power-queues 2.1.8 → 2.1.10

package/README.md

@@ -41,15 +41,18 @@ const queue = new PowerQueues({
 
 await queue.loadScripts(true);
 
-await queue.addTasks('mysql_create:example:table_name', [
-	{ type: 'welcome', userId: 42 },
-	{ type: 'hello', userId: 51 }
+await queue.addTasks('ws', [
+	{ body: 'welcome', userId: 42 },
+	{ body: 'hello', userId: 51 }
 ]);
 ```
 
-Example of a worker for executing a MySQL insert transaction:
+Example of queue worker for sending message to client via WebSocket and executing a MySQL insert transaction:
 
 ``` ts
+import express from 'express';
+import http from 'http';
+import { Server } from 'socket.io';
 import mysql from 'mysql2/promise';
 import Redis from 'ioredis';
 import type { IORedisLike } from 'power-redis';
@@ -70,7 +73,11 @@ const pool = mysql.createPool({
 });
 const redis = new Redis('redis://127.0.0.1:6379');
 
-export class ExampleQueue extends PowerQueues {
+const app = express();
+const server = http.createServer(app);
+const io = new Server(server);
+
+export class WebSocketAndMysqlCreateQueue extends PowerQueues {
 	public readonly selectStuckCount: number = 256;
 	public readonly selectCount: number = 256;
 	public readonly retryCount: number = 3;
@@ -84,50 +91,68 @@ export class ExampleQueue extends PowerQueues {
 		this.redis = redis;
 	}
 
-	async onBatchReady(queueName: string, tasks: Task[]) {
-		const values = tasks
-			.filter((task) => isObjFilled(task.payload))
-			.map((task) => task.payload);
-
-		if (isArrFilled(values)) {
-			const conn = await pool.getConnection();
-
-			try {
-				await conn.beginTransaction();
-
-				const cols = Object.keys(values[0]);
-				const placeholder = `(${cols.map(() => '?').join(',')})`;
-				const sql = `INSERT INTO \`alerts\` (${cols.map((c) => `\`${c}\``).join(',')}) VALUES ${values.map(() => placeholder).join(',')}`;
-				const params = [];
+	async onExecute(queueName: string, task: Task) {
+		const id = uuid();
+
+		io.to(`user:${task.payload.userId}`).emit('alerts', {
+			body: task.payload.body,
+			id,
+		});
+		return {
+			...task,
+			payload: {
+				...task.payload,
+				id,
+			},
+		};
+	}
 
-				for (const row of values) {
-					for (const c of cols) {
-						params.push(row[c]);
-					}
+	async onBatchReady(queueName: string, tasks: Task[]) {
+		const values = tasks.map((task) => task.payload);
+		const conn = await pool.getConnection();
+	
+		try {
+			await conn.beginTransaction();
+
+			const cols = Object.keys(values[0]);
+			const placeholder = `(${cols.map(() => '?').join(',')})`;
+			const sql = `INSERT INTO \`alerts\` (${cols.map((c) => `\`${c}\``).join(',')}) VALUES ${values.map(() => placeholder).join(',')}`;
+			const params = [];
+
+			for (const row of values) {
+				for (const c of cols) {
+					params.push(row[c]);
 				}
-				await conn.execute(sql, params);
-				await conn.commit();
-			}
-			catch (err) {
-				await conn.rollback();
-				throw err;
-			}
-			finally {
-				conn.release();
 			}
+			await conn.execute(sql, params);
+			await conn.commit();
+		}
+		catch (err) {
+			await queryRunner.rollbackTransaction();
+			throw err;
+		}
+		finally {
+			await queryRunner.release();
 		}
 	}
 
+	async onError(err: any, queueName: string, task: Task): Promise<Task> {
+		console.error('Alert error', queueName, task, (process.env.NODE_ENV === 'production')
+			? err.message
+			: err);
+		return task;
+	}
+
 	async onBatchError(err: any, queueName: string, tasks: Array<[ string, any, number, string, string, number ]>) {
-		this.logger.error('Transaction error', queueName, tasks.length, (process.env.NODE_ENV === 'production')
+		console.error('Batch error', queueName, tasks.length, (process.env.NODE_ENV === 'production')
 			? err.message
-			: err, tasks.map((task) => task[1]));
+			: err);
 	}
 }
 
 const exampleQueue = new ExampleQueue();
 
-exampleQueue.runQueue('mysql_create:example:table_name');
+exampleQueue.runQueue('ws');
 ```
 
 ## ⚖️ power-queues vs Existing Solutions

package/dist/index.cjs

@@ -569,22 +569,20 @@ var PowerQueues = class extends import_power_redis.PowerRedis {
     const taskP = { ...task };
     if (!(taskP.attempt >= this.retryCount - 1)) {
       await this.onRetry(err, queueName, taskP);
-      await this.addTasks(queueName, [{ ...taskP.payload }], {
+      await this.addTasks(queueName, [{ ...taskP.payload, idemKey: taskP.idemKey }], {
         createdAt: taskP.createdAt,
         job: taskP.job,
-        attempt: (taskP.attempt || 0) + 1,
-        idemKey: taskP.idemKey
+        attempt: (taskP.attempt || 0) + 1
       });
     } else if (this.logStatus) {
       const dlqKey = queueName + ":dlq";
       const statusKey = `${queueName}:${taskP.job}:`;
       await this.incr(statusKey + "err", this.logStatusTimeout);
       await this.incr(statusKey + "ready", this.logStatusTimeout);
-      await this.addTasks(dlqKey, [{ ...taskP.payload }], {
+      await this.addTasks(dlqKey, [{ ...taskP.payload, idemKey: taskP.idemKey }], {
         createdAt: taskP.createdAt,
         job: taskP.job,
-        attempt: taskP.attempt,
-        idemKey: taskP.idemKey
+        attempt: taskP.attempt
       });
     }
     return await this.onError(err, queueName, { ...taskP, attempt: (taskP.attempt || 0) + 1 });
@@ -773,7 +771,7 @@ var PowerQueues = class extends import_power_redis.PowerRedis {
         payload: JSON.stringify(taskP),
         attempt: Number(opts.attempt || 0),
         job: opts.job ?? (0, import_uuid.v4)(),
-        idemKey: String((idemKey ?? opts?.idemKey) || (0, import_uuid.v4)()),
+        idemKey: String(idemKey || (0, import_uuid.v4)()),
         createdAt
       };
       const reqKeysLength = this.keysLength(entry);

package/dist/index.d.cts

@@ -12,7 +12,6 @@ type AddTasksOptions = {
     approx?: boolean;
     exact?: boolean;
     trimLimit?: number;
-    idemKey?: string;
     job?: string;
     status?: boolean;
     statusTimeoutMs?: number;

package/dist/index.d.ts

@@ -12,7 +12,6 @@ type AddTasksOptions = {
     approx?: boolean;
     exact?: boolean;
     trimLimit?: number;
-    idemKey?: string;
     job?: string;
     status?: boolean;
     statusTimeoutMs?: number;

package/dist/index.js

@@ -549,22 +549,20 @@ var PowerQueues = class extends PowerRedis {
     const taskP = { ...task };
     if (!(taskP.attempt >= this.retryCount - 1)) {
       await this.onRetry(err, queueName, taskP);
-      await this.addTasks(queueName, [{ ...taskP.payload }], {
+      await this.addTasks(queueName, [{ ...taskP.payload, idemKey: taskP.idemKey }], {
         createdAt: taskP.createdAt,
         job: taskP.job,
-        attempt: (taskP.attempt || 0) + 1,
-        idemKey: taskP.idemKey
+        attempt: (taskP.attempt || 0) + 1
       });
     } else if (this.logStatus) {
       const dlqKey = queueName + ":dlq";
       const statusKey = `${queueName}:${taskP.job}:`;
       await this.incr(statusKey + "err", this.logStatusTimeout);
       await this.incr(statusKey + "ready", this.logStatusTimeout);
-      await this.addTasks(dlqKey, [{ ...taskP.payload }], {
+      await this.addTasks(dlqKey, [{ ...taskP.payload, idemKey: taskP.idemKey }], {
         createdAt: taskP.createdAt,
         job: taskP.job,
-        attempt: taskP.attempt,
-        idemKey: taskP.idemKey
+        attempt: taskP.attempt
       });
     }
     return await this.onError(err, queueName, { ...taskP, attempt: (taskP.attempt || 0) + 1 });
@@ -753,7 +751,7 @@ var PowerQueues = class extends PowerRedis {
         payload: JSON.stringify(taskP),
         attempt: Number(opts.attempt || 0),
         job: opts.job ?? uuid(),
-        idemKey: String((idemKey ?? opts?.idemKey) || uuid()),
+        idemKey: String(idemKey || uuid()),
         createdAt
       };
       const reqKeysLength = this.keysLength(entry);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "power-queues",
-	"version": "2.1.8",
+	"version": "2.1.10",
 	"description": "High-performance Redis Streams queue for Node.js with Lua-powered bulk XADD, idempotent workers, heartbeat locks, stuck-task recovery, retries, DLQ, and distributed processing.",
 	"author": "ihor-bielchenko",
 	"license": "MIT",