@lark-apaas/nestjs-logger 1.0.0 → 1.0.1-alpha.1

package/README.md

@@ -11,6 +11,10 @@
 - 独立的 trace 日志文件
 - 请求上下文传递
 - 日志体长度截断
+- **完美兼容 Exception Filter**：
+  - 拦截 `response.json()` 和 `response.send()` 方法
+  - 能够捕获 Exception Filter 改写的响应体和最终状态码
+  - 确保异常日志的完整性和准确性
 
 ## 安装
 
@@ -95,6 +99,14 @@ HTTP 请求追踪日志使用 **`verbose` 级别**（对应 Pino 的 `trace` 级
 - **需要显式启用**：要查看 HTTP 请求追踪日志，需要将 `LOGGER_LEVEL` 设置为 `verbose`
 - **细粒度控制**：可以通过日志级别控制是否打印请求追踪，而无需修改 `LOG_REQUEST_BODY` 和 `LOG_RESPONSE_BODY` 配置
 
+### 响应体记录规则
+
+**只针对 JSON 响应记录 body**：
+- 自动检测 `Content-Type` 是否包含 `application/json`
+- 只有 JSON 响应才会记录 `response_body` 字段
+- 文件下载、HTML 页面等非 JSON 响应不会记录 body，避免日志污染
+- 这样可以显著减少日志体积，同时保持日志的可读性
+
 ### 启用方式
 
 通过环境变量启用：
@@ -117,7 +129,11 @@ LOG_RESPONSE_BODY=true
 
 2. **默认不限制长度**：如果不设置 `LOG_MAX_BODY_LENGTH` 环境变量，日志体不会被截断。建议在生产环境设置合理的限制值。
 
-3. **响应数据处理**：日志库会尝试序列化所有响应数据，对于无法序列化的数据（如 Buffer、Stream）会返回类型信息。
+3. **响应体过滤**：
+   - 只记录 JSON 响应的 body（检测 Content-Type）
+   - 文件下载、HTML、图片等非 JSON 响应不会记录 body
+   - 避免记录无法序列化的数据（如 Buffer、Stream）
+   - 显著减少日志体积，提高日志可读性
 
 ### 日志输出示例
 
@@ -229,6 +245,27 @@ 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`
+   - **类型检测**：通过 `Content-Type` header 判断是否为 JSON 响应，只记录 JSON 类型的 body
+   - **延迟记录**：不在 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,6 +14855,16 @@ var LoggingInterceptor = class {
       ip: req.ip ?? null,
       pid: process.pid
     };
+    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
     };
@@ -14866,47 +14876,45 @@ var LoggingInterceptor = class {
     }
     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;
-      const appLog = this.appLogger[res.statusCode >= 400 ? "error" : "log"].bind(this.appLogger);
       const responseMeta = {
         ...baseMeta,
         status_code: statusCode,
         duration_ms: durationMs
       };
-      if (this.config.logResponseBody && responseData !== void 0) {
-        responseMeta["response_body"] = this.sanitizeAndTruncate(responseData);
-      }
-      const traceLevel = res.statusCode >= 400 ? "error" : "verbose";
-      appLog("HTTP request completed\n url=%s \n status_code=%d \n duration_ms=%d \n response_body=%o", req.url, statusCode, durationMs, responseMeta.response_body ?? {});
-      this.traceLogger.logStructured(traceLevel, "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;
-      }
-      const meta = {
-        ...baseMeta,
-        status_code: statusCode,
-        duration_ms: durationMs
-      };
-      if (error instanceof Error) {
-        meta["error"] = {
-          message: error.message,
-          stack: error.stack
-        };
+      const finalResponseBody = res.__finalResponseBody;
+      const contentType = res.getHeader("content-type");
+      const isJsonResponse = typeof contentType === "string" && contentType.includes("application/json");
+      if (this.config.logResponseBody && finalResponseBody !== void 0 && isJsonResponse) {
+        responseMeta["response_body"] = this.sanitizeAndTruncate(finalResponseBody);
+      }
+      const isError = statusCode >= 400;
+      const appLog = this.appLogger[isError ? "error" : "log"].bind(this.appLogger);
+      const traceLevel = isError ? "error" : "verbose";
+      const shouldLogBody = this.config.logResponseBody && isJsonResponse && finalResponseBody !== void 0;
+      if (isError) {
+        if (shouldLogBody) {
+          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 {
+          appLog("HTTP request failed\n url=%s \n status_code=%d \n duration_ms=%d", req.url, statusCode, durationMs);
+        }
       } else {
-        meta["error"] = String(error);
+        if (shouldLogBody) {
+          appLog("HTTP request completed\n url=%s \n status_code=%d \n duration_ms=%d \n response_body=%o", req.url, statusCode, durationMs, finalResponseBody);
+        } else {
+          appLog("HTTP request completed\n url=%s \n status_code=%d \n duration_ms=%d", req.url, statusCode, durationMs);
+        }
       }
-      this.appLogger.error("HTTP request failed\n url=%s \n status_code=%d \n duration_ms=%d \n error=%o", req.url, statusCode, durationMs, meta.error);
-      this.traceLogger.logStructured("error", "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;
     }));
   }