nlogs 1.1.3 → 2.3.2

package/dist/utils/trace.store.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="node" />
+import { AsyncLocalStorage } from 'async_hooks';
+import { MaybePromise } from '../helpers/types';
+export interface TraceState<T extends object> {
+    traceId: string;
+    sessionId?: string;
+    parentTrace?: TraceState<T>;
+    details?: T;
+}
+export interface WithTraceId {
+    traceId?: string;
+    sessionId?: string;
+    details?: any;
+    [key: string]: any;
+}
+export declare class TraceStore<T extends object = object> {
+    readonly storage: AsyncLocalStorage<TraceState<T>>;
+    readonly rootTraceId: string;
+    get store(): TraceState<T>;
+    get traceId(): string;
+    set traceId(value: string);
+    get sessionId(): string;
+    set sessionId(value: string);
+    get traceIds(): string[] | undefined;
+    get details(): {};
+    assign(state: Partial<TraceState<T>>): void;
+    setDetails(details: T): void;
+    mergeDetails(details: T): void;
+    run<R extends MaybePromise<any>>(callback: () => R): R;
+    run<R extends MaybePromise<any>>(traceId: string, callback: () => R): R;
+    run<R extends MaybePromise<any>, D extends WithTraceId>(details: D, callback: () => R): R;
+    exit(): Promise<void>;
+}

package/dist/utils/trace.store.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TraceStore = void 0;
+const async_hooks_1 = require("async_hooks");
+const string_1 = require("../helpers/string");
+const param_error_1 = require("../errors/param.error");
+class TraceStore {
+    constructor() {
+        this.storage = new async_hooks_1.AsyncLocalStorage();
+        this.rootTraceId = (0, string_1.uuid)();
+    }
+    get store() {
+        return this.storage.getStore() || { traceId: this.rootTraceId };
+    }
+    get traceId() {
+        return this.store?.traceId;
+    }
+    set traceId(value) {
+        this.assign({ traceId: value });
+    }
+    get sessionId() {
+        return this.store?.sessionId;
+    }
+    set sessionId(value) {
+        this.assign({ sessionId: value });
+    }
+    get traceIds() {
+        if (!this.store.parentTrace)
+            return undefined;
+        let state = this.store;
+        const ids = new Set();
+        while (state.parentTrace) {
+            state = state.parentTrace;
+            ids.add(state.traceId);
+        }
+        return [...ids].reverse();
+    }
+    get details() {
+        return this.store.details || {};
+    }
+    assign(state) {
+        this.storage.enterWith(Object.assign({}, this.storage.getStore(), state));
+    }
+    setDetails(details) {
+        this.assign({ details });
+    }
+    mergeDetails(details) {
+        this.assign({ details: Object.assign({}, this.details, details) });
+    }
+    run(tdc, callback) {
+        if (typeof tdc === 'function')
+            return this.run({}, tdc);
+        if (typeof callback !== 'function')
+            throw new param_error_1.ParamNlogsError('TraceStore.run', 'callback');
+        if (typeof tdc === 'string')
+            return this.run({ traceId: tdc }, callback);
+        const { traceId, sessionId, details, ...stateDetails } = tdc;
+        const state = {
+            ...this.store,
+            traceId: traceId || (0, string_1.uuid)(),
+            sessionId: sessionId || this.sessionId,
+            details: {
+                ...this.details,
+                ...stateDetails,
+                ...(details || {}),
+            },
+        };
+        state.parentTrace = this.store;
+        return this.storage.run(state, callback);
+    }
+    async exit() {
+        return new Promise(resolve => this.storage.exit(resolve));
+    }
+}
+exports.TraceStore = TraceStore;
+//# sourceMappingURL=trace.store.js.map

