58f8093689
- Updated all component headers and documentation
- Changed navbar and footer branding
- Updated homepage hero badge
- Modified page title in index.html
- Simplified footer text to 'Built with ❤️'
- Consistent V2 capitalization across all references
262 lines
9.3 KiB
JavaScript
262 lines
9.3 KiB
JavaScript
const content = `--[[
|
|
Adds a parent job to the queue by doing the following:
|
|
- Increases the job counter if needed.
|
|
- Creates a new job key with the job data.
|
|
- adds the job to the waiting-children zset
|
|
Input:
|
|
KEYS[1] 'meta'
|
|
KEYS[2] 'id'
|
|
KEYS[3] 'completed'
|
|
KEYS[4] events stream key
|
|
ARGV[1] msgpacked arguments array
|
|
[1] key prefix,
|
|
[2] custom id (will not generate one automatically)
|
|
[3] name
|
|
[4] timestamp
|
|
[5] parentKey?
|
|
[6] waitChildrenKey key.
|
|
[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
|
|
]]
|
|
local metaKey = KEYS[1]
|
|
local idKey = KEYS[2]
|
|
local completedKey = KEYS[3]
|
|
local eventsKey = KEYS[4]
|
|
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
|
|
--[[
|
|
Function to store a job
|
|
]]
|
|
local function storeJob(eventsKey, jobIdKey, jobId, name, data, opts, timestamp,
|
|
parentKey, parentData, repeatJobKey)
|
|
local jsonOpts = cjson.encode(opts)
|
|
local delay = opts['delay'] or 0
|
|
local priority = opts['priority'] or 0
|
|
local optionalValues = {}
|
|
if parentKey ~= nil then
|
|
table.insert(optionalValues, "parentKey")
|
|
table.insert(optionalValues, parentKey)
|
|
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", name, "data", data, "opts", jsonOpts,
|
|
"timestamp", timestamp, "delay", delay, "priority", priority,
|
|
unpack(optionalValues))
|
|
rcall("XADD", eventsKey, "*", "event", "added", "jobId", jobId, "name", name)
|
|
return delay, priority
|
|
end
|
|
--[[
|
|
Validate and move or add dependencies to parent.
|
|
]]
|
|
-- Includes
|
|
--[[
|
|
Validate and move parent to active if needed.
|
|
]]
|
|
-- Includes
|
|
--[[
|
|
Add delay marker if needed.
|
|
]]
|
|
-- Includes
|
|
--[[
|
|
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
|
|
local function addDelayMarkerIfNeeded(targetKey, delayedKey)
|
|
local waitLen = rcall("LLEN", targetKey)
|
|
if waitLen <= 1 then
|
|
local nextTimestamp = getNextDelayedTimestamp(delayedKey)
|
|
if nextTimestamp ~= nil then
|
|
-- Check if there is already a marker with older timestamp
|
|
-- if there is, we need to replace it.
|
|
if waitLen == 1 then
|
|
local marker = rcall("LINDEX", targetKey, 0)
|
|
local oldTimestamp = tonumber(marker:sub(3))
|
|
if oldTimestamp and oldTimestamp > nextTimestamp then
|
|
rcall("LSET", targetKey, 0, "0:" .. nextTimestamp)
|
|
end
|
|
else
|
|
-- if there is no marker, then we need to add one
|
|
rcall("LPUSH", targetKey, "0:" .. nextTimestamp)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
--[[
|
|
Function to add job considering priority.
|
|
]]
|
|
-- Includes
|
|
--[[
|
|
Function priority marker to wait if needed
|
|
in order to wake up our workers and to respect priority
|
|
order as much as possible
|
|
]]
|
|
local function addPriorityMarkerIfNeeded(waitKey)
|
|
local waitLen = rcall("LLEN", waitKey)
|
|
if waitLen == 0 then
|
|
rcall("LPUSH", waitKey, "0:0")
|
|
end
|
|
end
|
|
--[[
|
|
Function to get priority score.
|
|
]]
|
|
local function getPriorityScore(priority, priorityCounterKey)
|
|
local prioCounter = rcall("INCR", priorityCounterKey)
|
|
return priority * 0x100000000 + prioCounter % 0x100000000
|
|
end
|
|
local function addJobWithPriority(waitKey, prioritizedKey, priority, paused, jobId, priorityCounterKey)
|
|
local score = getPriorityScore(priority, priorityCounterKey)
|
|
rcall("ZADD", prioritizedKey, score, jobId)
|
|
if not paused then
|
|
addPriorityMarkerIfNeeded(waitKey)
|
|
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, false
|
|
else
|
|
return pausedKey, true
|
|
end
|
|
end
|
|
local function moveParentToWaitIfNeeded(parentQueueKey, parentDependenciesKey, parentKey, parentId, timestamp)
|
|
local isParentActive = rcall("ZSCORE", parentQueueKey .. ":waiting-children", parentId)
|
|
if rcall("SCARD", parentDependenciesKey) == 0 and isParentActive then
|
|
rcall("ZREM", parentQueueKey .. ":waiting-children", parentId)
|
|
local parentWaitKey = parentQueueKey .. ":wait"
|
|
local parentTarget, paused = getTargetQueueList(parentQueueKey .. ":meta", parentWaitKey,
|
|
parentQueueKey .. ":paused")
|
|
local jobAttributes = rcall("HMGET", parentKey, "priority", "delay")
|
|
local priority = tonumber(jobAttributes[1]) or 0
|
|
local delay = tonumber(jobAttributes[2]) or 0
|
|
if delay > 0 then
|
|
local delayedTimestamp = tonumber(timestamp) + delay
|
|
local score = delayedTimestamp * 0x1000
|
|
local parentDelayedKey = parentQueueKey .. ":delayed"
|
|
rcall("ZADD", parentDelayedKey, score, parentId)
|
|
rcall("XADD", parentQueueKey .. ":events", "*", "event", "delayed", "jobId", parentId,
|
|
"delay", delayedTimestamp)
|
|
addDelayMarkerIfNeeded(parentTarget, parentDelayedKey)
|
|
else
|
|
if priority == 0 then
|
|
rcall("RPUSH", parentTarget, parentId)
|
|
else
|
|
addJobWithPriority(parentWaitKey, parentQueueKey .. ":prioritized", priority, paused,
|
|
parentId, parentQueueKey .. ":pc")
|
|
end
|
|
rcall("XADD", parentQueueKey .. ":events", "*", "event", "waiting", "jobId", parentId,
|
|
"prev", "waiting-children")
|
|
end
|
|
end
|
|
end
|
|
local function updateParentDepsIfNeeded(parentKey, parentQueueKey, parentDependenciesKey,
|
|
parentId, jobIdKey, returnvalue, timestamp )
|
|
local processedSet = parentKey .. ":processed"
|
|
rcall("HSET", processedSet, jobIdKey, returnvalue)
|
|
moveParentToWaitIfNeeded(parentQueueKey, parentDependenciesKey, parentKey, parentId, timestamp)
|
|
end
|
|
--[[
|
|
This function is used to update the parent's dependencies if the job
|
|
is already completed and about to be ignored. The parent must get its
|
|
dependencies updated to avoid the parent job being stuck forever in
|
|
the waiting-children state.
|
|
]]
|
|
local function updateExistingJobsParent(parentKey, parent, parentData,
|
|
parentDependenciesKey, completedKey,
|
|
jobIdKey, jobId, timestamp)
|
|
if parentKey ~= nil then
|
|
if rcall("ZSCORE", completedKey, jobId) ~= false then
|
|
local returnvalue = rcall("HGET", jobIdKey, "returnvalue")
|
|
updateParentDepsIfNeeded(parentKey, parent['queueKey'],
|
|
parentDependenciesKey, parent['id'],
|
|
jobIdKey, returnvalue, timestamp)
|
|
else
|
|
if parentDependenciesKey ~= nil then
|
|
rcall("SADD", parentDependenciesKey, jobIdKey)
|
|
end
|
|
end
|
|
rcall("HMSET", jobIdKey, "parentKey", parentKey, "parent", parentData)
|
|
end
|
|
end
|
|
local function getOrSetMaxEvents(metaKey)
|
|
local maxEvents = rcall("HGET", metaKey, "opts.maxLenEvents")
|
|
if not maxEvents then
|
|
maxEvents = 10000
|
|
rcall("HSET", metaKey, "opts.maxLenEvents", maxEvents)
|
|
end
|
|
return maxEvents
|
|
end
|
|
if parentKey ~= nil then
|
|
if rcall("EXISTS", parentKey) ~= 1 then return -5 end
|
|
parentData = cjson.encode(parent)
|
|
end
|
|
local jobCounter = rcall("INCR", idKey)
|
|
local maxEvents = getOrSetMaxEvents(metaKey)
|
|
local parentDependenciesKey = args[7]
|
|
local timestamp = args[4]
|
|
if args[2] == "" then
|
|
jobId = jobCounter
|
|
jobIdKey = args[1] .. jobId
|
|
else
|
|
jobId = args[2]
|
|
jobIdKey = args[1] .. jobId
|
|
if rcall("EXISTS", jobIdKey) == 1 then
|
|
updateExistingJobsParent(parentKey, parent, parentData,
|
|
parentDependenciesKey, completedKey, jobIdKey,
|
|
jobId, timestamp)
|
|
rcall("XADD", eventsKey, "MAXLEN", "~", maxEvents, "*", "event",
|
|
"duplicated", "jobId", jobId)
|
|
return jobId .. "" -- convert to string
|
|
end
|
|
end
|
|
-- Store the job.
|
|
storeJob(eventsKey, jobIdKey, jobId, args[3], ARGV[2], opts, timestamp,
|
|
parentKey, parentData, repeatJobKey)
|
|
local waitChildrenKey = args[6]
|
|
rcall("ZADD", waitChildrenKey, timestamp, jobId)
|
|
rcall("XADD", eventsKey, "MAXLEN", "~", maxEvents, "*", "event",
|
|
"waiting-children", "jobId", jobId)
|
|
-- 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 addParentJob = {
|
|
name: 'addParentJob',
|
|
content,
|
|
keys: 4,
|
|
};
|
|
//# sourceMappingURL=addParentJob-4.js.map
|