bullmq 2.2.0 → 2.3.0

package/dist/{cjs/commands/addJob-8.lua → esm/scripts/addJob-8.js}

@@ -1,8 +1,7 @@
---[[
+const content = `--[[
   Adds a job to the queue by doing the following:
     - Increases the job counter if needed.
     - Creates a new job key with the job data.
-
     - if delayed:
       - computes timestamp.
       - adds to delayed zset.
@@ -13,7 +12,6 @@
          - FIFO
          - prioritized.
       - Adds the job to the "added" list so that workers gets notified.
-
     Input:
       KEYS[1] 'wait',
       KEYS[2] 'paused'
@@ -23,7 +21,6 @@
       KEYS[6] 'priority'
       KEYS[7] 'completed'
       KEYS[8] events stream key
-
       ARGV[1] msgpacked arguments array
             [1]  key prefix,
             [2]  custom id (will not generate one automatically)
@@ -34,10 +31,8 @@
             [7]  parent dependencies key.
             [8]  parent? {id, queueKey}
             [9] repeat job key
-            
       ARGV[2] Json stringified job data
       ARGV[3] msgpacked options
-
       Output:
         jobId  - OK
         -5     - Missing parent key
@@ -45,39 +40,96 @@
 local jobId
 local jobIdKey
 local rcall = redis.call
-
 local args = cmsgpack.unpack(ARGV[1])
-
 local data = ARGV[2]
 local opts = cmsgpack.unpack(ARGV[3])
-
 local parentKey = args[5]
 local repeatJobKey = args[9]
 local parent = args[8]
 local parentData
-
 -- Includes
---- @include "includes/addJobWithPriority"
---- @include "includes/getTargetQueueList"
---- @include "includes/trimEvents"
---- @include "includes/getNextDelayedTimestamp"
-
+--[[
+  Function to add job considering priority.
+]]
+local function addJobWithPriority(priorityKey, priority, targetKey, jobId)
+  rcall("ZADD", priorityKey, priority, jobId)
+  local count = rcall("ZCOUNT", priorityKey, 0, priority)
+  local len = rcall("LLEN", targetKey)
+  local id = rcall("LINDEX", targetKey, len - (count - 1))
+  if id then
+    rcall("LINSERT", targetKey, "BEFORE", id, jobId)
+  else
+    rcall("RPUSH", targetKey, jobId)
+  end
+end
+--[[
+  Function to check for the meta.paused key to decide if we are paused or not
+  (since an empty list and !EXISTS are not really the same).
+]]
+local function getTargetQueueList(queueMetaKey, waitKey, pausedKey)
+  if rcall("HEXISTS", queueMetaKey, "paused") ~= 1 then
+    return waitKey
+  else
+    return pausedKey
+  end
+end
+--[[
+  Function to trim events, default 10000.
+]]
+local function trimEvents(metaKey, eventStreamKey)
+  local maxEvents = rcall("HGET", metaKey, "opts.maxLenEvents")
+  if maxEvents ~= false then
+    rcall("XTRIM", eventStreamKey, "MAXLEN", "~", maxEvents)
+  else
+    rcall("XTRIM", eventStreamKey, "MAXLEN", "~", 10000)
+  end
+end
+--[[
+  Function to return the next delayed job timestamp.
+]] 
+local function getNextDelayedTimestamp(delayedKey)
+    local result = rcall("ZRANGE", delayedKey, 0, 0, "WITHSCORES")
+    if #result then
+      local nextTimestamp = tonumber(result[2])
+      if (nextTimestamp ~= nil) then 
+        nextTimestamp = nextTimestamp / 0x1000
+      end
+      return nextTimestamp
+    end
+end
 if parentKey ~= nil then
   if rcall("EXISTS", parentKey) ~= 1 then
     return -5
   end
-
   parentData = cjson.encode(parent)
 end
-
 local jobCounter = rcall("INCR", KEYS[4])
-
 -- Includes
---- @include "includes/updateParentDepsIfNeeded"
-
+--[[
+  Validate and move or add dependencies to parent.
+]]
+-- Includes
+local function updateParentDepsIfNeeded(parentKey, parentQueueKey, parentDependenciesKey,
+  parentId, jobIdKey, returnvalue )
+  local processedSet = parentKey .. ":processed"
+  rcall("HSET", processedSet, jobIdKey, returnvalue)
+  local activeParent = rcall("ZSCORE", parentQueueKey .. ":waiting-children", parentId)
+  if rcall("SCARD", parentDependenciesKey) == 0 and activeParent then 
+    rcall("ZREM", parentQueueKey .. ":waiting-children", parentId)
+    local parentTarget = getTargetQueueList(parentQueueKey .. ":meta", parentQueueKey .. ":wait",
+      parentQueueKey .. ":paused")
+    local priority = tonumber(rcall("HGET", parentKey, "priority"))
+    -- Standard or priority add
+    if priority == 0 then
+      rcall("RPUSH", parentTarget, parentId)
+    else
+      addJobWithPriority(parentQueueKey .. ":priority", priority, parentTarget, parentId)
+    end
+    rcall("XADD", parentQueueKey .. ":events", "*", "event", "waiting", "jobId", parentId, "prev", "waiting-children")
+  end
+end
 -- Trim events before emiting them to avoid trimming events emitted in this script
 trimEvents(KEYS[3], KEYS[8])
-
 local parentDependenciesKey = args[7]
 if args[2] == "" then
   jobId = jobCounter
@@ -101,13 +153,11 @@ else
     return jobId .. "" -- convert to string
   end
 end
-
 -- Store the job.
 local jsonOpts = cjson.encode(opts)
 local delay = opts['delay'] or 0
 local priority = opts['priority'] or 0
 local timestamp = args[4]
-
 local optionalValues = {}
 if parentKey ~= nil then
   table.insert(optionalValues, "parentKey")
@@ -115,20 +165,15 @@ if parentKey ~= nil then
   table.insert(optionalValues, "parent")
   table.insert(optionalValues, parentData)
 end
-
 if repeatJobKey ~= nil then
   table.insert(optionalValues, "rjk")
   table.insert(optionalValues, repeatJobKey)
 end
-
 rcall("HMSET", jobIdKey, "name", args[3], "data", ARGV[2], "opts", jsonOpts,
   "timestamp", timestamp, "delay", delay, "priority", priority, unpack(optionalValues))
-
 rcall("XADD", KEYS[8], "*", "event", "added", "jobId", jobId, "name", args[3])
-
 -- Check if job is delayed
 local delayedTimestamp = (delay > 0 and (timestamp + delay)) or 0
-
 -- Check if job is a parent, if so add to the parents set
 local waitChildrenKey = args[6]
 if waitChildrenKey ~= nil then
@@ -150,7 +195,6 @@ elseif (delayedTimestamp ~= 0) then
     end
 else
     local target = getTargetQueueList(KEYS[3], KEYS[1], KEYS[2])
-
     -- Standard or priority add
     if priority == 0 then
         -- LIFO or FIFO
@@ -163,12 +207,17 @@ else
     -- Emit waiting event
     rcall("XADD", KEYS[8], "*", "event", "waiting", "jobId", jobId)
 end
-
 -- Check if this job is a child of another job, if so add it to the parents dependencies
 -- TODO: Should not be possible to add a child job to a parent that is not in the "waiting-children" status.
 -- fail in this case.
 if parentDependenciesKey ~= nil then
     rcall("SADD", parentDependenciesKey, jobIdKey)
 end
-
 return jobId .. "" -- convert to string
+`;
+export const addJob = {
+    name: 'addJob',
+    content,
+    keys: 8,
+};
+//# sourceMappingURL=addJob-8.js.map

package/dist/esm/scripts/addJob-8.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addJob-8.js","sourceRoot":"","sources":["../../../src/scripts/addJob-8.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwNf,CAAC;AACF,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,IAAI,EAAE,QAAQ;IACd,OAAO;IACP,IAAI,EAAE,CAAC;CACR,CAAC"}

package/dist/esm/scripts/changeDelay-4.d.ts

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

package/dist/esm/{commands/changeDelay-4.lua → scripts/changeDelay-4.js}

@@ -1,11 +1,10 @@
---[[
+const content = `--[[
   Change job delay when it is in delayed set.
   Input:
     KEYS[1] delayed key
     KEYS[2] job key
     KEYS[3] events stream
     KEYS[4] delayed stream
-
     ARGV[1] delay
     ARGV[2] delayedTimestamp
     ARGV[3] the id of the job
@@ -13,31 +12,29 @@
     0 - OK
    -1 - Missing job.
    -3 - Job not in delayed set.
-
   Events:
     - delayed key.
 ]]
 local rcall = redis.call
-
 if rcall("EXISTS", KEYS[2]) == 1 then
-
   local jobId = ARGV[3]
   local score = tonumber(ARGV[2])
   local delayedTimestamp = (score / 0x1000)
-
   local numRemovedElements = rcall("ZREM", KEYS[1], jobId)
-
   if (numRemovedElements < 1)  then
     return -3
   end
-
   rcall("HSET", KEYS[2], "delay", tonumber(ARGV[1]))
   rcall("ZADD", KEYS[1], score, jobId)
-
   rcall("XADD", KEYS[3], "*", "event", "delayed", "jobId", jobId, "delay", delayedTimestamp);
   rcall("XADD", KEYS[4], "*", "nextTimestamp", delayedTimestamp);
-
   return 0
 else
   return -1
-end
+end`;
+export const changeDelay = {
+    name: 'changeDelay',
+    content,
+    keys: 4,
+};
+//# sourceMappingURL=changeDelay-4.js.map

package/dist/esm/scripts/changeDelay-4.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changeDelay-4.js","sourceRoot":"","sources":["../../../src/scripts/changeDelay-4.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAiCZ,CAAC;AACL,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,IAAI,EAAE,aAAa;IACnB,OAAO;IACP,IAAI,EAAE,CAAC;CACR,CAAC"}

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

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

package/dist/esm/scripts/cleanJobsInSet-2.js

@@ -0,0 +1,261 @@
+const content = `--[[
+  Remove jobs from the specific set.
+  Input:
+    KEYS[1]  set key,
+    KEYS[2]  events stream key
+    ARGV[1]  jobKey prefix
+    ARGV[2]  timestamp
+    ARGV[3]  limit the number of jobs to be removed. 0 is unlimited
+    ARGV[4]  set name, can be any of 'wait', 'active', 'paused', 'delayed', 'completed', or 'failed'
+]]
+local rcall = redis.call
+local rangeStart = 0
+local rangeEnd = -1
+local limit = tonumber(ARGV[3])
+-- If we're only deleting _n_ items, avoid retrieving all items
+-- for faster performance
+--
+-- Start from the tail of the list, since that's where oldest elements
+-- are generally added for FIFO lists
+if limit > 0 then
+  rangeStart = -1 - limit + 1
+  rangeEnd = -1
+end
+-- Includes
+--[[
+  Function to clean job list.
+  Returns jobIds and deleted count number.
+]]
+-- Includes
+--[[
+  Function to get the latest saved timestamp.
+]]
+local function getTimestamp(jobKey, attributes)
+  if #attributes == 1 then
+    return rcall("HGET", jobKey, attributes[1])
+  end
+  local jobTs
+  for _, ts in ipairs(rcall("HMGET", jobKey, unpack(attributes))) do
+    if (ts) then
+      jobTs = ts
+      break
+    end
+  end
+  return jobTs
+end
+--[[
+  Function to remove job.
+]]
+-- Includes
+--[[
+  Check if this job has a parent. If so we will just remove it from
+  the parent child list, but if it is the last child we should move the parent to "wait/paused"
+  which requires code from "moveToFinished"
+]]
+--[[
+  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 check for the meta.paused key to decide if we are paused or not
+  (since an empty list and !EXISTS are not really the same).
+]]
+local function getTargetQueueList(queueMetaKey, waitKey, pausedKey)
+  if rcall("HEXISTS", queueMetaKey, "paused") ~= 1 then
+    return waitKey
+  else
+    return pausedKey
+  end
+end
+local function moveParentToWait(parentPrefix, parentId, emitEvent)
+  local parentTarget = getTargetQueueList(parentPrefix .. "meta", parentPrefix .. "wait", parentPrefix .. "paused")
+  rcall("RPUSH", parentTarget, parentId)
+  if emitEvent then
+    local parentEventStream = parentPrefix .. "events"
+    rcall("XADD", parentEventStream, "*", "event", "waiting", "jobId", parentId, "prev", "waiting-children")
+  end
+end
+local function removeParentDependencyKey(jobKey, hard, parentKey, baseKey)
+  if parentKey then
+    local parentProcessedKey = parentKey .. ":processed"
+    rcall("HDEL", parentProcessedKey, jobKey)
+    local parentDependenciesKey = parentKey .. ":dependencies"
+    local result = rcall("SREM", parentDependenciesKey, jobKey)
+    if result > 0 then
+      local pendingDependencies = rcall("SCARD", parentDependenciesKey)
+      if pendingDependencies == 0 then
+        local parentId = getJobIdFromKey(parentKey)
+        local parentPrefix = getJobKeyPrefix(parentKey, parentId)
+        local numRemovedElements = rcall("ZREM", parentPrefix .. "waiting-children", parentId)
+        if numRemovedElements == 1 then
+          if hard then
+            if parentPrefix == baseKey then
+              removeParentDependencyKey(parentKey, hard, nil, baseKey)
+              rcall("DEL", parentKey, parentKey .. ':logs',
+                parentKey .. ':dependencies', parentKey .. ':processed')
+            else
+              moveParentToWait(parentPrefix, parentId)
+            end
+          else
+            moveParentToWait(parentPrefix, parentId, true)
+          end
+        end
+      end
+    end
+  else
+    local missedParentKey = rcall("HGET", jobKey, "parentKey")
+    if( (type(missedParentKey) == "string") and missedParentKey ~= "" and (rcall("EXISTS", missedParentKey) == 1)) then
+      local parentProcessedKey = missedParentKey .. ":processed"
+      rcall("HDEL", parentProcessedKey, jobKey)
+      local parentDependenciesKey = missedParentKey .. ":dependencies"
+      local result = rcall("SREM", parentDependenciesKey, jobKey)
+      if result > 0 then
+        local pendingDependencies = rcall("SCARD", parentDependenciesKey)
+        if pendingDependencies == 0 then
+          local parentId = getJobIdFromKey(missedParentKey)
+          local parentPrefix = getJobKeyPrefix(missedParentKey, parentId)
+          local numRemovedElements = rcall("ZREM", parentPrefix .. "waiting-children", parentId)
+          if numRemovedElements == 1 then
+            if hard then
+              if parentPrefix == baseKey then
+                removeParentDependencyKey(missedParentKey, hard, nil, baseKey)
+                rcall("DEL", missedParentKey, missedParentKey .. ':logs',
+                  missedParentKey .. ':dependencies', missedParentKey .. ':processed')
+              else
+                moveParentToWait(parentPrefix, parentId)
+              end
+            else
+              moveParentToWait(parentPrefix, parentId, true)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+local function removeJob(jobId, hard, baseKey)
+  local jobKey = baseKey .. jobId
+  removeParentDependencyKey(jobKey, hard, nil, baseKey)
+  rcall("DEL", jobKey, jobKey .. ':logs',
+    jobKey .. ':dependencies', jobKey .. ':processed')
+end
+local function cleanList(listKey, jobKeyPrefix, rangeStart, rangeEnd,
+  timestamp, isWaiting)
+  local jobs = rcall("LRANGE", listKey, rangeStart, rangeEnd)
+  local deleted = {}
+  local deletedCount = 0
+  local jobTS
+  local deletionMarker = ''
+  local jobIdsLen = #jobs
+  for i, job in ipairs(jobs) do
+    if limit > 0 and deletedCount >= limit then
+      break
+    end
+    local jobKey = jobKeyPrefix .. job
+    if (isWaiting or rcall("EXISTS", jobKey .. ":lock") == 0) then
+      -- Find the right timestamp of the job to compare to maxTimestamp:
+      -- * finishedOn says when the job was completed, but it isn't set unless the job has actually completed
+      -- * processedOn represents when the job was last attempted, but it doesn't get populated until
+      --   the job is first tried
+      -- * timestamp is the original job submission time
+      -- Fetch all three of these (in that order) and use the first one that is set so that we'll leave jobs
+      -- that have been active within the grace period:
+      jobTS = getTimestamp(jobKey, {"finishedOn", "processedOn", "timestamp"})
+      if (not jobTS or jobTS < timestamp) then
+        -- replace the entry with a deletion marker; the actual deletion will
+        -- occur at the end of the script
+        rcall("LSET", listKey, rangeEnd - jobIdsLen + i, deletionMarker)
+        removeJob(job, true, jobKeyPrefix)
+        if isWaiting then
+          rcall("ZREM", jobKeyPrefix .. "priority", job)
+        end
+        deletedCount = deletedCount + 1
+        table.insert(deleted, job)
+      end
+    end
+  end
+  rcall("LREM", listKey, 0, deletionMarker)
+  return {deleted, deletedCount}
+end
+--[[
+  Function to clean job set.
+  Returns jobIds and deleted count number.
+]]
+-- Includes
+--[[
+  Function to loop in batches.
+  Just a bit of warning, some commands as ZREM
+  could receive a maximum of 7000 parameters per call.
+]]
+local function batches(n, batchSize)
+  local i = 0
+  return function()
+    local from = i * batchSize + 1
+    i = i + 1
+    if (from <= n) then
+      local to = math.min(from + batchSize - 1, n)
+      return from, to
+    end
+  end
+end
+-- We use ZRANGEBYSCORE to make the case where we're deleting a limited number
+-- of items in a sorted set only run a single iteration. If we simply used
+-- ZRANGE, we may take a long time traversing through jobs that are within the
+-- grace period.
+local function getJobs(setKey, rangeStart, rangeEnd, maxTimestamp, limit)
+  if limit > 0 then
+    return rcall("ZRANGEBYSCORE", setKey, 0, maxTimestamp, "LIMIT", 0, limit)
+  else
+    return rcall("ZRANGE", setKey, rangeStart, rangeEnd)
+  end
+end
+local function cleanSet(setKey, jobKeyPrefix, rangeStart, rangeEnd, timestamp, limit, attributes)
+  local jobs = getJobs(setKey, rangeStart, rangeEnd, timestamp, limit)
+  local deleted = {}
+  local deletedCount = 0
+  local jobTS
+  for i, job in ipairs(jobs) do
+    if limit > 0 and deletedCount >= limit then
+      break
+    end
+    local jobKey = jobKeyPrefix .. job
+    -- * finishedOn says when the job was completed, but it isn't set unless the job has actually completed
+    jobTS = getTimestamp(jobKey, attributes)
+    if (not jobTS or jobTS < timestamp) then
+      removeJob(job, true, jobKeyPrefix)
+      deletedCount = deletedCount + 1
+      table.insert(deleted, job)
+    end
+  end
+  if(#deleted > 0) then
+    for from, to in batches(#deleted, 7000) do
+      rcall("ZREM", setKey, unpack(deleted, from, to))
+    end
+  end
+  return {deleted, deletedCount}
+end
+local result
+if ARGV[4] == "active" then
+  result = cleanList(KEYS[1], ARGV[1], rangeStart, rangeEnd, ARGV[2], false)
+elseif ARGV[4] == "delayed" then
+  result = cleanSet(KEYS[1], ARGV[1], rangeStart, rangeEnd, ARGV[2], limit, {"processedOn", "timestamp"})
+elseif ARGV[4] == "wait" or ARGV[4] == "paused" then
+  result = cleanList(KEYS[1], ARGV[1], rangeStart, rangeEnd, ARGV[2], true)
+else
+  result = cleanSet(KEYS[1], ARGV[1], rangeStart, rangeEnd, ARGV[2], limit, {"finishedOn"} )
+end
+rcall("XADD", KEYS[2], "*", "event", "cleaned", "count", result[2])
+return result[1]
+`;
+export const cleanJobsInSet = {
+    name: 'cleanJobsInSet',
+    content,
+    keys: 2,
+};
+//# sourceMappingURL=cleanJobsInSet-2.js.map

package/dist/esm/scripts/cleanJobsInSet-2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanJobsInSet-2.js","sourceRoot":"","sources":["../../../src/scripts/cleanJobsInSet-2.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8Pf,CAAC;AACF,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,IAAI,EAAE,gBAAgB;IACtB,OAAO;IACP,IAAI,EAAE,CAAC;CACR,CAAC"}

package/dist/esm/scripts/drain-4.d.ts

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