@jeffchi/logger 1.0.3 → 1.0.5

package/lib/cache.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="lodash" />
+export interface LogContent {
+    prefix?: string[];
+    data: any[];
+    timestamp: number;
+}
+/** 单例模式的缓存对像 */
+export declare class LogCache {
+    #private;
+    lastWrite: number;
+    static get cache(): LogCache;
+    get defaultLogFile(): string;
+    private constructor();
+    push(data: LogContent, file?: string): void;
+    /** 立即写入并清空缓存 */
+    flush(file?: string): void;
+    /** 延迟写入并清空缓存 */
+    write: import("lodash").DebouncedFunc<(file: any) => void>;
+}

package/lib/cache.js

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogCache = void 0;
+const checkPlateform_1 = require("./utils/checkPlateform");
+const date_fns_1 = require("date-fns");
+const lodash_1 = require("lodash");
+const path_1 = __importDefault(require("path"));
+const noop_1 = __importDefault(require("./utils/noop"));
+const type_1 = require("./utils/type");
+/** 单例模式的缓存对像 */
+class LogCache {
+    static #cache = new LogCache();
+    lastWrite = Date.now();
+    #map;
+    #fs;
+    static get cache() {
+        return LogCache.#cache;
+    }
+    get defaultLogFile() {
+        return `logs/${(0, date_fns_1.format)(Date.now(), 'yyyy-MM-dd')}.log`;
+    }
+    constructor() {
+        this.#map = new Map();
+        (0, checkPlateform_1.checkPlatform)().then((fs) => {
+            this.#fs = fs;
+        });
+    }
+    push(data, file) {
+        file = file || this.defaultLogFile;
+        let set = this.#map.get(file);
+        if (!set) {
+            set = new Set();
+            this.#map.set(file, set);
+        }
+        const now = Date.now();
+        if (set.add(data).size > 1000 || now - this.lastWrite > 30000) {
+            this.flush(file);
+        }
+        else {
+            this.write(file);
+        }
+    }
+    /** 立即写入并清空缓存 */
+    flush(file) {
+        if (!this.#fs)
+            return;
+        this.#map.forEach((set, key) => {
+            if (!set)
+                return;
+            if ((file === null && key === this.defaultLogFile) || !file || key === file) {
+                const list = Array.from(set);
+                set.clear();
+                this.#writeLogFile(key, list);
+                this.lastWrite = Date.now();
+            }
+        });
+    }
+    /** 延迟写入并清空缓存 */
+    write = (0, lodash_1.debounce)((file) => this.flush(file), 1000);
+    /** 检查日志文件的路径,如果目录不存在,则创建,最好返回有效的日志文件,如果文件已存在,则追加日志数据 */
+    #checkFolder(output) {
+        const paths = path_1.default.dirname(output || this.defaultLogFile);
+        const { existsSync, mkdirSync } = this.#fs || {};
+        if (!existsSync?.(paths)) {
+            mkdirSync?.(paths);
+        }
+    }
+    #writeLogFile(outputFile, content) {
+        if (!(0, type_1.isArray)(content)) {
+            content = [content];
+        }
+        outputFile = outputFile || this.defaultLogFile;
+        this.#checkFolder(outputFile);
+        const { writeFile } = this.#fs || {};
+        if (outputFile && writeFile) {
+            const list = content.reduce((o, { prefix = [], data }) => [...o, [...prefix, ...data.map(JSON.stringify), '\n'].join(' ')], []);
+            writeFile?.(outputFile, list.join(''), { flag: 'a' }, noop_1.default);
+        }
+    }
+}
+exports.LogCache = LogCache;

package/lib/index.js

@@ -1,48 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loggerWithTags = void 0;
+const cache_1 = require("./cache");
 const defOptions_1 = require("./consts/defOptions");
 const interface_1 = require("./interface");
 const buildLogPreffix_1 = require("./utils/buildLogPreffix");
 const checkLogMode_1 = require("./utils/checkLogMode");
-const checkPlateform_1 = require("./utils/checkPlateform");
 const type_1 = require("./utils/type");
