@zenweb/schedule 2.3.6 → 3.0.0

package/README.md

@@ -1,25 +1,9 @@
-# ZenWeb Schedule module
-
-[ZenWeb](https://www.npmjs.com/package/zenweb)
-
-## Quick start
-```
-$ npm i @zenweb/schedule
-```
-
-app/index.js
-```js
-app.setup('@zenweb/schedule');
-```
-
-app/schedule/echo.js
-```js
-app.schedule.job('*/1 * * * * *', ctx => {
-  console.log('task echo');
-});
-```
-
-## Develop
-```
-$ yarn global add rimraf typescript
-```
+# ZenWeb Schedule module
+
+[ZenWeb](https://www.npmjs.com/package/zenweb)
+
+定时任务
+
+## 安装
+
+安装定时任务模块依赖于 @zenweb/inject @zenweb/router 模块

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,38 +1,31 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const globby = require("globby");
-const path = require("path");
-const register_1 = require("./register");
-__exportStar(require("./types"), exports);
-function setup(option) {
-    return async function schedule(setup) {
-        option = Object.assign({
-            paths: [path.join(process.cwd(), 'app', 'schedule')],
-        }, option);
-        setup.debug('option: %o', option);
-        const register = new register_1.ScheduleRegister(setup.core, option);
-        setup.defineCoreProperty('schedule', { value: register });
-        if (option.paths && option.paths.length) {
-            for (const d of option.paths) {
-                let count = 0;
-                for (const m of await globby(option.patterns || '**/*.{ts,js}', { cwd: d, absolute: true })) {
-                    require(m);
-                    count++;
-                }
-                setup.debug('load: %s %o files', d, count);
-            }
-        }
-    };
-}
-exports.default = setup;
-//# sourceMappingURL=index.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schedule = void 0;
+const globby = require("globby");
+const path = require("path");
+const register_1 = require("./register");
+Object.defineProperty(exports, "schedule", { enumerable: true, get: function () { return register_1.schedule; } });
+function setup(option) {
+    option = Object.assign({
+        paths: [path.join(process.cwd(), 'app', 'schedule')],
+    }, option);
+    return async function schedule(setup) {
+        setup.checkCoreProperty('injector', '@zenweb/inject');
+        setup.checkCoreProperty('router', '@zenweb/router');
+        setup.debug('option: %o', option);
+        setup.defineCoreProperty('schedule', { value: true });
+        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);
+                        }
+                    }
+                }
+            }
+        }
+    };
+}
+exports.default = setup;

package/dist/register.d.ts

@@ -1,15 +1,31 @@
-/// <reference types="koa__router" />
-import '@zenweb/router';
-import { Middleware } from 'koa';
-import { Core } from '@zenweb/core';
-import { RequestCallback, ScheduleOption } from './types';
-import { Router } from '@zenweb/router';
-import { RecurrenceRule, RecurrenceSpecDateRange, RecurrenceSpecObjLit } from 'node-schedule';
-export declare class ScheduleRegister {
-    option: ScheduleOption;
-    router: Router;
-    callback: RequestCallback;
-    private _index;
-    constructor(core: Core, option?: ScheduleOption);
-    job(rule: RecurrenceRule | RecurrenceSpecDateRange | RecurrenceSpecObjLit | Date | string | number, ...middleware: Middleware[]): import("node-schedule").Job;
-}
+import '@zenweb/inject';
+import '@zenweb/router';
+import { Middleware } from 'koa';
+import { Core } from '@zenweb/core';
+import { RecurrenceRule, RecurrenceSpecDateRange, RecurrenceSpecObjLit } from 'node-schedule';
+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 {};

package/dist/register.js

