Add initializeAnalytics()

Author: hsubox76

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

@@ -24,7 +24,8 @@ import {
   AnalyticsCallOptions,
   CustomParams,
   EventNameString,
-  EventParams
+  EventParams,
+  SettingsOptions
 } from '@firebase/analytics-types-exp';
 import { Provider } from '@firebase/component';
 import {
@@ -37,7 +38,8 @@ import { ANALYTICS_TYPE } from './constants';
 import {
   AnalyticsService,
   initializationPromisesMap,
-  wrappedGtagFunction
+  wrappedGtagFunction,
+  settings
 } from './factory';
 import { logger } from './logger';
 import {
@@ -48,7 +50,6 @@ import {
   setAnalyticsCollectionEnabled as internalSetAnalyticsCollectionEnabled
 } from './functions';
 
-export { analyticsSettings } from './factory';
 export { EventName } from './constants';
 
 declare module '@firebase/component' {
@@ -57,15 +58,38 @@ declare module '@firebase/component' {
   }
 }
 
+/**
+ * Firebase Analytics initialization function that allows custom
+ * settings. Can be called at most once. If no custom settings
+ * are needed, `getAnalytics()` can be used to initialize instead.
+ *
+ * @public
+ *
+ * @param app - The FirebaseApp to use.
+ * @param options - Custom gtag and dataLayer names.
+ */
+export function initializeAnalytics(
+  app: FirebaseApp,
+  options: SettingsOptions
+): Analytics {
+  const analyticsProvider: Provider<'analytics-exp'> = _getProvider(
+    app,
+    ANALYTICS_TYPE
+  );
+  settings(options);
+  const analyticsInstance = analyticsProvider.getImmediate();
+  return analyticsInstance;
+}
+
 /**
  * Returns a Firebase Analytics instance for the given app.
+ * Initializes Firebase Analytics if not already initialized.
  *
  * @public
  *
  * @param app - The FirebaseApp to use.
  */
 export function getAnalytics(app: FirebaseApp): Analytics {
-  // Dependencies
   const analyticsProvider: Provider<'analytics-exp'> = _getProvider(
     app,
     ANALYTICS_TYPE

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

@@ -144,7 +144,7 @@ export function getGlobalVars(): {
  *
  * @param options - Custom gtag and dataLayer names.
  */
-export function analyticsSettings(options: SettingsOptions): void {
+export function settings(options: SettingsOptions): void {
   if (globalInitDone) {
     throw ERROR_FACTORY.create(AnalyticsError.ALREADY_INITIALIZED);
   }

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

@@ -19,7 +19,6 @@ import { expect } from 'chai';
 import { SinonStub, stub, useFakeTimers } from 'sinon';
 import '../testing/setup';
 import {
-  analyticsSettings,
   factory as analyticsFactory,
   resetGlobalVars,
   getGlobalVars
@@ -35,7 +34,7 @@ import { removeGtagScript } from '../testing/gtag-script-util';
 import { Deferred } from '@firebase/util';
 import { AnalyticsError } from './errors';
 import { logEvent } from './api';
-import { AnalyticsService } from './factory';
+import { AnalyticsService, settings } from './factory';
 import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
 
 let analyticsInstance: AnalyticsService = {} as AnalyticsService;
@@ -288,7 +287,7 @@ describe('FirebaseAnalytics instance tests', () => {
       );
       window[customGtagName] = gtagStub;
       window[customDataLayerName] = [];
-      analyticsSettings({
+      settings({
         dataLayerName: customDataLayerName,
         gtagName: customGtagName
       });

packages-exp/analytics-exp/testing/integration-tests/integration.ts

@@ -17,7 +17,12 @@
 
 import { initializeApp, deleteApp } from '@firebase/app-exp';
 import '@firebase/installations-exp';
-import { getAnalytics, logEvent, EventName } from '../../src/index';
+import {
+  getAnalytics,
+  logEvent,
+  EventName,
+  initializeAnalytics
+} from '../../src/index';
 import '../setup';
 import { expect } from 'chai';
 import { stub } from 'sinon';
@@ -35,26 +40,37 @@ try {
 
 const RETRY_INTERVAL = 1000;
 
+async function checkForEventCalls(): Promise<number> {
+  await new Promise(resolve => setTimeout(resolve, RETRY_INTERVAL));
+  const resources = performance.getEntriesByType('resource');
+  const callsWithEvent = resources.filter(
+    resource =>
+      resource.name.includes('google-analytics.com') &&
+      resource.name.includes('en=login')
+  );
+  if (callsWithEvent.length === 0) {
+    return checkForEventCalls();
+  } else {
+    return callsWithEvent.length;
+  }
+}
+
 describe('FirebaseAnalytics Integration Smoke Tests', () => {
   let app: FirebaseApp;
   afterEach(() => deleteApp(app));
+  it('intializeAnalytics() sets options', async () => {
+    app = initializeApp(config);
+    const analyticsInstance = initializeAnalytics(app, {
+      dataLayerName: 'testname'
+    });
+    expect(window['testname']).to.exist;
+    logEvent(analyticsInstance, EventName.LOGIN, { method: 'email' });
+    await checkForEventCalls();
+    expect((window['testname'] as any[]).length).to.be.at.least(1);
+  });
   it('logEvent() sends correct network request.', async () => {
     app = initializeApp(config);
     logEvent(getAnalytics(app), EventName.LOGIN, { method: 'email' });
-    async function checkForEventCalls(): Promise<number> {
-      await new Promise(resolve => setTimeout(resolve, RETRY_INTERVAL));
-      const resources = performance.getEntriesByType('resource');
-      const callsWithEvent = resources.filter(
-        resource =>
-          resource.name.includes('google-analytics.com') &&
-          resource.name.includes('en=login')
-      );
-      if (callsWithEvent.length === 0) {
-        return checkForEventCalls();
-      } else {
-        return callsWithEvent.length;
-      }
-    }
     const eventCallCount = await checkForEventCalls();
     expect(eventCallCount).to.equal(1);
   });