@x-9lab/xlab 1.0.0-alpha.1

package/dist/middleware/request-filter.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>_default
+});
+const _htmlFilter = /*#__PURE__*/ _interopRequireWildcard(require("./@bin/html-filter"));
+const _url = /*#__PURE__*/ _interopRequireDefault(require("url"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+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 _interopRequireWildcard(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 = {};
+    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;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+const IS_STATIC_RE = /^\/.*\.(ttf|woff|eot|html|css|js|json|png|jpeg|jpg|gif|bmp|handlebars|mp3|mp4|m3u8|avi|mpg|mpeg|xml|json|tpl)$/i;
+const IS_IMG_RE = /\.(jpg|jpeg|png|gif)$/i;
+const IS_CSS_RE = /\.css$/i;
+const IS_JS_RE = /\.js$/i;
+const IS_HTML_RE = /\.html$/i;
+const IS_DIR_RE = /(\/|[\.\d\/]+)$/i;
+const IS_TPL_RE = /\.tpl$/i;
+const IS_FONT_RE = /\.(ttf|woff|eot|woff2)$/i;
+// 判断是否是 JS 文件路径
+function isJS(url) {
+    return url && IS_JS_RE.test(url);
+}
+// 判断是否是 HTML 文件路径
+function isHtml(url) {
+    return url && IS_HTML_RE.test(url);
+}
+// 判断是否是图片路径
+function isImg(url) {
+    return url && IS_IMG_RE.test(url);
+}
+// 判断是否目录路径
+function isDir(url) {
+    return url && IS_DIR_RE.test(url) && !IS_FONT_RE.test(url);
+}
+// 判断是否是 css 文件路径
+function isCss(url) {
+    return url && IS_CSS_RE.test(url);
+}
+// 判断是否文件
+function isStatic(url) {
+    return url && IS_STATIC_RE.test(url);
+}
+// 判断是否模板
+function isTpl(url) {
+    return url && IS_TPL_RE.test(url);
+}
+// 判断是否字体
+function isFont(url) {
+    return url && IS_FONT_RE.test(url);
+}
+// 请求过滤器
+// 用于补充识别一些必要信息
+async function filter(ctx, next) {
+    var parsedUrl = _url.default.parse(ctx.url);
+    var pathname = parsedUrl.pathname;
+    ctx.state.parsedUrl = parsedUrl;
+    var srcType = {
+        "js": false,
+        "html": false,
+        "img": false,
+        "css": false,
+        "dir": false,
+        "static": false,
+        "tpl": false,
+        "font": false
+    };
+    // 辨别请求资源类型
+    if (isDir(pathname)) {
+        srcType.dir = true;
+        // 提取页面必要的信息
+        // 由于 dir 也可能直接返回 HTML 页面
+        // 所以这里也需要经过 HTML 的过滤器处理
+        ctx.state.originHost = ctx.headers["x-forwarded-host"] || ctx.headers.host;
+        ctx.state.ver = (0, _htmlFilter.filter)(ctx.url);
+    } else if (isStatic(pathname)) {
+        srcType.static = true;
+        if (isHtml(pathname)) {
+            srcType.html = true;
+            // 提取页面必要的信息
+            ctx.state.originHost = ctx.headers["x-forwarded-host"] || ctx.headers.host;
+            ctx.state.ver = (0, _htmlFilter.filter)(ctx.url);
+        } else if (isJS(pathname)) {
+            srcType.js = true;
+        } else if (isImg(pathname)) {
+            srcType.img = true;
+        } else if (isCss(pathname)) {
+            srcType.css = true;
+        } else if (isTpl(pathname)) {
+            srcType.tpl = true;
+        } else if (isFont(pathname)) {
+            srcType.font = true;
+        }
+    }
+    ctx.state.srcType = srcType;
+    await next();
+}
+function _default() {
+    (0, _htmlFilter.default)();
+    return filter;
+}

package/dist/middleware/service-mark.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>_default
+});
+var info = {};
+// 业务名称
+info.mark = getSysConfig("mark") || getSysConfig("name");
+// 业务版本
+info.version = getSysConfig("version");
+// 服务端版本
+info.serverVer = require("../../package.json").version;
+// 业务启动时间
+// FIX ME : 服务器不是北京时间的时候这个数据跟实际启动的时间存在时差
+info.date = requireMod("common").date("Y-m-d h:i:s", Date.now());
+// 模块版本信息
+const MARK = `${info.mark}@${info.version}&${info.serverVer} (${info.date})`;
+info = null;
+/**
+ * 处理函数
+ */ async function handler(ctx, next) {
+    ctx.set("X-Mark", MARK);
+    await next();
+}
+function _default() {
+    return handler;
+}

package/dist/middlewares.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>_default
+});
+const _common = require("./components/common");
+const _utils = require("@x-drive/utils");
+const cwd = process.cwd();
+/**内部中间件 */ const INTERNAL_MIDDLEWARE = {
+    "combo": true,
+    "bad-request": true,
+    "fresh-filter": true,
+    "handle-pre-dir": true,
+    "request-filter": true,
+    "service-mark": true,
+    "compress": true,
+    "cors": true
+};
+// ［最后3个中间件固定是 系统路由，静态文件服务，错误请求处理模块］
+/**加载中间件 */ function loadMiddleware(app) {
+    const config = getSysConfig();
+    if ((0, _utils.isArray)(config.middleware) && config.middleware.length) {
+        config.middleware.forEach((item)=>{
+            const isSrtItem = (0, _utils.isString)(item);
+            let name = isSrtItem ? item : item[0];
+            const conf = isSrtItem ? null : item[1];
+            if (INTERNAL_MIDDLEWARE[name]) {
+                app.use((0, _common.getRealDefaultMod)(require(`./middleware/${name}`))(conf));
+            } else {
+                app.use((0, _common.getRealDefaultMod)(require(`${cwd}/@server/middleware/${name}`))(conf));
+            }
+            masterLog(`MIDDLEWARE >>> [${name}] launch`);
+        });
+        console.log("");
+    }
+}
+const _default = loadMiddleware;

