mm_logger 0.0.0-stage → 1.0.0

package/package.json

@@ -1,6 +1,57 @@
 {
   "name": "mm_logger",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "高性能 Node.js 日志模块，支持多级别日志、文件轮转、事件钩子和灵活配置。",
+  "main": "index.js",
+  "scripts": {
+    "test": "node test.js",
+    "test:unit": "jest --coverage"
+  },
+  "keywords": [
+    "mm_mod",
+    "mm_infra",
+    "mm_observability",
+    "log",
+    "logger",
+    "logging",
+    "file",
+    "rotation",
+    "nodejs",
+    "javascript",
+    "module",
+    "enterprise",
+    "tracing",
+    "masking",
+    "security",
+    "performance"
+  ],
+  "layer": "infra",
+  "group": "observability",
+  "author": {
+    "name": "qww",
+    "email": "qiwenwu@elins.cn",
+    "url": "http://qww.elins.cn"
+  },
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/qiwenwu/mm_logger.git"
+  },
+  "bugs": {
+    "url": "https://github.com/qiwenwu/mm_logger/issues"
+  },
+  "homepage": "https://github.com/qiwenwu/mm_logger#readme",
+  "dependencies": {
+    "log4js": "^6.9.1",
+    "mm_helper": "^1.0.0"
+  },
+  "devDependencies": {
+    "jest": "^30.5.2"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "directories": {
+    "lib": "."
+  }
+}

package/test/colors.test.js

