@lark-apaas/fullstack-nestjs-core 1.1.12-alpha.9 → 1.1.13-alpha.0

package/dist/index.cjs

@@ -32,6 +32,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  AutoTrace: () => import_nestjs_common5.AutoTrace,
   CsrfMiddleware: () => CsrfMiddleware,
   CsrfTokenMiddleware: () => CsrfTokenMiddleware,
   DevToolsModule: () => import_nestjs_openapi_devtools2.DevToolsModule,
@@ -172,10 +173,47 @@ var import_common3 = require("@nestjs/common");
 var import_nestjs_common = require("@lark-apaas/nestjs-common");
 
 // src/utils/safe-stringify.ts
-function escapeRegExp(str) {
-  return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&").replace(/</g, "\\u003c").replace(/>/g, "\\u003e").replace(/&/g, "\\u0026").replace(/'/g, "\\'").replace(/"/g, '\\"').replace(/\r/g, "\\r").replace(/\n/g, "\\n").replace(/\u2028/g, "\\u2028").replace(/\u2029/g, "\\u2029");
+function safeEscape(s) {
+  return s.replace(/[<>&='"\n\r\u2028\u2029]/g, function(c) {
+    switch (c.charCodeAt(0)) {
+      case 60:
+        return "\\u003c";
+      // <
+      case 62:
+        return "\\u003e";
+      // >
+      case 38:
+        return "\\u0026";
+      // &
+      case 61:
+        return "\\u003d";
+      // =
+      case 39:
+        return "\\u0027";
+      // '
+      case 34:
+        return "\\u0022";
+      // "
+      case 10:
+        return "\\u000a";
+      // \n
+      case 13:
+        return "\\u000d";
+      // \r
+      // 正常来说用户无法输入这几个字符, 现代浏览器也修复了这个问题
+      // https://zhuanlan.zhihu.com/p/29958439
+      case 8232:
+        return "\\u2028";
+      // 行分隔符
+      case 8233:
+        return "\\u2029";
+      // 段落分隔符
+      default:
+        return c;
+    }
+  });
 }
-__name(escapeRegExp, "escapeRegExp");
+__name(safeEscape, "safeEscape");
 
 // src/middlewares/view-context/index.ts
 function _ts_decorate3(decorators, target, key, desc) {
@@ -228,14 +266,13 @@ var ViewContextMiddleware = class _ViewContextMiddleware {
     const { userId, tenantId, appId } = req.userContext;
     const csrfToken = req.csrfToken;
     const appInfo = await this.getAppInfo(appId);
-    this.logger.debug(`appInfo: ${JSON.stringify(appInfo)}`);
     req.__platform_data__ = {
       csrfToken: csrfToken ?? "",
       userId: userId ?? "",
       appId: appId ?? "",
-      appName: escapeRegExp(appInfo?.app_name ?? "\u5999\u642D\u5E94\u7528"),
+      appName: safeEscape(appInfo?.app_name ?? "\u5999\u642D\u5E94\u7528"),
       appAvatar: appInfo?.app_avatar ?? "",
-      appDescription: escapeRegExp(appInfo?.app_description ?? ""),
+      appDescription: safeEscape(appInfo?.app_description ?? ""),
       tenantId
     };
     res.locals = {
@@ -244,9 +281,9 @@ var ViewContextMiddleware = class _ViewContextMiddleware {
       userId: userId ?? "",
       tenantId: tenantId ?? "",
       appId: appId ?? "",
-      appName: escapeRegExp(appInfo?.app_name ?? "\u5999\u642D\u5E94\u7528"),
+      appName: safeEscape(appInfo?.app_name ?? "\u5999\u642D\u5E94\u7528"),
       appAvatar: appInfo?.app_avatar ?? "",
-      appDescription: escapeRegExp(appInfo?.app_description ?? "")
+      appDescription: safeEscape(appInfo?.app_description ?? "")
     };
     next();
   }
@@ -436,26 +473,30 @@ var HttpInterceptorService = class {
   setupInterceptors() {
     const axiosInstance = this.httpService.axiosRef;
     axiosInstance.interceptors.request.use((config) => {
-      this.logger.log("HTTP Request", {
-        method: config.method?.toUpperCase(),
-        url: config.url,
-        headers: config.headers,
-        params: config.params,
-        data: config.data
-      }, "HttpService");
+      if (process.env.NODE_ENV === "development") {
+        this.logger.log("HTTP Request", {
+          method: config.method?.toUpperCase(),
+          url: config.url,
+          headers: config.headers,
+          params: config.params,
+          data: config.data
+        }, "HttpService");
+      }
       return config;
     }, (error) => {
       this.logger.error("HTTP Request Error", error, "HttpService");
       return Promise.reject(error);
     });
     axiosInstance.interceptors.response.use((response) => {
-      this.logger.log("HTTP Response", {
-        method: response.config.method?.toUpperCase(),
-        url: response.config.url,
-        status: response.status,
-        statusText: response.statusText,
-        data: response.data
-      }, "HttpService");
+      if (process.env.NODE_ENV === "development") {
+        this.logger.log("HTTP Response", {
+          method: response.config.method?.toUpperCase(),
+          url: response.config.url,
+          status: response.status,
+          statusText: response.statusText,
+          data: response.data
+        }, "HttpService");
+      }
       return response;
     }, (error) => {
       this.logger.error("HTTP Response Error", {
@@ -698,14 +739,14 @@ var PlatformHttpClientService = class _PlatformHttpClientService {
   */
   registerGlobalInterceptors() {
     this.client.interceptors.request.use((config) => {
-      this.logger.log(`HTTP Request: ${config.method?.toUpperCase()} ${config.url}`);
+      this.logger.debug(`Server SDK HTTP Request: ${config.method?.toUpperCase()} ${config.url}`);
       return config;
     }, (error) => {
-      this.logger.error("HTTP Request Error", error, "HttpService");
+      this.logger.error("Server SDK HTTP Request Error", error, "HttpService");
       return Promise.reject(error);
     });
     this.client.interceptors.response.use((response) => {
-      this.logger.log(`HTTP Response: ${response.status} ${response.url}`);
+      this.logger.debug(`Server SDK HTTP Response: ${response.status} ${response.url}`);
       return response;
     }, (error) => {
       const errorLog = {
@@ -713,7 +754,7 @@ var PlatformHttpClientService = class _PlatformHttpClientService {
         statusText: error.response?.statusText,
         message: error.message
       };
-      this.logger.error(`HTTP Response Error: ${error.config?.method?.toUpperCase()} ${error.config?.url} ${JSON.stringify(errorLog)}`);
+      this.logger.error(`Server SDK HTTP Response Error: ${error.config?.method?.toUpperCase()} ${error.config?.url} ${JSON.stringify(errorLog)}`);
       return Promise.reject(error);
     });
   }
@@ -779,10 +820,12 @@ var PlatformModule = class _PlatformModule {
               const appLogger = args[1];
               const drizzleLogger = {
                 logQuery(query, params) {
-                  appLogger.log?.("SQL Query " + JSON.stringify({
-                    query,
-                    params
-                  }), "Database");
+                  if (process.env.NODE_ENV === "development") {
+                    appLogger.log?.("SQL Query " + JSON.stringify({
+                      query,
+                      params
+                    }), "Database");
+                  }
                 }
               };
               return {
@@ -821,7 +864,11 @@ var PlatformModule = class _PlatformModule {
             PlatformHttpClientService
           ]
         },
-        HttpInterceptorService
+        HttpInterceptorService,
+        {
+          provide: import_core2.APP_INTERCEPTOR,
+          useClass: import_nestjs_observable.TraceInterceptor
+        }
       ],
       exports: [
         import_config2.ConfigModule,
@@ -841,7 +888,9 @@ var PlatformModule = class _PlatformModule {
     if (process.env.NODE_ENV === "development") {
       consumer.apply(FrameworkDebugMiddleware).forRoutes("/api/__framework__/debug");
     }
-    consumer.apply(UserContextMiddleware, RequestContextMiddleware, import_nestjs_logger2.LoggerContextMiddleware, import_nestjs_datapaas.SqlExecutionContextMiddleware).forRoutes("/*");
+    consumer.apply(UserContextMiddleware, RequestContextMiddleware, import_nestjs_logger2.LoggerContextMiddleware, import_nestjs_observable.ObservableTraceMiddleware, ...DISABLE_DATAPASS ? [] : [
+      import_nestjs_datapaas.SqlExecutionContextMiddleware
+    ]).forRoutes("/*");
     consumer.apply(CsrfTokenMiddleware, ViewContextMiddleware).exclude("/api/(.*)").forRoutes("*");
     if (options.enableCsrf !== false) {
       const csrfRoutes = options.csrfRoutes || "/api/*";
@@ -885,6 +934,7 @@ async function configureApp(app, perms = defaultPerms) {
       console.error("[OpenAPI] OpenAPI \u751F\u6210\u5931\u8D25:", err);
     }
   }
+  console.log("App Started Successfully.");
 }
 __name(configureApp, "configureApp");
 
@@ -894,8 +944,10 @@ __reExport(index_exports, require("@lark-apaas/nestjs-authnpaas"), module.export
 __reExport(index_exports, require("@lark-apaas/nestjs-datapaas"), module.exports);
 __reExport(index_exports, require("@lark-apaas/nestjs-observable"), module.exports);
 __reExport(index_exports, require("@lark-apaas/nestjs-trigger"), module.exports);
+var import_nestjs_common5 = require("@lark-apaas/nestjs-common");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  AutoTrace,
   CsrfMiddleware,
   CsrfTokenMiddleware,
   DevToolsModule,

package/dist/index.d.cts

@@ -4,6 +4,7 @@ import { NestExpressApplication } from '@nestjs/platform-express';
 export { DevToolsModule, DevToolsOptions, DevToolsV2Module, DevToolsV2Options } from '@lark-apaas/nestjs-openapi-devtools';
 import { Request, Response, NextFunction } from 'express';
 import { PlatformHttpClient } from '@lark-apaas/nestjs-common';
+export { AutoTrace } from '@lark-apaas/nestjs-common';
 export * from '@lark-apaas/nestjs-authnpaas';
 export * from '@lark-apaas/nestjs-datapaas';
 export * from '@lark-apaas/nestjs-observable';

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { NestExpressApplication } from '@nestjs/platform-express';
 export { DevToolsModule, DevToolsOptions, DevToolsV2Module, DevToolsV2Options } from '@lark-apaas/nestjs-openapi-devtools';
 import { Request, Response, NextFunction } from 'express';
 import { PlatformHttpClient } from '@lark-apaas/nestjs-common';
+export { AutoTrace } from '@lark-apaas/nestjs-common';
 export * from '@lark-apaas/nestjs-authnpaas';
 export * from '@lark-apaas/nestjs-datapaas';
 export * from '@lark-apaas/nestjs-observable';

package/dist/index.js

@@ -3,10 +3,10 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
 
 // src/modules/platform/module.ts
 import { Global, Module, ValidationPipe } from "@nestjs/common";
-import { APP_PIPE } from "@nestjs/core";
+import { APP_INTERCEPTOR, APP_PIPE } from "@nestjs/core";
 import { CommonModule, OBSERVABLE_SERVICE } from "@lark-apaas/nestjs-common";
 import { ConfigModule, ConfigService } from "@nestjs/config";
-import { NestjsObservableModule as ObservableModule, Observable } from "@lark-apaas/nestjs-observable";
+import { NestjsObservableModule as ObservableModule, Observable, ObservableTraceMiddleware, TraceInterceptor } from "@lark-apaas/nestjs-observable";
 import { HttpModule } from "@nestjs/axios";
 import { LoggerModule, AppLogger as AppLogger2, LoggerContextMiddleware } from "@lark-apaas/nestjs-logger";
 import { DataPaasModule, SqlExecutionContextMiddleware } from "@lark-apaas/nestjs-datapaas";
@@ -130,10 +130,47 @@ import { Inject, Injectable as Injectable3, Logger } from "@nestjs/common";
 import { PLATFORM_HTTP_CLIENT } from "@lark-apaas/nestjs-common";
 
 // src/utils/safe-stringify.ts
-function escapeRegExp(str) {
-  return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&").replace(/</g, "\\u003c").replace(/>/g, "\\u003e").replace(/&/g, "\\u0026").replace(/'/g, "\\'").replace(/"/g, '\\"').replace(/\r/g, "\\r").replace(/\n/g, "\\n").replace(/\u2028/g, "\\u2028").replace(/\u2029/g, "\\u2029");
+function safeEscape(s) {
+  return s.replace(/[<>&='"\n\r\u2028\u2029]/g, function(c) {
+    switch (c.charCodeAt(0)) {
+      case 60:
+        return "\\u003c";
+      // <
+      case 62:
+        return "\\u003e";
+      // >
+      case 38:
+        return "\\u0026";
+      // &
+      case 61:
+        return "\\u003d";
+      // =
+      case 39:
+        return "\\u0027";
+      // '
+      case 34:
+        return "\\u0022";
+      // "
+      case 10:
+        return "\\u000a";
+      // \n
+      case 13:
+        return "\\u000d";
+      // \r
+      // 正常来说用户无法输入这几个字符, 现代浏览器也修复了这个问题
+      // https://zhuanlan.zhihu.com/p/29958439
+      case 8232:
+        return "\\u2028";
+      // 行分隔符
+      case 8233:
+        return "\\u2029";
+      // 段落分隔符
+      default:
+        return c;
+    }
+  });
 }
-__name(escapeRegExp, "escapeRegExp");
+__name(safeEscape, "safeEscape");
 
 // src/middlewares/view-context/index.ts
 function _ts_decorate3(decorators, target, key, desc) {
@@ -186,14 +223,13 @@ var ViewContextMiddleware = class _ViewContextMiddleware {
     const { userId, tenantId, appId } = req.userContext;
     const csrfToken = req.csrfToken;
     const appInfo = await this.getAppInfo(appId);
-    this.logger.debug(`appInfo: ${JSON.stringify(appInfo)}`);
     req.__platform_data__ = {
       csrfToken: csrfToken ?? "",
       userId: userId ?? "",
       appId: appId ?? "",
-      appName: escapeRegExp(appInfo?.app_name ?? "\u5999\u642D\u5E94\u7528"),
+      appName: safeEscape(appInfo?.app_name ?? "\u5999\u642D\u5E94\u7528"),
       appAvatar: appInfo?.app_avatar ?? "",
-      appDescription: escapeRegExp(appInfo?.app_description ?? ""),
+      appDescription: safeEscape(appInfo?.app_description ?? ""),
       tenantId
     };
     res.locals = {
@@ -202,9 +238,9 @@ var ViewContextMiddleware = class _ViewContextMiddleware {
       userId: userId ?? "",
       tenantId: tenantId ?? "",
       appId: appId ?? "",
-      appName: escapeRegExp(appInfo?.app_name ?? "\u5999\u642D\u5E94\u7528"),
+      appName: safeEscape(appInfo?.app_name ?? "\u5999\u642D\u5E94\u7528"),
       appAvatar: appInfo?.app_avatar ?? "",
-      appDescription: escapeRegExp(appInfo?.app_description ?? "")
+      appDescription: safeEscape(appInfo?.app_description ?? "")
     };
     next();
   }
@@ -394,26 +430,30 @@ var HttpInterceptorService = class {
   setupInterceptors() {
     const axiosInstance = this.httpService.axiosRef;
     axiosInstance.interceptors.request.use((config) => {
-      this.logger.log("HTTP Request", {
-        method: config.method?.toUpperCase(),
-        url: config.url,
-        headers: config.headers,
-        params: config.params,
-        data: config.data
-      }, "HttpService");
+      if (process.env.NODE_ENV === "development") {
+        this.logger.log("HTTP Request", {
+          method: config.method?.toUpperCase(),
+          url: config.url,
+          headers: config.headers,
+          params: config.params,
+          data: config.data
+        }, "HttpService");
+      }
       return config;
     }, (error) => {
       this.logger.error("HTTP Request Error", error, "HttpService");
       return Promise.reject(error);
     });
     axiosInstance.interceptors.response.use((response) => {
-      this.logger.log("HTTP Response", {
-        method: response.config.method?.toUpperCase(),
-        url: response.config.url,
-        status: response.status,
-        statusText: response.statusText,
-        data: response.data
-      }, "HttpService");
+      if (process.env.NODE_ENV === "development") {
+        this.logger.log("HTTP Response", {
+          method: response.config.method?.toUpperCase(),
+          url: response.config.url,
+          status: response.status,
+          statusText: response.statusText,
+          data: response.data
+        }, "HttpService");
+      }
       return response;
     }, (error) => {
       this.logger.error("HTTP Response Error", {
@@ -656,14 +696,14 @@ var PlatformHttpClientService = class _PlatformHttpClientService {
   */
   registerGlobalInterceptors() {
     this.client.interceptors.request.use((config) => {
-      this.logger.log(`HTTP Request: ${config.method?.toUpperCase()} ${config.url}`);
+      this.logger.debug(`Server SDK HTTP Request: ${config.method?.toUpperCase()} ${config.url}`);
       return config;
     }, (error) => {
-      this.logger.error("HTTP Request Error", error, "HttpService");
+      this.logger.error("Server SDK HTTP Request Error", error, "HttpService");
       return Promise.reject(error);
     });
     this.client.interceptors.response.use((response) => {
-      this.logger.log(`HTTP Response: ${response.status} ${response.url}`);
+      this.logger.debug(`Server SDK HTTP Response: ${response.status} ${response.url}`);
       return response;
     }, (error) => {
       const errorLog = {
@@ -671,7 +711,7 @@ var PlatformHttpClientService = class _PlatformHttpClientService {
         statusText: error.response?.statusText,
         message: error.message
       };
-      this.logger.error(`HTTP Response Error: ${error.config?.method?.toUpperCase()} ${error.config?.url} ${JSON.stringify(errorLog)}`);
+      this.logger.error(`Server SDK HTTP Response Error: ${error.config?.method?.toUpperCase()} ${error.config?.url} ${JSON.stringify(errorLog)}`);
       return Promise.reject(error);
     });
   }
@@ -737,10 +777,12 @@ var PlatformModule = class _PlatformModule {
               const appLogger = args[1];
               const drizzleLogger = {
                 logQuery(query, params) {
-                  appLogger.log?.("SQL Query " + JSON.stringify({
-                    query,
-                    params
-                  }), "Database");
+                  if (process.env.NODE_ENV === "development") {
+                    appLogger.log?.("SQL Query " + JSON.stringify({
+                      query,
+                      params
+                    }), "Database");
+                  }
                 }
               };
               return {
@@ -779,7 +821,11 @@ var PlatformModule = class _PlatformModule {
             PlatformHttpClientService
           ]
         },
-        HttpInterceptorService
+        HttpInterceptorService,
+        {
+          provide: APP_INTERCEPTOR,
+          useClass: TraceInterceptor
+        }
       ],
       exports: [
         ConfigModule,
@@ -799,7 +845,9 @@ var PlatformModule = class _PlatformModule {
     if (process.env.NODE_ENV === "development") {
       consumer.apply(FrameworkDebugMiddleware).forRoutes("/api/__framework__/debug");
     }
-    consumer.apply(UserContextMiddleware, RequestContextMiddleware, LoggerContextMiddleware, SqlExecutionContextMiddleware).forRoutes("/*");
+    consumer.apply(UserContextMiddleware, RequestContextMiddleware, LoggerContextMiddleware, ObservableTraceMiddleware, ...DISABLE_DATAPASS ? [] : [
+      SqlExecutionContextMiddleware
+    ]).forRoutes("/*");
     consumer.apply(CsrfTokenMiddleware, ViewContextMiddleware).exclude("/api/(.*)").forRoutes("*");
     if (options.enableCsrf !== false) {
       const csrfRoutes = options.csrfRoutes || "/api/*";
@@ -843,6 +891,7 @@ async function configureApp(app, perms = defaultPerms) {
       console.error("[OpenAPI] OpenAPI \u751F\u6210\u5931\u8D25:", err);
     }
   }
+  console.log("App Started Successfully.");
 }
 __name(configureApp, "configureApp");
 
@@ -852,7 +901,9 @@ export * from "@lark-apaas/nestjs-authnpaas";
 export * from "@lark-apaas/nestjs-datapaas";
 export * from "@lark-apaas/nestjs-observable";
 export * from "@lark-apaas/nestjs-trigger";
+import { AutoTrace } from "@lark-apaas/nestjs-common";
 export {
+  AutoTrace,
   CsrfMiddleware,
   CsrfTokenMiddleware,
   DevToolsModule,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/fullstack-nestjs-core",
-  "version": "1.1.12-alpha.9",
+  "version": "1.1.13-alpha.0",
   "description": "FullStack Nestjs Core",
   "type": "module",
   "main": "./dist/index.js",
@@ -39,12 +39,12 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@lark-apaas/http-client": "0.1.2",
+    "@lark-apaas/http-client": "^0.1.2",
     "@lark-apaas/nestjs-authnpaas": "^1.0.2",
-    "@lark-apaas/nestjs-common": "^0.1.0",
+    "@lark-apaas/nestjs-common": "^0.1.1",
     "@lark-apaas/nestjs-datapaas": "^1.0.7",
-    "@lark-apaas/nestjs-logger": "^1.0.4",
-    "@lark-apaas/nestjs-observable": "^0.0.1",
+    "@lark-apaas/nestjs-logger": "^1.0.5",
+    "@lark-apaas/nestjs-observable": "^0.0.2",
     "@lark-apaas/nestjs-openapi-devtools": "^1.0.9",
     "@lark-apaas/nestjs-trigger": "^0.0.1",
     "@nestjs/axios": "^4.0.1",
@@ -57,7 +57,6 @@
     "@nestjs/swagger": "^7.4.2",
     "@types/cookie-parser": "^1.4.9",
     "@types/express": "^5.0.3",
-    "@types/serialize-javascript": "^5.0.4",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.2",
     "drizzle-orm": "0.44.6",