Add back referrer url tracking

Author: stevenosse

.flutter-plugins-dependencies

@@ -1 +1 @@
-{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","native_build":true,"dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","native_build":true,"dependencies":[]},{"name":"referrer","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/referrer-0.0.2/","native_build":true,"dependencies":[]},{"name":"shared_preferences_foundation","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_foundation-2.4.0/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"android":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","native_build":true,"dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","native_build":true,"dependencies":[]},{"name":"referrer","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/referrer-0.0.2/","native_build":true,"dependencies":[]},{"name":"shared_preferences_android","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_android-2.2.2/","native_build":true,"dependencies":[]}],"macos":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","native_build":true,"dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","native_build":true,"dependencies":[]},{"name":"shared_preferences_foundation","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_foundation-2.4.0/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"linux":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","native_build":false,"dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","native_build":false,"dependencies":[]},{"name":"path_provider_linux","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/path_provider_linux-2.2.1/","native_build":false,"dependencies":[]},{"name":"shared_preferences_linux","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_linux-2.3.2/","native_build":false,"dependencies":["path_provider_linux"]}],"windows":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","native_build":false,"dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","native_build":false,"dependencies":[]},{"name":"path_provider_windows","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/path_provider_windows-2.2.1/","native_build":false,"dependencies":[]},{"name":"shared_preferences_windows","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_windows-2.3.2/","native_build":false,"dependencies":["path_provider_windows"]}],"web":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","dependencies":[]},{"name":"shared_preferences_web","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_web-2.3.0/","dependencies":[]}]},"dependencyGraph":[{"name":"device_info_plus","dependencies":[]},{"name":"package_info_plus","dependencies":[]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_windows","dependencies":[]},{"name":"referrer","dependencies":[]},{"name":"shared_preferences","dependencies":["shared_preferences_android","shared_preferences_foundation","shared_preferences_linux","shared_preferences_web","shared_preferences_windows"]},{"name":"shared_preferences_android","dependencies":[]},{"name":"shared_preferences_foundation","dependencies":[]},{"name":"shared_preferences_linux","dependencies":["path_provider_linux"]},{"name":"shared_preferences_web","dependencies":[]},{"name":"shared_preferences_windows","dependencies":["path_provider_windows"]}],"date_created":"2024-05-24 09:44:27.728713","version":"3.22.1"}
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","native_build":true,"dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","native_build":true,"dependencies":[]},{"name":"referrer","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/referrer-0.0.2/","native_build":true,"dependencies":[]},{"name":"shared_preferences_foundation","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_foundation-2.4.0/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"android":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","native_build":true,"dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","native_build":true,"dependencies":[]},{"name":"referrer","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/referrer-0.0.2/","native_build":true,"dependencies":[]},{"name":"shared_preferences_android","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_android-2.2.2/","native_build":true,"dependencies":[]}],"macos":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","native_build":true,"dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","native_build":true,"dependencies":[]},{"name":"shared_preferences_foundation","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_foundation-2.4.0/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"linux":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","native_build":false,"dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","native_build":false,"dependencies":[]},{"name":"path_provider_linux","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/path_provider_linux-2.2.1/","native_build":false,"dependencies":[]},{"name":"shared_preferences_linux","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_linux-2.3.2/","native_build":false,"dependencies":["path_provider_linux"]}],"windows":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","native_build":false,"dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","native_build":false,"dependencies":[]},{"name":"path_provider_windows","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/path_provider_windows-2.2.1/","native_build":false,"dependencies":[]},{"name":"shared_preferences_windows","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_windows-2.3.2/","native_build":false,"dependencies":["path_provider_windows"]}],"web":[{"name":"device_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/device_info_plus-10.1.0/","dependencies":[]},{"name":"package_info_plus","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/package_info_plus-8.0.0/","dependencies":[]},{"name":"shared_preferences_web","path":"/Users/steve_nosse-djou/.pub-cache/hosted/pub.dev/shared_preferences_web-2.3.0/","dependencies":[]}]},"dependencyGraph":[{"name":"device_info_plus","dependencies":[]},{"name":"package_info_plus","dependencies":[]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_windows","dependencies":[]},{"name":"referrer","dependencies":[]},{"name":"shared_preferences","dependencies":["shared_preferences_android","shared_preferences_foundation","shared_preferences_linux","shared_preferences_web","shared_preferences_windows"]},{"name":"shared_preferences_android","dependencies":[]},{"name":"shared_preferences_foundation","dependencies":[]},{"name":"shared_preferences_linux","dependencies":["path_provider_linux"]},{"name":"shared_preferences_web","dependencies":[]},{"name":"shared_preferences_windows","dependencies":["path_provider_windows"]}],"date_created":"2024-05-24 09:54:41.640939","version":"3.22.1"}

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.0.6
+- Add back referrer tracking
+
 ## 0.0.5
 - Replace User Agent lib with another one that supports all platforms
 - Remove lifecycle events tracking (for now)

lib/src/observers/referrer_observer.dart

@@ -0,0 +1,19 @@
+import 'package:flutter/widgets.dart';
+import 'package:openpanel_flutter/openpanel_flutter.dart';
+import 'package:referrer/referrer.dart' as r;
+
+class ReferrerObserver with WidgetsBindingObserver {
+  @override
+  Future<bool> didPushRouteInformation(
+    RouteInformation routeInformation,
+  ) async {
+    final referrerInfo = await r.Referrer().getReferrer();
+    if (referrerInfo?.referrer != null) {
+      Openpanel.instance.setGlobalProperties({
+        '__referrer': referrerInfo!.referrer,
+      });
+    }
+
+    return super.didPushRouteInformation(routeInformation);
+  }
+}

lib/src/open_panel.dart

@@ -2,13 +2,15 @@ import 'dart:developer';
 
 import 'package:device_info_plus/device_info_plus.dart';
 import 'package:flutter/foundation.dart';
+import 'package:flutter/material.dart';
 import 'package:logger/web.dart';
 
 import 'package:openpanel_flutter/src/models/open_panel_event_options.dart';
 import 'package:openpanel_flutter/src/models/open_panel_options.dart';
 import 'package:openpanel_flutter/src/models/open_panel_state.dart';
 import 'package:openpanel_flutter/src/models/post_event_payload.dart';
 import 'package:openpanel_flutter/src/models/update_profile_payload.dart';
+import 'package:openpanel_flutter/src/observers/referrer_observer.dart';
 import 'package:openpanel_flutter/src/services/openpanel_http_client.dart';
 import 'package:openpanel_flutter/src/services/preferences_service.dart';
 import 'package:package_info_plus/package_info_plus.dart';
@@ -43,6 +45,12 @@ class Openpanel {
 
   /// Initialise Openpanel.
   /// This must be called before using Openpanel.
+  /// 
+  ///  - [options]
+  ///    - [url] - Openpanel url
+  ///    - [clientId] - Openpanel client id
+  ///    - [clientSecret] - Openpanel client secret
+  ///    - [verbose] - Enable verbose logging
   ///
   /// Example:
   /// ```dart
@@ -89,6 +97,8 @@ class Openpanel {
 
     await _httpClient.init(options);
 
+    WidgetsBinding.instance.addObserver(ReferrerObserver());
+
     _isClientInitialised = true;
   }
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: openpanel_flutter
 description: "Openpanel is an open-source alternative to Mixpanel that combines the power of Mixpanel with the ease of Plausible. This package is not officially maintained by the Openpanel team."
-version: 0.0.5
+version: 0.0.6
 homepage: https://github.com/stevenosse/openpanel_flutter.git
 topics: 
   - analytics