@nicnocquee/dataqueue 1.34.0 → 1.35.0-beta.20260224075710

package/ai/skills/dataqueue-advanced/SKILL.md

@@ -170,6 +170,56 @@ await queue.addJob({
 - Handler must be serializable (no closures over external variables).
 - `prolong`, `onTimeout`, `ctx.run`, waits are NOT available.
 
+## Event Hooks
+
+Subscribe to real-time job lifecycle events. Works identically with PostgreSQL and Redis.
+
+```typescript
+const queue = initJobQueue<MyPayloadMap>(config);
+
+queue.on('job:completed', ({ jobId, jobType }) => {
+  console.log(`Job ${jobId} (${jobType}) completed`);
+});
+
+queue.on('job:failed', ({ jobId, jobType, error, willRetry }) => {
+  console.error(`Job ${jobId} failed: ${error.message}`);
+  if (!willRetry) {
+    alertOps(`Permanent failure for job ${jobId}`);
+  }
+});
+
+queue.on('error', (error) => {
+  Sentry.captureException(error);
+});
+```
+
+### Available events
+
+| Event            | Payload                                |
+| ---------------- | -------------------------------------- |
+| `job:added`      | `{ jobId, jobType }`                   |
+| `job:processing` | `{ jobId, jobType }`                   |
+| `job:completed`  | `{ jobId, jobType }`                   |
+| `job:failed`     | `{ jobId, jobType, error, willRetry }` |
+| `job:cancelled`  | `{ jobId }`                            |
+| `job:retried`    | `{ jobId }`                            |
+| `job:waiting`    | `{ jobId, jobType }`                   |
+| `job:progress`   | `{ jobId, progress }`                  |
+| `error`          | `Error`                                |
+
+### Listener management
+
+```typescript
+const listener = ({ jobId }) => console.log(jobId);
+queue.on('job:completed', listener);
+queue.off('job:completed', listener);
+queue.once('job:added', ({ jobId }) => console.log('First job:', jobId));
+queue.removeAllListeners('job:completed');
+queue.removeAllListeners(); // all events
+```
+
+The `error` event fires alongside `onError` callbacks in `ProcessorOptions` and `SupervisorOptions` -- both mechanisms work independently.
+
 ## Tags
 
 ```typescript
@@ -201,8 +251,117 @@ const jobId = await queue.addJob({
 
 If a job with the same key exists, returns the existing job ID. Key is unique across all statuses until `cleanupOldJobs` removes it.
 
+## Transactional Job Creation (PostgreSQL Only)
+
+Insert a job within an existing database transaction so the job is enqueued **atomically** with other writes:
+
+```typescript
+import { Pool } from 'pg';
+
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+
+async function registerUser(email: string, name: string) {
+  const client = await pool.connect();
+  try {
+    await client.query('BEGIN');
+
+    await client.query('INSERT INTO users (email, name) VALUES ($1, $2)', [
+      email,
+      name,
+    ]);
+
+    const queue = getJobQueue();
+    await queue.addJob(
+      {
+        jobType: 'send_email',
+        payload: { to: email, subject: 'Welcome!', body: `Hi ${name}!` },
+      },
+      { db: client },
+    );
+
+    await client.query('COMMIT');
+  } catch (error) {
+    await client.query('ROLLBACK');
+    throw error;
+  } finally {
+    client.release();
+  }
+}
+```
+
+The `db` option accepts any object matching `DatabaseClient { query(text, values): Promise<{ rows, rowCount }> }` — works with `pg.PoolClient`, `pg.Client`, or compatible ORM query runners.
+
+The job event (`'added'`) is also inserted within the same transaction.
+
+## Retry Strategy
+
+Configure how failed jobs are retried with `retryDelay`, `retryBackoff`, and `retryDelayMax`.
+
+### Fixed delay
+
+```typescript
+await queue.addJob({
+  jobType: 'email',
+  payload: {
+    /* ... */
+  },
+  maxAttempts: 5,
+  retryDelay: 30, // 30 seconds between each retry
+  retryBackoff: false,
+});
+```
+
+### Exponential backoff with cap
+
+```typescript
+await queue.addJob({
+  jobType: 'email',
+  payload: {
+    /* ... */
+  },
+  maxAttempts: 10,
+  retryDelay: 5, // base: 5 seconds
+  retryBackoff: true, // default — delay doubles each attempt with jitter
+  retryDelayMax: 300, // never wait more than 5 minutes
+});
+```
+
+### Cron schedules with retry config
+
+```typescript
+await queue.addCronJob({
+  scheduleName: 'daily-sync',
+  cronExpression: '0 * * * *',
+  jobType: 'sync',
+  payload: { source: 'api' },
+  retryDelay: 60,
+  retryBackoff: true,
+  retryDelayMax: 600,
+});
+```
+
+Every job enqueued by the schedule inherits the retry settings.
+
+### Default behavior
+
+When no retry options are set, the legacy formula `2^attempts * 60 seconds` is used. This is fully backward compatible.
+
 ## Maintenance
 
+Use `createSupervisor()` to automate all maintenance tasks in a long-running server:
+
+```typescript
+const supervisor = queue.createSupervisor({
+  intervalMs: 60_000,
+  stuckJobsTimeoutMinutes: 10,
+  cleanupJobsDaysToKeep: 30,
+  cleanupEventsDaysToKeep: 30,
+});
+supervisor.startInBackground();
+```
+
+For serverless or one-off scripts, call `supervisor.start()` (runs once) or use the manual methods:
+
 ```typescript
 await queue.reclaimStuckJobs(10); // reclaim jobs stuck > 10 min
 await queue.cleanupOldJobs(30); // delete completed jobs > 30 days

package/ai/skills/dataqueue-core/SKILL.md

@@ -38,7 +38,8 @@ export const jobHandlers: JobHandlers<JobPayloadMap> = {
   },
   generate_report: async (payload, signal) => {
     if (signal.aborted) return;
-    await generateReport(payload.reportId, payload.userId);
+    const url = await generateReport(payload.reportId, payload.userId);
+    return { url }; // stored as job output, readable via getJob()
   },
 };
 ```
@@ -79,6 +80,30 @@ jobQueue = initJobQueue<JobPayloadMap>({
 });
 ```
 
+### Bring Your Own Pool / Client
+
+You can pass an existing `pg.Pool` or `ioredis` client instead of connection config:
+
+```typescript
+import { Pool } from 'pg';
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+
+jobQueue = initJobQueue<JobPayloadMap>({ pool });
+```
+
+```typescript
+import IORedis from 'ioredis';
+const redis = new IORedis(process.env.REDIS_URL);
+
+jobQueue = initJobQueue<JobPayloadMap>({
+  backend: 'redis',
+  client: redis,
+  keyPrefix: 'myapp:',
+});
+```
+
+When you provide your own pool/client, the library will **not** close it on shutdown — you manage its lifecycle.
+
 ## Step 4: Add Jobs
 
 ```typescript
@@ -92,6 +117,71 @@ const jobId = await queue.addJob({
 });
 ```
 
+### Batch Insert
+
+Use `addJobs` to insert many jobs in a single database round-trip. Returns IDs in the same order as the input array.
+
+```typescript
+const jobIds = await queue.addJobs([
+  {
+    jobType: 'send_email',
+    payload: { to: 'a@example.com', subject: 'Hi', body: '...' },
+  },
+  {
+    jobType: 'send_email',
+    payload: { to: 'b@example.com', subject: 'Hi', body: '...' },
+    priority: 10,
+  },
+  {
+    jobType: 'generate_report',
+    payload: { reportId: '1', userId: '2' },
+    tags: ['monthly'],
+  },
+]);
+```
+
+Each job can independently have its own `idempotencyKey`, `priority`, `runAt`, `tags`, etc. The `{ db }` transactional option is also supported (PostgreSQL only).
+
+### Transactional Job Creation (PostgreSQL only)
+
+Pass an external `pg.PoolClient` inside a transaction via `{ db: client }`:
+
+```typescript
+const client = await pool.connect();
+await client.query('BEGIN');
+await client.query('INSERT INTO users (email) VALUES ($1)', [email]);
+await queue.addJob(
+  {
+    jobType: 'send_email',
+    payload: { to: email, subject: 'Welcome!', body: '...' },
+  },
+  { db: client },
+);
+await client.query('COMMIT');
+client.release();
+```
+
+If the transaction rolls back, the job is never enqueued.
+
+### Retry configuration
+
+Control retry behavior per-job with `retryDelay`, `retryBackoff`, and `retryDelayMax`:
+
+```typescript
+await queue.addJob({
+  jobType: 'send_email',
+  payload: { to: 'user@example.com', subject: 'Hi', body: 'Hello' },
+  maxAttempts: 5,
+  retryDelay: 10, // base delay: 10 seconds
+  retryBackoff: true, // exponential backoff (default)
+  retryDelayMax: 300, // cap at 5 minutes
+});
+```
+
+- **Fixed delay**: set `retryBackoff: false` for constant delay between retries.
+- **Exponential backoff** (default): delay doubles each attempt with jitter.
+- **Default**: when no retry options are set, legacy `2^attempts * 60s` is used.
+
 ## Step 5: Process Jobs
 
 ### Serverless (one-shot)
@@ -114,8 +204,20 @@ const processor = queue.createProcessor(handlers, {
 });
 processor.startInBackground();
 
+// Automate maintenance (reclaim stuck jobs, cleanup old data, expire tokens)
+const supervisor = queue.createSupervisor({
+  intervalMs: 60_000,
+  stuckJobsTimeoutMinutes: 10,
+  cleanupJobsDaysToKeep: 30,
+  cleanupEventsDaysToKeep: 30,
+});
+supervisor.startInBackground();
+
 process.on('SIGTERM', async () => {
-  await processor.stopAndDrain(30000);
+  await Promise.all([
+    processor.stopAndDrain(30000),
+    supervisor.stopAndDrain(30000),
+  ]);
   queue.getPool().end();
   process.exit(0);
 });
@@ -126,6 +228,8 @@ process.on('SIGTERM', async () => {
 1. **Creating a new queue per request** — always use a singleton. Each `initJobQueue` creates a DB pool.
 2. **Missing handler for a job type** — the job fails with `FailureReason.NoHandler`. Let TypeScript enforce completeness by typing handlers as `JobHandlers<PayloadMap>`.
 3. **Not checking `signal.aborted`** — timed-out jobs keep running in the background. Always check the signal in long-running handlers.
-4. **Forgetting `reclaimStuckJobs`** — crashed workers leave jobs stuck in `processing`. Call `reclaimStuckJobs()` periodically.
+4. **Skipping maintenance** — use `createSupervisor()` to automate reclaiming stuck jobs, cleaning up old data, and expiring tokens. Without it, crashed workers leave jobs stuck in `processing` and tables grow unbounded.
 5. **Forgetting to run migrations** — PostgreSQL requires `dataqueue-cli migrate` before use. Redis needs no migrations.
 6. **Not calling `stopAndDrain` on shutdown** — use `stopAndDrain()` (not `stop()`) for graceful shutdown to avoid stuck jobs.
+7. **Forgetting to commit/rollback when using `db` option** — the `addJob` INSERT sits in an open transaction. If you never `COMMIT` or `ROLLBACK`, the connection leaks and the job is invisible to other sessions.
+8. **Using `db` option with Redis** — transactional job creation is PostgreSQL only. The Redis backend throws if `db` is provided.

package/ai/skills/dataqueue-react/SKILL.md

@@ -102,13 +102,14 @@ export async function GET(
 
 ### useJob Return Value
 
-| Field       | Type                | Description                     |
-| ----------- | ------------------- | ------------------------------- |
-| `data`      | `JobData \| null`   | Latest job data from fetcher    |
-| `status`    | `JobStatus \| null` | Current job status              |
-| `progress`  | `number \| null`    | Progress percentage (0–100)     |
-| `isLoading` | `boolean`           | True until first fetch resolves |
-| `error`     | `Error \| null`     | Last fetch error                |
+| Field       | Type                | Description                                           |
+| ----------- | ------------------- | ----------------------------------------------------- |
+| `data`      | `JobData \| null`   | Latest job data from fetcher                          |
+| `status`    | `JobStatus \| null` | Current job status                                    |
+| `progress`  | `number \| null`    | Progress percentage (0–100)                           |
+| `output`    | `unknown \| null`   | Handler output from `ctx.setOutput()` or return value |
+| `isLoading` | `boolean`           | True until first fetch resolves                       |
+| `error`     | `Error \| null`     | Last fetch error                                      |
 
 ## Dashboard — @nicnocquee/dataqueue-dashboard
 
@@ -187,3 +188,14 @@ const handler = async (payload, signal, ctx) => {
   }
 };
 ```
+
+### Job Output from Handlers
+
+Store results via `ctx.setOutput(data)` or by returning a value from the handler. Exposed via `getJob()` (`output` field) and the `useJob` hook's `output` property. If both are used, `ctx.setOutput()` takes precedence.
+
+```typescript
+const handler = async (payload, signal, ctx) => {
+  const result = await doWork(payload);
+  return { url: result.downloadUrl }; // stored as output
+};
+```