@rife/logger 0.0.5-beta.1

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+import winston from 'winston';
+import 'winston-daily-rotate-file';
+export { winston };
+export declare const getNewTraceId: (size?: number | undefined) => string;
+export declare function runInTrace<T>(fn: (...args: any[]) => T): T;
+export declare function getTraceId(): any;
+export declare namespace Rife {
+    namespace Logger {
+        interface Options {
+            /**
+             * 输出日志到console
+             * 默认：development环境下输出，production环境下不输出
+             */
+            writeToConsole?: boolean;
+            /**
+             * 输出日志到文件
+             * 默认：development环境下输出，production环境下不输出
+             */
+            writeToFile?: boolean;
+            /**
+             * 输出日志的文件目录
+             * 默认：./logs/
+             */
+            dirname?: string;
+            /**
+             * 输出日志的文件名
+             * 默认：server
+             */
+            filename?: string;
+            /**
+             * 日志输出格式
+             */
+            format?: {
+                /**
+                 * 显示时间
+                 * 默认：true
+                 */
+                time?: boolean;
+                /**
+                 * 显示traceId
+                 * 默认：true
+                 */
+                traceId?: boolean;
+            };
+        }
+    }
+    interface Logger {
+        info: winston.LeveledLogMethod;
+        warn: winston.LeveledLogMethod;
+        error: winston.LeveledLogMethod;
+    }
+}
+export declare function createLogger(options?: Rife.Logger.Options): {
+    logger: Rife.Logger;
+    instance: winston.Logger;
+};

package/dist/index.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLogger = exports.getTraceId = exports.runInTrace = exports.getNewTraceId = exports.winston = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const async_hooks_1 = require("async_hooks");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const nanoid_1 = require("nanoid");
+const winston_1 = tslib_1.__importDefault(require("winston"));
+exports.winston = winston_1.default;
+const safe_stable_stringify_1 = tslib_1.__importDefault(require("safe-stable-stringify"));
+require("winston-daily-rotate-file");
+const als = new async_hooks_1.AsyncLocalStorage();
+const isDev = () => process.env.NODE_ENV === 'development';
+const isProd = () => !isDev();
+// https://github.com/CyberAP/nanoid-dictionary/blob/master/src/nolookalikes.js
+exports.getNewTraceId = (0, nanoid_1.customAlphabet)('346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz', 5);
+function runInTrace(fn) {
+    return als.run({ traceId: (0, exports.getNewTraceId)() }, fn);
+}
+exports.runInTrace = runInTrace;
+function getTraceId() {
+    return als.getStore()?.traceId;
+}
+exports.getTraceId = getTraceId;
+const levelColor = {
+    info: chalk_1.default.green,
+    error: chalk_1.default.redBright,
+    warn: chalk_1.default.yellow,
+};
+const levelSymbolMap = {
+    info: 'INF',
+    warn: 'WRN',
+    error: 'ERR',
+};
+// 设置traceId
+// https://www.npmjs.com/package/cls-rtracer
+const tracerFormat = (options) => winston_1.default.format.printf(info => {
+    let traceId = getTraceId();
+    const color = (message, chalk) => (options.writeToFile ? message : chalk(message));
+    const levelit = (text) => {
+        switch (info.level) {
+            case 'info': {
+                return color(text, levelColor.info);
+            }
+            case 'warn': {
+                return color(text, levelColor.warn);
+            }
+            case 'error': {
+                return color(text, levelColor.error);
+            }
+        }
+        return text;
+    };
+    const levelSymbol = levelSymbolMap[info.level];
+    const level = levelSymbol ? levelit(` [${levelSymbol}]`) : '';
+    const service = info.metadata.service ? levelit(` [${info.metadata.service}]`) : '';
+    const timestamp = options.format.time ? color(info.timestamp, chalk_1.default.gray) : '';
+    const trace = traceId ? color(` [${traceId}]`, chalk_1.default.gray) : '';
+    let message = info.message || '';
+    if (typeof info?.message !== 'string') {
+        try {
+            if (isDev()) {
+                message = '\n' + (0, safe_stable_stringify_1.default)(info?.message, undefined, 4);
+            }
+            else {
+                message = (0, safe_stable_stringify_1.default)(info?.message, undefined, 0);
+            }
+        }
+        catch (e) {
+            message = 'fail to stringify json';
+        }
+    }
+    message = ' ' + message;
+    const stack = info.metadata.stack ? color('\n' + info.metadata.stack + '\n', chalk_1.default.gray) : '';
+    return `${timestamp}${trace}${level}${service}${message}${stack}`;
+});
+function createLogger(options) {
+    let transports = [];
+    let config = {
+        writeToConsole: options?.writeToConsole ?? isDev(),
+        writeToFile: options?.writeToFile ?? isProd(),
+        dirname: options?.dirname || path_1.default.join(process.cwd(), './logs/'),
+        filename: options?.filename || 'server',
+        format: {
+            time: options?.format?.time ?? true,
+        },
+    };
+    if (config.writeToFile) {
+        transports.push(new winston_1.default.transports.DailyRotateFile({
+            // https://www.npmjs.com/package/winston-daily-rotate-file
+            filename: config.filename,
+            dirname: config.dirname,
+            datePattern: 'YYYY-MM-DD',
+            maxFiles: '30d',
+            extension: '.log',
+        }));
+    }
+    if (config.writeToConsole) {
+        transports.push(new winston_1.default.transports.Console());
+    }
+    const { combine, timestamp, colorize, errors, metadata, splat, json } = winston_1.default.format;
+    const timeFormat = isProd() ? 'YYYY-MM-DD HH:mm:ss.SSS' : 'HH:mm:ss.SSS';
+    let format = [
+        errors({ stack: true }),
+        metadata(),
+        timestamp({ format: timeFormat }),
+        splat(),
+        tracerFormat(config),
+    ];
+    if (!config.writeToFile) {
+        format.push(colorize());
+    }
+    const instance = winston_1.default.createLogger({
+        format: combine(...format),
+        transports,
+    });
+    const logger = {
+        info: instance.info.bind(instance),
+        warn: instance.warn.bind(instance),
+        error: instance.error.bind(instance),
+    };
+    return { logger, instance };
+}
+exports.createLogger = createLogger;

