bullmq 5.47.3 → 5.48.1

package/dist/esm/interfaces/telemetry.d.ts

@@ -33,8 +33,8 @@ export interface ContextManager<Context = any> {
     /**
      * Creates a new context and sets it as active for the fn passed as last argument
      *
-     * @param context -
-     * @param fn -
+     * @param context - the context to set as active
+     * @param fn - the function to execute with the context
      */
     with<A extends (...args: any[]) => any>(context: Context, fn: A): ReturnType<A>;
     /**
@@ -46,15 +46,15 @@ export interface ContextManager<Context = any> {
      * is the mechanism used to propagate the context across a distributed
      * application.
      *
-     * @param context -
+     * @param context - the current context
      */
     getMetadata(context: Context): string;
     /**
      * Creates a new context from a serialized version effectively
      * linking the new context to the parent context.
      *
-     * @param activeContext -
-     * @param metadata -
+     * @param activeContext - the current active context
+     * @param metadata - the serialized version of the context
      */
     fromMetadata(activeContext: Context, metadata: string): Context;
 }
@@ -68,9 +68,10 @@ export interface Tracer<Context = any> {
      * context. If the context is not provided, the current active context should be
      * used.
      *
-     * @param name -
-     * @param options -
-     * @param context -
+     * @param name - span name
+     * @param options - span options
+     * @param context - optional context
+     * @returns - the created span
      */
     startSpan(name: string, options?: SpanOptions, context?: Context): Span;
 }