@@ -0,0 +1,265 @@
+'use strict';
+
+const os = require('os');
+
+const ENV_KEYS = [
+  'NO_COLOR',
+  'FORCE_COLOR',
+  'CI',
+  'TERM',
+  'WT_SESSION',
+  'ConEmuANSI',
+  'ANSICON',
+  'TERM_PROGRAM',
+  'GITHUB_ACTIONS',
+  'GITLAB_CI',
+  'CIRCLECI',
+  'TRAVIS',
+  'BUILDKITE'
+];
+
+let saved_platform;
+let saved_tty;
+
+/**
+ * 清理与颜色相关的环境变量
+ */
+function clearEnv() {
+  ENV_KEYS.forEach((key) => {
+    delete process.env[key];
+  });
+}
+
+/**
+ * 重载 colors 模块以重置内部缓存
+ * @returns {Object} colors 模块对象
+ */
+function loadColors() {
+  jest.resetModules();
+  return require('../lib/colors');
+}
+
+/**
+ * 创建输出流桩
+ * @param {boolean} is_tty 是否为 TTY
+ * @returns {Object} 流桩对象
+ */
+function createStream(is_tty) {
+  return { isTTY: is_tty };
+}
+
+/**
+ * 设置 process.platform
+ * @param {string} platform 平台名称
+ */
+function setPlatform(platform) {
+  Object.defineProperty(process, 'platform', { value: platform, configurable: true });
+}
+
+/**
+ * 设置 process.stdout.isTTY，避免模块加载时触发平台探测
+ * @param {boolean} is_tty 是否为 TTY
+ */
+function setStreamTty(is_tty) {
+  Object.defineProperty(process.stdout, 'isTTY', { value: is_tty, configurable: true });
+}
+
+beforeEach(() => {
+  saved_platform = process.platform;
+  saved_tty = process.stdout.isTTY;
+  clearEnv();
+  setStreamTty(false);
+});
+
+afterEach(() => {
+  clearEnv();
+  setPlatform(saved_platform);
+  setStreamTty(saved_tty);
+  jest.restoreAllMocks();
+});
+
+describe('supportsColor', () => {
+  it('未传流时默认使用 process.stdout', () => {
+    const { supportsColor } = loadColors();
+    expect(typeof supportsColor()).toBe('boolean');
+  });
+
+  it('设置 NO_COLOR 时禁用颜色', () => {
+    process.env.NO_COLOR = '1';
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(true))).toBe(false);
+  });
+
+  it('NO_COLOR 为空字符串时也禁用颜色（回归）', () => {
+    process.env.NO_COLOR = '';
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(true))).toBe(false);
+  });
+
+  it('FORCE_COLOR 为真值时启用颜色', () => {
+    process.env.FORCE_COLOR = '1';
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(false))).toBe(true);
+  });
+
+  it('FORCE_COLOR=0 时禁用颜色', () => {
+    process.env.FORCE_COLOR = '0';
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(true))).toBe(false);
+  });
+
+  it('FORCE_COLOR=false 时禁用颜色', () => {
+    process.env.FORCE_COLOR = 'false';
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(true))).toBe(false);
+  });
+
+  it('FORCE_COLOR 为空字符串时继续检测', () => {
+    process.env.FORCE_COLOR = '';
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(false))).toBe(false);
+  });
+
+  it('非 TTY 流禁用颜色', () => {
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(false))).toBe(false);
+  });
+
+  it('TERM=dumb 时禁用颜色', () => {
+    process.env.TERM = 'dumb';
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(true))).toBe(false);
+  });
+
+  it('CI 环境无已知 CI 标识时禁用颜色', () => {
+    process.env.CI = '1';
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(true))).toBe(false);
+  });
+
+  it('CI 环境且有 GITHUB_ACTIONS 时启用颜色', () => {
+    process.env.CI = '1';
+    process.env.GITHUB_ACTIONS = '1';
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(true))).toBe(true);
+  });
+
+  it('Windows 平台下按终端能力判断', () => {
+    setPlatform('win32');
+    jest.spyOn(os, 'release').mockReturnValue('10.0.19045');
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(true))).toBe(true);
+  });
+
+  it('非 Windows 平台 TTY 即启用颜色', () => {
+    setPlatform('linux');
+    const { supportsColor } = loadColors();
+    expect(supportsColor(createStream(true))).toBe(true);
+  });
+});
+
+describe('windowsSupportsVT', () => {
+  it('WT_SESSION 存在时支持 VT', () => {
+    process.env.WT_SESSION = '1';
+    const { windowsSupportsVT } = loadColors();
+    expect(windowsSupportsVT()).toBe(true);
+  });
+
+  it('ConEmuANSI=ON 时支持 VT', () => {
+    process.env.ConEmuANSI = 'ON';
+    const { windowsSupportsVT } = loadColors();
+    expect(windowsSupportsVT()).toBe(true);
+  });
+
+  it('ANSICON 存在时支持 VT', () => {
+    process.env.ANSICON = '1';
+    const { windowsSupportsVT } = loadColors();
+    expect(windowsSupportsVT()).toBe(true);
+  });
+
+  it('TERM_PROGRAM=vscode 时支持 VT', () => {
+    process.env.TERM_PROGRAM = 'vscode';
+    const { windowsSupportsVT } = loadColors();
+    expect(windowsSupportsVT()).toBe(true);
+  });
+
+  it('系统版本足够新时支持 VT', () => {
+    jest.spyOn(os, 'release').mockReturnValue('10.0.19045');
+    const { windowsSupportsVT } = loadColors();
+    expect(windowsSupportsVT()).toBe(true);
+  });
+
+  it('主版本过低时不支持 VT', () => {
+    jest.spyOn(os, 'release').mockReturnValue('6.1.7601');
+    const { windowsSupportsVT } = loadColors();
+    expect(windowsSupportsVT()).toBe(false);
+  });
+
+  it('构建号过低时不支持 VT', () => {
+    jest.spyOn(os, 'release').mockReturnValue('10.0.10000');
+    const { windowsSupportsVT } = loadColors();
+    expect(windowsSupportsVT()).toBe(false);
+  });
+
+  it('版本号解析不出数字时不支持 VT', () => {
+    jest.spyOn(os, 'release').mockReturnValue('');
+    const { windowsSupportsVT } = loadColors();
+    expect(windowsSupportsVT()).toBe(false);
+  });
+
+  it('release 抛错时不支持 VT', () => {
+    jest.spyOn(os, 'release').mockImplementation(() => {
+      throw new Error('boom');
+    });
+    const { windowsSupportsVT } = loadColors();
+    expect(windowsSupportsVT()).toBe(false);
+  });
+
+  it('结果会被缓存', () => {
+    process.env.WT_SESSION = '1';
+    const { windowsSupportsVT } = loadColors();
+    expect(windowsSupportsVT()).toBe(true);
+    expect(windowsSupportsVT()).toBe(true);
+  });
+});
+
+describe('createColors', () => {
+  it('启用颜色时各着色器输出 ANSI 序列', () => {
+    const { createColors } = loadColors();
+    const c = createColors(true);
+
+    expect(c.enabled).toBe(true);
+    expect(c.blue('x')).toBe('\u001b[34mx\u001b[39m');
+    expect(c.ansi256(200)('x')).toBe('\u001b[38;5;200mx\u001b[39m');
+    expect(c.rgb(1, 2, 3)('x')).toBe('\u001b[38;2;1;2;3mx\u001b[39m');
+    expect(c.bgRgb(1, 2, 3)('x')).toBe('\u001b[48;2;1;2;3mx\u001b[49m');
+    expect(c.style('bold red')('x')).toBe('\u001b[1;31mx\u001b[39;22m');
+    expect(c.style(['bold', 'red'])('x')).toBe('\u001b[1;31mx\u001b[39;22m');
+    expect(c.style('bold nope')('x')).toBe('\u001b[1mx\u001b[22m');
+    expect(c.style('nope')('x')).toBe('x');
+  });
+
+  it('禁用颜色时各着色器原样返回', () => {
+    const { createColors } = loadColors();
+    const c = createColors(false);
+
+    expect(c.enabled).toBe(false);
+    expect(c.blue('x')).toBe('x');
+    expect(c.blue(123)).toBe('123');
+    expect(c.ansi256(200)('x')).toBe('x');
+    expect(c.rgb(1, 2, 3)('x')).toBe('x');
+    expect(c.bgRgb(1, 2, 3)('x')).toBe('x');
+    expect(c.style('bold red')('x')).toBe('x');
+  });
+
+  it('默认导出与 forStream 返回可用着色器', () => {
+    const colorsModule = loadColors();
+
+    expect(colorsModule.STYLES.reset).toEqual([0, 0]);
+    expect(colorsModule.colors.enabled).toBe(false);
+
+    const streamed = colorsModule.forStream(createStream(true));
+    expect(typeof streamed.red).toBe('function');
+    expect(streamed.red('x')).toContain('x');
+  });
+});

