redis-smq 7.2.1 → 7.2.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 7.2.3 (2023-03-26)
+
+* test(consumer-heartbeat): update tests (4332153)
+* refactor(consumer-heartbeat): clean up and improve API (20fc1b1)
+
+## 7.2.2 (2023-03-25)
+
+* test(workers): update tests (c22f1bb)
+* perf(workers): use offset/count for schedule and watchdog workers (e78ecdb)
+* build: bump up redis-smq-common to v2.0.0 (c90050d)
+* build: clean up (61851a9)
+
 ## 7.2.1 (2023-02-15)
 
 * build: update deps (e362d7c)

package/dist/src/lib/consumer/consumer-heartbeat.d.ts

@@ -15,12 +15,8 @@ export declare class ConsumerHeartbeat extends EventEmitter {
     protected getPayload(): TConsumerHeartbeat;
     protected onTick(): void;
     quit(cb: ICallback<void>): void;
-    static validateHeartbeatsOf(redisClient: RedisClient, consumerIds: string[], cb: ICallback<Record<string, boolean>>): void;
-    static getValidHeartbeats(redisClient: RedisClient, cb: ICallback<{
-        consumerId: string;
-        payload: string;
-    }[]>): void;
-    static getValidHeartbeatIds(redisClient: RedisClient, cb: ICallback<string[]>): void;
-    static getExpiredHeartbeatIds(redisClient: RedisClient, cb: ICallback<string[]>): void;
+    protected static isExpiredHeartbeat(heartbeat: TConsumerHeartbeat): boolean;
+    static getConsumersHeartbeats(redisClient: RedisClient, consumerIds: string[], cb: ICallback<Record<string, TConsumerHeartbeat | false>>): void;
+    static getExpiredHeartbeatIds(redisClient: RedisClient, offset: number, count: number, cb: ICallback<string[]>): void;
     static handleExpiredHeartbeatId(consumerId: string | string[], multi: IRedisClientMulti): void;
 }

package/dist/src/lib/consumer/consumer-heartbeat.js

@@ -84,7 +84,12 @@ class ConsumerHeartbeat extends events_2.EventEmitter {
             (cb) => this.redisClient.halt(cb),
         ], cb);
     }
