@lark-apaas/nestjs-logger 1.0.2 → 1.0.3-alpha.0

package/LICENSE

@@ -0,0 +1,13 @@
+MIT License
+
+Copyright (c) 2024 Lark Technologies Pte. Ltd. and/or its affiliates
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,provided that the above copyright notice and this permission notice appear in all copies.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
+INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
+CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
+ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/dist/index.cjs

@@ -452,7 +452,7 @@ var require_config_constants = __commonJS({
       value: true
     });
     exports2.AS_PROVIDER_METHOD_KEY = exports2.VALIDATED_ENV_PROPNAME = exports2.PARTIAL_CONFIGURATION_PROPNAME = exports2.PARTIAL_CONFIGURATION_KEY = exports2.VALIDATED_ENV_LOADER = exports2.CONFIGURATION_LOADER = exports2.CONFIGURATION_TOKEN = exports2.CONFIGURATION_SERVICE_TOKEN = void 0;
-    exports2.CONFIGURATION_SERVICE_TOKEN = Symbol("CONFIG_SERVICE");
+    exports2.CONFIGURATION_SERVICE_TOKEN = /* @__PURE__ */ Symbol("CONFIG_SERVICE");
     exports2.CONFIGURATION_TOKEN = "CONFIGURATION_TOKEN";
     exports2.CONFIGURATION_LOADER = "CONFIGURATION_LOADER";
     exports2.VALIDATED_ENV_LOADER = "VALIDATED_ENV_LOADER";
@@ -14381,17 +14381,14 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/service/app-logger.service.ts
-var import_common2 = require("@nestjs/common");
-var import_util = require("util");
+var import_common = require("@nestjs/common");
 
 // src/helper/constants.ts
-var PINO_ROOT_LOGGER = Symbol("PINO_ROOT_LOGGER");
-var TRACE_LOGGER = Symbol("TRACE_LOGGER");
-var METRICS_LOGGER = Symbol("METRICS_LOGGER");
+var PINO_ROOT_LOGGER = /* @__PURE__ */ Symbol("PINO_ROOT_LOGGER");
+var TRACE_LOGGER = /* @__PURE__ */ Symbol("TRACE_LOGGER");
 