@@ -1,60 +1,89 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScheduleRegister = void 0;
-require("@zenweb/router");
-const http_1 = require("http");
-const node_schedule_1 = require("node-schedule");
-const SAFE_IP = '127.0.0.1';
-/**
- * 安全检查，防止外部调用
- */
-function safeCheck(ctx, next) {
-    if (!ctx.req.socket.remoteAddress || !ctx.req.socket.remoteAddress.endsWith(SAFE_IP)) {
-        ctx.throw(403);
-    }
-    return next();
-}
-class ScheduleRegister {
-    constructor(core, option) {
-        this.option = option || {};
-        this.router = core.router;
-        this.callback = core.koa.callback();
-        this._index = 0;
-    }
-    job(rule, ...middleware) {
-        // 注册到路由
-        const path = `/___schedule/job/${this._index++}`;
-        this.router.post(path, safeCheck, ...middleware);
-        // 注册到 scheduleJob
-        const callback = () => {
-            const request = Object.assign({
-                headers: {
-                    host: '127.0.0.1',
-                },
-                query: {},
-                querystring: '',
-                host: '127.0.0.1',
-                hostname: '127.0.0.1',
-                protocol: 'http',
-                secure: 'false',
-                method: 'POST',
-                url: path,
-                path: path,
-                socket: {
-                    remoteAddress: SAFE_IP,
-                    remotePort: 7001,
-                },
-            });
-            const response = new http_1.ServerResponse(request);
-            if (this.option.jobCallback) {
-                this.option.jobCallback(request, response, this.callback);
-            }
-            else {
-                this.callback(request, response);
-            }
-        };
-        return (0, node_schedule_1.scheduleJob)(rule, callback);
-    }
-}
-exports.ScheduleRegister = ScheduleRegister;
-//# sourceMappingURL=register.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSchedule = exports.schedule = exports.addJob = exports.getJobs = void 0;
+require("@zenweb/inject");
+require("@zenweb/router");
+const http_1 = require("http");
+const node_schedule_1 = require("node-schedule");
+const crypto_1 = require("crypto");
+const SAFE_IP = '127.0.0.1';
+const JOBS = Symbol('Schedule#jobs');
+/**
+ * 安全检查，防止外部调用
+ */
+function safeCheck(ctx, next) {
+    if (!ctx.req.socket.remoteAddress || !ctx.req.socket.remoteAddress.endsWith(SAFE_IP)) {
+        ctx.throw(403);
+    }
+    return next();
+}
+/**
+ * 取得对象中的任务列表
+ */
+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;
+/**
+ * 定时任务设定
+ */
+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));
+    };
+}
+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);
+                ctx.injector.apply(cls, item);
+            });
+            // 启用定时器
+            (0, node_schedule_1.scheduleJob)(item.rule, function callback() {
+                const request = Object.assign({
+                    headers: {
+                        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,
+                    },
+                });
+                const response = new http_1.ServerResponse(request);
+                core.koa.callback()(request, response);
+            });
+        }
+    }
+}
+exports.registerSchedule = registerSchedule;

package/dist/types.d.ts

@@ -1,15 +1,14 @@
-/// <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 interface ScheduleOption {
-    /**
-     * 加载 schedule 文件目录，默认: ./app/schedule
-     */
-    paths?: string[];
-    /**
-     * 文件匹配规则，默认: ** /*.{ts,js}
-     */
-    patterns?: string;
-    jobCallback?: JobCallback;
-}
+/// <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 interface ScheduleOption {
+    /**
+     * 加载 schedule 文件目录，默认: ./app/schedule
+     */
+    paths?: string[];
+    /**
+     * 文件匹配规则，默认: ** /*.{ts,js}
+     */
+    patterns?: string;
+}

