bullmq 1.57.3 → 1.59.1

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

@@ -0,0 +1,19 @@
+--[[
+  Release lock
+
+     Input:
+        KEYS[1] 'lock',
+      
+        ARGV[1]  token
+        ARGV[2]  lock duration in milliseconds
+      
+      Output:
+        "OK" if lock extented succesfully.
+]]
+local rcall = redis.call
+
+if rcall("GET", KEYS[1]) == ARGV[1] then
+  return rcall("DEL", KEYS[1])
+else
+  return 0
+end

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/script-loader.d.ts

@@ -0,0 +1,120 @@
+import { RedisClient } from '../interfaces';
+export interface Command {
+    name: string;
+    options: {
+        numberOfKeys: number;
+        lua: string;
+    };
+}
+/**
+ * Script metadata
+ */
+export interface ScriptMetadata {
+    /**
+     * Name of the script
+     */
+    name: string;
+    numberOfKeys?: number;
+    /**
+     * The path to the script. For includes, this is the normalized path,
+     * whereas it may not be normalized for the top-level parent
+     */
+    path: string;
+    /**
+     * The raw script content
+     */
+    content: string;
+    /**
+     * A hash of the normalized path for easy replacement in the parent
+     */
+    token: string;
+    /**
+     * Metadata on the scripts that this script includes
+     */
+    includes: ScriptMetadata[];
+}
+export declare class ScriptLoaderError extends Error {
+    readonly path: string;
+    /**
+     * The include stack
+     */
+    readonly includes: string[];
+    readonly line: number;
+    readonly position: number;
+    constructor(message: string, path: string, stack?: string[], line?: number, position?: number);
+}
+/**
+ * Lua script loader with include support
+ */
+export declare class ScriptLoader {
+    /**
+     * Map an alias to a path
+     */
+    private pathMapper;
+    private clientScripts;
+    /**
+     * Cache commands by dir
+     */
+    private commandCache;
+    private rootPath;
+    constructor();
+    /**
+     * Add a script path mapping. Allows includes of the form "<includes>/utils.lua" where `includes` is a user
+     * defined path
+     * @param name - the name of the mapping. Note: do not include angle brackets
+     * @param mappedPath - if a relative path is passed, it's relative to the *caller* of this function.
+     * Mapped paths are also accepted, e.g. "~/server/scripts/lua" or "<base>/includes"
+     */
+    addPathMapping(name: string, mappedPath: string): void;
+    /**
+     * Resolve the script path considering path mappings
+     * @param scriptName - the name of the script
+     * @param stack - the include stack, for nicer errors
+     */
+    resolvePath(scriptName: string, stack?: string[]): string;
+    /**
+     * Recursively collect all scripts included in a file
+     * @param file - the parent file
+     * @param cache - a cache for file metadata to increase efficiency. Since a file can be included
+     * multiple times, we make sure to load it only once.
+     * @param stack - internal stack to prevent circular references
+     */
+    private resolveDependencies;
+    /**
+     * Parse a (top-level) lua script
+     * @param filename - the full path to the script
+     * @param content - the content of the script
+     * @param cache - cache
+     */
+    parseScript(filename: string, content: string, cache?: Map<string, ScriptMetadata>): Promise<ScriptMetadata>;
+    /**
+     * Construct the final version of a file by interpolating its includes in dependency order.
+     * @param file - the file whose content we want to construct
+     * @param processed - a cache to keep track of which includes have already been processed
+     */
+    interpolate(file: ScriptMetadata, processed?: Set<string>): string;
+    loadCommand(filename: string, cache?: Map<string, ScriptMetadata>): Promise<Command>;
+    /**
+     * Load redis lua scripts.
+     * The name of the script must have the following format:
+     *
+     * cmdName-numKeys.lua
+     *
+     * cmdName must be in camel case format.
+     *
+     * For example:
+     * moveToFinish-3.lua
+     *
+     */
+    loadScripts(dir?: string, cache?: Map<string, ScriptMetadata>): Promise<Command[]>;
+    /**
+     * Attach all lua scripts in a given directory to a client instance
+     * @param client - redis client to attach script to
+     * @param pathname - the path to the directory containing the scripts
+     */
+    load(client: RedisClient, pathname: string): Promise<void>;
+    /**
+     * Clears the command cache
+     */
+    clearCache(): void;
+}