api.test.ts

/**
 * @license
 * Copyright 2019 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { expect } from 'chai';
import { SinonStub, stub } from 'sinon';
import '../testing/setup';
import { getFullApp } from '../testing/get-fake-firebase-services';
import {
  getAnalytics,
  initializeAnalytics,
  setConsent,
  setDefaultEventParameters
} from './api';
import { FirebaseApp, deleteApp } from '@firebase/app';
import { AnalyticsError } from './errors';
import * as init from './initialize-analytics';
const fakeAppParams = { appId: 'abcdefgh12345:23405', apiKey: 'AAbbCCdd12345' };
import * as factory from './factory';
import {
  defaultConsentSettingsForInit,
  defaultEventParametersForInit
} from './functions';
import { ConsentSettings } from './public-types';

describe('FirebaseAnalytics API tests', () => {
  let initStub: SinonStub = stub();
  let app: FirebaseApp;
  const wrappedGtag: SinonStub = stub();

  beforeEach(() => {
    initStub = stub(init, '_initializeAnalytics').resolves(
      'FAKE_MEASUREMENT_ID'
    );
  });

  afterEach(async () => {
    await initStub();
    initStub.restore();
    if (app) {
      return deleteApp(app);
    }
  });

  after(() => {
    delete window['gtag'];
    delete window['dataLayer'];
  });

  it('initializeAnalytics() with same (no) options returns same instance', () => {
    app = getFullApp(fakeAppParams);
    const analyticsInstance = initializeAnalytics(app);
    const newInstance = initializeAnalytics(app);
    expect(analyticsInstance).to.equal(newInstance);
  });
  it('initializeAnalytics() with same options returns same instance', () => {
    app = getFullApp(fakeAppParams);
    const analyticsInstance = initializeAnalytics(app, {
      config: { 'send_page_view': false }
    });
    const newInstance = initializeAnalytics(app, {
      config: { 'send_page_view': false }
    });
    expect(analyticsInstance).to.equal(newInstance);
  });
  it('initializeAnalytics() with different options throws', () => {
    app = getFullApp(fakeAppParams);
    initializeAnalytics(app, {
      config: { 'send_page_view': false }
    });
    expect(() =>
      initializeAnalytics(app, {
        config: { 'send_page_view': true }
      })
    ).to.throw(AnalyticsError.ALREADY_INITIALIZED);
  });
  it('initializeAnalytics() with different options (one undefined) throws', () => {
    app = getFullApp(fakeAppParams);
    initializeAnalytics(app);
    expect(() =>
      initializeAnalytics(app, {
        config: { 'send_page_view': true }
      })
    ).to.throw(AnalyticsError.ALREADY_INITIALIZED);
  });
  it('getAnalytics() returns same instance created by previous getAnalytics()', () => {
    app = getFullApp(fakeAppParams);
    const analyticsInstance = getAnalytics(app);
    expect(getAnalytics(app)).to.equal(analyticsInstance);
  });
  it('getAnalytics() returns same instance created by initializeAnalytics()', () => {
    app = getFullApp(fakeAppParams);
    const analyticsInstance = initializeAnalytics(app);
    expect(getAnalytics(app)).to.equal(analyticsInstance);
  });
  it('setDefaultEventParameters() updates defaultEventParametersForInit if gtag does not exist ', () => {
    const eventParametersForInit = {
      'github_user': 'dwyfrequency',
      'company': 'google'
    };
    app = getFullApp(fakeAppParams);
    setDefaultEventParameters(eventParametersForInit);
    expect(defaultEventParametersForInit).to.deep.equal(eventParametersForInit);
  });
  it('setDefaultEventParameters() calls gtag set if wrappedGtagFunction exists', () => {
    const eventParametersForInit = {
      'github_user': 'dwyfrequency',
      'company': 'google'
    };
    stub(factory, 'wrappedGtagFunction').get(() => wrappedGtag);
    app = getFullApp(fakeAppParams);
    setDefaultEventParameters(eventParametersForInit);
    expect(wrappedGtag).to.have.been.calledWithExactly(
      'set',
      eventParametersForInit
    );
  });
  it('setConsent() updates defaultConsentSettingsForInit if gtag does not exist ', () => {
    const consentParametersForInit: ConsentSettings = {
      'analytics_storage': 'granted',
      'functionality_storage': 'denied'
    };
    stub(factory, 'wrappedGtagFunction').get(() => undefined);
    app = getFullApp(fakeAppParams);
    setConsent(consentParametersForInit);
    expect(defaultConsentSettingsForInit).to.deep.equal(
      consentParametersForInit
    );
  });
  it('setConsent() calls gtag consent "update" if wrappedGtagFunction exists', () => {
    const consentParametersForInit: ConsentSettings = {
      'analytics_storage': 'granted',
      'functionality_storage': 'denied'
    };
    stub(factory, 'wrappedGtagFunction').get(() => wrappedGtag);
    app = getFullApp(fakeAppParams);
    setConsent(consentParametersForInit);
    expect(wrappedGtag).to.have.been.calledWithExactly(
      'consent',
      'update',
      consentParametersForInit
    );
  });
});