snugkv-nest 0.2.0 → 0.3.0

package/dist/core/queue/job.js

@@ -0,0 +1,221 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Job = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const client_1 = require("../client");
+const types_1 = require("./types");
+/** A job as stored on the server. Fetched jobs are snapshots; call `getState()` or `Queue.getJob()` for fresh data. */
+class Job {
+    queue;
+    id;
+    name;
+    data;
+    opts;
+    timestamp;
+    delay;
+    priority;
+    progress;
+    returnvalue;
+    failedReason;
+    stacktrace;
+    attemptsMade;
+    stalledCounter;
+    processedOn;
+    finishedOn;
+    /** Lock token while a worker holds the job. */
+    token;
+    /** Scheduler that created this job. */
+    schedulerId;
+    parent;
+    /** Children that have not finished. */
+    pendingChildren;
+    /** Set by a worker. */
+    raw;
+    constructor(queue, id, raw) {
+        this.queue = queue;
+        this.id = id;
+        this.raw = raw;
+        this.name = raw.name ?? '';
+        this.data = (0, types_1.parseJson)(raw.data);
+        this.timestamp = Number(raw.ts ?? 0);
+        this.delay = Number(raw.delay ?? 0);
+        this.priority = Number(raw.prio ?? 0);
+        this.progress = raw.prg === undefined ? 0 : (0, types_1.parseJson)(raw.prg);
+        this.returnvalue = (0, types_1.parseJson)(raw.rv);
+        this.failedReason = raw.fr || undefined;
+        this.stacktrace = raw.st ? (0, types_1.parseJson)(raw.st) : [];
+        if (!Array.isArray(this.stacktrace))
+            this.stacktrace = [String(raw.st)];
+        this.attemptsMade = Number(raw.atm ?? 0);
+        this.stalledCounter = Number(raw.stc ?? 0);
+        this.processedOn = raw.po ? Number(raw.po) : undefined;
+        this.finishedOn = raw.fo ? Number(raw.fo) : undefined;
+        this.token = raw.tk || undefined;
+        this.schedulerId = raw.rep || undefined;
+        this.parent = raw.pq ? { id: raw.pid ?? '', queue: (0, types_1.queueNameOf)(raw.pq) } : undefined;
+        this.pendingChildren = Number(raw.pend ?? 0);
+        const bt = raw.bt;
+        this.opts = {
+            attempts: Number(raw.att ?? 1),
+            delay: this.delay,
+            priority: this.priority,
+            lifo: raw.lifo === '1' || undefined,
+            backoff: bt ? { type: bt, delay: Number(raw.bd ?? 0) } : undefined,
+        };
+    }
+    static fromFlat(queue, id, flat) {
+        return new Job(queue, id, (0, client_1.pairsToObject)(flat));
+    }
+    /** Where this job is now. */
+    async getState() {
+        return (await this.queue.fcall('snugq_state', this.id));
+    }
+    async updateProgress(progress) {
+        await this.queue.fcall('snugq_progress', this.id, (0, types_1.toJson)(progress));
+        this.progress = progress;
+    }
+    /** Adds a line to the job log. Returns the log length. */
+    async log(line) {
+        return (await this.queue.fcall('snugq_log', this.id, line, this.opts.keepLogs ?? 0));
+    }
+    async updateData(data) {
+        await this.queue.fcall('snugq_update_data', this.id, (0, types_1.toJson)(data));
+        this.data = data;
+    }
+    /** Removes the job and its unfinished children. Returns false if a worker holds it. */
+    async remove() {
+        return (await this.queue.fcall('snugq_remove', this.id)) === 1;
+    }
+    /** Puts a failed (or completed) job back in the queue. */
+    async retry(state = 'failed', opts = {}) {
+        const r = (await this.queue.fcall('snugq_retry', this.id, state, opts.resetAttemptsMade ? 1 : 0));
+        if (r === -1)
+            throw new Error(`job ${this.id} does not exist`);
+        if (r === -5)
+            throw new Error(`job ${this.id} is not ${state}`);
+    }
+    /** Runs a delayed job now. */
+    async promote() {
+        const r = (await this.queue.fcall('snugq_promote', this.id));
+        if (r === -1)
+            throw new Error(`job ${this.id} does not exist`);
+        if (r === -3)
+            throw new Error(`job ${this.id} is not delayed`);
+    }
+    async changeDelay(delayMs) {
+        const r = (await this.queue.fcall('snugq_change_delay', this.id, Math.max(0, Math.floor(delayMs))));
+        if (r === -1)
+            throw new Error(`job ${this.id} does not exist`);
+        if (r === -3)
+            throw new Error(`job ${this.id} is not delayed`);
+    }
+    async changePriority(opts) {
+        const r = (await this.queue.fcall('snugq_change_priority', this.id, opts.priority, opts.lifo ? 1 : 0));
+        if (r === -1)
+            throw new Error(`job ${this.id} does not exist`);
+    }
+    /**
+     * From a processor: delay this job until `timestamp` (ms since epoch), then throw `new DelayedError()`.
+     * It does not use up an attempt.
+     */
+    async moveToDelayed(timestamp, token) {
+        const t = token ?? this.token;
+        if (!t)
+            throw new Error('moveToDelayed needs the lock token');
+        const r = (await this.queue.fcall('snugq_move_to_delayed', this.id, t, Math.max(0, Math.floor(timestamp - Date.now()))));
+        if (r === -2)
+            throw new Error(`lock of job ${this.id} was lost`);
+    }
+    /** Log lines. */
+    async getLogs(start = 0, end = -1) {
+        await this.queue.ready();
+        return this.queue.client.lrange(`${this.queue.base}job:${this.id}:logs`, start, end);
+    }
+    /** Results of finished children, keyed by `queue:jobId`. */
+    async getChildrenValues() {
+        await this.queue.ready();
+        const h = await this.queue.client.hgetall(`${this.queue.base}job:${this.id}:processed`);
+        const out = {};
+        for (const [ref, v] of Object.entries(h))
+            out[refToKey(ref)] = (0, types_1.parseJson)(v);
+        return out;
+    }
+    /** Reasons of children that failed, keyed by `queue:jobId`. */
+    async getFailedChildrenValues() {
+        await this.queue.ready();
+        const h = await this.queue.client.hgetall(`${this.queue.base}job:${this.id}:failed`);
+        const out = {};
+        for (const [ref, v] of Object.entries(h))
+            out[refToKey(ref)] = v;
+        return out;
+    }
+    /** Resolves with the return value when the job completes; rejects when it fails. Needs a started {@link QueueEvents}. */
+    async waitUntilFinished(events, ttlMs) {
+        await events.waitUntilReady();
+        return new Promise((resolve, reject) => {
+            let timer;
+            const cleanup = () => {
+                events.off('completed', onDone);
+                events.off('failed', onFail);
+                if (timer)
+                    clearTimeout(timer);
+            };
+            const onDone = (a) => {
+                if (a.jobId !== this.id)
+                    return;
+                cleanup();
+                resolve(a.returnvalue);
+            };
+            const onFail = (a) => {
+                if (a.jobId !== this.id)
+                    return;
+                cleanup();
+                reject(new Error(a.failedReason));
+            };
+            events.on('completed', onDone);
+            events.on('failed', onFail);
+            if (ttlMs) {
+                timer = setTimeout(() => {
+                    cleanup();
+                    reject(new Error(`job ${this.id} did not finish within ${ttlMs} ms`));
+                }, ttlMs);
+            }
+            // Events may have happened before we listened: look at the stored state too.
+            void this.queue.fcall('snugq_state', this.id).then(async (state) => {
+                if (state !== 'completed' && state !== 'failed')
+                    return;
+                const h = await this.queue.client.hmget(`${this.queue.base}job:${this.id}`, 'rv', 'fr');
+                if (state === 'completed')
+                    onDone({ jobId: this.id, returnvalue: (0, types_1.parseJson)(h[0] ?? undefined) });
+                else
+                    onFail({ jobId: this.id, failedReason: h[1] ?? 'failed' });
+            }, reject);
+        });
+    }
+    toJSON() {
+        return {
+            id: this.id,
+            name: this.name,
+            data: this.data,
+            opts: this.opts,
+            progress: this.progress,
+            timestamp: this.timestamp,
+            delay: this.delay,
+            priority: this.priority,
+            attemptsMade: this.attemptsMade,
+            processedOn: this.processedOn,
+            finishedOn: this.finishedOn,
+            returnvalue: this.returnvalue,
+            failedReason: this.failedReason,
+            stacktrace: this.stacktrace,
+            parent: this.parent,
+            schedulerId: this.schedulerId,
+        };
+    }
+}
+exports.Job = Job;
+function refToKey(ref) {
+    const i = ref.lastIndexOf('|');
+    return i < 0 ? ref : `${(0, types_1.queueNameOf)(ref.slice(0, i))}:${ref.slice(i + 1)}`;
+}
+//# sourceMappingURL=job.js.map

