@webex/plugin-logger 2.59.2 → 2.59.3-next.1

package/src/logger.js

@@ -1,427 +1,427 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-import {inBrowser, patterns} from '@webex/common';
-import {WebexHttpError, WebexPlugin} from '@webex/webex-core';
-import {cloneDeep, has, isArray, isObject, isString} from 'lodash';
-
-const precedence = {
-  silent: 0,
-  group: 1,
-  groupEnd: 2,
-  error: 3,
-  warn: 4,
-  log: 5,
-  info: 6,
-  debug: 7,
-  trace: 8,
-};
-
-export const levels = Object.keys(precedence).filter((level) => level !== 'silent');
-
-const fallbacks = {
-  error: ['log'],
-  warn: ['error', 'log'],
-  info: ['log'],
-  debug: ['info', 'log'],
-  trace: ['debug', 'info', 'log'],
-};
-
-const LOG_TYPES = {
-  SDK: 'sdk',
-  CLIENT: 'client',
-};
-
-const SDK_LOG_TYPE_NAME = 'wx-js-sdk';
-
-const authTokenKeyPattern = /[Aa]uthorization/;
-
-/**
- * Recursively strips "authorization" fields from the specified object
- * @param {Object} object
- * @param {Array<mixed>} [visited]
- * @private
- * @returns {Object}
- */
-function walkAndFilter(object, visited = []) {
-  if (visited.includes(object)) {
-    // Prevent circular references
-    return object;
-  }
-
-  visited.push(object);
-
-  if (isArray(object)) {
-    return object.map((o) => walkAndFilter(o, visited));
-  }
-  if (!isObject(object)) {
-    if (isString(object)) {
-      if (patterns.containsEmails.test(object)) {
-        return object.replace(patterns.containsEmails, '[REDACTED]');
-      }
-    }
-
-    return object;
-  }
-
-  for (const [key, value] of Object.entries(object)) {
-    if (authTokenKeyPattern.test(key)) {
-      Reflect.deleteProperty(object, key);
-    } else {
-      object[key] = walkAndFilter(value, visited);
-    }
-  }
-
-  return object;
-}
-
-/**
- * @class
- */
-const Logger = WebexPlugin.extend({
-  namespace: 'Logger',
-
-  derived: {
-    level: {
-      cache: false,
-      fn() {
-        return this.getCurrentLevel();
-      },
-    },
-    client_level: {
-      cache: false,
-      fn() {
-        return this.getCurrentClientLevel();
-      },
-    },
-  },
-  session: {
-    // for when configured to use single buffer
-    buffer: {
-      type: 'array',
-      default() {
-        return [];
-      },
-    },
-    groupLevel: {
-      type: 'number',
-      default() {
-        return 0;
-      },
-    },
-    // for when configured to use separate buffers
-    sdkBuffer: {
-      type: 'array',
-      default() {
-        return [];
-      },
-    },
-    clientBuffer: {
-      type: 'array',
-      default() {
-        return [];
-      },
-    },
-  },
-
-  /**
-   * Ensures auth headers don't get printed in logs
-   * @param {Array<mixed>} args
-   * @private
-   * @memberof Logger
-   * @returns {Array<mixed>}
-   */
-  filter(...args) {
-    return args.map((arg) => {
-      // WebexHttpError already ensures auth tokens don't get printed, so, no
-      // need to alter it here.
-      if (arg instanceof Error) {
-        // karma logs won't print subclassed errors correctly, so we need
-        // explicitly call their tostring methods.
-        if (process.env.NODE_ENV === 'test' && inBrowser) {
-          let ret = arg.toString();
-
-          ret += 'BEGIN STACK';
-          ret += arg.stack;
-          ret += 'END STACK';
-
-          return ret;
-        }
-
-        return arg;
-      }
-
-      arg = cloneDeep(arg);
-
-      return walkAndFilter(arg);
-    });
-  },
-
-  /**
-   * Determines if the current level allows logs at the specified level to be
-   * printed
-   * @param {string} level
-   * @param {string} type type of log, SDK or client
-   * @private
-   * @memberof Logger
-   * @returns {boolean}
-   */
-  shouldPrint(level, type = LOG_TYPES.SDK) {
-    return (
-      precedence[level] <=
-      precedence[type === LOG_TYPES.SDK ? this.getCurrentLevel() : this.getCurrentClientLevel()]
-    );
-  },
-
-  /**
-   * Determines if the current level allows logs at the specified level to be
-   * put into the log buffer. We're configuring it omit trace and debug logs
-   * because there are *a lot* of debug logs that really don't provide value at
-   * runtime (they're helpful for debugging locally, but really just pollute the
-   * uploaded logs and push useful info out).
-   * @param {string} level
-   * @param {string} type type of log, SDK or client
-   * @private
-   * @memberof Logger
-   * @returns {boolean}
-   */
-  shouldBuffer(level) {
-    return (
-      precedence[level] <=
-      (this.config.bufferLogLevel ? precedence[this.config.bufferLogLevel] : precedence.info)
-    );
-  },
-
-  /**
-   * Indicates the current SDK log level based on env vars, feature toggles, and
-   * user type.
-   * @instance
-   * @memberof Logger
-   * @private
-   * @memberof Logger
-   * @returns {string}
-   */
-  // eslint-disable-next-line complexity
-  getCurrentLevel() {
-    // If a level has been explicitly set via config, alway use it.
-    if (this.config.level) {
-      return this.config.level;
-    }
-
-    if (levels.includes(process.env.WEBEX_LOG_LEVEL)) {
-      return process.env.WEBEX_LOG_LEVEL;
-    }
-
-    // Always use debug-level logging in test mode;
-    if (process.env.NODE_ENV === 'test') {
-      return 'trace';
-    }
-
-    // Use server-side-feature toggles to configure log levels
-    const level =
-      this.webex.internal.device && this.webex.internal.device.features.developer.get('log-level');
-
-    if (level) {
-      if (levels.includes(level)) {
-        return level;
-      }
-    }
-
-    return 'error';
-  },
-
-  /**
-   * Indicates the current client log level based on config, defaults to SDK level
-   * @instance
-   * @memberof Logger
-   * @private
-   * @memberof Logger
-   * @returns {string}
-   */
-  getCurrentClientLevel() {
-    // If a client log level has been explicitly set via config, alway use it.
-    if (this.config.clientLevel) {
-      return this.config.clientLevel;
-    }
-
-    // otherwise default to SDK level
-    return this.getCurrentLevel();
-  },
-
-  /**
-   * Format logs (for upload)
-   *
-   * If separate client, SDK buffers is configured, merge the buffers, if configured
-   *
-   * @instance
-   * @memberof Logger
-   * @public
-   * @memberof Logger
-   * @returns {string} formatted buffer
-   */
-  formatLogs() {
-    function getDate(log) {
-      return log[1];
-    }
-    let buffer = [];
-    let clientIndex = 0;
-    let sdkIndex = 0;
-
-    if (this.config.separateLogBuffers) {
-      // merge the client and sdk buffers
-      // while we have entries in either buffer
-      while (clientIndex < this.clientBuffer.length || sdkIndex < this.sdkBuffer.length) {
-        // if we have remaining entries in the SDK buffer
-        if (
-          sdkIndex < this.sdkBuffer.length &&
-          // and we haven't exhausted all the client buffer entries, or SDK date is before client date
-          (clientIndex >= this.clientBuffer.length ||
-            new Date(getDate(this.sdkBuffer[sdkIndex])) <=
-              new Date(getDate(this.clientBuffer[clientIndex])))
-        ) {
-          // then add to the SDK buffer
-          buffer.push(this.sdkBuffer[sdkIndex]);
-          sdkIndex += 1;
-        }
-        // otherwise if we haven't exhausted all the client buffer entries, add client entry, whether it was because
-        // it was the only remaining entries or date was later (the above if)
-        else if (clientIndex < this.clientBuffer.length) {
-          buffer.push(this.clientBuffer[clientIndex]);
-          clientIndex += 1;
-        }
-      }
-    } else {
-      buffer = this.buffer;
-    }
-
-    return buffer.join('\n');
-  },
-});
-
-/**
- * Creates a logger method
- *
- *
- * @param {string} level level to create (info, error, warn, etc.)
- * @param {string} impl the level to use when writing to console
- * @param {string} type type of log, SDK or client
- * @param {bool} neverPrint function never prints to console
- * @param {bool} alwaysBuffer function always logs to log buffer
- * @instance
- * @memberof Logger
- * @private
- * @memberof Logger
- * @returns {function} logger method with specified params
- */
-function makeLoggerMethod(level, impl, type, neverPrint = false, alwaysBuffer = false) {
-  // Much of the complexity in the following function is due to a test-mode-only
-  // helper
-  return function wrappedConsoleMethod(...args) {
-    // it would be easier to just pass in the name and buffer here, but the config isn't completely initialized
-    // in Ampersand, even if the initialize method is used to set this up.  so we keep the type to achieve
-    // a sort of late binding to allow retrieving a name from config.
-    const logType = type;
-    const clientName =
-      logType === LOG_TYPES.SDK ? SDK_LOG_TYPE_NAME : this.config.clientName || logType;
-
-    let buffer;
-    let historyLength;
-
-    if (this.config.separateLogBuffers) {
-      historyLength = this.config.clientHistoryLength
-        ? this.config.clientHistoryLength
-        : this.config.historyLength;
-      buffer = logType === LOG_TYPES.SDK ? this.sdkBuffer : this.clientBuffer;
-    } else {
-      buffer = this.buffer;
-      historyLength = this.config.historyLength;
-    }
-
-    try {
-      const shouldPrint = !neverPrint && this.shouldPrint(level, logType);
-      const shouldBuffer = alwaysBuffer || this.shouldBuffer(level);
-
-      if (!shouldBuffer && !shouldPrint) {
-        return;
-      }
-
-      const filtered = [clientName, ...this.filter(...args)];
-      const stringified = filtered.map((item) => {
-        if (item instanceof WebexHttpError) {
-          return item.toString();
-        }
-
-        return item;
-      });
-
-      if (shouldPrint) {
-        // when logging an object in browsers, we tend to get a dynamic
-        // reference, thus going back to look at the logged value doesn't
-        // necessarily show the state at log time, thus we print the stringified
-        // value.
-        const toPrint = inBrowser ? stringified : filtered;
-
-        /* istanbul ignore if */
-        if (process.env.NODE_ENV === 'test' && has(this, 'webex.internal.device.url')) {
-          toPrint.unshift(this.webex.internal.device.url.slice(-3));
-        }
-        // eslint-disable-next-line no-console
-        console[impl](...toPrint);
-      }
-
-      if (shouldBuffer) {
-        const logDate = new Date();
-
-        stringified.unshift(logDate.toISOString());
-        stringified.unshift('|  '.repeat(this.groupLevel));
-        buffer.push(stringified);
-        if (buffer.length > historyLength) {
-          buffer.shift();
-        }
-        if (level === 'group') this.groupLevel += 1;
-        if (level === 'groupEnd' && this.groupLevel > 0) this.groupLevel -= 1;
-      }
-    } catch (reason) {
-      if (!neverPrint) {
-        /* istanbul ignore next */
-        // eslint-disable-next-line no-console
-        console.warn(`failed to execute Logger#${level}`, reason);
-      }
-    }
-  };
-}
-
-levels.forEach((level) => {
-  let impls = fallbacks[level];
-  let impl = level;
-
-  if (impls) {
-    impls = impls.slice();
-    // eslint-disable-next-line no-console
-    while (!console[impl]) {
-      impl = impls.pop();
-    }
-  }
-
-  // eslint-disable-next-line complexity
-  Logger.prototype[`client_${level}`] = makeLoggerMethod(level, impl, LOG_TYPES.CLIENT);
-  Logger.prototype[level] = makeLoggerMethod(level, impl, LOG_TYPES.SDK);
-});
-
-Logger.prototype.client_logToBuffer = makeLoggerMethod(
-  levels.info,
-  levels.info,
-  LOG_TYPES.CLIENT,
-  true,
-  true
-);
-Logger.prototype.logToBuffer = makeLoggerMethod(
-  levels.info,
-  levels.info,
-  LOG_TYPES.SDK,
-  true,
-  true
-);
-
-export default Logger;
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {inBrowser, patterns} from '@webex/common';
+import {WebexHttpError, WebexPlugin} from '@webex/webex-core';
+import {cloneDeep, has, isArray, isObject, isString} from 'lodash';
+
+const precedence = {
+  silent: 0,
+  group: 1,
+  groupEnd: 2,
+  error: 3,
+  warn: 4,
+  log: 5,
+  info: 6,
+  debug: 7,
+  trace: 8,
+};
+
+export const levels = Object.keys(precedence).filter((level) => level !== 'silent');
+
+const fallbacks = {
+  error: ['log'],
+  warn: ['error', 'log'],
+  info: ['log'],
+  debug: ['info', 'log'],
+  trace: ['debug', 'info', 'log'],
+};
+
+const LOG_TYPES = {
+  SDK: 'sdk',
+  CLIENT: 'client',
+};
+
+const SDK_LOG_TYPE_NAME = 'wx-js-sdk';
+
+const authTokenKeyPattern = /[Aa]uthorization/;
+
+/**
+ * Recursively strips "authorization" fields from the specified object
+ * @param {Object} object
+ * @param {Array<mixed>} [visited]
+ * @private
+ * @returns {Object}
+ */
+function walkAndFilter(object, visited = []) {
+  if (visited.includes(object)) {
+    // Prevent circular references
+    return object;
+  }
+
+  visited.push(object);
+
+  if (isArray(object)) {
+    return object.map((o) => walkAndFilter(o, visited));
+  }
+  if (!isObject(object)) {
+    if (isString(object)) {
+      if (patterns.containsEmails.test(object)) {
+        return object.replace(patterns.containsEmails, '[REDACTED]');
+      }
+    }
+
+    return object;
+  }
+
+  for (const [key, value] of Object.entries(object)) {
+    if (authTokenKeyPattern.test(key)) {
+      Reflect.deleteProperty(object, key);
+    } else {
+      object[key] = walkAndFilter(value, visited);
+    }
+  }
+
+  return object;
+}
+
+/**
+ * @class
+ */
+const Logger = WebexPlugin.extend({
+  namespace: 'Logger',
+
+  derived: {
+    level: {
+      cache: false,
+      fn() {
+        return this.getCurrentLevel();
+      },
+    },
+    client_level: {
+      cache: false,
+      fn() {
+        return this.getCurrentClientLevel();
+      },
+    },
+  },
+  session: {
+    // for when configured to use single buffer
+    buffer: {
+      type: 'array',
+      default() {
+        return [];
+      },
+    },
+    groupLevel: {
+      type: 'number',
+      default() {
+        return 0;
+      },
+    },
+    // for when configured to use separate buffers
+    sdkBuffer: {
+      type: 'array',
+      default() {
+        return [];
+      },
+    },
+    clientBuffer: {
+      type: 'array',
+      default() {
+        return [];
+      },
+    },
+  },
+
+  /**
+   * Ensures auth headers don't get printed in logs
+   * @param {Array<mixed>} args
+   * @private
+   * @memberof Logger
+   * @returns {Array<mixed>}
+   */
+  filter(...args) {
+    return args.map((arg) => {
+      // WebexHttpError already ensures auth tokens don't get printed, so, no
+      // need to alter it here.
+      if (arg instanceof Error) {
+        // karma logs won't print subclassed errors correctly, so we need
+        // explicitly call their tostring methods.
+        if (process.env.NODE_ENV === 'test' && inBrowser) {
+          let ret = arg.toString();
+
+          ret += 'BEGIN STACK';
+          ret += arg.stack;
+          ret += 'END STACK';
+
+          return ret;
+        }
+
+        return arg;
+      }
+
+      arg = cloneDeep(arg);
+
+      return walkAndFilter(arg);
+    });
+  },
+
+  /**
+   * Determines if the current level allows logs at the specified level to be
+   * printed
+   * @param {string} level
+   * @param {string} type type of log, SDK or client
+   * @private
+   * @memberof Logger
+   * @returns {boolean}
+   */
+  shouldPrint(level, type = LOG_TYPES.SDK) {
+    return (
+      precedence[level] <=
+      precedence[type === LOG_TYPES.SDK ? this.getCurrentLevel() : this.getCurrentClientLevel()]
+    );
+  },
+
+  /**
+   * Determines if the current level allows logs at the specified level to be
+   * put into the log buffer. We're configuring it omit trace and debug logs
+   * because there are *a lot* of debug logs that really don't provide value at
+   * runtime (they're helpful for debugging locally, but really just pollute the
+   * uploaded logs and push useful info out).
+   * @param {string} level
+   * @param {string} type type of log, SDK or client
+   * @private
+   * @memberof Logger
+   * @returns {boolean}
+   */
+  shouldBuffer(level) {
+    return (
+      precedence[level] <=
+      (this.config.bufferLogLevel ? precedence[this.config.bufferLogLevel] : precedence.info)
+    );
+  },
+
+  /**
+   * Indicates the current SDK log level based on env vars, feature toggles, and
+   * user type.
+   * @instance
+   * @memberof Logger
+   * @private
+   * @memberof Logger
+   * @returns {string}
+   */
+  // eslint-disable-next-line complexity
+  getCurrentLevel() {
+    // If a level has been explicitly set via config, alway use it.
+    if (this.config.level) {
+      return this.config.level;
+    }
+
+    if (levels.includes(process.env.WEBEX_LOG_LEVEL)) {
+      return process.env.WEBEX_LOG_LEVEL;
+    }
+
+    // Always use debug-level logging in test mode;
+    if (process.env.NODE_ENV === 'test') {
+      return 'trace';
+    }
+
+    // Use server-side-feature toggles to configure log levels
+    const level =
+      this.webex.internal.device && this.webex.internal.device.features.developer.get('log-level');
+
+    if (level) {
+      if (levels.includes(level)) {
+        return level;
+      }
+    }
+
+    return 'error';
+  },
+
+  /**
+   * Indicates the current client log level based on config, defaults to SDK level
+   * @instance
+   * @memberof Logger
+   * @private
+   * @memberof Logger
+   * @returns {string}
+   */
+  getCurrentClientLevel() {
+    // If a client log level has been explicitly set via config, alway use it.
+    if (this.config.clientLevel) {
+      return this.config.clientLevel;
+    }
+
+    // otherwise default to SDK level
+    return this.getCurrentLevel();
+  },
+
+  /**
+   * Format logs (for upload)
+   *
+   * If separate client, SDK buffers is configured, merge the buffers, if configured
+   *
+   * @instance
+   * @memberof Logger
+   * @public
+   * @memberof Logger
+   * @returns {string} formatted buffer
+   */
+  formatLogs() {
+    function getDate(log) {
+      return log[1];
+    }
+    let buffer = [];
+    let clientIndex = 0;
+    let sdkIndex = 0;
+
+    if (this.config.separateLogBuffers) {
+      // merge the client and sdk buffers
+      // while we have entries in either buffer
+      while (clientIndex < this.clientBuffer.length || sdkIndex < this.sdkBuffer.length) {
+        // if we have remaining entries in the SDK buffer
+        if (
+          sdkIndex < this.sdkBuffer.length &&
+          // and we haven't exhausted all the client buffer entries, or SDK date is before client date
+          (clientIndex >= this.clientBuffer.length ||
+            new Date(getDate(this.sdkBuffer[sdkIndex])) <=
+              new Date(getDate(this.clientBuffer[clientIndex])))
+        ) {
+          // then add to the SDK buffer
+          buffer.push(this.sdkBuffer[sdkIndex]);
+          sdkIndex += 1;
+        }
+        // otherwise if we haven't exhausted all the client buffer entries, add client entry, whether it was because
+        // it was the only remaining entries or date was later (the above if)
+        else if (clientIndex < this.clientBuffer.length) {
+          buffer.push(this.clientBuffer[clientIndex]);
+          clientIndex += 1;
+        }
+      }
+    } else {
+      buffer = this.buffer;
+    }
+
+    return buffer.join('\n');
+  },
+});
+
+/**
+ * Creates a logger method
+ *
+ *
+ * @param {string} level level to create (info, error, warn, etc.)
+ * @param {string} impl the level to use when writing to console
+ * @param {string} type type of log, SDK or client
+ * @param {bool} neverPrint function never prints to console
+ * @param {bool} alwaysBuffer function always logs to log buffer
+ * @instance
+ * @memberof Logger
+ * @private
+ * @memberof Logger
+ * @returns {function} logger method with specified params
+ */
+function makeLoggerMethod(level, impl, type, neverPrint = false, alwaysBuffer = false) {
+  // Much of the complexity in the following function is due to a test-mode-only
+  // helper
+  return function wrappedConsoleMethod(...args) {
+    // it would be easier to just pass in the name and buffer here, but the config isn't completely initialized
+    // in Ampersand, even if the initialize method is used to set this up.  so we keep the type to achieve
+    // a sort of late binding to allow retrieving a name from config.
+    const logType = type;
+    const clientName =
+      logType === LOG_TYPES.SDK ? SDK_LOG_TYPE_NAME : this.config.clientName || logType;
+
+    let buffer;
+    let historyLength;
+
+    if (this.config.separateLogBuffers) {
+      historyLength = this.config.clientHistoryLength
+        ? this.config.clientHistoryLength
+        : this.config.historyLength;
+      buffer = logType === LOG_TYPES.SDK ? this.sdkBuffer : this.clientBuffer;
+    } else {
+      buffer = this.buffer;
+      historyLength = this.config.historyLength;
+    }
+
+    try {
+      const shouldPrint = !neverPrint && this.shouldPrint(level, logType);
+      const shouldBuffer = alwaysBuffer || this.shouldBuffer(level);
+
+      if (!shouldBuffer && !shouldPrint) {
+        return;
+      }
+
+      const filtered = [clientName, ...this.filter(...args)];
+      const stringified = filtered.map((item) => {
+        if (item instanceof WebexHttpError) {
+          return item.toString();
+        }
+
+        return item;
+      });
+
+      if (shouldPrint) {
+        // when logging an object in browsers, we tend to get a dynamic
+        // reference, thus going back to look at the logged value doesn't
+        // necessarily show the state at log time, thus we print the stringified
+        // value.
+        const toPrint = inBrowser ? stringified : filtered;
+
+        /* istanbul ignore if */
+        if (process.env.NODE_ENV === 'test' && has(this, 'webex.internal.device.url')) {
+          toPrint.unshift(this.webex.internal.device.url.slice(-3));
+        }
+        // eslint-disable-next-line no-console
+        console[impl](...toPrint);
+      }
+
+      if (shouldBuffer) {
+        const logDate = new Date();
+
+        stringified.unshift(logDate.toISOString());
+        stringified.unshift('|  '.repeat(this.groupLevel));
+        buffer.push(stringified);
+        if (buffer.length > historyLength) {
+          buffer.shift();
+        }
+        if (level === 'group') this.groupLevel += 1;
+        if (level === 'groupEnd' && this.groupLevel > 0) this.groupLevel -= 1;
+      }
+    } catch (reason) {
+      if (!neverPrint) {
+        /* istanbul ignore next */
+        // eslint-disable-next-line no-console
+        console.warn(`failed to execute Logger#${level}`, reason);
+      }
+    }
+  };
+}
+
+levels.forEach((level) => {
+  let impls = fallbacks[level];
+  let impl = level;
+
+  if (impls) {
+    impls = impls.slice();
+    // eslint-disable-next-line no-console
+    while (!console[impl]) {
+      impl = impls.pop();
+    }
+  }
+
+  // eslint-disable-next-line complexity
+  Logger.prototype[`client_${level}`] = makeLoggerMethod(level, impl, LOG_TYPES.CLIENT);
+  Logger.prototype[level] = makeLoggerMethod(level, impl, LOG_TYPES.SDK);
+});
+
+Logger.prototype.client_logToBuffer = makeLoggerMethod(
+  levels.info,
+  levels.info,
+  LOG_TYPES.CLIENT,
+  true,
+  true
+);
+Logger.prototype.logToBuffer = makeLoggerMethod(
+  levels.info,
+  levels.info,
+  LOG_TYPES.SDK,
+  true,
+  true
+);
+
+export default Logger;