@clairejs/server 3.23.3 → 3.23.5

package/README.md

@@ -1,7 +1,9 @@
 ## Change Log
 
-#### 3.23.3
+#### 3.23.5
 
+-   handle syncJobs being called multiple times
+-   fix abstract job scheduler & job model
 -   remove jobId fallback and update schedule job logic
 -   fix fallback jobId by id in AbstractJob
 -   fix retryDelayMs

package/dist/job/AbstractJobScheduler.d.ts

@@ -13,10 +13,11 @@ export declare abstract class AbstractJobScheduler {
     private _jobs;
     constructor(logger: AbstractLogger, db: ITransactionFactory, jobRepo: AbstractJobRepository);
     protected getCurrentJobHandlers(): Promise<JobHandlerMetadata[]>;
+    protected abstract getScheduledJobs(): Promise<AbstractJob[]>;
     /**
      * Sync all jobs to running state. This should be called only at init time.
      */
-    abstract syncJobs(): Promise<void>;
+    syncJobs(): Promise<void>;
     /**
      * Return unique job id which can then be used to cancel the job
      * @param payload the necessary info to launch the job

package/dist/job/AbstractJobScheduler.js

@@ -22,6 +22,51 @@ export class AbstractJobScheduler {
         }
         return this._jobs;
     }
+    /**
+     * Sync all jobs to running state. This should be called only at init time.
+     */
+    async syncJobs() {
+        //-- check jobs
+        const scheduledJobs = await this.getScheduledJobs();
+        const allHandlers = await this.getCurrentJobHandlers();
+        const tx = await this.db.createTransaction();
+        //-- remove job that no more exist
+        const nomoreExistJobs = scheduledJobs.filter((job) => !allHandlers.find((handler) => handler.jobName === job.jobName));
+        for (const job of nomoreExistJobs) {
+            this.logger.info(`Removing stale job: ${job.jobName} of id: ${job.id}`);
+            await this.disableJob(job.id, tx);
+        }
+        if (nomoreExistJobs.length) {
+            this.logger.info(`Cleaned up: ${nomoreExistJobs.length} stale jobs`);
+        }
+        //-- remove scheduled cron jobs that diff the cron expression
+        this.logger.debug("Remove scheduled cron jobs");
+        const scheduledCronJobs = scheduledJobs.filter((j) => j.cron);
+        const updatedScheduledCronJobs = scheduledCronJobs.filter((j) => j.cron && allHandlers.some((job) => job.jobName === j.jobName && job.cron !== j.cron));
+        for (const job of updatedScheduledCronJobs) {
+            await this.disableJob(job.id, tx);
+        }
+        await tx.commit();
+        //-- reschedule new cron jobs and those which are not synced
+        const resyncCronJobs = allHandlers.filter((job) => job.cron &&
+            (updatedScheduledCronJobs.some((j) => j.jobName === job.jobName) ||
+                !scheduledCronJobs.some((j) => j.jobName === job.jobName)));
+        this.logger.debug(`Resync ${resyncCronJobs.length} cron jobs`, resyncCronJobs);
+        for (const job of resyncCronJobs) {
+            await this.scheduleJob({
+                ...job.retryOptions,
+                jobName: job.jobName,
+                cron: job.cron,
+                at: job.at,
+            });
+        }
+        //-- sync "at" jobs
+        const allPersistedAtJobs = await this.jobRepo.getJobs({ _neq: { disabled: true, at: undefined } });
+        const missingScheduledAtJobs = allPersistedAtJobs.filter((job) => !scheduledJobs.find((scheduled) => scheduled.id === job.id));
+        for (const job of missingScheduledAtJobs) {
+            await this.scheduleJob(job);
+        }
+    }
     async scheduleJob({ id, ...payload }) {
         let jobId = id;
         const tx = await this.db.createTransaction();
@@ -31,7 +76,9 @@ export class AbstractJobScheduler {
         else {
             const job = jobId
                 ? await this.jobRepo.getJobById(jobId)
-                : await this.jobRepo.getJobs({ _eq: { jobName: payload.cron } }, { limit: 1 }).then((jobs) => jobs[0]);
+                : await this.jobRepo
+                    .getJobs({ _eq: { jobName: payload.jobName } }, { limit: 1 })
+                    .then((jobs) => jobs[0]);
             if (!job) {
                 jobId = await this.jobRepo.insertJob(payload, tx);
             }

package/dist/job/AwsJobScheduler.d.ts

@@ -19,8 +19,7 @@ export declare class AwsJobScheduler extends AbstractJobScheduler {
     constructor(logger: AbstractLogger, db: AbstractDbAdapter, jobRepo: AbstractJobRepository, apiLambdaFunctionArn: string, jobNamespace: string, eventBusName?: string);
     handleCron(jobInfo: AbstractJob): Promise<void>;
     private generateCronFromTimestamp;
-    getAllScheduledJobs(): Promise<AbstractJob[]>;
+    protected getScheduledJobs(): Promise<AbstractJob[]>;
     protected _scheduleJob(jobInfo: AbstractJob): Promise<void>;
-    syncJobs(): Promise<void>;
     cancelJob(jobId: string): Promise<void>;
 }

package/dist/job/AwsJobScheduler.js

@@ -49,7 +49,7 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
             date.getUTCFullYear(),
         ].join(" ");
     }
-    async getAllScheduledJobs() {
+    async getScheduledJobs() {
         const allRules = await this.eventbridge
             .listRules({
             EventBusName: this.eventBusName,
@@ -125,39 +125,6 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
             throw Errors.SYSTEM_ERROR(`Job does not have time config: ${jobInfo.jobName}`);
         }
     }
-    async syncJobs() {
-        //-- check jobs
-        const scheduledJobs = await this.getAllScheduledJobs();
-        const allHandlers = await this.getCurrentJobHandlers();
-        //-- remove job that no more exist
-        const nomoreExistJobs = scheduledJobs.filter((job) => !allHandlers.find((handler) => handler.jobName === job.jobName));
-        for (const job of nomoreExistJobs) {
-            this.logger.info(`Removing stale job: ${job.jobName} of id: ${job.id}`);
-            await this.disableJob(job.id);
-        }
-        if (nomoreExistJobs.length) {
-            this.logger.info(`Cleaned up: ${nomoreExistJobs.length} stale jobs`);
-        }
-        //-- remove scheduled cron jobs that diff the cron expression
-        this.logger.debug("Remove scheduled cron jobs");
-        const scheduledCronJobs = scheduledJobs.filter((j) => j.cron);
-        const unmatchedCronJobs = scheduledCronJobs.filter((j) => j.cron && !allHandlers.find((job) => job.jobName === j.jobName && job.cron === j.cron));
-        if (unmatchedCronJobs.length) {
-            await Promise.all(unmatchedCronJobs.map((j) => this.disableJob(j.id)));
-        }
-        //-- reschedule new cron jobs and those which are not synced
-        const resyncCronJobs = allHandlers.filter((job) => job.cron &&
-            (unmatchedCronJobs.some((j) => j.jobName === job.jobName) ||
-                !scheduledCronJobs.some((j) => j.jobName === job.jobName)));
-        this.logger.debug("Reschedule cron jobs", resyncCronJobs);
-        for (const job of resyncCronJobs) {
-            await this.scheduleJob({
-                jobName: job.jobName,
-                cron: job.cron,
-            });
-        }
-        //-- keep "at" jobs as is
-    }
     async cancelJob(jobId) {
         await this.eventbridge
             .removeTargets({

package/dist/job/LocalJobScheduler.d.ts

@@ -52,6 +52,7 @@ export declare class LocalJobScheduler extends AbstractJobScheduler implements I
     private extendMutexKey;
     init(): Promise<void>;
     exit(): void;
+    protected getScheduledJobs(): Promise<AbstractJob[]>;
     syncJobs(): Promise<void>;
     protected _scheduleJob(jobInfo: AbstractJob): Promise<void>;
     protected cancelJob(jobId: string): Promise<void>;

package/dist/job/LocalJobScheduler.js

@@ -142,25 +142,12 @@ let LocalJobScheduler = class LocalJobScheduler extends AbstractJobScheduler {
         }
         this.logger.debug("LocalJobScheduler exit");
     }
+    async getScheduledJobs() {
+        return Object.values(this.jobHolder).flatMap((job) => (job?.jobInfo ? [job.jobInfo] : []));
+    }
     async syncJobs() {
         if (this.isActive) {
-            //-- schedule all cron & interval jobs
-            const allJobs = await this.getCurrentJobHandlers();
-            for (const job of allJobs) {
-                if (job.cron) {
-                    await this.scheduleJob({
-                        ...job.retryOptions,
-                        jobName: job.jobName,
-                        cron: job.cron,
-                    });
-                }
-            }
-            //-- re-schedule "at" jobs that are stored in repo
-            const allPersistedJobs = await this.jobRepo.getJobs({ _neq: { disabled: true, at: undefined } });
-            //-- run job anyway, expired job will be removed then
-            for (const job of allPersistedJobs) {
-                await this.scheduleJob(job);
-            }
+            await super.syncJobs();
         }
         else {
             this.sendJob(CommunicationMessage.SYNC_JOB);

package/dist/job/job.js

@@ -83,10 +83,14 @@ __decorate([
     __metadata("design:type", String)
 ], AbstractJobModel.prototype, "lastError", void 0);
 __decorate([
-    Column({}),
+    Column({
+        isTimestamp: true,
+    }),
     __metadata("design:type", Number)
 ], AbstractJobModel.prototype, "lastRunAt", void 0);
 __decorate([
-    Column({}),
+    Column({
+        isTimestamp: true,
+    }),
     __metadata("design:type", Number)
 ], AbstractJobModel.prototype, "lastSuccessAt", void 0);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@clairejs/server",
-    "version": "3.23.3",
+    "version": "3.23.5",
     "description": "Claire server NodeJs framework written in Typescript.",
     "types": "dist/index.d.ts",
     "main": "dist/index.js",