package/test/console_logger.test.js

@@ -0,0 +1,92 @@
+'use strict';
+
+const ConsoleLogger = require('../lib/console_logger');
+
+describe('ConsoleLogger', () => {
+  let spies;
+
+  beforeEach(() => {
+    spies = {
+      info: jest.spyOn(console, 'info').mockImplementation(() => {}),
+      debug: jest.spyOn(console, 'debug').mockImplementation(() => {}),
+      error: jest.spyOn(console, 'error').mockImplementation(() => {}),
+      log: jest.spyOn(console, 'log').mockImplementation(() => {}),
+      warn: jest.spyOn(console, 'warn').mockImplementation(() => {})
+    };
+  });
+
+  afterEach(() => {
+    Object.values(spies).forEach((spy) => spy.mockRestore());
+  });
+
+  it('info 输出到 console.info', () => {
+    const logger = new ConsoleLogger();
+    logger.info('hello', 1);
+    expect(spies.info).toHaveBeenCalledTimes(1);
+    expect(spies.info.mock.calls[0][0]).toContain('hello');
+    expect(spies.info.mock.calls[0][1]).toBe(1);
+  });
+
+  it('debug 输出到 console.debug', () => {
+    const logger = new ConsoleLogger();
+    logger.debug('hello');
+    expect(spies.debug).toHaveBeenCalledTimes(1);
+    expect(spies.debug.mock.calls[0][0]).toContain('hello');
+  });
+
+  it('error 输出到 console.error', () => {
+    const logger = new ConsoleLogger();
+    logger.error('hello');
+    expect(spies.error).toHaveBeenCalledTimes(1);
+    expect(spies.error.mock.calls[0][0]).toContain('hello');
+  });
+
+  it('success 输出到 console.log', () => {
+    const logger = new ConsoleLogger();
+    logger.success('hello');
+    expect(spies.log).toHaveBeenCalledTimes(1);
+    expect(spies.log.mock.calls[0][0]).toContain('hello');
+  });
+
+  it('warn 输出到 console.warn', () => {
+    const logger = new ConsoleLogger();
+    logger.warn('hello');
+    expect(spies.warn).toHaveBeenCalledTimes(1);
+    expect(spies.warn.mock.calls[0][0]).toContain('hello');
+  });
+
+  describe('着色器分流', () => {
+    it('error 与 warn 使用基于 stderr 的着色器，其余使用 stdout', () => {
+      jest.resetModules();
+      jest.doMock('../lib/colors', () => ({
+        colors: {
+          blue: (s) => `OUT:${s}`,
+          white: (s) => `OUT:${s}`,
+          green: (s) => `OUT:${s}`
+        },
+        forStream: jest.fn(() => ({
+          red: (s) => `ERR:${s}`,
+          yellow: (s) => `ERR:${s}`
+        }))
+      }));
+
+      const IsolatedLogger = require('../lib/console_logger');
+      const logger = new IsolatedLogger();
+
+      logger.info('a');
+      logger.debug('b');
+      logger.success('c');
+      logger.error('d');
+      logger.warn('e');
+
+      expect(spies.info.mock.calls[0][0]).toBe('OUT:a');
+      expect(spies.debug.mock.calls[0][0]).toBe('OUT:b');
+      expect(spies.log.mock.calls[0][0]).toBe('OUT:c');
+      expect(spies.error.mock.calls[0][0]).toBe('ERR:d');
+      expect(spies.warn.mock.calls[0][0]).toBe('ERR:e');
+
+      jest.dontMock('../lib/colors');
+      jest.resetModules();
+    });
+  });
+});