-const writeFile_1 = require("./utils/writeFile");
 const loggerWithTags = (tags, options) => {
     if (!(0, type_1.isArray)(tags)) {
         tags = [tags];
     }
-    const { env, ...mergedOptions } = { ...defOptions_1.defOptions, ...(options || {}) };
+    const { env, outputFile, ...mergedOptions } = { ...defOptions_1.defOptions, ...(options || {}) };
     const debug = (...rest) => {
         const prefix = (0, buildLogPreffix_1.buildLogPreffix)(tags, { level: interface_1.LogLevel.DEBUG, ...mergedOptions });
-        const content = [...prefix, ...rest];
-        (0, checkLogMode_1.checkLogMode)(env || interface_1.LogMode.ALL) && console.debug(...content);
-        (0, checkPlateform_1.checkPlatform)().then((writer) => (0, writeFile_1.writeLogFile)(writer, content));
+        (0, checkLogMode_1.checkLogMode)(env || interface_1.LogMode.ALL) && console.debug([...prefix, ...rest]);
+        cache_1.LogCache.cache.push({ prefix, timestamp: Date.now(), data: [...rest] }, outputFile);
     };
     const info = (...rest) => {
         const prefix = (0, buildLogPreffix_1.buildLogPreffix)(tags, { level: interface_1.LogLevel.INFO, ...mergedOptions });
-        const content = [...prefix, ...rest];
-        (0, checkLogMode_1.checkLogMode)(env || interface_1.LogMode.ALL) && console.info(...content);
-        (0, checkPlateform_1.checkPlatform)().then((writer) => (0, writeFile_1.writeLogFile)(writer, content));
+        (0, checkLogMode_1.checkLogMode)(env || interface_1.LogMode.ALL) && console.info([...prefix, ...rest]);
+        cache_1.LogCache.cache.push({ prefix, timestamp: Date.now(), data: [...rest] }, outputFile);
     };
     const log = (...rest) => {
         const prefix = (0, buildLogPreffix_1.buildLogPreffix)(tags, mergedOptions);
-        const content = [...prefix, ...rest];
-        (0, checkLogMode_1.checkLogMode)(env || interface_1.LogMode.ALL) && console.log(...content);
-        (0, checkPlateform_1.checkPlatform)().then((writer) => (0, writeFile_1.writeLogFile)(writer, content));
+        (0, checkLogMode_1.checkLogMode)(env || interface_1.LogMode.ALL) && console.log([...prefix, ...rest]);
+        cache_1.LogCache.cache.push({ prefix, timestamp: Date.now(), data: [...rest] }, outputFile);
     };
     const warn = (...rest) => {
         const prefix = (0, buildLogPreffix_1.buildLogPreffix)(tags, { level: interface_1.LogLevel.WARN, ...mergedOptions });
-        const content = [...prefix, ...rest];
-        (0, checkLogMode_1.checkLogMode)(env || interface_1.LogMode.ALL) && console.warn(...content);
-        (0, checkPlateform_1.checkPlatform)().then((writer) => (0, writeFile_1.writeLogFile)(writer, content));
+        const { disableError } = mergedOptions;
+        const out = disableError ? console.debug : console.warn;
+        (0, checkLogMode_1.checkLogMode)(env || interface_1.LogMode.ALL) && out([...prefix, ...rest]);
+        cache_1.LogCache.cache.push({ prefix, timestamp: Date.now(), data: [...rest] }, outputFile);
     };
     const error = (msg, cause) => {
         const prefix = (0, buildLogPreffix_1.buildLogPreffix)(tags, { level: interface_1.LogLevel.ERROR, ...mergedOptions });
-        const content = [...prefix, msg];
-        (0, checkLogMode_1.checkLogMode)(env || interface_1.LogMode.ALL) && console.error(...content);
-        (0, checkPlateform_1.checkPlatform)().then((writer) => (0, writeFile_1.writeLogFile)(writer, content));
-        throw new Error(msg, { cause });
+        const { ignoreThrow, disableError } = mergedOptions;
+        const out = disableError ? console.debug : console.error;
+        (0, checkLogMode_1.checkLogMode)(env || interface_1.LogMode.ALL) && out([...prefix, msg]);
+        cache_1.LogCache.cache.push({ prefix, timestamp: Date.now(), data: [msg] }, outputFile);
+        if (!ignoreThrow) {
+            throw new Error(msg, { cause });
+        }
     };
     return { debug, info, log, warn, error };
 };

package/lib/interface.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+export type PathLike = string | Buffer | URL;
 /**
  * 日志输出打印的模式
  * @default LogMode.ALL
@@ -29,7 +31,7 @@ export interface ILogOptions {
      * 是否支持输出时间戳及时间戳格式
      *
      * 字符串格式参见: https://github.com/date-fns/date-fns/blob/main/src/format/index.ts
-     * @default true - 'MMM dd, yyyy HH:mm:ss.SSS'
+     * @default true 开启后默认IOS格式 'yyyy-MM-ddTHH:mm:ss.SSSZ'
      */
     date?: boolean | string;
     /**
@@ -37,8 +39,40 @@ export interface ILogOptions {
      * @default 'all'
      */
     env?: LogMode;
