@clairejs/server 3.28.0 → 3.28.2

package/README.md

@@ -1,6 +1,6 @@
 ## Change Log
 
-#### 3.28.0
+#### 3.28.2
 
 -   implement new job scheduler
 

package/dist/job/AbstractJobScheduler.d.ts

@@ -25,7 +25,7 @@ export declare abstract class AbstractJobScheduler {
      */
     protected abstract cancelJob(id: string): Promise<void>;
     protected abstract retryJob(job: AbstractJob, at: number): Promise<void>;
-    protected abstract cleanupJob(job: AbstractJob): Promise<void>;
+    protected abstract cleanupJob(id: string): Promise<void>;
     /**
      * Remove the scheduled job and prevent if from running in the future
      * @param id The job id returned from scheduleJobAt function
@@ -35,6 +35,6 @@ export declare abstract class AbstractJobScheduler {
      * Execute the scheduled job
      * @param job The schedled job info to execute
      */
-    protected executeJob(job: AbstractJob): Promise<void>;
+    protected executeJob(jobId: string): Promise<void>;
 }
 export {};

package/dist/job/AbstractJobScheduler.js

@@ -39,7 +39,12 @@ export class AbstractJobScheduler {
      * Execute the scheduled job
      * @param job The schedled job info to execute
      */
-    async executeJob(job) {
+    async executeJob(jobId) {
+        const job = await this.jobRepo.getJobById(jobId);
+        if (!job) {
+            await this.cancelJob(jobId);
+            return;
+        }
         if (job.disabled) {
             return;
         }
@@ -60,7 +65,7 @@ export class AbstractJobScheduler {
                 this.logger.debug(`Calling job handler for ${job.id}`);
                 await jobHandler.handlerFn(job);
                 this.logger.debug(`Job handler for ${job.id} completed`);
-                await this.cleanupJob(job).catch((err) => this.logger.error(`Failed to cleanup job: ${job.id}`, err));
+                await this.cleanupJob(job.id).catch((err) => this.logger.error(`Failed to cleanup job: ${job.id}`, err));
                 //-- job run success, update
                 update.lastSuccessAt = Date.now();
                 //-- reset retry count if this is cron job
@@ -78,16 +83,15 @@ export class AbstractJobScheduler {
                 update.failCount = (job.failCount || 0) + 1;
                 update.lastError = String(err);
                 //-- job run error, check retry
-                if (job.retryOnFail) {
-                    if ((job.retryCount || 0) < (job.maxRetry || 1)) {
-                        update.retryCount = (job.retryCount || 0) + 1;
-                        await this.retryJob({ ...job, ...update }, Date.now() + Math.max(job.retryDelayMs || 0, 60000));
+                const maxRetry = job.maxRetry || 0;
+                if (maxRetry) {
+                    const currentRetryCount = job.retryCount || 0;
+                    if (currentRetryCount < maxRetry) {
+                        await this.retryJob(job, Date.now() + Math.max(job.retryDelayMs || 0, 60000));
+                        update.retryCount = currentRetryCount + 1;
                     }
                     else {
-                        if (job.cron) {
-                            update.at = undefined;
-                        }
-                        else {
+                        if (job.at) {
                             update.disabled = true;
                             await this.cancelJob(job.id);
                         }
@@ -95,7 +99,6 @@ export class AbstractJobScheduler {
                 }
             }
             await this.jobRepo.updateJobById(job.id, update, tx);
-            Object.assign(job, update);
         }
         await tx.commit();
     }

package/dist/job/AwsJobScheduler.d.ts

@@ -13,13 +13,13 @@ export declare class AwsJobScheduler extends AbstractJobScheduler {
     protected readonly jobNamespace: string;
     protected readonly scheduler: SchedulerClient;
     constructor(logger: AbstractLogger, db: AbstractDbAdapter, jobRepo: AbstractJobRepository, apiLambdaFunctionArn: string, apiLambdaFunctionRoleArn: string, jobNamespace: string);
-    handleCron(jobInfo: AbstractJob): Promise<void>;
+    handleCron(jobInfo: Pick<AbstractJob, "id">): Promise<void>;
     private convertCronToSchedulerExpression;
     private getJobUniqueName;
     private getOneTimeExpression;
     private removeJobFromScheduler;
     protected retryJob(job: AbstractJob, at: number): Promise<void>;
-    protected cleanupJob(job: AbstractJob): Promise<void>;
+    protected cleanupJob(jobId: string): Promise<void>;
     protected registerJob(job: AbstractJob): Promise<void>;
     cancelJob(jobId: string): Promise<void>;
 }

package/dist/job/AwsJobScheduler.js

@@ -37,7 +37,7 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
     }
     async handleCron(jobInfo) {
         this.logger.debug(`Handle cron`, jobInfo);
-        await this.executeJob(jobInfo);
+        await this.executeJob(jobInfo.id);
     }
     convertCronToSchedulerExpression(cron) {
         // AWS Scheduler uses a different cron format than standard cron
@@ -71,8 +71,9 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
         await this.scheduler.send(deleteCommand);
     }
     async retryJob(job, at) {
-        const jobName = this.getJobUniqueName(job.id);
-        if (job.at) {
+        const { id, disabled, execCount, failCount, retryCount, lastError, lastRunAt, lastSuccessAt, ...payload } = job;
+        const jobName = this.getJobUniqueName(id);
+        if (at) {
             //-- update the job
             const getCommand = new GetScheduleCommand({
                 Name: jobName,
@@ -87,11 +88,11 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
         }
         else {
             //-- schedule a new one-time job to re-execute this cron with minus one maxRetry
-            await this.scheduleJob({ ...job, at, maxRetry: (job.maxRetry || 1) - 1 });
+            await this.scheduleJob({ ...payload, at, maxRetry: (payload.maxRetry || 0) - 1 });
         }
     }
-    async cleanupJob(job) {
-        return await this.removeJobFromScheduler(job.id);
+    async cleanupJob(jobId) {
+        return await this.removeJobFromScheduler(jobId);
     }
     async registerJob(job) {
         this.logger.debug("Scheduling job: ", job);
@@ -131,7 +132,7 @@ let AwsJobScheduler = class AwsJobScheduler extends AbstractJobScheduler {
                 Input: JSON.stringify({
                     requestContext: {
                         cronScheduler: {
-                            data: job,
+                            data: { id: job.id },
                         },
                     },
                 }),

package/dist/job/LocalJobScheduler.d.ts

@@ -54,7 +54,7 @@ export declare class LocalJobScheduler extends AbstractJobScheduler implements I
     init(): Promise<void>;
     exit(): void;
     protected retryJob(job: AbstractJob, at: number): Promise<void>;
-    protected cleanupJob(job: AbstractJob): Promise<void>;
+    protected cleanupJob(jobId: string): Promise<void>;
     protected registerJob(job: AbstractJob): Promise<void>;
     protected cancelJob(jobId: string): Promise<void>;
 }

package/dist/job/LocalJobScheduler.js

@@ -18,6 +18,7 @@ var CommunicationMessage;
 (function (CommunicationMessage) {
     CommunicationMessage["SCHEDULE_JOB"] = "SCHEDULE_JOB";
     CommunicationMessage["REMOVE_JOB"] = "REMOVE_JOB";
+    CommunicationMessage["CLEANUP_JOB"] = "CLEANUP_JOB";
 })(CommunicationMessage || (CommunicationMessage = {}));
 let LocalJobScheduler = class LocalJobScheduler extends AbstractJobScheduler {
     logger;
@@ -65,23 +66,26 @@ let LocalJobScheduler = class LocalJobScheduler extends AbstractJobScheduler {
         this.subscribeClient.publish(this.multiClientChannel, JSON.stringify({ type, data }));
     }
     async processMessage(type, data) {
+        if (!this.isActive) {
+            //-- not active scheduler, ignore
+            return;
+        }
         switch (type) {
-            case CommunicationMessage.SCHEDULE_JOB:
-                if (!this.isActive) {
-                    //-- not active scheduler, ignore
-                    return;
-                }
+            case CommunicationMessage.SCHEDULE_JOB: {
                 const jobInfo = data;
                 await this.registerJob(jobInfo);
                 break;
-            case CommunicationMessage.REMOVE_JOB:
-                if (!this.isActive) {
-                    //-- not active scheduler, ignore
-                    return;
-                }
+            }
+            case CommunicationMessage.REMOVE_JOB: {
                 const jobId = data;
                 await this.cancelJob(jobId);
                 break;
+            }
+            case CommunicationMessage.CLEANUP_JOB: {
+                const jobId = data;
+                await this.cleanupJob(jobId);
+                break;
+            }
             default:
                 this.logger.error(`Not recognize message type ${type}`);
                 break;
@@ -143,17 +147,19 @@ let LocalJobScheduler = class LocalJobScheduler extends AbstractJobScheduler {
         this.logger.debug("LocalJobScheduler exit");
     }
     async retryJob(job, at) {
+        const { id, disabled, execCount, failCount, retryCount, lastError, lastRunAt, lastSuccessAt, ...payload } = job;
         if (job.at) {
             //-- just register the job at new timestamp
             await this.registerJob({ ...job, at });
         }
         else {
-            //-- schedule a new one-time job to re-execute this cron with minus one retry
-            await this.scheduleJob({ ...job, at, maxRetry: (job.maxRetry || 1) - 1 });
+            //-- schedule a new one-time job to re-execute this cron with minus one maxRetry
+            await this.scheduleJob({ ...payload, at, maxRetry: (job.maxRetry || 0) - 1 });
         }
     }
-    async cleanupJob(job) {
-        this.jobHolder[job.id] = undefined;
+    async cleanupJob(jobId) {
+        this.jobHolder[jobId] = undefined;
+        this.sendJob(CommunicationMessage.CLEANUP_JOB, jobId);
     }
     async registerJob(job) {
         if (this.isActive) {
@@ -161,13 +167,13 @@ let LocalJobScheduler = class LocalJobScheduler extends AbstractJobScheduler {
             if (job.at) {
                 //-- use the lib
                 const timeout = setTimeout(() => {
-                    this.executeJob(job).catch((err) => this.logger.error(`Error execute job ${job.jobName} with id: ${job.id}`, err));
+                    this.executeJob(job.id).catch((err) => this.logger.error(`Error execute job ${job.jobName} with id: ${job.id}`, err));
                 }, new Date(job.at).getTime() - Date.now());
                 this.jobHolder[job.id] = { jobCanceler: () => clearTimeout(timeout), job };
             }
             else if (job.cron) {
                 const scheduledJob = scheduler.scheduleJob(job.cron, () => {
-                    this.executeJob(job).catch((err) => this.logger.error(`Error execute job ${job.jobName} with id: ${job.id}`, err));
+                    this.executeJob(job.id).catch((err) => this.logger.error(`Error execute job ${job.jobName} with id: ${job.id}`, err));
                 });
                 this.jobHolder[job.id] = { jobCanceler: () => scheduledJob.cancel(), job };
             }

package/dist/job/interfaces.d.ts

@@ -1,7 +1,6 @@
 import { ObjectMetadata } from "@clairejs/core";
 export declare const CRON_REQUEST_METHOD = "cron";
 export interface JobRetryOptions {
-    retryOnFail?: boolean;
     maxRetry?: number;
     retryDelayMs?: number;
 }

package/dist/system/LambdaWrapper.js

@@ -106,7 +106,6 @@ export class LambdaWrapper {
                 return toApiGatewayFormat({ code: 200, headers: corsHeaders, cookies: {} });
             }
             if (requestOptions.method === CRON_REQUEST_METHOD) {
-                console.log("handle cron", requestOptions.body);
                 await this.jobScheduler?.handleCron(requestOptions.body);
                 return toApiGatewayFormat({ code: 200, headers: corsHeaders, cookies: {} });
             }

package/package.json

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