@spinajs/queue 2.0.481 → 2.0.482

package/lib/mjs/migrations/Queue_2026_07_17_00_00_00.js

@@ -0,0 +1,46 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { OrmMigration, Migration } from '@spinajs/orm';
+/**
+ * Widens `queue_jobs.Status` to the six states the code actually writes.
+ * `retrying` / `dead` arrived with retry support (see index.ts) but the enum
+ * was never widened, so strict-enum drivers reject or coerce them.
+ *
+ * NOT NULL and the 'created' default are restated deliberately: MySQL's MODIFY
+ * COLUMN replaces the whole definition and silently drops anything omitted.
+ * On sqlite this alteration is a logged no-op - it renders enum as
+ * unconstrained TEXT, so there is nothing to widen there.
+ */
+let Queue_2026_07_17_00_00_00 = class Queue_2026_07_17_00_00_00 extends OrmMigration {
+    async up(connection) {
+        // sqlite renders enum as unconstrained TEXT and has no MODIFY COLUMN, so there is
+        // nothing to widen there. Emitting the MODIFY anyway produces a MySQL-flavoured
+        // `ALTER TABLE ... MODIFY ... ENUM(...)` that sqlite rejects, so skip it explicitly
+        // ( mirrors the guard in Queue_2026_07_02, and matches this migration's documented
+        // "no-op on sqlite" contract above ).
+        const isSqlite = connection.Options.Driver.toLowerCase().includes('sqlite');
+        if (isSqlite) {
+            return;
+        }
+        await connection.schema().alterTable('queue_jobs', (table) => {
+            // `.default().value('created')` returns the ColumnQueryBuilder, which has no
+            // `.modify()` - that lives on AlterColumnQueryBuilder. So `.modify()` must be
+            // called on the column builder itself, separately from the default.
+            const status = table.enum('Status', ['error', 'success', 'created', 'executing', 'retrying', 'dead']).notNull();
+            status.default().value('created');
+            status.modify();
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async down(_connection) { }
+};
+Queue_2026_07_17_00_00_00 = __decorate([
+    Migration('queue')
+], Queue_2026_07_17_00_00_00);
+export { Queue_2026_07_17_00_00_00 };
+//# sourceMappingURL=Queue_2026_07_17_00_00_00.js.map

package/lib/mjs/migrations/Queue_2026_07_17_00_00_00.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Queue_2026_07_17_00_00_00.js","sourceRoot":"","sources":["../../../src/migrations/Queue_2026_07_17_00_00_00.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAsD;AACtD,OAAO,EAAE,YAAY,EAAa,SAAS,EAAE,MAAM,cAAc,CAAC;AAElE;;;;;;;;;GASG;AAEI,IAAM,yBAAyB,GAA/B,MAAM,yBAA0B,SAAQ,YAAY;IAClD,KAAK,CAAC,EAAE,CAAC,UAAqB;QACnC,kFAAkF;QAClF,gFAAgF;QAChF,oFAAoF;QACpF,mFAAmF;QACnF,sCAAsC;QACtC,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC5E,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QAED,MAAM,UAAU,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3D,6EAA6E;YAC7E,8EAA8E;YAC9E,oEAAoE;YACpE,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChH,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAClC,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gEAAgE;IACzD,KAAK,CAAC,IAAI,CAAC,WAAsB,IAAkB,CAAC;CAC5D,CAAA;AAxBY,yBAAyB;IADrC,SAAS,CAAC,OAAO,CAAC;GACN,yBAAyB,CAwBrC"}

package/lib/mjs/models/JobModel.d.ts

@@ -1,18 +1,80 @@
 import { DateTime } from 'luxon';
-import { ModelBase } from '@spinajs/orm';
+import { ModelBase, QueryScope, ISelectQueryBuilder } from '@spinajs/orm';
 /**
- * Base modele for users used by ACL
+ * Possible job lifecycle statuses.
+ * - created:   dispatched, not yet picked up
+ * - executing: currently running
+ * - retrying:  failed, will be retried
+ * - success:   finished ok ( terminal )
+ * - error:     legacy generic failure ( terminal )
+ * - dead:      failed and retries exhausted / dead-lettered ( terminal )
+ */
+export type JobStatus = 'created' | 'executing' | 'retrying' | 'success' | 'error' | 'dead';
+/** Statuses a job can no longer leave - safe to report as done / purge. */
+export declare const JOB_TERMINAL_STATUSES: JobStatus[];
+/** Statuses of jobs still in flight. */
+export declare const JOB_ACTIVE_STATUSES: JobStatus[];
+/**
+ * Reusable query scopes for {@link JobModel}. Available on any JobModel query
+ * ( select / update / destroy ), so callers compose readable, safe queries eg.
  *
+ *   await JobModel.destroy().terminal().olderThan(cutoff);
+ *   await JobModel.query().byJobId(id).first();
+ */
+export declare class JobQueryScopes implements QueryScope {
+    byJobId(this: ISelectQueryBuilder<JobModel[]> & JobQueryScopes, jobId: string): ISelectQueryBuilder<JobModel<unknown>[]> & JobQueryScopes;
+    withStatus(this: ISelectQueryBuilder<JobModel[]> & JobQueryScopes, status: JobStatus | JobStatus[]): ISelectQueryBuilder<JobModel<unknown>[]> & JobQueryScopes;
+    /** Jobs in a terminal state ( success / error / dead ). */
+    terminal(this: ISelectQueryBuilder<JobModel[]> & JobQueryScopes): ISelectQueryBuilder<JobModel<unknown>[]> & JobQueryScopes;
+    /** Jobs still in flight ( created / executing / retrying ). */
+    active(this: ISelectQueryBuilder<JobModel[]> & JobQueryScopes): ISelectQueryBuilder<JobModel<unknown>[]> & JobQueryScopes;
+    /** Jobs created before the given moment ( row age ). */
+    olderThan(this: ISelectQueryBuilder<JobModel[]> & JobQueryScopes, date: DateTime): ISelectQueryBuilder<JobModel<unknown>[]> & JobQueryScopes;
+    /** Jobs finished before the given moment. */
+    finishedBefore(this: ISelectQueryBuilder<JobModel[]> & JobQueryScopes, date: DateTime): ISelectQueryBuilder<JobModel<unknown>[]> & JobQueryScopes;
+}
+/**
+ * Tracks a dispatched job: its status, progress, result / error and timing.
+ * One row per emitted job, keyed by the unique {@link JobModel.JobId}.
  */
-export declare class JobModel<T> extends ModelBase {
+export declare class JobModel<T = unknown> extends ModelBase {
+    static readonly _queryScopes: JobQueryScopes;
     Id: number;
     JobId: string;
     Name: string;
+    /**
+     * The job's successful result. Failures are recorded in {@link JobModel.LastError},
+     * so this holds only the actual output.
+     */
     Result: T;
-    Status: 'error' | 'success' | 'created' | 'executing';
+    Status: JobStatus;
     Progress: number;
+    /**
+     * Optional human-facing progress phase (e.g. `loading`, `rendering`), set by
+     * jobs that report richer progress than a bare percentage. Nullable.
+     */
+    Phase: string;
+    /**
+     * Optional human-facing progress message accompanying {@link Phase}. Nullable.
+     */
+    Message: string;
+    /**
+     * Number of times job execution has been attempted. Incremented on every failed run.
+     * Once it reaches {@link JobModel.MaxAttempts} the job is marked as `dead`.
+     */
+    Attempt: number;
+    /**
+     * Total allowed executions for the job ( RetryCount + 1 ) captured at first receipt.
+     * Lets consumers render `Attempt / MaxAttempts` ( e.g. "attempt 2 of 2" ).
+     */
+    MaxAttempts: number;
+    /**
+     * Last error message when the job failed or was retried. Kept separate from Result.
+     */
+    LastError: string;
     Connection: string;
     CreatedAt: DateTime;
+    UpdatedAt: DateTime;
     ExecutedAt: DateTime;
     FinishedAt: DateTime;
 }

package/lib/mjs/models/JobModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"JobModel.d.ts","sourceRoot":"","sources":["../../../src/models/JobModel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,SAAS,EAA+D,MAAM,cAAc,CAAC;AAEtG;;;GAGG;AACH,qBAEa,QAAQ,CAAC,CAAC,CAAE,SAAQ,SAAS;IAEjC,EAAE,EAAE,MAAM,CAAC;IAEX,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;IAGb,MAAM,EAAE,CAAC,CAAC;IAEV,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;IAEtD,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAGnB,SAAS,EAAE,QAAQ,CAAC;IAGpB,UAAU,EAAE,QAAQ,CAAC;IAGrB,UAAU,EAAE,QAAQ,CAAC;CAC7B"}
+{"version":3,"file":"JobModel.d.ts","sourceRoot":"","sources":["../../../src/models/JobModel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,SAAS,EAA0E,UAAU,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAElJ;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;AAE5F,2EAA2E;AAC3E,eAAO,MAAM,qBAAqB,EAAE,SAAS,EAAiC,CAAC;AAE/E,wCAAwC;AACxC,eAAO,MAAM,mBAAmB,EAAE,SAAS,EAAyC,CAAC;AAErF;;;;;;GAMG;AACH,qBAAa,cAAe,YAAW,UAAU;IACxC,OAAO,CAAC,IAAI,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,GAAG,cAAc,EAAE,KAAK,EAAE,MAAM;IAI7E,UAAU,CAAC,IAAI,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,GAAG,cAAc,EAAE,MAAM,EAAE,SAAS,GAAG,SAAS,EAAE;IAIzG,2DAA2D;IACpD,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,GAAG,cAAc;IAItE,+DAA+D;IACxD,MAAM,CAAC,IAAI,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,GAAG,cAAc;IAIpE,wDAAwD;IACjD,SAAS,CAAC,IAAI,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,GAAG,cAAc,EAAE,IAAI,EAAE,QAAQ;IAIvF,6CAA6C;IACtC,cAAc,CAAC,IAAI,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,GAAG,cAAc,EAAE,IAAI,EAAE,QAAQ;CAG7F;AAED;;;GAGG;AACH,qBAEa,QAAQ,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,SAAS;IAClD,gBAAuB,YAAY,EAAE,cAAc,CAAwB;IAGpE,EAAE,EAAE,MAAM,CAAC;IAEX,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IAEI,MAAM,EAAE,CAAC,CAAC;IAEV,MAAM,EAAE,SAAS,CAAC;IAElB,QAAQ,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACI,KAAK,EAAE,MAAM,CAAC;IAErB;;OAEG;IACI,OAAO,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACI,OAAO,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACI,WAAW,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACI,SAAS,EAAE,MAAM,CAAC;IAElB,UAAU,EAAE,MAAM,CAAC;IAGnB,SAAS,EAAE,QAAQ,CAAC;IAGpB,SAAS,EAAE,QAAQ,CAAC;IAGpB,UAAU,EAAE,QAAQ,CAAC;IAGrB,UAAU,EAAE,QAAQ,CAAC;CAC7B"}

package/lib/mjs/models/JobModel.js

@@ -8,13 +8,49 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 import { DateTime } from 'luxon';
-import { ModelBase, Connection, Model, Json, CreatedAt, DateTime as DT, Primary } from '@spinajs/orm';
+import { ModelBase, Connection, Model, Json, CreatedAt, UpdatedAt, DateTime as DT, Primary } from '@spinajs/orm';
+/** Statuses a job can no longer leave - safe to report as done / purge. */
+export const JOB_TERMINAL_STATUSES = ['success', 'error', 'dead'];
+/** Statuses of jobs still in flight. */
+export const JOB_ACTIVE_STATUSES = ['created', 'executing', 'retrying'];
 /**
- * Base modele for users used by ACL
+ * Reusable query scopes for {@link JobModel}. Available on any JobModel query
+ * ( select / update / destroy ), so callers compose readable, safe queries eg.
  *
+ *   await JobModel.destroy().terminal().olderThan(cutoff);
+ *   await JobModel.query().byJobId(id).first();
+ */
+export class JobQueryScopes {
+    byJobId(jobId) {
+        return this.where('JobId', jobId);
+    }
+    withStatus(status) {
+        return Array.isArray(status) ? this.whereIn('Status', status) : this.where('Status', status);
+    }
+    /** Jobs in a terminal state ( success / error / dead ). */
+    terminal() {
+        return this.whereIn('Status', JOB_TERMINAL_STATUSES);
+    }
+    /** Jobs still in flight ( created / executing / retrying ). */
+    active() {
+        return this.whereIn('Status', JOB_ACTIVE_STATUSES);
+    }
+    /** Jobs created before the given moment ( row age ). */
+    olderThan(date) {
+        return this.where('CreatedAt', '<', date);
+    }
+    /** Jobs finished before the given moment. */
+    finishedBefore(date) {
+        return this.where('FinishedAt', '<', date);
+    }
+}
+/**
+ * Tracks a dispatched job: its status, progress, result / error and timing.
+ * One row per emitted job, keyed by the unique {@link JobModel.JobId}.
  */
 let JobModel = class JobModel extends ModelBase {
 };
+JobModel._queryScopes = new JobQueryScopes();
 __decorate([
     Primary(),
     __metadata("design:type", Number)
@@ -27,6 +63,10 @@ __decorate([
     CreatedAt(),
     __metadata("design:type", DateTime)
 ], JobModel.prototype, "CreatedAt", void 0);
+__decorate([
+    UpdatedAt(),
+    __metadata("design:type", DateTime)
+], JobModel.prototype, "UpdatedAt", void 0);
 __decorate([
     DT(),
     __metadata("design:type", DateTime)

package/lib/mjs/models/JobModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"JobModel.js","sourceRoot":"","sources":["../../../src/models/JobModel.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEtG;;;GAGG;AAGI,IAAM,QAAQ,GAAd,MAAM,QAAY,SAAQ,SAAS;CAyBzC,CAAA;AAvBQ;IADN,OAAO,EAAE;;oCACQ;AAOX;IADN,IAAI,EAAE;;wCACU;AASV;IADN,SAAS,EAAE;8BACM,QAAQ;2CAAC;AAGpB;IADN,EAAE,EAAE;8BACc,QAAQ;4CAAC;AAGrB;IADN,EAAE,EAAE;8BACc,QAAQ;4CAAC;AAxBjB,QAAQ;IAFpB,UAAU,CAAC,OAAO,CAAC;IACnB,KAAK,CAAC,YAAY,CAAC;GACP,QAAQ,CAyBpB"}
+{"version":3,"file":"JobModel.js","sourceRoot":"","sources":["../../../src/models/JobModel.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,IAAI,EAAE,EAAE,OAAO,EAAmC,MAAM,cAAc,CAAC;AAalJ,2EAA2E;AAC3E,MAAM,CAAC,MAAM,qBAAqB,GAAgB,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAE/E,wCAAwC;AACxC,MAAM,CAAC,MAAM,mBAAmB,GAAgB,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;AAErF;;;;;;GAMG;AACH,MAAM,OAAO,cAAc;IAClB,OAAO,CAAyD,KAAa;QAClF,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAEM,UAAU,CAAyD,MAA+B;QACvG,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC/F,CAAC;IAED,2DAA2D;IACpD,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC;IACvD,CAAC;IAED,+DAA+D;IACxD,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;IACrD,CAAC;IAED,wDAAwD;IACjD,SAAS,CAAyD,IAAc;QACrF,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,6CAA6C;IACtC,cAAc,CAAyD,IAAc;QAC1F,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC7C,CAAC;CACF;AAED;;;GAGG;AAGI,IAAM,QAAQ,GAAd,MAAM,QAAsB,SAAQ,SAAS;;AAC3B,qBAAY,GAAmB,IAAI,cAAc,EAAE,AAAvC,CAAwC;AAGpE;IADN,OAAO,EAAE;;oCACQ;AAWX;IADN,IAAI,EAAE;;wCACU;AAqCV;IADN,SAAS,EAAE;8BACM,QAAQ;2CAAC;AAGpB;IADN,SAAS,EAAE;8BACM,QAAQ;2CAAC;AAGpB;IADN,EAAE,EAAE;8BACc,QAAQ;4CAAC;AAGrB;IADN,EAAE,EAAE;8BACc,QAAQ;4CAAC;AA7DjB,QAAQ;IAFpB,UAAU,CAAC,OAAO,CAAC;IACnB,KAAK,CAAC,YAAY,CAAC;GACP,QAAQ,CA8DpB"}

package/lib/mjs/services/JobRetentionService.d.ts

@@ -0,0 +1,26 @@
+import { Log } from '@spinajs/log';
+import { DateTime } from 'luxon';
+import { JobRetentionService } from '../interfaces.js';
+/**
+ * Built-in {@link JobRetentionService}. Periodically deletes terminal jobs older than the
+ * configured `maxAge` so the `queue_jobs` table doesn't grow unbounded. All timings / statuses
+ * come from the injected `queue.retention` config block - nothing is hardcoded except the
+ * fallback interval used when none is configured.
+ */
+export declare class DefaultJobRetentionService extends JobRetentionService {
+    protected Log: Log;
+    protected RetentionTimer?: ReturnType<typeof setInterval>;
+    resolve(): Promise<void>;
+    dispose(): Promise<void>;
+    /**
+     * Starts the periodic job-retention purge when configured. No-op if retention is disabled
+     * or no `maxAge` is set.
+     */
+    protected startRetention(): void;
+    /**
+     * Deletes terminal ( or given ) jobs created before `olderThan`. The set is selected with the
+     * JobModel query scopes ( status + date ), then removed by id.
+     */
+    purgeJobs(olderThan: DateTime, statuses?: string[]): Promise<number>;
+}
+//# sourceMappingURL=JobRetentionService.d.ts.map

package/lib/mjs/services/JobRetentionService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JobRetentionService.d.ts","sourceRoot":"","sources":["../../../src/services/JobRetentionService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAQvD;;;;;GAKG;AACH,qBACa,0BAA2B,SAAQ,mBAAmB;IAEjE,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IAEnB,SAAS,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;IAE7C,OAAO;IAIP,OAAO;IAOpB;;;OAGG;IACH,SAAS,CAAC,cAAc;IAyBxB;;;OAGG;IACU,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;CAclF"}

package/lib/mjs/services/JobRetentionService.js

@@ -0,0 +1,84 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Injectable } from '@spinajs/di';
+import { Log, Logger } from '@spinajs/log';
+import { DateTime } from 'luxon';
+import { JobRetentionService } from '../interfaces.js';
+import { JobModel, JOB_TERMINAL_STATUSES } from '../models/JobModel.js';
+/**
+ * How often ( ms ) to run the purge when `queue.retention.interval` is not set.
+ */
+const DEFAULT_INTERVAL_MS = 60 * 60 * 1000;
+/**
+ * Built-in {@link JobRetentionService}. Periodically deletes terminal jobs older than the
+ * configured `maxAge` so the `queue_jobs` table doesn't grow unbounded. All timings / statuses
+ * come from the injected `queue.retention` config block - nothing is hardcoded except the
+ * fallback interval used when none is configured.
+ */
+let DefaultJobRetentionService = class DefaultJobRetentionService extends JobRetentionService {
+    async resolve() {
+        this.startRetention();
+    }
+    async dispose() {
+        if (this.RetentionTimer) {
+            clearInterval(this.RetentionTimer);
+            this.RetentionTimer = undefined;
+        }
+    }
+    /**
+     * Starts the periodic job-retention purge when configured. No-op if retention is disabled
+     * or no `maxAge` is set.
+     */
+    startRetention() {
+        if (!this.Options?.enabled || !this.Options.maxAge) {
+            return;
+        }
+        const interval = this.Options.interval ?? DEFAULT_INTERVAL_MS;
+        const maxAge = this.Options.maxAge;
+        this.RetentionTimer = setInterval(() => {
+            const cutoff = DateTime.now().minus({ milliseconds: maxAge });
+            this.purgeJobs(cutoff, this.Options.statuses)
+                .then((n) => {
+                if (n > 0) {
+                    this.Log.info(`Retention purge removed ${n} job(s) older than ${cutoff.toISO()}`);
+                }
+            })
+                .catch((err) => this.Log.error(err, 'Job retention purge failed'));
+        }, interval);
+        // don't keep the process alive just for the purge timer
+        this.RetentionTimer.unref?.();
+        this.Log.info(`Job retention enabled: purging jobs older than ${maxAge}ms every ${interval}ms`);
+    }
+    /**
+     * Deletes terminal ( or given ) jobs created before `olderThan`. The set is selected with the
+     * JobModel query scopes ( status + date ), then removed by id.
+     */
+    async purgeJobs(olderThan, statuses) {
+        const rows = await JobModel.query()
+            .columns(['Id'])
+            .withStatus(statuses ?? JOB_TERMINAL_STATUSES)
+            .olderThan(olderThan);
+        const ids = rows.map((r) => r.Id);
+        if (ids.length === 0) {
+            return 0;
+        }
+        await JobModel.destroy(ids);
+        return ids.length;
+    }
+};
+__decorate([
+    Logger('queue'),
+    __metadata("design:type", Log)
+], DefaultJobRetentionService.prototype, "Log", void 0);
+DefaultJobRetentionService = __decorate([
+    Injectable(JobRetentionService)
+], DefaultJobRetentionService);
+export { DefaultJobRetentionService };
+//# sourceMappingURL=JobRetentionService.js.map

package/lib/mjs/services/JobRetentionService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JobRetentionService.js","sourceRoot":"","sources":["../../../src/services/JobRetentionService.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAa,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAEnF;;GAEG;AACH,MAAM,mBAAmB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE3C;;;;;GAKG;AAEI,IAAM,0BAA0B,GAAhC,MAAM,0BAA2B,SAAQ,mBAAmB;IAM1D,KAAK,CAAC,OAAO;QAClB,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACnC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,cAAc;QACtB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACnD,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,mBAAmB,CAAC;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAEnC,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE;YACrC,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;YAC9D,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;iBAC1C,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBACV,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACV,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2BAA2B,CAAC,sBAAsB,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACpF,CAAC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,4BAA4B,CAAC,CAAC,CAAC;QACvE,CAAC,EAAE,QAAQ,CAAC,CAAC;QAEb,wDAAwD;QACvD,IAAI,CAAC,cAAyC,CAAC,KAAK,EAAE,EAAE,CAAC;QAE1D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kDAAkD,MAAM,YAAY,QAAQ,IAAI,CAAC,CAAC;IAClG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,SAAmB,EAAE,QAAmB;QAC7D,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,KAAK,EAAE;aAChC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;aACf,UAAU,CAAE,QAAwB,IAAI,qBAAqB,CAAC;aAC9D,SAAS,CAAC,SAAS,CAAC,CAAC;QAExB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,MAAM,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,OAAO,GAAG,CAAC,MAAM,CAAC;IACpB,CAAC;CACF,CAAA;AA9DW;IADT,MAAM,CAAC,OAAO,CAAC;8BACD,GAAG;uDAAC;AAFR,0BAA0B;IADtC,UAAU,CAAC,mBAAmB,CAAC;GACnB,0BAA0B,CAgEtC"}