bullmq 1.59.0 → 1.59.4

package/dist/esm/commands/removeJob-1.lua

@@ -0,0 +1,115 @@
+--[[
+    Remove a job from all the queues 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] jobId
+      ARGV[1]  jobId
+
+     Events:
+      'removed'
+]]
+
+local rcall = redis.call
+
+-- Includes
+--- @include "includes/destructureJobKey"
+
+-- recursively check if there are no locks on the
+-- jobs to be removed.
+local function isLocked( prefix, jobId)
+    local jobKey = prefix .. jobId;
+
+    -- Check if this job is locked
+    local lockKey = jobKey .. ':lock'
+    local lock = rcall("GET", lockKey)
+    if not lock then
+        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)
+                local result = isLocked( childJobPrefix, childJobId )
+                if result then
+                    return true
+                end
+            end
+        end
+        return false
+    end
+    return true
+end
+
+local function removeJob( prefix, jobId)
+    local jobKey = prefix .. jobId;
+
+    -- 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"
+    local parentKey = rcall("HGET", jobKey, "parentKey")
+    if( (type(parentKey) == "string") and parentKey ~= "" and (rcall("EXISTS", parentKey) == 1)) then
+        local parentDependenciesKey = parentKey .. ":dependencies"
+        local result = rcall("SREM", parentDependenciesKey, jobKey)
+        if rcall("SCARD", parentDependenciesKey) == 0 then
+            local parentId = getJobIdFromKey(parentKey)
+            local parentPrefix = getJobKeyPrefix(parentKey, parentId)
+
+            rcall("ZREM", parentPrefix .. "waiting-children", parentId)
+
+            if rcall("HEXISTS", parentPrefix .. "meta", "paused") ~= 1 then
+                rcall("RPUSH", parentPrefix .. "wait", parentId)
+            else
+                rcall("RPUSH", parentPrefix .. "parentPrefixpaused", parentId)
+            end
+
+            local parentEventStream = parentPrefix .. "events"
+            rcall("XADD", parentEventStream, "*", "event", "active", "jobId", parentId, "prev", "waiting-children")
+        end
+    end
+
+    rcall("LREM", prefix .. "active", 0, jobId)
+    rcall("LREM", prefix .. "wait", 0, jobId)
+    rcall("ZREM", prefix .. "delayed", jobId)
+    rcall("LREM", prefix .. "paused", 0, jobId)
+    rcall("ZREM", prefix .. "completed", jobId)
+    rcall("ZREM", prefix .. "failed", jobId)
+    rcall("ZREM", prefix .. "priority", jobId)
+    rcall("ZREM", prefix .. "waiting-children", jobId)
+    rcall("DEL", jobKey)
+    rcall("DEL", jobKey .. ":logs")
+    rcall("DEL", jobKey .. ":processed")
+
+    -- 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 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 )
+        end
+    end
+
+    rcall("DEL", jobKey .. ":dependencies")
+
+    -- -- delete keys related to rate limiter
+        -- local limiterIndexTable = KEYS[10] .. ":index"
+        -- local limitedSetKey = rcall("HGET", limiterIndexTable, jobId)
+        -- if limitedSetKey then
+        --     rcall("SREM", limitedSetKey, jobId)
+        --     rcall("HDEL", limiterIndexTable, jobId)
+    -- end
+
+    rcall("XADD", prefix .. "events", "*", "event", "removed", "jobId", jobId, "prev", "unknown");
+end
+
+local prefix = getJobKeyPrefix(KEYS[1], ARGV[1])
+
+if not isLocked(prefix, ARGV[1]) then
+    removeJob(prefix, ARGV[1])
+    return 1
+end
+return 0

package/dist/esm/commands/removeRepeatable-2.lua

@@ -0,0 +1,23 @@
+
+--[[
+  Removes a repeatable job
+  Input:
+    KEYS[1] repeat jobs key
+    KEYS[2] delayed jobs key
+
+    ARGV[1] repeat job id
+    ARGV[2] repeat job key
+    ARGV[3] queue key
+]]
+local rcall = redis.call
+local millis = rcall("ZSCORE", KEYS[1], ARGV[2])
+
+if(millis) then
+  -- Delete next programmed job.
+  local repeatJobId = ARGV[1] .. millis
+  if(rcall("ZREM", KEYS[2], repeatJobId) == 1) then
+    rcall("DEL", ARGV[3] .. repeatJobId)
+  end
+end
+
+rcall("ZREM", KEYS[1], ARGV[2]);

