@tachybase/plugin-adapter-bullmq 1.3.17 → 1.3.18

package/dist/node_modules/bullmq/dist/esm/classes/job.d.ts

@@ -1,5 +1,5 @@
-import { BulkJobOptions, DependenciesOpts, JobJson, JobJsonRaw, MinimalJob, MoveToWaitingChildrenOpts, ParentKeys, ParentOpts, RedisClient } from '../interfaces';
-import { FinishedStatus, JobsOptions, JobState, JobJsonSandbox, MinimalQueue, RedisJobOptions } from '../types';
+import { BulkJobOptions, DependenciesOpts, JobJson, JobJsonRaw, MinimalJob, MoveToWaitingChildrenOpts, ParentKeys, ParentKeyOpts, RedisClient } from '../interfaces';
+import { FinishedStatus, JobsOptions, JobState, JobJsonSandbox, MinimalQueue, RedisJobOptions, JobProgress } from '../types';
 import { Scripts } from './scripts';
 import type { QueueEvents } from './queue-events';
 export declare const PRIORITY_LIMIT: number;
@@ -11,7 +11,6 @@ export declare const PRIORITY_LIMIT: number;
  *
  * A Job instance is also passed to the Worker's process function.
  *
- * @class Job
  */
 export declare class Job<DataType = any, ReturnType = any, NameType extends string = string> implements MinimalJob<DataType, ReturnType, NameType> {
     protected queue: MinimalQueue;
@@ -30,14 +29,14 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
     id?: string;
     /**
      * It includes the prefix, the namespace separator :, and queue name.
-     * @see https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html
+     * @see {@link https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html}
      */
     readonly queueQualifiedName: string;
     /**
      * The progress a job has performed so far.
      * @defaultValue 0
      */
-    progress: number | object;
+    progress: JobProgress;
     /**
      * The value returned by the processor when processing this job.
      * @defaultValue null
@@ -74,10 +73,20 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
      * @defaultValue 0
      */
     attemptsMade: number;
+    /**
+     * Number of times where job has stalled.
+     * @defaultValue 0
+     */
+    stalledCounter: number;
     /**
      * Reason for failing.
      */
     failedReason: string;
+    /**
+     * Deferred failure. Stores a failed message and marks this job to be failed directly
+     * as soon as the job is picked up by a worker, and using this string as the failed reason.
+     */
+    deferredFailure: string;
     /**
      * Timestamp for when the job finished (completed or failed).
      */
@@ -121,6 +130,9 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
      */
     processedBy?: string;
     protected toKey: (type: string) => string;
+    /**
+     * @deprecated use UnrecoverableError
+     */
     protected discarded: boolean;
     protected scripts: Scripts;
     constructor(queue: MinimalQueue, 
@@ -167,8 +179,8 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
      * @returns
      */
     static fromJSON<T = any, R = any, N extends string = string>(queue: MinimalQueue, json: JobJsonRaw, jobId?: string): Job<T, R, N>;
-    protected setScripts(): void;
-    static optsFromJSON(rawOpts?: string): JobsOptions;
+    protected createScripts(): void;
+    static optsFromJSON(rawOpts?: string, optsDecode?: Record<string, string>): JobsOptions;
     /**
      * Fetches a Job from the queue given the passed job id.
      *
@@ -180,21 +192,21 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
     /**
      * addJobLog
      *
-     * @param queue Queue instance
-     * @param jobId Job id
-     * @param logRow Log row
-     * @param keepLogs optional maximum number of logs to keep
+     * @param queue - A minimal queue instance
+     * @param jobId - Job id
+     * @param logRow - String with a row of log data to be logged
+     * @param keepLogs - The optional amount of log entries to preserve
      *
      * @returns The total number of log entries for this job so far.
      */
     static addJobLog(queue: MinimalQueue, jobId: string, logRow: string, keepLogs?: number): Promise<number>;
-    toJSON(): Omit<this, "toJSON" | "scripts" | "changeDelay" | "changePriority" | "extendLock" | "getState" | "moveToDelayed" | "moveToWaitingChildren" | "promote" | "removeChildDependency" | "updateData" | "updateProgress" | "discard" | "addJob" | "prefix" | "queue" | "asJSON" | "asJSONSandbox" | "log" | "clearLogs" | "remove" | "moveToCompleted" | "moveToFailed" | "isCompleted" | "isFailed" | "isDelayed" | "isWaitingChildren" | "isActive" | "isWaiting" | "queueName" | "getChildrenValues" | "getFailedChildrenValues" | "getDependencies" | "getDependenciesCount" | "waitUntilFinished" | "retry">;
+    toJSON(): Omit<this, "toJSON" | "scripts" | "addJob" | "removeUnprocessedChildren" | "extendLock" | "updateData" | "updateProgress" | "removeChildDependency" | "getState" | "changeDelay" | "changePriority" | "moveToDelayed" | "moveToWaitingChildren" | "promote" | "discard" | "prefix" | "queue" | "asJSON" | "asJSONSandbox" | "log" | "clearLogs" | "remove" | "moveToCompleted" | "moveToWait" | "moveToFailed" | "isCompleted" | "isFailed" | "isDelayed" | "isWaitingChildren" | "isActive" | "isWaiting" | "queueName" | "getChildrenValues" | "getIgnoredChildrenFailures" | "getFailedChildrenValues" | "getDependencies" | "getDependenciesCount" | "waitUntilFinished" | "retry">;
     /**
      * Prepares a job to be serialized for storage in Redis.
      * @returns
      */
     asJSON(): JobJson;
-    static optsAsJSON(opts?: JobsOptions): RedisJobOptions;
+    static optsAsJSON(opts?: JobsOptions, optsEncode?: Record<string, string>): RedisJobOptions;
     /**
      * Prepares a job to be passed to Sandbox.
      * @returns
@@ -211,7 +223,7 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
      *
      * @param progress - number or object to be saved as progress.
      */
-    updateProgress(progress: number | object): Promise<void>;
+    updateProgress(progress: JobProgress): Promise<void>;
     /**
      * Logs one row of log data.
      *
@@ -241,6 +253,15 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
     remove({ removeChildren }?: {
         removeChildren?: boolean;
     }): Promise<void>;
+    /**
+     * Remove all children from this job that are not yet processed,
+     * in other words that are in any other state than completed, failed or active.
+     *
+     * @remarks
+     *  - Jobs with locks (most likely active) are ignored.
+     *  - This method can be slow if the number of children is large (\> 1000).
+     */
+    removeUnprocessedChildren(): Promise<void>;
     /**
      * Extend the lock for this job.
      *
@@ -258,6 +279,13 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
      * @returns Returns the jobData of the next job in the waiting queue or void.
      */
     moveToCompleted(returnValue: ReturnType, token: string, fetchNext?: boolean): Promise<void | any[]>;
+    /**
+     * Moves a job to the wait or prioritized state.
+     *
+     * @param token - Worker token used to acquire completed job.
+     * @returns Returns pttl.
+     */
+    moveToWait(token?: string): Promise<number>;
     private shouldRetryJob;
     /**
      * Moves a job to the failed queue.
@@ -334,7 +362,19 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
         [jobKey: string]: CT;
     }>;
     /**
-     * Get this jobs children failure values if any.
+     * Retrieves the failures of child jobs that were explicitly ignored while using ignoreDependencyOnFailure option.
+     * This method is useful for inspecting which child jobs were intentionally ignored when an error occured.
+     * @see {@link https://docs.bullmq.io/guide/flows/ignore-dependency}
+     *
+     * @returns Object mapping children job keys with their failure values.
+     */
+    getIgnoredChildrenFailures(): Promise<{
+        [jobKey: string]: string;
+    }>;
+    /**
+     * Get job's children failure values that were ignored if any.
+     *
+     * @deprecated This method is deprecated and will be removed in v6. Use getIgnoredChildrenFailures instead.
      *
      * @returns Object mapping children job keys with their failure values.
      */
@@ -348,10 +388,15 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
      * on processed/unprocessed dependencies, since v7.2 you must consider that count
      * won't have any effect until processed/unprocessed dependencies have a length
      * greater than 127
-     * @see https://redis.io/docs/management/optimization/memory-optimization/#redis--72
-     * @returns dependencies separated by processed and unprocessed.
+     * @see {@link https://redis.io/docs/management/optimization/memory-optimization/#redis--72}
+     * @see {@link https://docs.bullmq.io/guide/flows#getters}
+     * @returns dependencies separated by processed, unprocessed, ignored and failed.
      */
     getDependencies(opts?: DependenciesOpts): Promise<{
+        nextFailedCursor?: number;
+        failed?: string[];
+        nextIgnoredCursor?: number;
+        ignored?: Record<string, any>;
         nextProcessedCursor?: number;
         processed?: Record<string, any>;
         nextUnprocessedCursor?: number;
@@ -360,12 +405,16 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
     /**
      * Get children job counts if this job is a parent and has children.
      *
-     * @returns dependencies count separated by processed and unprocessed.
+     * @returns dependencies count separated by processed, unprocessed, ignored and failed.
      */
     getDependenciesCount(opts?: {
+        failed?: boolean;
+        ignored?: boolean;
         processed?: boolean;
         unprocessed?: boolean;
     }): Promise<{
+        failed?: number;
+        ignored?: number;
         processed?: number;
         unprocessed?: number;
     }>;
@@ -408,6 +457,7 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
     retry(state?: FinishedStatus): Promise<void>;
     /**
      * Marks a job to not be retried if it fails (even if attempts has been configured)
+     * @deprecated use UnrecoverableError
      */
     discard(): void;
     private isInZSet;
@@ -419,7 +469,7 @@ export declare class Job<DataType = any, ReturnType = any, NameType extends stri
      * @param parentOpts -
      * @returns
      */
-    addJob(client: RedisClient, parentOpts?: ParentOpts): Promise<string>;
+    addJob(client: RedisClient, parentOpts?: ParentKeyOpts): Promise<string>;
     protected validateOptions(jobData: JobJson): void;
     protected updateStacktrace(err: Error): void;
 }