@lark-apaas/nestjs-logger 0.1.0-alpha.9 → 1.0.1-alpha.0

package/README.md

@@ -11,6 +11,10 @@
 - 独立的 trace 日志文件
 - 请求上下文传递
 - 日志体长度截断
+- **完美兼容 Exception Filter**：
+  - 拦截 `response.json()` 和 `response.send()` 方法
+  - 能够捕获 Exception Filter 改写的响应体和最终状态码
+  - 确保异常日志的完整性和准确性
 
 ## 安装
 
@@ -229,6 +233,26 @@ NestJS LoggerService 级别到 Pino 级别的映射：
 
 ## 注意事项
 
+### 架构设计
+
+1. **Exception Filter 兼容性**：
+   - 使用 `response.on('finish')` 事件记录日志，确保在响应完全发送后才记录
+   - 拦截 `response.json()` 和 `response.send()` 方法，捕获最终发送的响应体
+   - 能够正确捕获全局 Exception Filter 设置的最终状态码和响应体
+   - 日志记录发生在 NestJS 请求生命周期的最后阶段，确保信息完整准确
+
+2. **请求生命周期**：
+   ```
+   Middleware → Guards → Interceptor (before) → Pipes → Controller
+       ↓
+   Interceptor (after/catchError) → Exception Filters → Response Finish (✅ 日志记录)
+   ```
+
+3. **实现原理**：
+   - **拦截响应方法**：在 Interceptor 中拦截 `res.json()` 和 `res.send()`，存储响应体到 `res.__finalResponseBody`
+   - **延迟记录**：不在 Interceptor 的 `tap()` 或 `catchError()` 中记录日志，而是在 `finish` 事件中统一记录
+   - **完整信息**：此时可以获取 Exception Filter 处理后的最终状态码和响应体，确保日志准确性
+
 ### 安全性
 
 1. **生产环境默认不打印 HTTP 追踪日志**：由于使用 verbose 级别，生产环境（info 级别）默认不会输出详细日志

package/dist/index.cjs

@@ -10567,7 +10567,7 @@ var require_tap = __commonJS({
     var lift_1 = require_lift();
     var OperatorSubscriber_1 = require_OperatorSubscriber();
     var identity_1 = require_identity();
-    function tap2(observerOrNext, error, complete) {
+    function tap(observerOrNext, error, complete) {
       var tapObserver = isFunction_1.isFunction(observerOrNext) || error || complete ? {
         next: observerOrNext,
         error,
@@ -10600,8 +10600,8 @@ var require_tap = __commonJS({
         }));
       }) : identity_1.identity;
     }
-    __name(tap2, "tap");
-    exports2.tap = tap2;
+    __name(tap, "tap");
+    exports2.tap = tap;
   }
 });
 
@@ -14855,7 +14855,16 @@ var LoggingInterceptor = class {
       ip: req.ip ?? null,
       pid: process.pid
     };
-    this.appLogger.logStructured("log", "HTTP request started", baseMeta, "HTTPTraceInterceptor");
+    const originalJson = res.json.bind(res);
+    const originalSend = res.send.bind(res);
+    res.json = function(body) {
+      res.__finalResponseBody = body;
+      return originalJson(body);
+    };
+    res.send = function(body) {
+      res.__finalResponseBody = body;
+      return originalSend(body);
+    };
     const requestMeta = {
       ...baseMeta
     };
