groupmq-plus 1.1.0 → 1.1.1

package/dist/index.d.cts

@@ -84,6 +84,11 @@ declare class Job<T = any> {
   retry(_state?: Extract<Status$1, 'completed' | 'failed'>): Promise<void>;
   updateData(jobData: T): Promise<void>;
   update(jobData: T): Promise<void>;
+  /**
+   * Wait until this job is completed or failed.
+   * @param timeoutMs Optional timeout in milliseconds (0 = no timeout)
+   */
+  waitUntilFinished(timeoutMs?: number): Promise<unknown>;
   static fromReserved<T = any>(queue: Queue<T>, reserved: ReservedJob<T>, meta?: {
     processedOn?: number;
     finishedOn?: number;
@@ -493,6 +498,9 @@ declare class Queue<T = any> {
   orderingDelayMs: number;
   name: string;
   private _consecutiveEmptyReserves;
+  private subscriber?;
+  private eventsSubscribed;
+  private waitingJobs;
   private promoterRedis?;
   private promoterRunning;
   private promoterLockId?;
@@ -765,6 +773,12 @@ declare class Queue<T = any> {
    * Attempts to mimic BullMQ's Job shape for fields commonly used by BullBoard.
    */
   getJob(id: string): Promise<Job<T>>;
+  private setupSubscriber;
+  private handleJobEvent;
+  /**
+   * Wait for a job to complete or fail, similar to BullMQ's waitUntilFinished.
+   */
+  waitUntilFinished(jobId: string, timeoutMs?: number): Promise<unknown>;
   /**
    * Fetch jobs by statuses, emulating BullMQ's Queue.getJobs API used by BullBoard.
    * Only getter functionality; ordering is best-effort.
@@ -917,7 +931,10 @@ interface DispatchStrategy {
 }
 //#endregion
 //#region src/worker.d.ts
-type BackoffStrategy = (attempt: number) => number;
+declare class UnrecoverableError extends Error {
+  constructor(message?: string);
+}
+type BackoffStrategy = (attempt: number, error: unknown) => number;
 interface WorkerEvents<T = any> extends Record<string, (...args: any[]) => void> {
   error: (error: Error) => void;
   closed: () => void;
@@ -988,9 +1005,11 @@ type WorkerOptions<T> = {
   maxAttempts?: number;
   /**
    * Backoff strategy for retrying failed jobs. Determines delay between retries.
+    * Receives the error object to allow smarter strategies.
    *
    * @default Exponential backoff with jitter (500ms, 1s, 2s, 4s, 8s, 16s, 30s max)
-   * @example (attempt) => Math.min(10000, attempt * 1000) // Linear backoff
+    * @example (attempt, err) =>
+    *   err instanceof RateLimitError ? err.retryAfterMs : Math.min(10000, attempt * 1000)
    *
    * **When to adjust:**
    * - Rate-limited APIs: Use longer delays
@@ -1296,5 +1315,5 @@ declare function getWorkersStatus<T = any>(workers: Worker<T>[]): {
   }>;
 };
 //#endregion
-export { AddOptions, BackoffStrategy, BullBoardGroupMQAdapter, FlowJob, FlowOptions, GroupMQBullBoardAdapterOptions, Job, Queue, QueueOptions, RepeatOptions, ReservedJob, Worker, WorkerEvents, WorkerOptions, getWorkersStatus, waitForQueueToEmpty };
+export { AddOptions, BackoffStrategy, BullBoardGroupMQAdapter, FlowJob, FlowOptions, GroupMQBullBoardAdapterOptions, Job, Queue, QueueOptions, RepeatOptions, ReservedJob, UnrecoverableError, Worker, WorkerEvents, WorkerOptions, getWorkersStatus, waitForQueueToEmpty };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -84,6 +84,11 @@ declare class Job<T = any> {
   retry(_state?: Extract<Status$1, 'completed' | 'failed'>): Promise<void>;
   updateData(jobData: T): Promise<void>;
   update(jobData: T): Promise<void>;
+  /**
+   * Wait until this job is completed or failed.
+   * @param timeoutMs Optional timeout in milliseconds (0 = no timeout)
+   */
+  waitUntilFinished(timeoutMs?: number): Promise<unknown>;
   static fromReserved<T = any>(queue: Queue<T>, reserved: ReservedJob<T>, meta?: {
     processedOn?: number;
     finishedOn?: number;
@@ -493,6 +498,9 @@ declare class Queue<T = any> {
   orderingDelayMs: number;
   name: string;
   private _consecutiveEmptyReserves;
+  private subscriber?;
+  private eventsSubscribed;
+  private waitingJobs;
   private promoterRedis?;
   private promoterRunning;
   private promoterLockId?;
@@ -765,6 +773,12 @@ declare class Queue<T = any> {
    * Attempts to mimic BullMQ's Job shape for fields commonly used by BullBoard.
    */
   getJob(id: string): Promise<Job<T>>;
+  private setupSubscriber;
+  private handleJobEvent;
+  /**
+   * Wait for a job to complete or fail, similar to BullMQ's waitUntilFinished.
+   */
+  waitUntilFinished(jobId: string, timeoutMs?: number): Promise<unknown>;
   /**
    * Fetch jobs by statuses, emulating BullMQ's Queue.getJobs API used by BullBoard.
    * Only getter functionality; ordering is best-effort.
@@ -917,7 +931,10 @@ interface DispatchStrategy {
 }
 //#endregion
 //#region src/worker.d.ts
-type BackoffStrategy = (attempt: number) => number;
+declare class UnrecoverableError extends Error {
+  constructor(message?: string);
+}
+type BackoffStrategy = (attempt: number, error: unknown) => number;
 interface WorkerEvents<T = any> extends Record<string, (...args: any[]) => void> {
   error: (error: Error) => void;
   closed: () => void;
@@ -988,9 +1005,11 @@ type WorkerOptions<T> = {
   maxAttempts?: number;
   /**
    * Backoff strategy for retrying failed jobs. Determines delay between retries.
+    * Receives the error object to allow smarter strategies.
    *
    * @default Exponential backoff with jitter (500ms, 1s, 2s, 4s, 8s, 16s, 30s max)
-   * @example (attempt) => Math.min(10000, attempt * 1000) // Linear backoff
+    * @example (attempt, err) =>
+    *   err instanceof RateLimitError ? err.retryAfterMs : Math.min(10000, attempt * 1000)
    *
    * **When to adjust:**
    * - Rate-limited APIs: Use longer delays
@@ -1296,5 +1315,5 @@ declare function getWorkersStatus<T = any>(workers: Worker<T>[]): {
   }>;
 };
 //#endregion
-export { AddOptions, BackoffStrategy, BullBoardGroupMQAdapter, FlowJob, FlowOptions, GroupMQBullBoardAdapterOptions, Job, Queue, QueueOptions, RepeatOptions, ReservedJob, Worker, WorkerEvents, WorkerOptions, getWorkersStatus, waitForQueueToEmpty };
+export { AddOptions, BackoffStrategy, BullBoardGroupMQAdapter, FlowJob, FlowOptions, GroupMQBullBoardAdapterOptions, Job, Queue, QueueOptions, RepeatOptions, ReservedJob, UnrecoverableError, Worker, WorkerEvents, WorkerOptions, getWorkersStatus, waitForQueueToEmpty };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -276,6 +276,13 @@ var Job = class Job {
 	async update(jobData) {
 		await this.updateData(jobData);
 	}
+	/**
+	* Wait until this job is completed or failed.
+	* @param timeoutMs Optional timeout in milliseconds (0 = no timeout)
+	*/
+	async waitUntilFinished(timeoutMs = 0) {
+		return this.queue.waitUntilFinished(this.id, timeoutMs);
+	}
 	static fromReserved(queue, reserved, meta) {
 		return new Job({
 			queue,
@@ -469,6 +476,8 @@ function safeJsonParse(input) {
 var Queue = class {
 	constructor(opts) {
 		this._consecutiveEmptyReserves = 0;
+		this.eventsSubscribed = false;
+		this.waitingJobs = /* @__PURE__ */ new Map();
 		this.promoterRunning = false;
 		this.batchBuffer = [];
 		this.flushing = false;
@@ -1317,6 +1326,91 @@ var Queue = class {
 	async getJob(id) {
 		return Job.fromStore(this, id);
 	}
+	async setupSubscriber() {
+		if (this.eventsSubscribed && this.subscriber) return;
+		if (!this.subscriber) {
+			this.subscriber = this.r.duplicate();
+			this.subscriber.on("message", (channel, message) => {
+				if (channel === `${this.ns}:events`) this.handleJobEvent(message);
+			});
+			this.subscriber.on("error", (err) => {
+				this.logger.error("Redis error (events subscriber):", err);
+			});
+		}
+		await this.subscriber.subscribe(`${this.ns}:events`);
+		this.eventsSubscribed = true;
+	}
+	handleJobEvent(message) {
+		try {
+			const event = safeJsonParse(message);
+			if (!event || typeof event.id !== "string") return;
+			const waiters = this.waitingJobs.get(event.id);
+			if (!waiters || waiters.length === 0) return;
+			if (event.status === "completed") {
+				const parsed = typeof event.result === "string" ? safeJsonParse(event.result) ?? event.result : event.result;
+				waiters.forEach((w) => w.resolve(parsed));
+			} else if (event.status === "failed") {
+				const info = typeof event.result === "string" ? safeJsonParse(event.result) ?? {} : event.result ?? {};
+				const err = new Error(info && info.message || "Job failed");
+				if (info && typeof info === "object") {
+					if (typeof info.name === "string") err.name = info.name;
+					if (typeof info.stack === "string") err.stack = info.stack;
+				}
+				waiters.forEach((w) => w.reject(err));
+			}
+			this.waitingJobs.delete(event.id);
+		} catch (err) {
+			this.logger.error("Failed to process job event:", err);
+		}
+	}
+	/**
+	* Wait for a job to complete or fail, similar to BullMQ's waitUntilFinished.
+	*/
+	async waitUntilFinished(jobId, timeoutMs = 0) {
+		const job = await this.getJob(jobId);
+		const state = await job.getState();
+		if (state === "completed") return job.returnvalue;
+		if (state === "failed") throw new Error(job.failedReason || "Job failed");
+		await this.setupSubscriber();
+		return new Promise((resolve, reject) => {
+			let timer;
+			let waiter;
+			const cleanup = () => {
+				if (timer) clearTimeout(timer);
+				const current = this.waitingJobs.get(jobId);
+				if (!current) return;
+				const remaining = current.filter((w) => w !== waiter);
+				if (remaining.length === 0) this.waitingJobs.delete(jobId);
+				else this.waitingJobs.set(jobId, remaining);
+			};
+			const wrappedResolve = (value) => {
+				cleanup();
+				resolve(value);
+			};
+			const wrappedReject = (err) => {
+				cleanup();
+				reject(err);
+			};
+			waiter = {
+				resolve: wrappedResolve,
+				reject: wrappedReject
+			};
+			const waiters = this.waitingJobs.get(jobId) ?? [];
+			waiters.push(waiter);
+			this.waitingJobs.set(jobId, waiters);
+			if (timeoutMs > 0) timer = setTimeout(() => {
+				wrappedReject(/* @__PURE__ */ new Error(`Timed out waiting for job ${jobId} to finish`));
+			}, timeoutMs);
+			(async () => {
+				try {
+					const latest = await this.getJob(jobId);
+					const latestState = await latest.getState();
+					if (latestState === "completed") wrappedResolve(latest.returnvalue);
+					else if (latestState === "failed") wrappedReject(new Error(latest.failedReason ?? "Job failed"));
+				} catch (_err) {}
+			})();
+		});
+	}
 	/**
 	* Fetch jobs by statuses, emulating BullMQ's Queue.getJobs API used by BullBoard.
 	* Only getter functionality; ordering is best-effort.
@@ -1511,6 +1605,25 @@ var Queue = class {
 			await this.flushBatch();
 		}
 		await this.stopPromoter();
+		if (this.subscriber) {
+			try {
+				await this.subscriber.unsubscribe(`${this.ns}:events`);
+				await this.subscriber.quit();
+			} catch (_err) {
+				try {
+					this.subscriber.disconnect();
+				} catch (_e) {}
+			}
+			this.subscriber = void 0;
+			this.eventsSubscribed = false;
+		}
+		if (this.waitingJobs.size > 0) {
+			const err = /* @__PURE__ */ new Error("Queue closed");
+			this.waitingJobs.forEach((waiters) => {
+				waiters.forEach((w) => w.reject(err));
+			});
+			this.waitingJobs.clear();
+		}
 		try {
 			await this.r.quit();
 		} catch (_e) {
@@ -1938,6 +2051,12 @@ var AsyncFifoQueue = class {
 
 //#endregion
 //#region src/worker.ts
+var UnrecoverableError = class extends Error {
+	constructor(message) {
+		super(message);
+		this.name = "UnrecoverableError";
+	}
+};
 var TypedEventEmitter = class {
 	constructor() {
 		this.listeners = /* @__PURE__ */ new Map();
@@ -1973,7 +2092,7 @@ var TypedEventEmitter = class {
 		return this;
 	}
 };
-const defaultBackoff = (attempt) => {
+const defaultBackoff = (attempt, _error) => {
 	const base = Math.min(3e4, 2 ** (attempt - 1) * 500);
 	const jitter = Math.floor(base * .25 * Math.random());
 	return base + jitter;
@@ -2486,7 +2605,12 @@ var _Worker = class extends TypedEventEmitter {
 			status: "failed"
 		}));
 		const nextAttempt = job.attempts + 1;
-		const backoffMs = this.backoff(nextAttempt);
+		if (err instanceof UnrecoverableError) {
+			this.logger.info(`Unrecoverable error for job ${job.id}: ${err instanceof Error ? err.message : String(err)}. Skipping retries.`);
+			await this.deadLetterJob(err, job, jobStartWallTime, failedAt, nextAttempt);
+			return;
+		}
+		const backoffMs = this.backoff(nextAttempt, err);
 		if (nextAttempt >= this.maxAttempts) {
 			await this.deadLetterJob(err, job, jobStartWallTime, failedAt, nextAttempt);
 			return;
@@ -2553,5 +2677,5 @@ function sleep(ms) {
 }
 
 //#endregion
-export { BullBoardGroupMQAdapter, Job, Queue, Worker, getWorkersStatus, waitForQueueToEmpty };
+export { BullBoardGroupMQAdapter, Job, Queue, UnrecoverableError, Worker, getWorkersStatus, waitForQueueToEmpty };
 //# sourceMappingURL=index.js.map