@x-9lab/xlab 1.6.1 → 2.0.1

package/dist/server.js

@@ -2,120 +2,229 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-exports.default = exports.exit = exports.boot = exports.app = void 0;
-require("./global");
-require("./init-env");
-var _log = require("./components/log");
-var _cron = require("./components/cron");
-var _defaultXConfig = _interopRequireDefault(require("./default-x-config"));
-var _dotFile = require("./dot-file");
-var _koaStatic = _interopRequireDefault(require("koa-static"));
-var _koaRouter = _interopRequireDefault(require("koa-router"));
-var _path = _interopRequireDefault(require("path"));
-var _koa = _interopRequireDefault(require("koa"));
-var _config = _interopRequireWildcard(require("./config"));
-var _custom = _interopRequireDefault(require("./custom"));
-var _router = _interopRequireDefault(require("./router"));
-var _cluster = _interopRequireDefault(require("./cluster"));
-var _middlewares = _interopRequireDefault(require("./middlewares"));
-var _badRequest = _interopRequireDefault(require("./middleware/bad-request"));
-function _interopRequireDefault(obj) {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get app () {
+        return app;
+    },
+    get boot () {
+        return boot;
+    },
+    get default () {
+        return _default;
+    },
+    get exit () {
+        return exit;
+    },
+    get getApp () {
+        return getApp;
+    },
+    get shutdown () {
+        return shutdown;
+    }
+});
+const _log = require("./components/log");
+const _cron = require("./components/cron");
+const _defaultxconfig = /*#__PURE__*/ _interop_require_default(require("./default-x-config"));
+const _dotfile = require("./dot-file");
+const _config = /*#__PURE__*/ _interop_require_wildcard(require("./config"));
+const _custom = require("./custom");
+const _initenv = /*#__PURE__*/ _interop_require_default(require("./init-env"));
+const _cluster = /*#__PURE__*/ _interop_require_wildcard(require("./cluster"));
+const _router = /*#__PURE__*/ _interop_require_default(require("./router"));
+const _middlewares = /*#__PURE__*/ _interop_require_default(require("./middlewares"));
+const _badrequest = /*#__PURE__*/ _interop_require_default(require("./middleware/bad-request"));
+const _utils = require("@x-drive/utils");
+const _koastatic = /*#__PURE__*/ _interop_require_default(require("koa-static"));
+const _koarouter = /*#__PURE__*/ _interop_require_default(require("koa-router"));
+const _path = /*#__PURE__*/ _interop_require_default(require("path"));
+const _koa = /*#__PURE__*/ _interop_require_default(require("koa"));
+function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
 }
-function _interopRequireWildcard(obj) {
-    if (obj && obj.__esModule) {
-        return obj;
-    } else {
-        var newObj = {};
-        if (obj != null) {
-            for(var key in obj){
-                if (Object.prototype.hasOwnProperty.call(obj, key)) {
-                    var desc = Object.defineProperty && Object.getOwnPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : {};
-                    if (desc.get || desc.set) {
-                        Object.defineProperty(newObj, key, desc);
-                    } else {
-                        newObj[key] = obj[key];
-                    }
-                }
-            }
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interop_require_wildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) return obj;
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") return {
+        default: obj
+    };
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) return cache.get(obj);
+    var newObj = {
+        __proto__: null
+    };
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) Object.defineProperty(newObj, key, desc);
+            else newObj[key] = obj[key];
         }
-        newObj.default = obj;
-        return newObj;
     }
+    newObj.default = obj;
+    if (cache) cache.set(obj, newObj);
+    return newObj;
 }
-process.env.TZ = _config.default.timezone;
 const logger = _log.globalLog.getLogger("system");
-(0, _dotFile).processDotFile(_config.default.env, logger);
-// 只在 master 上输出的日志
-global.masterLog = _config.log;
-// 服务实例
-const app = new _koa.default();
-/**
- * 获取应用实例对象
- * @deprecated v1.7.0 后将弃用，请直接从模块中引用
- * @return 实例对象
- */ global.getApp = function() {
-    return app;
-};
+/**服务实例 */ const app = new _koa.default();
 // 不输出X-Powered-By
 // @ts-ignore
 app.poweredBy = false;
