@x-9lab/xlab 1.5.1 → 1.5.3

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

@@ -2,6 +2,8 @@
 interface ICronJob {
     /**定时任务 */
     (): void;
+    /**定时任务 */
+    default?: () => void;
     /**获取定时任务间隔时间 */
     getDelay?: () => number;
     /**获取定时任务开启状态 */

package/@types/custom.d.ts

@@ -1,3 +1,3 @@
 /**处理自定义业务 */
-declare function processCustom(): void;
+declare function processCustom(): Promise<void>;
 export default processCustom;

package/@types/global.d.ts

@@ -120,7 +120,7 @@ declare global {
             enableCron?: boolean;
             /**
              * 开启的中间件列表
-             * @deprecated since version 1.1.0, 1.3.0 后将完全删除
+             * @deprecated since version 1.1.0, 已弃用, 请使用改用 `middlewares` 配置项
              */
             middleware?: (string | (string | Record<string, any>)[])[];
             /**开启的中间件列表 */

package/dist/@config/config.js

@@ -17,7 +17,6 @@ const CONFIG = {
     "staticHtmlFileMaxage": 0,
     "enableComboCache": true,
     "enableCron": false,
-    "middleware": [],
     "strictSSL": false,
     "root": "public",
     "timezone": "Asia/Shanghai"

package/dist/components/cron/index.js

@@ -13,6 +13,7 @@ _export(exports, {
     kill: ()=>kill
 });
 const _utils = require("@x-drive/utils");
+const _util = require("util");
 const _path = /*#__PURE__*/ _interopRequireDefault(require("path"));
 const _fs = /*#__PURE__*/ _interopRequireDefault(require("fs"));
 function _interopRequireDefault(obj) {
@@ -30,6 +31,7 @@ const config = getSysConfig("cron") || {
 /**
  * 计时器对象
  */ var CRON_TIMERS = {};
+/**任务执行状态, 确保同时只会有一个定时任务在执行 */ const JOB_STATUS = {};
 /**
  * 定时刷新函数
  * @param mod  模块对象
@@ -37,6 +39,9 @@ const config = getSysConfig("cron") || {
  * @param dont 不执行
  * @return     计时器对象
  */ function fetch(mod, name, dont) {
+    if (JOB_STATUS[name] === true) {
+        return;
+    }
     var time = (0, _utils.isFunction)(mod.getDelay) ? mod.getDelay() : DEF_TIME;
     if (isNaN(time)) {
         logger.warn("[ %s ] Time Invalid.", name);
@@ -47,7 +52,17 @@ const config = getSysConfig("cron") || {
         return null;
     }
     if (!dont) {
-        mod();
+        JOB_STATUS[name] = true;
+        try {
+            if ((0, _utils.isExecutable)(mod)) {
+                mod();
+            } else if (mod.default && (0, _utils.isExecutable)(mod.default())) {
+                mod.default();
+            }
+        } catch (e) {
+            logger.error((0, _util.inspect)(e));
+        }
+        JOB_STATUS[name] = false;
     }
     return setTimeout(function() {
         CRON_TIMERS[name] = fetch(mod, name, dont);
@@ -75,7 +90,7 @@ const config = getSysConfig("cron") || {
         dirStat = _fs.default.accessSync(cronPath, _fs.default.constants.F_OK);
     } catch (e) {
         dirStat = true;
-        logger.warn(e);
+        logger.warn((0, _util.inspect)(e));
     }
     // accessSync 在文件不存在的时候才会返回内容
     if (dirStat) {
@@ -85,19 +100,19 @@ const config = getSysConfig("cron") || {
     var crons = _fs.default.readdirSync(cronPath);
     logger.info("Cron online.");
     try {
-        crons.forEach(function(cron) {
+        for (const cron of crons){
             if (cron.charAt(0) !== ".") {
                 var tmpPath = cronPath + "/" + cron;
                 var stats = _fs.default.statSync(tmpPath);
                 if (stats.isFile()) {
                     var name = cron.replace(".js", "");
                     CRON_TIMERS[name] = fetch(require(_path.default.resolve(tmpPath)), name);
-                    logger.info("\t>>> [ %s ] %s.", name, CRON_TIMERS[name] ? "running" : "disabled");
+                    logger.info("[ %s ] %s.", name, CRON_TIMERS[name] ? "running" : "disabled");
                 }
             }
-        });
+        }
     } catch (err) {
-        logger.error(err);
+        logger.error((0, _util.inspect)(err));
     }
     console.log("");
 }

package/dist/custom.js

@@ -10,13 +10,14 @@ const _utils = require("@x-drive/utils");
 const _common = require("./components/common");
 const _defaultXConfig = /*#__PURE__*/ _interopRequireDefault(require("./default-x-config"));
 const _config = require("./config");
+const _util = require("util");
 const _path = /*#__PURE__*/ _interopRequireDefault(require("path"));
 function _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
 }
-/**处理自定义业务 */ function processCustom() {
+/**处理自定义业务 */ async function processCustom() {
     const config = (0, _config.get)();
     const CustomPath = _path.default.resolve(process.cwd(), _defaultXConfig.default.businessDir, "custom");
     const hasCustom = (0, _common.checkFileStat)(CustomPath);
@@ -27,18 +28,22 @@ function _interopRequireDefault(obj) {
         return;
     }
     if (hasCustom) {
-        config.custom.forEach(async (item)=>{
-            const isStrItem = (0, _utils.isString)(item);
-            const name = isStrItem ? item : item[0];
-            const conf = isStrItem ? null : item[1];
-            const mod = (0, _common.getRealDefaultMod)(require(_path.default.resolve(CustomPath, name)));
-            if ((0, _utils.isFunction)(mod)) {
-                mod(conf);
-            } else if ((0, _utils.isAsyncFunction)(mod)) {
-                await mod(conf);
+        try {
+            for (const item of config.custom){
+                const isStrItem = (0, _utils.isString)(item);
+                const name = isStrItem ? item : item[0];
+                const conf = isStrItem ? null : item[1];
+                const mod = (0, _common.getRealDefaultMod)(require(_path.default.resolve(CustomPath, name)));
+                if ((0, _utils.isFunction)(mod)) {
+                    mod(conf);
+                } else if ((0, _utils.isAsyncFunction)(mod)) {
+                    await mod(conf);
+                }
+                masterLog("custom", `[${name}] loaded`);
             }
-            masterLog("custom", `[${name}] loaded`);
-        });
+        } catch (e) {
+            masterLog("custom", "error", (0, _util.inspect)(e));
+        }
     }
     console.log("");
 }

package/dist/router.js

@@ -91,28 +91,31 @@ function _interopRequireDefault(obj) {
                 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;
-                apiPart = api.split("/");
-                if (apiPart[0] !== "") {
-                    apiPart.unshift("");
-                }
-                // 保证一定是以 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.isObject)(mod)) {
+                const subjectMod = mod;
+                if ((0, _utils.isFunction)(subjectMod.handler) || (0, _utils.isAsyncFunction)(subjectMod.handler)) {
+                    modName = subjectMod.method || "get";
+                    api = subjectMod.api || api;
+                    apiPart = api.split("/");
+                    if (apiPart[0] !== "") {
+                        apiPart.unshift("");
+                    }
+                    // 如果没有声明忽略检测则保证接口一定是以 api 开头的
+                    if (!subjectMod.ignoreApiNameCheck && !IS_API_REGEXP.test(api)) {
+                        api = buildApi(api);
+                    }
+                    if ((0, _utils.isArray)(subjectMod.middleware)) {
+                        mod = [
+                            api,
+                            ...subjectMod.middleware,
+                            subjectMod.handler
+                        ];
+                    } else {
+                        mod = [
+                            api,
+                            subjectMod.handler
+                        ];
+                    }
                 }
             }
             var dirMws = [];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@x-9lab/xlab",
-    "version": "1.5.1",
+    "version": "1.5.3",
     "description": "9lab 服务端模块",
     "versionDesc": "静态文件服务支持跨域",
     "scripts": {