Propagate measurement ID change to analytics-exp (#4459)

Author: hsubox76

packages-exp/analytics-exp/src/factory.ts

@@ -22,12 +22,7 @@ import {
   MinimalDynamicConfig,
   Analytics
 } from '@firebase/analytics-types-exp';
-import {
-  insertScriptTag,
-  getOrCreateDataLayer,
-  wrapOrCreateGtag,
-  findGtagScriptOnPage
-} from './helpers';
+import { getOrCreateDataLayer, wrapOrCreateGtag } from './helpers';
 import { AnalyticsError, ERROR_FACTORY } from './errors';
 import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
 import { areCookiesEnabled, isBrowserExtension } from '@firebase/util';
@@ -60,9 +55,9 @@ export let initializationPromisesMap: {
  * wait on all these to be complete in order to determine if it can selectively
  * wait for only certain initialization (FID) promises or if it must wait for all.
  */
-let dynamicConfigPromisesList: Array<Promise<
-  DynamicConfig | MinimalDynamicConfig
->> = [];
+let dynamicConfigPromisesList: Array<
+  Promise<DynamicConfig | MinimalDynamicConfig>
+> = [];
 
 /**
  * Maps fetched measurementIds to appId. Populated when the app's dynamic config
@@ -214,10 +209,6 @@ export function factory(
     // Steps here should only be done once per page: creation or wrapping
     // of dataLayer and global gtag function.
 
-    // Detect if user has already put the gtag <script> tag on this page.
-    if (!findGtagScriptOnPage()) {
-      insertScriptTag(dataLayerName);
-    }
     getOrCreateDataLayer(dataLayerName);
 
     const { wrappedGtag, gtagCore } = wrapOrCreateGtag(
@@ -239,7 +230,8 @@ export function factory(
     dynamicConfigPromisesList,
     measurementIdToAppId,
     installations,
-    gtagCoreFunction
+    gtagCoreFunction,
+    dataLayerName
   );
 
   const analyticsInstance: AnalyticsService = new AnalyticsService(app);

packages-exp/analytics-exp/src/helpers.test.ts

@@ -57,10 +57,11 @@ describe('Gtag wrapping functions', () => {
 
   it('insertScriptIfNeeded inserts script tag', () => {
     expect(findGtagScriptOnPage()).to.be.null;
-    insertScriptTag('customDataLayerName');
+    insertScriptTag('customDataLayerName', fakeMeasurementId);
     const scriptTag = findGtagScriptOnPage();
     expect(scriptTag).to.not.be.null;
     expect(scriptTag!.src).to.contain(`l=customDataLayerName`);
+    expect(scriptTag!.src).to.contain(`id=${fakeMeasurementId}`);
   });
 
   describe('wrapOrCreateGtag() when user has not previously inserted a gtag script tag on this page', () => {

packages-exp/analytics-exp/src/helpers.ts

@@ -43,11 +43,14 @@ export function promiseAllSettled<T>(
  * Inserts gtag script tag into the page to asynchronously download gtag.
  * @param dataLayerName Name of datalayer (most often the default, "_dataLayer").
  */
-export function insertScriptTag(dataLayerName: string): void {
+export function insertScriptTag(
+  dataLayerName: string,
+  measurementId: string
+): void {
   const script = document.createElement('script');
   // We are not providing an analyticsId in the URL because it would trigger a `page_view`
   // without fid. We will initialize ga-id using gtag (config) command together with fid.
-  script.src = `${GTAG_URL}?l=${dataLayerName}`;
+  script.src = `${GTAG_URL}?l=${dataLayerName}&id=${measurementId}`;
   script.async = true;
   document.head.appendChild(script);
 }

packages-exp/analytics-exp/src/index.test.ts

@@ -100,7 +100,11 @@ describe('FirebaseAnalytics instance tests', () => {
       );
     });
     it('Warns if config has no apiKey but does have a measurementId', async () => {
+      // Since this is a warning and doesn't block the rest of initialization
+      // all the async stuff needs to be stubbed and cleaned up.
       const warnStub = stub(console, 'warn');
+      const docStub = stub(document, 'createElement');
+      stubFetch(200, { measurementId: fakeMeasurementId });
       const app = getFakeApp({
         appId: fakeAppParams.appId,
         measurementId: fakeMeasurementId
@@ -115,7 +119,11 @@ describe('FirebaseAnalytics instance tests', () => {
         `Falling back to the measurement ID ${fakeMeasurementId}`
       );
       warnStub.restore();
+      docStub.restore();
+      fetchStub.restore();
       idbOpenStub.restore();
+      delete window['gtag'];
+      delete window['dataLayer'];
     });
     it('Throws if creating an instance with already-used appId', () => {
       const app = getFakeApp(fakeAppParams);
@@ -206,6 +214,7 @@ describe('FirebaseAnalytics instance tests', () => {
     afterEach(() => {
       delete window['gtag'];
       delete window['dataLayer'];
+      removeGtagScript();
       fetchStub.restore();
       clock.restore();
       warnStub.restore();

packages-exp/analytics-exp/src/initialize-analytics.test.ts

@@ -28,6 +28,7 @@ import { DynamicConfig } from '@firebase/analytics-types-exp';
 import { FirebaseApp } from '@firebase/app-types-exp';
 import { Deferred } from '@firebase/util';
 import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
+import { removeGtagScript } from '../testing/gtag-script-util';
 
 const fakeMeasurementId = 'abcd-efgh-ijkl';
 const fakeFid = 'fid-1234-zyxw';
@@ -60,6 +61,7 @@ describe('initializeIds()', () => {
   });
   afterEach(() => {
     fetchStub.restore();
+    removeGtagScript();
   });
   it('gets FID and measurement ID and calls gtag config with them', async () => {
     stubFetch();
@@ -68,7 +70,8 @@ describe('initializeIds()', () => {
       dynamicPromisesList,
       measurementIdToAppId,
       fakeInstallations,
-      gtagStub
+      gtagStub,
+      'dataLayer'
     );
     expect(gtagStub).to.be.calledWith(GtagCommand.CONFIG, fakeMeasurementId, {
       'firebase_id': fakeFid,
@@ -83,7 +86,8 @@ describe('initializeIds()', () => {
       dynamicPromisesList,
       measurementIdToAppId,
       fakeInstallations,
-      gtagStub
+      gtagStub,
+      'dataLayer'
     );
     const dynamicPromiseResult = await dynamicPromisesList[0];
     expect(dynamicPromiseResult.measurementId).to.equal(fakeMeasurementId);
@@ -96,7 +100,8 @@ describe('initializeIds()', () => {
       dynamicPromisesList,
       measurementIdToAppId,
       fakeInstallations,
-      gtagStub
+      gtagStub,
+      'dataLayer'
     );
     expect(measurementIdToAppId[fakeMeasurementId]).to.equal(fakeAppId);
   });
@@ -108,7 +113,8 @@ describe('initializeIds()', () => {
       dynamicPromisesList,
       measurementIdToAppId,
       fakeInstallations,
-      gtagStub
+      gtagStub,
+      'dataLayer'
     );
     expect(consoleStub.args[0][1]).to.include(fakeMeasurementId);
     expect(consoleStub.args[0][1]).to.include('old-measurement-id');

packages-exp/analytics-exp/src/initialize-analytics.ts

@@ -30,6 +30,7 @@ import {
   validateIndexedDBOpenable
 } from '@firebase/util';
 import { ERROR_FACTORY, AnalyticsError } from './errors';
+import { findGtagScriptOnPage, insertScriptTag } from './helpers';
 
 async function validateIndexedDB(): Promise<boolean> {
   if (!isIndexedDBAvailable()) {
@@ -74,7 +75,8 @@ export async function initializeAnalytics(
   >,
   measurementIdToAppId: { [key: string]: string },
   installations: _FirebaseInstallationsInternal,
-  gtagCore: Gtag
+  gtagCore: Gtag,
+  dataLayerName: string
 ): Promise<string> {
   const dynamicConfigPromise = fetchDynamicConfigWithRetry(app);
   // Once fetched, map measurementIds to appId, for ease of lookup in wrapped gtag function.
@@ -113,6 +115,11 @@ export async function initializeAnalytics(
     fidPromise
   ]);
 
+  // Detect if user has already put the gtag <script> tag on this page.
+  if (!findGtagScriptOnPage()) {
+    insertScriptTag(dataLayerName, dynamicConfig.measurementId);
+  }
+
   // This command initializes gtag.js and only needs to be called once for the entire web app,
   // but since it is idempotent, we can call it multiple times.
   // We keep it together with other initialization logic for better code structure.
@@ -131,6 +138,8 @@ export async function initializeAnalytics(
 
   // It should be the first config command called on this GA-ID
   // Initialize this GA-ID and set FID on it using the gtag config API.
+  // Note: This will trigger a page_view event unless 'send_page_view' is set to false in
+  // `configProperties`.
   gtagCore(GtagCommand.CONFIG, dynamicConfig.measurementId, configProperties);
   return dynamicConfig.measurementId;
 }