groupmq-plus 1.1.1 → 1.1.2

package/dist/index.d.cts

@@ -37,6 +37,7 @@ declare class Job<T = any> {
   readonly timestamp: number;
   readonly orderMs?: number;
   readonly status: Status$1 | 'unknown';
+  readonly parentId?: string;
   constructor(args: {
     queue: Queue<T>;
     id: string;
@@ -56,6 +57,7 @@ declare class Job<T = any> {
     timestamp: number;
     orderMs?: number;
     status?: Status$1 | 'unknown';
+    parentId?: string;
   });
   getState(): Promise<Status$1 | 'stuck' | 'waiting-children' | 'prioritized' | 'unknown'>;
   toJSON(): {
@@ -89,6 +91,26 @@ declare class Job<T = any> {
    * @param timeoutMs Optional timeout in milliseconds (0 = no timeout)
    */
   waitUntilFinished(timeoutMs?: number): Promise<unknown>;
+  /**
+   * Get all child jobs of this job (if it's a parent in a flow).
+   * @returns Array of child Job instances
+   */
+  getChildren(): Promise<Job<any>[]>;
+  /**
+   * Get the return values of all child jobs in a flow.
+   * @returns Object mapping child job IDs to their return values
+   */
+  getChildrenValues(): Promise<Record<string, any>>;
+  /**
+   * Get the number of remaining child jobs that haven't completed yet.
+   * @returns Number of remaining dependencies, or null if not a parent job
+   */
+  getDependenciesCount(): Promise<number | null>;
+  /**
+   * Get the parent job of this job (if it's a child in a flow).
+   * @returns Parent Job instance, or undefined if no parent or parent was deleted
+   */
+  getParent(): Promise<Job<any> | undefined>;
   static fromReserved<T = any>(queue: Queue<T>, reserved: ReservedJob<T>, meta?: {
     processedOn?: number;
     finishedOn?: number;
@@ -537,6 +559,18 @@ declare class Queue<T = any> {
    * @returns An object mapping child job IDs to their results
    */
   getFlowResults(parentId: string): Promise<Record<string, any>>;
+  /**
+   * Gets all child job IDs for a parent job in a flow.
+   * @param parentId The ID of the parent job
+   * @returns An array of child job IDs
+   */
+  getFlowChildrenIds(parentId: string): Promise<string[]>;
+  /**
+   * Gets all child jobs for a parent job in a flow.
+   * @param parentId The ID of the parent job
+   * @returns An array of Job instances for all children
+   */
+  getFlowChildren(parentId: string): Promise<Job<any>[]>;
   private addSingle;
   private flushBatch;
   reserve(): Promise<ReservedJob<T> | null>;
@@ -967,10 +1001,10 @@ type WorkerOptions<T> = {
   name?: string;
   /**
    * The function that processes jobs. Must be async and handle job failures gracefully.
-   * @param job The reserved job to process
+   * @param job The Job instance to process, with access to all Job methods
    * @returns Promise that resolves when job is complete
    */
-  handler: (job: ReservedJob<T>) => Promise<unknown>;
+  handler: (job: Job<T>) => Promise<unknown>;
   /**
    * Heartbeat interval in milliseconds to keep jobs alive during processing.
    * Prevents jobs from timing out during long-running operations.
@@ -987,9 +1021,9 @@ type WorkerOptions<T> = {
   /**
    * Error handler called when job processing fails or worker encounters errors
    * @param err The error that occurred
-   * @param job The job that failed (if applicable)
+   * @param job The Job instance that failed (if applicable)
    */
-  onError?: (err: unknown, job?: ReservedJob<T>) => void;
+  onError?: (err: unknown, job?: Job<T>) => void;
   /**
    * Maximum number of retry attempts for failed jobs at the worker level.
    * This overrides the queue's default maxAttempts setting.
@@ -1256,14 +1290,14 @@ declare class _Worker<T = any> extends TypedEventEmitter<WorkerEvents<T>> {
    * For concurrency > 1, returns the oldest job in progress
    */
   getCurrentJob(): {
-    job: ReservedJob<T>;
+    job: Job<T>;
     processingTimeMs: number;
   } | null;
   /**
    * Get information about all currently processing jobs
    */
   getCurrentJobs(): Array<{
-    job: ReservedJob<T>;
+    job: Job<T>;
     processingTimeMs: number;
   }>;
   /**

package/dist/index.d.ts

@@ -37,6 +37,7 @@ declare class Job<T = any> {
   readonly timestamp: number;
   readonly orderMs?: number;
   readonly status: Status$1 | 'unknown';
+  readonly parentId?: string;
   constructor(args: {
     queue: Queue<T>;
     id: string;
@@ -56,6 +57,7 @@ declare class Job<T = any> {
     timestamp: number;
     orderMs?: number;
     status?: Status$1 | 'unknown';
+    parentId?: string;
   });
   getState(): Promise<Status$1 | 'stuck' | 'waiting-children' | 'prioritized' | 'unknown'>;
   toJSON(): {
@@ -89,6 +91,26 @@ declare class Job<T = any> {
    * @param timeoutMs Optional timeout in milliseconds (0 = no timeout)
    */
   waitUntilFinished(timeoutMs?: number): Promise<unknown>;
+  /**
+   * Get all child jobs of this job (if it's a parent in a flow).
+   * @returns Array of child Job instances
+   */
+  getChildren(): Promise<Job<any>[]>;
+  /**
+   * Get the return values of all child jobs in a flow.
+   * @returns Object mapping child job IDs to their return values
+   */
+  getChildrenValues(): Promise<Record<string, any>>;
+  /**
+   * Get the number of remaining child jobs that haven't completed yet.
+   * @returns Number of remaining dependencies, or null if not a parent job
+   */
+  getDependenciesCount(): Promise<number | null>;
+  /**
+   * Get the parent job of this job (if it's a child in a flow).
+   * @returns Parent Job instance, or undefined if no parent or parent was deleted
+   */
+  getParent(): Promise<Job<any> | undefined>;
   static fromReserved<T = any>(queue: Queue<T>, reserved: ReservedJob<T>, meta?: {
     processedOn?: number;
     finishedOn?: number;
@@ -537,6 +559,18 @@ declare class Queue<T = any> {
    * @returns An object mapping child job IDs to their results
    */
   getFlowResults(parentId: string): Promise<Record<string, any>>;
+  /**
+   * Gets all child job IDs for a parent job in a flow.
+   * @param parentId The ID of the parent job
+   * @returns An array of child job IDs
+   */
+  getFlowChildrenIds(parentId: string): Promise<string[]>;
+  /**
+   * Gets all child jobs for a parent job in a flow.
+   * @param parentId The ID of the parent job
+   * @returns An array of Job instances for all children
+   */
+  getFlowChildren(parentId: string): Promise<Job<any>[]>;
   private addSingle;
   private flushBatch;
   reserve(): Promise<ReservedJob<T> | null>;
@@ -967,10 +1001,10 @@ type WorkerOptions<T> = {
   name?: string;
   /**
    * The function that processes jobs. Must be async and handle job failures gracefully.
-   * @param job The reserved job to process
+   * @param job The Job instance to process, with access to all Job methods
    * @returns Promise that resolves when job is complete
    */
-  handler: (job: ReservedJob<T>) => Promise<unknown>;
+  handler: (job: Job<T>) => Promise<unknown>;
   /**
    * Heartbeat interval in milliseconds to keep jobs alive during processing.
    * Prevents jobs from timing out during long-running operations.
@@ -987,9 +1021,9 @@ type WorkerOptions<T> = {
   /**
    * Error handler called when job processing fails or worker encounters errors
    * @param err The error that occurred
-   * @param job The job that failed (if applicable)
+   * @param job The Job instance that failed (if applicable)
    */
-  onError?: (err: unknown, job?: ReservedJob<T>) => void;
+  onError?: (err: unknown, job?: Job<T>) => void;
   /**
    * Maximum number of retry attempts for failed jobs at the worker level.
    * This overrides the queue's default maxAttempts setting.
@@ -1256,14 +1290,14 @@ declare class _Worker<T = any> extends TypedEventEmitter<WorkerEvents<T>> {
    * For concurrency > 1, returns the oldest job in progress
    */
   getCurrentJob(): {
-    job: ReservedJob<T>;
+    job: Job<T>;
     processingTimeMs: number;
   } | null;
   /**
    * Get information about all currently processing jobs
    */
   getCurrentJobs(): Array<{
-    job: ReservedJob<T>;
+    job: Job<T>;
     processingTimeMs: number;
   }>;
   /**

package/dist/index.js

@@ -235,6 +235,7 @@ var Job = class Job {
 		this.timestamp = args.timestamp;
 		this.orderMs = args.orderMs;
 		this.status = args.status ?? "unknown";
+		this.parentId = args.parentId;
 	}
 	async getState() {
 		return this.status ?? "unknown";
@@ -283,6 +284,39 @@ var Job = class Job {
 	async waitUntilFinished(timeoutMs = 0) {
 		return this.queue.waitUntilFinished(this.id, timeoutMs);
 	}
+	/**
+	* Get all child jobs of this job (if it's a parent in a flow).
+	* @returns Array of child Job instances
+	*/
+	async getChildren() {
+		return this.queue.getFlowChildren(this.id);
+	}
+	/**
+	* Get the return values of all child jobs in a flow.
+	* @returns Object mapping child job IDs to their return values
+	*/
+	async getChildrenValues() {
+		return this.queue.getFlowResults(this.id);
+	}
+	/**
+	* Get the number of remaining child jobs that haven't completed yet.
+	* @returns Number of remaining dependencies, or null if not a parent job
+	*/
+	async getDependenciesCount() {
+		return this.queue.getFlowDependencies(this.id);
+	}
+	/**
+	* Get the parent job of this job (if it's a child in a flow).
+	* @returns Parent Job instance, or undefined if no parent or parent was deleted
+	*/
+	async getParent() {
+		if (!this.parentId) return void 0;
+		try {
+			return await this.queue.getJob(this.parentId);
+		} catch (_e) {
+			return;
+		}
+	}
 	static fromReserved(queue, reserved, meta) {
 		return new Job({
 			queue,
@@ -322,6 +356,7 @@ var Job = class Job {
 		const failedReason = (raw.failedReason ?? raw.lastErrorMessage) || void 0;
 		const stacktrace = (raw.stacktrace ?? raw.lastErrorStack) || void 0;
 		const returnvalue = raw.returnvalue ? safeJsonParse$1(raw.returnvalue) : void 0;
+		const parentId = raw.parentId || void 0;
 		return new Job({
 			queue,
 			id,
@@ -340,7 +375,8 @@ var Job = class Job {
 			returnvalue,
 			timestamp: timestampMs || Date.now(),
 			orderMs,
-			status: knownStatus ?? coerceStatus(raw.status)
+			status: knownStatus ?? coerceStatus(raw.status),
+			parentId
 		});
 	}
 	static async fromStore(queue, id) {
@@ -359,6 +395,7 @@ var Job = class Job {
 		const failedReason = (raw.failedReason ?? raw.lastErrorMessage) || void 0;
 		const stacktrace = (raw.stacktrace ?? raw.lastErrorStack) || void 0;
 		const returnvalue = raw.returnvalue ? safeJsonParse$1(raw.returnvalue) : void 0;
+		const parentId = raw.parentId || void 0;
 		const [inProcessing, inDelayed] = await Promise.all([queue.redis.zscore(`${queue.namespace}:processing`, id), queue.redis.zscore(`${queue.namespace}:delayed`, id)]);
 		let status = raw.status;
 		if (inProcessing !== null) status = "active";
@@ -384,7 +421,8 @@ var Job = class Job {
 			returnvalue,
 			timestamp: timestampMs || Date.now(),
 			orderMs,
-			status: coerceStatus(status)
+			status: coerceStatus(status),
+			parentId
 		});
 	}
 };
@@ -632,6 +670,38 @@ var Queue = class {
 		}
 		return parsed;
 	}
+	/**
+	* Gets all child job IDs for a parent job in a flow.
+	* @param parentId The ID of the parent job
+	* @returns An array of child job IDs
+	*/
+	async getFlowChildrenIds(parentId) {
+		return this.r.smembers(`${this.ns}:flow:children:${parentId}`);
+	}
+	/**
+	* Gets all child jobs for a parent job in a flow.
+	* @param parentId The ID of the parent job
+	* @returns An array of Job instances for all children
+	*/
+	async getFlowChildren(parentId) {
+		const ids = await this.getFlowChildrenIds(parentId);
+		if (ids.length === 0) return [];
+		const pipe = this.r.multi();
+		for (const id of ids) pipe.hgetall(`${this.ns}:job:${id}`);
+		const rows = await pipe.exec();
+		const jobs = [];
+		for (let i = 0; i < ids.length; i++) {
+			const id = ids[i];
+			const raw = rows?.[i]?.[1] || {};
+			if (!raw || Object.keys(raw).length === 0) {
+				this.logger.warn(`Skipping child job ${id} - not found (likely cleaned up)`);
+				continue;
+			}
+			const job = Job.fromRawHash(this, id, raw);
+			jobs.push(job);
+		}
+		return jobs;
+	}
 	async addSingle(opts) {
 		const now = Date.now();
 		let delayUntil = 0;
@@ -2515,7 +2585,10 @@ var _Worker = class extends TypedEventEmitter {
 		const oldest = Array.from(this.jobsInProgress)[0];
 		const now = Date.now();
 		return {
-			job: oldest.job,
+			job: Job.fromReserved(this.q, oldest.job, {
+				processedOn: oldest.ts,
+				status: "active"
+			}),
 			processingTimeMs: now - oldest.ts
 		};
 	}
@@ -2525,7 +2598,10 @@ var _Worker = class extends TypedEventEmitter {
 	getCurrentJobs() {
 		const now = Date.now();
 		return Array.from(this.jobsInProgress).map((item) => ({
-			job: item.job,
+			job: Job.fromReserved(this.q, item.job, {
+				processedOn: item.ts,
+				status: "active"
+			}),
 			processingTimeMs: now - item.ts
 		}));
 	}
@@ -2555,7 +2631,7 @@ var _Worker = class extends TypedEventEmitter {
 				} catch (e) {
 					const isConnErr = this.q.isConnectionError(e);
 					if (!isConnErr || !this.stopping) this.logger.error(`Heartbeat error for job ${job.id}:`, e instanceof Error ? e.message : String(e));
-					this.onError?.(e, job);
+					this.onError?.(e, Job.fromReserved(this.q, job, { status: "active" }));
 					if (!isConnErr || !this.stopping) this.emit("error", e instanceof Error ? e : new Error(String(e)));
 				}
 			}, minInterval);
@@ -2566,7 +2642,11 @@ var _Worker = class extends TypedEventEmitter {
 			heartbeatDelayTimer = setTimeout(() => {
 				startHeartbeat();
 			}, heartbeatThreshold);
-			const handlerResult = await this.handler(job);
+			const jobInstance = Job.fromReserved(this.q, job, {
+				processedOn: jobStartWallTime,
+				status: "active"
+			});
+			const handlerResult = await this.handler(jobInstance);
 			if (heartbeatDelayTimer) clearTimeout(heartbeatDelayTimer);
 			if (hbTimer) clearInterval(hbTimer);
 			const finishedAtWall = Date.now();
@@ -2590,7 +2670,11 @@ var _Worker = class extends TypedEventEmitter {
 	* Handle job failure: emit events, retry or dead-letter
 	*/
 	async handleJobFailure(err, job, jobStartWallTime) {
-		this.onError?.(err, job);
+		const jobInstance = Job.fromReserved(this.q, job, {
+			processedOn: jobStartWallTime,
+			status: "active"
+		});
+		this.onError?.(err, jobInstance);
 		this.blockingStats.consecutiveEmptyReserves = 0;
 		this.emptyReserveBackoffMs = 0;
 		try {