bullmq 2.2.0 → 2.3.0

package/dist/cjs/{commands/includes/removeParentDependencyKey.lua → scripts/drain-4.js}

@@ -1,22 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.drain = void 0;
+const content = `--[[
+  Drains the queue, removes all jobs that are waiting
+  or delayed, but not active, completed or failed
+  Input:
+    KEYS[1] 'wait',
+    KEYS[2] 'paused'
+    KEYS[3] 'delayed'
+    KEYS[4] 'priority'
+    ARGV[1]  queue key prefix
+]]
+local rcall = redis.call
+local queueBaseKey = ARGV[1]
+--[[
+  Functions to remove jobs.
+]]
+-- 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
+local function getListItems(keyName, max)
+  return rcall('LRANGE', keyName, 0, max - 1)
+end
+--[[
+  Function to get ZSet items.
+]]
+local function getZSetItems(keyName, max)
+  return rcall('ZRANGE', keyName, 0, max - 1)
+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"
 ]]
-
---- @include "destructureJobKey"
---- @include "getTargetQueueList"
-
+--[[
+  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"
@@ -28,9 +91,7 @@ local function removeParentDependencyKey(jobKey, hard, parentKey, baseKey)
       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
@@ -58,9 +119,7 @@ local function removeParentDependencyKey(jobKey, hard, parentKey, baseKey)
         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
@@ -79,3 +138,44 @@ local function removeParentDependencyKey(jobKey, hard, parentKey, baseKey)
     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 removeJobs(keys, hard, baseKey, max)
+  for i, key in ipairs(keys) do
+    removeJob(key, hard, baseKey)
+  end
+  return max - #keys
+end
+local function removeListJobs(keyName, hard, baseKey, max)
+  local jobs = getListItems(keyName, max)
+  local count = removeJobs(jobs, hard, baseKey, max)
+  rcall("LTRIM", keyName, #jobs, -1)
+  return count
+end
+local function removeZSetJobs(keyName, hard, baseKey, max)
+  local jobs = getZSetItems(keyName, max)
+  local count = removeJobs(jobs, hard, baseKey, max)
+  if(#jobs > 0) then
+    for from, to in batches(#jobs, 7000) do
+      rcall("ZREM", keyName, unpack(jobs))
+    end
+  end
+  return count
+end
+removeListJobs(KEYS[1], true, queueBaseKey, 0) --wait
+removeListJobs(KEYS[2], true, queueBaseKey, 0) --paused
+if KEYS[3] ~= "" then
+  removeZSetJobs(KEYS[3], true, queueBaseKey, 0) --delayed
+end
+rcall("DEL", KEYS[4])
+`;
+exports.drain = {
+    name: 'drain',
+    content,
+    keys: 4,
+};
+//# sourceMappingURL=drain-4.js.map

package/dist/cjs/scripts/drain-4.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"drain-4.js","sourceRoot":"","sources":["../../../src/scripts/drain-4.ts"],"names":[],"mappings":";;;AAAA,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2Kf,CAAC;AACW,QAAA,KAAK,GAAG;IACnB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,IAAI,EAAE,CAAC;CACR,CAAC"}

package/dist/cjs/scripts/extendLock-2.d.ts

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

package/dist/{esm/commands/extendLock-2.lua → cjs/scripts/extendLock-2.js}

