bullmq 6.3.12 → 6.3.14

package/dist/cjs/classes/queue-getters.js

@@ -329,7 +329,9 @@ class QueueGetters extends queue_base_1.QueueBase {
      *
      * @param parentId - The id of the parent job
      * @param type - "processed" | "pending"
-     * @param opts - Options for the query.
+     * @param start - Zero-based index from where to start returning children.
+     * @param end - Zero-based index where to stop returning children (inclusive),
+     * or -1 to return all of them.
      *
      * @returns an object with the following shape:
      * `{ items: { id: string, v?: any, err?: string } [], jobs: JobJson[], total: number}`

package/dist/cjs/classes/queue.js

@@ -233,7 +233,8 @@ class Queue extends queue_getters_1.QueueGetters {
      * Upserting a scheduler will create a new job scheduler or update an existing one.
      * It will also create the first job based on the repeat options and delayed accordingly.
      *
-     * @param key - Unique key for the repeatable job meta.
+     * @param jobSchedulerId - Unique id of the job scheduler. Upserting with an
+     * existing id updates that scheduler.
      * @param repeatOpts - Repeat options
      * @param jobTemplate - Job template. If provided it will be used for all the jobs
      * created by the scheduler.

package/dist/cjs/classes/redis-connection.js

@@ -175,7 +175,7 @@ class RedisConnection extends events_1.EventEmitter {
     }
     /**
      * Waits for a redis client to be ready.
-     * @param redis - client
+     * @param client - Redis client to wait for.
      */
     static async waitUntilReady(client) {
         if (client.status === 'ready') {

package/dist/cjs/classes/redis-queue-backend.js

@@ -1438,8 +1438,8 @@ class RedisQueueBackend extends events_1.EventEmitter {
      * This script is used when a job has been manually rate limited and needs
      * to be moved back to wait from active status.
      *
-     * @param client - Redis client
      * @param jobId - Job id
+     * @param token - Lock token of the job. Defaults to '0'.
      * @returns
      */
     async moveJobFromActiveToWait(jobId, token = '0') {

package/dist/cjs/commands/includes/moveChildBackToParentDependencies.lua

@@ -0,0 +1,20 @@
+--[[
+  Function to move a retried child back to its parent's dependencies.
+  This does not move a parent that has already left waiting-children back to that state.
+]]
+local function moveChildBackToParentDependencies(jobKey, prevState)
+  local parentKey = rcall("HGET", jobKey, "parentKey")
+
+  if parentKey and rcall("EXISTS", parentKey) == 1 then
+    if prevState == "failed" then
+      if rcall("ZREM", parentKey .. ":unsuccessful", jobKey) == 1 or
+        rcall("HDEL", parentKey .. ":failed", jobKey) == 1 then
+        rcall("SADD", parentKey .. ":dependencies", jobKey)
+      end
+    else
+      if rcall("HDEL", parentKey .. ":processed", jobKey) == 1 then
+        rcall("SADD", parentKey .. ":dependencies", jobKey)
+      end
+    end
+  end
+end

package/dist/cjs/commands/moveJobsToWait-8.lua

@@ -31,6 +31,7 @@ local rcall = redis.call;
 --- @include "includes/batches"
 --- @include "includes/getOrSetMaxEvents"
 --- @include "includes/isQueuePausedOrMaxed"
+--- @include "includes/moveChildBackToParentDependencies"
 
 local metaKey = KEYS[6]
 local isPausedOrMaxed = isQueuePausedOrMaxed(metaKey, KEYS[7])
@@ -42,11 +43,13 @@ if (#jobs > 0) then
         for i, key in ipairs(jobs) do
             local jobKey = KEYS[1] .. key
             rcall("HDEL", jobKey, "finishedOn", "processedOn", "failedReason")
+            moveChildBackToParentDependencies(jobKey, ARGV[3])
         end
     elseif ARGV[3] == "completed" then
         for i, key in ipairs(jobs) do
             local jobKey = KEYS[1] .. key
             rcall("HDEL", jobKey, "finishedOn", "processedOn", "returnvalue")
+            moveChildBackToParentDependencies(jobKey, ARGV[3])
         end
     end
 

package/dist/cjs/commands/reprocessJob-7.lua

@@ -28,6 +28,7 @@ local rcall = redis.call;
 --- @include "includes/addJobInTargetList"
 --- @include "includes/getOrSetMaxEvents"
 --- @include "includes/isQueuePausedOrMaxed"
+--- @include "includes/moveChildBackToParentDependencies"
 
 local jobKey = KEYS[1]
 if rcall("EXISTS", jobKey) == 1 then
@@ -48,20 +49,7 @@ if rcall("EXISTS", jobKey) == 1 then
     local isPausedOrMaxed = isQueuePausedOrMaxed(KEYS[5], KEYS[6])
     addJobInTargetList(KEYS[4], KEYS[7], ARGV[2], isPausedOrMaxed, jobId)
 
-    local parentKey = rcall("HGET", jobKey, "parentKey")
-
-    if parentKey and rcall("EXISTS", parentKey) == 1 then
-      if ARGV[4] == "failed" then
-        if rcall("ZREM", parentKey .. ":unsuccessful", jobKey) == 1 or
-          rcall("HDEL", parentKey .. ":failed", jobKey) == 1 then
-          rcall("SADD", parentKey .. ":dependencies", jobKey)
-        end
-      else
-        if rcall("HDEL", parentKey .. ":processed", jobKey) == 1 then
-          rcall("SADD", parentKey .. ":dependencies", jobKey)
-        end
-      end
-    end
+    moveChildBackToParentDependencies(jobKey, ARGV[4])
 
     local maxEvents = getOrSetMaxEvents(KEYS[5])
     -- Emit waiting event

package/dist/cjs/scripts/moveJobsToWait-8.js

@@ -75,6 +75,25 @@ local function isQueuePausedOrMaxed(queueMetaKey, activeKey)
   end
   return false
 end
+--[[
+  Function to move a retried child back to its parent's dependencies.
+  This does not move a parent that has already left waiting-children back to that state.
+]]
+local function moveChildBackToParentDependencies(jobKey, prevState)
+  local parentKey = rcall("HGET", jobKey, "parentKey")
+  if parentKey and rcall("EXISTS", parentKey) == 1 then
+    if prevState == "failed" then
+      if rcall("ZREM", parentKey .. ":unsuccessful", jobKey) == 1 or
+        rcall("HDEL", parentKey .. ":failed", jobKey) == 1 then
+        rcall("SADD", parentKey .. ":dependencies", jobKey)
+      end
+    else
+      if rcall("HDEL", parentKey .. ":processed", jobKey) == 1 then
+        rcall("SADD", parentKey .. ":dependencies", jobKey)
+      end
+    end
+  end
+end
 local metaKey = KEYS[6]
 local isPausedOrMaxed = isQueuePausedOrMaxed(metaKey, KEYS[7])
 local jobs = rcall('ZRANGEBYSCORE', KEYS[3], 0, timestamp, 'LIMIT', 0, maxCount)
@@ -83,11 +102,13 @@ if (#jobs > 0) then
         for i, key in ipairs(jobs) do
             local jobKey = KEYS[1] .. key
             rcall("HDEL", jobKey, "finishedOn", "processedOn", "failedReason")
+            moveChildBackToParentDependencies(jobKey, ARGV[3])
         end
     elseif ARGV[3] == "completed" then
         for i, key in ipairs(jobs) do
             local jobKey = KEYS[1] .. key
             rcall("HDEL", jobKey, "finishedOn", "processedOn", "returnvalue")
+            moveChildBackToParentDependencies(jobKey, ARGV[3])
         end
     end
     local maxEvents = getOrSetMaxEvents(metaKey)

package/dist/cjs/scripts/reprocessJob-7.js

@@ -67,6 +67,25 @@ local function isQueuePausedOrMaxed(queueMetaKey, activeKey)
   end
   return false
 end
+--[[
+  Function to move a retried child back to its parent's dependencies.
+  This does not move a parent that has already left waiting-children back to that state.
+]]
+local function moveChildBackToParentDependencies(jobKey, prevState)
+  local parentKey = rcall("HGET", jobKey, "parentKey")
+  if parentKey and rcall("EXISTS", parentKey) == 1 then
+    if prevState == "failed" then
+      if rcall("ZREM", parentKey .. ":unsuccessful", jobKey) == 1 or
+        rcall("HDEL", parentKey .. ":failed", jobKey) == 1 then
+        rcall("SADD", parentKey .. ":dependencies", jobKey)
+      end
+    else
+      if rcall("HDEL", parentKey .. ":processed", jobKey) == 1 then
+        rcall("SADD", parentKey .. ":dependencies", jobKey)
+      end
+    end
+  end
+end
 local jobKey = KEYS[1]
 if rcall("EXISTS", jobKey) == 1 then
   local jobId = ARGV[1]
@@ -81,19 +100,7 @@ if rcall("EXISTS", jobKey) == 1 then
     rcall("HDEL", jobKey, "finishedOn", "processedOn", ARGV[3], unpack(attributesToRemove))
     local isPausedOrMaxed = isQueuePausedOrMaxed(KEYS[5], KEYS[6])
     addJobInTargetList(KEYS[4], KEYS[7], ARGV[2], isPausedOrMaxed, jobId)
-    local parentKey = rcall("HGET", jobKey, "parentKey")
-    if parentKey and rcall("EXISTS", parentKey) == 1 then
-      if ARGV[4] == "failed" then
-        if rcall("ZREM", parentKey .. ":unsuccessful", jobKey) == 1 or
-          rcall("HDEL", parentKey .. ":failed", jobKey) == 1 then
-          rcall("SADD", parentKey .. ":dependencies", jobKey)
-        end
-      else
-        if rcall("HDEL", parentKey .. ":processed", jobKey) == 1 then
-          rcall("SADD", parentKey .. ":dependencies", jobKey)
-        end
-      end
-    end
+    moveChildBackToParentDependencies(jobKey, ARGV[4])
     local maxEvents = getOrSetMaxEvents(KEYS[5])
     -- Emit waiting event
     rcall("XADD", KEYS[2], "MAXLEN", "~", maxEvents, "*", "event", "waiting",