Implement client logging

Author: Feiyang1

packages-exp/app-exp/src/api.test.ts

@@ -16,24 +16,35 @@
  */
 
 import { expect } from 'chai';
-import { stub } from 'sinon';
+import { stub, spy } from 'sinon';
 import '../test/setup';
 import {
   initializeApp,
   getApps,
   deleteApp,
   getApp,
-  registerVersion
+  registerVersion,
+  setLogLevel,
+  LogLevel,
+  onLog
 } from './api';
 import { DEFAULT_ENTRY_NAME } from './constants';
 import { FirebaseAppInternal } from '@firebase/app-types-exp';
-import { clearComponents, components, registerComponent } from './internal';
+import { clearComponents, components, registerComponent, getProvider } from './internal';
 import { createTestComponent } from '../test/util';
+import { Component, ComponentType } from '@firebase/component';
+import { Logger } from '@firebase/logger';
+
+declare module '@firebase/component' {
+  interface NameServiceMapping {
+    'test-shell': void;
+  }
+}
 
 describe('API tests', () => {
   afterEach(() => {
     for (const app of getApps()) {
-      deleteApp(app).catch(() => {});
+      deleteApp(app).catch(() => { });
     }
   });
 
@@ -132,7 +143,7 @@ describe('API tests', () => {
       const app1 = initializeApp({});
       const app2 = initializeApp({}, 'App2');
 
-      deleteApp(app1).catch(() => {});
+      deleteApp(app1).catch(() => { });
 
       const apps = getApps();
 
@@ -146,15 +157,15 @@ describe('API tests', () => {
       const app = initializeApp({});
       expect((app as FirebaseAppInternal).isDeleted).to.be.false;
 
-      await deleteApp(app).catch(() => {});
+      await deleteApp(app).catch(() => { });
       expect((app as FirebaseAppInternal).isDeleted).to.be.true;
     });
 
     it('removes App from the cache', () => {
       const app = initializeApp({});
       expect(getApps().length).to.equal(1);
 
-      deleteApp(app).catch(() => {});
+      deleteApp(app).catch(() => { });
       expect(getApps().length).to.equal(0);
     });
   });
@@ -199,4 +210,73 @@ describe('API tests', () => {
       expect(components.size).to.equal(initialSize);
     });
   });
+
+  describe('User Log Methods', () => {
+    describe('Integration Tests', () => {
+
+      beforeEach(() => {
+        clearComponents();
+      });
+
+      it(`respects log level set through setLogLevel()`, () => {
+        const warnSpy = spy(console, 'warn');
+        const infoSpy = spy(console, 'info');
+        const logSpy = spy(console, 'log');
+        const app = initializeApp({});
+        registerComponent(
+          new Component(
+            'test-shell',
+            () => {
+              const logger = new Logger('@firebase/logger-test');
+              logger.warn('hello');
+              expect(warnSpy.called).to.be.true;
+              setLogLevel(LogLevel.WARN);
+              logger.info('hi');
+              expect(infoSpy.called).to.be.false;
+              logger.log('hi');
+              expect(logSpy.called).to.be.false;
+              logSpy.resetHistory();
+              infoSpy.resetHistory();
+              setLogLevel(LogLevel.DEBUG);
+              logger.info('hi');
+              expect(infoSpy.called).to.be.true;
+              logger.log('hi');
+              expect(logSpy.called).to.be.true;
+              return {};
+            },
+            ComponentType.PUBLIC
+          )
+        );
+
+        getProvider(app, 'test-shell').getImmediate();
+      });
+
+      it(`correctly triggers callback given to onLog()`, () => {
+        const infoSpy = spy(console, 'info');
+        let result: any = null;
+        // Note: default log level is INFO.
+        const app = initializeApp({});
+        registerComponent(
+          new Component(
+            'test-shell',
+            () => {
+              const logger = new Logger('@firebase/logger-test');
+              onLog(logData => {
+                result = logData;
+              });
+              logger.info('hi');
+              expect(result.level).to.equal('info');
+              expect(result.message).to.equal('hi');
+              expect(result.args).to.deep.equal(['hi']);
+              expect(result.type).to.equal('@firebase/logger-test');
+              expect(infoSpy.called).to.be.true;
+              return {};
+            },
+            ComponentType.PUBLIC
+          )
+        );
+        getProvider(app, 'test-shell').getImmediate();
+      });
+    });
+  });
 });

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

@@ -33,6 +33,13 @@ import { version } from '../../../packages/firebase/package.json';
 import { FirebaseAppImpl } from './firebaseApp';
 import { apps, components, registerComponent } from './internal';
 import { logger } from './logger';
