fix(analytics): Type defs (#8363)

* Type defs fix
* Test for function definition
* feat(analytics): Get CID
* feat(analytics): e2e tests for getCid()
* fix: ensure method is exposed
* test(other): install async-storage for Other e2e analytics testing

also implements the modular API definition for setReactNativeAsyncStorage

* fix(analytics, other): bind getAppInstanceId to _getCid in web module

this correctly binds the Other platform analytics implementation of _getCid
to the getAppInstanceId exported method and exposes it so it works, verified
in testing

* fix(analytics): use more compatible multi-line string format

the previous triple-backtick style was registering as an error on
some platforms

* test(analytics): modular test suite is now deprecation-clean

* fix(auth, other): reformat persistence warning for wide compatibility

---------

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

Author: MichaelVerdon

packages/analytics/__tests__/analytics.test.ts

@@ -4,6 +4,7 @@ import {
   firebase,
   getAnalytics,
   initializeAnalytics,
+  getGoogleAnalyticsClientId,
   logEvent,
   setAnalyticsCollectionEnabled,
   setSessionTimeoutDuration,
@@ -711,6 +712,10 @@ describe('Analytics', function () {
       expect(initializeAnalytics).toBeDefined();
     });
 
+    it('`getGoogleAnalyticsClientId` function is properly exposed to end user', function () {
+      expect(getGoogleAnalyticsClientId).toBeDefined();
+    });
+
     it('`logEvent` function is properly exposed to end user', function () {
       expect(logEvent).toBeDefined();
     });

packages/analytics/e2e/analytics.e2e.js

@@ -14,13 +14,23 @@
  * limitations under the License.
  *
  */
-
-describe('analytics() modular', function () {
+describe('analytics()', function () {
   beforeEach(async function () {
-    await firebase.analytics().logEvent('screen_view');
+    const { getAnalytics, logEvent } = analyticsModular;
+    await logEvent(getAnalytics(), 'screen_view');
   });
 
   describe('firebase v8 compatibility', function () {
+    beforeEach(async function beforeEachTest() {
+      // @ts-ignore
+      globalThis.RNFB_SILENCE_MODULAR_DEPRECATION_WARNINGS = true;
+    });
+
+    afterEach(async function afterEachTest() {
+      // @ts-ignore
+      globalThis.RNFB_SILENCE_MODULAR_DEPRECATION_WARNINGS = false;
+    });
+
     describe('logEvent()', function () {
       it('log an event without parameters', async function () {
         await firebase.analytics().logEvent('invertase_event');
@@ -549,9 +559,10 @@ describe('analytics() modular', function () {
   describe('modular', function () {
     describe('getAnalytics', function () {
       it('pass app as argument', function () {
+        const { getApp } = modular;
         const { getAnalytics } = analyticsModular;
 
-        const analytics = getAnalytics(firebase.app());
+        const analytics = getAnalytics(getApp());
 
         analytics.constructor.name.should.be.equal('FirebaseAnalyticsModule');
       });
@@ -1133,5 +1144,29 @@ describe('analytics() modular', function () {
         await setConsent(getAnalytics(), consentSettings);
       });
     });
+
+    describe('getGoogleAnalyticsClientId()', function () {
+      it('Error for getGoogleAnalyticsClientId() on non-other platforms', async function () {
+        if (Platform.other) {
+          this.skip();
+        }
+        try {
+          const { getAnalytics, getGoogleAnalyticsClientId } = analyticsModular;
+          await getGoogleAnalyticsClientId(getAnalytics());
+          fail('Should have thrown an error');
+        } catch (e) {
+          e.message.should.equal('getGoogleAnalyticsClientId is web-only.');
+        }
+      });
+
+      it('getGoogleAnalyticsClientId() works on other platform', async function () {
+        const { getAnalytics, getGoogleAnalyticsClientId } = analyticsModular;
+        if (!Platform.other) {
+          this.skip();
+        }
+        let cid = await getGoogleAnalyticsClientId(getAnalytics());
+        cid.should.not.be.empty;
+      });
+    });
   });
 });

packages/analytics/lib/modular/index.d.ts

@@ -23,6 +23,14 @@ export declare function initializeAnalytics(
   options?: FirebaseAnalyticsTypes.AnalyticsSettings,
 ): Analytics;
 
+/**
+ * Retrieves a unique Google Analytics identifier for the web client.
+ *
+ * @param analyticsInstance - Instance of analytics (web - only)
+ *
+ */
+export declare function getGoogleAnalyticsClientId(analyticsInstance: Analytics): Promise<string>;
+
 /**
  * Log a custom event with optional params. Note that there are various limits that applied
  * to event parameters (total parameter count, etc), but analytics applies the limits during
@@ -605,10 +613,14 @@ export function getAppInstanceId(analytics: Analytics): Promise<string | null>;
  * Gives a user a unique identification.
  *
  * @param analytics Analytics instance.
- * @param id Set to null to remove a previously assigned ID from analytics
- * events
+ * @param id Set to null to remove a previously assigned ID from analytics events
+ * @param options Additional options that can be passed to Analytics method calls such as logEvent, etc.
  */
-export function setUserId(analytics: Analytics, id: string | null): Promise<void>;
+export function setUserId(
+  analytics: Analytics,
+  id: string | null,
+  options?: AnalyticsCallOptions,
+): Promise<void>;
 
 /**
  * Sets a key/value pair of data on the current user. Each Firebase project can have up to 25 uniquely named (case-sensitive) user properties.

packages/analytics/lib/modular/index.js

@@ -1,4 +1,5 @@
 import { getApp } from '@react-native-firebase/app';
+import { Platform } from 'react-native';
 
 /**
  * @typedef {import('@firebase/app').FirebaseApp} FirebaseApp
@@ -64,6 +65,20 @@ export function initializeAnalytics(app, options) {
   return getApp(app.name).analytics();
 }
 
+/**
+ * Retrieves a unique Google Analytics identifier for the web client.
+ *
+ * @param {FirebaseAnalytics} analytics - Instance of analytics (web - only)
+ * @returns {Promise<string>}
+ */
+export async function getGoogleAnalyticsClientId(analytics) {
+  if (Platform.OS === 'android' || Platform.OS === 'ios') {
+    throw new Error('getGoogleAnalyticsClientId is web-only.');
+  } else {
+    return getAppInstanceId(analytics);
+  }
+}
+
 /**
  * Log a custom event with optional params.
  * @param {FirebaseAnalytics} analytics - Analytics instance.

packages/analytics/lib/web/RNFBAnalyticsModule.js

@@ -5,8 +5,8 @@ import { AnalyticsApi } from './api';
 
 let analyticsInstances = {};
 
-function getAnalyticsApi() {
-  const app = getApp('[DEFAULT]');
+function getAnalyticsApi(appName) {
+  const app = getApp(appName);
   const measurementId = app.options.measurementId;
   if (!measurementId) {
     // eslint-disable-next-line no-console
@@ -104,9 +104,9 @@ export default {
   },
 
   getAppInstanceId() {
-    // Unsupported for web.
     return guard(async () => {
-      return null;
+      const api = getAnalyticsApi('[DEFAULT]');
+      return api._getCid();
     });
   },
 

packages/analytics/lib/web/api.js

@@ -171,24 +171,22 @@ class AnalyticsApi {
     await setItem('analytics:cid', this.cid);
     if (isMemoryStorage()) {
       console.warn(
-        ```
-Firebase Analytics is using in memory persistence. This means that the analytics
-client ID is reset every time your app is restarted which may result in 
-inaccurate data being shown on the Firebase Analytics dashboard.
-
-To enable persistence, provide an Async Storage implementation.
-
-For example, to use React Native Async Storage:
-
-  import AsyncStorage from '@react-native-async-storage/async-storage';
-
-  // Before initializing Firebase set the Async Storage implementation
-  // that will be used to persist user sessions.
-  firebase.setReactNativeAsyncStorage(AsyncStorage);
-
-  // Then initialize Firebase as normal.
-  await firebase.initializeApp({ ... });
-```,
+        'Firebase Analytics is using in memory persistence. This means that the analytics\n' +
+          'client ID is reset every time your app is restarted which may result in\n' +
+          'inaccurate data being shown on the Firebase Analytics dashboard.\n' +
+          '\n' +
+          'To enable persistence, provide an Async Storage implementation.\n' +
+          '\n' +
+          'For example, to use React Native Async Storage:\n' +
+          '\n' +
+          "  import AsyncStorage from '@react-native-async-storage/async-storage';\n" +
+          '\n' +
+          '  // Before initializing Firebase set the Async Storage implementation\n' +
+          '  // that will be used to persist user sessions.\n' +
+          '  firebase.setReactNativeAsyncStorage(AsyncStorage);\n' +
+          '\n' +
+          '  // Then initialize Firebase as normal.\n' +
+          '  await firebase.initializeApp({ ... });\n',
       );
     }
     return this.cid;

packages/app/lib/internal/registry/app.js

@@ -218,26 +218,22 @@ export function setLogLevel(logLevel) {
 }
 
 export function setReactNativeAsyncStorage(asyncStorage) {
+  warnIfNotModularCall(arguments, 'setReactNativeAsyncStorage()');
+
   if (!isObject(asyncStorage)) {
-    throw new Error("firebase.setReactNativeAsyncStorage(*) 'asyncStorage' must be an object.");
+    throw new Error("setReactNativeAsyncStorage(*) 'asyncStorage' must be an object.");
   }
 
   if (!isFunction(asyncStorage.setItem)) {
-    throw new Error(
-      "firebase.setReactNativeAsyncStorage(*) 'asyncStorage.setItem' must be a function.",
-    );
+    throw new Error("setReactNativeAsyncStorage(*) 'asyncStorage.setItem' must be a function.");
   }
 
   if (!isFunction(asyncStorage.getItem)) {
-    throw new Error(
-      "firebase.setReactNativeAsyncStorage(*) 'asyncStorage.getItem' must be a function.",
-    );
+    throw new Error("setReactNativeAsyncStorage(*) 'asyncStorage.getItem' must be a function.");
   }
 
   if (!isFunction(asyncStorage.removeItem)) {
-    throw new Error(
-      "firebase.setReactNativeAsyncStorage(*) 'asyncStorage.removeItem' must be a function.",
-    );
+    throw new Error("setReactNativeAsyncStorage(*) 'asyncStorage.removeItem' must be a function.");
   }
 
   setReactNativeAsyncStorageInternal(asyncStorage);

packages/app/lib/modular/index.d.ts

@@ -70,3 +70,11 @@ export function getApp(name?: string): FirebaseApp;
  * @returns void
  */
 export function setLogLevel(logLevel: LogLevelString): void;
+
+/**
+ * The `AsyncStorage` implementation to use for persisting data on 'Other' platforms.
+ * If not specified, in memory persistence is used.
+ *
+ * This is required if you want to persist things like Auth sessions, Analytics device IDs, etc.
+ */
+export function setReactNativeAsyncStorage(asyncStorage: ReactNativeAsyncStorage): void;

packages/app/lib/modular/index.js

@@ -6,6 +6,7 @@ import {
   getApps as getAppsCompat,
   initializeApp as initializeAppCompat,
   setLogLevel as setLogLevelCompat,
+  setReactNativeAsyncStorage as setReactNativeAsyncStorageCompat,
 } from '../internal';
 import { setUserLogHandler } from '../internal/logger';
 import sdkVersion from '../version';
@@ -84,4 +85,14 @@ export function setLogLevel(logLevel) {
   return setLogLevelCompat.call(null, logLevel, MODULAR_DEPRECATION_ARG);
 }
 
+/**
+ * The `AsyncStorage` implementation to use for persisting data on 'Other' platforms.
+ * If not specified, in memory persistence is used.
+ *
+ * This is required if you want to persist things like Auth sessions, Analytics device IDs, etc.
+ */
+export function setReactNativeAsyncStorage(asyncStorage) {
+  return setReactNativeAsyncStorageCompat.call(null, asyncStorage, MODULAR_DEPRECATION_ARG);
+}
+
 export const SDK_VERSION = sdkVersion;

packages/auth/lib/web/RNFBAuthModule.js

@@ -230,20 +230,18 @@ function getCachedAuthInstance(appName) {
       // Warn auth persistence is is disabled unless Async Storage implementation is provided.
       // eslint-disable-next-line no-console
       console.warn(
-        ```
-Firebase Auth persistence is disabled. To enable persistence, provide an Async Storage implementation.
-
-For example, to use React Native Async Storage:
-
-  import AsyncStorage from '@react-native-async-storage/async-storage';
-
-  // Before initializing Firebase set the Async Storage implementation
-  // that will be used to persist user sessions.
-  firebase.setReactNativeAsyncStorage(AsyncStorage);
-
-  // Then initialize Firebase as normal.
-  await firebase.initializeApp({ ... });
-```,
+        'Firebase Auth persistence is disabled. To enable persistence, provide an Async Storage implementation.\n' +
+          '\n' +
+          'For example, to use React Native Async Storage:\n' +
+          '\n' +
+          "  import AsyncStorage from '@react-native-async-storage/async-storage';\n" +
+          '\n' +
+          '  // Before initializing Firebase set the Async Storage implementation\n' +
+          '  // that will be used to persist user sessions.\n' +
+          '  firebase.setReactNativeAsyncStorage(AsyncStorage);\n' +
+          '\n' +
+          '  // Then initialize Firebase as normal.\n' +
+          '  await firebase.initializeApp({ ... });\n',
       );
     }
     instances[appName] = initializeAuth(getApp(appName), {