Move API functionality to internal function

Author: dwyfrequency

packages/analytics/src/api.test.ts

@@ -36,8 +36,6 @@ import {
   defaultEventParametersForInit
 } from './functions';
 import { ConsentSettings } from './public-types';
-import { GtagCommand } from './constants';
-import * as util from '@firebase/util';
 
 describe('FirebaseAnalytics API tests', () => {
   let initStub: SinonStub = stub();
@@ -157,19 +155,4 @@ describe('FirebaseAnalytics API tests', () => {
       consentParametersForInit
     );
   });
-  it('getGoogleAnalyticsClientId() calls gtag "get" through wrappedGtagFunction', () => {
-    stub(factory, 'wrappedGtagFunction').get(() => wrappedGtag);
-    stub(util, 'getModularInstance').returns({
-      app: { options: { measurementId: 'measurement-id-1' } }
-    });
-    app = getFullApp({ ...fakeAppParams, measurementId: 'measurement-id-1' });
-    const analyticsInstance = initializeAnalytics(app);
-    const id = getGoogleAnalyticsClientId(analyticsInstance);
-    console.log({ didWeGetTheId: id });
-    expect(wrappedGtag).to.have.been.calledWith(
-      GtagCommand.GET,
-      'measurement-id-1',
-      'client_id'
-    );
-  });
 });

packages/analytics/src/api.ts

@@ -50,7 +50,8 @@ import {
   setUserProperties as internalSetUserProperties,
   setAnalyticsCollectionEnabled as internalSetAnalyticsCollectionEnabled,
   _setConsentDefaultForInit,
-  _setDefaultEventParametersForInit
+  _setDefaultEventParametersForInit,
+  internalGetGoogleAnalyticsClientId
 } from './functions';
 import { ERROR_FACTORY, AnalyticsError } from './errors';
 
@@ -175,31 +176,14 @@ export function setCurrentScreen(
  *
  * @param app - The {@link @firebase/app#FirebaseApp} to use.
  */
-export async function getGoogleAnalyticsClientId(
+export function getGoogleAnalyticsClientId(
   analyticsInstance: Analytics
 ): Promise<string> {
   analyticsInstance = getModularInstance(analyticsInstance);
-  const measurementId = analyticsInstance.app.options.measurementId;
-  let clientId = '';
-  if (!measurementId) {
-    logger.error('The app has no recognizable measurement ID.');
-  } else {
-    clientId = await new Promise((resolve, reject) => {
-      wrappedGtagFunction(
-        GtagCommand.GET,
-        measurementId,
-        'client_id',
-        (fieldName: string) => {
-          if (!fieldName) {
-            reject('There was an issue retrieving the `client_id`');
-          }
-          resolve(fieldName);
-        }
-      );
-    });
-  }
-
-  return clientId;
+  return internalGetGoogleAnalyticsClientId(
+    wrappedGtagFunction,
+    initializationPromisesMap[analyticsInstance.app.options.measurementId!]
+  );
 }
 
 /**

packages/analytics/src/functions.test.ts

@@ -27,10 +27,12 @@ import {
   defaultEventParametersForInit,
   _setDefaultEventParametersForInit,
   _setConsentDefaultForInit,
-  defaultConsentSettingsForInit
+  defaultConsentSettingsForInit,
+  internalGetGoogleAnalyticsClientId
 } from './functions';
 import { GtagCommand } from './constants';
 import { ConsentSettings } from './public-types';
+import { Gtag } from './types';
 
 const fakeMeasurementId = 'abcd-efgh-ijkl';
 const fakeInitializationPromise = Promise.resolve(fakeMeasurementId);
@@ -238,4 +240,34 @@ describe('FirebaseAnalytics methods', () => {
       ...additionalParams
     });
   });
+  it('internalGetGoogleAnalyticsClientId() rejects when no client_id is available', async () => {
+    await expect(
+      internalGetGoogleAnalyticsClientId(
+        function fakeWrappedGtag(
+          unused1: unknown,
+          unused2: unknown,
+          unused3: unknown,
+          callBackStub: (fieldName: string) => {}
+        ): void {
+          callBackStub('');
+        } as Gtag,
+        fakeInitializationPromise
+      )
+    ).to.be.rejectedWith('There was an issue retrieving the `client_id`');
+  });
+  it('internalGetGoogleAnalyticsClientId() returns client_id when available', async () => {
+    const CLIENT_ID = 'clientId1234';
+    const id = await internalGetGoogleAnalyticsClientId(
+      function fakeWrappedGtag(
+        unused1: unknown,
+        unused2: unknown,
+        unused3: unknown,
+        callBackStub: (fieldName: string) => {}
+      ): void {
+        callBackStub(CLIENT_ID);
+      } as Gtag,
+      fakeInitializationPromise
+    );
+    expect(id).to.equal(CLIENT_ID);
+  });
 });

packages/analytics/src/functions.ts

@@ -24,6 +24,7 @@ import {
 } from './public-types';
 import { Gtag } from './types';
 import { GtagCommand } from './constants';
+import { logger } from './logger';
 
 /**
  * Event parameters to set on 'gtag' during initialization.
@@ -137,6 +138,42 @@ export async function setUserProperties(
   }
 }
 
+/**
+ * Retrieves a unique Google Analytics identifier for the web client.
+ * See {@link https://developers.google.com/analytics/devguides/collection/ga4/reference/config#client_id | client_id}.
+ *
+ * @public
+ *
+ * @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
+ * @param properties Map of user properties to set
+ */
+export async function internalGetGoogleAnalyticsClientId(
+  gtagFunction: Gtag,
+  initializationPromise: Promise<string>
+): Promise<string> {
+  const measurementId = await initializationPromise;
+  let clientId = '';
+  if (!measurementId) {
+    logger.error('The app has no recognizable measurement ID.');
+  } else {
+    clientId = await new Promise((resolve, reject) => {
+      gtagFunction(
+        GtagCommand.GET,
+        measurementId,
+        'client_id',
+        (fieldName: string) => {
+          console.log('inside the callback');
+          if (!fieldName) {
+            reject('There was an issue retrieving the `client_id`');
+          }
+          resolve(fieldName);
+        }
+      );
+    });
+  }
+  return clientId;
+}
+
 /**
  * Set whether collection is enabled for this ID.
  *