package/dist/test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+process.env.NODE_ENV = 'development';
+// process.env.NODE_ENV = 'production';
+const _1 = require(".");
+const { logger } = (0, _1.createLogger)({ writeToFile: false, writeToConsole: true, format: { time: false } });
+const deep = { a: { b: { c: { g: { e: { f: 1 } } } } } };
+logger.info('1 %s', { a: 1 });
+logger.info('2 %j', deep);
+logger.info('3 \n%j', deep);
+logger.info('4 %s %s', 1, 2);
+logger.info('5 %o', deep);
+logger.info(deep);
+logger.warn('execed');
+logger.error(new Error('not found'));
+// import { format } from 'logform';
+// const jsonFormat = format.json({ space: 2 });
+// const info = jsonFormat.transform({
+//     level: 'info',
+//     message: 'my message',
+// });
+// console.log(info);

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@rife/logger",
+  "version": "0.0.5-beta.1",
+  "description": "",
+  "main": "./dist/index.js",
+  "types": "./src/index.ts",
+  "files": [
+    "dist/**/*",
+    "src/**/*",
+    "tsconfig.json"
+  ],
+  "dependencies": {
+    "chalk": "4",
+    "nanoid": "^3.1.30",
+    "winston": "^3.3.3",
+    "winston-daily-rotate-file": "^4.5.5",
+    "@rife/config": "0.0.5-beta.1"
+  },
+  "scripts": {
+    "dev": "infra dev",
+    "build": "infra build",
+    "prepublish": "infra build"
+  }
+}

package/src/index.ts

