feat: impl Schedule decorator

Author: killagu

core/schedule-decorator/README.md

@@ -0,0 +1,46 @@
+# `@eggjs/tegg-schedule-decorator`
+
+## Install
+
+```shell
+npm i --save @eggjs/tegg-schedule-decorator
+```
+
+## Define schedule subscriber
+
+```ts
+import { Schedule } from '@eggjs/tegg';
+
+// use number to define schedule interval
+@Schedule<IntervalParams>({
+  type: ScheduleType.WORKER,
+  scheduleData: {
+    // run every 100ms
+    interval: 100,
+  },
+})
+export class FooSubscriber {
+  @Inject()
+  private readonly logger: EggLogger;
+
+  async subscribe() {
+    this.logger.info('schedule called');
+  }
+}
+
+// use cron to define schedule interval
+@Schedule<CronParams>({
+  type: ScheduleType.WORKER,
+  scheduleData: {
+    cron: '0 0 3 * * *',
+  },
+})
+export class FooSubscriber {
+  @Inject()
+  private readonly logger: EggLogger;
+
+  async subscribe() {
+    this.logger.info('schedule called');
+  }
+}
+```

core/schedule-decorator/index.ts

@@ -0,0 +1,4 @@
+export * from './src/model/ScheduleMetadata';
+export * from './src/util/ScheduleInfoUtil';
+export * from './src/util/ScheduleMetadataUtil';
+export * from './src/decorator/Schedule';

