@warlock.js/queue 5.24.0 → 5.25.0

package/skills/define-jobs/SKILL.md

@@ -1,67 +1,67 @@
----
-name: define-jobs
-description: 'Define and dispatch background jobs with `@warlock.js/queue`: `defineJob({ name, queue?, attempts?, backoff?, removeOnComplete?, removeOnFail?, handle(payload, ctx) })` returns a typed job; `job.dispatch(payload, { delay, priority, jobId, attempts, backoff })`; the handler context (`id`, `attempt`, `maxAttempts`, `progress()`, `log()`); reading a job with `job.find(id)`. Triggers: `defineJob`, `.dispatch(`, `ctx.progress`, `JobContext`, `DispatchOptions`, `backoff`, `attempts`, `priority`, `jobId`; "run this in the background", "retry with backoff", "delay a job", "job progress", "idempotent dispatch". Skip: config and workers — `@warlock.js/queue/configure-queue/SKILL.md`; failed jobs — `@warlock.js/queue/manage-failed-jobs/SKILL.md`.'
----
-
-# Define and dispatch jobs
-
-```ts title="src/app/invoices/jobs/send-invoice.job.ts"
-import { defineJob } from "@warlock.js/queue";
-
-export const sendInvoice = defineJob({
-  name: "invoices.send", // unique across the app
-  attempts: 5, // total tries, default 1
-  backoff: { type: "exponential", delay: 2000 }, // or a number = fixed ms
-  async handle(payload: { invoiceId: string }, ctx) {
-    await ctx.log(`attempt ${ctx.attempt} of ${ctx.maxAttempts}`);
-    await ctx.progress(50);
-    // throw to fail this attempt; it is retried until attempts run out
-    return { sent: true }; // stored as the job result
-  },
-});
-```
-
-The job module must be imported by the process that runs workers — in a Warlock app, anything under `src/app` that is loaded at boot.
-
-## Dispatch
-
-```ts
-const { id } = await sendInvoice.dispatch({ invoiceId: "42" });
-
-await sendInvoice.dispatch({ invoiceId: "43" }, {
-  delay: "10m", // ms number or "500ms" | "30s" | "10m" | "2h" | "1d"
-  priority: 1, // 1 runs first; larger numbers later
-  jobId: "invoice:43", // a second dispatch with a live id is ignored
-});
-```
-
-Option precedence: dispatch options > `defineJob` > `queue.defaultJobOptions`.
-
-## Read a job
-
-```ts
-const job = await sendInvoice.find(id);
-// { id, name, queue, state, payload, progress, attemptsMade, result, failedReason, createdAt, finishedAt }
-```
-
-## Carry request context into jobs
-
-```ts
-setQueueContext(
-  defineQueueContext({
-    capture: () => tenantStorage.getStore(), // runs inside dispatch()
-    restore: (tenant, run) => tenantStorage.run(tenant, run), // wraps handle()
-  }),
-);
-```
-
-- `undefined` from `capture` carries nothing; the value must be JSON-safe. Read it in a handler as `ctx.context` (`unknown`).
-- Jobs dispatched from a restored handler capture the same context.
-- `defineJob({ context: false })` opts a job out.
-- Throw `UnrecoverableJobError` from a handler or `restore` to fail the job without retries.
-
-## Rules
-
-- A job name with no handler in the worker process fails at once, without retries.
-- Payloads are stored as JSON: pass ids, not model instances.
-- Defining the same name again replaces the handler (this is what keeps dev reloads working), so keep names unique.
+---
+name: define-jobs
+description: 'Define and dispatch background jobs with `@warlock.js/queue`: `defineJob({ name, queue?, attempts?, backoff?, removeOnComplete?, removeOnFail?, handle(payload, ctx) })` returns a typed job; `job.dispatch(payload, { delay, priority, jobId, attempts, backoff })`; the handler context (`id`, `attempt`, `maxAttempts`, `progress()`, `log()`); reading a job with `job.find(id)`. Triggers: `defineJob`, `.dispatch(`, `ctx.progress`, `JobContext`, `DispatchOptions`, `backoff`, `attempts`, `priority`, `jobId`; "run this in the background", "retry with backoff", "delay a job", "job progress", "idempotent dispatch". Skip: config and workers — `@warlock.js/queue/configure-queue/SKILL.md`; failed jobs — `@warlock.js/queue/manage-failed-jobs/SKILL.md`.'
+---
+
+# Define and dispatch jobs
+
+```ts title="src/app/invoices/jobs/send-invoice.job.ts"
+import { defineJob } from "@warlock.js/queue";
+
+export const sendInvoice = defineJob({
+  name: "invoices.send", // unique across the app
+  attempts: 5, // total tries, default 1
+  backoff: { type: "exponential", delay: 2000 }, // or a number = fixed ms
+  async handle(payload: { invoiceId: string }, ctx) {
+    await ctx.log(`attempt ${ctx.attempt} of ${ctx.maxAttempts}`);
+    await ctx.progress(50);
+    // throw to fail this attempt; it is retried until attempts run out
+    return { sent: true }; // stored as the job result
+  },
+});
+```
+
+The job module must be imported by the process that runs workers — in a Warlock app, anything under `src/app` that is loaded at boot.
+
+## Dispatch
+
+```ts
+const { id } = await sendInvoice.dispatch({ invoiceId: "42" });
+
+await sendInvoice.dispatch({ invoiceId: "43" }, {
+  delay: "10m", // ms number or "500ms" | "30s" | "10m" | "2h" | "1d"
+  priority: 1, // 1 runs first; larger numbers later
+  jobId: "invoice:43", // a second dispatch with a live id is ignored
+});
+```
+
+Option precedence: dispatch options > `defineJob` > `queue.defaultJobOptions`.
+
+## Read a job
+
+```ts
+const job = await sendInvoice.find(id);
+// { id, name, queue, state, payload, progress, attemptsMade, result, failedReason, createdAt, finishedAt }
+```
+
+## Carry request context into jobs
+
+```ts
+setQueueContext(
+  defineQueueContext({
+    capture: () => tenantStorage.getStore(), // runs inside dispatch()
+    restore: (tenant, run) => tenantStorage.run(tenant, run), // wraps handle()
+  }),
+);
+```
+
+- `undefined` from `capture` carries nothing; the value must be JSON-safe. Read it in a handler as `ctx.context` (`unknown`).
+- Jobs dispatched from a restored handler capture the same context.
+- `defineJob({ context: false })` opts a job out.
+- Throw `UnrecoverableJobError` from a handler or `restore` to fail the job without retries.
+
+## Rules
+
+- A job name with no handler in the worker process fails at once, without retries.
+- Payloads are stored as JSON: pass ids, not model instances.
+- Defining the same name again replaces the handler (this is what keeps dev reloads working), so keep names unique.

