pg-boss 12.4.0 → 12.5.0

package/dist/index.js

@@ -0,0 +1,239 @@
+import EventEmitter from 'node:events';
+import * as Attorney from "./attorney.js";
+import Contractor from "./contractor.js";
+import Manager from "./manager.js";
+import Timekeeper from "./timekeeper.js";
+import Boss from "./boss.js";
+import { delay } from "./tools.js";
+import DbDefault from "./db.js";
+export { JOB_STATES as states } from "./plans.js";
+export { QUEUE_POLICIES as policies } from "./plans.js";
+export const events = Object.freeze({
+    error: 'error',
+    warning: 'warning',
+    wip: 'wip',
+    stopped: 'stopped'
+});
+export function getConstructionPlans(schema) {
+    return Contractor.constructionPlans(schema);
+}
+export function getMigrationPlans(schema, version) {
+    return Contractor.migrationPlans(schema, version);
+}
+export function getRollbackPlans(schema, version) {
+    return Contractor.rollbackPlans(schema, version);
+}
+export class PgBoss extends EventEmitter {
+    #stoppingOn;
+    #stopped;
+    #starting;
+    #started;
+    #config;
+    #db;
+    #boss;
+    #contractor;
+    #manager;
+    #timekeeper;
+    constructor(value) {
+        super();
+        this.#stoppingOn = null;
+        this.#stopped = true;
+        const config = Attorney.getConfig(value);
+        this.#config = config;
+        const db = this.getDb();
+        this.#db = db;
+        if ('_pgbdb' in this.#db && this.#db._pgbdb) {
+            this.#promoteEvents(this.#db);
+        }
+        const contractor = new Contractor(db, config);
+        const manager = new Manager(db, config);
+        const boss = new Boss(db, manager, config);
+        const timekeeper = new Timekeeper(db, manager, config);
+        manager.timekeeper = timekeeper;
+        this.#promoteEvents(manager);
+        this.#promoteEvents(boss);
+        this.#promoteEvents(timekeeper);
+        this.#boss = boss;
+        this.#contractor = contractor;
+        this.#manager = manager;
+        this.#timekeeper = timekeeper;
+    }
+    #promoteEvents(emitter) {
+        for (const event of Object.values(emitter?.events)) {
+            emitter.on(event, arg => this.emit(event, arg));
+        }
+    }
+    async start() {
+        if (this.#starting || this.#started) {
+            return this;
+        }
+        this.#starting = true;
+        if (this.#db._pgbdb && !this.#db.opened) {
+            await this.#db.open();
+        }
+        if (this.#config.migrate) {
+            await this.#contractor.start();
+        }
+        else {
+            await this.#contractor.check();
+        }
+        await this.#manager.start();
+        if (this.#config.supervise) {
+            await this.#boss.start();
+        }
+        if (this.#config.schedule) {
+            await this.#timekeeper.start();
+        }
+        this.#starting = false;
+        this.#started = true;
+        this.#stopped = false;
+        return this;
+    }
+    async stop(options = {}) {
+        if (this.#stoppingOn || this.#stopped) {
+            return;
+        }
+        let { close = true, graceful = true, timeout = 30000 } = options;
+        timeout = Math.max(timeout, 1000);
+        this.#stoppingOn = Date.now();
+        await this.#manager.stop();
+        await this.#timekeeper.stop();
+        await this.#boss.stop();
+        const shutdown = async () => {
+            await this.#manager.failWip();
+            if (this.#db._pgbdb && this.#db.opened && close) {
+                await this.#db.close();
+                // Give event loop time to process socket closes
+                await delay(10);
+            }
+            this.#stopped = true;
+            this.#stoppingOn = null;
+            this.#started = false;
+            this.emit(events.stopped);
+        };
+        if (!graceful) {
+            return await shutdown();
+        }
+        while ((Date.now() - this.#stoppingOn) < timeout && this.#manager.hasPendingCleanups()) {
+            await delay(500);
+        }
+        await shutdown();
+    }
+    async send(...args) {
+        return await this.#manager.send(...args);
+    }
+    async sendAfter(name, data, options, after) {
+        return this.#manager.sendAfter(name, data, options, after);
+    }
+    sendThrottled(name, data, options, seconds, key) {
+        return this.#manager.sendThrottled(name, data, options, seconds, key);
+    }
+    sendDebounced(name, data, options, seconds, key) {
+        return this.#manager.sendDebounced(name, data, options, seconds, key);
+    }
+    insert(name, jobs, options) {
+        return this.#manager.insert(name, jobs, options);
+    }
+    fetch(name, options = {}) {
+        return this.#manager.fetch(name, options);
+    }
+    work(...args) {
+        return this.#manager.work(...args);
+    }
+    offWork(name, options) {
+        return this.#manager.offWork(name, options);
+    }
+    notifyWorker(workerId) {
+        return this.#manager.notifyWorker(workerId);
+    }
+    subscribe(event, name) {
+        return this.#manager.subscribe(event, name);
+    }
+    unsubscribe(event, name) {
+        return this.#manager.unsubscribe(event, name);
+    }
+    publish(event, data, options) {
+        return this.#manager.publish(event, data, options);
+    }
+    cancel(name, id, options) {
+        return this.#manager.cancel(name, id, options);
+    }
+    resume(name, id, options) {
+        return this.#manager.resume(name, id, options);
+    }
+    retry(name, id, options) {
+        return this.#manager.retry(name, id, options);
+    }
+    deleteJob(name, id, options) {
+        return this.#manager.deleteJob(name, id, options);
+    }
+    deleteQueuedJobs(name) {
+        return this.#manager.deleteQueuedJobs(name);
+    }
+    deleteStoredJobs(name) {
+        return this.#manager.deleteStoredJobs(name);
+    }
+    deleteAllJobs(name) {
+        return this.#manager.deleteAllJobs(name);
+    }
+    complete(name, id, data, options) {
+        return this.#manager.complete(name, id, data, options);
+    }
+    fail(name, id, data, options) {
+        return this.#manager.fail(name, id, data, options);
+    }
+    getJobById(name, id, options) {
+        return this.#manager.getJobById(name, id, options);
+    }
+    createQueue(name, options) {
+        return this.#manager.createQueue(name, options);
+    }
+    updateQueue(name, options) {
+        return this.#manager.updateQueue(name, options);
+    }
+    deleteQueue(name) {
+        return this.#manager.deleteQueue(name);
+    }
+    getQueues(names) {
+        return this.#manager.getQueues();
+    }
+    getQueue(name) {
+        return this.#manager.getQueue(name);
+    }
+    getQueueStats(name) {
+        return this.#manager.getQueueStats(name);
+    }
+    supervise(name) {
+        return this.#boss.supervise(name);
+    }
+    getSpy(name) {
+        return this.#manager.getSpy(name);
+    }
+    clearSpies() {
+        this.#manager.clearSpies();
+    }
+    isInstalled() {
+        return this.#contractor.isInstalled();
+    }
+    schemaVersion() {
+        return this.#contractor.schemaVersion();
+    }
+    schedule(name, cron, data, options) {
+        return this.#timekeeper.schedule(name, cron, data, options);
+    }
+    unschedule(name, key) {
+        return this.#timekeeper.unschedule(name, key);
+    }
+    getSchedules(name, key) {
+        return this.#timekeeper.getSchedules(name, key);
+    }
+    getDb() {
+        if (this.#db) {
+            return this.#db;
+        }
+        if (this.#config.db) {
+            return this.#config.db;
+        }
+        return new DbDefault(this.#config);
+    }
+}

package/dist/manager.d.ts

@@ -0,0 +1,89 @@
+import EventEmitter from 'node:events';
+import type Db from './db.ts';
+import type Timekeeper from './timekeeper.ts';
+import * as types from './types.ts';
+import Worker from './worker.ts';
+import { type JobSpyInterface } from './spy.ts';
+declare class Manager extends EventEmitter implements types.EventsMixin {
+    #private;
+    events: {
+        error: string;
+        wip: string;
+    };
+    db: (types.IDatabase & {
+        _pgbdb?: false;
+    }) | Db;
+    config: types.ResolvedConstructorOptions;
+    wipTs: number;
+    workers: Map<string, Worker>;
+    stopped: boolean | undefined;
+    queueCacheInterval: NodeJS.Timeout | undefined;
+    timekeeper: Timekeeper | undefined;
+    queues: Record<string, types.QueueResult> | null;
+    pendingOffWorkCleanups: Set<Promise<any>>;
+    constructor(db: types.IDatabase, config: types.ResolvedConstructorOptions);
+    getSpy<T = object>(name: string): JobSpyInterface<T>;
+    clearSpies(): void;
+    start(): Promise<void>;
+    onCacheQueues({ emit }?: {
+        emit?: boolean | undefined;
+    }): Promise<void>;
+    getQueueCache(name: string): Promise<types.QueueResult>;
+    stop(): Promise<void>;
+    failWip(): Promise<void>;
+    work<ReqData>(name: string, handler: types.WorkHandler<ReqData>): Promise<string>;
+    work<ReqData>(name: string, options: types.WorkOptions & {
+        includeMetadata: true;
+    }, handler: types.WorkWithMetadataHandler<ReqData>): Promise<string>;
+    work<ReqData>(name: string, options: types.WorkOptions, handler: types.WorkHandler<ReqData>): Promise<string>;
+    private addWorker;
+    private removeWorker;
+    private getWorkers;
+    private emitWip;
+    getWipData(options?: {
+        includeInternal?: boolean;
+    }): types.WipData[];
+    hasPendingCleanups(): boolean;
+    offWork(name: string, options?: types.OffWorkOptions): Promise<void>;
+    notifyWorker(workerId: string): void;
+    subscribe(event: string, name: string): Promise<void>;
+    unsubscribe(event: string, name: string): Promise<void>;
+    publish(event: string, data?: object, options?: types.SendOptions): Promise<void>;
+    send(request: types.Request): Promise<string | null>;
+    send(name: string, data?: object | null, options?: types.SendOptions | null): Promise<string | null>;
+    sendAfter(name: string, data: object | null, options: types.SendOptions | null, after: Date | string | number): Promise<string | null>;
+    sendThrottled(name: string, data: object | null, options: types.SendOptions | null, seconds: number, key?: string): Promise<string | null>;
+    sendDebounced(name: string, data: object | null, options: types.SendOptions | null, seconds: number, key?: string): Promise<string | null>;
+    createJob(request: types.Request): Promise<string | null>;
+    insert(name: string, jobs: types.JobInsert[], options?: types.InsertOptions): Promise<string[] | null>;
+    getDebounceStartAfter(singletonSeconds: number, clockOffset: number): number;
+    fetch<T>(name: string): Promise<types.Job<T>[]>;
+    fetch<T>(name: string, options: types.FetchOptions & {
+        includeMetadata: true;
+    }): Promise<types.JobWithMetadata<T>[]>;
+    fetch<T>(name: string, options: types.FetchOptions): Promise<types.Job<T>[]>;
+    private mapCompletionIdArg;
+    private mapCompletionDataArg;
+    private mapCommandResponse;
+    complete(name: string, id: string | string[], data?: object | null, options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    fail(name: string, id: string | string[], data?: any, options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    cancel(name: string, id: string | string[], options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    deleteJob(name: string, id: string | string[], options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    resume(name: string, id: string | string[], options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    retry(name: string, id: string | string[], options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    createQueue(name: string, options?: Omit<types.Queue, 'name'> & {
+        name?: string;
+    }): Promise<void>;
+    getQueues(names?: string | string[]): Promise<types.QueueResult[]>;
+    updateQueue(name: string, options?: types.UpdateQueueOptions): Promise<void>;
+    getQueue(name: string): Promise<any>;
+    deleteQueue(name: string): Promise<void>;
+    deleteQueuedJobs(name: string): Promise<void>;
+    deleteStoredJobs(name: string): Promise<void>;
+    deleteAllJobs(name?: string): Promise<void>;
+    getQueueStats(name: string): Promise<any>;
+    getJobById<T>(name: string, id: string, options?: types.ConnectionOptions): Promise<types.JobWithMetadata<T> | null>;
+    private assertDb;
+}
+export default Manager;
+//# sourceMappingURL=manager.d.ts.map

package/dist/manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manager.d.ts","sourceRoot":"","sources":["../src/manager.ts"],"names":[],"mappings":"AAEA,OAAO,YAAY,MAAM,aAAa,CAAA;AAGtC,OAAO,KAAK,EAAE,MAAM,SAAS,CAAA;AAE7B,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAG7C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,EAAU,KAAK,eAAe,EAAE,MAAM,UAAU,CAAA;AASvD,cAAM,OAAQ,SAAQ,YAAa,YAAW,KAAK,CAAC,WAAW;;IAC7D,MAAM;;;MAAS;IACf,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,GAAG;QAAE,MAAM,CAAC,EAAE,KAAK,CAAA;KAAE,CAAC,GAAG,EAAE,CAAA;IAC/C,MAAM,EAAE,KAAK,CAAC,0BAA0B,CAAA;IACxC,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5B,OAAO,EAAE,OAAO,GAAG,SAAS,CAAA;IAC5B,kBAAkB,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAA;IAC9C,UAAU,EAAE,UAAU,GAAG,SAAS,CAAA;IAClC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAA;IAChD,sBAAsB,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;gBAG5B,EAAE,EAAE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,0BAA0B;IAY1E,MAAM,CAAC,CAAC,GAAG,MAAM,EAAG,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC;IAYrD,UAAU,IAAK,IAAI;IAOb,KAAK;IAML,aAAa,CAAE,EAAE,IAAY,EAAE;;KAAK;IAUpC,aAAa,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC;IAoBxD,IAAI;IAYJ,OAAO;IASb,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IACjF,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,GAAG;QAAE,eAAe,EAAE,IAAI,CAAA;KAAE,EAAE,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IACrJ,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IA8E7G,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,OAAO;IAWf,UAAU,CAAE,OAAO,GAAE;QAAE,eAAe,CAAC,EAAE,OAAO,CAAA;KAAO;IAUvD,kBAAkB,IAAK,OAAO;IAIxB,OAAO,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,KAAK,CAAC,cAA+B,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B3F,YAAY,CAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAI/B,SAAS,CAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOtD,WAAW,CAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO9D,OAAO,CAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASlF,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IACrD,IAAI,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAO/F,SAAS,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IASvI,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAW3I,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAW3I,SAAS,CAAE,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAgF1D,MAAM,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,OAAO,GAAE,KAAK,CAAC,aAAkB;IA4BtF,qBAAqB,CAAE,gBAAgB,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IAiBpE,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/C,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,YAAY,GAAG;QAAE,eAAe,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;IACpH,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IA+B5E,OAAO,CAAC,kBAAkB;IAY1B,OAAO,CAAC,oBAAoB;IAU5B,OAAO,CAAC,kBAAkB;IAQpB,QAAQ,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,GAAE,KAAK,CAAC,iBAAsB;IAU1G,IAAI,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,OAAO,GAAE,KAAK,CAAC,iBAAsB;IAU5F,MAAM,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,GAAE,KAAK,CAAC,iBAAsB;IAUlF,SAAS,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,GAAE,KAAK,CAAC,iBAAsB;IAUrF,MAAM,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,GAAE,KAAK,CAAC,iBAAsB;IAUlF,KAAK,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,GAAE,KAAK,CAAC,iBAAsB;IAUjF,WAAW,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO;IAqBtF,SAAS,CAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAanE,WAAW,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,KAAK,CAAC,kBAAuB;IA0BjE,QAAQ,CAAE,IAAI,EAAE,MAAM;IAStB,WAAW,CAAE,IAAI,EAAE,MAAM;IAUzB,gBAAgB,CAAE,IAAI,EAAE,MAAM;IAO9B,gBAAgB,CAAE,IAAI,EAAE,MAAM;IAO9B,aAAa,CAAE,IAAI,CAAC,EAAE,MAAM;IAmB5B,aAAa,CAAE,IAAI,EAAE,MAAM;IAY3B,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,KAAK,CAAC,iBAAsB,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAkB9H,OAAO,CAAC,QAAQ;CAWjB;AAED,eAAe,OAAO,CAAA"}