+import {
+  LogLevel,
+  setLogLevel as setLogLevelImpl,
+  LogCallback,
+  LogOptions,
+  setUserLogHandler
+} from '@firebase/logger';
 
 /**
  * The current SDK version.
@@ -243,3 +250,30 @@ export function registerVersion(
     )
   );
 }
+
+/**
+ * Sets log handler for all Firebase SDKs.
+ * @param logCallback An optional custom log handler that executes user code whenever
+ * the Firebase SDK makes a logging call.
+ */
+export function onLog(logCallback: LogCallback | null, options?: LogOptions): void {
+  if (logCallback !== null && typeof logCallback !== 'function') {
+    throw ERROR_FACTORY.create(AppError.INVALID_LOG_ARGUMENT, {
+      appName: name
+    });
+  }
+  setUserLogHandler(logCallback, options);
+}
+
+/**
+ * Sets log level for all Firebase SDKs.
+ *
+ * All of the log types above the current log level are captured (i.e. if
+ * you set the log level to `info`, errors are logged, but `debug` and
+ * `verbose` logs are not).
+ */
+export function setLogLevel(logLevel: LogLevel): void {
+  setLogLevelImpl(logLevel);
+}
+
+export { LogLevel } from '@firebase/logger';

packages-exp/app-exp/src/errors.ts

@@ -22,7 +22,8 @@ export const enum AppError {
   BAD_APP_NAME = 'bad-app-name',
   DUPLICATE_APP = 'duplicate-app',
   APP_DELETED = 'app-deleted',
-  INVALID_APP_ARGUMENT = 'invalid-app-argument'
+  INVALID_APP_ARGUMENT = 'invalid-app-argument',
+  INVALID_LOG_ARGUMENT = 'invalid-log-argument'
 }
 
 const ERRORS: ErrorMap<AppError> = {
@@ -34,7 +35,9 @@ const ERRORS: ErrorMap<AppError> = {
   [AppError.APP_DELETED]: "Firebase App named '{$appName}' already deleted",
   [AppError.INVALID_APP_ARGUMENT]:
     'firebase.{$appName}() takes either no argument or a ' +
-    'Firebase App instance.'
+    'Firebase App instance.',
+  [AppError.INVALID_LOG_ARGUMENT]:
+    'First argument to `onLog` must be null or a function.'
 };
 
 type ErrorParams = { [key in AppError]: { appName: string } };

packages-exp/app-exp/src/internal.test.ts

@@ -48,11 +48,12 @@ describe('Internal API tests', () => {
       const testComp = createTestComponent('test');
 
       addComponent(app, testComp);
-
+      
       expect(app.container.getProvider('test').getComponent()).to.equal(
         testComp
       );
     });
+
     it('does NOT throw registering duplicate components', () => {
       const app = initializeApp({}) as FirebaseAppInternal;
       const testComp = createTestComponent('test');

packages-exp/app-exp/src/internal.ts

@@ -30,11 +30,11 @@ export const components = new Map<string, Component<any>>();
  * @param component the component being added to this app's container
  */
 export function addComponent(
-  app: FirebaseAppInternal,
+  app: FirebaseApp,
   component: Component
 ): void {
   try {
-    app.container.addComponent(component);
+    (app as FirebaseAppInternal).container.addComponent(component);
   } catch (e) {
     logger.debug(
       `Component ${component.name} failed to register with FirebaseApp ${app.name}`,
@@ -44,10 +44,10 @@ export function addComponent(
 }
 
 export function addOrOverwriteComponent(
-  app: FirebaseAppInternal,
+  app: FirebaseApp,
   component: Component
 ): void {
-  app.container.addOrOverwriteComponent(component);
+  (app as FirebaseAppInternal).container.addOrOverwriteComponent(component);
 }
 
 /**
@@ -76,10 +76,10 @@ export function registerComponent(component: Component): boolean {
 }
 
 export function getProvider<T extends Name>(
-  app: FirebaseAppInternal,
+  app: FirebaseApp,
   name: T
 ): Provider<T> {
-  return app.container.getProvider(name);
+  return (app as FirebaseAppInternal).container.getProvider(name);
 }
 
 /**

packages-exp/app-exp/src/platformLoggerService.test.ts

@@ -30,7 +30,6 @@ declare module '@firebase/component' {
   interface NameServiceMapping {
     'vs1': VersionService;
     'vs2': VersionService;
-    'test-shell': Promise<void>;
   }
 }