@zenweb/schedule 3.1.0 → 3.3.0

package/dist/index.d.ts

@@ -1,5 +1,10 @@
 import { SetupFunction } from '@zenweb/core';
-import { schedule } from './register';
+import { schedule, ScheduleRegister } from './register';
 import { ScheduleOption } from './types';
 export { ScheduleOption, schedule };
 export default function setup(option?: ScheduleOption): SetupFunction;
+declare module '@zenweb/core' {
+    interface Core {
+        schedule: ScheduleRegister;
+    }
+}

package/dist/index.js

@@ -8,25 +8,33 @@ 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 });
+        const schedule = new register_1.ScheduleRegister(setup.core, option);
+        setup.defineCoreProperty('schedule', { value: schedule });
         if (option.paths && option.paths.length) {
             for (const d of option.paths) {
                 for (const file of await globby(option.patterns || '**/*.{ts,js}', { cwd: d, absolute: true })) {
                     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);
+                            schedule.register(i);
                         }
                     }
                 }
             }
         }
+        setup.after(() => {
+            schedule.addToCoreRouter();
+        });
+        setup.destroy(() => {
+            schedule.destory();
+        });
     };
 }
 exports.default = setup;

package/dist/register.d.ts

@@ -1,32 +1,28 @@
 import '@zenweb/inject';
 import '@zenweb/router';
 import '@zenweb/log';
-import { Middleware } from 'koa';
-import { Core } from '@zenweb/core';
+import { Core, Middleware } 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[];
 }
-interface JobItem extends ScheduleMethodOption {
-    path: string;
-    handle: (...args: any[]) => Promise<void> | void;
-    params: any[];
-}
-/**
- * 取得对象中的任务列表
- */
-export declare function getJobs(target: any): JobItem[];
-/**
- * 在对象中添加任务配置
- */
-export declare function addJob(target: any, item: JobItem): void;
 /**
  * 定时任务设定
  */
-export declare function schedule(opt: ScheduleMethodOption): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
-/**
- * 添加定时任务到路由并启动定时器
- */
-export declare function registerSchedule(core: Core, target: any): void;
+export declare function schedule(opt: ScheduleMethodOption): (target: Object, propertyKey: string | symbol, descriptor_or_paramtypes?: any[] | PropertyDescriptor) => void;
+export declare class ScheduleRegister {
+    private core;
+    private router;
+    private option;
+    private jobs;
+    constructor(core: Core, option: ScheduleOption);
+    /**
+     * 添加定时任务到路由并启动定时器
+     */
+    register(target: any): void;
+    addToCoreRouter(): void;
+    destory(): void;
+}
 export {};

package/dist/register.js

@@ -1,14 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerSchedule = exports.schedule = exports.addJob = exports.getJobs = void 0;
+exports.ScheduleRegister = exports.schedule = 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");
+const decorator_make_1 = require("decorator-make");
+const router_1 = require("@zenweb/router");
+const inject_1 = require("@zenweb/inject");
 const SAFE_IP = '127.0.0.1';
-const JOBS = Symbol('Schedule#jobs');
 /**
  * 安全检查，防止外部调用
  */
@@ -28,73 +30,78 @@ async function safeCheck(ctx, next) {
         ctx.log.info('end', Date.now() - startTime, 'ms');
     }
 }
-/**
- * 取得对象中的任务列表
- */
-function getJobs(target) {
-    return Reflect.getMetadata(JOBS, target) || [];
-}
-exports.getJobs = getJobs;
-/**
- * 在对象中添加任务配置
- */
-function addJob(target, item) {
-    const list = [...getJobs(target), item];
-    Reflect.defineMetadata(JOBS, list, target);
-}
-exports.addJob = addJob;
+const scheduleDecorator = (0, decorator_make_1.makeMethodDecorator)();
 /**
  * 定时任务设定
  */
 function schedule(opt) {
-    return function (target, propertyKey, descriptor) {
-        const path = `/__schedule/${(0, crypto_1.randomUUID)()}/${target.constructor.name}.${propertyKey}`;
-        const params = Reflect.getOwnMetadata('design:paramtypes', target, propertyKey) || [];
-        addJob(target, Object.assign({
-            path,
-            handle: descriptor.value,
-            params,
-        }, opt));
-    };
+    return scheduleDecorator.wrap((descriptor, target) => {
+        const path = `${(0, crypto_1.randomUUID)()}/${target.constructor.name}.${descriptor.handle.name}`;
+        return Object.assign({ path }, descriptor, opt);
+    });
 }
 exports.schedule = schedule;
