feat(analytics): Adding default event parameters (#5246)

* Adding firebase default parameter function call to android
* iOS implementation
* e2e tests

Co-authored-by: Mike Hardy <[email protected]>

Author: MFrat

packages/analytics/__tests__/analytics.test.ts

@@ -164,6 +164,15 @@ describe('Analytics', function () {
     });
   });
 
+  describe('setDefaultEventParameters()', function () {
+    it('errors if params is not a object', function () {
+      // @ts-ignore test
+      expect(() => firebase.analytics().setDefaultEventParameters('123')).toThrowError(
+        "firebase.analytics().setDefaultEventParameters(*) 'params' expected an object value when it is defined.",
+      );
+    });
+  });
+
   describe('logAddToCart()', function () {
     it('errors if param is not an object', function () {
       // @ts-ignore test

packages/analytics/android/src/main/java/io/invertase/firebase/analytics/UniversalFirebaseAnalyticsModule.java

@@ -96,4 +96,11 @@ Task<Void> resetAnalyticsData() {
       return null;
     });
   }
+
+  Task<Void> setDefaultEventParameters(Bundle parameters) {
+    return Tasks.call(() -> {
+      FirebaseAnalytics.getInstance(getContext()).setDefaultEventParameters(parameters);
+      return null;
+    });
+  }
 }

packages/analytics/android/src/reactnative/java/io/invertase/firebase/analytics/ReactNativeFirebaseAnalyticsModule.java

@@ -131,6 +131,17 @@ public void resetAnalyticsData(Promise promise) {
     });
   }
 
+  @ReactMethod
+  public void setDefaultEventParameters(@Nullable ReadableMap params, Promise promise) {
+    module.setDefaultEventParameters(toBundle(params)).addOnCompleteListener(task -> {
+      if (task.isSuccessful()) {
+        promise.resolve(task.getResult());
+      } else {
+        rejectPromiseWithExceptionMap(promise, task.getException());
+      }
+    });
+  }
+
   private Bundle toBundle(ReadableMap readableMap) {
     Bundle bundle = Arguments.toBundle(readableMap);
     if (bundle == null) {

packages/analytics/e2e/analytics.e2e.js

@@ -418,4 +418,18 @@ describe('analytics()', function () {
       });
     });
   });
+
+  describe('setDefaultEventParameters()', function () {
+    it('set null default parameter', async function () {
+      await firebase.analytics().setDefaultEventParameters(null);
+    });
+
+    it('set undefined default parameter', async function () {
+      await firebase.analytics().setDefaultEventParameters(undefined);
+    });
+
+    it('set default parameters', async function () {
+      await firebase.analytics().setDefaultEventParameters({ number: 1, stringn: '123' });
+    });
+  });
 });

packages/analytics/ios/RNFBAnalytics/RNFBAnalyticsModule.m

@@ -142,6 +142,21 @@ - (dispatch_queue_t)methodQueue {
       return resolve([FIRAnalytics appInstanceID]);
   }
 
+  RCT_EXPORT_METHOD(setDefaultEventParameters:
+        (NSDictionary *) params
+        resolver:
+        (RCTPromiseResolveBlock) resolve
+        rejecter:
+        (RCTPromiseRejectBlock) reject) {
+    @try {
+      [FIRAnalytics setDefaultEventParameters:[self cleanJavascriptParams:params]];
+    } @catch (NSException *exception) {
+      return [RNFBSharedUtils rejectPromiseWithExceptionDict:reject exception:exception];
+    }
+
+    return resolve([NSNull null]);
+  }
+
 #pragma mark -
 #pragma mark Private methods
 

packages/analytics/lib/index.d.ts

@@ -1468,6 +1468,26 @@ export namespace FirebaseAnalyticsTypes {
      * @param params See {@link analytics.ViewSearchResultsParameters}.
      */
     logViewSearchResults(params: ViewSearchResultsParameters): Promise<void>;
+
+    /**
+     * Adds parameters that will be set on every event logged from the SDK, including automatic ones.
+     *
+     * #### Example
+     *
+     * ```js
+     * await firebase.analytics().setDefaultEventParameters({
+     *   userId: '1234',
+     * });
+     * ```
+     *
+     *
+     * @param params Parameters to be added to the map of parameters added to every event.
+     * They will be added to the map of default event parameters, replacing any existing
+     * parameter with the same name. Valid parameter values are String, long, and double.
+     * Setting a key's value to null will clear that parameter. Passing in a null bundle
+     * will clear all parameters.
+     */
+    setDefaultEventParameters(params?: { [key: string]: any }): Promise<void>;
   }
 }
 

packages/analytics/lib/index.js

@@ -666,6 +666,16 @@ class FirebaseAnalyticsModule extends FirebaseModule {
       ),
     );
   }
+
+  setDefaultEventParameters(params) {
+    if (!isObject(params) && !isNull(params) && !isUndefined(params)) {
+      throw new Error(
+        "firebase.analytics().setDefaultEventParameters(*) 'params' expected an object value when it is defined.",
+      );
+    }
+
+    return this.native.setDefaultEventParameters(params);
+  }
 }
 
 // import { SDK_VERSION } from '@react-native-firebase/analytics';