bullmq 1.57.4 → 1.59.2

package/dist/esm/classes/child-pool.js

@@ -0,0 +1,125 @@
+import { fork } from 'child_process';
+import * as path from 'path';
+import { flatten } from 'lodash';
+import * as getPort from 'get-port';
+import { killAsync } from './process-utils';
+import { ParentCommand, ChildCommand } from '../interfaces';
+import { parentSend } from '../utils';
+const CHILD_KILL_TIMEOUT = 30000;
+const convertExecArgv = async (execArgv) => {
+    const standard = [];
+    const convertedArgs = [];
+    for (let i = 0; i < execArgv.length; i++) {
+        const arg = execArgv[i];
+        if (arg.indexOf('--inspect') === -1) {
+            standard.push(arg);
+        }
+        else {
+            const argName = arg.split('=')[0];
+            const port = await getPort();
+            convertedArgs.push(`${argName}=${port}`);
+        }
+    }
+    return standard.concat(convertedArgs);
+};
+/**
+ * @see https://nodejs.org/api/process.html#process_exit_codes
+ */
+const exitCodesErrors = {
+    1: 'Uncaught Fatal Exception',
+    2: 'Unused',
+    3: 'Internal JavaScript Parse Error',
+    4: 'Internal JavaScript Evaluation Failure',
+    5: 'Fatal Error',
+    6: 'Non-function Internal Exception Handler',
+    7: 'Internal Exception Handler Run-Time Failure',
+    8: 'Unused',
+    9: 'Invalid Argument',
+    10: 'Internal JavaScript Run-Time Failure',
+    12: 'Invalid Debug Argument',
+    13: 'Unfinished Top-Level Await',
+};
+async function initChild(child, processFile) {
+    const onComplete = new Promise((resolve, reject) => {
+        const onMessageHandler = (msg) => {
+            if (msg.cmd === ParentCommand.InitCompleted) {
+                resolve();
+            }
+            else if (msg.cmd === ParentCommand.InitFailed) {
+                const err = new Error();
+                err.stack = msg.err.stack;
+                err.message = msg.err.message;
+                reject(err);
+            }
+            child.off('message', onMessageHandler);
+            child.off('close', onCloseHandler);
+        };
+        const onCloseHandler = (code, signal) => {
+            if (code > 128) {
+                code -= 128;
+            }
+            const msg = exitCodesErrors[code] || `Unknown exit code ${code}`;
+            reject(new Error(`Error initializing child: ${msg} and signal ${signal}`));
+            child.off('message', onMessageHandler);
+            child.off('close', onCloseHandler);
+        };
+        child.on('message', onMessageHandler);
+        // TODO: we need to clean this listener too.
+        child.on('close', onCloseHandler);
+    });
+    await parentSend(child, { cmd: ChildCommand.Init, value: processFile });
+    await onComplete;
+}
+export class ChildPool {
+    constructor(masterFile = path.join(process.cwd(), 'dist/cjs/classes/master.js')) {
+        this.masterFile = masterFile;
+        this.retained = {};
+        this.free = {};
+    }
+    async retain(processFile) {
+        const _this = this;
+        let child = _this.getFree(processFile).pop();
+        if (child) {
+            _this.retained[child.pid] = child;
+            return child;
+        }
+        const execArgv = await convertExecArgv(process.execArgv);
+        child = fork(this.masterFile, [], { execArgv, stdio: 'pipe' });
+        child.processFile = processFile;
+        _this.retained[child.pid] = child;
+        child.on('exit', _this.remove.bind(_this, child));
+        child.stdout.pipe(process.stdout);
+        child.stderr.pipe(process.stderr);
+        await initChild(child, child.processFile);
+        return child;
+    }
+    release(child) {
+        delete this.retained[child.pid];
+        this.getFree(child.processFile).push(child);
+    }
+    remove(child) {
+        delete this.retained[child.pid];
+        const free = this.getFree(child.processFile);
+        const childIndex = free.indexOf(child);
+        if (childIndex > -1) {
+            free.splice(childIndex, 1);
+        }
+    }
+    async kill(child, signal = 'SIGKILL') {
+        this.remove(child);
+        await killAsync(child, signal, CHILD_KILL_TIMEOUT);
+    }
+    async clean() {
+        const children = Object.values(this.retained).concat(this.getAllFree());
+        this.retained = {};
+        this.free = {};
+        await Promise.all(children.map(c => this.kill(c, 'SIGTERM')));
+    }
+    getFree(id) {
+        return (this.free[id] = this.free[id] || []);
+    }
+    getAllFree() {
+        return flatten(Object.values(this.free));
+    }
+}
+//# sourceMappingURL=child-pool.js.map

