@tsed/bullmq 7.39.0 → 7.40.0

package/lib/types/dispatchers/JobDispatcher.d.ts

@@ -1,9 +1,9 @@
 import { InjectorService } from "@tsed/di";
 import { JobMethods } from "../contracts";
 import { Type } from "@tsed/core";
-import { Job as BullMQJob } from "bullmq";
+import { Job as BullMQJob, JobsOptions } from "bullmq";
 export declare class JobDispatcher {
     private readonly injector;
     constructor(injector: InjectorService);
-    dispatch<T extends JobMethods>(job: Type<T>, payload?: Parameters<T["handle"]>[0]): Promise<BullMQJob>;
+    dispatch<T extends JobMethods>(job: Type<T>, payload?: Parameters<T["handle"]>[0], options?: JobsOptions): Promise<BullMQJob>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/bullmq",
-  "version": "7.39.0",
+  "version": "7.40.0",
   "private": false,
   "description": "BullMQ integration for Ts.ED",
   "keywords": [
@@ -29,12 +29,12 @@
     "tslib": "2.5.0"
   },
   "devDependencies": {
-    "@tsed/common": "7.39.0",
-    "@tsed/core": "7.39.0",
-    "@tsed/di": "7.39.0",
-    "@tsed/eslint": "7.39.0",
-    "@tsed/schema": "7.39.0",
-    "@tsed/typescript": "7.39.0",
+    "@tsed/common": "7.40.0",
+    "@tsed/core": "7.40.0",
+    "@tsed/di": "7.40.0",
+    "@tsed/eslint": "7.39.1",
+    "@tsed/schema": "7.40.0",
+    "@tsed/typescript": "7.39.1",
     "bullmq": "^4.12.3",
     "eslint": "^8.12.0",
     "ts-mockito": "^2.6.1"

package/src/dispatchers/JobDispatcher.spec.ts

@@ -9,7 +9,7 @@ import {instance, mock, verify, when, objectContaining} from "ts-mockito";
   backoff: 69
 })
 class ExampleTestJob implements JobMethods {
-  handle(payload: {msg: string}) {}
+  handle(payload: { msg: string }) {}
 }
 
 @JobController("queue-not-configured", "not-configured")
@@ -49,4 +49,50 @@ describe("JobDispatcher", () => {
       )
     ).once();
   });
+
+  it('should overwrite job options defined by the job', async () => {
+    const injector = mock(InjectorService);
+    const queue = mock(Queue);
+    when(queue.name).thenReturn("default");
+
+    when(injector.getMany("bullmq:queue")).thenReturn([instance(queue)]);
+
+    const dispatcher = new JobDispatcher(instance(injector));
+
+    await dispatcher.dispatch(ExampleTestJob, {msg: "hello test"}, {backoff: 42, jobId: 'ffeeaa'});
+
+    verify(
+      queue.add(
+        "example-job",
+        objectContaining({msg: "hello test"}),
+        objectContaining({
+          backoff: 42,
+          jobId: 'ffeeaa'
+        })
+      )
+    ).once();
+  })
+
+  it('should keep existing options and add new ones', async () => {
+    const injector = mock(InjectorService);
+    const queue = mock(Queue);
+    when(queue.name).thenReturn("default");
+
+    when(injector.getMany("bullmq:queue")).thenReturn([instance(queue)]);
+
+    const dispatcher = new JobDispatcher(instance(injector));
+
+    await dispatcher.dispatch(ExampleTestJob, {msg: "hello test"}, {jobId: 'ffeeaa'});
+
+    verify(
+      queue.add(
+        "example-job",
+        objectContaining({msg: "hello test"}),
+        objectContaining({
+          backoff: 69,
+          jobId: 'ffeeaa'
+        })
+      )
+    ).once();
+  });
 });

package/src/dispatchers/JobDispatcher.ts

@@ -1,14 +1,14 @@
 import {InjectorService, Service} from "@tsed/di";
 import {JobMethods, type JobStore} from "../contracts";
 import {Store, Type} from "@tsed/core";
-import {Job as BullMQJob, Queue} from "bullmq";
+import {Job as BullMQJob, JobsOptions, Queue} from "bullmq";
 
 @Service()
 export class JobDispatcher {
   constructor(private readonly injector: InjectorService) {}
 
   // eslint-disable-next-line require-await
-  public async dispatch<T extends JobMethods>(job: Type<T>, payload: Parameters<T["handle"]>[0] = {}): Promise<BullMQJob> {
+  public async dispatch<T extends JobMethods>(job: Type<T>, payload: Parameters<T["handle"]>[0] = {}, options: JobsOptions = {}): Promise<BullMQJob> {
     const store = Store.from(job).get<JobStore>("bullmq");
 
     const queue = this.injector.getMany<Queue>("bullmq:queue").find((queue) => queue.name === store.queue);
@@ -17,6 +17,9 @@ export class JobDispatcher {
       throw new Error(`Queue(${store.queue}) not defined`);
     }
 
-    return queue.add(store.name, payload, store.opts);
+    return queue.add(store.name, payload, {
+      ...store.opts,
+      ...options,
+    });
   }
 }