app_factory_firebase

Riverpod-native Firebase bootstrap and telemetry helpers for Flutter apps.

This package keeps Firebase setup in one reusable layer while keeping your app code dependent on small abstractions instead of directly depending on Firebase SDK singletons. It is useful for teams that repeatedly build Flutter apps with Firebase Analytics, Crashlytics, and Performance Monitoring.

Features

  • Firebase initialization from app-provided FirebaseOptions
  • Configurable Analytics, Crashlytics, and Performance collection switches
  • Release-only collection defaults to avoid polluting production dashboards
  • Flutter and Dart error capture through Crashlytics
  • Analytics event logging, screen tracking, user properties, and context properties
  • Firebase-safe Analytics parameter sanitization
  • Performance traces with attributes and metrics
  • Firebase Performance helper for Dio
  • Identity synchronization across Analytics and Crashlytics
  • Fake implementations for tests
  • Generated Riverpod providers as the single source of truth

What This Package Does Not Own

Each app still owns its own Firebase project and platform files:

  • firebase_options.dart
  • google-services.json
  • GoogleService-Info.plist
  • Firebase Console project setup
  • Android and iOS native Firebase plugin configuration
  • App-specific analytics event names
  • Route naming and screen naming strategy

Do not put an app-specific firebase_options.dart file inside this package. Pass DefaultFirebaseOptions.currentPlatform from the app instead.

Installation

Add the dependency:

dependencies:
  app_factory_firebase: ^0.0.3

Then run:

flutter pub get

Your app must also be configured for Firebase with the normal FlutterFire setup. For example, Android still needs google-services.json and the Google Services Gradle plugin, and iOS still needs GoogleService-Info.plist.

Quick Start

Most apps can use runAppWithFirebase. It creates a ProviderContainer, injects the Firebase config, initializes Firebase, wraps your app in UncontrolledProviderScope, and calls runApp.

import 'package:app_factory_firebase/app_factory_firebase.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/widgets.dart';

import 'app.dart';
import 'firebase_options.dart';

Future<void> main() async {
  final result = await runAppWithFirebase(
    config: AppFactoryFirebaseConfig(
      options: DefaultFirebaseOptions.currentPlatform,
      enableAnalytics: true,
      enableCrashlytics: true,
      enablePerformance: true,
      captureFlutterErrors: true,
      collectionInReleaseOnly: true,
      defaultEventParameters: {
        'app_id': 'example_app',
        'app_channel': 'production',
      },
      contextProperties: {
        'product_family': 'consumer',
      },
      debugLogInitializeResult: true,
    ),
    child: const App(),
  );

  debugPrint(result.toString());
}

collectionInReleaseOnly defaults to true, which means collection is disabled in debug builds and enabled in release builds unless overridden.

If your app has additional Riverpod overrides, pass them through:

await runAppWithFirebase(
  config: AppFactoryFirebaseConfig(
    options: DefaultFirebaseOptions.currentPlatform,
  ),
  overrides: [
    userRepositoryProvider.overrideWithValue(userRepository),
    settingsRepositoryProvider.overrideWithValue(settingsRepository),
  ],
  child: const App(),
);

Riverpod 3 does not publicly export the Override type from flutter_riverpod, so the overrides parameter accepts the provider override objects directly. Pass values such as provider.overrideWithValue(...) or provider.overrideWith(...).

Advanced Bootstrap

If your app already owns a custom ProviderContainer, initialize Firebase manually and keep using the same container.

import 'package:app_factory_firebase/app_factory_firebase.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';

import 'app.dart';
import 'firebase_options.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  final container = ProviderContainer(
    overrides: [
      appFactoryFirebaseConfigProvider.overrideWithValue(
        AppFactoryFirebaseConfig(
          options: DefaultFirebaseOptions.currentPlatform,
          enableAnalytics: true,
          enableCrashlytics: true,
          enablePerformance: true,
          captureFlutterErrors: true,
          collectionInReleaseOnly: true,
        ),
      ),
    ],
  );

  final result = await AppFactoryFirebase.initialize(container);
  debugPrint(result.toString());

  runApp(
    UncontrolledProviderScope(
      container: container,
      child: const App(),
    ),
  );
}

appFactoryFirebaseConfigProvider intentionally throws if it is not overridden. This makes missing Firebase configuration fail during startup instead of silently running without telemetry.

Firebase subsystem failures are treated as non-fatal. They are recorded in AppFactoryFirebaseInitializeResult.initializationErrors, and your app can continue to run.

Screen Tracking

The package tracks GoRouterState, sends screen views through AppScreenTracker, and stores the current screen for interaction events.

GoRouterState -> Resolver -> AppScreenTracker -> Firebase Analytics
                                  |
                                  v
                       click_element / view_pop

