feat(firebase_analytics): retrieves appInstanceId property on native platforms if available (#8689)

* fix(example): Bump compileSdkVersion for the example Android app to fix compilation

* feat(firebase_analytics): add appInstanceId property

This value is needed to send server-side events through the Measurement Protocol as a part of the same session, and also useful for debugging to pair up with the data visible in DebugView and BigQuery.

Author: willbryant

packages/firebase_analytics/firebase_analytics/android/src/main/java/io/flutter/plugins/firebase/analytics/FlutterFirebaseAnalyticsPlugin.java

@@ -10,6 +10,7 @@
 import androidx.annotation.NonNull;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
+import com.google.android.gms.tasks.Tasks;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.analytics.FirebaseAnalytics;
 import io.flutter.embedding.engine.plugins.FlutterPlugin;
@@ -130,6 +131,9 @@ public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
       case "Analytics#setDefaultEventParameters":
         methodCallTask = setDefaultEventParameters(call.arguments());
         break;
+      case "Analytics#getAppInstanceId":
+        methodCallTask = handleGetAppInstanceId();
+        break;
       default:
         result.notImplemented();
         return;
@@ -312,6 +316,21 @@ private Task<Void> setDefaultEventParameters(final Map<String, Object> arguments
     return taskCompletionSource.getTask();
   }
 
+  private Task<String> handleGetAppInstanceId() {
+    TaskCompletionSource<String> taskCompletionSource = new TaskCompletionSource<>();
+
+    cachedThreadPool.execute(
+        () -> {
+          try {
+            taskCompletionSource.setResult(Tasks.await(analytics.getAppInstanceId()));
+          } catch (Exception e) {
+            taskCompletionSource.setException(e);
+          }
+        });
+
+    return taskCompletionSource.getTask();
+  }
+
   @Override
   public Task<Map<String, Object>> getPluginConstantsForFirebaseApp(FirebaseApp firebaseApp) {
     TaskCompletionSource<Map<String, Object>> taskCompletionSource = new TaskCompletionSource<>();

packages/firebase_analytics/firebase_analytics/example/android/app/build.gradle

@@ -26,7 +26,7 @@ apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 apply plugin: 'com.google.gms.google-services'
 
 android {
-    compileSdkVersion 29
+    compileSdkVersion 31
 
     lintOptions {
         disable 'InvalidPackage'

packages/firebase_analytics/firebase_analytics/example/lib/main.dart

@@ -113,6 +113,20 @@ class _MyHomePageState extends State<MyHomePage> {
     setMessage('setUserProperty succeeded');
   }
 
+  Future<void> _testAppInstanceId() async {
+    String? id = await widget.analytics.appInstanceId;
+    if (id != null) {
+      setMessage('appInstanceId succeeded: $id');
+    } else {
+      setMessage('appInstanceId failed, consent declined');
+    }
+  }
+
+  Future<void> _testResetAnalyticsData() async {
+    await widget.analytics.resetAnalyticsData();
+    setMessage('resetAnalyticsData succeeded');
+  }
+
   AnalyticsEventItem itemCreator() {
     return AnalyticsEventItem(
       affiliation: 'affil',
@@ -303,6 +317,14 @@ class _MyHomePageState extends State<MyHomePage> {
             onPressed: _testSetUserProperty,
             child: const Text('Test setUserProperty'),
           ),
+          MaterialButton(
+            onPressed: _testAppInstanceId,
+            child: const Text('Test appInstanceId'),
+          ),
+          MaterialButton(
+            onPressed: _testResetAnalyticsData,
+            child: const Text('Test resetAnalyticsData'),
+          ),
           Text(
             _message,
             style: const TextStyle(color: Color.fromARGB(255, 0, 155, 0)),

packages/firebase_analytics/firebase_analytics/example/test_driver/firebase_analytics_e2e.dart

@@ -195,6 +195,29 @@ void testsMain() {
         }
       },
     );
+
+    test('appInstanceId', () async {
+      if (kIsWeb) {
+        await expectLater(
+          FirebaseAnalytics.instance.appInstanceId,
+          throwsA(isA<UnimplementedError>()),
+        );
+      } else {
+        final result = await FirebaseAnalytics.instance.appInstanceId;
+        expect(result, isNull);
+
+        await expectLater(
+          FirebaseAnalytics.instance.setConsent(
+            analyticsStorageConsentGranted: true,
+            adStorageConsentGranted: false,
+          ),
+          completes,
+        );
+
+        final result2 = await FirebaseAnalytics.instance.appInstanceId;
+        expect(result2, isA<String>());
+      }
+    });
   });
 }
 

packages/firebase_analytics/firebase_analytics/ios/Classes/FLTFirebaseAnalyticsPlugin.m

@@ -70,6 +70,8 @@ - (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)result
     [self setConsent:call.arguments withMethodCallResult:methodCallResult];
   } else if ([@"Analytics#setDefaultEventParameters" isEqualToString:call.method]) {
     [self setDefaultEventParameters:call.arguments withMethodCallResult:methodCallResult];
+  } else if ([@"Analytics#getAppInstanceId" isEqualToString:call.method]) {
+    [self getAppInstanceIdWithMethodCallResult:methodCallResult];
   } else {
     result(FlutterMethodNotImplemented);
   }
@@ -142,6 +144,11 @@ - (void)setDefaultEventParameters:(id)arguments
   result.success(nil);
 }
 
