loglevel.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. /*! loglevel - v1.9.2 - https://github.com/pimterry/loglevel - (c) 2024 Tim Perry - licensed MIT */
  2. (function (root, definition) {
  3. "use strict";
  4. if (typeof define === 'function' && define.amd) {
  5. define(definition);
  6. } else if (typeof module === 'object' && module.exports) {
  7. module.exports = definition();
  8. } else {
  9. root.log = definition();
  10. }
  11. }(this, function () {
  12. "use strict";
  13. // Slightly dubious tricks to cut down minimized file size
  14. var noop = function() {};
  15. var undefinedType = "undefined";
  16. var isIE = (typeof window !== undefinedType) && (typeof window.navigator !== undefinedType) && (
  17. /Trident\/|MSIE /.test(window.navigator.userAgent)
  18. );
  19. var logMethods = [
  20. "trace",
  21. "debug",
  22. "info",
  23. "warn",
  24. "error"
  25. ];
  26. var _loggersByName = {};
  27. var defaultLogger = null;
  28. // Cross-browser bind equivalent that works at least back to IE6
  29. function bindMethod(obj, methodName) {
  30. var method = obj[methodName];
  31. if (typeof method.bind === 'function') {
  32. return method.bind(obj);
  33. } else {
  34. try {
  35. return Function.prototype.bind.call(method, obj);
  36. } catch (e) {
  37. // Missing bind shim or IE8 + Modernizr, fallback to wrapping
  38. return function() {
  39. return Function.prototype.apply.apply(method, [obj, arguments]);
  40. };
  41. }
  42. }
  43. }
  44. // Trace() doesn't print the message in IE, so for that case we need to wrap it
  45. function traceForIE() {
  46. if (console.log) {
  47. if (console.log.apply) {
  48. console.log.apply(console, arguments);
  49. } else {
  50. // In old IE, native console methods themselves don't have apply().
  51. Function.prototype.apply.apply(console.log, [console, arguments]);
  52. }
  53. }
  54. if (console.trace) console.trace();
  55. }
  56. // Build the best logging method possible for this env
  57. // Wherever possible we want to bind, not wrap, to preserve stack traces
  58. function realMethod(methodName) {
  59. if (methodName === 'debug') {
  60. methodName = 'log';
  61. }
  62. if (typeof console === undefinedType) {
  63. return false; // No method possible, for now - fixed later by enableLoggingWhenConsoleArrives
  64. } else if (methodName === 'trace' && isIE) {
  65. return traceForIE;
  66. } else if (console[methodName] !== undefined) {
  67. return bindMethod(console, methodName);
  68. } else if (console.log !== undefined) {
  69. return bindMethod(console, 'log');
  70. } else {
  71. return noop;
  72. }
  73. }
  74. // These private functions always need `this` to be set properly
  75. function replaceLoggingMethods() {
  76. /*jshint validthis:true */
  77. var level = this.getLevel();
  78. // Replace the actual methods.
  79. for (var i = 0; i < logMethods.length; i++) {
  80. var methodName = logMethods[i];
  81. this[methodName] = (i < level) ?
  82. noop :
  83. this.methodFactory(methodName, level, this.name);
  84. }
  85. // Define log.log as an alias for log.debug
  86. this.log = this.debug;
  87. // Return any important warnings.
  88. if (typeof console === undefinedType && level < this.levels.SILENT) {
  89. return "No console available for logging";
  90. }
  91. }
  92. // In old IE versions, the console isn't present until you first open it.
  93. // We build realMethod() replacements here that regenerate logging methods
  94. function enableLoggingWhenConsoleArrives(methodName) {
  95. return function () {
  96. if (typeof console !== undefinedType) {
  97. replaceLoggingMethods.call(this);
  98. this[methodName].apply(this, arguments);
  99. }
  100. };
  101. }
  102. // By default, we use closely bound real methods wherever possible, and
  103. // otherwise we wait for a console to appear, and then try again.
  104. function defaultMethodFactory(methodName, _level, _loggerName) {
  105. /*jshint validthis:true */
  106. return realMethod(methodName) ||
  107. enableLoggingWhenConsoleArrives.apply(this, arguments);
  108. }
  109. function Logger(name, factory) {
  110. // Private instance variables.
  111. var self = this;
  112. /**
  113. * The level inherited from a parent logger (or a global default). We
  114. * cache this here rather than delegating to the parent so that it stays
  115. * in sync with the actual logging methods that we have installed (the
  116. * parent could change levels but we might not have rebuilt the loggers
  117. * in this child yet).
  118. * @type {number}
  119. */
  120. var inheritedLevel;
  121. /**
  122. * The default level for this logger, if any. If set, this overrides
  123. * `inheritedLevel`.
  124. * @type {number|null}
  125. */
  126. var defaultLevel;
  127. /**
  128. * A user-specific level for this logger. If set, this overrides
  129. * `defaultLevel`.
  130. * @type {number|null}
  131. */
  132. var userLevel;
  133. var storageKey = "loglevel";
  134. if (typeof name === "string") {
  135. storageKey += ":" + name;
  136. } else if (typeof name === "symbol") {
  137. storageKey = undefined;
  138. }
  139. function persistLevelIfPossible(levelNum) {
  140. var levelName = (logMethods[levelNum] || 'silent').toUpperCase();
  141. if (typeof window === undefinedType || !storageKey) return;
  142. // Use localStorage if available
  143. try {
  144. window.localStorage[storageKey] = levelName;
  145. return;
  146. } catch (ignore) {}
  147. // Use session cookie as fallback
  148. try {
  149. window.document.cookie =
  150. encodeURIComponent(storageKey) + "=" + levelName + ";";
  151. } catch (ignore) {}
  152. }
  153. function getPersistedLevel() {
  154. var storedLevel;
  155. if (typeof window === undefinedType || !storageKey) return;
  156. try {
  157. storedLevel = window.localStorage[storageKey];
  158. } catch (ignore) {}
  159. // Fallback to cookies if local storage gives us nothing
  160. if (typeof storedLevel === undefinedType) {
  161. try {
  162. var cookie = window.document.cookie;
  163. var cookieName = encodeURIComponent(storageKey);
  164. var location = cookie.indexOf(cookieName + "=");
  165. if (location !== -1) {
  166. storedLevel = /^([^;]+)/.exec(
  167. cookie.slice(location + cookieName.length + 1)
  168. )[1];
  169. }
  170. } catch (ignore) {}
  171. }
  172. // If the stored level is not valid, treat it as if nothing was stored.
  173. if (self.levels[storedLevel] === undefined) {
  174. storedLevel = undefined;
  175. }
  176. return storedLevel;
  177. }
  178. function clearPersistedLevel() {
  179. if (typeof window === undefinedType || !storageKey) return;
  180. // Use localStorage if available
  181. try {
  182. window.localStorage.removeItem(storageKey);
  183. } catch (ignore) {}
  184. // Use session cookie as fallback
  185. try {
  186. window.document.cookie =
  187. encodeURIComponent(storageKey) + "=; expires=Thu, 01 Jan 1970 00:00:00 UTC";
  188. } catch (ignore) {}
  189. }
  190. function normalizeLevel(input) {
  191. var level = input;
  192. if (typeof level === "string" && self.levels[level.toUpperCase()] !== undefined) {
  193. level = self.levels[level.toUpperCase()];
  194. }
  195. if (typeof level === "number" && level >= 0 && level <= self.levels.SILENT) {
  196. return level;
  197. } else {
  198. throw new TypeError("log.setLevel() called with invalid level: " + input);
  199. }
  200. }
  201. /*
  202. *
  203. * Public logger API - see https://github.com/pimterry/loglevel for details
  204. *
  205. */
  206. self.name = name;
  207. self.levels = { "TRACE": 0, "DEBUG": 1, "INFO": 2, "WARN": 3,
  208. "ERROR": 4, "SILENT": 5};
  209. self.methodFactory = factory || defaultMethodFactory;
  210. self.getLevel = function () {
  211. if (userLevel != null) {
  212. return userLevel;
  213. } else if (defaultLevel != null) {
  214. return defaultLevel;
  215. } else {
  216. return inheritedLevel;
  217. }
  218. };
  219. self.setLevel = function (level, persist) {
  220. userLevel = normalizeLevel(level);
  221. if (persist !== false) { // defaults to true
  222. persistLevelIfPossible(userLevel);
  223. }
  224. // NOTE: in v2, this should call rebuild(), which updates children.
  225. return replaceLoggingMethods.call(self);
  226. };
  227. self.setDefaultLevel = function (level) {
  228. defaultLevel = normalizeLevel(level);
  229. if (!getPersistedLevel()) {
  230. self.setLevel(level, false);
  231. }
  232. };
  233. self.resetLevel = function () {
  234. userLevel = null;
  235. clearPersistedLevel();
  236. replaceLoggingMethods.call(self);
  237. };
  238. self.enableAll = function(persist) {
  239. self.setLevel(self.levels.TRACE, persist);
  240. };
  241. self.disableAll = function(persist) {
  242. self.setLevel(self.levels.SILENT, persist);
  243. };
  244. self.rebuild = function () {
  245. if (defaultLogger !== self) {
  246. inheritedLevel = normalizeLevel(defaultLogger.getLevel());
  247. }
  248. replaceLoggingMethods.call(self);
  249. if (defaultLogger === self) {
  250. for (var childName in _loggersByName) {
  251. _loggersByName[childName].rebuild();
  252. }
  253. }
  254. };
  255. // Initialize all the internal levels.
  256. inheritedLevel = normalizeLevel(
  257. defaultLogger ? defaultLogger.getLevel() : "WARN"
  258. );
  259. var initialLevel = getPersistedLevel();
  260. if (initialLevel != null) {
  261. userLevel = normalizeLevel(initialLevel);
  262. }
  263. replaceLoggingMethods.call(self);
  264. }
  265. /*
  266. *
  267. * Top-level API
  268. *
  269. */
  270. defaultLogger = new Logger();
  271. defaultLogger.getLogger = function getLogger(name) {
  272. if ((typeof name !== "symbol" && typeof name !== "string") || name === "") {
  273. throw new TypeError("You must supply a name when creating a logger.");
  274. }
  275. var logger = _loggersByName[name];
  276. if (!logger) {
  277. logger = _loggersByName[name] = new Logger(
  278. name,
  279. defaultLogger.methodFactory
  280. );
  281. }
  282. return logger;
  283. };
  284. // Grab the current global log variable in case of overwrite
  285. var _log = (typeof window !== undefinedType) ? window.log : undefined;
  286. defaultLogger.noConflict = function() {
  287. if (typeof window !== undefinedType &&
  288. window.log === defaultLogger) {
  289. window.log = _log;
  290. }
  291. return defaultLogger;
  292. };
  293. defaultLogger.getLoggers = function getLoggers() {
  294. return _loggersByName;
  295. };
  296. // ES6 default export, for compatibility
  297. defaultLogger['default'] = defaultLogger;
  298. return defaultLogger;
  299. }));