@cichol/logger 2.0.8 → 4.0.0-alpha.1

package/README.md

@@ -26,7 +26,7 @@ $ npm install --save @cichol/logger
 
 ## License
 
-[MIT Licensed](LICENSE).
+[MIT Licensed](../../LICENSE).
 
 [github actions badge]: https://img.shields.io/github/workflow/status/morrighan/logger/On%20default/develop?style=flat-square
 [github actions]: https://github.com/morrighan/logger/actions

package/package.json

@@ -1,10 +1,10 @@
 {
     "name": "@cichol/logger",
-    "version": "2.0.8",
+    "version": "4.0.0-alpha.1",
     "description": "A logger based on `winston` for personal projects.",
-    "homepage": "https://github.com/morrighan/logger",
+    "homepage": "https://github.com/morrighan/packages",
     "bugs": {
-        "url": "https://github.com/morrighan/logger/issues"
+        "url": "https://github.com/morrighan/packages/issues"
     },
     "license": "MIT",
     "author": {
@@ -12,32 +12,28 @@
         "email": "contact@cichol.com",
         "url": "https://www.cichol.com/"
     },
-    "type": "module",
-    "main": "releases/cjs/index.cjs",
-    "module": "releases/esm/index.mjs",
+    "main": "releases/cjs.js",
+    "module": "releases/esm.js",
+    "types": "releases/index.d.ts",
     "directories": {
         "lib": "releases"
     },
     "exports": {
-        "import": "./releases/esm/index.mjs",
-        "require": "./releases/cjs/index.cjs"
+        "import": "./releases/esm.js",
+        "require": "./releases/cjs.js"
     },
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/morrighan/logger.git"
+        "url": "git+https://github.com/morrighan/packages.git",
+        "directory": "packages/logger"
     },
     "scripts": {
-        "build": "npm run build:cjs && npm run build:esm",
-        "build:cjs": "BABEL_ENV=\"cjs\" JS_EXTENSION=\".cjs\" npm run compile",
-        "build:esm": "BABEL_ENV=\"esm\" JS_EXTENSION=\".mjs\" npm run compile",
-        "compile": "npx babel --root-mode upward sources --extensions .js,.ts --out-dir releases/$BABEL_ENV --out-file-extension $JS_EXTENSION --source-maps inline --delete-dir-on-start && npx tsc --project sources --outDir releases/$BABEL_ENV",
-        "test": "npm run test:eslint && npm run test:tsc",
-        "test:eslint": "npx eslint . --ext .js,.ts",
-        "test:tsc": "npx tsc --project . --noEmit"
+        "build": "npm run build:tsc",
+        "build:tsc": "npx tsc --project sources --outFile releases/index.d.ts"
     },
     "dependencies": {
         "bluebird": "^3.7.2",
-        "chalk": "^4.1.1",
+        "chalk": "^4.1.2",
         "cli-highlight": "^2.1.11",
         "cls-rtracer": "^2.6.0",
         "lodash": "^4.17.21",
@@ -48,24 +44,9 @@
         "reflect-metadata": "^0.1.13",
         "winston": "^3.3.3"
     },
