Merge pull request #37 from noxify/batch-jobs

Batch processing

Author: noxify

.changeset/fine-taxes-drive.md

@@ -0,0 +1,7 @@
+---
+"@vorsteh-queue/adapter-drizzle": minor
+"@vorsteh-queue/adapter-kysely": minor
+"@vorsteh-queue/adapter-prisma": minor
+---
+
+Added support for batch processing

.changeset/sweet-oranges-cut.md

@@ -0,0 +1,43 @@
+---
+"@vorsteh-queue/core": minor
+---
+
+### Added
+
+- Batch processing support: You can now register batch handlers via `queue.registerBatch`, allowing the queue to process multiple jobs at once according to configurable batch sizes and timing.
+- New `batch` configuration options: `minSize`, `maxSize`, and `waitFor` allow fine-grained control over when and how batches are processed.
+- Type-safe batch jobs: Batch jobs are strictly separated from scheduled/single jobs and **do not support** cron, delay, or repeat options.
+- Adapter API extended: All core adapters now support efficient batch operations.
+- Events for batch lifecycle: The queue emits `batch:processing`, `batch:completed`, and `batch:failed` events for batch jobs.
+
+**Handler exclusivity:** A queue can handle only batch jobs or single jobs — not both. Attempting to register both handler types in the same queue will throw an error. This ensures clear and predictable processing.
+
+#### Example
+
+```ts
+import { MemoryQueueAdapter, Queue } from "@vorsteh-queue/core"
+
+type EmailPayload = { to: string; body: string }
+type EmailResult = { ok: boolean }
+
+const adapter = new MemoryQueueAdapter()
+const queue = new Queue<EmailPayload, EmailResult>(adapter, {
+  name: "batch-demo",
+  batch: { minSize: 5, maxSize: 20, waitFor: 1000 },
+})
+
+queue.registerBatch("send-emails", async (jobs) => {
+  // jobs is an array of up to 20 jobs
+  await sendBulkEmails(jobs.map((j) => j.payload))
+  return jobs.map(() => ({ ok: true }))
+})
+
+// Add jobs as usual
+await queue.addJobs("send-emails", [
+  { to: "[email protected]", body: "Hi A" },
+  { to: "[email protected]", body: "Hi B" },
+  // ...
+])
+
+queue.start()
+```

.github/workflows/tests.yml

@@ -46,7 +46,6 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10.15.1
           run_install: false
 
       - shell: bash
@@ -95,7 +94,6 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10.15.1
           run_install: false
 
       - shell: bash
@@ -127,7 +125,6 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10.15.1
           run_install: false
 
       - shell: bash
@@ -161,7 +158,6 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10.15.1
           run_install: false
 
       - shell: bash

README.md

@@ -7,10 +7,11 @@
 ## Features
 
 - **Type-safe**: Full TypeScript support with generic job payloads
-- **Multiple adapters**: Drizzle ORM (PostgreSQL), Prisma ORM (PostgreSQL), and in-memory implementations
+- **Multiple adapters**: Drizzle ORM (PostgreSQL), Prisma ORM (PostgreSQL), Kysely (PostgreSQL) and in-memory implementations
 - **Priority queues**: Numeric priority system (lower = higher priority)
 - **Delayed jobs**: Schedule jobs for future execution
 - **Recurring jobs**: Cron expressions and interval-based repetition
+- **Batch processing**: Process multiple jobs concurrently for higher efficiency and better performance by supporting parallel execution and grouping of jobs.
 - **UTC-first timezone support**: Reliable timezone handling with UTC storage
 - **Progress tracking**: Real-time job progress updates
 - **Event system**: Listen to job lifecycle events
@@ -24,6 +25,7 @@
 │   ├── core/                # Core queue logic and interfaces
 │   ├── adapter-drizzle/     # Drizzle ORM adapter (PostgreSQL)
 │   └── adapter-prisma/      # Prisma ORM adapter (PostgreSQL)
+│   └── adapter-kysely/      # Kysely adapter (PostgreSQL)
 ├── examples/                # Standalone usage examples
 └── tooling/                # Shared development tools
 ```
@@ -49,9 +51,14 @@ pnpm add @vorsteh-queue/core @vorsteh-queue/adapter-drizzle
 
 ```typescript
 // Drizzle ORM with PostgreSQL
+
+// Prisma ORM with PostgreSQL
+import { PrismaClient } from "@prisma/client"
 import { drizzle } from "drizzle-orm/node-postgres"
 import { Pool } from "pg"
+
 import { PostgresQueueAdapter } from "@vorsteh-queue/adapter-drizzle"