package/dist/esm/commands/reprocessJob-4.lua

@@ -0,0 +1,32 @@
+--[[
+  Attempts to reprocess a job
+
+  Input:
+    KEYS[1] job key
+    KEYS[2] events stream
+    KEYS[3] job state
+    KEYS[4] wait key
+
+    ARGV[1] job.id,
+    ARGV[2] (job.opts.lifo ? 'R' : 'L') + 'PUSH'
+
+  Output:
+    1  means the operation was a success
+    -1 means the job does not exist
+    -3 means the job was not found in the expected set.
+]]
+local rcall = redis.call;
+if (rcall("EXISTS", KEYS[1]) == 1) then
+  local jobId = ARGV[1]
+  if (rcall("ZREM", KEYS[3], jobId) == 1) then
+    rcall(ARGV[2], KEYS[4], jobId)
+
+    -- Emit waiting event
+    rcall("XADD", KEYS[2], "*", "event", "waiting", "jobId", jobId);
+    return 1
+  else
+    return -3
+  end
+else
+  return -1
+end

package/dist/esm/commands/retryJob-4.lua

@@ -0,0 +1,34 @@
+--[[
+  Retries a failed job by moving it back to the wait queue.
+
+    Input:
+      KEYS[1] 'active',
+      KEYS[2] 'wait'
+      KEYS[3] jobId
+      KEYS[4] events stream
+
+      ARGV[1]  pushCmd
+      ARGV[2]  jobId
+      ARGV[3]  token
+
+    Events:
+      'prefix:added'
+
+    Output:
+     0  - OK
+     -1 - Missing key
+]]
+local rcall = redis.call
+
+if rcall("EXISTS", KEYS[3]) == 1 then
+
+  rcall("LREM", KEYS[1], 0, ARGV[2])
+  rcall(ARGV[1], KEYS[2], ARGV[2])
+
+  -- Emit waiting event
+  rcall("XADD", KEYS[4], "*", "event", "waiting", "jobId", ARGV[2], "prev", "failed");
+  
+  return 0
+else
+  return -1
+end

package/dist/esm/commands/takeLock-1.lua

@@ -0,0 +1,17 @@
+--[[
+  Takes a lock
+
+     Input:
+        KEYS[1] 'lock',
+      
+        ARGV[1]  token
+        ARGV[2]  lock duration in milliseconds
+      
+      Output:
+        "OK" if lock extented succesfully.
+]]
+if redis.call("SET", KEYS[1], ARGV[1], "NX", "PX", ARGV[2]) then
+  return 1
+else
+  return 0
+end

package/dist/esm/commands/updateDelaySet-7.lua

