pg-boss 12.28.1 → 12.30.0

package/dist/attorney.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"attorney.d.ts","sourceRoot":"","sources":["../src/attorney.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC,QAAA,MAAM,MAAM;;;;CAIX,CAAA;AAqED,iBAAS,iBAAiB,CAAE,MAAM,GAAE,GAAQ,QAc3C;AAgBD,iBAAS,mBAAmB,CAAE,KAAK,EAAE,MAAM,UAE1C;AAED,iBAAS,aAAa,CAAE,IAAI,EAAE,GAAG,GAAG,KAAK,CAAC,OAAO,CAgDhD;AAOD,iBAAS,eAAe,CAAE,IAAI,EAAE,GAAG,EAAE,EAAE,MAAc,EAAE;;CAAK,GAAG,KAAK,CAAC,OAAO,CA4D3E;AAED,iBAAS,mBAAmB,CAAE,MAAM,EAAE,GAAG,QAOxC;AAED,iBAAS,gBAAgB,CAAE,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,QA2D/C;AA2GD,iBAAS,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG;IAClD,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAA;IAClC,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;CACjC,CA8BA;AAED,iBAAS,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,QAQlD;AAED,iBAAS,SAAS,CAAE,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,kBAAkB,GAAG,KAAK,CAAC,0BAA0B,CAwB9F;AAsFD,iBAAS,wBAAwB,CAAE,IAAI,EAAE,MAAM,QAiC9C;AAED,iBAAS,eAAe,CAAE,IAAI,EAAE,MAAM,QAIrC;AAED,iBAAS,SAAS,CAAE,GAAG,EAAE,MAAM,QAI9B;AAuJD,OAAO,EACL,SAAS,EACT,wBAAwB,EACxB,eAAe,EACf,cAAc,EACd,aAAa,EACb,eAAe,EACf,aAAa,EACb,SAAS,EACT,mBAAmB,EACnB,MAAM,EACN,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EAClB,CAAA"}
+{"version":3,"file":"attorney.d.ts","sourceRoot":"","sources":["../src/attorney.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC,QAAA,MAAM,MAAM;;;;CAIX,CAAA;AAkFD,iBAAS,iBAAiB,CAAE,MAAM,GAAE,GAAQ,QAc3C;AAgBD,iBAAS,mBAAmB,CAAE,KAAK,EAAE,MAAM,UAE1C;AAED,iBAAS,aAAa,CAAE,IAAI,EAAE,GAAG,GAAG,KAAK,CAAC,OAAO,CAgDhD;AAOD,iBAAS,eAAe,CAAE,IAAI,EAAE,GAAG,EAAE,EAAE,MAAc,EAAE;;CAAK,GAAG,KAAK,CAAC,OAAO,CA4D3E;AAED,iBAAS,mBAAmB,CAAE,MAAM,EAAE,GAAG,QAOxC;AAED,iBAAS,gBAAgB,CAAE,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,QA2D/C;AA2GD,iBAAS,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG;IAClD,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAA;IAClC,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;CACjC,CA8BA;AAED,iBAAS,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,QAQlD;AAED,iBAAS,SAAS,CAAE,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,kBAAkB,GAAG,KAAK,CAAC,0BAA0B,CAyB9F;AA4FD,iBAAS,wBAAwB,CAAE,IAAI,EAAE,MAAM,QAiC9C;AAED,iBAAS,eAAe,CAAE,IAAI,EAAE,MAAM,QAIrC;AAED,iBAAS,SAAS,CAAE,GAAG,EAAE,MAAM,QAI9B;AA+LD,OAAO,EACL,SAAS,EACT,wBAAwB,EACxB,eAAe,EACf,cAAc,EACd,aAAa,EACb,eAAe,EACf,aAAa,EACb,SAAS,EACT,mBAAmB,EACnB,MAAM,EACN,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EAClB,CAAA"}

package/dist/attorney.js

@@ -16,7 +16,9 @@ const COMPATIBILITY_FLAGS = [
     'noAdvisoryLocks',
     'noCoveringIndexes',
     'noListenNotify',
-    'noIndexProgressView'
+    'noIndexProgressView',
+    'noReindex',
+    'noMonitorVacuum'
 ];
 // The single source of truth for backend presets, mirrored by test/testHelper.ts.
 const BACKEND_PROFILES = {
@@ -33,7 +35,13 @@ const BACKEND_PROFILES = {
             noListenNotify: true,
             // Online DDL runs as a schema-change job, not the PG CONCURRENTLY path, and
             // pg_stat_progress_create_index isn't available — so BAM can't use liveness-based reclaim.
-            noIndexProgressView: true
+            noIndexProgressView: true,
+            // REINDEX is rejected in either form — "CockroachDB does not require reindexing" with
+            // CONCURRENTLY, "unimplemented: this syntax" without — and the bloat check itself cannot run:
+            // there is no pg_relation_size(), and reltuples / relpages is an "unsupported binary
+            // operator: <float4> / <int4>".
+            noReindex: true,
+            noMonitorVacuum: true
         }
     },
     yugabytedb: {
@@ -43,7 +51,12 @@ const BACKEND_PROFILES = {
             noTablePartitioning: true,
             // Index builds are a distributed backfill that pg_stat_progress_create_index doesn't reflect,
             // so liveness would misread an in-flight build as dead. BAM falls back to the timeout instead.
-            noIndexProgressView: true
+            noIndexProgressView: true,
+            // "REINDEX not supported yet" with or without CONCURRENTLY, and DocDB compaction owns
+            // reclamation. The bloat check runs but can never match: relpages and pg_relation_size() are
+            // 0 for every relation.
+            noReindex: true,
+            noMonitorVacuum: true
         }
     },
     // No noIndexProgressView: pg-boss keeps its tables coordinator-local (it never calls
@@ -366,6 +379,7 @@ function getConfig(value) {
     config.migrate = ('migrate' in config) ? config.migrate : true;
     config.createSchema = ('createSchema' in config) ? config.createSchema : true;
     config.useListenNotify = ('useListenNotify' in config) ? config.useListenNotify : false;
+    config.reindex = ('reindex' in config) ? config.reindex : true;
     resolveBackend(config);
     applySchemaConfig(config);
     applyOpsConfig(config);
@@ -414,6 +428,11 @@ function resolveBackend(config) {
     if (config.__test__noIndexProgressView) {
         config.noIndexProgressView = true;
     }
+    // Test hook: exercise the detection-only reindex path (bloat is reported, never rebuilt) used by
+    // CockroachDB/YugabyteDB, on a plain Postgres instance.
+    if (config.__test__noReindex) {
+        config.noReindex = true;
+    }
 }
 // The character rules for the contents of a quoted name, as a predicate clause returned rather than
 // thrown, so the bare-name path can ask whether quoting would actually fix a name before
@@ -553,6 +572,29 @@ function applyOpsConfig(config) {
         assert(config.queueStatRetentionDays <= POLICY.MAX_RETENTION_DAYS, `configuration assert: queueStatRetentionDays cannot exceed ${POLICY.MAX_RETENTION_DAYS} days`);
     }
     config.queueStatRetentionDays = config.queueStatRetentionDays || 7;
+    validateReindexConfig(config);
+    validateVacuumMonitorConfig(config);
+}
+function validateReindexConfig(config) {
+    assert(!('reindex' in config) || typeof config.reindex === 'boolean' || (typeof config.reindex === 'object' && config.reindex !== null), 'configuration assert: reindex must be a boolean or an options object');
+    if (typeof config.reindex === 'object' && config.reindex !== null) {
+        const { minPages, maxEntriesPerPage, minSizeRatio, maxIndexBytes, force } = config.reindex;
+        assert(minPages === undefined || (Number.isInteger(minPages) && minPages >= 0), 'configuration assert: reindex.minPages must be an integer >= 0');
+        assert(maxEntriesPerPage === undefined || (typeof maxEntriesPerPage === 'number' && maxEntriesPerPage > 0), 'configuration assert: reindex.maxEntriesPerPage must be a number > 0');
+        assert(minSizeRatio === undefined || (typeof minSizeRatio === 'number' && minSizeRatio >= 0), 'configuration assert: reindex.minSizeRatio must be a number >= 0');
+        assert(maxIndexBytes === undefined || (Number.isInteger(maxIndexBytes) && maxIndexBytes > 0), 'configuration assert: reindex.maxIndexBytes must be an integer > 0');
+        // force belongs to an explicit supervise() call, not to a background timer that would then
+        // rebuild every job index on every interval.
+        assert(force === undefined || force === false, 'configuration assert: reindex.force cannot be set in constructor options — pass it to supervise()');
+    }
+    assert(!('reindexIntervalSeconds' in config) || config.reindexIntervalSeconds >= 1, 'configuration assert: reindexIntervalSeconds must be at least every second');
+    config.reindexIntervalSeconds = config.reindexIntervalSeconds || POLICY.MAX_EXPIRATION_HOURS * 60 * 60;
+    assert(config.reindexIntervalSeconds / 60 / 60 <= POLICY.MAX_EXPIRATION_HOURS, `configuration assert: reindexIntervalSeconds cannot exceed ${POLICY.MAX_EXPIRATION_HOURS} hours`);
+}
+function validateVacuumMonitorConfig(config) {
+    // A switch, not a threshold: the check derives its trigger from the server's own autovacuum
+    // settings and from measured dead tuples, so there is no number here for a caller to get wrong.
+    assert(!('monitorVacuum' in config) || typeof config.monitorVacuum === 'boolean', 'configuration assert: monitorVacuum must be a boolean');
 }
 function validateDeletionConfig(config) {
     assert(!('deleteAfterSeconds' in config) || config.deleteAfterSeconds >= 0, 'configuration assert: deleteAfterSeconds must be at least 0 (0 disables deletion)');

package/dist/boss.d.ts

@@ -11,7 +11,13 @@ declare class Boss extends EventEmitter implements types.EventsMixin {
     get maintaining(): boolean;
     start(): Promise<void>;
     stop(): Promise<void>;
-    supervise(value?: string | types.QueueResult[]): Promise<void>;
+    supervise(value?: string | types.QueueResult[], options?: types.SuperviseOptions): Promise<void>;
+    /**
+     * The REINDEX statements this instance would run, for installations where it cannot run them
+     * itself. Unlike the background pass this applies no ownership filter and no size cap unless one
+     * is passed — the commands are for an operator, who may run them as a different role.
+     */
+    getReindexCommands(options?: types.ReindexOptions): Promise<string[]>;
 }
 export default Boss;
 //# sourceMappingURL=boss.d.ts.map

package/dist/boss.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"boss.d.ts","sourceRoot":"","sources":["../src/boss.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAA;AACtC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAmBnC,cAAM,IAAK,SAAQ,YAAa,YAAW,KAAK,CAAC,WAAW;;IAW1D,MAAM;;;MAAS;gBAGb,EAAE,EAAE,KAAK,CAAC,SAAS,EACnB,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,KAAK,CAAC,0BAA0B;IAa1C,IAAI,WAAW,IAAK,OAAO,CAE1B;IAEK,KAAK;IAWL,IAAI;IA8FJ,SAAS,CAAE,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,WAAW,EAAE;CAgItD;AAED,eAAe,IAAI,CAAA"}
+{"version":3,"file":"boss.d.ts","sourceRoot":"","sources":["../src/boss.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAA;AACtC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAgHnC,cAAM,IAAK,SAAQ,YAAa,YAAW,KAAK,CAAC,WAAW;;IAsC1D,MAAM;;;MAAS;gBAGb,EAAE,EAAE,KAAK,CAAC,SAAS,EACnB,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,KAAK,CAAC,0BAA0B;IAa1C,IAAI,WAAW,IAAK,OAAO,CAE1B;IAEK,KAAK;IAWL,IAAI;IA8FJ,SAAS,CAAE,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,WAAW,EAAE,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,gBAAgB;IAwqBvF;;;;OAIG;IACG,kBAAkB,CAAE,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAwB7E;AAED,eAAe,IAAI,CAAA"}