-// src/service/request-context.service.ts
-var import_common = require("@nestjs/common");
-var import_async_hooks = require("async_hooks");
+// src/service/app-logger.service.ts
+var import_nestjs_common = require("@lark-apaas/nestjs-common");
 function _ts_decorate(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -14399,43 +14396,6 @@ function _ts_decorate(decorators, target, key, desc) {
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
 __name(_ts_decorate, "_ts_decorate");
-var RequestContextService = class {
-  static {
-    __name(this, "RequestContextService");
-  }
-  storage = new import_async_hooks.AsyncLocalStorage();
-  run(context, callback) {
-    const store = {
-      ...context
-    };
-    return this.storage.run(store, callback);
-  }
-  setContext(partial) {
-    const store = this.storage.getStore();
-    if (!store) {
-      return;
-    }
-    Object.assign(store, partial);
-  }
-  getContext() {
-    return this.storage.getStore();
-  }
-  get(key) {
-    return this.storage.getStore()?.[key];
-  }
-};
-RequestContextService = _ts_decorate([
-  (0, import_common.Injectable)()
-], RequestContextService);
-
-// src/service/app-logger.service.ts
-function _ts_decorate2(decorators, target, key, desc) {
-  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-  return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-__name(_ts_decorate2, "_ts_decorate");
 function _ts_metadata(k, v) {
   if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
@@ -14543,10 +14503,12 @@ var BasePinoLogger = class _BasePinoLogger {
   }
   logger;
   contextStore;
+  observableService;
   levelState = new LogLevelState();
-  constructor(logger, contextStore) {
+  constructor(logger, contextStore, observableService) {
     this.logger = logger;
     this.contextStore = contextStore;
+    this.observableService = observableService;
     const pinoLevel = this.logger.level;
     const nestLevels = LogLevelState.fromPinoLevel(pinoLevel);
     this.levelState.set(nestLevels);
@@ -14610,6 +14572,26 @@ var BasePinoLogger = class _BasePinoLogger {
     const { context, stack, extras } = this.extractOptionalParams(optionalParams, treatStack);
     const requestState = this.contextStore.getContext();
     const traceId = requestState?.requestId ?? null;
+    const flatObject = /* @__PURE__ */ __name((extra) => {
+      let res = {};
+      try {
+        extra.forEach((item) => {
+          if (typeof item === "object" && item !== null) {
+            res = {
+              ...res,
+              ...item
+            };
+          }
+        });
+        delete res.message;
+        delete res.level;
+        delete res.time;
+        delete res.context;
+        return res;
+      } catch {
+      }
+    }, "flatObject");
+    const processedExtra = flatObject(extras);
     const payload = {
       trace_id: traceId,
       path: requestState?.path,
@@ -14617,12 +14599,13 @@ var BasePinoLogger = class _BasePinoLogger {
       user_id: requestState?.userId ?? null,
       app_id: requestState?.appId ?? null,
       tenant_id: requestState?.tenantId ?? null,
-      pid: process.pid
+      pid: process.pid,
+      ...processedExtra
     };
     if (context) {
       payload.context = context;
     }
-    const { messageText, stack: computedStack, data } = this.buildMessagePayload(message, extras);
+    const { messageText, stack: computedStack, data } = this.buildMessagePayload(message);
     if (stack) {
       payload.stack = stack;
     } else if (computedStack) {
@@ -14633,10 +14616,14 @@ var BasePinoLogger = class _BasePinoLogger {
     }
     const pinoLevel = mapLogLevelToPino(level);
     const sanitizedPayload = sanitizeValue(payload);
-    if (messageText) {
-      this.logger[pinoLevel](sanitizedPayload, messageText);
+    if (process.env.NODE_ENV === "development") {
+      if (messageText) {
+        this.logger[pinoLevel](sanitizedPayload, messageText);
+      } else {
+        this.logger[pinoLevel](sanitizedPayload);
+      }
     } else {
-      this.logger[pinoLevel](sanitizedPayload);
+      this.observableService.log(level, messageText ?? "", payload);
     }
   }
   extractOptionalParams(optionalParams, treatStack) {
@@ -14665,7 +14652,7 @@ var BasePinoLogger = class _BasePinoLogger {
       extras: params
     };
   }
-  buildMessagePayload(message, extras) {
+  buildMessagePayload(message) {
     if (message instanceof Error) {
       return {
         messageText: message.message,
@@ -14673,17 +14660,8 @@ var BasePinoLogger = class _BasePinoLogger {
       };
     }
     if (typeof message === "string") {
-      if (extras.length === 0) {
-        return {
-          messageText: message
-        };
-      }
-      const allMessages = [
-        message,
-        ...extras.map((e) => stringifyParam(e))
-      ].join(" ");
       return {
-        messageText: allMessages
+        messageText: message
       };
     }
     if (typeof message === "object" && message !== null) {
@@ -14706,18 +14684,20 @@ var AppLogger = class extends BasePinoLogger {
   static {
     __name(this, "AppLogger");
   }
-  constructor(logger, requestContext) {
-    super(logger, requestContext);
-    import_common2.Logger.overrideLogger(this);
+  constructor(logger, observableService, requestContext) {
+    super(logger, requestContext, observableService);
+    import_common.Logger.overrideLogger(this);
   }
 };
-AppLogger = _ts_decorate2([
-  (0, import_common2.Injectable)(),
-  _ts_param(0, (0, import_common2.Inject)(PINO_ROOT_LOGGER)),
+AppLogger = _ts_decorate([
+  (0, import_common.Injectable)(),
+  _ts_param(0, (0, import_common.Inject)(PINO_ROOT_LOGGER)),
+  _ts_param(1, (0, import_common.Inject)(import_nestjs_common.OBSERVABLE_SERVICE)),
   _ts_metadata("design:type", Function),
   _ts_metadata("design:paramtypes", [
     typeof PinoLogger === "undefined" ? Object : PinoLogger,
-    typeof RequestContextService === "undefined" ? Object : RequestContextService
+    typeof import_nestjs_common.ObservableService === "undefined" ? Object : import_nestjs_common.ObservableService,
+    typeof import_nestjs_common.RequestContextService === "undefined" ? Object : import_nestjs_common.RequestContextService
   ])
 ], AppLogger);
 var PinoLoggerService = class extends BasePinoLogger {
@@ -14743,18 +14723,6 @@ function mapLogLevelToPino(level) {
   }
 }
 __name(mapLogLevelToPino, "mapLogLevelToPino");
-function stringifyParam(param) {
-  if (typeof param === "string") {
-    return param;
-  }
-  const inspectOptions = {
-    depth: 4,
-    colors: false,
-    compact: true
-  };
-  return (0, import_util.inspect)(param, inspectOptions);
-}
-__name(stringifyParam, "stringifyParam");
 function sanitizeValue(value) {
   if (value === null || value === void 0) {
     return value;
@@ -14777,9 +14745,10 @@ function sanitizeValue(value) {
 __name(sanitizeValue, "sanitizeValue");
 
 // src/module.ts
-var import_common5 = require("@nestjs/common");
+var import_common4 = require("@nestjs/common");
 var import_core = require("@nestjs/core");
 var import_config3 = __toESM(require_config2(), 1);
+var import_nestjs_common4 = require("@lark-apaas/nestjs-common");
 
 // src/config/logger.config.ts
 var import_config = __toESM(require_config2(), 1);
@@ -14813,17 +14782,18 @@ var logger_config_default = (0, import_config.registerAs)("logger", () => {
 });
 
 // src/interceptor/logging.interceptor.ts
-var import_common3 = require("@nestjs/common");
+var import_common2 = require("@nestjs/common");
 var import_config2 = __toESM(require_config2(), 1);
 var import_operators = __toESM(require_operators(), 1);
-var import_util2 = require("util");
-function _ts_decorate3(decorators, target, key, desc) {
+var import_util = require("util");
+var import_nestjs_common2 = require("@lark-apaas/nestjs-common");
+function _ts_decorate2(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
   else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-__name(_ts_decorate3, "_ts_decorate");
+__name(_ts_decorate2, "_ts_decorate");
 function _ts_metadata2(k, v) {
   if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
@@ -14947,7 +14917,7 @@ duration_ms=${durationMs}`, "HTTPTraceInterceptor");
       this.traceLogger.logStructured(traceLevel, isError ? "HTTP request failed" : "HTTP request completed", responseMeta, "HTTPTraceInterceptor");
     });
     return next.handle().pipe((0, import_operators.catchError)((error) => {
-      this.appLogger.error((0, import_util2.format)("HTTP request exception\nmethod=%s url=%s\nerror=%o", req.method, req.url, error), "HTTPTraceInterceptor");
+      this.appLogger.error((0, import_util.format)("HTTP request exception\nmethod=%s url=%s\nerror=%o", req.method, req.url, error), "HTTPTraceInterceptor");
       throw error;
     }));
   }
@@ -14972,20 +14942,21 @@ duration_ms=${durationMs}`, "HTTPTraceInterceptor");
       return {
         _error: "Failed to serialize data",
         _type: typeof data,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         _constructor: data?.constructor?.name
       };
     }
   }
 };
-LoggingInterceptor = _ts_decorate3([
-  (0, import_common3.Injectable)(),
-  _ts_param2(0, (0, import_common3.Inject)(TRACE_LOGGER)),
-  _ts_param2(2, (0, import_common3.Inject)(AppLogger)),
-  _ts_param2(3, (0, import_common3.Inject)(logger_config_default.KEY)),
+LoggingInterceptor = _ts_decorate2([
+  (0, import_common2.Injectable)(),
+  _ts_param2(0, (0, import_common2.Inject)(TRACE_LOGGER)),
+  _ts_param2(2, (0, import_common2.Inject)(AppLogger)),
+  _ts_param2(3, (0, import_common2.Inject)(logger_config_default.KEY)),
   _ts_metadata2("design:type", Function),
   _ts_metadata2("design:paramtypes", [
     typeof PinoLoggerService === "undefined" ? Object : PinoLoggerService,
-    typeof RequestContextService === "undefined" ? Object : RequestContextService,
+    typeof import_nestjs_common2.RequestContextService === "undefined" ? Object : import_nestjs_common2.RequestContextService,
     typeof AppLogger === "undefined" ? Object : AppLogger,
     typeof import_config2.ConfigType === "undefined" ? Object : import_config2.ConfigType
   ])
@@ -15042,15 +15013,16 @@ function createFileDestination(pathname) {
 __name(createFileDestination, "createFileDestination");
 
 // src/middleware/logger-context.middleware.ts
-var import_common4 = require("@nestjs/common");
+var import_common3 = require("@nestjs/common");
 var import_crypto = require("crypto");
-function _ts_decorate4(decorators, target, key, desc) {
+var import_nestjs_common3 = require("@lark-apaas/nestjs-common");
+function _ts_decorate3(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
   else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-__name(_ts_decorate4, "_ts_decorate");
+__name(_ts_decorate3, "_ts_decorate");
 function _ts_metadata3(k, v) {
   if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
@@ -15065,51 +15037,44 @@ var LoggerContextMiddleware = class {
   }
   use(req, res, next) {
     const requestId = req.headers["x-tt-log-id"] ?? (0, import_crypto.randomUUID)();
-    const path = req.originalUrl ?? req.url;
-    const userContext = req.userContext ?? {};
     const mutableReq = req;
     mutableReq.requestId = requestId;
     mutableReq.id = requestId;
     res.setHeader("x-log-trace-id", requestId);
-    this.requestContext.run({
-      requestId,
-      path,
-      method: req.method,
-      userId: userContext.userId,
-      tenantId: userContext.tenantId,
-      appId: userContext.appId
-    }, () => next());
+    this.requestContext.setContext({
+      requestId
+    });
+    next();
   }
 };
-LoggerContextMiddleware = _ts_decorate4([
-  (0, import_common4.Injectable)(),
+LoggerContextMiddleware = _ts_decorate3([
+  (0, import_common3.Injectable)(),
   _ts_metadata3("design:type", Function),
   _ts_metadata3("design:paramtypes", [
-    typeof RequestContextService === "undefined" ? Object : RequestContextService
+    typeof import_nestjs_common3.RequestContextService === "undefined" ? Object : import_nestjs_common3.RequestContextService
   ])
 ], LoggerContextMiddleware);
 
 // src/module.ts
-function _ts_decorate5(decorators, target, key, desc) {
+function _ts_decorate4(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
   else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-__name(_ts_decorate5, "_ts_decorate");
+__name(_ts_decorate4, "_ts_decorate");
 var LoggerModule = class {
   static {
     __name(this, "LoggerModule");
   }
 };
-LoggerModule = _ts_decorate5([
-  (0, import_common5.Global)(),
-  (0, import_common5.Module)({
+LoggerModule = _ts_decorate4([
+  (0, import_common4.Global)(),
+  (0, import_common4.Module)({
     imports: [
       import_config3.ConfigModule.forFeature(logger_config_default)
     ],
     providers: [
-      RequestContextService,
       LoggerContextMiddleware,
       {
         provide: PINO_ROOT_LOGGER,
@@ -15125,13 +15090,14 @@ LoggerModule = _ts_decorate5([
       },
       {
         provide: TRACE_LOGGER,
-        useFactory: /* @__PURE__ */ __name((requestContext, config) => new PinoLoggerService(createPinoLogger({
+        useFactory: /* @__PURE__ */ __name((requestContext, config, observableService) => new PinoLoggerService(createPinoLogger({
           level: config.level,
           filePath: `${config.logDir}/trace.log`
-        }), requestContext), "useFactory"),
+        }), requestContext, observableService), "useFactory"),
         inject: [
-          RequestContextService,
-          logger_config_default.KEY
+          import_nestjs_common4.RequestContextService,
+          logger_config_default.KEY,
+          import_nestjs_common4.OBSERVABLE_SERVICE
         ]
       },
       AppLogger,
@@ -15144,7 +15110,6 @@ LoggerModule = _ts_decorate5([
     exports: [
       AppLogger,
       TRACE_LOGGER,
-      RequestContextService,
       LoggerContextMiddleware
     ]
   })