@firebase/logger

packages/database/package.json

@@ -20,6 +20,7 @@
   },
   "dependencies": {
     "@firebase/database-types": "0.1.2",
+    "@firebase/logger": "0.1.0",    
     "@firebase/util": "0.1.10",
     "faye-websocket": "0.11.1",
     "tslib": "^1.9.0"

packages/database/src/core/PersistentConnection.ts

@@ -935,7 +935,7 @@ export class PersistentConnection extends ServerActions {
     if (this.securityDebugCallback_) {
       this.securityDebugCallback_(body);
     } else {
-      if ('msg' in body && typeof console !== 'undefined') {
+      if ('msg' in body) {
         console.log('FIREBASE: ' + body['msg'].replace('\n', '\nFIREBASE: '));
       }
     }

packages/database/src/core/util/util.ts

@@ -27,6 +27,9 @@ import { stringToByteArray } from '@firebase/util';
 import { stringify } from '@firebase/util';
 import { SessionStorage } from '../storage/storage';
 import { isNodeSdk } from '@firebase/util';
+import { Logger } from '@firebase/logger';
+
+const logClient = new Logger('@firebase/database');
 
 /**
  * Returns a locally-unique ID (generated by just incrementing up from 0 each time its called).
@@ -105,16 +108,7 @@ export const enableLogging = function(
     "Can't turn on custom loggers persistently."
   );
   if (logger_ === true) {
-    if (typeof console !== 'undefined') {
-      if (typeof console.log === 'function') {
-        logger = console.log.bind(console);
-      } else if (typeof console.log === 'object') {
-        // IE does this.
-        logger = function(message) {
-          console.log(message);
-        };
-      }
-    }
+    logger = logClient.log.bind(logClient);
     if (persistent) SessionStorage.set('logging_enabled', true);
   } else if (typeof logger_ === 'function') {
     logger = logger_;
@@ -157,36 +151,25 @@ export const logWrapper = function(
  * @param {...string} var_args
  */
 export const error = function(...var_args: string[]) {
-  if (typeof console !== 'undefined') {
-    const message = 'FIREBASE INTERNAL ERROR: ' + buildLogMessage_(...var_args);
-    if (typeof console.error !== 'undefined') {
-      console.error(message);
-    } else {
-      console.log(message);
-    }
-  }
+  const message = 'FIREBASE INTERNAL ERROR: ' + buildLogMessage_(...var_args);
+  logClient.error(message);
 };
 
 /**
  * @param {...string} var_args
  */
 export const fatal = function(...var_args: string[]) {
-  const message = buildLogMessage_(...var_args);
-  throw new Error('FIREBASE FATAL ERROR: ' + message);
+  const message = `FIREBASE FATAL ERROR: ${buildLogMessage_(...var_args)}`;
+  logClient.error(message);
+  throw new Error(message);
 };
 
 /**
  * @param {...*} var_args
  */
 export const warn = function(...var_args: any[]) {
-  if (typeof console !== 'undefined') {
-    const message = 'FIREBASE WARNING: ' + buildLogMessage_(...var_args);
-    if (typeof console.warn !== 'undefined') {
-      console.warn(message);
-    } else {
-      console.log(message);
-    }
-  }
+  const message = 'FIREBASE WARNING: ' + buildLogMessage_(...var_args);
+  logClient.warn(message);
 };
 
 /**

packages/firestore/package.json

@@ -23,6 +23,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@firebase/firestore-types": "0.2.2",
+    "@firebase/logger": "0.1.0",
     "@firebase/webchannel-wrapper": "0.2.6",
     "grpc": "^1.9.1",
     "tslib": "^1.9.0"

packages/firestore/src/util/log.ts

@@ -19,36 +19,58 @@
 import { SDK_VERSION } from '../core/version';
 import { AnyJs } from './misc';
 import { PlatformSupport } from '../platform/platform';
+import { Logger, LogLevel as FirebaseLogLevel } from '@firebase/logger';
+
+const logClient = new Logger('@firebase/firestore');
 
 export enum LogLevel {
   DEBUG,
   ERROR,
   SILENT
 }
 
-let logLevel = LogLevel.ERROR;
-
 // Helper methods are needed because variables can't be exported as read/write
 export function getLogLevel(): LogLevel {
-  return logLevel;
+  if (logClient.logLevel === FirebaseLogLevel.DEBUG) {
+    return LogLevel.DEBUG;
+  } else if (logClient.logLevel === FirebaseLogLevel.SILENT) {
+    return LogLevel.SILENT;
+  } else {
+    return LogLevel.ERROR;
+  }
 }
 export function setLogLevel(newLevel: LogLevel): void {
-  logLevel = newLevel;
+  /**
+   * Map the new log level to the associated Firebase Log Level
+   */
+  switch (newLevel) {
+    case LogLevel.DEBUG:
+      logClient.logLevel = FirebaseLogLevel.DEBUG;
+      break;
+    case LogLevel.ERROR:
+      logClient.logLevel = FirebaseLogLevel.ERROR;
+      break;
+    case LogLevel.SILENT:
+      logClient.logLevel = FirebaseLogLevel.SILENT;
+      break;
+    default:
+      logClient.error(
+        `Firestore (${SDK_VERSION}): Invalid value passed to \`setLogLevel\``
+      );
+  }
 }
 
 export function debug(tag: string, msg: string, ...obj: AnyJs[]): void {
-  if (logLevel <= LogLevel.DEBUG) {
-    const time = new Date().toISOString();
+  if (logClient.logLevel <= FirebaseLogLevel.DEBUG) {
     const args = obj.map(argToString);
-    console.log(`Firestore (${SDK_VERSION}) ${time} [${tag}]: ${msg}`, ...args);
+    logClient.debug(`Firestore (${SDK_VERSION}) [${tag}]: ${msg}`, ...args);
   }
 }
 
 export function error(msg: string, ...obj: AnyJs[]): void {
-  if (logLevel <= LogLevel.ERROR) {
-    const time = new Date().toISOString();
+  if (logClient.logLevel <= FirebaseLogLevel.ERROR) {
     const args = obj.map(argToString);
-    console.error(`Firestore (${SDK_VERSION}) ${time}: ${msg}`, ...args);
+    logClient.error(`Firestore (${SDK_VERSION}): ${msg}`, ...args);
   }
 }
 

packages/logger/.npmignore

@@ -0,0 +1 @@
+# This file is left intentionally blank

packages/logger/README.md

@@ -0,0 +1,39 @@
+# @firebase/logger
+
+This package serves as the base of all logging in the JS SDK. Any logging that
+is intended to be for firebase end developers, should go through this module.
+
+## Basic Usage
+
+Firebase components should import the `Logger` class and instantiate a new
+instance by passing a component name (e.g. `@firebase/<COMPONENT>`) to the
+constructor.
+
+_e.g._
+
+```typescript
+import { Logger } from '@firebase/logger';
+
+const logClient = new Logger(`@firebase/<COMPONENT>`);
+```
+
+Each `Logger` instance supports 5 log functions each to be used in a specific
+instance:
+
+- `debug`: Internal logs; use this to allow developers to send us their debug
+  logs for us to be able to diagnose an issue.
+- `log`: Use to inform your user about things they may need to know.
+- `info`: Use if you have to inform the user about something that they need to
+  take a concrete action on. Once they take that action, the log should go away.
+- `warn`: Use when a product feature may stop functioning correctly; unexpected
+  scenario. Majority of user-facing logs.
+- `error`: Only use when user App would stop functioning correctly - super rare!
+
+## Log Format
+
+Each log will be formatted in the following manner:
+
+```typescript
+`[${new Date()}]  ${COMPONENT_NAME}: ${...args}`
+```
+

packages/logger/gulpfile.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2017 Google Inc.
+ *
+ * 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.
+ */
+
+const gulp = require('gulp');
+const tools = require('../../tools/build');
+
+const buildModule = gulp.parallel([
+  tools.buildCjs(__dirname),
+  tools.buildEsm(__dirname)
+]);
+
+const setupWatcher = () => {
+  gulp.watch(['index.ts', 'src/**/*'], buildModule);
+};
+
+gulp.task('build', buildModule);
+
+gulp.task('dev', gulp.parallel([setupWatcher]));

packages/logger/index.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright 2017 Google Inc.
+ *
+ * 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 { instances, LogLevel } from './src/logger';
+
+export function setLogLevel(level: LogLevel) {
+  instances.forEach(inst => {
+    inst.logLevel = level;
+  });
+}
+
+export { Logger, LogLevel, LogHandler } from './src/logger';

packages/logger/karma.conf.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2017 Google Inc.
+ *
+ * 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.
+ */
+
+const karma = require('karma');
+const path = require('path');
+const karmaBase = require('../../config/karma.base');
+
+module.exports = function(config) {
+  const karmaConfig = Object.assign({}, karmaBase, {
+    // files to load into karma
+    files: [{ pattern: `test/**/*` }],
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ['mocha']
+  });
+
+  config.set(karmaConfig);
+};

packages/logger/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@firebase/logger",
+  "version": "0.1.0",
+  "private": true,
+  "description": "A logger package for use in the Firebase JS SDK",
+  "author": "Firebase <[email protected]> (https://firebase.google.com/)",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "scripts": {
+    "dev": "gulp dev",
+    "test": "run-p test:browser test:node",
+    "test:browser": "karma start --single-run",
+    "test:browser:debug": "karma start --browsers Chrome --auto-watch",
+    "test:node": "nyc --reporter lcovonly -- mocha test/**/*.test.* --compilers ts:ts-node/register --exit",
+    "prepare": "gulp build"
+  },
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@types/chai": "^4.1.2",
+    "@types/mocha": "^2.2.48",
+    "@types/sinon": "^4.1.3",
+    "chai": "^4.1.1",
+    "gulp": "^4.0.0",
+    "karma": "^2.0.0",
+    "karma-chrome-launcher": "^2.2.0",
+    "karma-cli": "^1.0.1",
+    "karma-mocha": "^1.3.0",
+    "karma-sauce-launcher": "^1.2.0",
+    "karma-spec-reporter": "^0.0.32",
+    "karma-webpack": "^2.0.9",
+    "mocha": "^5.0.1",
+    "npm-run-all": "^4.1.1",
+    "nyc": "^11.4.1",
+    "ts-loader": "^3.5.0",
+    "ts-node": "^5.0.0",
+    "typescript": "^2.7.2",
+    "webpack": "^3.11.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/firebase/firebase-js-sdk/tree/master/packages/logger"
+  },
+  "bugs": {
+    "url": "https://github.com/firebase/firebase-js-sdk/issues"
+  },
+  "typings": "dist/esm/index.d.ts",
+  "nyc": {
+    "extension": [
+      ".ts"
+    ],
+    "reportDir": "./coverage/node"
+  },
+  "dependencies": {}
+}