package/dist/utils/trace.store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trace.store.js","sourceRoot":"","sources":["../../src/utils/trace.store.ts"],"names":[],"mappings":";;;AAAA,6CAA+C;AAC/C,8CAAwC;AAExC,uDAAuD;AAgBvD,MAAa,UAAU;IAAvB;QACW,YAAO,GAAG,IAAI,+BAAiB,EAAiB,CAAA;QAChD,gBAAW,GAAG,IAAA,aAAI,GAAE,CAAA;IAiF/B,CAAC;IA/EC,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,CAAA;IACjE,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,KAAK,EAAE,OAAO,CAAA;IAC5B,CAAC;IAED,IAAI,OAAO,CAAC,KAAa;QACvB,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,KAAK,EAAE,SAAS,CAAA;IAC9B,CAAC;IAED,IAAI,SAAS,CAAC,KAAa;QACzB,IAAI,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAA;IACnC,CAAC;IAED,IAAI,QAAQ;QACV,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW;YAAE,OAAO,SAAS,CAAA;QAC7C,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACtB,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAA;QAE7B,OAAO,KAAK,CAAC,WAAW,EAAE;YACxB,KAAK,GAAG,KAAK,CAAC,WAAW,CAAA;YACzB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SACvB;QAID,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,OAAO,EAAE,CAAA;IAC3B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAA;IACjC,CAAC;IAED,MAAM,CAAC,KAA6B;QAClC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC,CAAA;IAC3E,CAAC;IAED,UAAU,CAAC,OAAU;QACnB,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;IAC1B,CAAC;IAED,YAAY,CAAC,OAAU;QACrB,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC,CAAA;IACpE,CAAC;IAKD,GAAG,CAAqD,GAA2B,EAAE,QAAkB;QACrG,IAAI,OAAO,GAAG,KAAK,UAAU;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;QACvD,IAAI,OAAO,QAAQ,KAAK,UAAU;YAAE,MAAM,IAAI,6BAAe,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAA;QAC3F,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAA;QAExE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,GAAG,CAAA;QAE5D,MAAM,KAAK,GAAkB;YAC3B,GAAG,IAAI,CAAC,KAAK;YACb,OAAO,EAAE,OAAO,IAAI,IAAA,aAAI,GAAE;YAC1B,SAAS,EAAE,SAAS,IAAI,IAAI,CAAC,SAAS;YACtC,OAAO,EAAE;gBACP,GAAG,IAAI,CAAC,OAAO;gBACf,GAAG,YAAY;gBACf,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;aACnB;SACF,CAAA;QAED,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAA;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;IACjE,CAAC;CACF;AAnFD,gCAmFC"}

package/package.json

@@ -1,25 +1,46 @@
 {
   "name": "nlogs",
-  "version": "1.1.3",
-  "main": "index.js",
+  "version": "2.3.2",
+  "main": "dist/index.js",
   "repository": "git@github.com:nerjs/nlogs.git",
   "author": "nerjs <karifan.stap@gmail.com>",
   "license": "MIT",
-  "typings": "./index.d.ts",
+  "scripts": {
+    "lint": "eslint .",
+    "clear": "rm -rf ./dist",
+    "build": "tsc --build",
+    "watch": "tsc --watch",
+    "start": "nodemon --enable-source-maps --trace-warnings ./dist",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage"
+  },
+  "files": [
+    "dist/*"
+  ],
   "keywords": [
     "logs",
     "logger",
     "console"
   ],
-  "dependencies": {
-    "colors": "^1.4.0",
-    "find-package": "^1.0.0",
-    "merge": "^1.2.1",
-    "moment": "^2.24.0",
-    "pretty-time": "^1.1.0",
-    "terminal-link": "^2.1.1"
-  },
   "devDependencies": {
-    "@nerjs/eslint-config": "^1.0.0"
+    "@types/jest": "29.2.4",
+    "@typescript-eslint/eslint-plugin": "5.47.0",
+    "@typescript-eslint/parser": "5.47.0",
+    "eslint": "8.23",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "jest": "29.3.1",
+    "nodemon": "2.0.19",
+    "prettier": "2.7.1",
+    "ts-jest": "29.0.3",
+    "typescript": "4.9.4",
+    "@types/debug": "4.1.7"
+  },
+  "dependencies": {
+    "@types/node": "18.11.17",
+    "@types/pretty-time": "1.1.2",
+    "debug": "4.3.4",
+    "pretty-time": "1.1.0"
   }
 }

package/.eslintrc.js

@@ -1,3 +0,0 @@
-module.exports = {
-    extends: ['@nerjs/eslint-config']
-}

package/index.d.ts