-if (_config.default.custom) {
-    // 自定义初始化业务
-    (0, _custom).default();
+/**
+ * 获取应用实例对象
+ * @return 实例对象
+ */ function getApp() {
+    return app;
 }
-// 加载中间件
-(0, _middlewares).default(app);
-const koaRouter = new _koaRouter.default();
-// 路由中间件
-app.use(koaRouter.routes());
-// 具体路由
-(0, _router).default(koaRouter);
-// 静态文件服务
-var staticServeOpts = {};
-if (_config.default.isProd) {
-    staticServeOpts.maxage = _config.default.staticMaxage;
+/**http 服务实例, master fork 模式下为空 */ var server = null;
+/**是否已启动 */ var booted = false;
+/**是否正在退出 */ var shuttingDown = false;
+/**
+ * 关闭 http 服务, 等待在途请求结束, 超时强制返回
+ * @param timeout 超时时间(毫秒)
+ */ function closeServer(timeout) {
+    return new Promise(function(resolve) {
+        const timer = setTimeout(function() {
+            logger.warn(`等待在途请求结束超时(${timeout}ms), 强制关闭`);
+            resolve();
+        }, timeout);
+        server.close(function() {
+            clearTimeout(timer);
+            resolve();
+        });
+        // 主动断开空闲的 keep-alive 连接, 避免拖住 close 回调
+        if ((0, _utils.isExecutable)(server.closeIdleConnections)) {
+            server.closeIdleConnections();
+        }
+    });
 }
-staticServeOpts.setHeaders = function(res, path) {
-    if (_config.default.isProd && _config.default.staticHtmlFileMaxage && path.endsWith(".html")) {
-        res.setHeader("Cache-Control", `max-age=${_config.default.staticHtmlFileMaxage}`);
+/**
+ * 退出服务
+
+ * 停止定时任务 -> 通知 worker 退出(master) -> 等待在途请求 -> 执行 shutdown 钩子 -> 退出进程
+ * @param code 进程退出码
+ */ async function shutdown(code = 0) {
+    if (shuttingDown) {
+        return;
     }
-    if (_config.default.staticCros) {
-        const { origin  } = res.req.headers;
-        if (origin) {
-            res.setHeader("X-Cros-Static", origin);
-            res.setHeader("Access-Control-Allow-Origin", origin);
-            res.setHeader("Access-Control-Allow-Methods", "GET, OPTIONS");
+    shuttingDown = true;
+    const config = (0, _config.get)();
+    (0, _config.log)("system", `Shutting down (pid ${process.pid}) ...`);
+    try {
+        (0, _cron.kill)();
+        if (config.isMaster && config.workers) {
+            await (0, _cluster.shutdownWorkers)(config.shutdownTimeout);
         }
+        if (server) {
+            await closeServer(config.shutdownTimeout || 10 * 1000);
+        }
+        await (0, _custom.runShutdown)();
+    } catch (e) {
+        logger.error("Shutdown error:", e);
     }
-};
-app.use((0, _koaStatic).default(_path.default.resolve(process.cwd(), _config.default.root), staticServeOpts));
-// 异常状态处理中间件
-app.use(_badRequest.default);
-if (_config.default.enableCron) {
-    if (_config.default.isMaster || _config.default.enableWorkerCron) {
-        // 定时任务
-        (0, _cron).on(_path.default.resolve(process.cwd(), _defaultXConfig.default.businessDir, "cron"));
-    }
+    process.exit(code);
+}
+/**
+ * 退出服务
+ * @deprecated 请使用 shutdown
+ */ function exit() {
+    shutdown();
 }
-/**启动服务 */ function boot() {
-    (0, _cluster).default();
-    process.on("uncaughtException", (err)=>{
+/**
+ * 启动服务
+
+ * 按固定顺序执行启动阶段:
+ * initEnv -> loadConfig -> dotFile -> custom(setup) -> middleware
+ * -> router -> static/badRequest -> cron -> listen -> custom(ready)
+ */ async function boot() {
+    if (booted) {
+        return;
+    }
+    booted = true;
+    // 1. 业务环境预处理(@server/@env)
+    (0, _initenv.default)();
+    // 2. 配置装载
+    const config = (0, _config.default)();
+    process.env.TZ = config.timezone;
+    // 3. .xlab 环境数据
+    (0, _dotfile.processDotFile)(config.env, logger);
+    // 4. 自定义初始化(setup 钩子)
+    if (config.custom) {
+        await (0, _custom.loadCustom)();
+    }
+    // 5. 中间件
+    (0, _middlewares.default)(app);
+    // 6. 业务路由
+    const koaRouter = new _koarouter.default();
+    app.use(koaRouter.routes());
+    (0, _router.default)(koaRouter);
+    // 7. 静态文件服务
+    var staticServeOpts = {};
+    if (config.isProd) {
+        staticServeOpts.maxage = config.staticMaxage;
+    }
+    staticServeOpts.setHeaders = function(res, filePath) {
+        if (config.isProd && config.staticHtmlFileMaxage && filePath.endsWith(".html")) {
+            res.setHeader("Cache-Control", `max-age=${config.staticHtmlFileMaxage}`);
+        }
+        if (config.staticCros) {
+            const { origin } = res.req.headers;
+            if (origin) {
+                res.setHeader("X-Cros-Static", origin);
+                res.setHeader("Access-Control-Allow-Origin", origin);
+                res.setHeader("Access-Control-Allow-Methods", "GET, OPTIONS");
+            }
+        }
+    };
+    app.use((0, _koastatic.default)(_path.default.resolve(process.cwd(), config.root), staticServeOpts));
+    // 8. 异常状态处理中间件
+    app.use(_badrequest.default);
+    // 9. 定时任务
+    if (config.enableCron) {
+        if (config.isMaster || config.enableWorkerCron) {
+            (0, _cron.on)(_path.default.resolve(process.cwd(), _defaultxconfig.default.businessDir, "cron"));
+        }
+    }
+    // 10. 监听
+    server = (0, _cluster.default)(app);
+    // 11. 进程信号与异常处理
+    if (!config.isMaster) {
+        // master 异常退出(如被强杀)导致通道断开时, worker 自行优雅退出,
+        // 防止孤儿进程继续占用端口对外服务
+        process.on("disconnect", function() {
+            shutdown();
+        });
+    }
+    process.on("SIGTERM", function() {
+        shutdown();
+    }).on("SIGINT", function() {
+        shutdown();
+    }).on("uncaughtException", (err)=>{
         logger.error(`uncaughtException:${err.message}\n`, err.stack);
     }).on("unhandledRejection", (err)=>{
         logger.error(`unhandledRejection:${err.message}\n`, err.stack);
     });
+    // 12. ready 钩子
+    await (0, _custom.runReady)();
 }
-/**退出服务 */ function exit() {
-    process.exit();
-}
-var _default = app;
-exports.default = _default;
+const _default = app;
 if (require.main === module) {
-    boot();
+    boot().catch(function(err) {
+        logger.error("Boot failed:", err);
+        process.exit(1);
+    });
 }
-exports.app = app;
-exports.boot = boot;
-exports.exit = exit;

package/package.json

@@ -1,49 +1,45 @@
 {
     "name": "@x-9lab/xlab",
-    "version": "1.6.1",
+    "version": "2.0.1",
     "description": "9lab 服务端模块",
-    "versionDesc": "日志信息输出优化",
+    "versionDesc": "watch 退出信号级联与 worker 孤儿防护;移除 combo 中间件残留",
     "scripts": {
-        "dev": "swc src -D ./src/bin --config-file .swcrc -d dist -w",
-        "compile": "swc src -D ./src/bin --config-file .swcrc -d dist",
+        "dev": "swc src --copy-files --strip-leading-paths --config-file .swcrc -d dist -w",
+        "compile": "swc src --copy-files --strip-leading-paths --config-file .swcrc -d dist",
         "build": "yarn compile && yarn gen-declaration",
         "gen-declaration": "tsc --emitDeclarationOnly",
+        "test": "node --test",
         "changelog": "changelog"
     },
     "engines": {
-        "node": ">10.0.0"
+        "node": ">=20.0.0"
     },
-    "main": "./dist/server.js",
-    "types": "./@types/global.d.ts",
+    "main": "./dist/index.js",
+    "types": "./@types/index.d.ts",
     "files": [
         "dist",
-        "@types"
+        "@types",
+        "MIGRATION.md"
     ],
     "dependencies": {
-        "koa": "3.1.2",
-        "cron": "1.8.2",
-        "log4js": "^1.1.1",
-        "liftoff": "4.0.0",
-        "minimist": "1.2.6",
-        "koa-static": "5.0.0",
+        "@x-drive/utils": "1.1.32",
+        "koa": "3.2.1",
+        "koa-compress": "5.2.2",
         "koa-router": "14.0.0",
-        "koa-compress": "5.2.1",
-        "@x-drive/utils": "1.1.32"
+        "koa-static": "5.0.0",
+        "liftoff": "5.0.1",
+        "log4js": "^6.9.1",
+        "minimist": "1.2.8"
     },
     "devDependencies": {
-        "tslib": "2.3.0",
-        "colors": "1.4.0",
-        "should": "11.2.1",
-        "nodemon": "2.0.12",
-        "chokidar": "3.5.3",
-        "@swc/cli": "0.1.57",
-        "typescript": "4.3.4",
-        "@swc/core": "1.2.171",
-        "@types/log4js": "2.3.5",
-        "@types/node": "16.11.40",
-        "@types/koa-static": "4.0.4",
+        "@swc/cli": "^0.7.7",
+        "@swc/core": "^1.13.2",
         "@types/koa-router": "7.4.9",
-        "@x-drive/changelog": "1.1.6"
+        "@types/koa-static": "4.0.4",
+        "@types/node": "^20.19.0",
+        "@x-drive/changelog": "1.1.6",
+        "chokidar": "^3.6.0",
+        "typescript": "^5.9.2"
     },
     "bin": {
         "xlab": "dist/bin/xlab"
@@ -52,4 +48,4 @@
         "type": "git",
         "url": "git+https://github.com/x-9lab/xlab.git"
     }
-}
+}

package/@types/business/utils/cookie/1.1.0/clean/index.d.ts

@@ -1,3 +0,0 @@
-import type Koa from "koa";
-declare function onClean(ctx: Koa.Context): void;
-export default onClean;

package/@types/business/utils/cookie/1.1.0/clean/js/index.d.ts

@@ -1,2 +0,0 @@
-declare function onJsClean(ctx: any): void;
-export default onJsClean;

package/@types/components/cache/index.d.ts

@@ -1,2 +0,0 @@
-import { create } from "./lru";
-export { create as local };

package/@types/components/cache/lru.d.ts

@@ -1,21 +0,0 @@
-/**
- * 生成或获取一个缓存实例
- * @param  cacheName 实例名称
- * @param  conf      缓存配置，仅在生成的时候有效
- * @return           缓存实例
- */
-declare function create(cacheName: string, conf: Record<string, XLab.JsonValue>): any;
-export { create };
-/**
- * 获取一个缓存实例
- * @param name 缓存名称
- * @param conf 缓存配置
- */
-declare function get(name: string, conf?: Record<string, XLab.JsonValue>): any;
-export { get };
-/**
- * 获取当前缓存实例数量
- * @return 缓存数量
- */
-declare function len(): number;
-export { len };

package/@types/components/html-processor/index.d.ts

@@ -1,9 +0,0 @@
-import type Koa from "koa";
-declare type RouteOption = Record<string, string | string[] | Function>;
-interface HtmlProcessorOptions {
-    route?: RouteOption;
-}
-declare function htmlProcessor(pathname: string, options: HtmlProcessorOptions, context: Koa.Context): string;
-declare function init(): void;
-export { init };
-export { htmlProcessor };

package/@types/components/injection/index.d.ts

@@ -1,25 +0,0 @@
-import type Koa from "koa";
-/**
- * 数据注入方法
- * @param  html 待处理的字符串
- * @param  req  请求对象
- * @return      处理完的字符串
- */
-declare function inject(html: string, req: Koa.Context): string;
-export { inject };
-/**
- * 添加一个字段到缓存对象
- * @param  key 字段名
- * @param  val 数据
- * @return     存储的数据
- */
-declare function add(key: string, val: XLab.JsonValue): any;
-export { add };
-/**
- * 修改一个字段
- * @param  key 字段名
- * @param  val 数据
- * @return     存储的数据
- */
-declare function modify(key: string, val: XLab.JsonValue): boolean;
-export { modify };

package/@types/components/js-processor/index.d.ts

@@ -1,5 +0,0 @@
-import type Koa from "koa";
-declare function jsProcessor(pathname: string, context: Koa.Context): string;
-declare function init(): void;
-export { init };
-export { jsProcessor };

package/@types/components/md5/index.d.ts

@@ -1,2 +0,0 @@
-declare function md5(str: string): string;
-export { md5 };

package/@types/components/platform/index.d.ts

@@ -1,21 +0,0 @@
-interface IPlat {
-    /**平台类型，mobile 或 desktop */
-    is: string;
-    /**是否是微信 */
-    wechat?: boolean;
-    /**是否是支付宝 */
-    alipay?: boolean;
-    /**是否是微博 */
-    weibo?: boolean;
-    /**是否是 Windows 系统 */
-    win?: boolean;
-    /**是否是 Mac 系统 */
-    mac?: boolean;
-    /**是否是 Linux 系统 */
-    linux?: string;
-    /**操作系统信息 */
-    os?: string;
-}
-export type { IPlat };
-declare function check(ua: string): IPlat;
-export { check };

package/@types/components/proxy/index.d.ts

@@ -1,26 +0,0 @@
-import type Koa from "koa";
-/**代理配置项 */
-interface IProxyOption {
-    /**代理目标 */
-    target: string;
-    /**代理域名 */
-    host: string;
-}
-declare module "http" {
-    interface IncomingMessage {
-        /**代理类型 */
-        proxyType: string;
-    }
-}
-/**
- * 设置代理配置
- * @param type     代理配置名称
- * @param options  配置信息
- */
-declare function set(type: string, options: IProxyOption | string): IProxyOption;
-export { set };
-/**
- * web 代理
- */
-declare function web(reqObj: Koa.Context, headers: any): Promise<unknown>;
-export { web };

package/@types/components/querystring/index.d.ts

@@ -1,25 +0,0 @@
-/// <reference types="node" />
-import qs from "querystring";
-/**
- * 将 URL 参数转换为字符串
- * @example
- * ```ts
- * query2string({"pf":"145","ss":"320x240"});
- * query2string({"pf":"145","ss":"320x240"},["pf"]);
- * query2string({"pf":"145","ss":"320x240"},{"fr":"android"});
- * query2string({"pf":"145","ss":"320x240"},{"fr":"android"},["fr"]);
- * ```
- */
-declare function query2string(...args: Array<XLab.JsonObject | string[]>): string;
-export { query2string };
-/**
- * 字符串转成参数对象
- * @param  qString  参数字符串
- * @return          处理完的对象
- * @example
- * ```ts
- * string2query("pf=145&ss=320x240");
- * ```
- */
-declare function string2query(qString: string): qs.ParsedUrlQuery;
-export { string2query };

package/@types/components/redirect/index.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="node" />
-import type { ParsedUrlQuery } from "querystring";
-import type Koa from "koa";
-declare function by302(context: Koa.Context, url: string): void;
-export { by302 };
-declare function byJS(context: Koa.Context, url: string, msg: string, origin: string): void;
-export { byJS };
-declare function byMeta(context: Koa.Context, url: string): void;
-export { byMeta };
-declare function makeRedirectUrl(query: ParsedUrlQuery, url: string): string;
-export { makeRedirectUrl };

package/@types/components/request/helper.d.ts

@@ -1,3 +0,0 @@
-import type Fetch from "node-fetch";
-declare function getFetch(): Promise<typeof Fetch>;
-export { getFetch };

package/@types/components/request/index.d.ts

@@ -1,51 +0,0 @@
-import type { RequestInit, Response } from "node-fetch";
-/**支持的返回数据类型 */
-declare type IFetchType = "text" | "json" | "blob" | "buffer" | "arrayBuffer";
-/**请求配置 */
-interface IFetchConfig extends Partial<Omit<RequestInit, "body" | "method">> {
-    /**数据返回类型 */
-    type?: IFetchType;
-    /**是否强制同源 */
-    sameOrigin?: boolean;
-    /**请求自动重试次数 */
-    retry?: number;
-    /**自动重试间隔时间 */
-    retryDelay?: number;
-    /**是否自动追加随机数retry，默认 false */
-    random?: boolean;
-    /**数据返回时的钩子 */
-    onResponse?: (res?: Response) => Promise<unknown>;
-}
-export type { IFetchConfig };
-/**给指定对象增加一个随机字符串 */
-declare function setRandomStr(query: any): void;
-export { setRandomStr };
-/**设置默认 Headers */
-declare function setDefHeaders(headers: Record<string, any>): void;
-export { setDefHeaders };
-/**
- * 获取数据
- * @param type              请求类型
- * @param uri               请求地址
- * @param query             请求参数
- * @param data              发送数据
- * @param config            请求配置
- * @param needProcessConfig 是否需要处理配置
- */
-declare function httpFetch<T = unknown>(type: string, uri: string, query?: Record<string, any>, data?: any, config?: IFetchConfig, retry?: number, needProcessConfig?: boolean): Promise<T>;
-export { httpFetch as fetch };
-/**
- * 发起一个 get 请求
- * @param uri   请求地址
- * @param query 请求参数
- */
-declare function requsetGet<T = unknown>(uri: string, query?: Record<string, any>, config?: IFetchConfig): Promise<T>;
-export { requsetGet as get };
-/**
- * 发起一个 post 请求
- * @param uri   请求地址
- * @param query 请求参数
- * @param data  请求数据
- */
-declare function requestPost<T>(uri: string, query?: any, data?: any, config?: IFetchConfig): Promise<T>;
-export { requestPost as post };

package/@types/components/request/resolve-uri.d.ts

@@ -1,6 +0,0 @@
-/**
- * 解析请求别名
- * @param uri 请求地址
- */
-declare function resolve(uri: string): string;
-export default resolve;