create-logger.js 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. /**
  2. * create-logger.js: Logger factory for winston logger instances.
  3. *
  4. * (C) 2010 Charlie Robbins
  5. * MIT LICENCE
  6. */
  7. 'use strict';
  8. function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
  9. function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
  10. function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
  11. function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
  12. function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
  13. function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
  14. function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
  15. function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
  16. function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
  17. function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
  18. function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
  19. function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
  20. function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
  21. var _require = require('triple-beam'),
  22. LEVEL = _require.LEVEL;
  23. var config = require('./config');
  24. var Logger = require('./logger');
  25. var debug = require('@dabh/diagnostics')('winston:create-logger');
  26. function isLevelEnabledFunctionName(level) {
  27. return 'is' + level.charAt(0).toUpperCase() + level.slice(1) + 'Enabled';
  28. }
  29. /**
  30. * Create a new instance of a winston Logger. Creates a new
  31. * prototype for each instance.
  32. * @param {!Object} opts - Options for the created logger.
  33. * @returns {Logger} - A newly created logger instance.
  34. */
  35. module.exports = function () {
  36. var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
  37. //
  38. // Default levels: npm
  39. //
  40. opts.levels = opts.levels || config.npm.levels;
  41. /**
  42. * DerivedLogger to attach the logs level methods.
  43. * @type {DerivedLogger}
  44. * @extends {Logger}
  45. */
  46. var DerivedLogger = /*#__PURE__*/function (_Logger) {
  47. /**
  48. * Create a new class derived logger for which the levels can be attached to
  49. * the prototype of. This is a V8 optimization that is well know to increase
  50. * performance of prototype functions.
  51. * @param {!Object} options - Options for the created logger.
  52. */
  53. function DerivedLogger(options) {
  54. _classCallCheck(this, DerivedLogger);
  55. return _callSuper(this, DerivedLogger, [options]);
  56. }
  57. _inherits(DerivedLogger, _Logger);
  58. return _createClass(DerivedLogger);
  59. }(Logger);
  60. var logger = new DerivedLogger(opts);
  61. //
  62. // Create the log level methods for the derived logger.
  63. //
  64. Object.keys(opts.levels).forEach(function (level) {
  65. debug('Define prototype method for "%s"', level);
  66. if (level === 'log') {
  67. // eslint-disable-next-line no-console
  68. console.warn('Level "log" not defined: conflicts with the method "log". Use a different level name.');
  69. return;
  70. }
  71. //
  72. // Define prototype methods for each log level e.g.:
  73. // logger.log('info', msg) implies these methods are defined:
  74. // - logger.info(msg)
  75. // - logger.isInfoEnabled()
  76. //
  77. // Remark: to support logger.child this **MUST** be a function
  78. // so it'll always be called on the instance instead of a fixed
  79. // place in the prototype chain.
  80. //
  81. DerivedLogger.prototype[level] = function () {
  82. // Prefer any instance scope, but default to "root" logger
  83. var self = this || logger;
  84. // Optimize the hot-path which is the single object.
  85. for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
  86. args[_key] = arguments[_key];
  87. }
  88. if (args.length === 1) {
  89. var msg = args[0];
  90. var info = msg && msg.message && msg || {
  91. message: msg
  92. };
  93. info.level = info[LEVEL] = level;
  94. self._addDefaultMeta(info);
  95. self.write(info);
  96. return this || logger;
  97. }
  98. // When provided nothing assume the empty string
  99. if (args.length === 0) {
  100. self.log(level, '');
  101. return self;
  102. }
  103. // Otherwise build argument list which could potentially conform to
  104. // either:
  105. // . v3 API: log(obj)
  106. // 2. v1/v2 API: log(level, msg, ... [string interpolate], [{metadata}], [callback])
  107. return self.log.apply(self, [level].concat(args));
  108. };
  109. DerivedLogger.prototype[isLevelEnabledFunctionName(level)] = function () {
  110. return (this || logger).isLevelEnabled(level);
  111. };
  112. });
  113. return logger;
  114. };