@@ -1,217 +0,0 @@
-
-export = Logger;
-
-declare function Logger(mod: Logger.ParamModule, config: Logger.Config): Logger.NLogger;
-
-
-declare namespace Logger {
-    declare type ParamModule = NodeModule | {filename: string} | ImportMeta | string
-
-    /**
-     * @description style methods for colors module
-     * @see {@link colors github}
-     * @see {@http https://github.com/Marak/colors.js} 
-     */
-    declare type Style = [       
-        "black" |
-        "red" |
-        "green" |
-        "yellow" |
-        "blue" |
-        "magenta" |
-        "cyan" |
-        "white" |
-        "gray" |
-        "grey" |
-        "brightRed" |
-        "brightGreen" |
-        "brightYellow" |
-        "brightBlue" |
-        "brightMagenta" |
-        "brightCyan" |
-        "brightWhite" |
-        "bgBlack" |
-        "bgRed" |
-        "bgGreen" |
-        "bgYellow" |
-        "bgBlue" |
-        "bgMagenta" |
-        "bgCyan" |
-        "bgWhite" |
-        "bgGray" |
-        "bgGrey" |
-        "bgBrightRed" |
-        "bgBrightGreen" |
-        "bgBrightYellow" |
-        "bgBrightBlue" |
-        "bgBrightMagenta" |
-        "bgBrightCyan" |
-        "bgBrightWhite" |
-        "reset" |
-        "bold" |
-        "dim" |
-        "italic" |
-        "underline" |
-        "inverse" |
-        "hidden" |
-        "strikethroug" |
-        "rainbow" |
-        "zebra" |
-        "america" |
-        "trap" |
-        "random" 
-    ]
-
-    declare type Segments = {
-
-        /**
-         * @description first segment (moduleName)
-         * @default ['yellow', 'italic', 'dim']
-         */
-        first: Style,
-
-        /**
-         * @description filename style
-         * @default ['cyan', 'italic']
-         */
-        last: Style,
-
-        /**
-         * @description path sections (from module dir to filename). Without separator
-         * @default ['grey', 'italic']
-         */
-        all: Style,
-
-        /**
-         * @description separator path sections
-         * @default ['gray']
-         */
-        delimiter: Style,
-    }
-
-    declare type MethodConfig = {
-
-        /** @description Sets whether this method works*/
-        show: boolean
-
-        /** @description style for method build time label. If not specified, use default */
-        time?: Style,
-
-        /** @description style for method build segments (path & moduleName) label. If not specified, use default */
-        segments?: Segments,
-
-        /** @description style for method build methodName label. If not specified, use default */
-        label?: Style,
-
-        /**
-         * @description Show message when invoking logger.time()? Only time method
-         * @default false
-         */
-        showStartTimer: boolean,
-
-        /**
-         * @description warning if the label exists when invoking logger.time(). Only time method
-         * @default true
-         */
-        warningPresentLabel: boolean,
-
-
-        /**
-         * @description warning if the label does not exist when invoking logger.timeEnd(). Only time method
-         * @default true
-         */
-        warningMissingLabel: boolean,
-
-        /**
-         * @description overwrite the label if one already exists. Only time method
-         * @default false
-         */
-        changePresentLabel: boolean,
-
-        /**
-         * @description diff time style. Only time method
-         * @default ['yellow']
-         */
-        diffTimeColor: Style,
-
-        /**
-         * @description depth param to dir method
-         * @default 3
-         */
-        depth: number
-    }
-
-
-    declare interface Config {
-
-        /**
-         * @description style for default build time label
-         * @default ['gray', 'bgBlack']
-         */
-        time: Style
-
-        /**
-         * @description style for default build methodName label
-         * @default ['white', 'bold']
-         */
-        label: Style
-
-        /** @description style for default build segments (path & moduleName) label */
-        segments: Segments;
-
-        /** 
-         * @description custom formatters
-         */
-        formatters: {
-
-            /** @description format string labels with styles */
-            string: (str: string, styles: Style) => string,
-
-            /** @description format time labels */
-            time: (timestamp: number, short: boolean) => string,
-        },
-
-
-        /**
-         * @default true
-         */
-        enableFileLink: boolean;
-
-        /**
-         * @description if not NULL, each time the indicated timestamp of the log does not match the previous one, an additional message is displayed indicating the full date and time
-         * @default hour
-         */
-        groupedEveryTime: 'minute' | 'hour' | 'day' | null,
-
-        /**
-         * @description config for each method
-         */
-        methods: {
-            log: MethodConfig,
-            info: MethodConfig,
-            debug: MethodConfig,
-            warn: MethodConfig,
-            error: MethodConfig,
-            time: MethodConfig,
-            dir: MethodConfig,
-            table: MethodConfig
-        },
-    }
-
-    export declare function getConfig(): Config;
-    export declare function setConfig(newConfig: Config): undefined;
-
-    export declare class NLogger {
-        log(): undefined;
-        info(): undefined;
-        debug(): undefined;
-        warn(): undefined;
-        error(): undefined;
-        time(label: string): undefined;
-        timeLog(label: string): undefined;
-        timeEnd(label: string): undefined;
-        dir(obj: object, params: {depth: number}): undefined;
-        table(arr: [object]): undefined;
-    }
-}
-

