velocious 1.0.176 → 1.0.178

package/build/src/background-jobs/store.d.ts

@@ -0,0 +1,237 @@
+export default class BackgroundJobsStore {
+    /**
+     * @param {object} args - Options.
+     * @param {import("../configuration.js").default} args.configuration - Configuration.
+     * @param {string} [args.databaseIdentifier] - Database identifier.
+     */
+    constructor({ configuration, databaseIdentifier }: {
+        configuration: import("../configuration.js").default;
+        databaseIdentifier?: string;
+    });
+    configuration: import("../configuration.js").default;
+    databaseIdentifier: string;
+    logger: Logger;
+    _readyPromise: Promise<void>;
+    /**
+     * @returns {string} - Database identifier.
+     */
+    getDatabaseIdentifier(): string;
+    /**
+     * @returns {Promise<void>} - Resolves when ready.
+     */
+    ensureReady(): Promise<void>;
+    /**
+     * @param {object} args - Options.
+     * @param {string} args.jobName - Job name.
+     * @param {any[]} args.args - Arguments.
+     * @param {import("./types.js").BackgroundJobOptions} [args.options] - Options.
+     * @returns {Promise<string>} - Job id.
+     */
+    enqueue({ jobName, args, options }: {
+        jobName: string;
+        args: any[];
+        options?: import("./types.js").BackgroundJobOptions;
+    }): Promise<string>;
+    /**
+     * @returns {Promise<import("./store.js").BackgroundJobRow | null>} - Next job.
+     */
+    nextAvailableJob(): Promise<import("./store.js").BackgroundJobRow | null>;
+    /**
+     * @param {string} jobId - Job id.
+     * @returns {Promise<import("./store.js").BackgroundJobRow | null>} - Job row.
+     */
+    getJob(jobId: string): Promise<import("./store.js").BackgroundJobRow | null>;
+    /**
+     * @param {object} args - Options.
+     * @param {string} args.jobId - Job id.
+     * @param {string} [args.workerId] - Worker id.
+     * @returns {Promise<number>} - Resolves with handed off timestamp.
+     */
+    markHandedOff({ jobId, workerId }: {
+        jobId: string;
+        workerId?: string;
+    }): Promise<number>;
+    /**
+     * @param {object} args - Options.
+     * @param {string} args.jobId - Job id.
+     * @param {string} [args.workerId] - Worker id.
+     * @param {number} [args.handedOffAtMs] - Handed off timestamp.
+     * @returns {Promise<void>} - Resolves when updated.
+     */
+    markCompleted({ jobId, workerId, handedOffAtMs }: {
+        jobId: string;
+        workerId?: string;
+        handedOffAtMs?: number;
+    }): Promise<void>;
+    /**
+     * @param {object} args - Options.
+     * @param {string} args.jobId - Job id.
+     * @returns {Promise<void>} - Resolves when updated.
+     */
+    markReturnedToQueue({ jobId }: {
+        jobId: string;
+    }): Promise<void>;
+    /**
+     * @param {object} args - Options.
+     * @param {string} args.jobId - Job id.
+     * @param {unknown} args.error - Error.
+     * @param {string} [args.workerId] - Worker id.
+     * @param {number} [args.handedOffAtMs] - Handed off timestamp.
+     * @returns {Promise<void>} - Resolves when updated.
+     */
+    markFailed({ jobId, error, workerId, handedOffAtMs }: {
+        jobId: string;
+        error: unknown;
+        workerId?: string;
+        handedOffAtMs?: number;
+    }): Promise<void>;
+    /**
+     * @param {object} [args] - Options.
+     * @param {number} [args.orphanedAfterMs] - Mark jobs orphaned after this duration.
+     * @returns {Promise<number>} - Count of orphaned jobs.
+     */
+    markOrphanedJobs({ orphanedAfterMs }?: {
+        orphanedAfterMs?: number;
+    }): Promise<number>;
+    /**
+     * @returns {Promise<void>} - Resolves when cleared.
+     */
+    clearAll(): Promise<void>;
+    /**
+     * @param {number} retryCount - Retry attempt count (1-based).
+     * @returns {number} - Delay in milliseconds.
+     */
+    getRetryDelayMs(retryCount: number): number;
+    /**
+     * @param {number | undefined} maxRetries - Input.
+     * @returns {number} - Normalized max retries.
+     */
+    _normalizeMaxRetries(maxRetries: number | undefined): number;
+    _ensureSchema(): Promise<void>;
+    _ensureMigrationsTable(db: any): Promise<void>;
+    _hasMigration(db: any): Promise<boolean>;
+    _applyMigrations(db: any): Promise<void>;
+    _initializeModel(): Promise<void>;
+    _getJobRowById(db: any, jobId: any): Promise<{
+        id: string;
+        jobName: string;
+        args: any[];
+        forked: boolean;
+        status: string;
+        attempts: number;
+        maxRetries: number;
+        scheduledAtMs: number;
+        createdAtMs: number;
+        handedOffAtMs: number;
+        completedAtMs: number;
+        failedAtMs: number;
+        orphanedAtMs: number;
+        workerId: string;
+        lastError: string;
+    }>;
+    _applyFailure({ db, job, error, markOrphaned }: {
+        db: any;
+        job: any;
+        error: any;
+        markOrphaned: any;
+    }): Promise<void>;
+    _normalizeJobRow(row: any): {
+        id: string;
+        jobName: string;
+        args: any[];
+        forked: boolean;
+        status: string;
+        attempts: number;
+        maxRetries: number;
+        scheduledAtMs: number;
+        createdAtMs: number;
+        handedOffAtMs: number;
+        completedAtMs: number;
+        failedAtMs: number;
+        orphanedAtMs: number;
+        workerId: string;
+        lastError: string;
+    };
+    _normalizeNumber(value: any): number;
+    _normalizeBoolean(value: any): boolean;
+    _parseArgs(value: any): any[];
+    _normalizeError(error: any): string;
+    _withDb(callback: any): Promise<undefined>;
+    /**
+     * @param {object} args - Options.
+     * @param {import("./store.js").BackgroundJobRow} args.job - Job row.
+     * @param {string | null | undefined} args.workerId - Worker id from report.
+     * @param {number | null | undefined} args.handedOffAtMs - Handed off timestamp from report.
+     * @returns {boolean} - Whether to accept the report.
+     */
+    _shouldAcceptReport({ job, workerId, handedOffAtMs }: {
+        job: import("./store.js").BackgroundJobRow;
+        workerId: string | null | undefined;
+        handedOffAtMs: number | null | undefined;
+    }): boolean;
+    _migrationKey(): string;
+}
+export type BackgroundJobRow = {
+    /**
+     * - Job id.
+     */
+    id: string;
+    /**
+     * - Job class name.
+     */
+    jobName: string;
+    /**
+     * - Serialized job arguments.
+     */
+    args: any[];
+    /**
+     * - Whether the job is forked.
+     */
+    forked: boolean;
+    /**
+     * - Current job status.
+     */
+    status: string;
+    /**
+     * - Failure attempts count.
+     */
+    attempts: number | null;
+    /**
+     * - Max retry attempts.
+     */
+    maxRetries: number | null;
+    /**
+     * - Next scheduled time in ms.
+     */
+    scheduledAtMs: number | null;
+    /**
+     * - Creation time in ms.
+     */
+    createdAtMs: number | null;
+    /**
+     * - Time handed to worker in ms.
+     */
+    handedOffAtMs: number | null;
+    /**
+     * - Completion time in ms.
+     */
+    completedAtMs: number | null;
+    /**
+     * - Failure time in ms.
+     */
+    failedAtMs: number | null;
+    /**
+     * - Orphaned time in ms.
+     */
+    orphanedAtMs: number | null;
+    /**
+     * - Worker id handling the job.
+     */
+    workerId: string | null;
+    /**
+     * - Last failure message.
+     */
+    lastError: string | null;
+};
+import { Logger } from "../logger.js";
+//# sourceMappingURL=store.d.ts.map

