mirror of
https://github.com/n8n-io/n8n.git
synced 2024-09-29 19:27:35 -07:00
027dfb2f0a
* ⚡ Enable `esModuleInterop` for /core * ⚡ Adjust imports in /core * ⚡ Enable `esModuleInterop` for /cli * ⚡ Adjust imports in /cli * ⚡ Enable `esModuleInterop` for /nodes-base * ⚡ Adjust imports in /nodes-base * ⚡ Make imports consistent * ⬆️ Upgrade TypeScript to 4.6 (#3109) * ⬆️ Upgrade TypeScript to 4.6 * 📦 Update package-lock.json * 🔧 Avoid erroring on untyped errors * 📘 Fix type error Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
86 lines
2.5 KiB
TypeScript
86 lines
2.5 KiB
TypeScript
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
|
|
import Bull from 'bull';
|
|
import config from '../config';
|
|
// eslint-disable-next-line import/no-cycle
|
|
import { IBullJobData, IBullWebhookResponse } from './Interfaces';
|
|
// eslint-disable-next-line import/no-cycle
|
|
import * as ActiveExecutions from './ActiveExecutions';
|
|
// eslint-disable-next-line import/no-cycle
|
|
import * as WebhookHelpers from './WebhookHelpers';
|
|
|
|
export class Queue {
|
|
private activeExecutions: ActiveExecutions.ActiveExecutions;
|
|
|
|
private jobQueue: Bull.Queue;
|
|
|
|
constructor() {
|
|
this.activeExecutions = ActiveExecutions.getInstance();
|
|
|
|
const prefix = config.getEnv('queue.bull.prefix');
|
|
const redisOptions = config.getEnv('queue.bull.redis');
|
|
// Disabling ready check is necessary as it allows worker to
|
|
// quickly reconnect to Redis if Redis crashes or is unreachable
|
|
// for some time. With it enabled, worker might take minutes to realize
|
|
// redis is back up and resume working.
|
|
// More here: https://github.com/OptimalBits/bull/issues/890
|
|
// @ts-ignore
|
|
this.jobQueue = new Bull('jobs', { prefix, redis: redisOptions, enableReadyCheck: false });
|
|
|
|
this.jobQueue.on('global:progress', (jobId, progress: IBullWebhookResponse) => {
|
|
this.activeExecutions.resolveResponsePromise(
|
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
|
|
progress.executionId,
|
|
WebhookHelpers.decodeWebhookResponse(progress.response),
|
|
);
|
|
});
|
|
}
|
|
|
|
async add(jobData: IBullJobData, jobOptions: object): Promise<Bull.Job> {
|
|
return this.jobQueue.add(jobData, jobOptions);
|
|
}
|
|
|
|
async getJob(jobId: Bull.JobId): Promise<Bull.Job | null> {
|
|
return this.jobQueue.getJob(jobId);
|
|
}
|
|
|
|
async getJobs(jobTypes: Bull.JobStatus[]): Promise<Bull.Job[]> {
|
|
return this.jobQueue.getJobs(jobTypes);
|
|
}
|
|
|
|
getBullObjectInstance(): Bull.Queue {
|
|
return this.jobQueue;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param job A Bull.Job instance
|
|
* @returns boolean true if we were able to securely stop the job
|
|
*/
|
|
async stopJob(job: Bull.Job): Promise<boolean> {
|
|
if (await job.isActive()) {
|
|
// Job is already running so tell it to stop
|
|
await job.progress(-1);
|
|
return true;
|
|
}
|
|
// Job did not get started yet so remove from queue
|
|
try {
|
|
await job.remove();
|
|
return true;
|
|
} catch (e) {
|
|
await job.progress(-1);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
let activeQueueInstance: Queue | undefined;
|
|
|
|
export function getInstance(): Queue {
|
|
if (activeQueueInstance === undefined) {
|
|
activeQueueInstance = new Queue();
|
|
}
|
|
|
|
return activeQueueInstance;
|
|
}
|