Source: lib/debug/log.js

/*! @license
 * Shaka Player
 * Copyright 2016 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

goog.provide('shaka.log');

/**
 * @summary
 * A console logging framework which is compiled out for deployment.  This is
 * only available when using the uncompiled version.
 * @export
 */
shaka.log = class {
  /**
   * This always logs to the console, even in Release mode.  This should only be
   * used for deprecation messages and things the app should never ignore.
   *
   * @param {...*} args
   * @export
   */
  static alwaysError(...args) {}

  /**
   * This always logs to the console, even in Release mode.  This should only be
   * used for deprecation messages and things the app should never ignore.
   *
   * @param {...*} args
   * @export
   */
  static alwaysWarn(...args) {}

  /**
   * This always logs to the console, even in Release mode.  This should only be
   * used for deprecation messages and things the app should never ignore.
   *
   * @param {string} id
   * @param {...*} args
   */
  static warnOnce(id, ...args) {
    if (shaka.log.oneTimeWarningIssued_.has(id)) {
      return;
    }

    shaka.log.oneTimeWarningIssued_.add(id);
    shaka.log.alwaysWarn(...args);
  }
};

/**
 * This log is for when an error occurs.  This should always be accompanied
 * with an error event, thrown exception, or rejected Promise.  Logs are
 * disabled in Release mode, so there should be other methods of detecting the
 * error.
 *
 * @param {...*} args
 * @export
 */
shaka.log.error = (...args) => {};
/**
 * This log is for possible errors or things that may be surprising to a user.
 * For example, if we work around unusual or bad content, we should warn that
 * they should fix their content.  Deprecation messages and messages the app
 * shouldn't ignore should use alwaysWarn instead.
 *
 * @param {...*} args
 * @export
 */
shaka.log.warning = (...args) => {};

/**
 * This log is for messages to the user about what is happening.  For example,
 * when we update a manifest or install a polyfill.
 *
 * @param {...*} args
 * @export
 */
shaka.log.info = (...args) => {};

/**
 * This log is to aid *users* in debugging their content.  This should be for
 * logs about the content and what we do with it.  For example, when we change
 * streams or what we are choosing.
 *
 * @param {...*} args
 * @export
 */
shaka.log.debug = (...args) => {};

/**
 * This log is for debugging Shaka Player itself.  This may be logs about
 * internal states or events.  This may also be for more verbose logs about
 * content, such as for segment appends.
 *
 * @param {...*} args
 * @export
 */
shaka.log.v1 = (...args) => {};

/**
 * This log is for tracing and debugging Shaka Player.  These logs will happen
 * a lot, for example, logging every segment append or every update check.
 * These are mostly used for tracking which calls happen through the code.
 *
 * @param {...*} args
 * @export
 */
shaka.log.v2 = (...args) => {};

/**
 * Log levels.
 * @enum {number}
 * @export
 */
shaka.log.Level = {
  NONE: 0,
  ERROR: 1,
  WARNING: 2,
  INFO: 3,
  DEBUG: 4,
  V1: 5,
  V2: 6,
};

/**
 * @define {number} the maximum log level.
 * @export
 */
shaka.log.MAX_LOG_LEVEL = 3;


/**
 * A Set to indicate which one-time warnings have been issued.
 *
 * @private {!Set.<string>}
 */
shaka.log.oneTimeWarningIssued_ = new Set();

/**
 * @type {number} the current log level.
 * @export
 */
shaka.log.currentLevel;

/**
 * Change the log level - for debugging in any mode (uncompiled/compiled).
 *
 * @param {number} level
 * @export
 */
shaka.log.setLevel = (level) => {
  const nop = () => {};
  shaka.log.currentLevel = level;

  /* eslint-disable no-restricted-syntax */
  shaka.log.error = (shaka.log.currentLevel >= shaka.log.Level.ERROR) ?
    console.error.bind(console) : nop;

  shaka.log.warning = (shaka.log.currentLevel >= shaka.log.Level.WARNING) ?
    console.warn.bind(console) : nop;

  shaka.log.info = (shaka.log.currentLevel >= shaka.log.Level.INFO) ?
    console.info.bind(console) : nop;

  shaka.log.debug = (shaka.log.currentLevel >= shaka.log.Level.DEBUG) ?
    console.log.bind(console) : nop;

  shaka.log.v1 = (shaka.log.currentLevel >= shaka.log.Level.V1) ?
    console.debug.bind(console) : nop;

  shaka.log.v2 = (shaka.log.currentLevel >= shaka.log.Level.V2) ?
    console.debug.bind(console) : nop;
  /* eslint-enable no-restricted-syntax */
};

/**
 * Inits the logging capabilities.
 * @export
 */
shaka.log.init = () => {
  if (window.console) {
    /** @private {!Object.<shaka.log.Level, function(...*)>} */
    shaka.log.logMap_ = {
      [shaka.log.Level.ERROR]: (...args) => console.error(...args),
      [shaka.log.Level.WARNING]: (...args) => console.warn(...args),
      [shaka.log.Level.INFO]: (...args) => console.info(...args),
      [shaka.log.Level.DEBUG]: (...args) => console.log(...args),
      [shaka.log.Level.V1]: (...args) => console.debug(...args),
      [shaka.log.Level.V2]: (...args) => console.debug(...args),
    };

    shaka.log.alwaysWarn = (...args) => console.warn(...args);
    shaka.log.alwaysError = (...args) => console.error(...args);

    shaka.log.setLevel(shaka.log.MAX_LOG_LEVEL);
  }
};

shaka.log.init();