@@ -1,14 +1,14 @@
---[[
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extendLock = void 0;
+const content = `--[[
   Extend lock and removes the job from the stalled set.
-
   Input:
     KEYS[1] 'lock',
     KEYS[2] 'stalled'
-
     ARGV[1]  token
     ARGV[2]  lock duration in milliseconds
     ARGV[3]  jobid
-
   Output:
     "1" if lock extented succesfully.
 ]]
@@ -21,3 +21,10 @@ if rcall("GET", KEYS[1]) == ARGV[1] then
   end
 end
 return 0
+`;
+exports.extendLock = {
+    name: 'extendLock',
+    content,
+    keys: 2,
+};
+//# sourceMappingURL=extendLock-2.js.map

package/dist/cjs/scripts/extendLock-2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extendLock-2.js","sourceRoot":"","sources":["../../../src/scripts/extendLock-2.ts"],"names":[],"mappings":";;;AAAA,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;CAoBf,CAAC;AACW,QAAA,UAAU,GAAG;IACxB,IAAI,EAAE,YAAY;IAClB,OAAO;IACP,IAAI,EAAE,CAAC;CACR,CAAC"}

package/dist/cjs/scripts/getState-7.d.ts

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

package/dist/{esm/commands/getState-7.lua → cjs/scripts/getState-7.js}

@@ -1,6 +1,8 @@
---[[
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getState = void 0;
+const content = `--[[
   Get a job state
-
   Input: 
     KEYS[1] 'completed' key,
     KEYS[2] 'failed' key
@@ -9,7 +11,6 @@
     KEYS[5] 'wait' key
     KEYS[6] 'paused' key
     KEYS[7] waitChildrenKey key
-
     ARGV[1] job id
   Output:
     'completed'
@@ -23,35 +24,44 @@
 if redis.call("ZSCORE", KEYS[1], ARGV[1]) ~= false then
   return "completed"
 end
-
 if redis.call("ZSCORE", KEYS[2], ARGV[1]) ~= false then
   return "failed"
 end
-
 if redis.call("ZSCORE", KEYS[3], ARGV[1]) ~= false then
   return "delayed"
 end
-
 -- Includes
---- @include "includes/checkItemInList"
-
+--[[
+  Functions to check if a item belongs to a list.
+]]
+local function checkItemInList(list, item)
+  for _, v in pairs(list) do
+    if v == item then
+      return 1
+    end
+  end
+  return nil
+end
 local active_items = redis.call("LRANGE", KEYS[4] , 0, -1)
 if checkItemInList(active_items, ARGV[1]) ~= nil then
   return "active"
 end
-
 local wait_items = redis.call("LRANGE", KEYS[5] , 0, -1)
 if checkItemInList(wait_items, ARGV[1]) ~= nil then
   return "waiting"
 end
-
 local paused_items = redis.call("LRANGE", KEYS[6] , 0, -1)
 if checkItemInList(paused_items, ARGV[1]) ~= nil then
   return "waiting"
 end
-
 if redis.call("ZSCORE", KEYS[7], ARGV[1]) ~= false then
   return "waiting-children"
 end
-
 return "unknown"
+`;
+exports.getState = {
+    name: 'getState',
+    content,
+    keys: 7,
+};
+//# sourceMappingURL=getState-7.js.map

package/dist/cjs/scripts/getState-7.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getState-7.js","sourceRoot":"","sources":["../../../src/scripts/getState-7.ts"],"names":[],"mappings":";;;AAAA,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyDf,CAAC;AACW,QAAA,QAAQ,GAAG;IACtB,IAAI,EAAE,UAAU;IAChB,OAAO;IACP,IAAI,EAAE,CAAC;CACR,CAAC"}

package/dist/cjs/scripts/getStateV2-7.d.ts

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

package/dist/cjs/{commands/getStateV2-7.lua → scripts/getStateV2-7.js}

@@ -1,6 +1,8 @@
---[[
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStateV2 = void 0;
+const content = `--[[
   Get a job state
-
   Input: 
     KEYS[1] 'completed' key,
     KEYS[2] 'failed' key
@@ -9,7 +11,6 @@
     KEYS[5] 'wait' key
     KEYS[6] 'paused' key
     KEYS[7] waitChildrenKey key
-
     ARGV[1] job id
   Output:
     'completed'
@@ -23,29 +24,29 @@
 if redis.call("ZSCORE", KEYS[1], ARGV[1]) ~= false then
   return "completed"
 end
-
 if redis.call("ZSCORE", KEYS[2], ARGV[1]) ~= false then
   return "failed"
 end
-
 if redis.call("ZSCORE", KEYS[3], ARGV[1]) ~= false then
   return "delayed"
 end
-
 if redis.call("LPOS", KEYS[4] , ARGV[1]) ~= false then
   return "active"
 end
-
 if redis.call("LPOS", KEYS[5] , ARGV[1]) ~= false then
   return "waiting"
 end
-
 if redis.call("LPOS", KEYS[6] , ARGV[1]) ~= false then
   return "waiting"
 end
-
 if redis.call("ZSCORE", KEYS[7] , ARGV[1]) ~= false then
   return "waiting-children"
 end
-
 return "unknown"
+`;
+exports.getStateV2 = {
+    name: 'getStateV2',
+    content,
+    keys: 7,
+};
+//# sourceMappingURL=getStateV2-7.js.map

package/dist/cjs/scripts/getStateV2-7.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getStateV2-7.js","sourceRoot":"","sources":["../../../src/scripts/getStateV2-7.ts"],"names":[],"mappings":";;;AAAA,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0Cf,CAAC;AACW,QAAA,UAAU,GAAG;IACxB,IAAI,EAAE,YAAY;IAClB,OAAO;IACP,IAAI,EAAE,CAAC;CACR,CAAC"}

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

@@ -0,0 +1,26 @@
+export * from './addJob-8';
+export * from './changeDelay-4';
+export * from './cleanJobsInSet-2';
+export * from './drain-4';
+export * from './extendLock-2';
+export * from './getState-7';
+export * from './getStateV2-7';
+export * from './isFinished-3';
+export * from './isJobInList-1';
+export * from './moveStalledJobsToWait-8';
+export * from './moveToActive-9';
+export * from './moveToDelayed-5';
+export * from './moveToFinished-12';
+export * from './moveToWaitingChildren-4';
+export * from './obliterate-2';
+export * from './pause-4';
+export * from './promote-6';
+export * from './releaseLock-1';
+export * from './removeJob-1';
+export * from './removeRepeatable-2';
+export * from './reprocessJob-4';
+export * from './retryJob-6';
+export * from './retryJobs-6';
+export * from './takeLock-1';
+export * from './updateData-1';
+export * from './updateProgress-2';

package/dist/cjs/scripts/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./addJob-8"), exports);
+tslib_1.__exportStar(require("./changeDelay-4"), exports);
+tslib_1.__exportStar(require("./cleanJobsInSet-2"), exports);
+tslib_1.__exportStar(require("./drain-4"), exports);
+tslib_1.__exportStar(require("./extendLock-2"), exports);
+tslib_1.__exportStar(require("./getState-7"), exports);
+tslib_1.__exportStar(require("./getStateV2-7"), exports);
+tslib_1.__exportStar(require("./isFinished-3"), exports);
+tslib_1.__exportStar(require("./isJobInList-1"), exports);
+tslib_1.__exportStar(require("./moveStalledJobsToWait-8"), exports);
+tslib_1.__exportStar(require("./moveToActive-9"), exports);
+tslib_1.__exportStar(require("./moveToDelayed-5"), exports);
+tslib_1.__exportStar(require("./moveToFinished-12"), exports);
+tslib_1.__exportStar(require("./moveToWaitingChildren-4"), exports);
+tslib_1.__exportStar(require("./obliterate-2"), exports);
+tslib_1.__exportStar(require("./pause-4"), exports);
+tslib_1.__exportStar(require("./promote-6"), exports);
+tslib_1.__exportStar(require("./releaseLock-1"), exports);
+tslib_1.__exportStar(require("./removeJob-1"), exports);
+tslib_1.__exportStar(require("./removeRepeatable-2"), exports);
+tslib_1.__exportStar(require("./reprocessJob-4"), exports);
+tslib_1.__exportStar(require("./retryJob-6"), exports);
+tslib_1.__exportStar(require("./retryJobs-6"), exports);
+tslib_1.__exportStar(require("./takeLock-1"), exports);
+tslib_1.__exportStar(require("./updateData-1"), exports);
+tslib_1.__exportStar(require("./updateProgress-2"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/scripts/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,0DAAgC;AAChC,6DAAmC;AACnC,oDAA0B;AAC1B,yDAA+B;AAC/B,uDAA6B;AAC7B,yDAA+B;AAC/B,yDAA+B;AAC/B,0DAAgC;AAChC,oEAA0C;AAC1C,2DAAiC;AACjC,4DAAkC;AAClC,8DAAoC;AACpC,oEAA0C;AAC1C,yDAA+B;AAC/B,oDAA0B;AAC1B,sDAA4B;AAC5B,0DAAgC;AAChC,wDAA8B;AAC9B,+DAAqC;AACrC,2DAAiC;AACjC,uDAA6B;AAC7B,wDAA8B;AAC9B,uDAA6B;AAC7B,yDAA+B;AAC/B,6DAAmC"}

package/dist/cjs/scripts/isFinished-3.d.ts

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

package/dist/cjs/{commands/isFinished-3.lua → scripts/isFinished-3.js}

@@ -1,11 +1,12 @@
---[[
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFinished = void 0;
+const content = `--[[
   Checks if a job is finished (.i.e. is in the completed or failed set)
-
   Input: 
     KEYS[1] completed key
     KEYS[2] failed key
     KEYS[3] job key
-
     ARGV[1] job id
     ARGV[2] return value?
   Output:
@@ -17,32 +18,32 @@
 local rcall = redis.call
 if rcall("EXISTS", KEYS[3]) ~= 1 then
   if ARGV[2] == "1" then
-
     return {-5,"Missing key for job " .. KEYS[3] .. ". isFinished"}
   end  
   return -5
 end
-
 if rcall("ZSCORE", KEYS[1], ARGV[1]) ~= false then
   if ARGV[2] == "1" then
     local returnValue = rcall("HGET", KEYS[3], "returnvalue")
-
     return {1,returnValue}
   end
   return 1
 end
-
 if rcall("ZSCORE", KEYS[2], ARGV[1]) ~= false then
   if ARGV[2] == "1" then
     local failedReason = rcall("HGET", KEYS[3], "failedReason")
-
     return {2,failedReason}
   end
   return 2
 end
-
 if ARGV[2] == "1" then
   return {0}
 end
-
 return 0
+`;
+exports.isFinished = {
+    name: 'isFinished',
+    content,
+    keys: 3,
+};
+//# sourceMappingURL=isFinished-3.js.map

package/dist/cjs/scripts/isFinished-3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isFinished-3.js","sourceRoot":"","sources":["../../../src/scripts/isFinished-3.ts"],"names":[],"mappings":";;;AAAA,MAAM,OAAO,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuCf,CAAC;AACW,QAAA,UAAU,GAAG;IACxB,IAAI,EAAE,YAAY;IAClB,OAAO;IACP,IAAI,EAAE,CAAC;CACR,CAAC"}

package/dist/cjs/scripts/isJobInList-1.d.ts

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

package/dist/cjs/scripts/isJobInList-1.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isJobInList = void 0;
+const content = `--[[
+  Checks if job is in a given list.
+  Input:
+    KEYS[1]
+    ARGV[1]
+  Output:
+    1 if element found in the list.
+]]
+-- Includes
+--[[
+  Functions to check if a item belongs to a list.
+]]
+local function checkItemInList(list, item)
+  for _, v in pairs(list) do
+    if v == item then
+      return 1
+    end
+  end
+  return nil
+end
+local items = redis.call("LRANGE", KEYS[1] , 0, -1)
+return checkItemInList(items, ARGV[1])
+`;
+exports.isJobInList = {
+    name: 'isJobInList',
+    content,
+    keys: 1,
+};
+//# sourceMappingURL=isJobInList-1.js.map

package/dist/cjs/scripts/isJobInList-1.js.map

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

package/dist/cjs/scripts/moveStalledJobsToWait-8.d.ts

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