package/skills/manage-failed-jobs/SKILL.md

@@ -1,68 +1,68 @@
----
-name: manage-failed-jobs
-description: 'Inspect and retry failed `@warlock.js/queue` jobs: `failedJobs({ queue, start, end })` returns `FailedJob[]` (`id`, `name`, `payload`, `attemptsMade`, `failedReason`, `stacktrace`, `failedAt`, `retry()`), `retryFailedJob(id, { queue })` (throws `FailedJobNotFoundError`), and the bull-board UI — `warlock add bull-board` (requires: ["queue"], so it installs queue first when missing) writes a `dashboard: { enabled, path, middleware }` block to `src/config/queue.ts`; a guard middleware is required in production or boot throws `QueueDashboardUnguardedError`. Manual `queueDashboard(server, { basePath, queues, middleware })` also available — needs `@bull-board/api` + `@bull-board/fastify`, loaded only on call, missing ones throw `QueueDashboardDependencyError`. Triggers: `failedJobs`, `retryFailedJob`, `queueDashboard`, `bull-board`, `dashboard.enabled`, `QueueDashboardUnguardedError`; "list failed jobs", "retry a failed job", "queue dashboard", "job admin UI". Skip: defining retries — `@warlock.js/queue/define-jobs/SKILL.md`.'
----
-
-# Failed jobs
-
-A job is failed once it has used every attempt, or failed in a way that cannot be retried (for example, no handler for its name). Failed jobs are kept unless you set `removeOnFail`.
-
-```ts
-import { failedJobs, retryFailedJob } from "@warlock.js/queue";
-
-const failed = await failedJobs({ queue: "default", start: 0, end: 49 }); // newest first
-
-for (const job of failed) {
-  console.log(job.name, job.failedReason, job.attemptsMade);
-}
-
-await failed[0]?.retry(); // back to waiting
-await retryFailedJob("invoice:43"); // by id; throws FailedJobNotFoundError if not failed
-```
-
-## Dashboard (optional)
-
-```sh
-warlock add bull-board
-```
-
-This installs `@bull-board/api` + `@bull-board/fastify` and writes a `dashboard` block to `src/config/queue.ts`. It `requires: ["queue"]`, so it adds the `queue` feature first automatically when it isn't installed yet — no need to run `warlock add queue` yourself first:
-
-```ts title="src/config/queue.ts"
-import type { QueueConfig } from "@warlock.js/queue";
-import { middleware } from "@warlock.js/core";
-import { authMiddleware } from "@warlock.js/auth";
-
-const queueConfig: QueueConfig = {
-  connection: { host: "127.0.0.1", port: 6379 },
-  dashboard: {
-    enabled: true,
-    path: "/admin/queues", // default
-    middleware: [authMiddleware("admin")], // guards every dashboard route
-  },
-};
-
-export default queueConfig;
-```
-
-- The dashboard can retry and delete jobs, so it must be guarded. In production, an empty `middleware` list throws `QueueDashboardUnguardedError` at boot instead of mounting exposed. Outside production it logs a warning and mounts anyway.
-- `queueConnector()` mounts the dashboard at boot from this config — no extra wiring needed.
-
-### Advanced: manual `queueDashboard()`
-
-For mounting outside the config-driven path (a custom server, a non-standard boot sequence), call `queueDashboard` yourself:
-
-```ts
-import { getHttpServer } from "@warlock.js/core";
-import { queueDashboard } from "@warlock.js/queue";
-import { authMiddleware } from "@warlock.js/auth";
-
-await queueDashboard(getHttpServer(), {
-  basePath: "/admin/queues",
-  middleware: [authMiddleware("admin")],
-});
-```
-
-- Call it before the HTTP server starts listening.
-- Shows every queue that has a job, plus the default queue, unless you pass `queues`.
-- It has no authentication of its own — pass `middleware` yourself; this path does not enforce the production guard that the `dashboard` config does.
+---
+name: manage-failed-jobs
+description: 'Inspect and retry failed `@warlock.js/queue` jobs: `failedJobs({ queue, start, end })` returns `FailedJob[]` (`id`, `name`, `payload`, `attemptsMade`, `failedReason`, `stacktrace`, `failedAt`, `retry()`), `retryFailedJob(id, { queue })` (throws `FailedJobNotFoundError`), and the bull-board UI — `warlock add bull-board` (requires: ["queue"], so it installs queue first when missing) writes a `dashboard: { enabled, path, middleware }` block to `src/config/queue.ts`; a guard middleware is required in production or boot throws `QueueDashboardUnguardedError`. Manual `queueDashboard(server, { basePath, queues, middleware })` also available — needs `@bull-board/api` + `@bull-board/fastify`, loaded only on call, missing ones throw `QueueDashboardDependencyError`. Triggers: `failedJobs`, `retryFailedJob`, `queueDashboard`, `bull-board`, `dashboard.enabled`, `QueueDashboardUnguardedError`; "list failed jobs", "retry a failed job", "queue dashboard", "job admin UI". Skip: defining retries — `@warlock.js/queue/define-jobs/SKILL.md`.'
+---
+
+# Failed jobs
+
+A job is failed once it has used every attempt, or failed in a way that cannot be retried (for example, no handler for its name). Failed jobs are kept unless you set `removeOnFail`.
+
+```ts
+import { failedJobs, retryFailedJob } from "@warlock.js/queue";
+
+const failed = await failedJobs({ queue: "default", start: 0, end: 49 }); // newest first
+
+for (const job of failed) {
+  console.log(job.name, job.failedReason, job.attemptsMade);
+}
+
+await failed[0]?.retry(); // back to waiting
+await retryFailedJob("invoice:43"); // by id; throws FailedJobNotFoundError if not failed
+```
+
+## Dashboard (optional)
+
+```sh
+warlock add bull-board
+```
+
+This installs `@bull-board/api` + `@bull-board/fastify` and writes a `dashboard` block to `src/config/queue.ts`. It `requires: ["queue"]`, so it adds the `queue` feature first automatically when it isn't installed yet — no need to run `warlock add queue` yourself first:
+
+```ts title="src/config/queue.ts"
+import type { QueueConfig } from "@warlock.js/queue";
+import { middleware } from "@warlock.js/core";
+import { authMiddleware } from "@warlock.js/auth";
+
+const queueConfig: QueueConfig = {
+  connection: { host: "127.0.0.1", port: 6379 },
+  dashboard: {
+    enabled: true,
+    path: "/admin/queues", // default
+    middleware: [authMiddleware("admin")], // guards every dashboard route
+  },
+};
+
+export default queueConfig;
+```
+
+- The dashboard can retry and delete jobs, so it must be guarded. In production, an empty `middleware` list throws `QueueDashboardUnguardedError` at boot instead of mounting exposed. Outside production it logs a warning and mounts anyway.
+- `queueConnector()` mounts the dashboard at boot from this config — no extra wiring needed.
+
+### Advanced: manual `queueDashboard()`
+
+For mounting outside the config-driven path (a custom server, a non-standard boot sequence), call `queueDashboard` yourself:
+
+```ts
+import { getHttpServer } from "@warlock.js/core";
+import { queueDashboard } from "@warlock.js/queue";
+import { authMiddleware } from "@warlock.js/auth";
+
+await queueDashboard(getHttpServer(), {
+  basePath: "/admin/queues",
+  middleware: [authMiddleware("admin")],
+});
+```
+
+- Call it before the HTTP server starts listening.
+- Shows every queue that has a job, plus the default queue, unless you pass `queues`.
+- It has no authentication of its own — pass `middleware` yourself; this path does not enforce the production guard that the `dashboard` config does.