-    "devDependencies": {
-        "@babel/cli": "^7.14.3",
-        "@babel/core": "^7.14.3",
-        "@babel/plugin-transform-runtime": "^7.14.3",
-        "@babel/preset-env": "^7.14.2",
-        "@babel/preset-typescript": "^7.13.0",
-        "@cichol/eslint-config": "^3.0.2",
-        "@types/babel__core": "^7.1.14",
-        "@types/bluebird": "^3.5.35",
-        "@types/lodash": "^4.14.170",
-        "@types/morgan": "^1.9.2",
-        "@types/node": "^15.6.1",
-        "eslint": "^7.27.0",
-        "typescript": "^4.2.4"
-    },
     "engines": {
-        "node": "^14.16.0 || ^16",
-        "npm": "^7.12.0"
+        "node": "^14.18.3 || ^16.13.2",
+        "npm": "^8.3.1"
     },
     "publishConfig": {
         "registry": "https://registry.npmjs.org/",

package/releases/cjs.js

@@ -0,0 +1,554 @@
+'use strict';
+
+var _Symbol = require('@babel/runtime-corejs3/core-js/symbol');
+var _filterInstanceProperty = require('@babel/runtime-corejs3/core-js/instance/filter');
+var _mapInstanceProperty = require('@babel/runtime-corejs3/core-js/instance/map');
+var _trimInstanceProperty = require('@babel/runtime-corejs3/core-js/instance/trim');
+var _Reflect$hasOwnMetadata = require('@babel/runtime-corejs3/core-js/reflect/has-own-metadata');
+var _Reflect$getOwnMetadata = require('@babel/runtime-corejs3/core-js/reflect/get-own-metadata');
+var _Reflect$defineMetadata = require('@babel/runtime-corejs3/core-js/reflect/define-metadata');
+require('reflect-metadata');
+var http$1 = require('http');
+var stream = require('stream');
+var Promise$1 = require('bluebird');
+var lodash = require('lodash');
+var morgan = require('morgan');
+var winston = require('winston');
+var _findInstanceProperty = require('@babel/runtime-corejs3/core-js/instance/find');
+var _Reflect$apply = require('@babel/runtime-corejs3/core-js/reflect/apply');
+var chalk = require('chalk');
+var rTracer = require('cls-rtracer');
+var moment = require('moment');
+var _Map = require('@babel/runtime-corejs3/core-js/map');
+var process = require('process');
+var _Symbol$for = require('@babel/runtime-corejs3/core-js/symbol/for');
+var _startsWithInstanceProperty = require('@babel/runtime-corejs3/core-js/instance/starts-with');
+var _sliceInstanceProperty = require('@babel/runtime-corejs3/core-js/instance/slice');
+var path = require('path');
+var highlight = require('cli-highlight');
+var prettyBytes = require('pretty-bytes');
+var prettyMs = require('pretty-ms');
+var cluster = require('cluster');
+require('worker_threads');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var _Symbol__default = /*#__PURE__*/_interopDefaultLegacy(_Symbol);
+var _filterInstanceProperty__default = /*#__PURE__*/_interopDefaultLegacy(_filterInstanceProperty);
+var _mapInstanceProperty__default = /*#__PURE__*/_interopDefaultLegacy(_mapInstanceProperty);
+var _trimInstanceProperty__default = /*#__PURE__*/_interopDefaultLegacy(_trimInstanceProperty);
+var _Reflect$hasOwnMetadata__default = /*#__PURE__*/_interopDefaultLegacy(_Reflect$hasOwnMetadata);
+var _Reflect$getOwnMetadata__default = /*#__PURE__*/_interopDefaultLegacy(_Reflect$getOwnMetadata);
+var _Reflect$defineMetadata__default = /*#__PURE__*/_interopDefaultLegacy(_Reflect$defineMetadata);
+var Promise__default = /*#__PURE__*/_interopDefaultLegacy(Promise$1);
+var lodash__default = /*#__PURE__*/_interopDefaultLegacy(lodash);
+var morgan__default = /*#__PURE__*/_interopDefaultLegacy(morgan);
+var winston__default = /*#__PURE__*/_interopDefaultLegacy(winston);
+var _findInstanceProperty__default = /*#__PURE__*/_interopDefaultLegacy(_findInstanceProperty);
+var _Reflect$apply__default = /*#__PURE__*/_interopDefaultLegacy(_Reflect$apply);
+var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
+var rTracer__default = /*#__PURE__*/_interopDefaultLegacy(rTracer);
+var moment__default = /*#__PURE__*/_interopDefaultLegacy(moment);
+var _Map__default = /*#__PURE__*/_interopDefaultLegacy(_Map);
+var process__default = /*#__PURE__*/_interopDefaultLegacy(process);
+var _Symbol$for__default = /*#__PURE__*/_interopDefaultLegacy(_Symbol$for);
+var _startsWithInstanceProperty__default = /*#__PURE__*/_interopDefaultLegacy(_startsWithInstanceProperty);
+var _sliceInstanceProperty__default = /*#__PURE__*/_interopDefaultLegacy(_sliceInstanceProperty);
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+var highlight__default = /*#__PURE__*/_interopDefaultLegacy(highlight);
+var prettyBytes__default = /*#__PURE__*/_interopDefaultLegacy(prettyBytes);
+var prettyMs__default = /*#__PURE__*/_interopDefaultLegacy(prettyMs);
+var cluster__default = /*#__PURE__*/_interopDefaultLegacy(cluster);
+
+const LoggingLevel = {
+  // Critical levels. (It will crash the process)
+  Fatal: 0,
+  Error: 1,
+  // Warning levels. (It just report warning information, not crash the process)
+  Warning: 2,
+  // Regular level and aliases.
+  Notice: 3,
+  Info: 3,
+  // Maybe sensitive levels. (In general, does not useful)
+  Http: 4,
+  Query: 4,
+  // Loud levels.
+  Verbose: 5,
+  Debug: 5
+};
+
+const colorizerMap = new _Map__default["default"](); // Helpers.
+
+function createScheme(options) {
+  const nextIndex = colorizerMap.size;
+  const colorizer = chalk__default["default"].bgHex(options.background).hex(options.foreground);
+  colorizerMap.set(nextIndex, colorizer);
+  return nextIndex;
+} // Color definitions.
+
+
+const ColorValue = {
+  // Basic colors.
+  White: '#FFFFFF',
+  Gray: '#808080',
+  Black: '#000000',
+  // Specialized colors.
+  Critical: '#D63031',
+  Warning: '#FDCB6E',
+  Regular: '#0984E3',
+  Http: '#6AB04C',
+  Query: '#399AF3'
+};
+const ColorScheme = {
+  Critical: createScheme({
+    background: ColorValue.Critical,
+    foreground: ColorValue.Black
+  }),
+  Warning: createScheme({
+    background: ColorValue.Warning,
+    foreground: ColorValue.Black
+  }),
+  Regular: createScheme({
+    background: ColorValue.Regular,
+    foreground: ColorValue.White
+  }),
+  Http: createScheme({
+    background: ColorValue.Http,
+    foreground: ColorValue.Black
+  }),
+  Query: createScheme({
+    background: ColorValue.Query,
+    foreground: ColorValue.Black
+  }),
+  Loud: createScheme({
+    background: ColorValue.Black,
+    foreground: ColorValue.Gray
+  })
+};
+function getChalkOf(colorSet) {
+  return colorizerMap.get(colorSet) ?? chalk__default["default"];
+}
+/* eslint-enable no-use-before-define */
+
+// Node.js built-in APIs.
+
+const {
+  isTTY
+} = process__default["default"].stdout;
+const isNotOnCLI = !isTTY;
+function decorateLabel(label, scheme) {
+  if (isNotOnCLI) {
+    return label;
+  }
+
+  const chalk = getChalkOf(scheme);
+  const decoratedLabel = chalk.bold(` ${label} `);
+  return decoratedLabel;
+}
+
+// Constants.
+const rootPath = process__default["default"].cwd();
+const conjunction = ` ${chalk__default["default"].blue('──')} `;
+
+const splat = _Symbol$for__default["default"]('splat'); // Handler metadata.
+
+
+const name$8 = 'error';
+const level$8 = LoggingLevel.Error;
+const label$8 = decorateLabel('ERROR', ColorScheme.Critical);
+
+function mapLocationOfErrorThrown(filename) {
+  let target = path__default["default"].relative(rootPath, filename);
+
+  if (_startsWithInstanceProperty__default["default"](target).call(target, 'node_modules')) {
+    target = chalk__default["default"].gray(target).replace(/node_modules[\\/]([^\\/]+)(.*)/, (matches, moduleName, trailing) => `node_modules${path__default["default"].sep}${chalk__default["default"].bold.underline(moduleName)}${chalk__default["default"].gray(trailing)}` // eslint-disable-line max-len
+    );
+  } else {
+    target = `${chalk__default["default"].gray(path__default["default"].dirname(target) + path__default["default"].sep)}${chalk__default["default"].bold.underline(path__default["default"].basename(target))}`;
+  }
+
+  return target;
+}
+
+function handle$1(data) {
+  var _context, _context2, _context3;
+
+  const {
+    [splat]: [error] = []
+  } = data;
+
+  if (!(error instanceof Error)) {
+    return undefined;
+  }
+
+  const {
+    name,
+    message,
+    stack: rawStack = ''
+  } = error;
+
+  const stack = _mapInstanceProperty__default["default"](_context = _mapInstanceProperty__default["default"](_context2 = _mapInstanceProperty__default["default"](_context3 = _sliceInstanceProperty__default["default"](rawStack).call(rawStack, name.length + message.length + 3).split('\n')).call(_context3, line => line.replace(/^\s+at /g, ''))).call(_context2, line => path__default["default"].isAbsolute(line) ? `<anonymous>${conjunction}${mapLocationOfErrorThrown(line)}` : line)).call(_context, line => line.replace(/^(.+) \((.+)\)$/, (matches, contextName, rawLocation) => {
+    let location;
+
+    if (rawLocation === '<anonymous>') {
+      location = chalk__default["default"].gray(rawLocation);
+    } else {
+      const [filename, line, column] = rawLocation.split(':');
+
+      if (path__default["default"].isAbsolute(filename)) {
+        const target = mapLocationOfErrorThrown(path__default["default"].relative(rootPath, filename));
+        const trailing = chalk__default["default"].gray(`:${line}:${column}`);
+        location = target + trailing;
+      } else {
+        location = chalk__default["default"].gray(`https://github.com/${chalk__default["default"].bold.underline('nodejs')}/node/blob/${process.version}/lib/${filename}#L${line}`); // eslint-disable-line max-len
+      }
+    }
+
+    return `${contextName}${conjunction}${location}`;
+  })).join('\n');
+
+  const label = decorateLabel(name, ColorScheme.Critical);
+  const payload = `${message}\n\n${stack}\n`;
+  return {
+    label,
+    payload
+  };
+}
+
+var ErrorHandler = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    name: name$8,
+    level: level$8,
+    label: label$8,
+    'default': handle$1
+});
+
+// Local helpers.
+
+const name$7 = 'fatal';
+const level$7 = LoggingLevel.Fatal;
+const label$7 = decorateLabel('FATAL', ColorScheme.Critical);
+
+var FatalHandler = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    name: name$7,
+    level: level$7,
+    label: label$7,
+    'default': handle$1
+});
+
+// Local helpers.
+
+const name$6 = 'warning';
+const level$6 = LoggingLevel.Warning;
+const label$6 = decorateLabel('WARNING', ColorScheme.Warning);
+var warning = null;
+
+var WarningHandler = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    name: name$6,
+    level: level$6,
+    label: label$6,
+    'default': warning
+});
+
+// Local helpers.
+
+const name$5 = 'notice';
+const level$5 = LoggingLevel.Notice;
+const label$5 = decorateLabel('NOTICE', ColorScheme.Regular);
+var notice = null;
+
+var NoticeHandler = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    name: name$5,
+    level: level$5,
+    label: label$5,
+    'default': notice
+});
+
+// Local helpers.
+
+const name$4 = 'info';
+const level$4 = LoggingLevel.Info;
+const label$4 = decorateLabel('INFO', ColorScheme.Regular);
+var info = null;
+
+var InfoHandler = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    name: name$4,
+    level: level$4,
+    label: label$4,
+    'default': info
+});
+
+// Local helpers.
+
+const name$3 = 'http';
+const level$3 = LoggingLevel.Http;
+const label$3 = decorateLabel('HTTP', ColorScheme.Http);
+var http = null;
+
+var HttpHandler = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    name: name$3,
+    level: level$3,
+    label: label$3,
+    'default': http
+});
+
+// Highlight.js
+
+// Handler metadata.
+const name$2 = 'query';
+const level$2 = LoggingLevel.Query;
+const label$2 = decorateLabel('QUERY', ColorScheme.Query);
+function handle(data) {
+  const payload = highlight__default["default"](data.message, {
+    language: 'sql'
+  });
+  return {
+    label: label$2,
+    payload
+  };
+}
+
+var QueryHandler = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    name: name$2,
+    level: level$2,
+    label: label$2,
+    'default': handle
+});
+
+// Local helpers.
+
+const name$1 = 'verbose';
+const level$1 = LoggingLevel.Verbose;
+const label$1 = decorateLabel('VERBOSE', ColorScheme.Loud);
+var verbose = null;
+
+var VerboseHandler = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    name: name$1,
+    level: level$1,
+    label: label$1,
+    'default': verbose
+});
+
+// Local helpers.
+
+const name = 'debug';
+const level = LoggingLevel.Debug;
+const label = decorateLabel('DEBUG', ColorScheme.Loud);
+var debug = null;
+
+var DebugHandler = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    name: name,
+    level: level,
+    label: label,
+    'default': debug
+});
+
+// Handler implementations.
+const handlers = [FatalHandler, ErrorHandler, WarningHandler, NoticeHandler, InfoHandler, HttpHandler, QueryHandler, VerboseHandler, DebugHandler];
+
+var formatForCLI = winston.format.printf(data => {
+  const timestamp = chalk__default["default"].gray(moment__default["default"]().toISOString(true));
+
+  const handler = _findInstanceProperty__default["default"](handlers).call(handlers, ({
+    name
+  }) => name === data.level);
+
+  const fallback = {
+    label: handler?.label,
+    payload: data.message
+  };
+
+  const performHandle = handler?.default ?? (() => fallback); // Execute handler and then, get decorated payload.
+
+
+  const {
+    label,
+    payload
+  } = _Reflect$apply__default["default"](performHandle, undefined, [data]) ?? fallback;
+  let extraFingerprint;
+
+  if (handler?.level === LoggingLevel.Http) {
+    extraFingerprint = data.transactionId ? `(Transaction-ID = ${data.transactionId})` : `(Request-ID = ${rTracer__default["default"].id()})`;
+  }
+
+  return `${label} ${timestamp}${extraFingerprint ? ` ${extraFingerprint}` : ''}\n${payload}`;
+});
+
+// Node.js built-in APIs.
+
+const ExecutionMode = {
+  DevelopmentMode: 'development',
+  ProductionMode: 'production'
+};
+const ClusteringMode = {
+  MasterProcess: 0,
+  WorkerProcess: 1
+};
+// Exportings.
+const executionMode = process.env.NODE_ENV ?? ExecutionMode.DevelopmentMode;
+cluster__default["default"].isPrimary ?? cluster__default["default"].isMaster ? ClusteringMode.MasterProcess : ClusteringMode.WorkerProcess;
+
+// Node.js built-in APIs.
+
+// Helpers.
+function decorateStatusCode(statusCode) {
+  const groupOfCode = Math.floor(Number(statusCode) / 100) * 100;
+  const baseMessage = `${statusCode} ${http$1.STATUS_CODES[statusCode]}`;
+
+  switch (groupOfCode) {
+    case 200:
+      {
+        return chalk__default["default"].green(baseMessage);
+      }
+
+    case 300:
+      {
+        return chalk__default["default"].magenta(baseMessage);
+      }
+
+    case 400:
+    case 500:
+      {
+        return chalk__default["default"].red(baseMessage);
+      }
+
+    default:
+      {
+        return chalk__default["default"].gray(baseMessage);
+      }
+  }
+}
+
+function formatForMorgan(tokens, request, response) {
+  function _(token, ...subArgs) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+    return tokens[token](request, response, ...subArgs);
+  } // Raw values.
+
+
+  const method = _('method');
+
+  const URL = _('url');
+
+  const httpVersion = `HTTP/${_('http-version')}`;
+  const statusCode = Number(_('status'));
+  const contentLength = Number(_('res', 'content-length') ?? -1);
+  const responseTime = Number(_('response-time') ?? -1); // Decorated values.
+
+  const $method = chalk__default["default"].bold(method);
+  const $version = chalk__default["default"].rgb(98, 177, 255)(httpVersion);
+  const $statusCode = decorateStatusCode(statusCode);
+  const $contentLength = contentLength >= 0 ? prettyBytes__default["default"](contentLength) : '? B';
+  const $responseTime = responseTime >= 0 ? prettyMs__default["default"](responseTime) : ''; // Additional information.
+
+  const metadata = `(${$contentLength}, ${$responseTime})`;
+  return [`→ ${$method} ${URL} ${$version}`, `← ${$version} ${$statusCode} ${metadata}`].join('\n');
+}
+
+var formatForMorgan$1 = executionMode === ExecutionMode.DevelopmentMode ? formatForMorgan : morgan__default["default"].combined;
+
+var _context, _context2;
+
+// Transports.
+const {
+  Console: ConsoleTransport
+} = winston__default["default"].transports; // Keys in order to access private properties.
+
+const KeyOfInstance = _Symbol__default["default"]('@cichol/logger::classes/logger::Instance');
+
+const KeyOfPassport = _Symbol__default["default"]('@cichol/logger::classes/logger::Passport');
+
+class Logger {
+  #logger = winston__default["default"].createLogger({
+    levels: _filterInstanceProperty__default["default"](_context = _mapInstanceProperty__default["default"](_context2 = lodash__default["default"](handlers)).call(_context2, ({
+      name,
+      level
+    }) => [name, level])).call(_context, ([, level]) => typeof level === 'number').fromPairs().value(),
+    level: executionMode === ExecutionMode.ProductionMode ? 'http' : 'verbose',
+    transports: [new ConsoleTransport({
+      format: formatForCLI
+    })],
+    exitOnError: false
+  });
+  #morgan = morgan__default["default"](formatForMorgan$1, {
+    stream: new stream.PassThrough({
+      objectMode: true
+    }).on('data', data => {
+      this.log('http', _trimInstanceProperty__default["default"](data).call(data));
+    })
+  });
+
+  constructor(passport) {
+    if (passport !== KeyOfPassport) {
+      throw new ReferenceError('Logger class cannot be constructed in directly');
+    }
+  }
+
+  static get instance() {
+    if (this !== Logger) {
+      throw new ReferenceError('Logger class is not inheritable');
+    }
+
+    if (_Reflect$hasOwnMetadata__default["default"](KeyOfInstance, Logger)) {
+      return _Reflect$getOwnMetadata__default["default"](KeyOfInstance, Logger);
+    }
+
+    const instance = new Logger(KeyOfPassport);
+
+    try {
+      return instance;
+    } finally {
+      _Reflect$defineMetadata__default["default"](KeyOfInstance, instance, Logger);
+    }
+  }
+  /**
+   * Logging message with specific level.
+   *
+   * @param level
+   * @param message
+   * @param args Additional metadata.
+   */
+
+
+  log(...args) {
+    const logger = this.#logger;
+    const morgan = this.#morgan;
+
+    switch (true) {
+      case args.length >= 2 && args[0] instanceof http$1.IncomingMessage && args[1] instanceof http$1.ServerResponse:
+        {
+          const [request, response] = args;
+          return Promise__default["default"].fromCallback(callback => morgan(request, response, callback));
+        }
+
+      case args.length >= 1 && args[0] instanceof Error:
+        {
+          const [error, ...data] = args; // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+
+          logger.log('error', error.message, error, ...data);
+          return undefined;
+        }
+
+      default:
+        {
+          const [level, message, ...data] = args; // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+
+          logger.log(level, message, ...data);
+          return undefined;
+        }
+    }
+  }
+
+}
+
+var logger = Logger.instance;
+
+module.exports = logger;