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

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;
@@ -313,6 +317,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,

packages/firebase_analytics/firebase_analytics_platform_interface/test/method_channel_tests/method_channel_firebase_analytics_test.dart

@@ -22,6 +22,9 @@ void main() {
  methodCallLogger.add(call);
 
  switch (call.method) {
+ case 'Analytics#getAppInstanceId':
+ return 'ABCD1234';
+
  default:
  return true;
  }
@@ -117,6 +120,19 @@ void main() {
  );
  });
 
+ test('getAppInstanceId', () async {
+ await analytics.getAppInstanceId();
+ expect(
+ methodCallLogger,
+ <Matcher>[
+ isMethodCall(
+ 'Analytics#getAppInstanceId',
+ arguments: null,
+ ),
+ ],
+ );
+ });
+
  test('logEvent', () async {
  await analytics.logEvent(
  name: 'test-event',

packages/firebase_analytics/firebase_analytics_platform_interface/test/mock.dart

@@ -21,6 +21,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/test/platform_interface_tests/platform_interface_analytics_test.dart

@@ -198,6 +198,19 @@ void main() {
  ),
  );
  });
+
+ test('throws if .getAppInstanceId() not implemented', () async {
+ await expectLater(
+ () => firebaseAnalyticsPlatform.getAppInstanceId(),
+ throwsA(
+ isA<UnimplementedError>().having(
+ (e) => e.message,
+ 'message',
+ 'getAppInstanceId() is not implemented',
+ ),
+ ),
+ );
+ });
  });
 }
 

packages/firebase_analytics/firebase_analytics_web/lib/firebase_analytics_web.dart

@@ -135,4 +135,11 @@ class FirebaseAnalyticsWeb extends FirebaseAnalyticsPlatform {
  'setDefaultEventParameters() is not supported on web',
  );
  }
+
+ @override
+ Future<String?> getAppInstanceId() async {
+ throw UnimplementedError(
+ 'getAppInstanceId() is not supported on web',
+ );
+ }
 }

tests/test_driver/firebase_analytics/firebase_analytics_e2e.dart

@@ -198,5 +198,28 @@ void setupTests() {
  }
  },
  );
+
+ 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>());
+ }
+ });
  });
 }