voluptasmollitia/packages/app/test/platformLogger.test.ts

Monorepo for the Firebase JavaScript SDK

/**
 * @license
 * Copyright 2017 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 { FirebaseNamespace, VersionService } from '@firebase/app-types';
import {
  FirebaseService,
  _FirebaseNamespace
} from '@firebase/app-types/private';
import { createFirebaseNamespace } from '../src/firebaseNamespace';
import { expect } from 'chai';
import './setup';
import { PlatformLoggerService } from '../src/platformLoggerService';
import { registerCoreComponents } from '../src/registerCoreComponents';
import {
  Component,
  ComponentType,
  ComponentContainer
} from '@firebase/component';
import { version as appVersion } from '../package.json';

declare module '@firebase/component' {
  interface NameServiceMapping {
    'vs1': VersionService;
    'vs2': VersionService;
    'test-shell': FirebaseService;
  }
}

describe('Platform Logger Service', () => {
  describe('Unit Tests', () => {
    it(`logs core version`, () => {
      const container = new ComponentContainer('testContainer');
      container.addComponent(
        new Component(
          'vs1',
          () => ({ library: 'vs1', version: '1.2.3' }),
          ComponentType.VERSION
        )
      );
      container.addComponent(
        new Component(
          'vs2',
          () => ({ library: 'vs2', version: '3.02.01' }),
          ComponentType.VERSION
        )
      );
      const platformLoggerService = new PlatformLoggerService(container);
      const platformInfoString = platformLoggerService.getPlatformInfoString();
      expect(platformInfoString).to.include('vs1/1.2.3');
      expect(platformInfoString).to.include('vs2/3.02.01');
    });
  });

  describe('Integration Tests', () => {
    let firebase: FirebaseNamespace;

    beforeEach(() => {
      firebase = createFirebaseNamespace();
    });

    it(`logs core version`, () => {
      firebase.initializeApp({});
      registerCoreComponents(firebase);
      (firebase as _FirebaseNamespace).INTERNAL.registerComponent(
        new Component(
          'test-shell',
          (container: ComponentContainer) => {
            const platformLoggerProvider = container.getProvider(
              'platform-logger'
            );
            const platformLogger = platformLoggerProvider.getImmediate() as PlatformLoggerService;
            const platformInfoString = platformLogger.getPlatformInfoString();
            expect(platformInfoString).to.include(`fire-core/${appVersion}`);
            expect(platformInfoString).to.include('fire-js/');
            return {} as FirebaseService;
          },
          ComponentType.PUBLIC
        )
      );
      return (firebase as any)['test-shell']();
    });

    it(`logs core version with bundle variant`, () => {
      firebase.initializeApp({});
      registerCoreComponents(firebase, 'node');
      (firebase as _FirebaseNamespace).INTERNAL.registerComponent(
        new Component(
          'test-shell',
          (container: ComponentContainer) => {
            const platformLoggerProvider = container.getProvider(
              'platform-logger'
            );
            const platformLogger = platformLoggerProvider.getImmediate() as PlatformLoggerService;
            const platformInfoString = platformLogger.getPlatformInfoString();
            expect(platformInfoString).to.include(
              `fire-core-node/${appVersion}`
            );
            expect(platformInfoString).to.include('fire-js/');
            return {} as FirebaseService;
          },
          ComponentType.PUBLIC
        )
      );
      return (firebase as any)['test-shell']();
    });

    it(`logs other components' versions`, () => {
      firebase.initializeApp({});
      registerCoreComponents(firebase);
      (firebase as _FirebaseNamespace).registerVersion(
        '@firebase/analytics',
        '1.2.3'
      );
      (firebase as _FirebaseNamespace).INTERNAL.registerComponent(
        new Component(
          'test-shell',
          (container: ComponentContainer) => {
            const platformLoggerProvider = container.getProvider(
              'platform-logger'
            );
            const platformLogger = platformLoggerProvider.getImmediate() as PlatformLoggerService;
            const platformInfoString = platformLogger.getPlatformInfoString();
            expect(platformInfoString).to.include('fire-analytics/1.2.3');
            expect(platformInfoString).to.include('fire-js/');
            return {} as FirebaseService;
          },
          ComponentType.PUBLIC
        )
      );
      return (firebase as any)['test-shell']();
    });
  });
});