@cichol/logger 2.0.8 → 4.0.0-alpha.1

package/releases/esm.js

@@ -0,0 +1,523 @@
+import _Symbol from '@babel/runtime-corejs3/core-js/symbol';
+import _filterInstanceProperty from '@babel/runtime-corejs3/core-js/instance/filter';
+import _mapInstanceProperty from '@babel/runtime-corejs3/core-js/instance/map';
+import _trimInstanceProperty from '@babel/runtime-corejs3/core-js/instance/trim';
+import _Reflect$hasOwnMetadata from '@babel/runtime-corejs3/core-js/reflect/has-own-metadata';
+import _Reflect$getOwnMetadata from '@babel/runtime-corejs3/core-js/reflect/get-own-metadata';
+import _Reflect$defineMetadata from '@babel/runtime-corejs3/core-js/reflect/define-metadata';
+import 'reflect-metadata';
+import { STATUS_CODES, IncomingMessage, ServerResponse } from 'http';
+import { PassThrough } from 'stream';
+import Promise$1 from 'bluebird';
+import lodash from 'lodash';
+import morgan from 'morgan';
+import winston, { format } from 'winston';
+import _findInstanceProperty from '@babel/runtime-corejs3/core-js/instance/find';
+import _Reflect$apply from '@babel/runtime-corejs3/core-js/reflect/apply';
+import chalk from 'chalk';
+import rTracer from 'cls-rtracer';
+import moment from 'moment';
+import _Map from '@babel/runtime-corejs3/core-js/map';
+import process, { version, env } from 'process';
+import _Symbol$for from '@babel/runtime-corejs3/core-js/symbol/for';
+import _startsWithInstanceProperty from '@babel/runtime-corejs3/core-js/instance/starts-with';
+import _sliceInstanceProperty from '@babel/runtime-corejs3/core-js/instance/slice';
+import path from 'path';
+import highlight from 'cli-highlight';
+import prettyBytes from 'pretty-bytes';
+import prettyMs from 'pretty-ms';
+import cluster from 'cluster';
+import 'worker_threads';
+
+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(); // Helpers.
+
+function createScheme(options) {
+  const nextIndex = colorizerMap.size;
+  const colorizer = chalk.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;
+}
+/* eslint-enable no-use-before-define */
+
+// Node.js built-in APIs.
+
+const {
+  isTTY
+} = process.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.cwd();
+const conjunction = ` ${chalk.blue('──')} `;
+
+const splat = _Symbol$for('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.relative(rootPath, filename);
+
+  if (_startsWithInstanceProperty(target).call(target, 'node_modules')) {
+    target = chalk.gray(target).replace(/node_modules[\\/]([^\\/]+)(.*)/, (matches, moduleName, trailing) => `node_modules${path.sep}${chalk.bold.underline(moduleName)}${chalk.gray(trailing)}` // eslint-disable-line max-len
+    );
+  } else {
+    target = `${chalk.gray(path.dirname(target) + path.sep)}${chalk.bold.underline(path.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(_context = _mapInstanceProperty(_context2 = _mapInstanceProperty(_context3 = _sliceInstanceProperty(rawStack).call(rawStack, name.length + message.length + 3).split('\n')).call(_context3, line => line.replace(/^\s+at /g, ''))).call(_context2, line => path.isAbsolute(line) ? `<anonymous>${conjunction}${mapLocationOfErrorThrown(line)}` : line)).call(_context, line => line.replace(/^(.+) \((.+)\)$/, (matches, contextName, rawLocation) => {
+    let location;
+
+    if (rawLocation === '<anonymous>') {
+      location = chalk.gray(rawLocation);
+    } else {
+      const [filename, line, column] = rawLocation.split(':');
+
+      if (path.isAbsolute(filename)) {
+        const target = mapLocationOfErrorThrown(path.relative(rootPath, filename));
+        const trailing = chalk.gray(`:${line}:${column}`);
+        location = target + trailing;
+      } else {
+        location = chalk.gray(`https://github.com/${chalk.bold.underline('nodejs')}/node/blob/${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(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 = format.printf(data => {
+  const timestamp = chalk.gray(moment().toISOString(true));
+
+  const handler = _findInstanceProperty(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(performHandle, undefined, [data]) ?? fallback;
+  let extraFingerprint;
+
+  if (handler?.level === LoggingLevel.Http) {
+    extraFingerprint = data.transactionId ? `(Transaction-ID = ${data.transactionId})` : `(Request-ID = ${rTracer.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 = env.NODE_ENV ?? ExecutionMode.DevelopmentMode;
+cluster.isPrimary ?? cluster.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} ${STATUS_CODES[statusCode]}`;
+
+  switch (groupOfCode) {
+    case 200:
+      {
+        return chalk.green(baseMessage);
+      }
+
+    case 300:
+      {
+        return chalk.magenta(baseMessage);
+      }
+
+    case 400:
+    case 500:
+      {
+        return chalk.red(baseMessage);
+      }
+
+    default:
+      {
+        return chalk.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.bold(method);
+  const $version = chalk.rgb(98, 177, 255)(httpVersion);
+  const $statusCode = decorateStatusCode(statusCode);
+  const $contentLength = contentLength >= 0 ? prettyBytes(contentLength) : '? B';
+  const $responseTime = responseTime >= 0 ? prettyMs(responseTime) : ''; // Additional information.
+
+  const metadata = `(${$contentLength}, ${$responseTime})`;
+  return [`→ ${$method} ${URL} ${$version}`, `← ${$version} ${$statusCode} ${metadata}`].join('\n');
+}
+
+var formatForMorgan$1 = executionMode === ExecutionMode.DevelopmentMode ? formatForMorgan : morgan.combined;
+
+var _context, _context2;
+
+// Transports.
+const {
+  Console: ConsoleTransport
+} = winston.transports; // Keys in order to access private properties.
+
+const KeyOfInstance = _Symbol('@cichol/logger::classes/logger::Instance');
+
+const KeyOfPassport = _Symbol('@cichol/logger::classes/logger::Passport');
+
+class Logger {
+  #logger = winston.createLogger({
+    levels: _filterInstanceProperty(_context = _mapInstanceProperty(_context2 = lodash(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(formatForMorgan$1, {
+    stream: new PassThrough({
+      objectMode: true
+    }).on('data', data => {
+      this.log('http', _trimInstanceProperty(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(KeyOfInstance, Logger)) {
+      return _Reflect$getOwnMetadata(KeyOfInstance, Logger);
+    }
+
+    const instance = new Logger(KeyOfPassport);
+
+    try {
+      return instance;
+    } finally {
+      _Reflect$defineMetadata(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 IncomingMessage && args[1] instanceof ServerResponse:
+        {
+          const [request, response] = args;
+          return Promise$1.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;
+
+export { logger as default };

package/releases/index.d.ts

@@ -0,0 +1,196 @@
+/// <reference types="morgan" />
+/// <reference types="node" />
+/// <reference types="bluebird" />
+declare module "helpers/logging-level" {
+    const LoggingLevel: {
+        readonly Fatal: 0;
+        readonly Error: 1;
+        readonly Warning: 2;
+        readonly Notice: 3;
+        readonly Info: 3;
+        readonly Http: 4;
+        readonly Query: 4;
+        readonly Verbose: 5;
+        readonly Debug: 5;
+    };
+    type LoggingLevel = typeof LoggingLevel[keyof typeof LoggingLevel];
+    export default LoggingLevel;
+}
+declare module "helpers/color-scheme" {
+    import { Chalk } from 'chalk';
+    const ColorScheme: {
+        readonly Critical: number;
+        readonly Warning: number;
+        readonly Regular: number;
+        readonly Http: number;
+        readonly Query: number;
+        readonly Loud: number;
+    };
+    type ColorScheme = typeof ColorScheme[keyof typeof ColorScheme];
+    export function getChalkOf(colorSet: ColorScheme): Chalk;
+    export default ColorScheme;
+}
+declare module "helpers/label-decorator" {
+    import ColorScheme from "helpers/color-scheme";
+    export default function decorateLabel<T extends string>(label: T, scheme: ColorScheme): T;
+}
+declare module "handlers/error" {
+    type LoggingData = {
+        level: string;
+        message: string;
+    } & Record<PropertyKey, any>;
+    type HandledData = {
+        label: string;
+        payload: string;
+    };
+    export const name = "error";
+    export const level: 1;
+    export const label: "ERROR";
+    export default function handle(data: LoggingData): HandledData | undefined;
+}
+declare module "handlers/fatal" {
+    export const name = "fatal";
+    export const level: 0;
+    export const label: "FATAL";
+    export { default } from "handlers/error";
+}
+declare module "handlers/warning" {
+    export const name = "warning";
+    export const level: 2;
+    export const label: "WARNING";
+    const _default: null;
+    export default _default;
+}
+declare module "handlers/notice" {
+    export const name = "notice";
+    export const level: 3;
+    export const label: "NOTICE";
+    const _default_1: null;
+    export default _default_1;
+}
+declare module "handlers/info" {
+    export const name = "info";
+    export const level: 3;
+    export const label: "INFO";
+    const _default_2: null;
+    export default _default_2;
+}
+declare module "handlers/http" {
+    export const name = "http";
+    export const level: 4;
+    export const label: "HTTP";
+    const _default_3: null;
+    export default _default_3;
+}
+declare module "handlers/query" {
+    type LoggingData = {
+        level: string;
+        message: string;
+    } & Record<PropertyKey, any>;
+    type HandledData = {
+        label: string;
+        payload: string;
+    };
+    export const name = "query";
+    export const level: 4;
+    export const label: "QUERY";
+    export default function handle(data: LoggingData): HandledData | undefined;
+}
+declare module "handlers/verbose" {
+    export const name = "verbose";
+    export const level: 5;
+    export const label: "VERBOSE";
+    const _default_4: null;
+    export default _default_4;
+}
+declare module "handlers/debug" {
+    export const name = "debug";
+    export const level: 5;
+    export const label: "DEBUG";
+    const _default_5: null;
+    export default _default_5;
+}
+declare module "handlers/index" {
+    import * as FatalHandler from "handlers/fatal";
+    import * as ErrorHandler from "handlers/error";
+    import * as WarningHandler from "handlers/warning";
+    import * as NoticeHandler from "handlers/notice";
+    import * as InfoHandler from "handlers/info";
+    import * as HttpHandler from "handlers/http";
+    import * as QueryHandler from "handlers/query";
+    import * as VerboseHandler from "handlers/verbose";
+    import * as DebugHandler from "handlers/debug";
+    const handlers: (typeof FatalHandler | typeof ErrorHandler | typeof WarningHandler | typeof NoticeHandler | typeof InfoHandler | typeof HttpHandler | typeof QueryHandler | typeof VerboseHandler | typeof DebugHandler)[];
+    export type LoggingLevelName = (typeof handlers extends (infer T)[] ? T : never)['name'];
+    export default handlers;
+}
+declare module "formatters/command-line" {
+    const _default_6: import("logform").Format;
+    export default _default_6;
+}
+declare module "helpers/constants" {
+    export const ExecutionMode: {
+        readonly DevelopmentMode: "development";
+        readonly ProductionMode: "production";
+    };
+    export const ClusteringMode: {
+        readonly MasterProcess: 0;
+        readonly WorkerProcess: 1;
+    };
+    export const ThreadingMode: {
+        readonly MainThread: 0;
+        readonly WorkerThread: 1;
+    };
+    export type ExecutionMode = typeof ExecutionMode[keyof typeof ExecutionMode];
+    export type ClusteringMode = typeof ClusteringMode[keyof typeof ClusteringMode];
+    export type ThreadingMode = typeof ThreadingMode[keyof typeof ThreadingMode];
+    export const executionMode: ExecutionMode;
+    export const clusteringMode: ClusteringMode;
+    export const threadingMode: ThreadingMode;
+}
+declare module "formatters/morgan" {
+    import { IncomingMessage as HttpRequest, ServerResponse as HttpResponse } from 'http';
+    import morgan from 'morgan';
+    module 'morgan' {
+        const combined: morgan.FormatFn;
+    }
+    const _default_7: morgan.FormatFn<HttpRequest, HttpResponse>;
+    export default _default_7;
+}
+declare module "classes/logger" {
+    import 'reflect-metadata';
+    import { IncomingMessage as HttpRequest, ServerResponse as HttpResponse } from 'http';
+    import Promise from 'bluebird';
+    import type { LoggingLevelName } from "handlers/index";
+    class Logger {
+        #private;
+        private constructor();
+        static get instance(): Logger;
+        /**
+         * Logging message with specific level.
+         *
+         * @param level
+         * @param message
+         * @param args Additional metadata.
+         */
+        log(level: LoggingLevelName, message: string, ...args: any[]): void;
+        /**
+         * Logging HTTP I/O.
+         *
+         * @param request Node.js built-in `IncomingMessage` instance from `http` module.
+         * @param response Node.js built-in `ServerResponse` instance from `http` module.
+         */
+        log(request: HttpRequest, response: HttpResponse): Promise<void>;
+        /**
+         * Logging errors in detail.
+         *
+         * @param error
+         */
+        log(error: Error): void;
+    }
+    const _default_8: Logger;
+    export default _default_8;
+}
+declare module "index" {
+    export { default } from "classes/logger";
+}