-/**
- * 添加定时任务到路由并启动定时器
- */
-function registerSchedule(core, target) {
-    const jobs = getJobs(target.prototype);
-    if (jobs.length > 0) {
-        for (const item of jobs) {
-            // 添加到路由中
-            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);
-                await ctx.injector.apply(cls, item);
-            });
-            // 启用定时器
-            (0, node_schedule_1.scheduleJob)(item.rule, function callback() {
-                const request = Object.assign({
-                    headers: {
+class ScheduleRegister {
+    constructor(core, option) {
+        this.jobs = [];
+        this.core = core;
+        this.router = new router_1.Router({
+            prefix: '/__schedule/',
+        });
+        this.option = option;
+    }
+    /**
+     * 添加定时任务到路由并启动定时器
+     */
+    register(target) {
+        const methods = scheduleDecorator.getMethods(target.prototype);
+        if (methods.length > 0) {
+            (0, inject_1.scope)('prototype', false)(target);
+            for (const item of methods) {
+                // 添加到路由中
+                this.router.post(item.path, safeCheck, ...(item.middleware ?
+                    (Array.isArray(item.middleware) ? item.middleware : [item.middleware]) : []), async (ctx) => {
+                    const cls = await ctx.injector.getInstance(target);
+                    await ctx.injector.apply(cls, item);
+                });
+                if (this.option.disabled) {
+                    continue;
+                }
+                // 启用定时器
+                const job = (0, node_schedule_1.scheduleJob)(item.rule, () => {
+                    const path = '/__schedule/' + item.path;
+                    const request = Object.assign({
+                        headers: {
+                            host: '127.0.0.1',
+                        },
+                        query: {},
+                        querystring: '',
                         host: '127.0.0.1',
-                    },
-                    query: {},
-                    querystring: '',
-                    host: '127.0.0.1',
-                    hostname: '127.0.0.1',
-                    protocol: 'http',
-                    secure: 'false',
-                    method: 'POST',
-                    url: item.path,
-                    path: item.path,
-                    socket: {
-                        remoteAddress: SAFE_IP,
-                        remotePort: 7001,
-                    },
+                        hostname: '127.0.0.1',
+                        protocol: 'http',
+                        secure: 'false',
+                        method: 'POST',
+                        url: path,
+                        path,
+                        socket: {
+                            remoteAddress: SAFE_IP,
+                            remotePort: 7001,
+                        },
+                    });
+                    const response = new http_1.ServerResponse(request);
+                    this.core.koa.callback()(request, response);
                 });
-                const response = new http_1.ServerResponse(request);
-                core.koa.callback()(request, response);
-            });
+                this.jobs.push(job);
+            }
+        }
+    }
+    addToCoreRouter() {
+        this.core.router.use(this.router.routes());
+    }
+    destory() {
+        for (const job of this.jobs) {
+            job.cancel();
         }
     }
 }
-exports.registerSchedule = registerSchedule;
+exports.ScheduleRegister = ScheduleRegister;

package/dist/types.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { ServerResponse, IncomingMessage } from 'http';
-export declare type RequestCallback = (request: IncomingMessage, response: ServerResponse) => void;
-export declare type JobCallback = (request: IncomingMessage, response: ServerResponse, callback: RequestCallback) => void;
+export type RequestCallback = (request: IncomingMessage, response: ServerResponse) => void;
+export type JobCallback = (request: IncomingMessage, response: ServerResponse, callback: RequestCallback) => void;
 export interface ScheduleOption {
     /**
      * 加载 schedule 文件目录，默认: ./app/schedule
@@ -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.1.0",
+  "version": "3.3.0",
   "description": "Zenweb Schedule module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -8,7 +8,8 @@
     "dist"
   ],
   "scripts": {
-    "prepublishOnly": "rm -fr dist && tsc",
+    "build": "rimraf dist && tsc",
+    "prepublishOnly": "npm run build",
     "dev": "cd example && DEBUG=* ts-node app"
   },
   "author": {
@@ -33,14 +34,18 @@
     "url": "https://github.com/yefei/zenweb-schedule/issues"
   },
   "devDependencies": {
-    "@zenweb/core": "^2.4.1",
-    "@zenweb/inject": "^3.5.0",
-    "@zenweb/log": "^2.3.1",
-    "@zenweb/router": "^3.0.0"
+    "@zenweb/core": "^3.1.6",
+    "@zenweb/inject": "^3.17.0",
+    "@zenweb/log": "^3.0.0",
+    "@zenweb/router": "^3.1.1",
+    "rimraf": "^4.3.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.2"
   },
   "dependencies": {
-    "@types/node-schedule": "^1.3.2",
+    "@types/node-schedule": "^2.1.0",
+    "decorator-make": "^1.3.0",
     "globby": "11.0.4",
-    "node-schedule": "^2.0.0"
+    "node-schedule": "^2.1.1"
   }
 }