@@ -0,0 +1,187 @@
+import path from 'path';
+import { AsyncLocalStorage } from 'async_hooks';
+
+import chalk from 'chalk';
+import { customAlphabet } from 'nanoid';
+import winston from 'winston';
+import JSONStringify from 'safe-stable-stringify';
+import 'winston-daily-rotate-file';
+
+export { winston };
+
+const als = new AsyncLocalStorage<{ traceId: string } & any>();
+
+const isDev = () => process.env.NODE_ENV === 'development';
+const isProd = () => !isDev();
+
+// https://github.com/CyberAP/nanoid-dictionary/blob/master/src/nolookalikes.js
+export const getNewTraceId = customAlphabet('346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz', 5);
+
+export function runInTrace<T>(fn: (...args: any[]) => T): T {
+    return als.run({ traceId: getNewTraceId() }, fn);
+}
+
+export function getTraceId() {
+    return als.getStore()?.traceId;
+}
+
+const levelColor = {
+    info: chalk.green,
+    error: chalk.redBright,
+    warn: chalk.yellow,
+};
+
+const levelSymbolMap = {
+    info: 'INF',
+    warn: 'WRN',
+    error: 'ERR',
+};
+
+// 设置traceId
+// https://www.npmjs.com/package/cls-rtracer
+const tracerFormat = (options: { writeToFile: boolean; format: { time: boolean } }) =>
+    winston.format.printf(info => {
+        let traceId = getTraceId();
+        const color = (message: string, chalk: chalk.Chalk) => (options.writeToFile ? message : chalk(message));
+        const levelit = (text: string) => {
+            switch (info.level) {
+                case 'info': {
+                    return color(text, levelColor.info);
+                }
+                case 'warn': {
+                    return color(text, levelColor.warn);
+                }
+                case 'error': {
+                    return color(text, levelColor.error);
+                }
+            }
+            return text;
+        };
+        const levelSymbol = levelSymbolMap[info.level as keyof typeof levelSymbolMap];
+        const level = levelSymbol ? levelit(` [${levelSymbol}]`) : '';
+        const service = info.metadata.service ? levelit(` [${info.metadata.service}]`) : '';
+        const timestamp = options.format.time ? color(info.timestamp, chalk.gray) : '';
+        const trace = traceId ? color(` [${traceId}]`, chalk.gray) : '';
+        let message = info.message || '';
+        if (typeof info?.message !== 'string') {
+            try {
+                if (isDev()) {
+                    message = '\n' + JSONStringify(info?.message, undefined, 4);
+                } else {
+                    message = JSONStringify(info?.message, undefined, 0);
+                }
+            } catch (e) {
+                message = 'fail to stringify json';
+            }
+        }
+        message = ' ' + message;
+        const stack = info.metadata.stack ? color('\n' + info.metadata.stack + '\n', chalk.gray) : '';
+        return `${timestamp}${trace}${level}${service}${message}${stack}`;
+    });
+
+export namespace Rife {
+    export namespace Logger {
+        export interface Options {
+            /**
+             * 输出日志到console
+             * 默认：development环境下输出，production环境下不输出
+             */
+            writeToConsole?: boolean;
+
+            /**
+             * 输出日志到文件
+             * 默认：development环境下输出，production环境下不输出
+             */
+            writeToFile?: boolean;
+
+            /**
+             * 输出日志的文件目录
+             * 默认：./logs/
+             */
+            dirname?: string;
+
+            /**
+             * 输出日志的文件名
+             * 默认：server
+             */
+            filename?: string;
+
+            /**
+             * 日志输出格式
+             */
+            format?: {
+                /**
+                 * 显示时间
+                 * 默认：true
+                 */
+                time?: boolean;
+
+                /**
+                 * 显示traceId
+                 * 默认：true
+                 */
+                traceId?: boolean;
+            };
+        }
+    }
+
+    export interface Logger {
+        info: winston.LeveledLogMethod;
+        warn: winston.LeveledLogMethod;
+        error: winston.LeveledLogMethod;
+    }
+}
+
+export function createLogger(options?: Rife.Logger.Options) {
+    let transports: winston.transport[] = [];
+    let config = {
+        writeToConsole: options?.writeToConsole ?? isDev(),
+        writeToFile: options?.writeToFile ?? isProd(),
+        dirname: options?.dirname || path.join(process.cwd(), './logs/'),
+        filename: options?.filename || 'server',
+        format: {
+            time: options?.format?.time ?? true,
+        },
+    };
+    if (config.writeToFile) {
+        transports.push(
+            new winston.transports.DailyRotateFile({
+                // https://www.npmjs.com/package/winston-daily-rotate-file
+                filename: config.filename,
+                dirname: config.dirname,
+                datePattern: 'YYYY-MM-DD',
+                maxFiles: '30d',
+                extension: '.log',
+            }),
+        );
+    }
+
+    if (config.writeToConsole) {
+        transports.push(new winston.transports.Console());
+    }
+
+    const { combine, timestamp, colorize, errors, metadata, splat, json } = winston.format;
+    const timeFormat = isProd() ? 'YYYY-MM-DD HH:mm:ss.SSS' : 'HH:mm:ss.SSS';
+    let format: winston.Logform.Format[] = [
+        errors({ stack: true }),
+        metadata(),
+        timestamp({ format: timeFormat }),
+        splat(), // https://github.com/winstonjs/logform/blob/master/splat.js
+        tracerFormat(config),
+    ];
+    if (!config.writeToFile) {
+        format.push(colorize());
+    }
+    const instance = winston.createLogger({
+        format: combine(...format),
+        transports,
+    });
+
+    const logger: Rife.Logger = {
+        info: instance.info.bind(instance),
+        warn: instance.warn.bind(instance),
+        error: instance.error.bind(instance),
+    };
+
+    return { logger, instance };
+}

package/src/test.ts

@@ -0,0 +1,25 @@
+process.env.NODE_ENV = 'development';
+// process.env.NODE_ENV = 'production';
+
+import { createLogger } from '.';
+
+const { logger } = createLogger({ writeToFile: false, writeToConsole: true, format: { time: false } });
+
+const deep = { a: { b: { c: { g: { e: { f: 1 } } } } } };
+logger.info('1 %s', { a: 1 });
+logger.info('2 %j', deep);
+logger.info('3 \n%j', deep);
+logger.info('4 %s %s', 1, 2);
+logger.info('5 %o', deep);
+logger.info(deep);
+logger.warn('execed');
+logger.error(new Error('not found'));
+
+// import { format } from 'logform';
+
+// const jsonFormat = format.json({ space: 2 });
+// const info = jsonFormat.transform({
+//     level: 'info',
+//     message: 'my message',
+// });
+// console.log(info);

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+    "extends": "@rife/config/tsconfig.json", // 继承 packages 目录下通用配置
+    "compilerOptions": {
+        "outDir": "dist",
+        "declaration": true,
+        "baseUrl": ".",
+        "paths": {
+            "@/*": ["./src/*"]
+        }
+    },
+    "include": ["./src/**/*"]
+}