+import { PostgresPrismaQueueAdapter } from "@vorsteh-queue/adapter-prisma"
 import { Queue } from "@vorsteh-queue/core"
 
 interface EmailPayload {
@@ -69,10 +76,6 @@ const pool = new Pool({ connectionString: "postgresql://..." })
 const db = drizzle(pool)
 const queue = new Queue(new PostgresQueueAdapter(db), { name: "my-queue" })
 
-// Prisma ORM with PostgreSQL
-import { PrismaClient } from "@prisma/client"
-import { PostgresPrismaQueueAdapter } from "@vorsteh-queue/adapter-prisma"
-
 const prisma = new PrismaClient()
 const queue = new Queue(new PostgresPrismaQueueAdapter(prisma), { name: "my-queue" })
 
@@ -139,6 +142,26 @@ await queue.add("health-check", payload, {
 })
 ```
 
+## Batch Processing
+
+Process multiple jobs in a single batch for higher throughput and efficiency.
+
+```typescript
+queue.registerBatch<{ file: string }, { ok: boolean }>("process-files", async (jobs) => {
+  console.log(`Processing batch of ${jobs.length} files...`)
+  return jobs.map(() => ({ ok: true }))
+})
+
+await queue.addJobs("process-files", [{ file: "a.csv" }, { file: "b.csv" }, { file: "c.csv" }])
+
+queue.on("batch:processing", (jobs) => {
+  console.log(`Batch started: ${jobs.length} jobs`)
+})
+queue.on("batch:completed", (jobs) => {
+  console.log(`Batch completed: ${jobs.length} jobs`)
+})
+```
+
 ## Job Cleanup
 
 ```typescript

apps/docs/package.json

@@ -22,7 +22,7 @@
     "@mdx-js/loader": "3.1.1",
     "@mdx-js/node-loader": "3.1.1",
     "@mdx-js/react": "3.1.1",
-    "@next/mdx": "15.5.3",
+    "@next/mdx": "15.5.4",
     "@radix-ui/react-collapsible": "^1.1.12",
     "@radix-ui/react-compose-refs": "1.1.2",
     "@radix-ui/react-dialog": "^1.1.15",
@@ -41,7 +41,7 @@
     "interweave": "13.1.1",
     "lucide-react": "0.544.0",
     "multimatch": "7.0.0",
-    "next": "15.5.3",
+    "next": "15.5.4",
     "next-themes": "latest",
     "p-map": "7.0.3",
     "react": "19.1.1",
@@ -53,23 +53,24 @@
     "remark-mdx-frontmatter": "5.2.0",
     "remark-squeeze-paragraphs": "6.0.0",
     "remark-strip-badges": "7.0.0",
-    "renoun": "10.1.0",
+    "renoun": "10.1.2",
     "tm-grammars": "1.24.13",
     "tm-themes": "1.10.9",
     "ts-morph": "27.0.0",
-    "tw-animate-css": "^1.3.8",
+    "tw-animate-css": "^1.4.0",
     "use-debounce": "10.0.6",
     "zod": "4.1.11"
   },
   "devDependencies": {
     "@tailwindcss/postcss": "4.1.13",
-    "@tailwindcss/typography": "0.5.18",
+    "@tailwindcss/typography": "0.5.19",
     "@types/mdx": "2.0.13",
     "@types/node": "22.18.6",
     "@types/react": "19.1.13",
     "@types/react-dom": "19.1.9",
     "@types/serve-handler": "6.1.4",
     "@vorsteh-queue/adapter-drizzle": "workspace:*",
+    "@vorsteh-queue/adapter-kysely": "workspace:*",
     "@vorsteh-queue/adapter-prisma": "workspace:*",
     "@vorsteh-queue/core": "workspace:*",
     "@vorsteh-queue/eslint-config": "workspace:*",

examples/batch-processing/.env.example

@@ -0,0 +1 @@
+DATABASE_URL=postgresql://postgres:password@localhost:5432/queue_db

examples/batch-processing/drizzle.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "drizzle-kit"
+
+export default defineConfig({
+  schema: "./src/schema.ts",
+  out: "./drizzle",
+  dialect: "postgresql",
+  dbCredentials: {
+    url: process.env.DATABASE_URL || "postgresql://postgres:postgres@localhost:5432/queue_tracking",
+  },
+})

examples/batch-processing/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "batch-processing-example",
+  "version": "1.0.0",
+  "description": "batch processing example using Drizzle ORM with postgres.js",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "dev": "tsx src/index.ts",
+    "db:push": "drizzle-kit push"
+  },
+  "dependencies": {
+    "@vorsteh-queue/adapter-drizzle": "workspace:*",
+    "@vorsteh-queue/core": "workspace:*",
+    "drizzle-orm": "^0.44.5",
+    "postgres": "^3.4.7"
+  },
+  "devDependencies": {
+    "drizzle-kit": "^0.31.4",
+    "tsx": "4.20.5",
+    "typescript": "^5.9.2"
+  }
+}

examples/batch-processing/readme.mdx

@@ -0,0 +1,18 @@
+---
+title: Batch Processing Example
+navTitle: Batch Processing
+description: Demonstrates batch job processing. Shows how to register batch handlers, dispatch jobs in batches, and monitor batch events for robust, event-driven workflows.
+---
+
+## Setup
+
+Use the CLI to create this example:
+
+```bash
+npx create-vorsteh-queue@latest my-project --template batch-processing
+cd my-project
+cp .env.example .env
+# Edit .env with your PostgreSQL database URL
+pnpm db:push
+pnpm dev
+```

examples/batch-processing/src/database.ts

@@ -0,0 +1,13 @@
+import { drizzle } from "drizzle-orm/postgres-js"
+import postgres from "postgres"
+
+import * as schema from "./schema"
+
+// Shared database connection
+const client = postgres(
+  process.env.DATABASE_URL || "postgresql://postgres:password@localhost:5432/queue_tracking",
+  { max: 10 } // Connection pool
+)
+
+export const db = drizzle(client, { schema })
+export { client }