Source: lib/debug/log.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.log');
  9. goog.require('goog.asserts');
  11. /**
  12.  * @summary
  13.  * A console logging framework which is compiled out for deployment.  This is
  14.  * only available when using the uncompiled version.
  15.  * @exportDoc
  16.  */
  17. shaka.log = class {
  18.   /**
  19.    * This always logs to the console, even in Release mode.  This should only be
  20.    * used for deprecation messages and things the app should never ignore.
  21.    *
  22.    * @param {...*} args
  23.    */
  24.   static alwaysError(...args) {}
  26.   /**
  27.    * This always logs to the console, even in Release mode.  This should only be
  28.    * used for deprecation messages and things the app should never ignore.
  29.    *
  30.    * @param {...*} args
  31.    */
  32.   static alwaysWarn(...args) {}
  34.   /**
  35.    * This always logs to the console, even in Release mode.  This should only be
  36.    * used for deprecation messages and things the app should never ignore.
  37.    *
  38.    * @param {string} id
  39.    * @param {...*} args
  40.    */
  41.   static warnOnce(id, ...args) {
  42.     if (shaka.log.oneTimeWarningIssued_.has(id)) {
  43.       return;
  44.     }
  46.     shaka.log.oneTimeWarningIssued_.add(id);
  47.     shaka.log.alwaysWarn(...args);
  48.   }
  50.   /**
  51.    * This log is for when an error occurs.  This should always be accompanied
  52.    * with an error event, thrown exception, or rejected Promise.  Logs are
  53.    * disabled in Release mode, so there should be other methods of detecting the
  54.    * error.
  55.    *
  56.    * @param {...*} args
  57.    */
  58.   static error(...args) {}
  60.   /**
  61.    * This log is for possible errors or things that may be surprising to a user.
  62.    * For example, if we work around unusual or bad content, we should warn that
  63.    * they should fix their content.  Deprecation messages and messages the app
  64.    * shouldn't ignore should use alwaysWarn instead.
  65.    *
  66.    * @param {...*} args
  67.    */
  68.   static warning(...args) {}
  70.   /**
  71.    * This log is for messages to the user about what is happening.  For example,
  72.    * when we update a manifest or install a polyfill.
  73.    *
  74.    * @param {...*} args
  75.    */
  76.   static info(...args) {}
  78.   /**
  79.    * This log is to aid *users* in debugging their content.  This should be for
  80.    * logs about the content and what we do with it.  For example, when we change
  81.    * streams or what we are choosing.
  82.    *
  83.    * @param {...*} args
  84.    */
  85.   static debug(...args) {}
  87.   /**
  88.    * This log is for debugging Shaka Player itself.  This may be logs about
  89.    * internal states or events.  This may also be for more verbose logs about
  90.    * content, such as for segment appends.
  91.    *
  92.    * @param {...*} args
  93.    */
  94.   static v1(...args) {}
  96.   /**
  97.    * This log is for tracing and debugging Shaka Player.  These logs will happen
  98.    * a lot, for example, logging every segment append or every update check.
  99.    * These are mostly used for tracking which calls happen through the code.
  100.    *
  101.    * @param {...*} args
  102.    */
  103.   static v2(...args) {}
  104. };
  107. /**
  108.  * Log levels.
  109.  * @enum {number}
  110.  * @exportDoc
  111.  */
  112. shaka.log.Level = {
  113.   NONE: 0,
  114.   ERROR: 1,
  115.   WARNING: 2,
  116.   INFO: 3,
  117.   DEBUG: 4,
  118.   V1: 5,
  119.   V2: 6,
  120. };
  123. /**
  124.  * @define {number} the maximum log level.
  125.  */
  126. shaka.log.MAX_LOG_LEVEL = 3;
  129. /**
  130.  * A Set to indicate which one-time warnings have been issued.
  131.  *
  132.  * @private {!Set.<string>}
  133.  */
  134. shaka.log.oneTimeWarningIssued_ = new Set();
  137. // IE8 has no console unless it is opened in advance.
  138. // IE9 console methods are not Functions and have no bind.
  139. if (window.console && window.console.log.bind) {
  140.   /** @private {!Object.<shaka.log.Level, function(...*)>} */
  141.   shaka.log.logMap_ = {
  142.     /* eslint-disable no-restricted-syntax */
  143.     [shaka.log.Level.ERROR]: console.error.bind(console),
  144.     [shaka.log.Level.WARNING]: console.warn.bind(console),
  145.     [shaka.log.Level.INFO]: console.info.bind(console),
  146.     [shaka.log.Level.DEBUG]: console.log.bind(console),
  147.     [shaka.log.Level.V1]: console.debug.bind(console),
  148.     [shaka.log.Level.V2]: console.debug.bind(console),
  149.     /* eslint-enable no-restricted-syntax */
  150.   };
  152.   shaka.log.alwaysWarn = shaka.log.logMap_[shaka.log.Level.WARNING];
  153.   shaka.log.alwaysError = shaka.log.logMap_[shaka.log.Level.ERROR];
  155.   if (goog.DEBUG) {
  156.     // Since we don't want to export shaka.log in production builds, we don't
  157.     // use the @export annotation.  But the module wrapper (used in debug builds
  158.     // since v2.5.11) hides anything non-exported.  This is a debug-only,
  159.     // API-based export to make sure logging is available in debug builds.
  160.     goog.exportSymbol('shaka.log', shaka.log);
  162.     /** @type {number} */
  163.     shaka.log.currentLevel;
  165.     /**
  166.      * Change the log level.  Useful for debugging in uncompiled mode.
  167.      *
  168.      * @param {number} level
  169.      * @exportDoc
  170.      */
  171.     shaka.log.setLevel = (level) => {
  172.       const getLog = (curLevel) => {
  173.         if (curLevel <= level) {
  174.           goog.asserts.assert(
  175.               shaka.log.logMap_[curLevel], 'Unexpected log level');
  176.           return shaka.log.logMap_[curLevel];
  177.         } else {
  178.           return () => {};
  179.         }
  180.       };
  182.       shaka.log.currentLevel = level;
  183.       shaka.log.error = getLog(shaka.log.Level.ERROR);
  184.       shaka.log.warning = getLog(shaka.log.Level.WARNING);
  185.       shaka.log.info = getLog(shaka.log.Level.INFO);
  186.       shaka.log.debug = getLog(shaka.log.Level.DEBUG);
  187.       shaka.log.v1 = getLog(shaka.log.Level.V1);
  188.       shaka.log.v2 = getLog(shaka.log.Level.V2);
  189.     };
  191.     shaka.log.setLevel(shaka.log.MAX_LOG_LEVEL);
  192.   } else {
  193.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.ERROR) {
  194.       shaka.log.error = shaka.log.logMap_[shaka.log.Level.ERROR];
  195.     }
  196.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.WARNING) {
  197.       shaka.log.warning = shaka.log.logMap_[shaka.log.Level.WARNING];
  198.     }
  199.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.INFO) {
  200.       shaka.log.info = shaka.log.logMap_[shaka.log.Level.INFO];
  201.     }
  202.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.DEBUG) {
  203.       shaka.log.debug = shaka.log.logMap_[shaka.log.Level.DEBUG];
  204.     }
  205.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.V1) {
  206.       shaka.log.v1 = shaka.log.logMap_[shaka.log.Level.V1];
  207.     }
  208.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.V2) {
  209.       shaka.log.v2 = shaka.log.logMap_[shaka.log.Level.V2];
  210.     }
  211.   }
  212. }