@tsed/agenda 7.54.0 → 7.56.0

package/lib/types/AgendaModule.d.ts

@@ -7,6 +7,7 @@ export declare class AgendaModule implements OnDestroy, AfterListen {
     protected injector: InjectorService;
     protected agenda: AgendaService;
     private enabled;
+    private drainJobsBeforeClose;
     private disableJobProcessing;
     $afterListen(): Promise<any>;
     $onDestroy(): Promise<any>;

package/lib/types/interfaces/interfaces.d.ts

@@ -8,6 +8,7 @@ declare global {
                  */
                 enabled?: boolean;
                 disableJobProcessing?: boolean;
+                drainJobsBeforeClose?: boolean;
             } & AgendaConfig;
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/agenda",
-  "version": "7.54.0",
+  "version": "7.56.0",
   "description": "Agenda package for Ts.ED framework",
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
@@ -25,16 +25,16 @@
   },
   "private": false,
   "devDependencies": {
-    "@tsed/common": "7.54.0",
-    "@tsed/core": "7.54.0",
-    "@tsed/di": "7.54.0",
+    "@tsed/common": "7.56.0",
+    "@tsed/core": "7.56.0",
+    "@tsed/di": "7.56.0",
     "@tsed/eslint": "7.44.1",
     "@tsed/typescript": "7.44.1",
-    "agenda": "^4.1.3",
+    "agenda": "^5.0.0",
     "eslint": "^8.12.0"
   },
   "peerDependencies": {
-    "agenda": "^4.1.3"
+    "agenda": ">=4"
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {

package/readme.md

@@ -61,6 +61,8 @@ const mongoConnectionString = "mongodb://127.0.0.1/agenda";
 @Configuration({
   agenda: {
     enabled: true, // Enable Agenda jobs for this instance.
+    // drainJobsBeforeStop: true, // Wait for jobs to finish before stopping the agenda process.
+    // disableJobProcessing: true, // Prevents jobs from being processed.
     // pass any options that you would normally pass to new Agenda(), e.g.
     db: {
       address: mongoConnectionString

package/src/AgendaModule.spec.ts

@@ -11,6 +11,7 @@ jest.mock("agenda", () => {
     Agenda: class {
       close = jest.fn();
       stop = jest.fn();
+      drain = jest.fn();
       define = jest.fn();
       every = jest.fn();
       schedule = jest.fn();
@@ -131,11 +132,32 @@ describe("AgendaModule", () => {
 
         await agendaModule.$onDestroy();
 
+        expect(agendaModule.agenda.stop).toHaveBeenCalledWith();
         expect(agendaModule.agenda.close).toHaveBeenCalledWith({force: true});
       });
     });
   });
+  describe("when agenda is enabled and drainJobsBeforeClose = true", () => {
+    beforeEach(() =>
+      PlatformTest.create({
+        agenda: {
+          enabled: true,
+          drainJobsBeforeClose: true
+        }
+      })
+    );
+    afterEach(() => PlatformTest.reset());
+    describe("$onDestroy()", () => {
+      it("should close agenda", async () => {
+        const agendaModule = PlatformTest.get<any>(AgendaModule)!;
+
+        await agendaModule.$onDestroy();
 
+        expect(agendaModule.agenda.drain).toHaveBeenCalledWith();
+        expect(agendaModule.agenda.close).toHaveBeenCalledWith({force: true});
+      });
+    });
+  });
   describe("when agenda is enabled but disableJobProcessing = true", () => {
     beforeEach(() =>
       PlatformTest.create({

package/src/AgendaModule.ts

@@ -20,6 +20,9 @@ export class AgendaModule implements OnDestroy, AfterListen {
   @Constant("agenda.enabled", false)
   private enabled: boolean;
 
+  @Constant("agenda.drainJobsBeforeClose", false)
+  private drainJobsBeforeClose: boolean;
+
   @Constant("agenda.disableJobProcessing", false)
   private disableJobProcessing: boolean;
 
@@ -28,7 +31,10 @@ export class AgendaModule implements OnDestroy, AfterListen {
       const providers = this.getProviders();
 
       if (!this.disableJobProcessing) {
-        this.logger.info("Agenda add definitions...");
+        this.logger.info({
+          event: "AGENDA_ADD_DEFINITIONS",
+          message: "Agenda add definitions"
+        });
         providers.forEach((provider) => this.addAgendaDefinitionsForProvider(provider));
 
         await this.injector.emit("$beforeAgendaStart");
@@ -37,22 +43,36 @@ export class AgendaModule implements OnDestroy, AfterListen {
       await this.agenda.start();
 
       if (!this.disableJobProcessing) {
-        this.logger.info("Agenda add scheduled jobs...");
+        this.logger.info({
+          event: "AGENDA_ADD_JOBS",
+          message: "Agenda add scheduled jobs"
+        });
         await Promise.all(providers.map((provider) => this.scheduleJobsForProvider(provider)));
 
         await this.injector.emit("$afterAgendaStart");
       }
-    } else {
-      this.logger.info("Agenda disabled...");
     }
   }
 
   async $onDestroy(): Promise<any> {
     if (this.enabled) {
-      await this.agenda.stop();
+      if (this.drainJobsBeforeClose && "drain" in this.agenda) {
+        this.logger.info({
+          event: "AGENDA_DRAIN",
+          message: "Agenda is draining all jobs before close"
+        });
+        await this.agenda.drain();
+      } else {
+        this.logger.info({
+          event: "AGENDA_STOP",
+          message: "Agenda is stopping"
+        });
+        await this.agenda.stop();
+      }
+
       await this.agenda.close({force: true});
 
-      this.logger.info("Agenda stopped...");
+      this.logger.info({event: "AGENDA_STOP", message: "Agenda stopped"});
     }
   }
 
@@ -100,7 +120,7 @@ export class AgendaModule implements OnDestroy, AfterListen {
     Object.entries(store.define).forEach(([propertyKey, {name, ...options}]) => {
       const instance = this.injector.get(provider.token);
 
-      const jobProcessor: Processor = instance[propertyKey].bind(instance) as Processor;
+      const jobProcessor: Processor<unknown> = instance[propertyKey].bind(instance) as Processor<unknown>;
       const jobName = this.getNameForJob(propertyKey, store.namespace, name);
 
       this.define(jobName, options, jobProcessor);

package/src/interfaces/interfaces.ts

@@ -9,6 +9,7 @@ declare global {
          */
         enabled?: boolean;
         disableJobProcessing?: boolean;
+        drainJobsBeforeClose?: boolean;
       } & AgendaConfig;
     }
   }