package/dist/package.json

@@ -0,0 +1,61 @@
+{
+    "name": "@x-9lab/xlab",
+    "version": "1.0.0",
+    "private": true,
+    "description": "9lab 服务端模块",
+    "versionDesc": "",
+    "scripts": {
+        "dev": "swc src -D ./src/bin --config-file .swcrc -d dist -w",
+        "compile": "swc src -D ./src/bin --config-file .swcrc -d dist",
+        "build": "yarn compile && yarn gen-declaration",
+        "gen-declaration": "tsc --emitDeclarationOnly",
+        "changelog": "changelog"
+    },
+    "engines": {
+        "node": ">10.0.0"
+    },
+    "main": "./dist/server.js",
+    "types": "./@types/global.d.ts",
+    "files": [
+        "dist",
+        "@types"
+    ],
+    "dependencies": {
+        "koa": "2.13.1",
+        "cron": "1.8.2",
+        "redis": "4.0.3",
+        "log4js": "1.1.1",
+        "liftoff": "3.1.0",
+        "koa-ejs": "4.3.0",
+        "minimist": "1.2.5",
+        "request": "2.86.0",
+        "koa-body": "4.2.0",
+        "lru-cache": "6.0.0",
+        "koa-static": "5.0.0",
+        "koa-router": "10.0.0",
+        "http-proxy": "1.18.1",
+        "koa-compress": "5.0.1",
+        "@x-drive/utils": "1.1.19"
+    },
+    "devDependencies": {
+        "co": "4.6.0",
+        "mocha": "10.0.0",
+        "tslib": "2.3.0",
+        "colors": "1.4.0",
+        "should": "11.2.1",
+        "nodemon": "2.0.12",
+        "socket.io": "2.0.3",
+        "chokidar": "3.5.3",
+        "typescript": "4.3.4",
+        "@types/node": "16.11.40",
+        "@types/log4js": "2.3.5",
+        "@types/koa-static": "4.0.2",
+        "@types/koa-router": "7.4.4",
+        "@swc/cli": "0.1.57",
+        "@swc/core": "1.2.212",
+        "@x-drive/changelog": "1.1.6"
+    },
+    "bin": {
+        "xlab": "dist/bin/xlab"
+    }
+}

