@ruiapp/rapid-core 0.6.4 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @ruiapp/rapid-core
 
+## 0.7.0
+
+- feature: added server.registerCronJob to allow plugins register cron jobs.
+
 ## 0.2.4
 
 ### Patch Changes

package/dist/core/pluginManager.d.ts

@@ -28,6 +28,8 @@ declare class PluginManager {
     configureServices(applicationConfig: RpdApplicationConfig): Promise<void>;
     /** 配置路由 */
     configureRoutes(applicationConfig: RpdApplicationConfig): Promise<void>;
+    /** 配置定时任务 */
+    registerCronJobs(): Promise<void>;
     /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
     onApplicationLoaded(applicationConfig: RpdApplicationConfig): Promise<void>;
     /** 在应用准备完成后调用。此时服务器已经可以处理网络请求。 */

package/dist/core/routeContext.d.ts

@@ -21,7 +21,7 @@ export declare class RouteContext {
     set(headerName: string, headerValue: string): void;
     json(obj: any, status?: HttpStatus, headers?: HeadersInit): void;
     redirect(url: string, status?: HttpStatus): void;
-    getDbTransactionClient(): IDatabaseClient | null;
+    getDbTransactionClient(): IDatabaseClient | undefined;
     beginDbTransaction(): Promise<IDatabaseClient>;
     commitDbTransaction(): Promise<void>;
     rollbackDbTransaction(): Promise<void>;

package/dist/core/server.d.ts

@@ -4,6 +4,7 @@ import { Next, RouteContext } from "./routeContext";
 import EntityManager from "../dataAccess/entityManager";
 import { Logger } from "../facilities/log/LogFacility";
 import { FacilityFactory } from "./facility";
+import { CronJobConfiguration } from "../types/cron-job-types";
 export interface IRpdServer {
     config: RapidServerConfig;
     databaseConfig: IDatabaseConfig;
@@ -32,6 +33,8 @@ export interface IRpdServer {
     beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
     beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
     beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any): Promise<void>;
+    registerCronJob(job: CronJobConfiguration): void;
+    listCronJobs(): CronJobConfiguration[];
 }
 export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
 export interface RpdConfigurationItemOptions {
@@ -94,6 +97,8 @@ export interface RapidPlugin {
     configureServices?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
     /** 配置路由 */
     configureRoutes?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+    /** 注册定时任务 */
+    registerCronJobs?: (server: IRpdServer) => Promise<any>;
     /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
     onApplicationLoaded?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
     /** 在应用准备完成后调用。此时服务器已经可以处理网络请求，可以对外广播消息。 */

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./types";
+export * from "./types/cron-job-types";
 export * from "./server";
 export * from "./core/facility";
 export * from "./core/request";

package/dist/index.js

@@ -839,6 +839,14 @@ class PluginManager {
             }
         }
     }
+    /** 配置定时任务 */
+    async registerCronJobs() {
+        for (const plugin of this.#plugins) {
+            if (plugin.registerCronJobs) {
+                await plugin.registerCronJobs(this.#server);
+            }
+        }
+    }
     /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
     async onApplicationLoaded(applicationConfig) {
         for (const plugin of this.#plugins) {
@@ -1067,7 +1075,6 @@ class RouteContext {
     }
     constructor(server, request) {
         this.#server = server;
-        this.#dbTransactionClient = null;
         this.databaseAccessor = server.getDatabaseAccessor();
         this.request = request;
         this.state = {};
@@ -4262,6 +4269,9 @@ class RapidServer {
     #entityBeforeResponseEventEmitters;
     #entityWatchers;
     #appEntityWatchers;
+    #cronJobs;
+    #appCronJobs;
+    #disableCronJobs;
     #cachedEntityManager;
     #services;
     queryBuilder;
@@ -4305,6 +4315,9 @@ class RapidServer {
         this.registerEventHandler("entity.beforeResponse", this.#handleEntityEvent.bind(this, "entity.beforeResponse"));
         this.#entityWatchers = [];
         this.#appEntityWatchers = options.entityWatchers || [];
+        this.#cronJobs = [];
+        this.#appCronJobs = options.cronJobs || [];
+        this.#disableCronJobs = !!options.disableCronJobs;
         this.#services = new Map();
         this.queryBuilder = new QueryBuilder({
             dbDefaultSchema: options.databaseConfig.dbDefaultSchema,
@@ -4457,6 +4470,16 @@ class RapidServer {
     getService(name) {
         return this.#services.get(name);
     }
+    registerCronJob(job) {
+        const jobDuplicate = lodash.find(this.#cronJobs, (item) => item.code === job.code);
+        if (jobDuplicate) {
+            this.#logger.warn(`Duplicated cron job with code "${job.code}"`);
+        }
+        this.#cronJobs.push(job);
+    }
+    listCronJobs() {
+        return [...this.#cronJobs, ...this.#appCronJobs];
+    }
     async start() {
         this.#logger.info("Starting rapid server...");
         const pluginManager = this.#pluginManager;
@@ -4498,6 +4521,9 @@ class RapidServer {
             }
         }
         await this.configureApplication();
+        if (!this.#disableCronJobs) {
+            await pluginManager.registerCronJobs();
+        }
         this.#logger.info(`Rapid server ready.`);
         await pluginManager.onApplicationReady(this.#applicationConfig);
     }
@@ -8421,10 +8447,8 @@ var runCronJob = {
 var pluginRoutes$1 = [runCronJob];
 
 class CronJobPlugin {
-    #jobs;
-    constructor(options) {
-        this.#jobs = options.jobs || [];
-    }
+    #server;
+    constructor() { }
     get code() {
         return "cronJob";
     }
@@ -8440,7 +8464,9 @@ class CronJobPlugin {
     get configurations() {
         return [];
     }
-    async initPlugin(server) { }
+    async initPlugin(server) {
+        this.#server = server;
+    }
     async registerMiddlewares(server) { }
     async registerActionHandlers(server) {
         for (const actionHandler of pluginActionHandlers$1) {
@@ -8458,7 +8484,8 @@ class CronJobPlugin {
     }
     async onApplicationLoaded(server, applicationConfig) { }
     async onApplicationReady(server, applicationConfig) {
-        for (const job of this.#jobs) {
+        const cronJobs = server.listCronJobs();
+        for (const job of cronJobs) {
             const jobInstance = cron__namespace.CronJob.from({
                 ...(job.jobOptions || {}),
                 cronTime: job.cronTime,
@@ -8471,7 +8498,7 @@ class CronJobPlugin {
         }
     }
     getJobConfigurationByCode(code) {
-        return lodash.find(this.#jobs, (job) => job.code === code);
+        return lodash.find(this.#server.listCronJobs(), (job) => job.code === code);
     }
     async executeJob(server, job) {
         const logger = server.getLogger();

package/dist/plugins/cronJob/CronJobPlugin.d.ts

@@ -1,9 +1,9 @@
 import type { RpdApplicationConfig } from "../../types";
-import { CronJobConfiguration, CronJobPluginInitOptions } from "./CronJobPluginTypes";
+import { CronJobConfiguration } from "../../types/cron-job-types";
 import { IRpdServer, RapidPlugin, RpdConfigurationItemOptions, RpdServerPluginConfigurableTargetOptions, RpdServerPluginExtendingAbilities } from "../../core/server";
 declare class CronJobPlugin implements RapidPlugin {
     #private;
-    constructor(options: CronJobPluginInitOptions);
+    constructor();
     get code(): string;
     get description(): string;
     get extendingAbilities(): RpdServerPluginExtendingAbilities[];

package/dist/plugins/cronJob/CronJobPluginTypes.d.ts

@@ -1,50 +1,3 @@
-import { ActionHandlerContext } from "../../core/actionHandler";
-export interface CronJobConfiguration {
-    /**
-     * 定时任务编号
-     */
-    code: string;
-    /**
-     * 定时任务描述
-     */
-    description?: string;
-    /**
-     * crontab 表达式
-     */
-    cronTime: string;
-    /**
-     * 任务设置
-     */
-    jobOptions?: CronJobOptions;
-    /**
-     * 任务处理程序编号。当指定处理程序编号时，忽略 handler 配置。
-     */
-    actionHandlerCode?: string;
-    /**
-     * 定时任务处理程序
-     * @param ctx
-     * @param options
-     * @returns
-     */
-    handler?: (ctx: ActionHandlerContext, options: any) => Promise<void>;
-    /**
-     * 处理定时任务时的设置选项
-     */
-    handleOptions?: any;
-}
-export interface CronJobOptions {
-    /**
-     * Instantly triggers the onTick function post initialization. Default is false.
-     */
-    runOnInit?: boolean;
-    /**
-     * If true, no additional instances of the onTick callback function will run until the current onTick callback has completed. Any new scheduled executions that occur while the current callback is running will be skipped entirely. Default is false.
-     */
-    waitForCompletion?: boolean;
-}
-export interface CronJobPluginInitOptions {
-    jobs: CronJobConfiguration[];
-}
 export type RunCronJobActionHandlerOptions = {
     code?: string;
 };

package/dist/server.d.ts

@@ -5,6 +5,7 @@ import { Next } from "./core/routeContext";
 import EntityManager from "./dataAccess/entityManager";
 import { Logger } from "./facilities/log/LogFacility";
 import { FacilityFactory } from "./core/facility";
+import { CronJobConfiguration } from "./types/cron-job-types";
 export interface InitServerOptions {
     logger: Logger;
     databaseAccessor: IDatabaseAccessor;
@@ -14,6 +15,14 @@ export interface InitServerOptions {
     facilityFactories?: FacilityFactory[];
     plugins?: RapidPlugin[];
     entityWatchers?: EntityWatcherType[];
+    /**
+     * Application level cron jobs.
+     */
+    cronJobs?: CronJobConfiguration[];
+    /**
+     * All cron jobs of the server will be disabled if set `true`.
+     */
+    disableCronJobs?: boolean;
 }
 export declare class RapidServer implements IRpdServer {
     #private;
@@ -37,6 +46,8 @@ export declare class RapidServer implements IRpdServer {
     emitEvent<TEventName extends keyof RpdServerEventTypes>(event: EmitServerEventOptions<TEventName>): Promise<void>;
     registerService(name: string, service: any): void;
     getService<TService>(name: string): TService;
+    registerCronJob(job: CronJobConfiguration): void;
+    listCronJobs(): CronJobConfiguration[];
     start(): Promise<void>;
     configureApplication(): Promise<void>;
     registerFacilityFactory(factory: FacilityFactory): void;

package/dist/types/cron-job-types.d.ts

@@ -0,0 +1,44 @@
+import { ActionHandlerContext } from "../core/actionHandler";
+export interface CronJobConfiguration {
+    /**
+     * 定时任务编号
+     */
+    code: string;
+    /**
+     * 定时任务描述
+     */
+    description?: string;
+    /**
+     * crontab 表达式
+     */
+    cronTime: string;
+    /**
+     * 任务设置
+     */
+    jobOptions?: CronJobOptions;
+    /**
+     * 任务处理程序编号。当指定处理程序编号时，忽略 handler 配置。
+     */
+    actionHandlerCode?: string;
+    /**
+     * 定时任务处理程序
+     * @param ctx
+     * @param options
+     * @returns
+     */
+    handler?: (ctx: ActionHandlerContext, options: any) => Promise<void>;
+    /**
+     * 处理定时任务时的设置选项
+     */
+    handleOptions?: any;
+}
+export interface CronJobOptions {
+    /**
+     * Instantly triggers the onTick function post initialization. Default is false.
+     */
+    runOnInit?: boolean;
+    /**
+     * If true, no additional instances of the onTick callback function will run until the current onTick callback has completed. Any new scheduled executions that occur while the current callback is running will be skipped entirely. Default is false.
+     */
+    waitForCompletion?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-core",
-  "version": "0.6.4",
+  "version": "0.7.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/core/pluginManager.ts

@@ -117,6 +117,15 @@ class PluginManager {
     }
   }
 
+  /** 配置定时任务 */
+  async registerCronJobs() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerCronJobs) {
+        await plugin.registerCronJobs(this.#server);
+      }
+    }
+  }
+
   /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
   async onApplicationLoaded(applicationConfig: RpdApplicationConfig) {
     for (const plugin of this.#plugins) {

package/src/core/routeContext.ts

@@ -20,7 +20,7 @@ export class RouteContext {
   params: Record<string, string>;
   routeConfig: any;
   #server: IRpdServer;
-  #dbTransactionClient: IDatabaseClient | null;
+  #dbTransactionClient: IDatabaseClient | undefined;
 
   static newSystemOperationContext(server: IRpdServer) {
     return new RouteContext(server);
@@ -28,7 +28,6 @@ export class RouteContext {
 
   constructor(server: IRpdServer, request?: RapidRequest) {
     this.#server = server;
-    this.#dbTransactionClient = null;
     this.databaseAccessor = server.getDatabaseAccessor();
     this.request = request;
     this.state = {};
@@ -68,7 +67,7 @@ export class RouteContext {
     this.response.redirect(url, status);
   }
 
-  getDbTransactionClient(): IDatabaseClient | null {
+  getDbTransactionClient(): IDatabaseClient | undefined {
     return this.#dbTransactionClient;
   }
 

package/src/core/server.ts

@@ -21,6 +21,7 @@ import { Next, RouteContext } from "./routeContext";
 import EntityManager from "~/dataAccess/entityManager";
 import { Logger } from "~/facilities/log/LogFacility";
 import { FacilityFactory } from "./facility";
+import { CronJobConfiguration } from "~/types/cron-job-types";
 
 export interface IRpdServer {
   config: RapidServerConfig;
@@ -53,6 +54,9 @@ export interface IRpdServer {
   beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
   beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
   beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any): Promise<void>;
+
+  registerCronJob(job: CronJobConfiguration): void;
+  listCronJobs(): CronJobConfiguration[];
 }
 
 export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
@@ -130,6 +134,8 @@ export interface RapidPlugin {
   configureServices?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
   /** 配置路由 */
   configureRoutes?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+  /** 注册定时任务 */
+  registerCronJobs?: (server: IRpdServer) => Promise<any>;
   /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
   onApplicationLoaded?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
   /** 在应用准备完成后调用。此时服务器已经可以处理网络请求，可以对外广播消息。 */

package/src/index.ts

@@ -2,6 +2,7 @@ import { fixBigIntJSONSerialize } from "./polyfill";
 fixBigIntJSONSerialize();
 
 export * from "./types";
+export * from "./types/cron-job-types";
 export * from "./server";
 
 export * from "./core/facility";

package/src/plugins/cronJob/CronJobPlugin.ts

@@ -2,7 +2,7 @@ import * as cron from "cron";
 import type { RpdApplicationConfig } from "~/types";
 import pluginActionHandlers from "./actionHandlers";
 import pluginRoutes from "./routes";
-import { CronJobConfiguration, CronJobPluginInitOptions } from "./CronJobPluginTypes";
+import { CronJobConfiguration } from "~/types/cron-job-types";
 import {
   IRpdServer,
   RapidPlugin,
@@ -14,11 +14,9 @@ import { ActionHandlerContext } from "~/core/actionHandler";
 import { find } from "lodash";
 
 class CronJobPlugin implements RapidPlugin {
-  #jobs: CronJobConfiguration[];
+  #server: IRpdServer;
 
-  constructor(options: CronJobPluginInitOptions) {
-    this.#jobs = options.jobs || [];
-  }
+  constructor() {}
 
   get code(): string {
     return "cronJob";
@@ -40,7 +38,9 @@ class CronJobPlugin implements RapidPlugin {
     return [];
   }
 
-  async initPlugin(server: IRpdServer): Promise<any> {}
+  async initPlugin(server: IRpdServer): Promise<any> {
+    this.#server = server;
+  }
 
   async registerMiddlewares(server: IRpdServer): Promise<any> {}
 
@@ -69,7 +69,8 @@ class CronJobPlugin implements RapidPlugin {
   async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
 
   async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    for (const job of this.#jobs) {
+    const cronJobs = server.listCronJobs();
+    for (const job of cronJobs) {
       const jobInstance = cron.CronJob.from({
         ...(job.jobOptions || {}),
         cronTime: job.cronTime,
@@ -83,7 +84,7 @@ class CronJobPlugin implements RapidPlugin {
   }
 
   getJobConfigurationByCode(code: string) {
-    return find(this.#jobs, (job) => job.code === code);
+    return find(this.#server.listCronJobs(), (job) => job.code === code);
   }
 
   async executeJob(server: IRpdServer, job: CronJobConfiguration) {

package/src/plugins/cronJob/CronJobPluginTypes.ts

@@ -1,61 +1,3 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-
-export interface CronJobConfiguration {
-  /**
-   * 定时任务编号
-   */
-  code: string;
-
-  /**
-   * 定时任务描述
-   */
-  description?: string;
-
-  /**
-   * crontab 表达式
-   */
-  cronTime: string;
-
-  /**
-   * 任务设置
-   */
-  jobOptions?: CronJobOptions;
-
-  /**
-   * 任务处理程序编号。当指定处理程序编号时，忽略 handler 配置。
-   */
-  actionHandlerCode?: string;
-
-  /**
-   * 定时任务处理程序
-   * @param ctx
-   * @param options
-   * @returns
-   */
-  handler?: (ctx: ActionHandlerContext, options: any) => Promise<void>;
-
-  /**
-   * 处理定时任务时的设置选项
-   */
-  handleOptions?: any;
-}
-
-export interface CronJobOptions {
-  /**
-   * Instantly triggers the onTick function post initialization. Default is false.
-   */
-  runOnInit?: boolean;
-
-  /**
-   * If true, no additional instances of the onTick callback function will run until the current onTick callback has completed. Any new scheduled executions that occur while the current callback is running will be skipped entirely. Default is false.
-   */
-  waitForCompletion?: boolean;
-}
-
-export interface CronJobPluginInitOptions {
-  jobs: CronJobConfiguration[];
-}
-
 export type RunCronJobActionHandlerOptions = {
   code?: string;
 };

package/src/server.ts

@@ -33,6 +33,7 @@ import EntityManager from "./dataAccess/entityManager";
 import { bind, cloneDeep, find, forEach, merge, omit } from "lodash";
 import { Logger } from "./facilities/log/LogFacility";
 import { FacilityFactory } from "./core/facility";
+import { CronJobConfiguration } from "./types/cron-job-types";
 
 export interface InitServerOptions {
   logger: Logger;
@@ -43,6 +44,16 @@ export interface InitServerOptions {
   facilityFactories?: FacilityFactory[];
   plugins?: RapidPlugin[];
   entityWatchers?: EntityWatcherType[];
+
+  /**
+   * Application level cron jobs.
+   */
+  cronJobs?: CronJobConfiguration[];
+
+  /**
+   * All cron jobs of the server will be disabled if set `true`.
+   */
+  disableCronJobs?: boolean;
 }
 
 export class RapidServer implements IRpdServer {
@@ -70,6 +81,10 @@ export class RapidServer implements IRpdServer {
   #entityWatchers: EntityWatcherType[];
   #appEntityWatchers: EntityWatcherType[];
 
+  #cronJobs: CronJobConfiguration[];
+  #appCronJobs: CronJobConfiguration[];
+  #disableCronJobs: boolean;
+
   #cachedEntityManager: Map<string, EntityManager>;
   #services: Map<string, any>;
   queryBuilder: IQueryBuilder;
@@ -121,6 +136,10 @@ export class RapidServer implements IRpdServer {
     this.#entityWatchers = [];
     this.#appEntityWatchers = options.entityWatchers || [];
 
+    this.#cronJobs = [];
+    this.#appCronJobs = options.cronJobs || [];
+    this.#disableCronJobs = !!options.disableCronJobs;
+
     this.#services = new Map();
 
     this.queryBuilder = new QueryBuilder({
@@ -298,6 +317,19 @@ export class RapidServer implements IRpdServer {
     return this.#services.get(name);
   }
 
+  registerCronJob(job: CronJobConfiguration): void {
+    const jobDuplicate = find(this.#cronJobs, (item: CronJobConfiguration) => item.code === job.code);
+    if (jobDuplicate) {
+      this.#logger.warn(`Duplicated cron job with code "${job.code}"`);
+    }
+
+    this.#cronJobs.push(job);
+  }
+
+  listCronJobs() {
+    return [...this.#cronJobs, ...this.#appCronJobs];
+  }
+
   async start() {
     this.#logger.info("Starting rapid server...");
     const pluginManager = this.#pluginManager;
@@ -336,6 +368,10 @@ export class RapidServer implements IRpdServer {
 
     await this.configureApplication();
 
+    if (!this.#disableCronJobs) {
+      await pluginManager.registerCronJobs();
+    }
+
     this.#logger.info(`Rapid server ready.`);
     await pluginManager.onApplicationReady(this.#applicationConfig);
   }

package/src/types/cron-job-types.ts

@@ -0,0 +1,53 @@
+import { ActionHandlerContext } from "~/core/actionHandler";
+
+export interface CronJobConfiguration {
+  /**
+   * 定时任务编号
+   */
+  code: string;
+
+  /**
+   * 定时任务描述
+   */
+  description?: string;
+
+  /**
+   * crontab 表达式
+   */
+  cronTime: string;
+
+  /**
+   * 任务设置
+   */
+  jobOptions?: CronJobOptions;
+
+  /**
+   * 任务处理程序编号。当指定处理程序编号时，忽略 handler 配置。
+   */
+  actionHandlerCode?: string;
+
+  /**
+   * 定时任务处理程序
+   * @param ctx
+   * @param options
+   * @returns
+   */
+  handler?: (ctx: ActionHandlerContext, options: any) => Promise<void>;
+
+  /**
+   * 处理定时任务时的设置选项
+   */
+  handleOptions?: any;
+}
+
+export interface CronJobOptions {
+  /**
+   * Instantly triggers the onTick function post initialization. Default is false.
+   */
+  runOnInit?: boolean;
+
+  /**
+   * If true, no additional instances of the onTick callback function will run until the current onTick callback has completed. Any new scheduled executions that occur while the current callback is running will be skipped entirely. Default is false.
+   */
+  waitForCompletion?: boolean;
+}