package/dist/core/queue/job.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job.js","sourceRoot":"","sources":["../../../src/core/queue/job.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,sCAA0C;AAE1C,mCAA2F;AAE3F,uHAAuH;AACvH,MAAa,GAAG;IA0BO;IAzBZ,EAAE,CAAS;IACX,IAAI,CAAS;IACtB,IAAI,CAAI;IACC,IAAI,CAAc;IAClB,SAAS,CAAS;IAClB,KAAK,CAAS;IACd,QAAQ,CAAS;IAC1B,QAAQ,CAAM;IACd,WAAW,CAAgB;IAC3B,YAAY,CAAqB;IACjC,UAAU,CAAW;IACrB,YAAY,CAAS;IACrB,cAAc,CAAS;IACvB,WAAW,CAAqB;IAChC,UAAU,CAAqB;IAC/B,+CAA+C;IAC/C,KAAK,CAAqB;IAC1B,uCAAuC;IAC9B,WAAW,CAAqB;IAChC,MAAM,CAA4C;IAC3D,uCAAuC;IAC9B,eAAe,CAAS;IACjC,uBAAuB;IACd,GAAG,CAAyB;IAErC,YAAqB,KAAgB,EAAE,EAAU,EAAE,GAA2B;QAAzD,UAAK,GAAL,KAAK,CAAW;QACnC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAA,iBAAS,EAAC,GAAG,CAAC,IAAI,CAAM,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,iBAAS,EAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,GAAG,IAAA,iBAAS,EAAC,GAAG,CAAC,EAAE,CAAkB,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAE,IAAA,iBAAS,EAAC,GAAG,CAAC,EAAE,CAAc,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;YAAE,IAAI,CAAC,UAAU,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC3C,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACvD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,GAAG,IAAI,SAAS,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE,KAAK,EAAE,IAAA,mBAAW,EAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACrF,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;QAC7C,MAAM,EAAE,GAAG,GAAG,CAAC,EAAoD,CAAC;QACpE,IAAI,CAAC,IAAI,GAAG;YACV,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;YAC9B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,GAAG,CAAC,IAAI,KAAK,GAAG,IAAI,SAAS;YACnC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;SACnE,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,KAAgB,EAAE,EAAU,EAAE,IAAW;QACvD,OAAO,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,IAAA,sBAAa,EAAC,IAAI,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,6BAA6B;IAC7B,KAAK,CAAC,QAAQ;QACZ,OAAO,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC,CAAa,CAAC;IACtE,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,QAA4C;QAC/D,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,EAAE,EAAE,IAAA,cAAM,EAAC,QAAQ,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,0DAA0D;IAC1D,KAAK,CAAC,GAAG,CAAC,IAAY;QACpB,OAAO,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAW,CAAC;IACjG,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAO;QACtB,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,EAAE,IAAA,cAAM,EAAC,IAAI,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,uFAAuF;IACvF,KAAK,CAAC,MAAM;QACV,OAAQ,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC,CAAY,KAAK,CAAC,CAAC;IAC7E,CAAC;IAED,0DAA0D;IAC1D,KAAK,CAAC,KAAK,CAAC,QAAgC,QAAQ,EAAE,OAAwC,EAAE;QAC9F,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC;QAC5G,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAC/D,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE,WAAW,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,8BAA8B;IAC9B,KAAK,CAAC,OAAO;QACX,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE,CAAC,CAAW,CAAC;QACvE,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAC/D,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAe;QAC/B,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAW,CAAC;QAC9G,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAC/D,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,IAA0C;QAC7D,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,uBAAuB,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC;QACjH,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,KAAc;QACnD,MAAM,CAAC,GAAG,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAC9D,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,uBAAuB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAW,CAAC;QACnI,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC;IACnE,CAAC;IAED,iBAAiB;IACjB,KAAK,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;QAC/B,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,OAAO,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IACvF,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,iBAAiB;QACrB,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,OAAO,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC;QACxF,MAAM,GAAG,GAAwB,EAAE,CAAC;QACpC,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,IAAA,iBAAS,EAAC,CAAC,CAAC,CAAC;QAC5E,OAAO,GAAG,CAAC;IACb,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,uBAAuB;QAC3B,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,OAAO,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;QACrF,MAAM,GAAG,GAA2B,EAAE,CAAC;QACvC,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACjE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yHAAyH;IACzH,KAAK,CAAC,iBAAiB,CAAC,MAAmB,EAAE,KAAc;QACzD,MAAM,MAAM,CAAC,cAAc,EAAE,CAAC;QAC9B,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI,KAAiC,CAAC;YACtC,MAAM,OAAO,GAAG,GAAG,EAAE;gBACnB,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBAChC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAC7B,IAAI,KAAK;oBAAE,YAAY,CAAC,KAAK,CAAC,CAAC;YACjC,CAAC,CAAC;YACF,MAAM,MAAM,GAAG,CAAC,CAAoC,EAAE,EAAE;gBACtD,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,EAAE;oBAAE,OAAO;gBAChC,OAAO,EAAE,CAAC;gBACV,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;YACzB,CAAC,CAAC;YACF,MAAM,MAAM,GAAG,CAAC,CAA0C,EAAE,EAAE;gBAC5D,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,EAAE;oBAAE,OAAO;gBAChC,OAAO,EAAE,CAAC;gBACV,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;YACpC,CAAC,CAAC;YACF,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YAC/B,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC5B,IAAI,KAAK,EAAE,CAAC;gBACV,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;oBACtB,OAAO,EAAE,CAAC;oBACV,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,EAAE,0BAA0B,KAAK,KAAK,CAAC,CAAC,CAAC;gBACxE,CAAC,EAAE,KAAK,CAAC,CAAC;YACZ,CAAC;YACD,6EAA6E;YAC7E,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;gBACjE,IAAI,KAAK,KAAK,WAAW,IAAI,KAAK,KAAK,QAAQ;oBAAE,OAAO;gBACxD,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,OAAO,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;gBACxF,IAAI,KAAK,KAAK,WAAW;oBAAE,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,WAAW,EAAE,IAAA,iBAAS,EAAC,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,EAAE,CAAC,CAAC;;oBAC5F,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;YAClE,CAAC,EAAE,MAAM,CAAC,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM;QACJ,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;IACJ,CAAC;CACF;AA5MD,kBA4MC;AAED,SAAS,QAAQ,CAAC,GAAW;IAC3B,MAAM,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC/B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAA,mBAAW,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;AAC7E,CAAC"}