package/dist/types.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,44 +1,45 @@
-{
-  "name": "@zenweb/schedule",
-  "version": "2.3.6",
-  "description": "Zenweb Schedule module",
-  "exports": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "prepublishOnly": "rimraf dist && tsc"
-  },
-  "author": {
-    "name": "YeFei",
-    "email": "316606233@qq.com"
-  },
-  "keywords": [
-    "web",
-    "app",
-    "http",
-    "framework",
-    "schedule",
-    "cron",
-    "koa"
-  ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/yefei/zenweb-schedule.git"
-  },
-  "bugs": {
-    "url": "https://github.com/yefei/zenweb-schedule/issues"
-  },
-  "devDependencies": {
-    "@zenweb/core": "^2.3.2",
-    "@zenweb/router": "^2.3.0",
-    "zenweb": "^2.3.1"
-  },
-  "dependencies": {
-    "@types/node-schedule": "^1.3.2",
-    "globby": "11.0.4",
-    "node-schedule": "^2.0.0"
-  }
-}
+{
+  "name": "@zenweb/schedule",
+  "version": "3.0.0",
+  "description": "Zenweb Schedule module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepublishOnly": "rm -fr dist && tsc",
+    "dev": "cd example && DEBUG=* ts-node app"
+  },
+  "author": {
+    "name": "YeFei",
+    "email": "316606233@qq.com"
+  },
+  "keywords": [
+    "web",
+    "app",
+    "http",
+    "framework",
+    "schedule",
+    "cron",
+    "koa"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yefei/zenweb-schedule.git"
+  },
+  "bugs": {
+    "url": "https://github.com/yefei/zenweb-schedule/issues"
+  },
+  "devDependencies": {
+    "@zenweb/core": "^2.4.1",
+    "@zenweb/inject": "^3.5.0",
+    "@zenweb/router": "^3.0.0"
+  },
+  "dependencies": {
+    "@types/node-schedule": "^1.3.2",
+    "globby": "11.0.4",
+    "node-schedule": "^2.0.0"
+  }
+}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAiC;AAEjC,6BAA8B;AAC9B,yCAA8C;AAE9C,0CAAwB;AAExB,SAAwB,KAAK,CAAC,MAAuB;IACnD,OAAO,KAAK,UAAU,QAAQ,CAAC,KAAK;QAClC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;YACrB,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;SACrD,EAAE,MAAM,CAAC,CAAC;QACX,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,IAAI,2BAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1D,KAAK,CAAC,kBAAkB,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC1D,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE;YACvC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE;gBAC5B,IAAI,KAAK,GAAG,CAAC,CAAC;gBACd,KAAK,MAAM,CAAC,IAAI,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,cAAc,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE;oBAC3F,OAAO,CAAC,CAAC,CAAC,CAAC;oBACX,KAAK,EAAE,CAAC;iBACT;gBACD,KAAK,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;aAC5C;SACF;IACH,CAAC,CAAA;AACH,CAAC;AAnBD,wBAmBC"}

package/dist/register.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"register.js","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":";;;AAAA,0BAAwB;AACxB,+BAAuD;AAKvD,iDAA2G;AAE3G,MAAM,OAAO,GAAG,WAAW,CAAC;AAE5B;;GAEG;AACH,SAAS,SAAS,CAAC,GAAY,EAAE,IAAU;IACzC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACpF,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KAChB;IACD,OAAO,IAAI,EAAE,CAAC;AAChB,CAAC;AAED,MAAa,gBAAgB;IAM3B,YAAY,IAAU,EAAE,MAAuB;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAED,GAAG,CACD,IAA8F,EAC9F,GAAG,UAAwB;QAE3B,QAAQ;QACR,MAAM,IAAI,GAAG,oBAAoB,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,UAAU,CAAC,CAAC;QAEjD,kBAAkB;QAClB,MAAM,QAAQ,GAAG,GAAG,EAAE;YACpB,MAAM,OAAO,GAAoB,MAAM,CAAC,MAAM,CAAC;gBAC7C,OAAO,EAAE;oBACP,IAAI,EAAE,WAAW;iBAClB;gBACD,KAAK,EAAE,EAAE;gBACT,WAAW,EAAE,EAAE;gBACf,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,MAAM;gBAChB,MAAM,EAAE,OAAO;gBACf,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,IAAI;gBACT,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE;oBACN,aAAa,EAAE,OAAO;oBACtB,UAAU,EAAE,IAAI;iBACjB;aACF,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,qBAAc,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;gBAC3B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC3D;iBAAM;gBACL,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;aAClC;QACH,CAAC,CAAC;QACF,OAAO,IAAA,2BAAW,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;CACF;AAlDD,4CAkDC"}

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}