@@ -14865,50 +14874,36 @@ var LoggingInterceptor = class {
     if (this.config.logRequestBody && Object.keys(req.query || {}).length > 0) {
       requestMeta["query_params"] = this.sanitizeAndTruncate(req.query);
     }
+    this.appLogger.log("HTTP request started \n url=%s \n request_query=%o \n request_body=%o", req.url, requestMeta["query_params"] ?? {}, requestMeta["request_body"] ?? {});
     this.traceLogger.logStructured("verbose", "HTTP request started", requestMeta, "HTTPTraceInterceptor");
-    return next.handle().pipe((0, import_operators.tap)((responseData) => {
+    let logged = false;
+    res.on("finish", () => {
+      if (logged) {
+        return;
+      }
+      logged = true;
       const durationMs = Date.now() - startedAt;
       const statusCode = res.statusCode;
-      this.appLogger.logStructured("log", "HTTP request completed", {
-        ...baseMeta,
-        status_code: statusCode,
-        duration_ms: durationMs
-      }, "HTTPTraceInterceptor");
       const responseMeta = {
         ...baseMeta,
         status_code: statusCode,
         duration_ms: durationMs
       };
-      if (this.config.logResponseBody && responseData !== void 0) {
-        responseMeta["response_body"] = this.sanitizeAndTruncate(responseData);
+      const finalResponseBody = res.__finalResponseBody;
+      if (this.config.logResponseBody && finalResponseBody !== void 0) {
+        responseMeta["response_body"] = this.sanitizeAndTruncate(finalResponseBody);
       }
-      this.traceLogger.logStructured("verbose", "HTTP request completed", responseMeta, "HTTPTraceInterceptor");
-    }), (0, import_operators.catchError)((error) => {
-      const durationMs = Date.now() - startedAt;
-      const statusCode = res.statusCode >= 400 ? res.statusCode : 500;
-      const linkMeta = {
-        ...baseMeta,
-        status_code: statusCode,
-        duration_ms: durationMs
-      };
-      if (error instanceof Error) {
-        linkMeta["error_message"] = error.message;
-      }
-      this.appLogger.logStructured("log", "HTTP request failed", linkMeta, "HTTPTraceInterceptor");
-      const meta = {
-        ...baseMeta,
-        status_code: statusCode,
-        duration_ms: durationMs
-      };
-      if (error instanceof Error) {
-        meta["error"] = {
-          message: error.message,
-          stack: error.stack
-        };
+      const isError = statusCode >= 400;
+      const appLog = this.appLogger[isError ? "error" : "log"].bind(this.appLogger);
+      const traceLevel = isError ? "error" : "verbose";
+      if (isError) {
+        appLog("HTTP request failed\n url=%s \n status_code=%d \n duration_ms=%d \n response_body=%o", req.url, statusCode, durationMs, finalResponseBody ?? {});
       } else {
-        meta["error"] = String(error);
+        appLog("HTTP request completed\n url=%s \n status_code=%d \n duration_ms=%d \n response_body=%o", req.url, statusCode, durationMs, finalResponseBody ?? {});
       }
-      this.traceLogger.logStructured("verbose", "HTTP request failed", meta, "HTTPTraceInterceptor");
+      this.traceLogger.logStructured(traceLevel, isError ? "HTTP request failed" : "HTTP request completed", responseMeta, "HTTPTraceInterceptor");
+    });
+    return next.handle().pipe((0, import_operators.catchError)((error) => {
       throw error;
     }));
   }
@@ -14987,7 +14982,7 @@ function createPinoLogger(config) {
 }
 __name(createPinoLogger, "createPinoLogger");
 function createFileDestination(pathname) {
-  const target = pathname && pathname.length > 0 ? pathname : "logs/app.log";
+  const target = pathname && pathname.length > 0 ? pathname : "logs/server.log";
   const resolved = (0, import_path.isAbsolute)(target) ? target : (0, import_path.join)(process.cwd(), target);
   const dir = (0, import_path.dirname)(resolved);
   if (!(0, import_fs.existsSync)(dir)) {
@@ -15076,7 +15071,7 @@ LoggerModule = _ts_decorate5([
         useFactory: /* @__PURE__ */ __name((config) => {
           return createPinoLogger({
             level: config.level,
-            filePath: `${config.logDir}/app.log`
+            filePath: `${config.logDir}/server.log`
           });
         }, "useFactory"),
         inject: [