package/index.js

@@ -1,12 +0,0 @@
-const NLogger = require('./lib/logger')
-const Settings = require('./lib/config')
-
-const Logger = (mod, settings) => new NLogger(mod, settings)
-
-exports = module.exports = Logger
-
-exports.Logger = NLogger
-
-exports.getConfig = () => Settings.config
-
-exports.setConfig = newConfig => Settings.setConfig(newConfig)

package/lib/config.js

@@ -1,85 +0,0 @@
-const merge = require('merge')
-const findPackage = require('find-package')
-const path = require('path')
-const { fileURLToPath } = require('url')
-const defaultConfig = require('./defaultConfig')
-
-class NLoggerConfig {
-    constructor(mod, innerConfig) {
-        this.module = mod
-        this.config = innerConfig || {}
-        this.filename = null
-        this.packagePath = null
-        this.packageName = null
-        this.segments = []
-
-        this.initConfig()
-        this.initFileInfo()
-    }
-
-    initConfig() {
-        this.config = merge.recursive({}, NLoggerConfig.config, this.config || {})
-
-        let maxWidth = 0
-
-        Object.keys(this.config.methods).forEach(key => {
-            if (key.length > maxWidth) maxWidth = key.length
-            this.config.methods[key] = merge.recursive(
-                {},
-                {
-                    time: this.config.time,
-                    segments: this.config.segments,
-                    label: this.config.label,
-                },
-                this.config.methods[key],
-            )
-        })
-
-        Object.keys(this.config.methods).forEach(key => {
-            this.config.methods[key].__space = Array(maxWidth - key.length)
-                .fill(null)
-                .map(() => ' ')
-                .join('')
-        })
-
-        this.formatters = this.config.formatters
-
-        if (typeof this.module === 'string') {
-            this.module = {
-                filename: this.module,
-            }
-        } else if (typeof this.module === 'object' && !this.module.filename && this.module.url) {
-            this.module = {
-                filename: fileURLToPath(this.module.url),
-            }
-        }
-
-        if (!this.module.path) this.module.path = path.dirname(this.module.filename)
-    }
-
-    initFileInfo() {
-        this.filename = this.module.filename
-
-        const packageInfo = findPackage(this.module.path, true)
-
-        if (!packageInfo) return
-
-        this.packageName = packageInfo.name
-        this.packagePath = path.dirname(packageInfo.paths.absolute)
-
-        this.segments = this.filename
-            .replace(this.packagePath, '')
-            .replace(/^\//, '')
-            .split(path.sep)
-
-        this.segments.unshift(this.packageName)
-    }
-
-    static config = defaultConfig
-
-    static setConfig(newConfig) {
-        this.config = merge.recursive({}, this.config, newConfig)
-    }
-}
-
-module.exports = NLoggerConfig

package/lib/constants.js

@@ -1,7 +0,0 @@
-exports.GROUP_TIME = {
-    MINUTE: 'minute',
-    HOUR: 'hour',
-    DAY: 'day',
-}
-
-exports.TIME_LABELS_MAP = Symbol('TIME LABELS MAP')

package/lib/defaultConfig.js

@@ -1,57 +0,0 @@
-const stringFormatter = require('./stringFormatter')
-const timeFormatter = require('./timeFormatter')
-const { GROUP_TIME } = require('./constants')
-
-module.exports = {
-    time: ['gray', 'bgBlack'],
-    label: ['white', 'bold'],
-    segments: {
-        first: ['yellow', 'italic', 'dim'],
-        last: ['cyan', 'italic'],
-        all: ['gray', 'italic'],
-        delimiter: ['gray'],
-    },
-    formatters: {
-        string: stringFormatter,
-        time: timeFormatter,
-    },
-    enableFileLink: true,
-    groupedEveryTime: GROUP_TIME.HOUR, // minute, hour, day, null
-    methods: {
-        log: {
-            show: true,
-        },
-        info: {
-            show: true,
-            label: ['green'],
-        },
-        debug: {
-            label: ['magenta'],
-            show: process.env.NODE_ENV != 'production',
-        },
-        warn: {
-            show: process.env.NODE_ENV != 'production',
-            label: ['yellow'],
-        },
-        error: {
-            label: ['red'],
-            show: true,
-        },
-        time: {
-            show: true,
-            showStartTimer: false,
-            warningMissingLabel: true,
-            warningPresentLabel: true,
-            changePresentLabel: false,
-            diffTimeColor: ['yellow'],
-            label: ['black', 'bgYellow'],
-        },
-        dir: {
-            show: process.env.NODE_ENV != 'production',
-            depth: 3,
-        },
-        table: {
-            show: process.env.NODE_ENV != 'production',
-        },
-    },
-}

package/lib/logger.js

@@ -1,134 +0,0 @@
-const prettyTime = require('pretty-time')
-const merge = require('merge')
-const NLoggerCore = require('./loggerCore')
-const { TIME_LABELS_MAP } = require('./constants')
-
-class NLogger extends NLoggerCore {
-    constructor(mod, config) {
-        super(mod, config)
-
-        this[TIME_LABELS_MAP] = new Map()
-        ;[
-            'log',
-            'info',
-            'debug',
-            'warn',
-            'error',
-            'time',
-            'timeLog',
-            'timeEnd',
-            'dir',
-            'table',
-        ].forEach(m => {
-            this[m] = this[m].bind(this)
-        })
-    }
-
-    log(...args) {
-        this.logFromMethod('log', 'log', args)
-    }
-
-    info(...args) {
-        this.logFromMethod('info', 'info', args)
-    }
-
-    debug(...args) {
-        this.logFromMethod('log', 'debug', args)
-    }
-
-    warn(...args) {
-        this.logFromMethod('error', 'warn', args)
-    }
-
-    error(...args) {
-        this.logFromMethod('error', 'error', args)
-    }
-
-    time(label) {
-        const {
-            show,
-            showStartTimer,
-            warningPresentLabel,
-            changePresentLabel,
-            label: styleLabel,
-        } = this.getMethod('time')
-        if (!show) return
-        if (this[TIME_LABELS_MAP].has(label)) {
-            if (warningPresentLabel)
-                this.warn(`Timer: Label ${label} already exists for logger.time()`)
-            if (!changePresentLabel) return
-        }
-
-        if (showStartTimer)
-            console.log(
-                ' ',
-                this.createTime('time'),
-                this.createSegments('time'),
-                this.formatStr('timeStart:', styleLabel),
-                label,
-            )
-
-        this[TIME_LABELS_MAP].set(label, Date.now())
-
-        const timeEnd = () => this.timeEnd(label)
-        timeEnd.log = () => this.timeLog(label)
-
-        return timeEnd
-    }
-
-    __timeLog(label, txt) {
-        const { show, warningMissingLabel, diffTimeColor, label: styleLabel } = this.getMethod(
-            'time',
-        )
-        if (!show) return
-        if (!this[TIME_LABELS_MAP].has(label)) {
-            if (warningMissingLabel)
-                this.warn(`Timer: No such label ${label} for logger.${`${txt}`.trim()}()`)
-            return
-        }
-
-        const time = Date.now() - this[TIME_LABELS_MAP].get(label)
-
-        console.log(
-            ' ',
-            this.createTime('time'),
-            this.createSegments('time'),
-            this.formatStr(txt, styleLabel),
-            `${label}:: `,
-            this.formatStr(prettyTime(1000000 * time, 'ms'), diffTimeColor),
-        )
-
-        return true
-    }
-
-    timeLog(label) {
-        this.__timeLog(label, ' timeLog: ')
-    }
-
-    timeEnd(label) {
-        const res = this.__timeLog(label, ' timeEnd: ')
-        if (res) this[TIME_LABELS_MAP].delete(label)
-    }
-
-    dir(obj, params) {
-        const { show, depth } = this.getMethod('dir')
-        if (!show) return
-        console.group(...this.createStr('dir'))
-        console.dir(obj, merge({}, { depth }, params || {}))
-        console.groupEnd()
-    }
-
-    table(arr) {
-        const { show } = this.getMethod('table')
-        if (!show) return
-        console.group(...this.createStr('table'))
-        console.table(arr)
-        console.groupEnd()
-    }
-
-    clear() {
-        console.clear()
-    }
-}
-
-module.exports = NLogger