package/dist/esm/classes/child-pool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"child-pool.js","sourceRoot":"","sources":["../../../src/classes/child-pool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,IAAI,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,KAAK,OAAO,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,MAAM,kBAAkB,GAAG,KAAM,CAAC;AAMlC,MAAM,eAAe,GAAG,KAAK,EAAE,QAAkB,EAAqB,EAAE;IACtE,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACxC,MAAM,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE;YACnC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACpB;aAAM;YACL,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAClC,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;YAC7B,aAAa,CAAC,IAAI,CAAC,GAAG,OAAO,IAAI,IAAI,EAAE,CAAC,CAAC;SAC1C;KACF;IAED,OAAO,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,eAAe,GAAgC;IACnD,CAAC,EAAE,0BAA0B;IAC7B,CAAC,EAAE,QAAQ;IACX,CAAC,EAAE,iCAAiC;IACpC,CAAC,EAAE,wCAAwC;IAC3C,CAAC,EAAE,aAAa;IAChB,CAAC,EAAE,yCAAyC;IAC5C,CAAC,EAAE,6CAA6C;IAChD,CAAC,EAAE,QAAQ;IACX,CAAC,EAAE,kBAAkB;IACrB,EAAE,EAAE,sCAAsC;IAC1C,EAAE,EAAE,wBAAwB;IAC5B,EAAE,EAAE,4BAA4B;CACjC,CAAC;AAEF,KAAK,UAAU,SAAS,CAAC,KAAmB,EAAE,WAAmB;IAC/D,MAAM,UAAU,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACvD,MAAM,gBAAgB,GAAG,CAAC,GAAQ,EAAE,EAAE;YACpC,IAAI,GAAG,CAAC,GAAG,KAAK,aAAa,CAAC,aAAa,EAAE;gBAC3C,OAAO,EAAE,CAAC;aACX;iBAAM,IAAI,GAAG,CAAC,GAAG,KAAK,aAAa,CAAC,UAAU,EAAE;gBAC/C,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;gBACxB,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC;gBAC1B,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC;gBAC9B,MAAM,CAAC,GAAG,CAAC,CAAC;aACb;YACD,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACvC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QACrC,CAAC,CAAC;QAEF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE;YACtD,IAAI,IAAI,GAAG,GAAG,EAAE;gBACd,IAAI,IAAI,GAAG,CAAC;aACb;YACD,MAAM,GAAG,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,qBAAqB,IAAI,EAAE,CAAC;YACjE,MAAM,CACJ,IAAI,KAAK,CAAC,6BAA6B,GAAG,eAAe,MAAM,EAAE,CAAC,CACnE,CAAC;YACF,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACvC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QACrC,CAAC,CAAC;QAEF,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QAEtC,4CAA4C;QAC5C,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,MAAM,UAAU,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;IACxE,MAAM,UAAU,CAAC;AACnB,CAAC;AAED,MAAM,OAAO,SAAS;IAIpB,YACU,aAAa,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,4BAA4B,CAAC;QAAnE,eAAU,GAAV,UAAU,CAAyD;QAJ7E,aAAQ,GAAuC,EAAE,CAAC;QAClD,SAAI,GAAyC,EAAE,CAAC;IAI7C,CAAC;IAEJ,KAAK,CAAC,MAAM,CAAC,WAAmB;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC;QACnB,IAAI,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,CAAC;QAE7C,IAAI,KAAK,EAAE;YACT,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAClC,OAAO,KAAK,CAAC;SACd;QAED,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEzD,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/D,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QAEhC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAElC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAElD,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAClC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAElC,MAAM,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;QAC1C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,KAAsB;QAC5B,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,KAAsB;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEhC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAE7C,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,UAAU,GAAG,CAAC,CAAC,EAAE;YACnB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;SAC5B;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAAmB,EACnB,SAAgC,SAAS;QAEzC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnB,MAAM,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QAEf,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,CAAC,EAAU;QAChB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,UAAU;QACR,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/dist/esm/classes/child-processor.d.ts

@@ -0,0 +1,24 @@
+import { JobJson } from './job';
+declare enum ChildStatus {
+    Idle = 0,
+    Started = 1,
+    Terminating = 2,
+    Errored = 3
+}
+/**
+ * ChildProcessor
+ *
+ * This class acts as the interface between a child process and it parent process
+ * so that jobs can be processed in different processes than the parent.
+ *
+ */
+export declare class ChildProcessor {
+    status: ChildStatus;
+    processor: any;
+    currentJobPromise: Promise<unknown> | undefined;
+    init(processorFile: string): Promise<void>;
+    start(jobJson: JobJson): Promise<void>;
+    stop(): Promise<void>;
+    waitForCurrentJobAndExit(): Promise<void>;
+}
+export {};

package/dist/esm/classes/child-processor.js

@@ -0,0 +1,165 @@
+import { promisify } from 'util';
+import { ParentCommand } from '../interfaces';
+import { childSend } from '../utils';
+var ChildStatus;
+(function (ChildStatus) {
+    ChildStatus[ChildStatus["Idle"] = 0] = "Idle";
+    ChildStatus[ChildStatus["Started"] = 1] = "Started";
+    ChildStatus[ChildStatus["Terminating"] = 2] = "Terminating";
+    ChildStatus[ChildStatus["Errored"] = 3] = "Errored";
+})(ChildStatus || (ChildStatus = {}));
+/**
+ * ChildProcessor
+ *
+ * This class acts as the interface between a child process and it parent process
+ * so that jobs can be processed in different processes than the parent.
+ *
+ */
+export class ChildProcessor {
+    async init(processorFile) {
+        let processor;
+        try {
+            processor = require(processorFile);
+        }
+        catch (err) {
+            this.status = ChildStatus.Errored;
+            return childSend(process, {
+                cmd: ParentCommand.InitFailed,
+                err: err,
+            });
+        }
+        if (processor.default) {
+            // support es2015 module.
+            processor = processor.default;
+        }
+        if (processor.length > 1) {
+            processor = promisify(processor);
+        }
+        else {
+            const origProcessor = processor;
+            processor = function (...args) {
+                try {
+                    return Promise.resolve(origProcessor(...args));
+                }
+                catch (err) {
+                    return Promise.reject(err);
+                }
+            };
+        }
+        this.processor = processor;
+        this.status = ChildStatus.Idle;
+        await childSend(process, {
+            cmd: ParentCommand.InitCompleted,
+        });
+    }
+    async start(jobJson) {
+        if (this.status !== ChildStatus.Idle) {
+            return childSend(process, {
+                cmd: ParentCommand.Error,
+                err: new Error('cannot start a not idling child process'),
+            });
+        }
+        this.status = ChildStatus.Started;
+        this.currentJobPromise = (async () => {
+            try {
+                const job = wrapJob(jobJson);
+                const result = (await this.processor(job)) || {};
+                await childSend(process, {
+                    cmd: ParentCommand.Completed,
+                    value: result,
+                });
+            }
+            catch (err) {
+                await childSend(process, {
+                    cmd: ParentCommand.Failed,
+                    value: !err.message ? new Error(err) : err,
+                });
+            }
+            finally {
+                this.status = ChildStatus.Idle;
+                this.currentJobPromise = undefined;
+            }
+        })();
+    }
+    async stop() { }
+    async waitForCurrentJobAndExit() {
+        this.status = ChildStatus.Terminating;
+        try {
+            await this.currentJobPromise;
+        }
+        finally {
+            process.exit(process.exitCode || 0);
+        }
+    }
+}
+// https://stackoverflow.com/questions/18391212/is-it-not-possible-to-stringify-an-error-using-json-stringify
+if (!('toJSON' in Error.prototype)) {
+    Object.defineProperty(Error.prototype, 'toJSON', {
+        value: function () {
+            const alt = {};
+            const _this = this;
+            Object.getOwnPropertyNames(_this).forEach(function (key) {
+                alt[key] = _this[key];
+            }, this);
+            return alt;
+        },
+        configurable: true,
+        writable: true,
+    });
+}
+/**
+ * Enhance the given job argument with some functions
+ * that can be called from the sandboxed job processor.
+ *
+ * Note, the `job` argument is a JSON deserialized message
+ * from the main node process to this forked child process,
+ * the functions on the original job object are not in tact.
+ * The wrapped job adds back some of those original functions.
+ */
+function wrapJob(job) {
+    let progressValue = job.progress;
+    const updateProgress = async (progress) => {
+        // Locally store reference to new progress value
+        // so that we can return it from this process synchronously.
+        progressValue = progress;
+        // Send message to update job progress.
+        await childSend(process, {
+            cmd: ParentCommand.Progress,
+            value: progress,
+        });
+    };
+    const progress = (progress) => {
+        console.warn([
+            'BullMQ: DEPRECATION WARNING! progress function in sandboxed processor is deprecated. This will',
+            'be removed in the next major release, you should use updateProgress method instead.',
+        ].join(' '));
+        if (progress) {
+            return updateProgress(progress);
+        }
+        else {
+            // Return the last known progress value.
+            return progressValue;
+        }
+    };
+    return Object.assign(Object.assign({}, job), { data: JSON.parse(job.data || '{}'), opts: job.opts, returnValue: JSON.parse(job.returnvalue || '{}'), 
+        /*
+         * Emulate the real job `progress` function.
+         * If no argument is given, it behaves as a sync getter.
+         * If an argument is given, it behaves as an async setter.
+         */
+        progress,
+        /*
+         * Emulate the real job `updateProgress` function, should works as `progress` function.
+         */
+        updateProgress, 
+        /*
+         * Emulate the real job `log` function.
+         */
+        log: async (row) => {
+            childSend(process, {
+                cmd: ParentCommand.Log,
+                value: row,
+            });
+        } });
+}
+//# sourceMappingURL=child-processor.js.map

package/dist/esm/classes/child-processor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"child-processor.js","sourceRoot":"","sources":["../../../src/classes/child-processor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjC,OAAO,EAAgB,aAAa,EAAE,MAAM,eAAe,CAAC;AAE5D,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,IAAK,WAKJ;AALD,WAAK,WAAW;IACd,6CAAI,CAAA;IACJ,mDAAO,CAAA;IACP,2DAAW,CAAA;IACX,mDAAO,CAAA;AACT,CAAC,EALI,WAAW,KAAX,WAAW,QAKf;AAED;;;;;;GAMG;AACH,MAAM,OAAO,cAAc;IAKlB,KAAK,CAAC,IAAI,CAAC,aAAqB;QACrC,IAAI,SAAS,CAAC;QACd,IAAI;YACF,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;SACpC;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC;YAClC,OAAO,SAAS,CAAC,OAAO,EAAE;gBACxB,GAAG,EAAE,aAAa,CAAC,UAAU;gBAC7B,GAAG,EAAS,GAAG;aAChB,CAAC,CAAC;SACJ;QAED,IAAI,SAAS,CAAC,OAAO,EAAE;YACrB,yBAAyB;YACzB,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;SAClC;aAAM;YACL,MAAM,aAAa,GAAG,SAAS,CAAC;YAChC,SAAS,GAAG,UAAU,GAAG,IAAW;gBAClC,IAAI;oBACF,OAAO,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;iBAChD;gBAAC,OAAO,GAAG,EAAE;oBACZ,OAAO,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;iBAC5B;YACH,CAAC,CAAC;SACH;QACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC;QAC/B,MAAM,SAAS,CAAC,OAAO,EAAE;YACvB,GAAG,EAAE,aAAa,CAAC,aAAa;SACjC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,OAAgB;QACjC,IAAI,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,IAAI,EAAE;YACpC,OAAO,SAAS,CAAC,OAAO,EAAE;gBACxB,GAAG,EAAE,aAAa,CAAC,KAAK;gBACxB,GAAG,EAAE,IAAI,KAAK,CAAC,yCAAyC,CAAC;aAC1D,CAAC,CAAC;SACJ;QACD,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,iBAAiB,GAAG,CAAC,KAAK,IAAI,EAAE;YACnC,IAAI;gBACF,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC7B,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;gBACjD,MAAM,SAAS,CAAC,OAAO,EAAE;oBACvB,GAAG,EAAE,aAAa,CAAC,SAAS;oBAC5B,KAAK,EAAE,MAAM;iBACd,CAAC,CAAC;aACJ;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,SAAS,CAAC,OAAO,EAAE;oBACvB,GAAG,EAAE,aAAa,CAAC,MAAM;oBACzB,KAAK,EAAE,CAAS,GAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG;iBACzD,CAAC,CAAC;aACJ;oBAAS;gBACR,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC;gBAC/B,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;aACpC;QACH,CAAC,CAAC,EAAE,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,IAAI,KAAI,CAAC;IAEtB,KAAK,CAAC,wBAAwB;QAC5B,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,WAAW,CAAC;QACtC,IAAI;YACF,MAAM,IAAI,CAAC,iBAAiB,CAAC;SAC9B;gBAAS;YACR,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;SACrC;IACH,CAAC;CACF;AAED,6GAA6G;AAC7G,IAAI,CAAC,CAAC,QAAQ,IAAI,KAAK,CAAC,SAAS,CAAC,EAAE;IAClC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE;QAC/C,KAAK,EAAE;YACL,MAAM,GAAG,GAAQ,EAAE,CAAC;YACpB,MAAM,KAAK,GAAG,IAAI,CAAC;YAEnB,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,GAAG;gBACrD,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACxB,CAAC,EAAE,IAAI,CAAC,CAAC;YAET,OAAO,GAAG,CAAC;QACb,CAAC;QACD,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;CACJ;AAED;;;;;;;;GAQG;AACH,SAAS,OAAO,CAAC,GAAY;IAC3B,IAAI,aAAa,GAAG,GAAG,CAAC,QAAQ,CAAC;IAEjC,MAAM,cAAc,GAAG,KAAK,EAAE,QAAyB,EAAE,EAAE;QACzD,gDAAgD;QAChD,4DAA4D;QAC5D,aAAa,GAAG,QAAQ,CAAC;QACzB,uCAAuC;QACvC,MAAM,SAAS,CAAC,OAAO,EAAE;YACvB,GAAG,EAAE,aAAa,CAAC,QAAQ;YAC3B,KAAK,EAAE,QAAQ;SAChB,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CAAC,QAA0B,EAAE,EAAE;QAC9C,OAAO,CAAC,IAAI,CACV;YACE,gGAAgG;YAChG,qFAAqF;SACtF,CAAC,IAAI,CAAC,GAAG,CAAC,CACZ,CAAC;QAEF,IAAI,QAAQ,EAAE;YACZ,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC;SACjC;aAAM;YACL,wCAAwC;YACxC,OAAO,aAAa,CAAC;SACtB;IACH,CAAC,CAAC;IAEF,uCACK,GAAG,KACN,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,EAClC,IAAI,EAAE,GAAG,CAAC,IAAI,EACd,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC;QAChD;;;;WAIG;QACH,QAAQ;QACR;;WAEG;QACH,cAAc;QACd;;WAEG;QACH,GAAG,EAAE,KAAK,EAAE,GAAQ,EAAE,EAAE;YACtB,SAAS,CAAC,OAAO,EAAE;gBACjB,GAAG,EAAE,aAAa,CAAC,GAAG;gBACtB,KAAK,EAAE,GAAG;aACX,CAAC,CAAC;QACL,CAAC,IACD;AACJ,CAAC"}

package/dist/esm/classes/compat.d.ts

@@ -0,0 +1,316 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { Job } from './job';
+import { QueueEvents } from './queue-events';
+import { JobsOptions, QueueOptions, RepeatOptions, QueueEventsOptions, QueueSchedulerOptions, WorkerOptions, Processor } from '../interfaces';
+declare type CommonOptions = QueueSchedulerOptions & QueueOptions & WorkerOptions & QueueEventsOptions;
+export declare class Queue3<T = any> extends EventEmitter {
+    /**
+     * The name of the queue
+     */
+    name: string;
+    queueEvents: QueueEvents;
+    private opts;
+    private readonly queue;
+    private worker;
+    private queueScheduler;
+    /**
+     * This is the Queue constructor.
+     * It creates a new Queue that is persisted in Redis.
+     * Every time the same queue is instantiated it tries to process all the old jobs
+     * that may exist from a previous unfinished session.
+     */
+    constructor(name: string, opts?: CommonOptions);
+    /**
+     * Returns a promise that resolves when Redis is connected and the queue is ready to accept jobs.
+     * This replaces the `ready` event emitted on Queue in previous versions.
+     */
+    isReady(): Promise<this>;
+    /**
+     * Defines a processing function for the jobs placed into a given Queue.
+     *
+     * The callback is called every time a job is placed in the queue.
+     * It is passed an instance of the job as first argument.
+     *
+     * If the callback signature contains the second optional done argument,
+     * the callback will be passed a done callback to be called after the job has been completed.
+     * The done callback can be called with an Error instance, to signal that the job did not complete successfully,
+     * or with a result as second argument (e.g.: done(null, result);) when the job is successful.
+     * Errors will be passed as a second argument to the "failed" event; results,
+     * as a second argument to the "completed" event.
+     *
+     * If, however, the callback signature does not contain the done argument,
+     * a promise must be returned to signal job completion.
+     * If the promise is rejected, the error will be passed as a second argument to the "failed" event.
+     * If it is resolved, its value will be the "completed" event's second argument.
+     */
+    process(processor: string | Processor<T>): Promise<void>;
+    add(jobName: string, data: any, opts?: JobsOptions): Promise<Job>;
+    /**
+     * Returns a promise that resolves when the queue is paused.
+     *
+     * A paused queue will not process new jobs until resumed, but current jobs being processed will continue until
+     * they are finalized. The pause can be either global or local. If global, all workers in all queue instances
+     * for a given queue will be paused. If local, just this worker will stop processing new jobs after the current
+     * lock expires. This can be useful to stop a worker from taking new jobs prior to shutting down.
+     *
+     * Pausing a queue that is already paused does nothing.
+     */
+    pause(): Promise<void>;
+    pauseWorker(doNotWaitActive?: boolean): Promise<void>;
+    /**
+     * Returns a promise that resolves when the queue is resumed after being paused.
+     *
+     * The resume can be either local or global. If global, all workers in all queue instances for a given queue
+     * will be resumed. If local, only this worker will be resumed. Note that resuming a queue globally will not
+     * resume workers that have been paused locally; for those, resume(true) must be called directly on their
+     * instances.
+     *
+     * Resuming a queue that is not paused does nothing.
+     */
+    resume(): Promise<void>;
+    resumeWorker(): Promise<void>;
+    isWorkerPaused(): boolean;
+    /**
+     * Returns a promise that returns the number of jobs in the queue, waiting or paused.
+     * Since there may be other processes adding or processing jobs,
+     * this value may be true only for a very small amount of time.
+     */
+    count(): Promise<number>;
+    /**
+     * Empties a queue deleting all the input lists and associated jobs.
+     */
+    empty(): Promise<void>;
+    /**
+     * Closes the underlying redis client. Use this to perform a graceful shutdown.
+     *
+     * `close` can be called from anywhere, with one caveat:
+     * if called from within a job handler the queue won't close until after the job has been processed
+     */
+    close(): Promise<any>;
+    /**
+     * Returns a promise that will return the job instance associated with the jobId parameter.
+     * If the specified job cannot be located, the promise callback parameter will be set to null.
+     */
+    getJob(jobId: string): Promise<Job | null>;
+    /**
+     * Returns a promise that will return an array with the waiting jobs between start and end.
+     */
+    getWaiting(start?: number, end?: number): Promise<Array<Job>>;
+    /**
+     * Returns a promise that will return an array with the active jobs between start and end.
+     */
+    getActive(start?: number, end?: number): Promise<Array<Job>>;
+    /**
+     * Returns a promise that will return an array with the delayed jobs between start and end.
+     */
+    getDelayed(start?: number, end?: number): Promise<Array<Job>>;
+    /**
+     * Returns a promise that will return an array with the completed jobs between start and end.
+     */
+    getCompleted(start?: number, end?: number): Promise<Array<Job>>;
+    /**
+     * Returns a promise that will return an array with the failed jobs between start and end.
+     */
+    getFailed(start?: number, end?: number): Promise<Array<Job>>;
+    /**
+     * Returns JobInformation of repeatable jobs (ordered descending). Provide a start and/or an end
+     * index to limit the number of results. Start defaults to 0, end to -1 and asc to false.
+     */
+    getRepeatableJobs(start?: number, end?: number, asc?: boolean): Promise<JobInformation3[]>;
+    /**
+     * ???
+     */
+    nextRepeatableJob(name: string, data: any, opts?: JobsOptions, skipCheckExists?: boolean): Promise<Job>;
+    /**
+     * Removes a given repeatable job. The RepeatOptions and JobId needs to be the same as the ones
+     * used for the job when it was added.
+     *
+     * name: The name of the to be removed job
+     */
+    removeRepeatable(name: string, opts: RepeatOptions): Promise<void>;
+    /**
+     * Removes a given repeatable job by key.
+     */
+    removeRepeatableByKey(repeatJobKey: string): Promise<void>;
+    /**
+     * Returns a promise that will return an array of job instances of the given types.
+     * Optional parameters for range and ordering are provided.
+     */
+    getJobs(types: string[] | string, start?: number, end?: number, asc?: boolean): Promise<Array<Job>>;
+    getNextJob(): Promise<Job>;
+    /**
+     * Returns a object with the logs according to the start and end arguments. The returned count
+     * value is the total amount of logs, useful for implementing pagination.
+     */
+    getJobLogs(jobId: string, start?: number, end?: number): Promise<{
+        logs: string[];
+        count: number;
+    }>;
+    /**
+     * Returns a promise that resolves with the job counts for the given queue.
+     */
+    getJobCounts(...types: string[]): Promise<{
+        [index: string]: number;
+    }>;
+    /**
+     * Returns a promise that resolves with the job counts for the given queue of the given types.
+     */
+    getJobCountByTypes(...types: string[]): Promise<number>;
+    /**
+     * Returns a promise that resolves with the quantity of completed jobs.
+     */
+    getCompletedCount(): Promise<number>;
+    /**
+     * Returns a promise that resolves with the quantity of failed jobs.
+     */
+    getFailedCount(): Promise<number>;
+    /**
+     * Returns a promise that resolves with the quantity of delayed jobs.
+     */
+    getDelayedCount(): Promise<number>;
+    /**
+     * Returns a promise that resolves with the quantity of waiting jobs.
+     */
+    getWaitingCount(): Promise<number>;
+    /**
+     * Returns a promise that resolves with the quantity of paused jobs.
+     */
+    getPausedCount(): Promise<number>;
+    /**
+     * Returns a promise that resolves with the quantity of active jobs.
+     */
+    getActiveCount(): Promise<number>;
+    /**
+     * Returns a promise that resolves to the quantity of repeatable jobs.
+     */
+    getRepeatableCount(): Promise<number>;
+    /**
+     * Tells the queue remove all jobs created outside of a grace period in milliseconds.
+     * You can clean the jobs with the following states: completed, wait (typo for waiting), active, delayed, and failed.
+     * @param grace - Grace period in milliseconds.
+     * @param limit - Maximum amount of jobs to clean per call. If not provided will clean all matching jobs.
+     * @param type - Status of the job to clean. Values are completed, wait,
+     * active, paused, delayed, and failed. Defaults to completed.
+     */
+    clean(grace: number, limit: number, type?: 'completed' | 'wait' | 'active' | 'paused' | 'delayed' | 'failed'): Promise<string[]>;
+    /**
+     * Listens to queue events
+     */
+    on(event: string, callback: (...args: any[]) => void): this;
+    /**
+     * An error occurred
+     */
+    on(event: 'error', callback: ErrorEventCallback3): this;
+    /**
+     * A Job is waiting to be processed as soon as a worker is idling.
+     */
+    on(event: 'waiting', callback: WaitingEventCallback3): this;
+    /**
+     * A job has started. You can use `jobPromise.cancel()` to abort it
+     */
+    on(event: 'active', callback: ActiveEventCallback3<T>): this;
+    /**
+     * A job has been marked as stalled.
+     * This is useful for debugging job workers that crash or pause the event loop.
+     */
+    on(event: 'stalled', callback: StalledEventCallback3<T>): this;
+    /**
+     * A job's progress was updated
+     */
+    on(event: 'progress', callback: ProgressEventCallback3<T>): this;
+    /**
+     * A job successfully completed with a `result`
+     */
+    on(event: 'completed', callback: CompletedEventCallback3<T>): this;
+    /**
+     * A job failed with `err` as the reason
+     */
+    on(event: 'failed', callback: FailedEventCallback3<T>): this;
+    /**
+     * The queue has been paused
+     */
+    on(event: 'paused', callback: EventCallback3): this;
+    /**
+     * The queue has been resumed
+     */
+    on(event: 'resumed', callback: EventCallback3): this;
+    /**
+     * A job successfully removed.
+     */
+    on(event: 'removed', callback: RemovedEventCallback3<T>): this;
+    /**
+     * Old jobs have been cleaned from the queue.
+     * `jobs` is an array of jobs that were removed, and `type` is the type of those jobs.
+     *
+     * @see Queue#clean() for details
+     */
+    on(event: 'cleaned', callback: CleanedEventCallback3<T>): this;
+    /**
+     * Emitted every time the queue has processed all the waiting jobs
+     * (even if there can be some delayed jobs not yet processed)
+     */
+    on(event: 'drained', callback: EventCallback3): this;
+    once(event: string | symbol, listener: (...args: any[]) => void): this;
+    off(event: string | symbol, listener?: (...args: any[]) => void): this;
+    removeListener(event: string | symbol, listener: (...args: any[]) => void): this;
+    removeAllListeners(event: string | symbol): this;
+    /**
+     * Set clientName to Redis.client
+     */
+    setWorkerName(): Promise<any>;
+    /**
+     * Returns Redis clients array which belongs to current Queue
+     */
+    getWorkers(): Promise<{
+        [key: string]: string;
+    }[]>;
+    /**
+     * Returns Queue name in base64 encoded format
+     */
+    base64Name(): string;
+    /**
+     * Returns Queue name with keyPrefix (default: 'bull')
+     */
+    clientName(): string;
+    /**
+     * Returns Redis clients array which belongs to current Queue from string with all redis clients
+     *
+     * @param list - String with all redis clients
+     */
+    parseClientList(list: string): {
+        [key: string]: string;
+    }[];
+    retryJob(job: Job): Promise<void>;
+    private getQueueEvents;
+    private ensureWorkerCreated;
+    private attachListener;
+    detachListener(event: string | symbol, listener?: (...args: any[]) => void): this;
+}
+export declare type JobStatusClean3 = 'completed' | 'wait' | 'active' | 'delayed' | 'paused' | 'failed';
+export interface JobInformation3 {
+    key: string;
+    name: string;
+    id?: string;
+    endDate?: number;
+    tz?: string;
+    cron: string;
+    next: number;
+}
+export declare type EventCallback3 = () => void;
+export declare type ErrorEventCallback3 = (error: Error) => void;
+export interface JobPromise3 {
+    /**
+     * Abort this job
+     */
+    cancel(): void;
+}
+export declare type ActiveEventCallback3<T = any> = (job: Job, jobPromise?: JobPromise3) => void;
+export declare type StalledEventCallback3<T = any> = (job: Job) => void;
+export declare type ProgressEventCallback3<T = any> = (job: Job, progress: any) => void;
+export declare type CompletedEventCallback3<T = any> = (job: Job, result: any) => void;
+export declare type FailedEventCallback3<T = any> = (job: Job, error: Error) => void;
+export declare type CleanedEventCallback3<T = any> = (jobs: Array<Job>, status: JobStatusClean3) => void;
+export declare type RemovedEventCallback3<T = any> = (job: Job) => void;
+export declare type WaitingEventCallback3 = (jobId: string) => void;
+export {};