package/dist/core/queue/queue.d.ts

@@ -0,0 +1,152 @@
+import { EventEmitter } from 'node:events';
+import { SnugKvClient, SnugKvClientOptions } from '../client';
+import { Arg } from '../resp';
+import { Job } from './job';
+import { JobsOptions, JobState, JobType, QueueLike, toJson } from './types';
+export interface QueueOptions {
+    /** Share an existing client. It is not closed with the queue. */
+    client?: SnugKvClient;
+    /** Or give connection settings; the queue then owns and closes its client. */
+    connection?: SnugKvClientOptions;
+    /** Key prefix. Default `snugq`. All services using one queue must agree on it. */
+    prefix?: string;
+    /** Options merged into every `add`. */
+    defaultJobOptions?: JobsOptions;
+}
+export interface RepeatOptions {
+    /** Repeat every N ms (computed on the server). */
+    every?: number;
+    /** Cron pattern with 5 fields, or 6 with seconds first. */
+    pattern?: string;
+    /** IANA time zone for the pattern. Default UTC. */
+    tz?: string;
+    /** Stop after this many runs. */
+    limit?: number;
+    /** Stop after this time. */
+    endDate?: number | Date;
+}
+export interface JobTemplate<D = any> {
+    name?: string;
+    data?: D;
+    opts?: JobsOptions;
+}
+export interface JobScheduler {
+    id: string;
+    name: string;
+    every?: number;
+    pattern?: string;
+    tz?: string;
+    limit?: number;
+    endDate?: number;
+    /** Runs created so far. */
+    count: number;
+    /** When the next run is due (ms since epoch). */
+    next: number;
+    template: {
+        name: string;
+        data: any;
+        opts: JobsOptions;
+    };
+}
+export type JobCounts = Record<JobType, number>;
+/** Builds the stored job from what we sent, so `add` needs no second round trip. */
+export declare function localJob(q: QueueLike, id: string, name: string, data: unknown, opts: JobsOptions, parent?: {
+    base: string;
+    id: string;
+}): Job;
+/**
+ * A named queue of jobs. Producers call `add`; a {@link Worker} processes the jobs;
+ * {@link QueueEvents} reports what happens. Needs a SnugKV server with the built-in functions on.
+ */
+export declare class Queue<D = any, R = any> extends EventEmitter implements QueueLike {
+    readonly name: string;
+    readonly client: SnugKvClient;
+    readonly base: string;
+    readonly prefix: string;
+    private readonly owns;
+    private readyPromise?;
+    private readonly defaults;
+    constructor(name: string, options?: QueueOptions);
+    ready(): Promise<void>;
+    fcall(fn: string, ...args: Arg[]): Promise<any>;
+    private fcallRo;
+    add(name: string, data: D, opts?: JobsOptions): Promise<Job<D, R>>;
+    /** Adds many jobs in one round trip. Not atomic: each job is added on its own. */
+    addBulk(jobs: Array<{
+        name: string;
+        data: D;
+        opts?: JobsOptions;
+    }>): Promise<Array<Job<D, R>>>;
+    /** Base key of another queue with the same prefix. */
+    baseOf(queueName: string): string;
+    /**
+     * Creates or replaces a repeatable job. `every` repeats on the server; `pattern` (cron) is
+     * computed by the workers, so keep at least one worker running. Returns true when the first run was created.
+     */
+    upsertJobScheduler(id: string, repeat: RepeatOptions, template?: JobTemplate<D>): Promise<boolean>;
+    removeJobScheduler(id: string): Promise<boolean>;
+    getJobSchedulers(start?: number, end?: number): Promise<JobScheduler[]>;
+    getJob(id: string): Promise<Job<D, R> | null>;
+    getJobState(id: string): Promise<JobState>;
+    /** Jobs in the given states. Lists are in processing order; sorted sets by time or priority. */
+    getJobs(types?: JobType | JobType[], start?: number, end?: number, asc?: boolean): Promise<Array<Job<D, R>>>;
+    getWaiting: (start?: number, end?: number) => Promise<Job<D, R>[]>;
+    getActive: (start?: number, end?: number) => Promise<Job<D, R>[]>;
+    getDelayed: (start?: number, end?: number) => Promise<Job<D, R>[]>;
+    getPrioritized: (start?: number, end?: number) => Promise<Job<D, R>[]>;
+    getWaitingChildren: (start?: number, end?: number) => Promise<Job<D, R>[]>;
+    getCompleted: (start?: number, end?: number) => Promise<Job<D, R>[]>;
+    getFailed: (start?: number, end?: number) => Promise<Job<D, R>[]>;
+    getJobCounts(...types: JobType[]): Promise<Partial<JobCounts>>;
+    getJobCountByTypes(...types: JobType[]): Promise<number>;
+    /** Jobs that still wait to run: waiting, paused, delayed and prioritized. */
+    count(): Promise<number>;
+    getJobLogs(id: string, start?: number, end?: number): Promise<{
+        logs: string[];
+        count: number;
+    }>;
+    /** Completed or failed jobs per minute, newest last. */
+    getMetrics(type: 'completed' | 'failed', minutes?: number): Promise<{
+        count: number;
+        data: number[];
+        minute: number;
+    }>;
+    pause(): Promise<void>;
+    resume(): Promise<void>;
+    isPaused(): Promise<boolean>;
+    /** Total jobs processed at the same time across all workers. */
+    setGlobalConcurrency(n: number): Promise<void>;
+    removeGlobalConcurrency(): Promise<void>;
+    getGlobalConcurrency(): Promise<number | null>;
+    /** At most `max` jobs start per `duration` ms across all workers. */
+    setRateLimit(limit: {
+        max: number;
+        duration: number;
+    }): Promise<void>;
+    removeRateLimit(): Promise<void>;
+    /** Stop all workers from starting jobs for `ms` ms. */
+    rateLimit(ms: number): Promise<void>;
+    getRateLimitTtl(): Promise<number>;
+    remove(id: string): Promise<boolean>;
+    /** Removes waiting and prioritized (and delayed, if asked) jobs. Returns how many. */
+    drain(includeDelayed?: boolean): Promise<number>;
+    /** Removes jobs older than `graceMs`. Returns their ids. `limit` 0 means all. */
+    clean(graceMs: number, limit: number, type?: Exclude<JobType, 'active'>): Promise<string[]>;
+    /** Puts failed (or completed) jobs back in the queue. Returns how many. */
+    retryJobs(opts?: {
+        state?: 'failed' | 'completed';
+        count?: number;
+        resetAttemptsMade?: boolean;
+    }): Promise<number>;
+    /** Runs delayed jobs now. Returns how many. */
+    promoteJobs(count?: number): Promise<number>;
+    /** Deletes the queue and all its jobs. Refuses while jobs are active, unless `force`. */
+    obliterate(opts?: {
+        force?: boolean;
+        count?: number;
+    }): Promise<void>;
+    /** Names of all queues that have had jobs, under a prefix. */
+    static list(client: SnugKvClient, prefix?: string): Promise<string[]>;
+    close(): Promise<void>;
+}
+export { toJson };