agenda
Version:
Light weight job scheduler for Node.js
308 lines • 16 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.processJobs = void 0;
const debug_1 = __importDefault(require("debug"));
const create_job_1 = require("./create-job");
const debug = debug_1.default("agenda:internal:processJobs");
/**
* Process methods for jobs
* @param {Job} extraJob job to run immediately
*/
const processJobs = function (extraJob) {
var _a, _b, _c, _d;
return __awaiter(this, void 0, void 0, function* () {
debug("starting to process jobs: [%s:%s]", (_b = (_a = extraJob === null || extraJob === void 0 ? void 0 : extraJob.attrs) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : "unknownName", (_d = (_c = extraJob === null || extraJob === void 0 ? void 0 : extraJob.attrs) === null || _c === void 0 ? void 0 : _c._id) !== null && _d !== void 0 ? _d : "unknownId");
// Make sure an interval has actually been set
// Prevents race condition with 'Agenda.stop' and already scheduled run
if (!this._processInterval) {
debug("no _processInterval set when calling processJobs, returning");
return;
}
const self = this; // eslint-disable-line @typescript-eslint/no-this-alias
const definitions = this._definitions;
const jobQueue = this._jobQueue;
let jobName;
// Determine whether or not we have a direct process call!
if (!extraJob) {
// Go through each jobName set in 'Agenda.process' and fill the queue with the next jobs
const parallelJobQueueing = [];
for (jobName in definitions) {
if ({}.hasOwnProperty.call(definitions, jobName)) {
debug("queuing up job to process: [%s]", jobName);
parallelJobQueueing.push(jobQueueFilling(jobName));
}
}
yield Promise.all(parallelJobQueueing);
}
else if (definitions[extraJob.attrs.name]) {
// Add the job to list of jobs to lock and then lock it immediately!
debug("job [%s:%s] was passed directly to processJobs(), locking and running immediately", extraJob.attrs.name, extraJob.attrs._id);
self._jobsToLock.push(extraJob);
yield lockOnTheFly();
}
/**
* Returns true if a job of the specified name can be locked.
* Considers maximum locked jobs at any time if self._lockLimit is > 0
* Considers maximum locked jobs of the specified name at any time if jobDefinition.lockLimit is > 0
* @param name name of job to check if we should lock or not
* @returns whether or not you should lock job
*/
function shouldLock(name) {
const jobDefinition = definitions[name];
let shouldLock = true;
if (self._lockLimit && self._lockLimit <= self._lockedJobs.length) {
shouldLock = false;
}
if (jobDefinition.lockLimit &&
jobDefinition.lockLimit <= jobDefinition.locked) {
shouldLock = false;
}
debug("job [%s] lock status: shouldLock = %s", name, shouldLock);
return shouldLock;
}
/**
* Internal method that adds jobs to be processed to the local queue
* @param jobs Jobs to queue
*/
function enqueueJobs(jobs) {
if (!Array.isArray(jobs)) {
jobs = [jobs];
}
jobs.forEach((job) => {
jobQueue.insert(job);
});
}
/**
* Internal method that will lock a job and store it on MongoDB
* This method is called when we immediately start to process a job without using the process interval
* We do this because sometimes jobs are scheduled but will be run before the next process time
*/
function lockOnTheFly() {
return __awaiter(this, void 0, void 0, function* () {
debug("lockOnTheFly: isLockingOnTheFly: %s", self._isLockingOnTheFly);
// Already running this? Return
if (self._isLockingOnTheFly) {
debug("lockOnTheFly() already running, returning");
return;
}
// Set that we are running this
self._isLockingOnTheFly = true;
// Don't have any jobs to run? Return
if (self._jobsToLock.length === 0) {
debug("no jobs to current lock on the fly, returning");
self._isLockingOnTheFly = false;
return;
}
// Grab a job that needs to be locked
const now = new Date();
const job = self._jobsToLock.pop();
if (job === undefined) {
debug("no job was popped from _jobsToLock, extremly unlikely but not impossible concurrency issue");
self._isLockingOnTheFly = false;
return;
}
if (self._isJobQueueFilling.has(job.attrs.name)) {
debug("lockOnTheFly: jobQueueFilling already running for: %s", job.attrs.name);
self._isLockingOnTheFly = false;
return;
}
// If locking limits have been hit, stop locking on the fly.
// Jobs that were waiting to be locked will be picked up during a
// future locking interval.
if (!shouldLock(job.attrs.name)) {
debug("lock limit hit for: [%s:%s]", job.attrs.name, job.attrs._id);
self._jobsToLock = [];
self._isLockingOnTheFly = false;
return;
}
// Query to run against collection to see if we need to lock it
const criteria = {
_id: job.attrs._id,
lockedAt: null,
nextRunAt: job.attrs.nextRunAt,
disabled: { $ne: true },
};
// Update / options for the MongoDB query
const update = { $set: { lockedAt: now } };
// Lock the job in MongoDB!
const resp = yield self._collection.findOneAndUpdate(criteria, update, {
returnDocument: "after",
});
if (resp.value) {
// @ts-ignore
const job = create_job_1.createJob(self, resp.value);
debug("found job [%s:%s] that can be locked on the fly", job.attrs.name, job.attrs._id);
self._lockedJobs.push(job);
definitions[job.attrs.name].locked++;
enqueueJobs(job);
jobProcessing();
}
// Mark lock on fly is done for now
self._isLockingOnTheFly = false;
// Re-run in case anything is in the queue
yield lockOnTheFly();
});
}
/**
* Internal method used to fill a queue with jobs that can be run
* @param {String} name fill a queue with specific job name
* @returns {undefined}
*/
function jobQueueFilling(name) {
return __awaiter(this, void 0, void 0, function* () {
debug("jobQueueFilling: %s isJobQueueFilling: %s", name, self._isJobQueueFilling.has(name));
self._isJobQueueFilling.set(name, true);
try {
// Don't lock because of a limit we have set (lockLimit, etc)
if (!shouldLock(name)) {
debug("lock limit reached in queue filling for [%s]", name);
return; // Goes to finally block
}
// Set the date of the next time we are going to run _processEvery function
const now = new Date();
self._nextScanAt = new Date(now.valueOf() + self._processEvery);
// For this job name, find the next job to run and lock it!
const job = yield self._findAndLockNextJob(name, definitions[name]);
// Still have the job?
// 1. Add it to lock list
// 2. Add count of locked jobs
// 3. Queue the job to actually be run now that it is locked
// 4. Recursively run this same method we are in to check for more available jobs of same type!
if (job) {
// Before en-queing job make sure we haven't exceed our lock limits
if (!shouldLock(name)) {
debug("lock limit reached before job was returned. Releasing lock on [%s]", name);
job.attrs.lockedAt = null;
yield self.saveJob(job);
return;
}
debug("[%s:%s] job locked while filling queue", name, job.attrs._id);
self._lockedJobs.push(job);
definitions[job.attrs.name].locked++;
enqueueJobs(job);
yield jobQueueFilling(name);
jobProcessing();
}
}
catch (error) {
debug("[%s] job lock failed while filling queue", name, error);
}
finally {
self._isJobQueueFilling.delete(name);
}
});
}
/**
* Internal method that processes any jobs in the local queue (array)
* @returns {undefined}
*/
function jobProcessing() {
// Ensure we have jobs
if (jobQueue.length === 0) {
return;
}
// Store for all sorts of things
const now = new Date();
// Get the next job that is not blocked by concurrency
const job = jobQueue.returnNextConcurrencyFreeJob(definitions);
debug("[%s:%s] about to process job", job.attrs.name, job.attrs._id);
// If the 'nextRunAt' time is older than the current time, run the job
// Otherwise, setTimeout that gets called at the time of 'nextRunAt'
if (!job.attrs.nextRunAt || job.attrs.nextRunAt <= now) {
debug("[%s:%s] nextRunAt is in the past, run the job immediately", job.attrs.name, job.attrs._id);
runOrRetry();
}
else {
// @ts-expect-error linter complains about Date-arithmetic
const runIn = job.attrs.nextRunAt - now;
debug("[%s:%s] nextRunAt is in the future, calling setTimeout(%d)", job.attrs.name, job.attrs._id, runIn);
setTimeout(jobProcessing, runIn);
}
/**
* Internal method that tries to run a job and if it fails, retries again!
* @returns {undefined}
*/
function runOrRetry() {
if (self._processInterval) {
// @todo: We should check if job exists
const job = jobQueue.pop();
const jobDefinition = definitions[job.attrs.name];
if (jobDefinition.concurrency > jobDefinition.running &&
self._runningJobs.length < self._maxConcurrency) {
// Get the deadline of when the job is not supposed to go past for locking
const lockDeadline = new Date(Date.now() - jobDefinition.lockLifetime);
// This means a job has "expired", as in it has not been "touched" within the lockoutTime
// Remove from local lock
// NOTE: Shouldn't we update the 'lockedAt' value in MongoDB so it can be picked up on restart?
if (!job.attrs.lockedAt || job.attrs.lockedAt < lockDeadline) {
debug("[%s:%s] job lock has expired, freeing it up", job.attrs.name, job.attrs._id);
self._lockedJobs.splice(self._lockedJobs.indexOf(job), 1);
jobDefinition.locked--;
// If you have few thousand jobs for one worker it would throw "RangeError: Maximum call stack size exceeded"
// every 5 minutes (using the default options).
// We need to utilise the setImmedaite() to break the call stack back to 0.
setImmediate(jobProcessing);
return;
}
// Add to local "running" queue
self._runningJobs.push(job);
jobDefinition.running++;
// CALL THE ACTUAL METHOD TO PROCESS THE JOB!!!
debug("[%s:%s] processing job", job.attrs.name, job.attrs._id);
job
.run()
// eslint-disable-next-line @typescript-eslint/no-explicit-any
.then((job) => processJobResult(job))
.catch((error) => {
return job.agenda.emit("error", error);
});
}
else {
// Run the job immediately by putting it on the top of the queue
debug("[%s:%s] concurrency preventing immediate run, pushing job to top of queue", job.attrs.name, job.attrs._id);
enqueueJobs(job);
}
}
}
}
/**
* Internal method used to run the job definition
* @param {Error} err thrown if can't process job
* @param {Job} job job to process
*/
function processJobResult(job) {
const { name } = job.attrs;
// Job isn't in running jobs so throw an error
if (!self._runningJobs.includes(job)) {
debug("[%s] callback was called, job must have been marked as complete already", job.attrs._id);
throw new Error(`callback already called - job ${name} already marked complete`);
}
// Remove the job from the running queue
self._runningJobs.splice(self._runningJobs.indexOf(job), 1);
if (definitions[name].running > 0) {
definitions[name].running--;
}
// Remove the job from the locked queue
self._lockedJobs.splice(self._lockedJobs.indexOf(job), 1);
if (definitions[name].locked > 0) {
definitions[name].locked--;
}
// Re-process jobs now that one has finished
jobProcessing();
}
});
};
exports.processJobs = processJobs;
//# sourceMappingURL=process-jobs.js.map