@tsed/bullmq 8.43.1 → 8.43.3

package/lib/esm/dispatchers/JobDispatcher.js

@@ -2,6 +2,7 @@ import { Store } from "@tsed/core";
 import { inject, injectable } from "@tsed/di";
 import { BULLMQ } from "../constants/constants.js";
 import { getJobToken } from "../utils/getJobToken.js";
+import { getJobSchedulerId } from "../utils/getJobSchedulerId.js";
 import { getQueueToken } from "../utils/getQueueToken.js";
 export class JobDispatcher {
     async dispatch(job, payload, options = {}) {
@@ -10,10 +11,29 @@ export class JobDispatcher {
         if (!queue) {
             throw new Error(`Queue(${queueName}) not defined`);
         }
-        return queue.add(jobName, payload, {
+        const { repeat, ...opts } = {
             ...defaultJobOptions,
             ...options
-        });
+        };
+        if (repeat) {
+            const { jobId, ...template } = opts;
+            // a repeat given at dispatch time gets its own scheduler, so several schedules of the same job can coexist
+            const schedulerId = jobId || (options.repeat ? getJobSchedulerId(jobName, repeat) : jobName);
+            await this.removeLegacyRepeatable(queue, jobName, repeat, jobId);
+            // bullmq v6 removed the `repeat` option from Queue.add(): repeating jobs are handled by a job scheduler
+            return queue.upsertJobScheduler(schedulerId, repeat, { name: jobName, data: payload, opts: template });
+        }
+        return queue.add(jobName, payload, opts);
+    }
+    /**
+     * Repeatable jobs registered by `Queue.add(name, data, {repeat})` (bullmq < 6) aren't replaced by a job scheduler:
+     * they must be removed, otherwise the job is produced twice.
+     */
+    async removeLegacyRepeatable(queue, jobName, repeat, jobId) {
+        const legacyQueue = queue;
+        if (typeof legacyQueue.removeRepeatable === "function") {
+            await legacyQueue.removeRepeatable(jobName, repeat, jobId);
+        }
     }
     async resolveDispatchArgs(job, payload) {
         let queueName;

package/lib/esm/index.js

@@ -17,6 +17,7 @@ export * from "./dispatchers/JobDispatcher.js";
 export * from "./dispatchers/JobDispatcherOptions.js";
 export * from "./utils/createQueueProvider.js";
 export * from "./utils/createWorkerProvider.js";
+export * from "./utils/getJobSchedulerId.js";
 export * from "./utils/getJobToken.js";
 export * from "./utils/getQueueToken.js";
 export * from "./utils/getWorkerToken.js";

package/lib/esm/utils/getJobSchedulerId.js

@@ -0,0 +1,7 @@
+/**
+ * Build a stable job scheduler id from the job name and its repeat settings.
+ */
+export function getJobSchedulerId(jobName, repeat) {
+    const endDate = repeat.endDate === undefined ? undefined : new Date(repeat.endDate).getTime();
+    return [jobName, repeat.pattern ?? repeat.every, repeat.tz, endDate].filter((value) => value !== undefined).join(":");
+}

package/lib/types/contracts/JobStore.d.ts

@@ -1,6 +1,15 @@
-import { JobsOptions } from "bullmq";
+import type { JobsOptions, RepeatOptions } from "bullmq";
+/**
+ * Job options accepted by `@JobController` and `JobDispatcher`.
+ *
+ * `repeat` is kept as a Ts.ED option: bullmq v6 removed it from `Queue.add()`,
+ * so repeating jobs are registered through `Queue.upsertJobScheduler()`.
+ */
+export type JobOptions = Omit<JobsOptions, "repeat"> & {
+    repeat?: Omit<RepeatOptions, "key">;
+};
 export interface JobStore {
     name: string;
     queue: string;
-    opts: JobsOptions;
+    opts: JobOptions;
 }

package/lib/types/decorators/JobController.d.ts

@@ -1,3 +1,3 @@
-import { JobsOptions } from "bullmq";
-export declare function JobController(name: string, queue?: string, opts?: JobsOptions): any;
+import type { JobOptions } from "../contracts/JobStore.js";
+export declare function JobController(name: string, queue?: string, opts?: JobOptions): any;
 export declare function FallbackJobController(queue?: string): any;

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

@@ -1,11 +1,16 @@
-import { Job as BullMQJob, JobsOptions } from "bullmq";
-import { JobMethods } from "../contracts/index.js";
+import { Job as BullMQJob } from "bullmq";
+import { JobMethods, type JobOptions } from "../contracts/index.js";
 import { Type } from "@tsed/core";
 import type { JobDispatcherOptions } from "./JobDispatcherOptions.js";
 export declare class JobDispatcher {
-    dispatch<T extends JobMethods>(job: Type<T>, payload?: Parameters<T["handle"]>[0], options?: JobsOptions): Promise<BullMQJob>;
-    dispatch<P = unknown>(job: JobDispatcherOptions, payload?: P, options?: JobsOptions): Promise<BullMQJob>;
-    dispatch<P = unknown>(job: string, payload?: P, options?: JobsOptions): Promise<BullMQJob>;
+    dispatch<T extends JobMethods>(job: Type<T>, payload?: Parameters<T["handle"]>[0], options?: JobOptions): Promise<BullMQJob>;
+    dispatch<P = unknown>(job: JobDispatcherOptions, payload?: P, options?: JobOptions): Promise<BullMQJob>;
+    dispatch<P = unknown>(job: string, payload?: P, options?: JobOptions): Promise<BullMQJob>;
+    /**
+     * Repeatable jobs registered by `Queue.add(name, data, {repeat})` (bullmq < 6) aren't replaced by a job scheduler:
+     * they must be removed, otherwise the job is produced twice.
+     */
+    private removeLegacyRepeatable;
     private resolveDispatchArgs;
     private retrieveJobOptionsFromClassBasedJob;
 }

package/lib/types/index.d.ts

@@ -17,6 +17,7 @@ export * from "./dispatchers/JobDispatcher.js";
 export * from "./dispatchers/JobDispatcherOptions.js";
 export * from "./utils/createQueueProvider.js";
 export * from "./utils/createWorkerProvider.js";
+export * from "./utils/getJobSchedulerId.js";
 export * from "./utils/getJobToken.js";
 export * from "./utils/getQueueToken.js";
 export * from "./utils/getWorkerToken.js";

package/lib/types/utils/createQueueProvider.d.ts

@@ -1,2 +1,2 @@
 import { Queue, QueueOptions } from "bullmq";
-export declare function createQueueProvider(queue: string, opts: QueueOptions): Queue<any, any, string>;
+export declare function createQueueProvider(queue: string, opts: QueueOptions): Queue<any, any, string, any, any, string, import("bullmq").RedisQueueBackend>;

package/lib/types/utils/createWorkerProvider.d.ts

@@ -1,2 +1,2 @@
 import { Job, Worker, WorkerOptions } from "bullmq";
-export declare function createWorkerProvider(worker: string, process: (job: Job) => any, opts: WorkerOptions): Worker<any, any, string>;
+export declare function createWorkerProvider(worker: string, process: (job: Job) => any, opts: WorkerOptions): Worker<any, any, string, import("bullmq").RedisQueueBackend, import("bullmq").JobProgress>;

package/lib/types/utils/getJobSchedulerId.d.ts

@@ -0,0 +1,5 @@
+import type { RepeatOptions } from "bullmq";
+/**
+ * Build a stable job scheduler id from the job name and its repeat settings.
+ */
+export declare function getJobSchedulerId(jobName: string, repeat: Omit<RepeatOptions, "key">): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/bullmq",
-  "version": "8.43.1",
+  "version": "8.43.3",
   "description": "BullMQ integration for Ts.ED",
   "keywords": [
     "BullMQ",
@@ -30,19 +30,19 @@
     "tslib": ">=2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.43.1",
-    "@tsed/core": "8.43.1",
-    "@tsed/di": "8.43.1",
-    "@tsed/platform-http": "8.43.1",
-    "@tsed/schema": "8.43.1",
-    "@tsed/typescript": "8.43.1",
-    "bullmq": "^4.12.3 || ^5.1.1",
+    "@tsed/barrels": "8.43.3",
+    "@tsed/core": "8.43.3",
+    "@tsed/di": "8.43.3",
+    "@tsed/platform-http": "8.43.3",
+    "@tsed/schema": "8.43.3",
+    "@tsed/typescript": "8.43.3",
+    "bullmq": "^6.3.8",
     "ts-mockito": "^2.6.1",
     "typescript": "6.0.2",
     "vitest": "4.1.4"
   },
   "peerDependencies": {
-    "bullmq": "^4.12.3 || ^5.1.1"
+    "bullmq": ">=5.16.0"
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {