@zenweb/schedule 3.0.0 → 3.2.0

package/dist/index.js

@@ -8,10 +8,12 @@ Object.defineProperty(exports, "schedule", { enumerable: true, get: function ()
 function setup(option) {
     option = Object.assign({
         paths: [path.join(process.cwd(), 'app', 'schedule')],
+        disabled: process.env.ZENWEB_SCHEDULE_DISABLED === '1',
     }, option);
     return async function schedule(setup) {
         setup.checkCoreProperty('injector', '@zenweb/inject');
         setup.checkCoreProperty('router', '@zenweb/router');
+        setup.checkCoreProperty('log', '@zenweb/log');
         setup.debug('option: %o', option);
         setup.defineCoreProperty('schedule', { value: true });
         if (option.paths && option.paths.length) {
@@ -20,7 +22,7 @@ function setup(option) {
                     const mod = require(file.slice(0, -3));
                     for (const i of Object.values(mod)) {
                         if (typeof i === 'function') {
-                            (0, register_1.registerSchedule)(setup.core, i);
+                            (0, register_1.registerSchedule)(setup.core, i, option);
                         }
                     }
                 }

package/dist/register.d.ts

@@ -1,8 +1,10 @@
 import '@zenweb/inject';
 import '@zenweb/router';
+import '@zenweb/log';
 import { Middleware } from 'koa';
 import { Core } from '@zenweb/core';
 import { RecurrenceRule, RecurrenceSpecDateRange, RecurrenceSpecObjLit } from 'node-schedule';
+import { ScheduleOption } from './types';
 interface ScheduleMethodOption {
     rule: RecurrenceRule | RecurrenceSpecDateRange | RecurrenceSpecObjLit | Date | string | number;
     middleware?: Middleware | Middleware[];
@@ -27,5 +29,5 @@ export declare function schedule(opt: ScheduleMethodOption): (target: any, prope
 /**
  * 添加定时任务到路由并启动定时器
  */
-export declare function registerSchedule(core: Core, target: any): void;
+export declare function registerSchedule(core: Core, target: any, option: ScheduleOption): void;
 export {};

package/dist/register.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerSchedule = exports.schedule = exports.addJob = exports.getJobs = void 0;
 require("@zenweb/inject");
 require("@zenweb/router");
+require("@zenweb/log");
 const http_1 = require("http");
 const node_schedule_1 = require("node-schedule");
 const crypto_1 = require("crypto");
@@ -11,11 +12,21 @@ const JOBS = Symbol('Schedule#jobs');
 /**
  * 安全检查，防止外部调用
  */
-function safeCheck(ctx, next) {
+async function safeCheck(ctx, next) {
+    const startTime = Date.now();
+    ctx.log.info('start');
     if (!ctx.req.socket.remoteAddress || !ctx.req.socket.remoteAddress.endsWith(SAFE_IP)) {
         ctx.throw(403);
     }
-    return next();
+    try {
+        await next();
+    }
+    catch (err) {
+        ctx.log.child({ err }).error('error');
+    }
+    finally {
+        ctx.log.info('end', Date.now() - startTime, 'ms');
+    }
 }
 /**
  * 取得对象中的任务列表
@@ -50,7 +61,7 @@ exports.schedule = schedule;
 /**
  * 添加定时任务到路由并启动定时器
  */
-function registerSchedule(core, target) {
+function registerSchedule(core, target, option) {
     const jobs = getJobs(target.prototype);
     if (jobs.length > 0) {
         for (const item of jobs) {
@@ -58,8 +69,11 @@ function registerSchedule(core, target) {
             core.router.post(item.path, safeCheck, ...(item.middleware ?
                 (Array.isArray(item.middleware) ? item.middleware : [item.middleware]) : []), async (ctx) => {
                 const cls = await ctx.injector.getInstance(target);
-                ctx.injector.apply(cls, item);
+                await ctx.injector.apply(cls, item);
             });
+            if (option.disabled) {
+                continue;
+            }
             // 启用定时器
             (0, node_schedule_1.scheduleJob)(item.rule, function callback() {
                 const request = Object.assign({

package/dist/types.d.ts

@@ -11,4 +11,12 @@ export interface ScheduleOption {
      * 文件匹配规则，默认: ** /*.{ts,js}
      */
     patterns?: string;
+    /**
+     * 是否禁用定时器
+     * 如禁用只注册到路由而不自动执行
+     * 可以通过环境变量 ZENWEB_SCHEDULE_DISABLED=1 控制
+     *
+     * @default false
+     */
+    disabled?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenweb/schedule",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "Zenweb Schedule module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -35,7 +35,10 @@
   "devDependencies": {
     "@zenweb/core": "^2.4.1",
     "@zenweb/inject": "^3.5.0",
-    "@zenweb/router": "^3.0.0"
+    "@zenweb/log": "^2.3.1",
+    "@zenweb/router": "^3.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.2"
   },
   "dependencies": {
     "@types/node-schedule": "^1.3.2",