package/dist/router.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>_default
+});
+const _utils = require("@x-drive/utils");
+const _common = require("./components/common");
+const _path = /*#__PURE__*/ _interopRequireDefault(require("path"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+/**生成 api */ function buildApi(api) {
+    if (!api.startsWith("/")) {
+        api = `/${api}`;
+    }
+    return `/api${api}`;
+}
+/**加载业务服务接口 */ function appRouter(router) {
+    const IS_API_REGEXP = /^\/api\//;
+    var processBusiness = function(modPath, item) {
+        var mod = require(_path.default.resolve(modPath));
+        if (mod) {
+            mod = (0, _common.getRealDefaultMod)(mod);
+            let api_path = modPath.split("business");
+            let api;
+            let modName;
+            // 根据路径生成 url 规则
+            api = api_path[1].replace(".js", "").split("/");
+            // 文件名是 index
+            const lastIsIndex = api[api.length - 1] === "index";
+            // 文件名是 index 的则会被从 api 上先强行去掉
+            // 如果需要命名成 index 的需要自己用 object 形式，用 api 字段定义
+            if (lastIsIndex) {
+                api.pop();
+            }
+            // 如果模块返回的是数组，则使用文件名做为方法名，并在 api 上去掉文件名
+            if ((0, _utils.isArray)(mod)) {
+                if (!lastIsIndex) {
+                    api.pop();
+                }
+                api = buildApi(api.join("/"));
+                mod.unshift(api);
+            } else {
+                // 不是数组则把文件当作正常的 api 地址
+                api = buildApi(api.join("/"));
+            }
+            // 是对象则取对应的字段
+            if ((0, _utils.isObject)(mod) && ((0, _utils.isFunction)(mod.handler) || (0, _utils.isAsyncFunction)(mod.handler))) {
+                modName = mod.method || "get";
+                api = mod.api || api;
+                // 保证一定是以 api 开头的
+                if (!IS_API_REGEXP.test(api)) {
+                    api = buildApi(api);
+                }
+                if ((0, _utils.isArray)(mod.middleware)) {
+                    mod = [
+                        api,
+                        ...mod.middleware,
+                        mod.handler
+                    ];
+                } else {
+                    mod = [
+                        api,
+                        mod.handler
+                    ];
+                }
+            }
+            // 直接返回函数则直接绑定
+            if ((0, _utils.isFunction)(mod) || (0, _utils.isAsyncFunction)(mod)) {
+                mod = [
+                    api,
+                    mod
+                ];
+            }
+            if (!modName) {
+                modName = item.replace(".js", "");
+                if (modName === "index") {
+                    modName = "get";
+                }
+            }
+            router[modName].apply(router, mod);
+            masterLog("router", `Handling API >>> [${modName}] ${api}`);
+        }
+    };
+    // 业务基本目录
+    var _p = _path.default.resolve(__dirname, "business");
+    (0, _common.walk)(_p, 0, processBusiness);
+    // 支持自定义 api
+    _p = _path.default.resolve(process.cwd(), "@server", "business");
+    if (process.cwd() !== __dirname && (0, _common.checkFileStat)(_p)) {
+        (0, _common.walk)(_p, 0, processBusiness);
+    }
+    processBusiness = null;
+    console.log("");
+}
+const _default = appRouter;

package/dist/server.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    boot: ()=>boot,
+    exit: ()=>exit,
+    default: ()=>_default
+});
+require("./global");
+const _log = require("./components/log");
+const _cron = require("./components/cron");
+const _koaStatic = /*#__PURE__*/ _interopRequireDefault(require("koa-static"));
+const _koaRouter = /*#__PURE__*/ _interopRequireDefault(require("koa-router"));
+const _path = /*#__PURE__*/ _interopRequireDefault(require("path"));
+const _koa = /*#__PURE__*/ _interopRequireDefault(require("koa"));
+const _config = /*#__PURE__*/ _interopRequireWildcard(require("./config"));
+const _custom = /*#__PURE__*/ _interopRequireDefault(require("./custom"));
+const _router = /*#__PURE__*/ _interopRequireDefault(require("./router"));
+const _cluster = /*#__PURE__*/ _interopRequireDefault(require("./cluster"));
+const _middlewares = /*#__PURE__*/ _interopRequireDefault(require("./middlewares"));
+const _badRequest = /*#__PURE__*/ _interopRequireDefault(require("./middleware/bad-request"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+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 _interopRequireWildcard(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 = {};
+    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;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+const logger = _log.globalLog.getLogger("system");
+// 只在 master 上输出的日志
+global.masterLog = _config.log;
+// 服务实例
+const app = new _koa.default();
+/**
+ * 获取应用实例对象
+ * @return 实例对象
+ */ global.getApp = function() {
+    return app;
+};
+// 不输出X-Powered-By
+// @ts-ignore
+app.poweredBy = false;
+if (_config.default.custom) {
+    // 自定义初始化业务
+    (0, _custom.default)();
+}
+// 加载中间件
+(0, _middlewares.default)(app);
+// 数据体解析
+// app.use(koaBody());
+const koaRouter = new _koaRouter.default();
+// 路由中间件
+app.use(koaRouter.routes());
+// 具体路由
+(0, _router.default)(koaRouter);
+// 静态文件服务
+var staticServeOpts = {};
+if (_config.default.isProd) {
+    staticServeOpts.maxage = _config.default.staticMaxage;
+    const staticHtmlFileMaxage = _config.default.staticHtmlFileMaxage;
+    staticServeOpts.setHeaders = function(res, path) {
+        if (staticHtmlFileMaxage && path.endsWith(".html")) {
+            res.setHeader("Cache-Control", `max-age=${staticHtmlFileMaxage}`);
+        }
+    };
+}
+app.use((0, _koaStatic.default)(_path.default.resolve(process.cwd(), _config.default.root), staticServeOpts));
+// 异常状态处理中间件
+app.use(_badRequest.default);
+if (_config.default.enableCron) {
+    // 定时任务
+    (0, _cron.on)(_path.default.resolve(process.cwd(), "@server", "cron"));
+}
+/**启动服务 */ function boot() {
+    (0, _cluster.default)();
+    process.on("uncaughtException", (err)=>{
+        logger.error("uncaughtException:\n", err.stack);
+    }).on("unhandledRejection", (err)=>{
+        logger.error("unhandledRejection:\n", err.stack);
+    });
+}
+/**退出服务 */ function exit() {
+    process.exit();
+}
+const _default = app;
+if (require.main === module) {
+    boot();
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+    "name": "@x-9lab/xlab",
+    "version": "1.0.0-alpha.1",
+    "description": "9lab 服务端模块",
+    "versionDesc": "",
+    "scripts": {
+        "dev": "swc src -D ./src/bin --config-file .swcrc -d dist -w",
+        "compile": "swc src -D ./src/bin --config-file .swcrc -d dist",
+        "build": "yarn compile && yarn gen-declaration",
+        "gen-declaration": "tsc --emitDeclarationOnly",
+        "changelog": "changelog"
+    },
+    "engines": {
+        "node": ">10.0.0"
+    },
+    "main": "./dist/server.js",
+    "types": "./@types/global.d.ts",
+    "files": [
+        "dist"
+    ],
+    "dependencies": {
+        "koa": "2.13.1",
+        "cron": "1.8.2",
+        "redis": "4.0.3",
+        "log4js": "1.1.1",
+        "liftoff": "3.1.0",
+        "koa-ejs": "4.3.0",
+        "minimist": "1.2.5",
+        "request": "2.86.0",
+        "koa-body": "4.2.0",
+        "lru-cache": "6.0.0",
+        "koa-static": "5.0.0",
+        "koa-router": "10.0.0",
+        "http-proxy": "1.18.1",
+        "koa-compress": "5.0.1",
+        "@x-drive/utils": "1.1.19"
+    },
+    "devDependencies": {
+        "co": "4.6.0",
+        "mocha": "10.0.0",
+        "tslib": "2.3.0",
+        "colors": "1.4.0",
+        "should": "11.2.1",
+        "nodemon": "2.0.12",
+        "socket.io": "2.0.3",
+        "chokidar": "3.5.3",
+        "typescript": "4.3.4",
+        "@types/node": "16.11.40",
+        "@types/log4js": "2.3.5",
+        "@types/koa-static": "4.0.2",
+        "@types/koa-router": "7.4.4",
+        "@swc/cli": "0.1.57",
+        "@swc/core": "1.2.212",
+        "@x-drive/changelog": "1.1.6"
+    },
+    "bin": {
+        "xlab": "dist/bin/xlab"
+    }
+}