core/schedule-decorator/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@eggjs/tegg-schedule-decorator",
+  "version": "1.4.1",
+  "description": "tegg schedule decorator",
+  "main": "dist/index.js",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "typings": "dist/index.d.ts",
+  "keywords": [
+    "egg",
+    "typescript",
+    "runtime",
+    "tegg"
+  ],
+  "scripts": {
+    "clean": "tsc -b --clean",
+    "tsc": "npm run clean && tsc -p ./tsconfig.json",
+    "tsc:pub": "npm run clean && tsc -p ./tsconfig.pub.json",
+    "prepublishOnly": "npm run tsc:pub",
+    "autod": "autod"
+  },
+  "author": "killagu <[email protected]>",
+  "license": "MIT",
+  "homepage": "https://github.com/eggjs/tegg",
+  "bugs": {
+    "url": "https://github.com/eggjs/tegg/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "[email protected]:eggjs/tegg.git",
+    "directory": "core/schedule-decorator"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {
+    "@eggjs/core-decorator": "^1.3.0",
+    "@eggjs/tegg-common-util": "^1.1.1",
+    "@eggjs/tegg-metadata": "^1.3.0",
+    "cron-parser": "^2.18.0"
+  },
+  "devDependencies": {
+    "egg-schedule": "^3.6.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

core/schedule-decorator/src/builder/ScheduleMetaBuilder.ts

@@ -0,0 +1,33 @@
+import { EggProtoImplClass } from '@eggjs/core-decorator';
+import { ScheduleMetadata } from '../model/ScheduleMetadata';
+import { ScheduleInfoUtil } from '../util/ScheduleInfoUtil';
+import { ScheduleOptions } from '../decorator/Schedule';
+
+const DEFAULT_SCHEDULE_OPTIONS: ScheduleOptions = {
+  immediate: false,
+  disable: false,
+  env: undefined,
+};
+
+export class ScheduleMetaBuilder {
+  private readonly clazz: EggProtoImplClass;
+
+  constructor(clazz: EggProtoImplClass) {
+    this.clazz = clazz;
+  }
+
+  build(): ScheduleMetadata<object> {
+    const params = ScheduleInfoUtil.getScheduleParams(this.clazz);
+    if (!params) {
+      throw new Error(`class ${this.clazz.name} is not a schedule`);
+    }
+    const options = ScheduleInfoUtil.getScheduleOptions(this.clazz);
+    const scheduleOptions = Object.assign({}, DEFAULT_SCHEDULE_OPTIONS, options);
+    return new ScheduleMetadata<object>(
+      params.type,
+      params.scheduleData,
+      scheduleOptions.immediate!,
+      scheduleOptions.disable!,
+      scheduleOptions.env);
+  }
+}

core/schedule-decorator/src/decorator/Schedule.ts

@@ -0,0 +1,52 @@
+import { ScheduleTypeLike } from '../model/ScheduleMetadata';
+import { AccessLevel, ContextProto, EggProtoImplClass, PrototypeUtil } from '@eggjs/core-decorator';
+import { ScheduleInfoUtil } from '../util/ScheduleInfoUtil';
+import { StackUtil } from '@eggjs/tegg-common-util';
+
+export interface ScheduleParams<T> {
+  type: ScheduleTypeLike;
+  scheduleData: T;
+}
+
+export interface CronParams {
+  cron: string;
+  cronOptions?: any;
+}
+
+export interface IntervalParams {
+  interval: string | number;
+}
+
+export type CronScheduleParams = ScheduleParams<CronParams>;
+export type IntervalScheduleParams = ScheduleParams<IntervalParams>;
+
+export interface ScheduleOptions {
+  // default is false
+  immediate?: boolean;
+  // default is false
+  disable?: boolean;
+  // if env has value, only run in this envs
+  env?: Array<string>;
+}
+
+export interface ScheduleSubscriber {
+  subscribe(data?: any): Promise<any>;
+}
+
+export function Schedule<T>(param: ScheduleParams<T>, options?: ScheduleOptions) {
+  return function(clazz: EggProtoImplClass<ScheduleSubscriber>) {
+    ScheduleInfoUtil.setIsSchedule(true, clazz);
+    ScheduleInfoUtil.setScheduleParams(param, clazz);
+    if (options) {
+      ScheduleInfoUtil.setScheduleOptions(options, clazz);
+    }
+    const func = ContextProto({
+      name: clazz.name,
+      accessLevel: AccessLevel.PUBLIC,
+    });
+    func(clazz);
+
+    PrototypeUtil.setFilePath(clazz, StackUtil.getCalleeFromStack(false, 5));
+  };
+}
+

core/schedule-decorator/src/model/ScheduleMetadata.ts

@@ -0,0 +1,27 @@
+export enum ScheduleType {
+  WORKER = 'worker',
+  ALL = 'all',
+}
+
+export type ScheduleTypeLike = ScheduleType | string;
+
+export class ScheduleMetadata<T> {
+  type: ScheduleTypeLike;
+  scheduleData: T;
+  immediate: boolean;
+  disable: boolean;
+  env: undefined | Array<string>;
+
+  constructor(type: ScheduleTypeLike, data: T, immediate: boolean, disable: boolean, env: undefined | Array<string>) {
+    this.type = type;
+    this.scheduleData = data;
+    this.immediate = immediate;
+    this.disable = disable;
+    this.env = env;
+  }
+
+  shouldRegister(env: string): boolean {
+    if (!this.env) return true;
+    return this.env.includes(env);
+  }
+}

core/schedule-decorator/src/util/ScheduleInfoUtil.ts

@@ -0,0 +1,32 @@
+import { EggProtoImplClass, MetadataUtil } from '@eggjs/core-decorator';
+import { ScheduleOptions, ScheduleParams } from '../decorator/Schedule';
+
+export const IS_SCHEDULE = Symbol.for('EggPrototype#isSchedule');
+export const SCHEDULE_PARAMS = Symbol.for('EggPrototype#schedule#params');
+export const SCHEDULE_OPTIONS = Symbol.for('EggPrototype#schedule#options');
+
+export class ScheduleInfoUtil {
+  static isSchedule(clazz: EggProtoImplClass): boolean {
+    return MetadataUtil.getBooleanMetaData(IS_SCHEDULE, clazz);
+  }
+
+  static setIsSchedule(isSchedule: boolean, clazz: EggProtoImplClass) {
+    MetadataUtil.defineMetaData(IS_SCHEDULE, isSchedule, clazz);
+  }
+
+  static setScheduleParams<T>(scheduleParams: ScheduleParams<T>, clazz: EggProtoImplClass) {
+    MetadataUtil.defineMetaData(SCHEDULE_PARAMS, scheduleParams, clazz);
+  }
+
+  static setScheduleOptions(scheduleParams: ScheduleOptions, clazz: EggProtoImplClass) {
+    MetadataUtil.defineMetaData(SCHEDULE_OPTIONS, scheduleParams, clazz);
+  }
+
+  static getScheduleOptions(clazz: EggProtoImplClass): ScheduleOptions | undefined {
+    return MetadataUtil.getMetaData(SCHEDULE_OPTIONS, clazz);
+  }
+
+  static getScheduleParams(clazz: EggProtoImplClass): ScheduleParams<object> | undefined {
+    return MetadataUtil.getMetaData(SCHEDULE_PARAMS, clazz);
+  }
+}

core/schedule-decorator/src/util/ScheduleMetadataUtil.ts

@@ -0,0 +1,14 @@
+import { EggProtoImplClass, MetadataUtil } from '@eggjs/core-decorator';
+import { ScheduleMetadata } from '../model/ScheduleMetadata';
+
+export const SCHEDULE_METADATA = Symbol.for('EggPrototype#schedule#metadata');
+
+export class ScheduleMetadataUtil {
+  static setScheduleMetadata(clazz: EggProtoImplClass, metaData: ScheduleMetadata<object>) {
+    MetadataUtil.defineMetaData(SCHEDULE_METADATA, metaData, clazz);
+  }
+
+  static getScheduleMetadata(clazz): ScheduleMetadata<object> | undefined {
+    return MetadataUtil.getMetaData(SCHEDULE_METADATA, clazz);
+  }
+}

core/schedule-decorator/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "baseUrl": "./"
+  },
+  "exclude": [
+    "dist",
+    "node_modules"
+  ]
+}

core/schedule-decorator/tsconfig.pub.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "baseUrl": "./"
+  },
+  "exclude": [
+    "dist",
+    "node_modules",
+    "test"
+  ]
+}