+- (void)getAppInstanceIdWithMethodCallResult:(FLTFirebaseMethodCallResult *)result {
+  NSString *appInstanceID = [FIRAnalytics appInstanceID];
+  result.success(appInstanceID);
+}
+
 #pragma mark - FLTFirebasePlugin
 
 - (void)didReinitializeFirebaseCore:(void (^_Nonnull)(void))completion {

packages/firebase_analytics/firebase_analytics/lib/src/firebase_analytics.dart

@@ -69,6 +69,12 @@ class FirebaseAnalytics extends FirebasePluginPlatform {
     return _delegate.isSupported();
   }
 
+  /// Retrieves the app instance id from the service, or null if consent has
+  /// been denied.
+  Future<String?> get appInstanceId {
+    return _delegate.getAppInstanceId();
+  }
+
   /// Logs a custom Flutter Analytics event with the given [name] and event [parameters].
   Future<void> logEvent({
     required String name,

packages/firebase_analytics/firebase_analytics/test/firebase_analytics_test.dart

@@ -1195,6 +1195,19 @@ void main() {
           ],
         );
       });
+
+      test('appInstanceId', () async {
+        var _ = await analytics!.appInstanceId;
+        expect(
+          methodCallLog,
+          <Matcher>[
+            isMethodCall(
+              'Analytics#getAppInstanceId',
+              arguments: null,
+            )
+          ],
+        );
+      });
     });
   });
 }

packages/firebase_analytics/firebase_analytics/test/mock.dart

@@ -20,6 +20,9 @@ void setupFirebaseAnalyticsMocks([Callback? customHandlers]) {
       .setMockMethodCallHandler((MethodCall methodCall) async {
     methodCallLog.add(methodCall);
     switch (methodCall.method) {
+      case 'Analytics#getAppInstanceId':
+        return 'ABCD1234';
+
       default:
         return false;
     }

packages/firebase_analytics/firebase_analytics_platform_interface/lib/src/method_channel/method_channel_firebase_analytics.dart

@@ -168,6 +168,15 @@ class MethodChannelFirebaseAnalytics extends FirebaseAnalyticsPlatform {
     }
   }
 
+  @override
+  Future<String?> getAppInstanceId() {
+    try {
+      return channel.invokeMethod<String?>('Analytics#getAppInstanceId');
+    } catch (e, s) {
+      convertPlatformException(e, s);
+    }
+  }
+
   @override
   Future<void> setSessionTimeoutDuration(Duration timeout) async {
     try {

packages/firebase_analytics/firebase_analytics_platform_interface/lib/src/platform_interface/platform_interface_firebase_analytics.dart

@@ -68,6 +68,11 @@ abstract class FirebaseAnalyticsPlatform extends PlatformInterface {
     throw UnimplementedError('isSupported() is not implemented');
   }
 
+  /// Retrieves the app instance id from the service.
+  Future<String?> getAppInstanceId() {
+    throw UnimplementedError('getAppInstanceId() is not implemented');
+  }
+
   /// Logs the given event [name] with the given [parameters].
   Future<void> logEvent({
     required String name,