analytics-feature

Analytics Feature — flutter_core_modules

The analytics feature provides a provider-agnostic event tracking API. A single EventEntity.track(context) call fans out to all enabled analytics providers simultaneously.

---

1. Architecture Overview

EventEntity.track(context)
    │
    └──► ProviderScope.containerOf(context)
             │
             └──► analyticsRepositoryProvider (AnalyticsRepositoryImpl)
                      │
                      ├──► AmplitudeConfig.enabled  → amplitude.track(BaseEvent)
                      ├──► FirebaseAnalyticsConfig.enabled → firebaseAnalytics.logEvent()
                      ├──► PosthogConfig.enabled    → posthog.capture()
                      ├──► MixpanelConfig.enabled   → mixpanel.track()
                      └──► StatsigConfig.enabled    → Statsig.logEvent()

Each provider runs as a Future.microtask with .catchError(() {}) — failures in one provider never affect others.

---

2. EventEntity — Base Class for All Events

File: lib/src/features/analytics/domain/entities/events/event_entity.dart

abstract class EventEntity {
  const EventEntity();

  // Override to provide event properties
  Map<String, Object>? get properties;

  // Derived — converts class name to snake_case automatically
  // e.g. TapOnReviewButton → 'tap_on_review_button'
  String get name => formatToSnakeCase(runtimeType.toString());

  // Tracks to all enabled analytics providers via ProviderScope
  Future<void> track({required BuildContext context});

  // Properties with all values toString'd (needed for Firebase which rejects non-String/num)
  Map<String, Object>? get propertiesToAvoidAssertInputTypes;
}

Key design decision: Event names are derived automatically from the class name via runtimeType.toString() converted to snake_case. No manual name override needed.

---

3. How to Define a New Event

Simple event (no properties):

// In the relevant file or a new events file:
class TapOnMyFeature extends EventEntity {
  const TapOnMyFeature();

  @override
  Map<String, Object>? get properties => const {};
}