package/build/src/background-jobs/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../src/background-jobs/store.js"],"names":[],"mappings":"AAcA;IACE;;;;OAIG;IACH,mDAHG;QAAoD,aAAa,EAAzD,OAAO,qBAAqB,EAAE,OAAO;QACvB,kBAAkB,GAAhC,MAAM;KAChB,EAMA;IAJC,qDAAkC;IAClC,2BAA4C;IAC5C,eAA8B;IAC9B,6BAAyB;IAG3B;;OAEG;IACH,yBAFa,MAAM,CAMlB;IAED;;OAEG;IACH,eAFa,OAAO,CAAC,IAAI,CAAC,CAgBzB;IAED;;;;;;OAMG;IACH,oCALG;QAAqB,OAAO,EAApB,MAAM;QACM,IAAI,EAAhB,GAAG,EAAE;QAC4C,OAAO,GAAxD,OAAO,YAAY,EAAE,oBAAoB;KACjD,GAAU,OAAO,CAAC,MAAM,CAAC,CA6B3B;IAED;;OAEG;IACH,oBAFa,OAAO,CAAC,OAAO,YAAY,EAAE,gBAAgB,GAAG,IAAI,CAAC,CAuBjE;IAED;;;OAGG;IACH,cAHW,MAAM,GACJ,OAAO,CAAC,OAAO,YAAY,EAAE,gBAAgB,GAAG,IAAI,CAAC,CAmBjE;IAED;;;;;OAKG;IACH,mCAJG;QAAqB,KAAK,EAAlB,MAAM;QACQ,QAAQ,GAAtB,MAAM;KACd,GAAU,OAAO,CAAC,MAAM,CAAC,CAoB3B;IAED;;;;;;OAMG;IACH,kDALG;QAAqB,KAAK,EAAlB,MAAM;QACQ,QAAQ,GAAtB,MAAM;QACQ,aAAa,GAA3B,MAAM;KACd,GAAU,OAAO,CAAC,IAAI,CAAC,CAoBzB;IAED;;;;OAIG;IACH,+BAHG;QAAqB,KAAK,EAAlB,MAAM;KACd,GAAU,OAAO,CAAC,IAAI,CAAC,CAiBzB;IAED;;;;;;;OAOG;IACH,sDANG;QAAqB,KAAK,EAAlB,MAAM;QACQ,KAAK,EAAnB,OAAO;QACO,QAAQ,GAAtB,MAAM;QACQ,aAAa,GAA3B,MAAM;KACd,GAAU,OAAO,CAAC,IAAI,CAAC,CAazB;IAED;;;;OAIG;IACH,uCAHG;QAAsB,eAAe,GAA7B,MAAM;KACd,GAAU,OAAO,CAAC,MAAM,CAAC,CA4B3B;IAED;;OAEG;IACH,YAFa,OAAO,CAAC,IAAI,CAAC,CAQzB;IAED;;;OAGG;IACH,4BAHW,MAAM,GACJ,MAAM,CAUlB;IAED;;;OAGG;IACH,iCAHW,MAAM,GAAG,SAAS,GAChB,MAAM,CAQlB;IAED,+BAmBC;IAED,+CAWC;IAED,yCAUC;IAED,yCA2BC;IAED,kCAUC;IAED;;;;;;;;;;;;;;;;OAYC;IAED;;;;;sBAmCC;IAED;;;;;;;;;;;;;;;;MAkBC;IAED,qCAQC;IAED,uCAMC;IAED,8BAYC;IAED,oCASC;IAED,2CASC;IAED;;;;;;OAMG;IACH,sDALG;QAAoD,GAAG,EAA/C,OAAO,YAAY,EAAE,gBAAgB;QACL,QAAQ,EAAxC,MAAM,GAAG,IAAI,GAAG,SAAS;QACO,aAAa,EAA7C,MAAM,GAAG,IAAI,GAAG,SAAS;KACjC,GAAU,OAAO,CAUnB;IAED,wBAEC;CACF;;;;;QAIa,MAAM;;;;aACN,MAAM;;;;UACN,GAAG,EAAE;;;;YACL,OAAO;;;;YACP,MAAM;;;;cACN,MAAM,GAAG,IAAI;;;;gBACb,MAAM,GAAG,IAAI;;;;mBACb,MAAM,GAAG,IAAI;;;;iBACb,MAAM,GAAG,IAAI;;;;mBACb,MAAM,GAAG,IAAI;;;;mBACb,MAAM,GAAG,IAAI;;;;gBACb,MAAM,GAAG,IAAI;;;;kBACb,MAAM,GAAG,IAAI;;;;cACb,MAAM,GAAG,IAAI;;;;eACb,MAAM,GAAG,IAAI;;uBAziBN,cAAc"}