@@ -85,33 +86,35 @@ export interface Span<Context = any> {
      * setSpanOnContext sets the span on the context. This is useful when you want
      * to propagate the span across the application.
      *
-     * @param ctx
+     * @param ctx - context to set the span on
+     * @returns - the context with the span set on it
      */
     setSpanOnContext(ctx: Context): Context;
     /**
      * setAttribute sets an attribute on the span.
      *
-     * @param ctx
+     * @param key - attribute key
+     * @param value - attribute value
      */
     setAttribute(key: string, value: AttributeValue): void;
     /**
      * setAttributes sets multiple attributes on the span.
      *
-     * @param attributes
+     * @param attributes - attributes to set
      */
     setAttributes(attributes: Attributes): void;
     /**
      * addEvent adds an event to the span.
      *
-     * @param name
-     * @param attributes
+     * @param name - event name
+     * @param attributes - event attributes
      */
     addEvent(name: string, attributes?: Attributes): void;
     /**
      * recordException records an exception on the span.
      *
-     * @param exception
-     * @param time
+     * @param exception - exception to record
+     * @param time - time to record the exception
      */
     recordException(exception: Exception, time?: Time): void;
     /**

package/dist/esm/interfaces/worker-options.d.ts

@@ -20,14 +20,14 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
     /**
      * Condition to start processor at instance creation.
      *
-     * @default true
+     * @defaultValue true
      */
     autorun?: boolean;
     /**
      * Amount of jobs that a single worker is allowed to work on
      * in parallel.
      *
-     * @default 1
+     * @defaultValue 1
      * @see {@link https://docs.bullmq.io/guide/workers/concurrency}
      */
     concurrency?: number;
@@ -46,13 +46,13 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
      * to the `wait` state. If this is exceeded, the job is moved
      * to `failed`.
      *
-     * @default 1
+     * @defaultValue 1
      */
     maxStalledCount?: number;
     /**
      * Number of milliseconds between stallness checks.
      *
-     * @default 30000
+     * @defaultValue 30000
      */
     stalledInterval?: number;
     /**
@@ -72,7 +72,7 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
      *  perform stalled checkd and move jobs back to wait for jobs being processed
      *  by this worker.
      *
-     *  @default false
+     *  @defaultValue false
      */
     skipStalledCheck?: boolean;
     /**
@@ -80,13 +80,13 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
      *  after lockDuration and moved back to the wait queue (if the stalled check is
      *  not disabled)
      *
-     *  @default false
+     *  @defaultValue false
      */
     skipLockRenewal?: boolean;
     /**
      * Number of seconds to long poll for jobs when the queue is empty.
      *
-     * @default 5
+     * @defaultValue 5
      */
     drainDelay?: number;
     /**
@@ -95,7 +95,7 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
      * be picked up by the stalled checker and move back to wait so that another worker
      * can process it again.
      *
-     * @default 30000
+     * @defaultValue 30000
      */
     lockDuration?: number;
     /**
@@ -108,7 +108,7 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
     /**
      * This is an internal option that should not be modified.
      *
-     * @default 15000
+     * @defaultValue 15000
      */
     runRetryDelay?: number;
     /**
@@ -120,7 +120,7 @@ export interface WorkerOptions extends QueueBaseOptions, SandboxedOptions {
      * Note: This option can only be used when specifying
      * a file for the processor argument.
      *
-     * @default false
+     * @defaultValue false
      */
     useWorkerThreads?: boolean;
     /**

package/dist/esm/scripts/index.d.ts

@@ -38,6 +38,7 @@ export * from './removeChildDependency-1';
 export * from './removeJob-3';
 export * from './removeJobScheduler-3';
 export * from './removeRepeatable-3';
+export * from './removeUnprocessedChildren-2';
 export * from './reprocessJob-8';
 export * from './retryJob-11';
 export * from './saveStacktrace-1';

package/dist/esm/scripts/index.js

@@ -38,6 +38,7 @@ export * from './removeChildDependency-1';
 export * from './removeJob-3';
 export * from './removeJobScheduler-3';
 export * from './removeRepeatable-3';
+export * from './removeUnprocessedChildren-2';
 export * from './reprocessJob-8';
 export * from './retryJob-11';
 export * from './saveStacktrace-1';

package/dist/esm/scripts/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/scripts/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/scripts/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC"}

package/dist/esm/scripts/removeJob-3.js

@@ -1,38 +1,18 @@
 const content = `--[[
-    Remove a job from all the queues it may be in as well as all its data.
+    Remove a job from all the statuses it may be in as well as all its data.
     In order to be able to remove a job, it cannot be active.
     Input:
-      KEYS[1] queue prefix
+      KEYS[1] jobKey
       KEYS[2] meta key
       KEYS[3] repeat key
       ARGV[1] jobId
       ARGV[2] remove children
+      ARGV[3] queue prefix
     Events:
       'removed'
 ]]
 local rcall = redis.call
 -- Includes
---[[
-  Functions to destructure job key.
-  Just a bit of warning, these functions may be a bit slow and affect performance significantly.
-]]
-local getJobIdFromKey = function (jobKey)
-  return string.match(jobKey, ".*:(.*)")
-end
-local getJobKeyPrefix = function (jobKey, jobId)
-  return string.sub(jobKey, 0, #jobKey - #jobId)
-end
---[[
-  Function to get max events value or set by default 10000.
-]]
-local function getOrSetMaxEvents(metaKey)
-  local maxEvents = rcall("HGET", metaKey, "opts.maxLenEvents")
-  if not maxEvents then
-    maxEvents = 10000
-    rcall("HSET", metaKey, "opts.maxLenEvents", maxEvents)
-  end
-  return maxEvents
-end
 --[[
   Function to check if the job belongs to a job scheduler and
   current delayed job matches with jobId
@@ -54,6 +34,16 @@ end
   returns:
     boolean
 ]]
+--[[
+  Functions to destructure job key.
+  Just a bit of warning, these functions may be a bit slow and affect performance significantly.
+]]
+local getJobIdFromKey = function (jobKey)
+  return string.match(jobKey, ".*:(.*)")
+end
+local getJobKeyPrefix = function (jobKey, jobId)
+  return string.sub(jobKey, 0, #jobKey - #jobId)
+end
 local function isLocked( prefix, jobId, removeChildren)
   local jobKey = prefix .. jobId;
   -- Check if this job is locked
@@ -78,6 +68,25 @@ local function isLocked( prefix, jobId, removeChildren)
   end
   return true
 end
+--[[
+    Remove a job from all the statuses it may be in as well as all its data,
+    including its children. Active children can be ignored.
+    Events:
+      'removed'
+]]
+local rcall = redis.call
+-- Includes
+--[[
+  Function to get max events value or set by default 10000.
+]]
+local function getOrSetMaxEvents(metaKey)
+  local maxEvents = rcall("HGET", metaKey, "opts.maxLenEvents")
+  if not maxEvents then
+    maxEvents = 10000
+    rcall("HSET", metaKey, "opts.maxLenEvents", maxEvents)
+  end
+  return maxEvents
+end
 --[[
   Function to remove deduplication key.
 ]]
@@ -241,66 +250,85 @@ local function removeParentDependencyKey(jobKey, hard, parentKey, baseKey, debou
   end
   return false
 end
-local function removeJob(prefix, jobId, parentKey, removeChildren)
-    local jobKey = prefix .. jobId;
-    removeParentDependencyKey(jobKey, false, parentKey, nil)
-    if removeChildren == "1" then
-        -- Check if this job has children
-        -- If so, we are going to try to remove the children recursively in deep first way because
-        -- if some job is locked we must exit with and error.
-        -- local countProcessed = rcall("HLEN", jobKey .. ":processed")
+local removeJobChildren
+local removeJobWithChildren
+removeJobChildren = function(prefix, meta, jobKey, options)
+    -- Check if this job has children
+    -- If so, we are going to try to remove the children recursively in a depth-first way
+    -- because if some job is locked, we must exit with an error.
+    if not options.ignoreProcessed then
         local processed = rcall("HGETALL", jobKey .. ":processed")
-        if (#processed > 0) then
+        if #processed > 0 then
             for i = 1, #processed, 2 do
                 local childJobId = getJobIdFromKey(processed[i])
                 local childJobPrefix = getJobKeyPrefix(processed[i], childJobId)
-                removeJob(childJobPrefix, childJobId, jobKey, removeChildren)
-            end
-        end
-        local dependencies = rcall("SMEMBERS", jobKey .. ":dependencies")
-        if (#dependencies > 0) then
-            for i, childJobKey in ipairs(dependencies) do
-                -- We need to get the jobId for this job.
-                local childJobId = getJobIdFromKey(childJobKey)
-                local childJobPrefix = getJobKeyPrefix(childJobKey, childJobId)
-                removeJob(childJobPrefix, childJobId, jobKey, removeChildren)
+                removeJobWithChildren(childJobPrefix, meta, childJobId, jobKey, options)
             end
         end
         local failed = rcall("HGETALL", jobKey .. ":failed")
-        if (#failed > 0) then
+        if #failed > 0 then
             for i = 1, #failed, 2 do
                 local childJobId = getJobIdFromKey(failed[i])
                 local childJobPrefix = getJobKeyPrefix(failed[i], childJobId)
-                removeJob(childJobPrefix, childJobId, jobKey, removeChildren)
+                removeJobWithChildren(childJobPrefix, meta, childJobId, jobKey, options)
             end
         end
         local unsuccessful = rcall("ZRANGE", jobKey .. ":unsuccessful", 0, -1)
-        if (#unsuccessful > 0) then
+        if #unsuccessful > 0 then
             for i = 1, #unsuccessful, 1 do
                 local childJobId = getJobIdFromKey(unsuccessful[i])
                 local childJobPrefix = getJobKeyPrefix(unsuccessful[i], childJobId)
-                removeJob(childJobPrefix, childJobId, jobKey, removeChildren)
+                removeJobWithChildren(childJobPrefix, meta, childJobId, jobKey, options)
             end
         end
     end
-    local prev = removeJobFromAnyState(prefix, jobId)
-    removeDeduplicationKey(prefix, jobKey)
-    if removeJobKeys(jobKey) > 0 then
-        local maxEvents = getOrSetMaxEvents(KEYS[2])
-        rcall("XADD", prefix .. "events", "MAXLEN", "~", maxEvents, "*", "event", "removed", "jobId", jobId, "prev",
-            prev)
+    local dependencies = rcall("SMEMBERS", jobKey .. ":dependencies")
+    if #dependencies > 0 then
+        for i, childJobKey in ipairs(dependencies) do
+            local childJobId = getJobIdFromKey(childJobKey)
+            local childJobPrefix = getJobKeyPrefix(childJobKey, childJobId)
+            removeJobWithChildren(childJobPrefix, meta, childJobId, jobKey, options)
+        end
+    end
+end
+removeJobWithChildren = function(prefix, meta, jobId, parentKey, options)
+    local jobKey = prefix .. jobId
+    if options.ignoreLocked then
+        if isLocked(prefix, jobId) then
+            return
+        end
+    end
+    -- Check if job is in the failed zset
+    local failedSet = prefix .. "failed"
+    if not (options.ignoreProcessed and rcall("ZSCORE", failedSet, jobId)) then
+        removeParentDependencyKey(jobKey, false, parentKey, nil)
+        if options.removeChildren then
+            removeJobChildren(prefix, meta, jobKey, options)
+        end
+        local prev = removeJobFromAnyState(prefix, jobId)
+        removeDeduplicationKey(prefix, jobKey)
+        if removeJobKeys(jobKey) > 0 then
+            local maxEvents = getOrSetMaxEvents(meta)
+            rcall("XADD", prefix .. "events", "MAXLEN", "~", maxEvents, "*", "event", "removed", "jobId", jobId, "prev", prev)
+        end
     end
 end
-local prefix = KEYS[1]
 local jobId = ARGV[1]
 local shouldRemoveChildren = ARGV[2]
-local jobKey = prefix .. jobId
+local prefix = ARGV[3]
+local jobKey = KEYS[1]
+local meta = KEYS[2]
 local repeatKey = KEYS[3]
 if isJobSchedulerJob(jobId, jobKey, repeatKey) then
     return -8
 end
 if not isLocked(prefix, jobId, shouldRemoveChildren) then
-    removeJob(prefix, jobId, nil, shouldRemoveChildren)
+    local options = {
+        removeChildren = shouldRemoveChildren == "1",
+        ignoreProcessed = false,
+        ignoreLocked = false
+    }
+    removeJobWithChildren(prefix, meta, jobId, nil, options)
     return 1
 end
 return 0

package/dist/esm/scripts/removeJob-3.js.map

@@ -1 +1 @@
-{"version":3,"file":"removeJob-3.js","sourceRoot":"","sources":["../../../src/scripts/removeJob-3.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkTf,CAAC;AACF,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE,WAAW;IACjB,OAAO;IACP,IAAI,EAAE,CAAC;CACR,CAAC"}
+{"version":3,"file":"removeJob-3.js","sourceRoot":"","sources":["../../../src/scripts/removeJob-3.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8Uf,CAAC;AACF,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE,WAAW;IACjB,OAAO;IACP,IAAI,EAAE,CAAC;CACR,CAAC"}

package/dist/esm/scripts/removeUnprocessedChildren-2.d.ts

@@ -0,0 +1,5 @@
+export declare const removeUnprocessedChildren: {
+    name: string;
+    content: string;
+    keys: number;
+};