kb-server 0.0.6 → 0.0.8

package/dist/common/api-middleware.js

@@ -23,11 +23,11 @@ const packAPI = (apis, options) => {
         const ctx = {
             RequestId: requestId,
         };
+        // API 解析 - 将Action定义移到try块外部，以便在catch块中也能访问
+        const { Action, ...params } = req.body || {};
         try {
-            // API 解析
-            const { Action, ...params } = req.body || {};
             if (log) {
-                logger_1.logger.info(`请求入参：${JSON.stringify(req.body)} - RequestId: ${requestId}`);
+                logger_1.logger.info({ requestId, action: Action, params }, "请求入参");
             }
             // 接口未定义
             if (!Action) {
@@ -63,12 +63,11 @@ const packAPI = (apis, options) => {
             };
             // 完成响应
             took = Date.now() - start;
-            logger_1.logger.info(`响应：${JSON.stringify(response)}`);
-            logger_1.logger.info(`耗时：${took} ms - RequestId: ${requestId}`);
+            logger_1.logger.info({ requestId, action: Action, response, took }, "请求响应");
             return res.send(response);
         }
         catch (rawError) {
-            logger_1.logger.error(rawError);
+            logger_1.logger.error({ requestId, action: Action, error: rawError }, "请求处理异常");
             // 未知错误
             let error = new create_errors_1.CommonErrors.InternalError.UnknownError();
             // 可控错误
@@ -90,8 +89,7 @@ const packAPI = (apis, options) => {
             };
             // 完成响应
             took = Date.now() - start;
-            logger_1.logger.info(`响应：${JSON.stringify(response)}`);
-            logger_1.logger.info(`耗时：${took} ms - RequestId: ${requestId}`);
+            logger_1.logger.info({ requestId, action: Action, response, took }, "请求响应");
             return res.send(response);
         }
     };

package/dist/common/sse-middleware.js

@@ -33,11 +33,11 @@ const packSSE = (sseHandlers, options) => {
         const ctx = {
             RequestId: requestId,
         };
+        // API 解析 - 将Action定义移到try块外部，以便在catch块中也能访问
+        const { Action, ...params } = req.body || {};
         try {
-            // API 解析
-            const { Action, ...params } = req.body || {};
             if (log) {
-                logger_1.logger.info(`请求入参：${JSON.stringify(req.body)} - RequestId: ${requestId}`);
+                logger_1.logger.info({ requestId, action: Action, params }, "SSE请求入参");
             }
             // 接口未定义
             if (!Action) {
@@ -73,7 +73,7 @@ const packSSE = (sseHandlers, options) => {
                 abortController.abort();
                 // 完成响应
                 took = Date.now() - start;
-                logger_1.logger.info(`耗时：${took} ms - ${requestId}`);
+                logger_1.logger.info({ requestId, action: Action, took }, "SSE连接关闭");
                 return res.end();
             });
             // 写头
@@ -87,14 +87,14 @@ const packSSE = (sseHandlers, options) => {
                 if (timeoutId)
                     clearTimeout(timeoutId);
                 timeoutId = setTimeout(() => {
-                    logger_1.logger.info(`超时自动关闭：${requestId}`);
+                    logger_1.logger.info({ requestId, action: Action }, "SSE超时自动关闭");
                     close();
                 }, timeout);
             };
             // 推送消息
             const push = (data) => {
                 if (!isConnected) {
-                    logger_1.logger.warning(`连接已关闭： ${requestId}`);
+                    logger_1.logger.warn({ requestId, action: Action }, "SSE连接已关闭");
                     return;
                 }
                 resetTimeout();
@@ -102,11 +102,11 @@ const packSSE = (sseHandlers, options) => {
                 const response = (0, exports.createSSEMsg)("message", msg);
                 try {
                     res.write(response);
-                    logger_1.logger.info(`推送数据： ${response}`);
+                    logger_1.logger.info({ requestId, action: Action, data, chunk: response }, "SSE推送数据");
                 }
                 catch (error) {
                     if (error.code === "EPIPE" || error.code === "ECONNRESET") {
-                        logger_1.logger.warning(`连接已关闭： ${requestId}`);
+                        logger_1.logger.warn({ requestId, action: Action, error }, "SSE连接已关闭");
                         isConnected = false;
                     }
                 }
@@ -115,7 +115,7 @@ const packSSE = (sseHandlers, options) => {
             const close = () => {
                 if (!isConnected)
                     return;
-                logger_1.logger.info(`主动关闭连接： ${requestId}`);
+                logger_1.logger.info({ requestId, action: Action }, "SSE主动关闭连接");
                 const response = (0, exports.createSSEMsg)("done", "[DONE]");
                 res.write(response, () => res.end());
             };
@@ -130,7 +130,7 @@ const packSSE = (sseHandlers, options) => {
             }
         }
         catch (rawError) {
-            logger_1.logger.error(rawError);
+            logger_1.logger.error({ requestId, action: Action, error: rawError }, "SSE请求处理异常");
             if (!res.headersSent) {
                 // 写头
                 res.writeHead(200, {
@@ -156,7 +156,7 @@ const packSSE = (sseHandlers, options) => {
                 },
             };
             const response = (0, exports.createSSEMsg)("error", JSON.stringify(errResponse));
-            logger_1.logger.info(`发送消息：\n${response}`);
+            logger_1.logger.info({ requestId, action: Action, response: errResponse }, "SSE错误响应");
             res.write(response, () => res.end());
         }
     };

package/dist/helper/logger.d.ts

@@ -1,5 +1,2 @@
-export declare const logger: {
-    info: (message: unknown) => void;
-    error: (message: unknown) => void;
-    warning: (message: unknown) => void;
-};
+import pino from "pino";
+export declare const logger: pino.Logger<never, boolean>;

package/dist/helper/logger.js

@@ -4,17 +4,35 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logger = void 0;
+const pino_1 = __importDefault(require("pino"));
 const dayjs_1 = __importDefault(require("dayjs"));
-const log = (level, message) => {
-    const logTime = (0, dayjs_1.default)().format(`YYYY-MM-DD HH:mm:ss`);
-    if (typeof message === "string") {
-        console.log(`[${level}] - [${logTime}] - ${message}`);
-    }
-    else {
-        console.log(`[${level}] - [${logTime}] - `, message);
-    }
-};
-const info = (message) => log("info", message);
-const error = (message) => log("error", message);
-const warning = (message) => log("warning", message);
-exports.logger = { info, error, warning };
+const utc_1 = __importDefault(require("dayjs/plugin/utc"));
+const timezone_1 = __importDefault(require("dayjs/plugin/timezone"));
+// 扩展dayjs插件
+dayjs_1.default.extend(utc_1.default);
+dayjs_1.default.extend(timezone_1.default);
+// 创建基础logger
+exports.logger = (0, pino_1.default)({
+    level: process.env.LOG_LEVEL || "info",
+    // 使用dayjs获取东八区时间（北京时间）
+    timestamp: () => `,"time":"${(0, dayjs_1.default)()
+        .tz("Asia/Shanghai")
+        .toISOString()}","timezone":"Asia/Shanghai","formatTime":"${(0, dayjs_1.default)()
+        .tz("Asia/Shanghai")
+        .format("YYYY-MM-DD HH:mm:ss")}"`,
+    transport: process.env.NODE_ENV !== "production"
+        ? {
+            target: "pino-pretty",
+            options: {
+                colorize: true,
+                // 保持原始的ISO时间戳格式，不转换
+                translateTime: false,
+                // 简单的消息格式
+                messageFormat: "{msg}",
+                ignore: "pid,hostname",
+                // 添加同步选项确保顺序
+                sync: true,
+            },
+        }
+        : undefined,
+});

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export { createErrors } from "./common/create-errors";
 export { implementAPI, ServerContext } from "./common/create-api";
 export { implementSseAPI } from "./common/create-sse";
 export { callService } from "./common/call-service";
+export { logger } from "./helper/logger";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.callService = exports.implementSseAPI = exports.implementAPI = exports.createErrors = exports.createServer = void 0;
+exports.logger = exports.callService = exports.implementSseAPI = exports.implementAPI = exports.createErrors = exports.createServer = void 0;
 var create_server_1 = require("./common/create-server");
 Object.defineProperty(exports, "createServer", { enumerable: true, get: function () { return create_server_1.createServer; } });
 var create_errors_1 = require("./common/create-errors");
@@ -11,3 +11,5 @@ var create_sse_1 = require("./common/create-sse");
 Object.defineProperty(exports, "implementSseAPI", { enumerable: true, get: function () { return create_sse_1.implementSseAPI; } });
 var call_service_1 = require("./common/call-service");
 Object.defineProperty(exports, "callService", { enumerable: true, get: function () { return call_service_1.callService; } });
+var logger_1 = require("./helper/logger");
+Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return logger_1.logger; } });

package/dist/tests/logger/basic.test.d.ts

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

package/dist/tests/logger/basic.test.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 基础日志功能测试
+ * 运行方式: npx tsx src/tests/logger/basic.test.ts
+ */
+const logger_1 = require("../../helper/logger");
+console.log('=== 基础日志功能测试 ===\n');
+// 测试不同级别的日志
+logger_1.logger.info('这是一条信息日志');
+logger_1.logger.warn('这是一条警告日志');
+logger_1.logger.error('这是一条错误日志');
+logger_1.logger.debug('这是一条调试日志（默认级别下不会显示）');
+logger_1.logger.trace('这是一条跟踪日志（默认级别下不会显示）');
+// 测试直接调用方法
+logger_1.logger.fatal('这是一条致命错误日志');
+console.log('\n基础日志测试完成');

package/dist/tests/logger/run-all.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 运行所有日志测试
+ * 运行方式: npx tsx src/tests/logger/run-all.ts
+ */
+export {};

package/dist/tests/logger/run-all.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * 运行所有日志测试
+ * 运行方式: npx tsx src/tests/logger/run-all.ts
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+console.log('=== 运行所有日志测试 ===\n');
+const testFiles = [
+    'src/tests/logger/basic.test.ts',
+    'src/tests/logger/structured.test.ts',
+    'src/tests/logger/timezone.test.ts'
+];
+let failedTests = 0;
+for (const testFile of testFiles) {
+    if (!(0, fs_1.existsSync)(testFile)) {
+        console.log(`❌ 跳过不存在的测试文件: ${testFile}`);
+        failedTests++;
+        continue;
+    }
+    try {
+        console.log(`\n🔄 运行测试: ${testFile}`);
+        console.log('---');
+        (0, child_process_1.execSync)(`npx tsx ${testFile}`, { stdio: 'inherit' });
+        console.log('✅ 测试通过');
+    }
+    catch (error) {
+        console.log('❌ 测试失败');
+        failedTests++;
+    }
+}
+console.log('\n=== 测试总结 ===');
+if (failedTests === 0) {
+    console.log('🎉 所有测试都已通过！');
+}
+else {
+    console.log(`⚠️ 有 ${failedTests} 个测试失败`);
+}
+// 测试不同环境变量配置
+console.log('\n=== 测试不同环境变量配置 ===');
+console.log('\n📝 测试美化输出 (USE_PRETTY_LOGS=true):');
+try {
+    console.log('---');
+    (0, child_process_1.execSync)('USE_PRETTY_LOGS=true npx tsx src/tests/logger/basic.test.ts', { stdio: 'inherit' });
+    console.log('✅ 美化输出测试通过');
+}
+catch (error) {
+    console.log('❌ 美化输出测试失败');
+}
+console.log('\n📝 测试调试级别 (LOG_LEVEL=debug):');
+try {
+    console.log('---');
+    (0, child_process_1.execSync)('LOG_LEVEL=debug npx tsx src/tests/logger/basic.test.ts', { stdio: 'inherit' });
+    console.log('✅ 调试级别测试通过');
+}
+catch (error) {
+    console.log('❌ 调试级别测试失败');
+}

package/dist/tests/logger/structured.test.d.ts

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

package/dist/tests/logger/structured.test.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 结构化日志测试
+ * 运行方式: npx tsx src/tests/logger/structured.test.ts
+ */
+const logger_1 = require("../../helper/logger");
+const dayjs_1 = __importDefault(require("dayjs"));
+console.log("=== 结构化日志测试 ===\n");
+// 测试对象日志
+logger_1.logger.info({
+    user: "张三",
+    action: "登录",
+    ip: "192.168.1.1",
+    timestamp: (0, dayjs_1.default)().format("YYYY-MM-DD HH:mm:ss"),
+});
+// 测试错误对象日志
+logger_1.logger.error({
+    error: "数据库连接失败",
+    code: "DB_ERROR",
+    retryCount: 3,
+    lastError: "Connection timeout after 5000ms",
+    stack: "Error: Connection timeout\n    at Object.connect (db.js:42:15)",
+});
+// 测试复杂对象日志
+logger_1.logger.info({
+    event: "API请求",
+    request: {
+        id: "req-123456",
+        method: "POST",
+        url: "/api/users",
+        headers: {
+            "content-type": "application/json",
+            authorization: "Bearer ***",
+        },
+        body: {
+            name: "李四",
+            email: "lisi@example.com",
+        },
+    },
+    response: {
+        status: 201,
+        time: 125,
+        data: {
+            id: "user-789",
+            name: "李四",
+            email: "lisi@example.com",
+            createdAt: (0, dayjs_1.default)().toISOString(),
+        },
+    },
+});
+console.log("\n结构化日志测试完成");

package/dist/tests/logger/timezone.test.d.ts

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

package/dist/tests/logger/timezone.test.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 时区测试
+ * 运行方式: npx tsx src/tests/logger/timezone.test.ts
+ */
+const logger_1 = require("../../helper/logger");
+const dayjs_1 = __importDefault(require("dayjs"));
+const utc_1 = __importDefault(require("dayjs/plugin/utc"));
+const timezone_1 = __importDefault(require("dayjs/plugin/timezone"));
+// 扩展dayjs插件
+dayjs_1.default.extend(utc_1.default);
+dayjs_1.default.extend(timezone_1.default);
+console.log('=== 时区测试 ===\n');
+// 显示当前时间对比
+console.log('UTC时间:', (0, dayjs_1.default)().utc().format());
+console.log('东八区时间:', (0, dayjs_1.default)().tz('Asia/Shanghai').format());
+console.log('本地时间:', (0, dayjs_1.default)().format());
+console.log();
+// 测试日志时间戳
+logger_1.logger.info('这条日志应该包含东八区时间戳');
+// 测试业务日志中的时间
+logger_1.logger.info({
+    event: '用户操作',
+    user: '张三',
+    action: '下单',
+    // 使用dayjs记录东八区时间
+    beijingTime: (0, dayjs_1.default)().tz('Asia/Shanghai').format('YYYY-MM-DD HH:mm:ss'),
+    utcTime: (0, dayjs_1.default)().utc().format(),
+    orderInfo: {
+        id: 'ORDER-123456',
+        amount: 299.00,
+        items: ['商品A', '商品B']
+    }
+});
+// 测试跨时区场景
+logger_1.logger.warn({
+    msg: '服务器时区警告',
+    serverTimezone: dayjs_1.default.tz.guess(),
+    serverTime: (0, dayjs_1.default)().format('YYYY-MM-DD HH:mm:ss Z'),
+    beijingTime: (0, dayjs_1.default)().tz('Asia/Shanghai').format('YYYY-MM-DD HH:mm:ss Z'),
+    utcTime: (0, dayjs_1.default)().utc().format()
+});
+console.log('\n时区测试完成');

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "kb-server",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "A fast server for Node.JS,made by express.",
   "main": "dist/index.js",
   "scripts": {
     "build": "rm -rf ./dist && tsc",
-    "release": "npm run build && npm publish"
+    "release": "npm run build && npm version patch && npm publish"
   },
   "keywords": [
     "2kb",
@@ -29,9 +29,18 @@
     "express": "^4.21.1",
     "is-plain-object": "^5.0.0",
     "nanoid": "^3.3.9",
+    "pino": "^10.1.0",
     "utility-types": "^3.11.0",
     "uuid": "^11.0.3"
   },
+  "peerDependencies": {
+    "pino-pretty": "^13.1.3"
+  },
+  "peerDependenciesMeta": {
+    "pino-pretty": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@types/express": "^4.17.21"
   }