fix(firebase_analytics): allow null values for `setDefaultEventPara…

…meters()` which removes defaults. Permissible on android and iOS. (#9135) Co-authored-by: Russell Wheatley <russellwheatley85@gmail.com>
firebase · Jul 21, 2022 · dff46a3 · dff46a3
1 parent 9da7cc3
commit dff46a3
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 6 deletions.
diff --git a/...d/src/main/java/io/flutter/plugins/firebase/analytics/FlutterFirebaseAnalyticsPlugin.java b/...d/src/main/java/io/flutter/plugins/firebase/analytics/FlutterFirebaseAnalyticsPlugin.java
@@ -302,8 +302,7 @@ private Task<Void> setDefaultEventParameters(final Map<String, Object> arguments
     cachedThreadPool.execute(
         () -> {
           try {
-            Map<String, Object> parameters = Objects.requireNonNull(arguments);
-            analytics.setDefaultEventParameters(createBundleFromMap(parameters));
+            analytics.setDefaultEventParameters(createBundleFromMap(arguments));
             taskCompletionSource.setResult(null);
           } catch (Exception e) {
             taskCompletionSource.setException(e);

diff --git a/packages/firebase_analytics/firebase_analytics/lib/src/firebase_analytics.dart b/packages/firebase_analytics/firebase_analytics/lib/src/firebase_analytics.dart
@@ -120,7 +120,7 @@ class FirebaseAnalytics extends FirebasePluginPlatform {
 
   /// Adds parameters that will be set on every event logged from the SDK, including automatic ones.
   Future<void> setDefaultEventParameters(
-    Map<String, Object> defaultParameters,
+    Map<String, Object?>? defaultParameters,
   ) async {
     await _delegate.setDefaultEventParameters(defaultParameters);
   }

diff --git a/...nalytics_platform_interface/lib/src/method_channel/method_channel_firebase_analytics.dart b/...nalytics_platform_interface/lib/src/method_channel/method_channel_firebase_analytics.dart
@@ -82,7 +82,7 @@ class MethodChannelFirebaseAnalytics extends FirebaseAnalyticsPlatform {
 
   @override
   Future<void> setDefaultEventParameters(
-    Map<String, Object> defaultParameters,
+    Map<String, Object?>? defaultParameters,
   ) async {
     try {
       return channel.invokeMethod<void>(

diff --git a/..._platform_interface/lib/src/platform_interface/platform_interface_firebase_analytics.dart b/..._platform_interface/lib/src/platform_interface/platform_interface_firebase_analytics.dart
@@ -139,7 +139,7 @@ abstract class FirebaseAnalyticsPlatform extends PlatformInterface {
 
   /// Adds parameters that will be set on every event logged from the SDK, including automatic ones.
   Future<void> setDefaultEventParameters(
-    Map<String, Object> defaultParameters,
+    Map<String, Object?>? defaultParameters,
   ) {
     throw UnimplementedError('setDefaultEventParameters() is not implemented');
   }

diff --git a/packages/firebase_analytics/firebase_analytics_web/lib/firebase_analytics_web.dart b/packages/firebase_analytics/firebase_analytics_web/lib/firebase_analytics_web.dart
@@ -129,7 +129,7 @@ class FirebaseAnalyticsWeb extends FirebaseAnalyticsPlatform {
 
   @override
   Future<void> setDefaultEventParameters(
-    Map<String, Object> defaultParameters,
+    Map<String, Object?>? defaultParameters,
   ) async {
     throw UnimplementedError(
       'setDefaultEventParameters() is not supported on web',

diff --git a/tests/test_driver/firebase_analytics/firebase_analytics_e2e.dart b/tests/test_driver/firebase_analytics/firebase_analytics_e2e.dart
@@ -189,12 +189,34 @@ void setupTests() {
                 .setDefaultEventParameters({'default': 'parameters'}),
             throwsA(isA<UnimplementedError>()),
           );
+          // reset a single default parameter
+          await expectLater(
+            FirebaseAnalytics.instance
+                .setDefaultEventParameters({'default': null}),
+            throwsA(isA<UnimplementedError>()),
+          );
+          // reset all default parameters
+          await expectLater(
+            FirebaseAnalytics.instance.setDefaultEventParameters(null),
+            throwsA(isA<UnimplementedError>()),
+          );
         } else {
           await expectLater(
             FirebaseAnalytics.instance
                 .setDefaultEventParameters({'default': 'parameters'}),
             completes,
           );
+          // reset a single default parameter
+          await expectLater(
+            FirebaseAnalytics.instance
+                .setDefaultEventParameters({'default': null}),
+            completes,
+          );
+          // reset all default parameters
+          await expectLater(
+            FirebaseAnalytics.instance.setDefaultEventParameters(null),
+            completes,
+          );
         }
       },
     );