Refactor analytics backend injection (#2135)

nilsreichardt · web-flow · commit 45c380f95f56 · 2026-02-07T23:23:01.000+01:00
Remove direct calls to `Analytics(getBackend())` that instantiate `FirebaseAnalytics.instance` and make analytics backends injectable so tests can provide a mocked `FirebaseAnalytics` instance. Closes #1379 ------ [Codex Task](https://chatgpt.com/codex/tasks/task_e_6982616055c883229df96a2ea8383106)
diff --git a/app/integration_test/app_test.dart b/app/integration_test/app_test.dart
@@ -42,6 +42,7 @@ void main() {
           dynamicLinkBloc: dependencies.dynamicLinkBloc,
           flavor: Flavor.dev,
           isIntegrationTest: true,
+          analytics: dependencies.blocDependencies.analytics,
         ),
       );
 
diff --git a/app/integration_test/integration_test_old.dart b/app/integration_test/integration_test_old.dart
@@ -53,6 +53,7 @@ void main() {
         dynamicLinkBloc: dependencies.dynamicLinkBloc,
         flavor: Flavor.dev,
         isIntegrationTest: true,
+        analytics: dependencies.blocDependencies.analytics,
       ),
     );
   }
diff --git a/app/lib/account/account_page_bloc.dart b/app/lib/account/account_page_bloc.dart
@@ -27,17 +27,17 @@ class AccountPageBloc extends BlocBase {
   final GlobalKey<ScaffoldMessengerState> globalKey;
   final LinkProviderGateway linkProviderGateway;
   final UserGateway userGateway;
-
-  final _analytics = LinkProviderAnalytics(Analytics(getBackend()));
+  final LinkProviderAnalytics _analytics;
 
   late Stream<UserView> userViewStream;
 
   AccountPageBloc({
     required this.userGateway,
     required this.linkProviderGateway,
     required this.globalKey,
+    required Analytics analytics,
     required this.l10n,
-  }) {
+  }) : _analytics = LinkProviderAnalytics(analytics) {
     final userStream = userGateway.userStream;
     final authUserStream = userGateway.authUserStream;
 
diff --git a/app/lib/account/account_page_bloc_factory.dart b/app/lib/account/account_page_bloc_factory.dart
@@ -6,6 +6,7 @@
 //
 // SPDX-License-Identifier: EUPL-1.2
 
+import 'package:analytics/analytics.dart';
 import 'package:authentification_base/authentification_gateways.dart';
 import 'package:bloc_base/bloc_base.dart';
 import 'package:flutter/material.dart';
@@ -15,17 +16,22 @@ import 'package:sharezone_localizations/sharezone_localizations.dart';
 
 class AccountPageBlocFactory extends BlocBase {
   final UserGateway _userGateway;
+  final Analytics _analytics;
 
-  AccountPageBlocFactory(this._userGateway);
+  AccountPageBlocFactory(this._userGateway, this._analytics);
 
   AccountPageBloc create(
     GlobalKey<ScaffoldMessengerState> scaffoldMessengerKey,
     SharezoneLocalizations l10n,
   ) {
     return AccountPageBloc(
       globalKey: scaffoldMessengerKey,
-      linkProviderGateway: LinkProviderGateway(_userGateway),
+      linkProviderGateway: LinkProviderGateway(
+        _userGateway,
+        analytics: _analytics,
+      ),
       userGateway: _userGateway,
+      analytics: _analytics,
       l10n: l10n,
     );
   }
diff --git a/app/lib/account/register_account_section.dart b/app/lib/account/register_account_section.dart
@@ -11,6 +11,7 @@ import 'package:authentification_base/authentification_analytics.dart';
 import 'package:bloc_provider/bloc_provider.dart';
 import 'package:flutter/material.dart';
 import 'package:font_awesome_flutter/font_awesome_flutter.dart';
+import 'package:provider/provider.dart';
 import 'package:sharezone/account/use_account_on_multiple_devices_instruction.dart';
 import 'package:sharezone/auth/email_and_password_link_page.dart';
 import 'package:sharezone/main/application_bloc.dart';
@@ -287,9 +288,7 @@ Future<void> showCredentialAlreadyInUseDialog(BuildContext context) async {
   );
 
   if (showInstruction != null && showInstruction && context.mounted) {
-    final LinkProviderAnalytics analytics = LinkProviderAnalytics(
-      Analytics(getBackend()),
-    );
+    final analytics = LinkProviderAnalytics(context.read<Analytics>());
     analytics.logShowedUseMultipleDevicesInstruction();
     Navigator.pushNamed(context, UseAccountOnMultipleDevicesInstructions.tag);
   }
diff --git a/app/lib/auth/email_and_password_link_bloc.dart b/app/lib/auth/email_and_password_link_bloc.dart
@@ -31,10 +31,7 @@ class EmailAndPasswordLinkBloc extends BlocBase
   final LinkProviderGateway linkProviderGateway;
   final UserEditBlocGateway userEditBlocGateway;
   final String initialName;
-
-  final LinkProviderAnalytics _analytics = LinkProviderAnalytics(
-    Analytics(getBackend()),
-  );
+  final LinkProviderAnalytics _analytics;
 
   final _emailController = BehaviorSubject<String>();
   final _passwordController = BehaviorSubject<String?>();
@@ -54,7 +51,8 @@ class EmailAndPasswordLinkBloc extends BlocBase
     this.initialName,
     this.scaffoldMessengerKey,
     this.l10n,
-  ) {
+    Analytics analytics,
+  ) : _analytics = LinkProviderAnalytics(analytics) {
     _nameController.sink.add(initialName);
   }
 
diff --git a/app/lib/auth/email_and_password_link_page.dart b/app/lib/auth/email_and_password_link_page.dart
@@ -6,6 +6,7 @@
 //
 // SPDX-License-Identifier: EUPL-1.2
 
+import 'package:analytics/analytics.dart';
 import 'package:authentification_base/authentification.dart';
 import 'package:bloc_provider/bloc_provider.dart';
 import 'package:flutter/material.dart';
@@ -70,12 +71,14 @@ class _EmailAndPasswordLinkPageState extends State<EmailAndPasswordLinkPage> {
     super.didChangeDependencies();
     if (_didInit) return;
     final api = BlocProvider.of<SharezoneContext>(context).api;
+    final analytics = AnalyticsProvider.ofOrNullObject(context);
     bloc = EmailAndPasswordLinkBloc(
-      LinkProviderGateway(api.user),
+      LinkProviderGateway(api.user, analytics: analytics),
       UserEditBlocGateway(api.user, widget.user),
       widget.user.name,
       scaffoldKey,
       context.l10n,
+      analytics,
     );
     delayKeyboard(context: context, focusNode: emailFocusNode);
     _didInit = true;
diff --git a/app/lib/auth/login_page.dart b/app/lib/auth/login_page.dart
@@ -99,8 +99,7 @@ class _LoginPageState extends State<LoginPage> {
 
   @override
   void initState() {
-    final analytics = LoginAnalytics(Analytics(getBackend()));
-    bloc = LoginBloc(analytics);
+    bloc = LoginBloc(LoginAnalytics(context.read<Analytics>()));
     super.initState();
     showTipCardIfIsAvailable(context);
   }
diff --git a/app/lib/auth/sign_in_with_qr_code_page.dart b/app/lib/auth/sign_in_with_qr_code_page.dart
@@ -16,6 +16,7 @@ import 'package:cloud_firestore/cloud_firestore.dart';
 import 'package:cloud_functions/cloud_functions.dart';
 import 'package:crash_analytics/crash_analytics.dart';
 import 'package:flutter/material.dart' hide VerticalDivider;
+import 'package:provider/provider.dart';
 import 'package:qr_flutter/qr_flutter.dart';
 import 'package:sharezone/groups/src/widgets/contact_support.dart';
 import 'package:sharezone_widgets/sharezone_widgets.dart';
@@ -39,7 +40,7 @@ class SignInWithQrCodePage extends StatelessWidget {
                   FirebaseFunctions.instanceFor(region: 'europe-west1'),
                 ),
               ),
-              loginAnalytics: LoginAnalytics(Analytics(getBackend())),
+              loginAnalytics: LoginAnalytics(context.read<Analytics>()),
               crashAnalytics: getCrashAnalytics(),
             ),
             child: _InnerSignInWithQrCodePage(),
diff --git a/app/lib/dashboard/widgets/dashboard_fab.dart b/app/lib/dashboard/widgets/dashboard_fab.dart
@@ -14,7 +14,7 @@ class _DashboardPageFAB extends StatelessWidget {
   const _DashboardPageFAB();
 
   Future<void> openDashboardFabSheet(BuildContext context) async {
-    final analytics = DashboardAnalytics(Analytics(getBackend()));
+    final analytics = DashboardAnalytics(context.read<Analytics>());
     analytics.logOpenFabSheet();
 
     final fabResult = await showModalBottomSheet<_DashboardFabResult>(
diff --git a/app/lib/main/auth_app.dart b/app/lib/main/auth_app.dart
@@ -62,6 +62,7 @@ class _AuthAppState extends State<AuthApp> {
   Widget build(BuildContext context) {
     return MultiProvider(
       providers: [
+        Provider.value(value: widget.analytics),
         ChangeNotifierProvider(
           create:
               (context) => SupportPageController(
diff --git a/app/lib/main/run_app.dart b/app/lib/main/run_app.dart
@@ -8,13 +8,16 @@
 
 import 'dart:async';
 import 'dart:developer';
-import 'dart:ui';
 
 import 'package:analytics/analytics.dart';
+import 'package:analytics/null_analytics_backend.dart'
+    show NullAnalyticsBackend;
 import 'package:app_functions/app_functions.dart';
 import 'package:authentification_base/authentification.dart';
 import 'package:cloud_functions/cloud_functions.dart';
+import 'package:firebase_analytics/firebase_analytics.dart';
 import 'package:firebase_core/firebase_core.dart';
+import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:key_value_store/key_value_store.dart';
 import 'package:platform_check/platform_check.dart';
@@ -79,6 +82,7 @@ Future<void> runFlutterApp({required Flavor flavor}) async {
       blocDependencies: dependencies.blocDependencies,
       dynamicLinkBloc: dependencies.dynamicLinkBloc,
       flavor: flavor,
+      analytics: dependencies.blocDependencies.analytics,
     ),
   );
 
@@ -117,6 +121,14 @@ Future<AppDependencies> initializeDependencies({required Flavor flavor}) async {
   final pluginInitializations = await runPluginInitializations(flavor: flavor);
 
   final firebaseDependencies = FirebaseDependencies.get();
+  final firebaseAnalytics = FirebaseAnalytics.instance;
+  final analyticsBackend =
+      kDebugMode
+          ?
+          // LoggingAnalyticsBackend()
+          NullAnalyticsBackend()
+          : getBackend(firebaseAnalytics: firebaseAnalytics);
+  final analytics = Analytics(analyticsBackend);
   final firebaseFunctions = FirebaseFunctions.instanceFor(
     region: 'europe-west1',
   );
@@ -132,10 +144,11 @@ Future<AppDependencies> initializeDependencies({required Flavor flavor}) async {
   final registrationGateway = RegistrationGateway(
     references.users,
     firebaseDependencies.auth!,
+    analytics: analytics,
     anonymousUserNameBuilder: buildAnonymousUserName,
   );
   final blocDependencies = BlocDependencies(
-    analytics: Analytics(getBackend()),
+    analytics: analytics,
     firestore: firebaseDependencies.firestore!,
     keyValueStore: keyValueStore,
     sharedPreferences: pluginInitializations.sharedPreferences,
@@ -167,8 +180,6 @@ Future<AppDependencies> initializeDependencies({required Flavor flavor}) async {
   // ignore:close_sinks
   final beitrittsversuche = runBeitrittsVersuche();
 
-  final analytics = Analytics(getBackend());
-
   UserGateway? userGateway;
   SharezoneGateway? sharezoneGateway;
 
diff --git a/app/lib/main/sharezone.dart b/app/lib/main/sharezone.dart
@@ -56,6 +56,7 @@ class Sharezone extends StatefulWidget {
   final DynamicLinkBloc dynamicLinkBloc;
   final Stream<Beitrittsversuch?> beitrittsversuche;
   final Flavor flavor;
+  final Analytics analytics;
   final bool isIntegrationTest;
 
   const Sharezone({
@@ -64,11 +65,10 @@ class Sharezone extends StatefulWidget {
     required this.dynamicLinkBloc,
     required this.beitrittsversuche,
     required this.flavor,
+    required this.analytics,
     this.isIntegrationTest = false,
   });
 
-  static Analytics analytics = Analytics(getBackend());
-
   @override
   State createState() => _SharezoneState();
 }
@@ -107,7 +107,7 @@ class _SharezoneState extends State<Sharezone> with WidgetsBindingObserver {
   }
 
   void logAppOpen() {
-    Sharezone.analytics.log(NamedAnalyticsEvent(name: 'app_open'));
+    widget.analytics.log(NamedAnalyticsEvent(name: 'app_open'));
   }
 
   @override
@@ -178,13 +178,13 @@ class _SharezoneState extends State<Sharezone> with WidgetsBindingObserver {
                                         snapshot.data;
                                     return SharezoneApp(
                                       widget.blocDependencies,
-                                      Sharezone.analytics,
+                                      widget.analytics,
                                       widget.beitrittsversuche,
                                     );
                                   }
                                   return AuthApp(
                                     blocDependencies: widget.blocDependencies,
-                                    analytics: Sharezone.analytics,
+                                    analytics: widget.analytics,
                                   );
                                 },
                               ),
diff --git a/app/lib/main/sharezone_bloc_providers.dart b/app/lib/main/sharezone_bloc_providers.dart
@@ -9,8 +9,6 @@
 import 'package:abgabe_client_lib/abgabe_client_lib.dart';
 import 'package:abgabe_http_api/api.dart';
 import 'package:analytics/analytics.dart';
-import 'package:analytics/null_analytics_backend.dart'
-    show NullAnalyticsBackend;
 import 'package:authentification_base/authentification.dart' as auth;
 import 'package:bloc_base/bloc_base.dart';
 import 'package:bloc_provider/bloc_provider.dart';
@@ -22,7 +20,6 @@ import 'package:dio/dio.dart';
 import 'package:feedback_shared_implementation/feedback_shared_implementation.dart';
 import 'package:filesharing_logic/file_uploader.dart';
 import 'package:firebase_messaging/firebase_messaging.dart';
-import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:group_domain_implementation/group_domain_accessors_implementation.dart';
 import 'package:group_domain_models/group_domain_models.dart';
@@ -170,13 +167,7 @@ class _SharezoneBlocProvidersState extends State<SharezoneBlocProviders> {
   void initState() {
     super.initState();
 
-    final analyticsBackend =
-        kDebugMode
-            ?
-            // LoggingAnalyticsBackend()
-            NullAnalyticsBackend()
-            : getBackend();
-    analytics = Analytics(analyticsBackend);
+    analytics = widget.blocDependencies.analytics;
 
     // Muss in die initState, weil ansonsten der Bloc die Daten resettet,
     // wenn das Handy gedreht wird und dadurch die build Methode dieses Widgets
@@ -288,7 +279,7 @@ class _SharezoneBlocProvidersState extends State<SharezoneBlocProviders> {
       SchoolClassFilterAnalytics(analytics),
     );
 
-    final markdownAnalytics = MarkdownAnalytics(Analytics(getBackend()));
+    final markdownAnalytics = MarkdownAnalytics(analytics);
 
     var abgabenGateway = FirestoreAbgabeGateway(
       firestore: firestore,
@@ -608,7 +599,7 @@ class _SharezoneBlocProvidersState extends State<SharezoneBlocProviders> {
         ),
       ),
       BlocProvider<AccountPageBlocFactory>(
-        bloc: AccountPageBlocFactory(api.user),
+        bloc: AccountPageBlocFactory(api.user, analytics),
       ),
       BlocProvider<BlackboardAnalytics>(bloc: BlackboardAnalytics(analytics)),
       BlocProvider<NavigationExperimentCache>(
@@ -726,7 +717,7 @@ class _SharezoneBlocProvidersState extends State<SharezoneBlocProviders> {
           CommentsGateway(api.references.firestore),
           api.user.userStream,
           CommentViewFactory(courseGateway: api.course, uid: api.uID),
-          CommentsAnalytics(Analytics(getBackend())),
+          CommentsAnalytics(analytics),
         ),
       ),
       BlocProvider<HomeworkDetailsViewFactory>(
@@ -764,7 +755,7 @@ class _SharezoneBlocProvidersState extends State<SharezoneBlocProviders> {
             api.schoolClassGateway,
             api.connectionsGateway,
           ),
-          CourseCreateAnalytics(Analytics(getBackend())),
+          CourseCreateAnalytics(analytics),
         ),
       ),
     ];
diff --git a/app/macos/Flutter/GeneratedPluginRegistrant.swift b/app/macos/Flutter/GeneratedPluginRegistrant.swift
@@ -25,6 +25,7 @@ import google_sign_in_ios
 import in_app_review
 import mobile_scanner
 import package_info_plus
+import path_provider_foundation
 import patrol
 import pdfx
 import purchases_flutter
@@ -57,6 +58,7 @@ func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
   InAppReviewPlugin.register(with: registry.registrar(forPlugin: "InAppReviewPlugin"))
   MobileScannerPlugin.register(with: registry.registrar(forPlugin: "MobileScannerPlugin"))
   FPPPackageInfoPlusPlugin.register(with: registry.registrar(forPlugin: "FPPPackageInfoPlusPlugin"))
+  PathProviderPlugin.register(with: registry.registrar(forPlugin: "PathProviderPlugin"))
   PatrolPlugin.register(with: registry.registrar(forPlugin: "PatrolPlugin"))
   PdfxPlugin.register(with: registry.registrar(forPlugin: "PdfxPlugin"))
   PurchasesFlutterPlugin.register(with: registry.registrar(forPlugin: "PurchasesFlutterPlugin"))
diff --git a/app/pubspec.yaml b/app/pubspec.yaml
@@ -75,6 +75,7 @@ dependencies:
     path: ../lib/filesharing/files_usecases
   filesharing_logic:
     path: ../lib/filesharing/filesharing_logic
+  firebase_analytics: ^12.0.2
   firebase_auth: ^6.1.0
   firebase_core: ^4.1.1
   firebase_messaging: ^16.0.2
diff --git a/lib/analytics/lib/src/analytics/backend/firebase_analytics_backend.dart b/lib/analytics/lib/src/analytics/backend/firebase_analytics_backend.dart
@@ -62,9 +62,12 @@ class FirebaseAnalyticsBackend extends AnalyticsBackend {
       _firebaseAnalytics.setUserProperty(name: name, value: value);
 }
 
-AnalyticsBackend getBackend() {
+AnalyticsBackend getBackend({
+  required FirebaseAnalytics firebaseAnalytics,
+  CrashAnalytics? crashAnalytics,
+}) {
   return FirebaseAnalyticsBackend(
-    FirebaseAnalytics.instance,
-    getCrashAnalytics(),
+    firebaseAnalytics,
+    crashAnalytics ?? getCrashAnalytics(),
   );
 }
diff --git a/lib/analytics/lib/src/analytics/get_backend.dart b/lib/analytics/lib/src/analytics/get_backend.dart
diff --git a/lib/authentification/authentification_base/lib/src/gateways/link_provider_gateway.dart b/lib/authentification/authentification_base/lib/src/gateways/link_provider_gateway.dart
diff --git a/lib/authentification/authentification_base/lib/src/gateways/registration_gateway.dart b/lib/authentification/authentification_base/lib/src/gateways/registration_gateway.dart

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ void main() {`
`53`	`53`	`dynamicLinkBloc: dependencies.dynamicLinkBloc,`
`54`	`54`	`flavor: Flavor.dev,`
`55`	`55`	`isIntegrationTest: true,`
	`56`	`+ analytics: dependencies.blocDependencies.analytics,`
`56`	`57`	`),`
`57`	`58`	`);`
`58`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,8 +99,7 @@ class _LoginPageState extends State<LoginPage> {`
`99`	`99`
`100`	`100`	`@override`
`101`	`101`	`void initState() {`
`102`		`- final analytics = LoginAnalytics(Analytics(getBackend()));`
`103`		`- bloc = LoginBloc(analytics);`
	`102`	`+ bloc = LoginBloc(LoginAnalytics(context.read<Analytics>()));`
`104`	`103`	`super.initState();`
`105`	`104`	`showTipCardIfIsAvailable(context);`
`106`	`105`	`}`