final appRouterProvider = Provider<GoRouter>((ref) {
  return GoRouter(
    initialLocation: '/home',
    routes: [
      GoRoute(
        name: 'home',
        path: '/home',
        builder: (context, state) => const HomePage(),
      ),
    ],
  );
});

class App extends ConsumerWidget {
  const App({super.key});

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final GoRouter router = ref.watch(appRouterProvider);
    ref.watch(goRouterScreenTrackingProvider(router));

    return MaterialApp.router(routerConfig: router);
  }
}

This package sends screen views manually. Disable Firebase automatic screen reporting to avoid duplicate screen_view events:

<!-- android/app/src/main/AndroidManifest.xml, inside <application> -->
<meta-data
    android:name="google_analytics_automatic_screen_reporting_enabled"
    android:value="false" />

<!-- ios/Runner/Info.plist -->
<key>FirebaseAutomaticScreenReportingEnabled</key>
<false/>

Do not also register FirebaseAnalyticsObserver on navigators managed by the same GoRouter.

Production apps should override the resolver with stable Analytics screen names.

AppScreenResolution resolveAppScreen(GoRouterState state) {
  return switch (state.name) {
    'home' => const AppTrackedScreen(
        AppResolvedScreen(screenName: 'Home'),
      ),
    'historyDetail' => const AppTrackedScreen(
        AppResolvedScreen(screenName: 'HistoryDetail'),
      ),
    'deleteConfirmDialog' => const AppIgnoredScreen(),
    _ => AppTrackedScreen(
        AppResolvedScreen(
          screenName: 'UnmappedRoute',
          parameters: {'route_name': state.name ?? 'unnamed'},
        ),
      ),
  };
}

final screenResolverOverride =
    goRouterScreenResolverProvider.overrideWithValue(resolveAppScreen);
  • Initial routes, nested routes, back navigation, and StatefulShellRoute branches are tracked automatically.
  • Query-only changes are deduplicated unless the resolver supplies a trackingKey.
  • showDialog keeps the underlying screen; router-backed dialogs should resolve to AppIgnoredScreen.
  • AppUnmappedScreen is diagnostic-only and preserves the previous screen context. Real page routes should use a tracked UnmappedRoute fallback to avoid attributing interactions to the previous page.
  • Screens outside go_router can call appScreenTrackerProvider directly.
  • Tracking failures are fail-open and available through appScreenTrackingIssueSinkProvider.

See GoRouter Screen Tracking for resolver metadata, popup rules, deduplication, issue reporting, and edge cases.

Analytics Events

Keep event names in your app, not in this package:

class AppEvents {
  const AppEvents._();

  static const String signupComplete = 'signup_complete';
  static const String purchaseStart = 'purchase_start';
}

Log events through appAnalyticsProvider:

await ref.read(appAnalyticsProvider).logEvent(
  AppEvents.signupComplete,
  parameters: {
    'source': 'email',
    'has_invite_code': true,
    'created_at': DateTime.now(),
  },
);

Analytics parameters are sanitized before reaching Firebase:

  • String, int, and double are kept as-is
  • bool becomes 'true' or 'false'
  • DateTime becomes an ISO-8601 string
  • null is ignored
  • unsupported values are dropped and reported with debugPrint in debug builds

Convert lists, maps, and custom objects into simple fields before logging.

Interaction Events

appInteractionEventsProvider records the click_element and view_pop event schemas. It automatically includes screen_name from the latest tracked screen. Route and tab names should therefore be stable, app-specific identifiers. If an interaction occurs before any screen is tracked, screen_name is set to unknown and a debug warning is printed.

await ref.read(appInteractionEventsProvider).clickElement(
  elementId: 'add_expense_button',
  elementName: 'add_expense',
);

await ref.read(appInteractionEventsProvider).viewPop(
  popId: 'delete_expense_confirm',
  popName: 'delete_expense_confirm',
);

For a nested flow that does not match the active route, pass screenName to either method to override the current page for that event.

Crash Reporting

Global Flutter and Dart fatal errors can be connected during initialization with captureFlutterErrors: true.

When enabled, this package is the sole owner of FlutterError.onError and PlatformDispatcher.instance.onError and replaces any previously installed handlers. Do not install another global error handler alongside it. Apps that need another monitoring SDK or custom global error handling must set captureFlutterErrors: false and own the forwarding to Crashlytics explicitly. Flutter framework errors are still presented locally in debug and profile builds, while Crashlytics upload failures remain fail-open.

For errors you catch manually:

try {
  await repository.sync();
} catch (error, stackTrace) {
  await ref.read(appCrashReporterProvider).recordError(
    error,
    stackTrace,
    fatal: false,
  );
  rethrow;
}

You can also add Crashlytics breadcrumbs:

ref.read(appCrashReporterProvider).log('sync started');

Performance Traces

Use traceAsync for critical async flows:

