Source: lib/debug/log.js

  1. /**
  2.  * @license
  3.  * Copyright 2016 Google Inc.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  18. goog.provide('shaka.log');
  21. /**
  22.  * @namespace shaka.log
  23.  * @summary
  24.  * A console logging framework which is compiled out for deployment.  This is
  25.  * only available when using the uncompiled version.
  26.  * @exportDoc
  27.  */
  30. /**
  31.  * Log levels.
  32.  * @enum {number}
  33.  * @exportDoc
  34.  */
  35. shaka.log.Level = {
  36.   NONE: 0,
  37.   ERROR: 1,
  38.   WARNING: 2,
  39.   INFO: 3,
  40.   DEBUG: 4,
  41.   V1: 5,
  42.   V2: 6
  43. };
  46. /**
  47.  * @define {number} the maximum log level.
  48.  */
  49. goog.define('shaka.log.MAX_LOG_LEVEL', 3);
  52. /**
  53.  * This always logs to the console, even in Release mode.  This should only be
  54.  * used for deprecation messages and things the app should never ignore.
  55.  *
  56.  * @type {function(*, ...*)}
  57.  */
  58. shaka.log.alwaysError = function() {};
  61. /**
  62.  * This always logs to the console, even in Release mode.  This should only be
  63.  * used for deprecation messages and things the app should never ignore.
  64.  *
  65.  * @type {function(*, ...*)}
  66.  */
  67. shaka.log.alwaysWarn = function() {};
  70. /**
  71.  * This log is for when an error occurs.  This should always be accompanied with
  72.  * an error event, thrown exception, or rejected Promise.  Logs are disabled in
  73.  * Release mode, so there should be other methods of detecting the error.
  74.  *
  75.  * @type {function(*, ...*)}
  76.  */
  77. shaka.log.error = function() {};
  80. /**
  81.  * This log is for possible errors or things that may be surprising to a user.
  82.  * For example, if we work around unusual or bad content, we should warn that
  83.  * they should fix their content.  Deprecation messages and messages the app
  84.  * shouldn't ignore should use alwaysWarn instead.
  85.  *
  86.  * @type {function(*, ...*)}
  87.  */
  88. shaka.log.warning = function() {};
  91. /**
  92.  * This log is for messages to the user about what is happening.  For example,
  93.  * when we update a manifest or install a polyfill.
  94.  *
  95.  * @type {function(*, ...*)}
  96.  */
  97. shaka.log.info = function() {};
  100. /**
  101.  * This log is to aid *users* in debugging their content.  This should be for
  102.  * logs about the content and what we do with it.  For example, when we change
  103.  * streams or what we are choosing.
  104.  *
  105.  * @type {function(*, ...*)}
  106.  */
  107. shaka.log.debug = function() {};
  110. /**
  111.  * This log is for debugging Shaka Player itself.  This may be logs about
  112.  * internal states or events.  This may also be for more verbose logs about
  113.  * content, such as for segment appends.
  114.  *
  115.  * @type {function(*, ...*)}
  116.  */
  117. shaka.log.v1 = function() {};
  120. /**
  121.  * This log is for tracing and debugging Shaka Player.  These logs will happen
  122.  * a lot, for example, logging every segment append or every update check.
  123.  * These are mostly used for tracking which calls happen through the code.
  124.  *
  125.  * @type {function(*, ...*)}
  126.  */
  127. shaka.log.v2 = function() {};
  130. // IE8 has no console unless it is opened in advance.
  131. // IE9 console methods are not Functions and have no bind.
  132. if (window.console && window.console.log.bind) {
  133.   shaka.log.alwaysWarn = console.warn.bind(console);
  134.   shaka.log.alwaysError = console.error.bind(console);
  136.   if (goog.DEBUG) {
  137.     /** @type {number} */
  138.     shaka.log.currentLevel;
  140.     /**
  141.      * Change the log level.  Useful for debugging in uncompiled mode.
  142.      *
  143.      * @param {number} level
  144.      * @exportDoc
  145.      */
  146.     shaka.log.setLevel = function(level) {
  147.       let nop = function() {};
  148.       let log = shaka.log;
  149.       const Level = shaka.log.Level;
  151.       shaka.log.currentLevel = level;
  153.       log.error = (level >= Level.ERROR) ? console.error.bind(console) : nop;
  154.       log.warning = (level >= Level.WARNING) ? console.warn.bind(console) : nop;
  155.       log.info = (level >= Level.INFO) ? console.info.bind(console) : nop;
  156.       log.debug = (level >= Level.DEBUG) ? console.log.bind(console) : nop;
  157.       log.v1 = (level >= Level.V1) ? console.debug.bind(console) : nop;
  158.       log.v2 = (level >= Level.V2) ? console.debug.bind(console) : nop;
  159.     };
  161.     shaka.log.setLevel(shaka.log.MAX_LOG_LEVEL);
  162.   } else {
  163.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.ERROR) {
  164.       shaka.log.error = console.error.bind(console);
  165.     }
  166.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.WARNING) {
  167.       shaka.log.warning = console.warn.bind(console);
  168.     }
  169.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.INFO) {
  170.       shaka.log.info = console.info.bind(console);
  171.     }
  172.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.DEBUG) {
  173.       shaka.log.debug = console.log.bind(console);
  174.     }
  175.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.V1) {
  176.       shaka.log.v1 = console.debug.bind(console);
  177.     }
  178.     if (shaka.log.MAX_LOG_LEVEL >= shaka.log.Level.V2) {
  179.       shaka.log.v2 = console.debug.bind(console);
  180.     }
  181.   }
  182. }