@jayfong/x-server 2.57.1 → 2.58.1

package/lib/_cjs/core/ctx_storage.js

@@ -0,0 +1,6 @@
+"use strict";
+
+exports.__esModule = true;
+exports.ctxStorage = void 0;
+var _nodeAsync_hooks = require("node:async_hooks");
+const ctxStorage = exports.ctxStorage = new _nodeAsync_hooks.AsyncLocalStorage();

package/lib/_cjs/core/handler.js

@@ -10,6 +10,7 @@ var vae = _interopRequireWildcard(require("vtils/vae"));
 var _validator = require("vtils/validator");
 var _http_error = require("../core/http_error");
 var _dispose = require("../services/dispose");
+var _ctx_storage = require("./ctx_storage");
 var _http_redirect = require("./http_redirect");
 var _server = require("./server");
 _validator.yup.setLocale((0, _validator.getZhCN)({
@@ -25,10 +26,11 @@ class Handler {
       if (Handler.hooks.length) {
         await Promise.all(Handler.hooks.map(hook => hook(this.options, data, ctx)));
       }
+      ctx.setHeader('x-trace-id', ctx.traceId);
       if (this.options.requestMethod === 'WS') {
-        return this.handleWs(data, ctx);
+        return _ctx_storage.ctxStorage.run(ctx, () => this.handleWs(data, ctx));
       }
-      return this.handleHttp(data, ctx);
+      return _ctx_storage.ctxStorage.run(ctx, () => this.handleHttp(data, ctx));
     };
     this.handleHttp = async (data, ctx) => {
       // 请求数据解析

package/lib/_cjs/core/server.js

@@ -7,7 +7,8 @@ var _interopRequireWildcard2 = _interopRequireDefault(require("@babel/runtime/he
 var _nodeProcess = _interopRequireDefault(require("node:process"));
 var _fastify = _interopRequireDefault(require("fastify"));
 var _vtils = require("vtils");
-var _x = require("../x");
+var _x = require("vtils/x");
+var _x2 = require("../x");
 var _http_error = require("./http_error");
 var _http_method = require("./http_method");
 class Server {
@@ -66,7 +67,7 @@ class Server {
     await Promise.resolve().then(() => (0, _interopRequireWildcard2.default)(require('.x/hooks')));
   }
   applyServices() {
-    _x.x.register(...(this.options.services || []));
+    _x2.x.register(...(this.options.services || []));
   }
   applyPlugins() {
     const plugins = this.options.plugins || [];
@@ -76,7 +77,7 @@ class Server {
   }
   async applyRoutes() {
     await this.fastify.register(async fastify => {
-      const appUrl = _x.x.env.APP_URL.replace(/\/+$/, '');
+      const appUrl = _x2.x.env.APP_URL.replace(/\/+$/, '');
       const routeMap = (0, _vtils.keyBy)(this.routes, item => item.path);
       const handleRoute = async (item, req, res, path) => {
         const handlerOptions = item.handler.options;
@@ -86,6 +87,7 @@ class Server {
         path != null ? path : isWS ? res.url : req.url}`;
         if (isWS) {
           await item.handler.handle(undefined, {
+            traceId: (0, _x.cuid2)(),
             url: url,
             headers: res.headers,
             setHeader: _vtils.noop,
@@ -113,6 +115,7 @@ class Server {
           ...req.body,
           ...files
         }, {
+          traceId: (0, _x.cuid2)(),
           url,
           headers: req.headers,
           setHeader: (k, v) => res.header(k, v),
@@ -168,11 +171,11 @@ class Server {
         url: '/$',
         handler: async req => {
           const payload = req.body;
-          if (payload && typeof payload === 'object' && _x.x.env.APP_TOKEN && payload.token === _x.x.env.APP_TOKEN) {
+          if (payload && typeof payload === 'object' && _x2.x.env.APP_TOKEN && payload.token === _x2.x.env.APP_TOKEN) {
             if (payload.type === 'ping') {
               return 'ping:success';
             } else if (payload.type === 'updateEnv') {
-              Object.assign(_x.x.env, payload.data);
+              Object.assign(_x2.x.env, payload.data);
 
               // 更新静态文件服务
               this.applyStatic();
@@ -183,8 +186,8 @@ class Server {
     });
   }
   async applyStatic() {
-    if (Array.isArray(_x.x.env.APP_STATIC_CONTENT)) {
-      const staticContent = _x.x.env.APP_STATIC_CONTENT;
+    if (Array.isArray(_x2.x.env.APP_STATIC_CONTENT)) {
+      const staticContent = _x2.x.env.APP_STATIC_CONTENT;
       for (const item of staticContent) {
         if (!item.method) {
           item.method = 'GET';
@@ -212,7 +215,7 @@ class Server {
     await Promise.resolve().then(() => (0, _interopRequireWildcard2.default)(require('.x/crons')));
   }
   async applyAutoClose() {
-    _x.x.dispose.add(() => this.close());
+    _x2.x.dispose.add(() => this.close());
   }
 }
 exports.Server = Server;

package/lib/_cjs/plugins/cors.js

@@ -30,6 +30,7 @@ class CorsPlugin {
     fastify.register(_cors.default, {
       origin: (origin, cb) => allowAll ? cb(null, true) : cb(null, origin ? check(origin) : true),
       maxAge: (0, _vtils.ms)(this.options.ttl, true),
+      exposedHeaders: ['x-trace-id'],
       ...(0, _vtils.omitStrict)(this.options, ['allow', 'ttl'])
     });
   }

package/lib/_cjs/services/log.js

@@ -74,9 +74,15 @@ class LogService {
     return this.getLogFile(new Date());
   }
   parseLogLineText(text, keysMap = {}) {
-    const [time, level, title, ...desc] = text.split(/\t+/);
+    const segments = text.split(/\t+/);
+    // 没有 traceId 的注入一下
+    if (segments[1].length < 10) {
+      segments.splice(1, 0, '');
+    }
+    const [time, traceId, level, title, ...desc] = segments;
     return {
       time: time,
+      traceId: traceId,
       level: level,
       title: title,
       desc: desc.reduce((res, item, index) => {
@@ -91,7 +97,7 @@ class LogService {
     };
   }
   log(payload) {
-    const getContent = () => `${[(0, _date.formatDate)(new Date(), 'yyyy-mm-dd hh:ii:ss'), payload.level, payload.title, ...(!payload.desc ? [] : Array.isArray(payload.desc) ? payload.desc : Object.keys(payload.desc).map(key => `${key}:${payload.desc[key]}`))].map(item => String(item).replace(/[\r\n\t]+/g, ' ')).join('\t')}`;
+    const getContent = () => `${[(0, _date.formatDate)(new Date(), 'yyyy-mm-dd hh:ii:ss'), ...(!_x.x.ctx ? [] : [_x.x.ctx.traceId]), payload.level, payload.title, ...(!payload.desc ? [] : Array.isArray(payload.desc) ? payload.desc : Object.keys(payload.desc).map(key => `${key}:${payload.desc[key]}`))].map(item => String(item).replace(/[\r\n\t]+/g, ' ')).join('\t')}`;
     if (payload.writer === 'console') {
       console[payload.level === 'error' ? 'error' : 'log'](getContent());
     } else {

package/lib/_cjs/x.js

@@ -6,6 +6,7 @@ exports.x = void 0;
 var _os = _interopRequireDefault(require("os"));
 var _path = _interopRequireDefault(require("path"));
 var _fsExtra = _interopRequireDefault(require("fs-extra"));
+var _ctx_storage = require("./core/ctx_storage");
 var _db_value = require("./services/db_value");
 var _dispose = require("./services/dispose");
 var _emoji = require("./services/emoji");
@@ -15,6 +16,9 @@ const x = exports.x = {
   appId: env.APP_ID,
   env: env,
   dataDir: _path.default.join(_os.default.homedir(), `.xs/${env.APP_ID}`),
+  get ctx() {
+    return _ctx_storage.ctxStorage.getStore();
+  },
   register: (...services) => {
     for (const service of services) {
       // @ts-ignore

package/lib/core/ctx_storage.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { XHandler } from './types';
+export declare const ctxStorage: AsyncLocalStorage<XHandler.Context>;

package/lib/core/ctx_storage.js

@@ -0,0 +1,2 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+export const ctxStorage = new AsyncLocalStorage();

package/lib/core/handler.js

@@ -4,6 +4,7 @@ import * as vae from 'vtils/vae';
 import { getZhCN, yup } from 'vtils/validator';
 import { HttpError } from "../core/http_error";
 import { DisposeService } from "../services/dispose";
+import { ctxStorage } from "./ctx_storage";
 import { HttpRedirect } from "./http_redirect";
 import { Server } from "./server";
 yup.setLocale(getZhCN({
@@ -19,10 +20,11 @@ export class Handler {
       if (Handler.hooks.length) {
         await Promise.all(Handler.hooks.map(hook => hook(this.options, data, ctx)));
       }
+      ctx.setHeader('x-trace-id', ctx.traceId);
       if (this.options.requestMethod === 'WS') {
-        return this.handleWs(data, ctx);
+        return ctxStorage.run(ctx, () => this.handleWs(data, ctx));
       }
-      return this.handleHttp(data, ctx);
+      return ctxStorage.run(ctx, () => this.handleHttp(data, ctx));
     };
     this.handleHttp = async (data, ctx) => {
       // 请求数据解析

package/lib/core/server.js

@@ -1,6 +1,7 @@
 import process from 'node:process';
 import Fastify from 'fastify';
 import { base64UrlDecode, castArray, keyBy, noop, rot13 } from 'vtils';
+import { cuid2 } from 'vtils/x';
 import { x } from "../x";
 import { HttpError } from "./http_error";
 import { HandlerMethodToHttpMethod } from "./http_method";
@@ -80,6 +81,7 @@ export class Server {
         path != null ? path : isWS ? res.url : req.url}`;
         if (isWS) {
           await item.handler.handle(undefined, {
+            traceId: cuid2(),
             url: url,
             headers: res.headers,
             setHeader: noop,
@@ -107,6 +109,7 @@ export class Server {
           ...req.body,
           ...files
         }, {
+          traceId: cuid2(),
           url,
           headers: req.headers,
           setHeader: (k, v) => res.header(k, v),

package/lib/core/types.d.ts

@@ -63,6 +63,10 @@ export declare namespace XHandler {
     interface ExtraContext {
     }
     interface Context extends ExtraContext {
+        /**
+         * 当前请求的跟踪 ID
+         */
+        traceId: string;
         /**
          * 当前请求的地址
          */

package/lib/plugins/cors.js

@@ -26,6 +26,7 @@ export class CorsPlugin {
     fastify.register(FastifyCors, {
       origin: (origin, cb) => allowAll ? cb(null, true) : cb(null, origin ? check(origin) : true),
       maxAge: ms(this.options.ttl, true),
+      exposedHeaders: ['x-trace-id'],
       ...omitStrict(this.options, ['allow', 'ttl'])
     });
   }

package/lib/services/log.d.ts

@@ -10,6 +10,7 @@ export type LogServicePayload = {
     desc?: LogServiceDesc;
 };
 export type LogServiceLogItem<K extends string = string> = Merge<LogServicePayload, {
+    traceId: string;
     time: string;
     desc: Record<K, any>;
 }>;

package/lib/services/log.js

@@ -69,9 +69,15 @@ export class LogService {
     return this.getLogFile(new Date());
   }
   parseLogLineText(text, keysMap = {}) {
-    const [time, level, title, ...desc] = text.split(/\t+/);
+    const segments = text.split(/\t+/);
+    // 没有 traceId 的注入一下
+    if (segments[1].length < 10) {
+      segments.splice(1, 0, '');
+    }
+    const [time, traceId, level, title, ...desc] = segments;
     return {
       time: time,
+      traceId: traceId,
       level: level,
       title: title,
       desc: desc.reduce((res, item, index) => {
@@ -86,7 +92,7 @@ export class LogService {
     };
   }
   log(payload) {
-    const getContent = () => `${[formatDate(new Date(), 'yyyy-mm-dd hh:ii:ss'), payload.level, payload.title, ...(!payload.desc ? [] : Array.isArray(payload.desc) ? payload.desc : Object.keys(payload.desc).map(key => `${key}:${payload.desc[key]}`))].map(item => String(item).replace(/[\r\n\t]+/g, ' ')).join('\t')}`;
+    const getContent = () => `${[formatDate(new Date(), 'yyyy-mm-dd hh:ii:ss'), ...(!x.ctx ? [] : [x.ctx.traceId]), payload.level, payload.title, ...(!payload.desc ? [] : Array.isArray(payload.desc) ? payload.desc : Object.keys(payload.desc).map(key => `${key}:${payload.desc[key]}`))].map(item => String(item).replace(/[\r\n\t]+/g, ' ')).join('\t')}`;
     if (payload.writer === 'console') {
       console[payload.level === 'error' ? 'error' : 'log'](getContent());
     } else {

package/lib/x.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { XHandler } from './core/types';
 import { BaseService } from './services/base';
 import './services/db_value';
 import './services/dispose';
@@ -8,6 +9,7 @@ export interface X {
     readonly appId: string;
     readonly env: NodeJS.ProcessEnv;
     readonly dataDir: string;
+    readonly ctx: XHandler.Context;
     readonly register: (...services: BaseService[]) => void;
 }
 export declare const x: X;

package/lib/x.js

@@ -1,6 +1,7 @@
 import os from 'os';
 import path from 'path';
 import fs from 'fs-extra';
+import { ctxStorage } from "./core/ctx_storage";
 import { DbValueService } from "./services/db_value";
 import { DisposeService } from "./services/dispose";
 import { EmojiService } from "./services/emoji";
@@ -10,6 +11,9 @@ export const x = {
   appId: env.APP_ID,
   env: env,
   dataDir: path.join(os.homedir(), `.xs/${env.APP_ID}`),
+  get ctx() {
+    return ctxStorage.getStore();
+  },
   register: (...services) => {
     for (const service of services) {
       // @ts-ignore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayfong/x-server",
-  "version": "2.57.1",
+  "version": "2.58.1",
   "license": "ISC",
   "sideEffects": false,
   "main": "lib/_cjs/index.js",