package/skills/queue-notifications/SKILL.md

@@ -1,35 +1,35 @@
----
-name: queue-notifications
-description: 'Send `@warlock.js/notifications` `.queue()` deliveries through BullMQ with `bullmqQueue({ queue?, attempts?, backoff? })` from `@warlock.js/notifications` — put it in the `queue` slot of `src/config/notifications.ts`; the queue workers deliver. Honours `SendOptions.delay` (number = seconds, or "10m"), retries a failing `channel.send`, and fails at once for a channel missing from the worker config. Triggers: `bullmqQueue`, `NotificationConfig.queue`, `QueuePackageNotInstalledError`; "queue notifications with BullMQ", "retry notification delivery", "delayed notification". Skip: the herald backend — `@warlock.js/notifications/queue-notifications/SKILL.md`.'
----
-
-# Queue notifications with BullMQ
-
-```ts title="src/config/notifications.ts"
-import { type NotificationConfig, bullmqQueue, mailChannel } from "@warlock.js/notifications";
-
-const config: NotificationConfig = {
-  channels: { mail: mailChannel() },
-  queue: bullmqQueue({ attempts: 3, backoff: { type: "exponential", delay: 5000 } }),
-};
-
-export default config;
-```
-
-`bullmqQueue` ships inside `@warlock.js/notifications` itself and lazy-loads `@warlock.js/queue` (an OPTIONAL peer) the first time `.queue()` runs — install it with `warlock add queue` if it isn't there yet, otherwise the first `.queue()` throws `QueuePackageNotInstalledError`.
-
-Also configure the queue itself (`configure-queue`). No separate notifications worker is needed: the delivery is an ordinary job, run by the queue workers.
-
-```ts
-await orderShipped.queue(user, { order }); // enqueued, delivered by a worker
-await orderShipped.queue(user, { order }, { delay: "10m" }); // delivered in 10 minutes
-```
-
-## Behaviour
-
-- The job carries the rendered payload and resolved route; the worker looks the channel up by name in its own notifications config and calls `channel.send`.
-- `delay`: a number is seconds (notifications' convention); a string is a duration.
-- `channel.send` throws → retried per `attempts` / `backoff`, then listed by `failedJobs()`.
-- Channel not configured in the worker → fails at once, no retries.
-- Deliveries run under the job name `warlock.notifications.deliver`.
-
+---
+name: queue-notifications
+description: 'Send `@warlock.js/notifications` `.queue()` deliveries through BullMQ with `bullmqQueue({ queue?, attempts?, backoff? })` from `@warlock.js/notifications` — put it in the `queue` slot of `src/config/notifications.ts`; the queue workers deliver. Honours `SendOptions.delay` (number = seconds, or "10m"), retries a failing `channel.send`, and fails at once for a channel missing from the worker config. Triggers: `bullmqQueue`, `NotificationConfig.queue`, `QueuePackageNotInstalledError`; "queue notifications with BullMQ", "retry notification delivery", "delayed notification". Skip: the herald backend — `@warlock.js/notifications/queue-notifications/SKILL.md`.'
+---
+
+# Queue notifications with BullMQ
+
+```ts title="src/config/notifications.ts"
+import { type NotificationConfig, bullmqQueue, mailChannel } from "@warlock.js/notifications";
+
+const config: NotificationConfig = {
+  channels: { mail: mailChannel() },
+  queue: bullmqQueue({ attempts: 3, backoff: { type: "exponential", delay: 5000 } }),
+};
+
+export default config;
+```
+
+`bullmqQueue` ships inside `@warlock.js/notifications` itself and lazy-loads `@warlock.js/queue` (an OPTIONAL peer) the first time `.queue()` runs — install it with `warlock add queue` if it isn't there yet, otherwise the first `.queue()` throws `QueuePackageNotInstalledError`.
+
+Also configure the queue itself (`configure-queue`). No separate notifications worker is needed: the delivery is an ordinary job, run by the queue workers.
+
+```ts
+await orderShipped.queue(user, { order }); // enqueued, delivered by a worker
+await orderShipped.queue(user, { order }, { delay: "10m" }); // delivered in 10 minutes
+```
+
+## Behaviour
+
+- The job carries the rendered payload and resolved route; the worker looks the channel up by name in its own notifications config and calls `channel.send`.
+- `delay`: a number is seconds (notifications' convention); a string is a duration.
+- `channel.send` throws → retried per `attempts` / `backoff`, then listed by `failedJobs()`.
+- Channel not configured in the worker → fails at once, no retries.
+- Deliveries run under the job name `warlock.notifications.deliver`.
+