+    /** 禁用warn输出,避免在测试场景下影响测试结果
+     * @default false
+     */
+    disableWarn?: boolean;
+    /** 禁用error输出,避免在测试场景下打断正常测试流程
+     * @default false
+     */
+    disableError?: boolean;
+    /** 调用error输出错误信息后,禁止继续抛出异常错误
+     * @description
+     * 调用error输出错误信息后,默认继续抛出异常错误,在测试环境下可以临地禁用,避免影响正常的测试流程
+     */
+    ignoreThrow?: boolean;
+    /**
+     * 基于当前工程根目录下的日志输出文件
+     *
+     * @description
+     * 浏览器环境:自动忽略该选项;
+     *
+     * node环境下默认 logs/xxx.log
+     */
+    outputFile?: string;
+}
+export interface IFileHelper {
+    existsSync?: (path: PathLike) => boolean;
+    mkdirSync?: (path: PathLike, options?: {
+        mode?: number | string | undefined;
+        recursive: true;
+    }) => string | undefined;
+    writeFile?: CallableFunction;
+    join?: (...paths: string[]) => string;
+    sep?: '\\' | '/';
+    resolve?: (...paths: string[]) => string;
 }
-export type LogContent = any[];
 export interface ILogger {
     debug: (...rest: any[]) => void;
     info: (...rest: any[]) => void;

package/lib/utils/buildLogPreffix.js

@@ -6,17 +6,22 @@ const interface_1 = require("../interface");
 const type_1 = require("./type");
 const buildLogPreffix = (tags, options) => {
     const { level = interface_1.LogLevel.LOG, date } = options;
-    const prefix = [level.toString()];
+    const prefix = [];
     if (tags.length) {
         prefix.unshift(tags.map((t) => `[${t.toUpperCase()}]`).join(' '));
     }
     if (date) {
-        let now = new Date();
+        const now = new Date();
+        let dtStr;
         if ((0, type_1.isString)(date)) {
-            now = (0, date_fns_1.format)(now, date);
+            dtStr = (0, date_fns_1.format)(now, date);
         }
-        prefix.unshift(now);
+        else {
+            dtStr = new Date(now).toISOString();
+        }
+        prefix.unshift(dtStr);
     }
+    prefix.unshift(`[${level}]\t`);
     return prefix;
 };
 exports.buildLogPreffix = buildLogPreffix;

package/lib/utils/checkPlateform.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="node" />
+import { IFileHelper } from '../interface';
 /**
  * 检查当前运行环境,node环境下返回node的fs模块,浏览器环境返回null
  * @returns fs
  */
-export declare const checkPlatform: () => Promise<typeof import("fs").writeFile | null>;
+export declare const checkPlatform: () => Promise<IFileHelper | null>;

package/lib/utils/checkPlateform.js

@@ -28,13 +28,19 @@ exports.checkPlatform = void 0;
  * 检查当前运行环境,node环境下返回node的fs模块,浏览器环境返回null
  * @returns fs
  */
-const checkPlatform = () => Promise.resolve().then(() => __importStar(require('fs'))).then((fs) => {
+const checkPlatform = () => Promise.all([Promise.resolve().then(() => __importStar(require('fs'))), Promise.resolve().then(() => __importStar(require('path')))]).then(([fs, path]) => {
     // 如果fs为空则判定当前为浏览器环境
     if (!fs)
         return null;
-    if (!fs.existsSync('logs')) {
-        fs.mkdirSync('logs');
-    }
-    return fs?.writeFile;
+    const { existsSync, mkdirSync, writeFile } = fs;
+    const { sep, resolve, join } = path;
+    return {
+        existsSync,
+        mkdirSync,
+        writeFile,
+        join,
+        sep,
+        resolve,
+    };
 });
 exports.checkPlatform = checkPlatform;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeffchi/logger",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "main": "dist/index.js",
   "types": "lib/index.d.ts",
   "description": "A log print output javascript tool library that can be used at the front and back ends",
@@ -39,12 +39,17 @@
     "lib/**/*"
   ],
   "peerDependencies": {
-    "date-fns": "^2.29.3"
+    "date-fns": "^2.29.3",
+    "@types/lodash": "^4.14.191",
+    "@types/node": "^18.11.18",
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@types/jest": "^29.2.5",
+    "@types/lodash": "^4.14.191",
     "@types/node": "^18.11.18",
     "jest": "^29.3.1",
+    "lodash": "^4.17.21",
     "prettier": "^2.8.2",
     "ts-jest": "^29.0.5",
     "tslint": "^6.1.3",