feat: add Redis support for email queue processing with Docker configuration

Author: muniter

example-queue-project/docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3.8'
+
+services:
+  redis:
+    image: redis:7-alpine
+    container_name: queue-redis
+    ports:
+      - "6379:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 10s
+      timeout: 3s
+      retries: 5
+
+  redis-commander:
+    image: rediscommander/redis-commander:latest
+    container_name: queue-redis-ui
+    environment:
+      - REDIS_HOSTS=local:redis:6379
+    ports:
+      - "8081:8081"
+    depends_on:
+      - redis

example-queue-project/package-lock.json

@@ -11,12 +11,17 @@
     "start": "node dist/index.js",
     "push": "tsx src/index.ts --push",
     "run": "tsx src/index.ts --run",
-    "demo": "echo 'Run \"npm run run\" in one terminal, then \"npm run push\" in another!'"
+    "demo": "echo 'Run \"npm run run\" in one terminal, then \"npm run push\" in another!'",
+    "redis:start": "docker-compose up -d redis",
+    "redis:stop": "docker-compose down",
+    "redis:ui": "docker-compose up -d redis-commander",
+    "redis:logs": "docker-compose logs -f redis"
   },
   "dependencies": {
     "@aws-sdk/client-sqs": "^3.831.0",
     "@muniter/queue": "file:..",
     "dotenv": "^16.3.1",
+    "redis": "^4.6.0",
     "sqlite3": "^5.1.6"
   },
   "devDependencies": {

example-queue-project/package.json

@@ -0,0 +1,54 @@
+import { RedisQueue } from "@muniter/queue";
+import { createClient } from "redis";
+
+interface EmailJobs {
+  "welcome-email": { to: string; name: string };
+  "notification": { to: string; subject: string; body: string };
+}
+
+// Create Redis client directly
+const redisClient = createClient({ url: 'redis://localhost:6379' });
+
+redisClient.on('error', (err) => console.error('Redis Client Error:', err));
+redisClient.on('connect', () => console.log('Redis Client Connected'));
+redisClient.on('ready', () => console.log('Redis Client Ready'));
+
+await redisClient.connect();
+
+// Create Redis queue - no adapter needed!
+export const emailQueue = new RedisQueue<EmailJobs>(redisClient, 'email');
+
+// Register job handlers
+emailQueue.onJob("welcome-email", async (payload) => {
+  const { to, name } = payload;
+  console.log(`[Redis] Sending welcome email to ${to} (${name})`);
+  await new Promise((resolve) => setTimeout(resolve, 1000));
+  console.log(`[Redis] Welcome email sent successfully to ${to}`);
+});
+
+emailQueue.onJob("notification", async (payload) => {
+  const { to, subject, body } = payload;
+  console.log(`[Redis] Sending notification email to ${to}: ${subject}`);
+  await new Promise((resolve) => setTimeout(resolve, 500));
+  console.log(`[Redis] Notification sent successfully`);
+});
+
+// Event listeners
+emailQueue.on("beforeExec", (event) => {
+  console.log(
+    `\n[Redis Queue][${new Date().toISOString()}] Starting ${event.name} job ${event.id}...`
+  );
+});
+
+emailQueue.on("afterExec", (event) => {
+  console.log(
+    `[Redis Queue][${new Date().toISOString()}] Job ${event.id} (${event.name}) completed successfully`
+  );
+});
+
+emailQueue.on("afterError", (event) => {
+  console.error(
+    `[Redis Queue][${new Date().toISOString()}] Job ${event.id} (${event.name}) failed:`,
+    event.error
+  );
+});