@@ -0,0 +1,73 @@
+--[[
+  Updates the delay set, by picking a delayed job that should
+  be processed now.
+
+     Input:
+      KEYS[1] 'delayed'
+      KEYS[2] 'wait'
+      KEYS[3] 'priority'
+      KEYS[4] 'paused'
+      KEYS[5] 'meta'
+
+      KEYS[6] event's stream
+      KEYS[7] delayed stream
+
+      ARGV[1] queue.toKey('')
+      ARGV[2] delayed timestamp
+
+     Events:
+      'waiting'
+]]
+local rcall = redis.call
+
+-- Try to get as much as 1000 jobs at once
+local jobs = rcall("ZRANGEBYSCORE", KEYS[1], 0, tonumber(ARGV[2]) * 0x1000,
+                   "LIMIT", 0, 1000)
+
+if (#jobs > 0) then
+    rcall("ZREM", KEYS[1], unpack(jobs))
+
+    -- check if we need to use push in paused instead of waiting
+    local target
+    if rcall("HEXISTS", KEYS[5], "paused") ~= 1 then
+        target = KEYS[2]
+    else
+        target = KEYS[4]
+    end
+
+    for _, jobId in ipairs(jobs) do
+        local priority =
+            tonumber(rcall("HGET", ARGV[1] .. jobId, "priority")) or 0
+
+        if priority == 0 then
+            -- LIFO or FIFO
+            rcall("LPUSH", target, jobId)
+        else
+            -- Priority add
+            rcall("ZADD", KEYS[3], priority, jobId)
+            local count = rcall("ZCOUNT", KEYS[3], 0, priority)
+
+            local len = rcall("LLEN", target)
+            local id = rcall("LINDEX", target, len - (count - 1))
+            if id then
+                rcall("LINSERT", target, "BEFORE", id, jobId)
+            else
+                rcall("RPUSH", target, jobId)
+            end
+        end
+
+        -- Emit waiting event
+        rcall("XADD", KEYS[6], "*", "event", "waiting", "jobId", jobId, "prev",
+              "delayed")
+        rcall("HSET", ARGV[1] .. jobId, "delay", 0)
+    end
+end
+
+local nextTimestamp = rcall("ZRANGE", KEYS[1], 0, 0, "WITHSCORES")[2]
+local id
+if (nextTimestamp ~= nil) then
+    nextTimestamp = nextTimestamp / 0x1000
+    id = rcall("XADD", KEYS[7], "*", "nextTimestamp", nextTimestamp)
+end
+
+return {nextTimestamp, id}

package/dist/esm/commands/updateProgress-2.lua

@@ -0,0 +1,15 @@
+--[[
+  Update job progress
+
+     Input:
+        KEYS[1] Job id key
+        KEYS[2] event stream key
+      
+        ARGV[1] id
+        ARGV[2] progress
+        
+      Event:
+        progress(jobId, progress)
+]]
+redis.call("HSET", KEYS[1], "progress", ARGV[2])
+redis.call("XADD", KEYS[2], "*", "event", "progress", "jobId", ARGV[1], "data", ARGV[2]);

package/dist/esm/interfaces/advanced-options.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=advanced-options.js.map

package/dist/esm/interfaces/backoff-options.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=backoff-options.js.map

package/dist/esm/interfaces/child-message.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=child-message.js.map

package/dist/esm/interfaces/connection.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=connection.js.map

package/dist/esm/interfaces/flow-job.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=flow-job.js.map

package/dist/esm/interfaces/jobs-options.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=jobs-options.js.map

package/dist/esm/interfaces/parent-message.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=parent-message.js.map

package/dist/esm/interfaces/parent.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=parent.js.map

package/dist/esm/interfaces/queue-scheduler-options.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=queue-scheduler-options.js.map

package/dist/esm/interfaces/rate-limiter-options.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=rate-limiter-options.js.map

package/dist/esm/interfaces/redis-options.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=redis-options.js.map

package/dist/esm/interfaces/redis-streams.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=redis-streams.js.map

package/dist/esm/interfaces/repeat-options.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=repeat-options.js.map

package/dist/esm/interfaces/sandboxed-job-processor.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=sandboxed-job-processor.js.map

package/dist/esm/interfaces/sandboxed-job.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=sandboxed-job.js.map

package/dist/esm/interfaces/worker-options.js

@@ -1,2 +1 @@
-export {};
 //# sourceMappingURL=worker-options.js.map

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "bullmq",
-  "version": "1.59.0",
+  "version": "1.59.4",
   "description": "Queue for messages and jobs based on Redis",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
+  "jsnext:main": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
   "source": "src/index.ts",
   "author": "Taskforce.sh Inc.",
@@ -20,9 +21,9 @@
   ],
   "scripts": {
     "build": "npm-run-all tsc:all copy:lua copy:includes:lua clean:temp:files",
-    "clean:temp:files": "rimraf dist/bullmq.d.ts dist/tsdoc-metadata.json",
-    "copy:lua": "copyfiles -f ./src/commands/*.lua ./dist/commands",
-    "copy:includes:lua": "copyfiles -f ./src/commands/includes/*.lua ./dist/commands/includes",
+    "clean:temp:files": "rimraf dist/cjs/bullmq.d.ts dist/esm/bullmq.d.ts dist/tsdoc-metadata.json",
+    "copy:lua": "copyfiles -f ./src/commands/*.lua ./dist/cjs/commands && copyfiles -f ./src/commands/*.lua ./dist/esm/commands",
+    "copy:includes:lua": "copyfiles -f ./src/commands/includes/*.lua ./dist/cjs/commands/includes && copyfiles -f ./src/commands/includes/*.lua ./dist/esm/commands/includes",
     "coverage": "nyc --reporter=text npm run test",
     "coveralls": "nyc report --reporter=text-lcov | coveralls",
     "cm": "git cz",
@@ -106,7 +107,7 @@
     "test-console": "^2.0.0",
     "ts-mocha": "^8.0.0",
     "ts-node": "^8.10.2",
-    "typescript": "^4.5.2"
+    "typescript": "3.9.10"
   },
   "nyc": {
     "extends": "@istanbuljs/nyc-config-typescript",