-    static validateHeartbeatsOf(redisClient, consumerIds, cb) {
+    static isExpiredHeartbeat(heartbeat) {
+        const { timestamp: heartbeatTimestamp } = heartbeat;
+        const timestamp = Date.now() - ConsumerHeartbeat.heartbeatTTL;
+        return heartbeatTimestamp > timestamp;
+    }
+    static getConsumersHeartbeats(redisClient, consumerIds, cb) {
         const keyHeartbeats = redis_keys_1.redisKeys.getMainKeys().keyHeartbeats;
         redisClient.hmget(keyHeartbeats, consumerIds, (err, reply) => {
             if (err)
@@ -93,73 +98,25 @@ class ConsumerHeartbeat extends events_2.EventEmitter {
                 cb(new redis_smq_common_2.errors.InvalidCallbackReplyError());
             else {
                 const r = {};
-                redis_smq_common_2.async.each(consumerIds, (item, index, done) => {
-                    const idx = Number(index);
-                    const payload = reply[idx];
+                redis_smq_common_2.async.eachOf(consumerIds, (item, index, done) => {
+                    const payload = reply[index];
                     if (payload) {
-                        const { timestamp: heartbeatTimestamp } = JSON.parse(payload);
-                        const timestamp = Date.now() - ConsumerHeartbeat.heartbeatTTL;
-                        r[consumerIds[idx]] = heartbeatTimestamp > timestamp;
+                        const consumerHeartbeat = JSON.parse(payload);
+                        r[consumerIds[index]] = this.isExpiredHeartbeat(consumerHeartbeat)
+                            ? consumerHeartbeat
+                            : false;
                     }
                     else
-                        r[consumerIds[idx]] = false;
+                        r[consumerIds[index]] = false;
                     done();
                 }, () => cb(null, r));
             }
         });
     }
-    static getValidHeartbeats(redisClient, cb) {
-        ConsumerHeartbeat.getValidHeartbeatIds(redisClient, (err, consumerIds) => {
-            if (err)
-                cb(err);
-            else if (consumerIds && consumerIds.length) {
-                const { keyHeartbeats } = redis_keys_1.redisKeys.getMainKeys();
-                redisClient.hmget(keyHeartbeats, consumerIds, (err, res) => {
-                    if (err)
-                        cb(err);
-                    else if (!res || res.length !== consumerIds.length)
-                        cb(new redis_smq_common_2.errors.EmptyCallbackReplyError());
-                    else {
-                        const heartbeats = [];
-                        redis_smq_common_2.async.each(res, (payload, index, done) => {
-                            if (payload) {
-                                const idx = Number(index);
-                                const consumerId = consumerIds[idx];
-                                heartbeats.push({
-                                    consumerId,
-                                    payload,
-                                });
-                                done();
-                            }
-                            else
-                                done();
-                        }, (err) => {
-                            if (err)
-                                cb(err);
-                            else
-                                cb(null, heartbeats);
-                        });
-                    }
-                });
-            }
-            else
-                cb(null, []);
-        });
-    }
-    static getValidHeartbeatIds(redisClient, cb) {
+    static getExpiredHeartbeatIds(redisClient, offset, count, cb) {
         const { keyHeartbeatConsumerWeight } = redis_keys_1.redisKeys.getMainKeys();
-        const timestamp = Date.now() - ConsumerHeartbeat.heartbeatTTL;
-        redisClient.zrangebyscore(keyHeartbeatConsumerWeight, timestamp, '+inf', (err, consumerIds) => {
-            if (err)
-                cb(err);
-            else
-                cb(null, consumerIds !== null && consumerIds !== void 0 ? consumerIds : []);
-        });
-    }
-    static getExpiredHeartbeatIds(redisClient, cb) {
-        const { keyHeartbeatConsumerWeight } = redis_keys_1.redisKeys.getMainKeys();
-        const timestamp = Date.now() - ConsumerHeartbeat.heartbeatTTL;
-        redisClient.zrangebyscore(keyHeartbeatConsumerWeight, '-inf', timestamp, (err, consumerIds) => {
+        const ts = Date.now() - ConsumerHeartbeat.heartbeatTTL;
+        redisClient.zrangebyscore(keyHeartbeatConsumerWeight, '-inf', ts, offset, count, (err, consumerIds) => {
             if (err)
                 cb(err);
             else

package/dist/src/lib/consumer/consumer-queues.js

@@ -15,15 +15,16 @@ exports.consumerQueues = {
             if (err)
                 cb(err);
             else {
+                const consumers = reply !== null && reply !== void 0 ? reply : {};
                 if (transform) {
                     const data = {};
-                    redis_smq_common_1.async.each(reply !== null && reply !== void 0 ? reply : {}, (item, key, done) => {
+                    redis_smq_common_1.async.eachIn(consumers, (item, key, done) => {
                         data[key] = JSON.parse(item);
                         done();
                     }, () => cb(null, data));
                 }
                 else
-                    cb(null, reply !== null && reply !== void 0 ? reply : {});
+                    cb(null, consumers);
             }
         });
     },

package/dist/src/lib/consumer/consumer.d.ts

@@ -1,4 +1,4 @@
-import { TConsumerMessageHandler, TConsumerRedisKeys, TConsumerInfo, TQueueParams, IConfig } from '../../../types';
+import { TConsumerMessageHandler, TConsumerRedisKeys, TConsumerInfo, TQueueParams, IConfig, TConsumerHeartbeat } from '../../../types';
 import { ConsumerHeartbeat } from './consumer-heartbeat';
 import { Base } from '../base';
 import { MessageHandlerRunner } from './consumer-message-handler/message-handler-runner';
@@ -23,11 +23,9 @@ export declare class Consumer extends Base {
     cancel(queue: string | TQueueParams, cb: ICallback<void>): void;
     getQueues(): TQueueParams[];
     getRedisKeys(): TConsumerRedisKeys;
-    static getOnlineConsumers(redisClient: RedisClient, queue: TQueueParams, transform: boolean | undefined, cb: ICallback<Record<string, TConsumerInfo | string>>): void;
-    static getOnlineConsumerIds(redisClient: RedisClient, queue: TQueueParams, cb: ICallback<string[]>): void;
-    static countOnlineConsumers(redisClient: RedisClient, queue: TQueueParams, cb: ICallback<number>): void;
-    static getConsumerHeartbeats(redisClient: RedisClient, cb: ICallback<{
-        consumerId: string;
-        payload: string;
-    }[]>): void;
+    static getConsumersHeartbeats(redisClient: RedisClient, consumersIds: string[], cb: ICallback<Record<string, TConsumerHeartbeat | false>>): void;
+    static getConsumerHeartbeat(redisClient: RedisClient, consumerId: string, cb: ICallback<TConsumerHeartbeat | false>): void;
+    static getQueueConsumers(redisClient: RedisClient, queue: TQueueParams, transform: boolean | undefined, cb: ICallback<Record<string, TConsumerInfo | string>>): void;
+    static getQueueConsumerIds(redisClient: RedisClient, queue: TQueueParams, cb: ICallback<string[]>): void;
+    static countQueueConsumers(redisClient: RedisClient, queue: TQueueParams, cb: ICallback<number>): void;
 }

package/dist/src/lib/consumer/consumer.js

@@ -116,18 +116,26 @@ class Consumer extends base_1.Base {
     getRedisKeys() {
         return this.redisKeys;
     }
-    static getOnlineConsumers(redisClient, queue, transform = false, cb) {
+    static getConsumersHeartbeats(redisClient, consumersIds, cb) {
+        consumer_heartbeat_1.ConsumerHeartbeat.getConsumersHeartbeats(redisClient, consumersIds, cb);
+    }
+    static getConsumerHeartbeat(redisClient, consumerId, cb) {
+        consumer_heartbeat_1.ConsumerHeartbeat.getConsumersHeartbeats(redisClient, [consumerId], (err, consumersHeartbeats = {}) => {
+            if (err)
+                cb(err);
+            else
+                cb(null, consumersHeartbeats[consumerId]);
+        });
+    }
+    static getQueueConsumers(redisClient, queue, transform = false, cb) {
         consumer_queues_1.consumerQueues.getQueueConsumers(redisClient, queue, transform, cb);
     }
-    static getOnlineConsumerIds(redisClient, queue, cb) {
+    static getQueueConsumerIds(redisClient, queue, cb) {
         consumer_queues_1.consumerQueues.getQueueConsumerIds(redisClient, queue, cb);
     }
-    static countOnlineConsumers(redisClient, queue, cb) {
+    static countQueueConsumers(redisClient, queue, cb) {
         consumer_queues_1.consumerQueues.countQueueConsumers(redisClient, queue, cb);
     }
-    static getConsumerHeartbeats(redisClient, cb) {
-        consumer_heartbeat_1.ConsumerHeartbeat.getValidHeartbeats(redisClient, cb);
-    }
 }
 exports.Consumer = Consumer;
 //# sourceMappingURL=consumer.js.map

package/dist/src/lib/queue-manager/delete-queue-transaction.js

@@ -11,7 +11,7 @@ const queue_not_found_error_1 = require("./errors/queue-not-found.error");
 function validateMessageQueueDeletion(redisClient, queue, cb) {
     const verifyHeartbeats = (consumerIds, cb) => {
         if (consumerIds.length) {
-            consumer_heartbeat_1.ConsumerHeartbeat.validateHeartbeatsOf(redisClient, consumerIds, (err, reply) => {
+            consumer_heartbeat_1.ConsumerHeartbeat.getConsumersHeartbeats(redisClient, consumerIds, (err, reply) => {
                 if (err)
                     cb(err);
                 else {
@@ -29,7 +29,7 @@ function validateMessageQueueDeletion(redisClient, queue, cb) {
             cb();
     };
     const getOnlineConsumers = (cb) => {
-        consumer_1.Consumer.getOnlineConsumerIds(redisClient, queue, cb);
+        consumer_1.Consumer.getQueueConsumerIds(redisClient, queue, cb);
     };
     redis_smq_common_1.async.waterfall([getOnlineConsumers, verifyHeartbeats], (err) => cb(err));
 }

package/dist/src/workers/schedule.worker.js

@@ -11,7 +11,7 @@ class ScheduleWorker extends redis_smq_common_1.Worker {
         super(managed);
         this.fetchMessageIds = (cb) => {
             const { keyScheduledMessageWeight } = redis_keys_1.redisKeys.getMainKeys();
-            this.redisClient.zrangebyscore(keyScheduledMessageWeight, 0, Date.now(), cb);
+            this.redisClient.zrangebyscore(keyScheduledMessageWeight, 0, Date.now(), 0, 100, cb);
         };
         this.fetchMessages = (ids, cb) => {
             if (ids.length) {

package/dist/src/workers/watchdog.worker.js

@@ -10,7 +10,7 @@ class WatchdogWorker extends redis_smq_common_1.Worker {
     constructor(redisClient, config, managed, logger) {
         super(managed);
         this.work = (cb) => {
-            consumer_heartbeat_1.ConsumerHeartbeat.getExpiredHeartbeatIds(this.redisClient, (err, reply) => {
+            consumer_heartbeat_1.ConsumerHeartbeat.getExpiredHeartbeatIds(this.redisClient, 0, 100, (err, reply) => {
                 if (err)
                     cb(err);
                 else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-smq",
-  "version": "7.2.1",
+  "version": "7.2.3",
   "description": "A simple high-performance Redis message queue for Node.js.",
   "author": "Weyoss <weyoss@protonmail.com>",
   "license": "MIT",
@@ -39,7 +39,7 @@
     "uuid": "9.0.0"
   },
   "peerDependencies": {
-    "redis-smq-common": "^1.0.6"
+    "redis-smq-common": "^2.0.0"
   },
   "devDependencies": {
     "@types/bluebird": "3.5.38",
@@ -51,7 +51,6 @@
     "@types/uuid": "9.0.0",
     "@typescript-eslint/eslint-plugin": "4.32.0",
     "@typescript-eslint/parser": "4.32.0",
-    "coveralls": "3.1.1",
     "eslint": "7.32.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-prettier": "4.0.0",
@@ -59,7 +58,7 @@
     "jest": "27.2.4",
     "lint-staged": "11.1.2",
     "prettier": "2.4.1",
-    "redis-smq-common": "^1.0.6",
+    "redis-smq-common": "^2.0.0",
     "supertest": "6.1.6",
     "ts-jest": "27.0.5",
     "ts-node": "10.2.1",