final result = await ref.read(appPerformanceTracerProvider).traceAsync(
  'sync_push',
  (trace) async {
    trace.putAttribute('source', 'manual');
    trace.incrementMetric('pending_items', 3);
    return syncPush();
  },
);

Or manually start and stop a trace:

final trace = await ref
    .read(appPerformanceTracerProvider)
    .startTrace('voice_parse');

try {
  trace.putAttribute('language', 'en-US');
  await parseVoice();
} finally {
  await trace.stop();
}

Dio Performance Interceptor

Add the Firebase Performance interceptor to a Dio instance:

final dio = Dio();
dio.interceptors.addAll(
  ref.read(firebasePerformanceDioInterceptorsProvider),
);

If enablePerformance is false, the provider returns an empty list.

Identity Synchronization

After login, set the telemetry identity once:

await ref.read(appTelemetryIdentityProvider).setIdentity(
  user.id,
  properties: {
    'plan': user.plan,
    'locale': user.locale,
  },
);

This updates:

  • Analytics user id
  • Analytics user properties
  • Crashlytics user identifier

Identity synchronization is best-effort. Analytics or Crashlytics failures are logged for diagnostics and are not propagated back into login or logout flows.

On logout, clear the identity:

await ref.read(appTelemetryIdentityProvider).clearIdentity(
  propertyNames: ['plan', 'locale'],
);

You can also pass null to setIdentity:

await ref.read(appTelemetryIdentityProvider).setIdentity(
  null,
  properties: {
    'plan': '',
    'locale': '',
  },
);

Testing

The package includes fake implementations so tests can assert telemetry without touching Firebase.

Analytics

test('logs signup event', () async {
  final fakeAnalytics = FakeAppAnalytics();

  final container = ProviderContainer(
    overrides: [
      appFactoryFirebaseConfigProvider.overrideWithValue(
        AppFactoryFirebaseConfig(
          options: DefaultFirebaseOptions.currentPlatform,
          enableAnalytics: false,
          enableCrashlytics: false,
          enablePerformance: false,
        ),
      ),
      appAnalyticsProvider.overrideWithValue(fakeAnalytics),
    ],
  );
  addTearDown(container.dispose);

  await container.read(appAnalyticsProvider).logEvent(
    'signup_complete',
    parameters: {'source': 'email'},
  );

  expect(fakeAnalytics.events, hasLength(1));
  expect(fakeAnalytics.events.single.name, 'signup_complete');
  expect(fakeAnalytics.events.single.parameters['source'], 'email');
});

Crash Reporting

final fakeCrashReporter = FakeAppCrashReporter();

final container = ProviderContainer(
  overrides: [
    appCrashReporterProvider.overrideWithValue(fakeCrashReporter),
  ],
);

await container.read(appCrashReporterProvider).recordError(
  Exception('boom'),
  StackTrace.current,
  fatal: false,
);

expect(fakeCrashReporter.errors.single.fatal, false);

Performance

final fakeTracer = FakeAppPerformanceTracer();

final container = ProviderContainer(
  overrides: [
    appPerformanceTracerProvider.overrideWithValue(fakeTracer),
  ],
);

await container.read(appPerformanceTracerProvider).traceAsync(
  'sync_push',
  (trace) async {
    trace.putAttribute('source', 'manual');
  },
);

expect(fakeTracer.traces.single.name, 'sync_push');
expect(fakeTracer.traces.single.attributes['source'], 'manual');
expect(fakeTracer.traces.single.stopped, true);

Available fakes:

  • FakeAppAnalytics
  • FakeAppCrashReporter
  • FakeAppPerformanceTracer

Development

Provider declarations use riverpod_generator. After changing lib/src/providers.dart, regenerate and commit lib/src/providers.g.dart:

dart run build_runner build

FAQ

Why not include firebase_options.dart in this package?

Each app uses a different Firebase project. The generated Firebase options and platform files belong to the app, not to a reusable package.

Why is collection disabled in debug by default?

The default collectionInReleaseOnly: true avoids polluting production dashboards during development, testing, hot reload, and local debugging.

If you need collection in debug builds, explicitly override it:

AppFactoryFirebaseConfig(
  options: DefaultFirebaseOptions.currentPlatform,
  analyticsCollectionEnabled: true,
  crashlyticsCollectionEnabled: true,
  performanceCollectionEnabled: true,
)

Can initialization failure block app startup?

Only a missing AppFactoryFirebaseConfig is treated as a setup error. Firebase subsystem failures are recorded in initializationErrors, and the app can keep running.

Should app code use Firebase SDK singletons directly?

Prefer appAnalyticsProvider, appCrashReporterProvider, and appPerformanceTracerProvider. That keeps business code testable and makes it easy to replace implementations in tests.

Libraries

app_factory_firebase