Add queue tables

A table with `queue_table` set works as a job queue that many workers can
pull from at once. Claims use SELECT ... FOR UPDATE SKIP LOCKED over the
idx_queue_claim index order, so each job goes to one worker and only the
claimed rows are locked.

- Schema: adds the queue_* columns and the idx_queue_claim /
  idx_queue_lease indexes. Declaring these names yourself is an error.
- `queue_table` accepts `true` or { max_attempts, lease_ms, keep_completed }
- BunMariaDB.queue: push, claim, ack, fail, extend, cancel
- Statuses: pending, processing, done, failed, cancelled
- Leases use the database clock. Expired leases are reclaimed (or
  dead-lettered on the last attempt) and old lock tokens stop working.
- insert/update can't set queue state fields. update/delete skip claimed
  jobs.

Tests: allow the test container's self-signed certificate, and give the
queue test its own client so it doesn't reuse one closed by db.test.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
2026-10-18 15:43:22 +01:00
co-authored by Claude Opus 5.5
parent 688f4bcb58
commit 7c470e0225
16 changed files with 1091 additions and 4 deletions
+64
View File
@@ -0,0 +1,64 @@
import dbHandler from "../db-handler";
import type { BunMariaDBConfig, DBResponseObject } from "../../types";
import { quoteIdentifier } from "../../utils/sql-identifier";
import { QUEUE_NOW_SQL, requireQueueTable } from "./queue-utils";
type Params<Table extends string = string> = {
table: Table;
id: number | string;
/** `queue_lock_token` from the claimed row */
lock_token: string;
/** New lease length, counted from now. Defaults to the table's `lease_ms` */
lease_ms?: number;
config?: BunMariaDBConfig;
};
/**
* Extend the lease on a claimed job, for jobs that run longer than the
* lease given to `claim`.
*/
export default async function QueueExtend<Table extends string = string>({
table,
id,
lock_token,
lease_ms,
config,
}: Params<Table>): Promise<DBResponseObject> {
try {
const options = requireQueueTable(table);
const leaseMs = Math.max(
0,
Math.floor(Number(lease_ms ?? options.lease_ms) || 0),
);
const res = await dbHandler({
query: `UPDATE ${quoteIdentifier(table)} SET queue_lease_expires_at = ${QUEUE_NOW_SQL} + ?, updated_at = ${QUEUE_NOW_SQL} WHERE id = ? AND queue_status = 'processing' AND queue_lock_token = ?`,
values: [leaseMs, id, lock_token],
config,
});
if (!res.success) {
return { ...res, success: false };
}
if (!res.db_res?.affectedRows) {
return {
...res,
success: false,
msg: "Job is not claimed with this lock token",
};
}
return await dbHandler({
query: `SELECT * FROM ${quoteIdentifier(table)} WHERE id = ?`,
values: [id],
config,
});
} catch (error: any) {
return {
success: false,
error: error.message,
};
}
}