package/test.js

@@ -0,0 +1,57 @@
+/**
+ * @description 日志模块测试文件
+ */
+const { getLogger } = require('./index.js');
+
+// 创建日志实例
+const log = getLogger({
+    level: 'debug',
+    console: true,
+    file: true,
+    dir: './test_logs',
+    json: false
+});
+
+console.log('=== 开始测试日志模块 ===');
+
+// 测试基本日志功能
+log.debug('这是一条debug级别日志');
+log.info('这是一条info级别日志');
+log.success('这是一条success级别日志');
+log.warn('这是一条warn级别日志');
+log.error('这是一条error级别日志');
+log.fatal('这是一条fatal级别日志');
+
+// 测试HTTP日志
+log.http('info', 'HTTP GET /api/users 200 OK');
+log.http('warn', 'HTTP POST /api/users 400 Bad Request', { error: 'Invalid input' });
+log.http('error', 'HTTP POST /api/users 500 Internal Server Error', { error: 'Server error' });
+
+// 测试带额外参数
+log.info('带对象参数', { user_id: 1 }, { name: 'test', value: 123 });
+log.debug('带多个参数', '参数1', '参数2');
+
+console.log('=== 日志记录测试完成 ===');
+console.log('请检查控制台输出和日志文件');
+
+// 测试日志查询功能（可选）
+setTimeout(async () => {
+    try {
+        console.log('\n=== 测试日志查询 ===');
+        const today = new Date().toISOString().split('T')[0];
+        const result = await log.find({
+            date: today,
+            keyword: 'HTTP',
+            level: 'info',
+            page_now: 1,
+            page_size: 10
+        });
+        console.log(result);
+        console.log(`找到 ${result.count} 条日志`);
+    } catch (e) {
+        console.log('查询日志时发生错误:', e.message);
+    }
+}, 1000);
+
+console.log('=== 测试日志查询 ===');
+console.log('read', log.read());