redis-smq 7.0.5 → 7.0.6

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 7.0.6 (2022-08-08)
+
+* Improve consumer/producer shutdown handling (36278ce)
+* Update docs (51dfd16)
+* Update examples (208934b)
+* Fix tests (573e340)
+* Add and use ProducerNotRunningError error class (e89facd)
+* Fix a potential MaxListenersExceededWarning exception throwing (011a21b)
+* Make producers to be run manually before producing messages (c989449)
+
 ## 7.0.5 (2022-07-20)
 
 * Remove code redundancies (55eec79)

package/README.md

@@ -141,25 +141,27 @@ Before publishing a message do not forget to set the destination queue of the me
 'use strict';
 const {Message, Producer} = require('redis-smq');
 
-const message = new Message();
-
-message
-    .setBody({hello: 'world'})
-    .setTTL(3600000) // in millis
-    .setQueue('test_queue');
-
-message.getId() // null
-
 const producer = new Producer();
-producer.produce(message, (err) => {
-    if (err) console.log(err);
-    else {
-      const msgId = message.getId(); // string
-      console.log('Successfully produced. Message ID is ', msgId);
-    }
-});
+producer.run((err) => {
+   if (err) throw err;
+   const message = new Message();
+   message
+           .setBody({hello: 'world'})
+           .setTTL(3600000) // in millis
+           .setQueue('test_queue');
+   message.getId() // null
+   producer.produce(message, (err) => {
+      if (err) console.log(err);
+      else {
+         const msgId = message.getId(); // string
+         console.log('Successfully produced. Message ID is ', msgId);
+      }
+   });
+})
 ```
 
+Starting with v7.0.6, before producing messages you need first to run your producer instance.
+
 See [Producer Reference](/docs/api/producer.md) for more details.
 
 #### Consumer Class

package/dist/misc/health-check/combined-run.js

@@ -1,40 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const __1 = require("../..");
 const redis_smq_common_1 = require("redis-smq-common");
-redis_smq_common_1.logger.setLogger(console);
-const config = {
-    logger: {
-        enabled: false,
-    },
-    messages: {
-        store: true,
-    },
-};
-const producer = new __1.Producer(config);
-const consumer = new __1.Consumer(config);
-consumer.run();
-const produce = (err) => {
+const __1 = require("../..");
+const events_1 = require("../../src/common/events/events");
+const queue = `queue_${Date.now()}`;
+const producer = new __1.Producer();
+const produceForever = (err) => {
     if (err)
         console.log(err);
     else {
-        setTimeout(() => {
-            const m = new __1.Message().setBody(Date.now()).setQueue(queue);
-            producer.produce(m, produce);
-        }, 1000);
+        if (producer.isGoingUp() || producer.isRunning()) {
+            const message = new __1.Message().setBody('some data').setQueue(queue);
+            producer.produce(message, produceForever);
+        }
     }
 };
-const queue = `queue_${Date.now()}`;
-__1.QueueManager.createInstance(config, (err, queueManager) => {
+const consumer = new __1.Consumer();
+consumer.consume(queue, (message, cb) => cb(), (err) => err && console.log(err));
+consumer.on(events_1.events.UP, () => {
+    console.log('UP');
+});
+consumer.on(events_1.events.DOWN, () => {
+    console.log('DOWN');
+});
+const serialOnOff = (cb) => redis_smq_common_1.async.waterfall([
+    (cb) => consumer.run((err) => cb(err)),
+    (cb) => consumer.shutdown((err) => cb(err)),
+    (cb) => consumer.run((err) => cb(err)),
+    (cb) => consumer.shutdown((err) => cb(err)),
+    (cb) => consumer.run((err) => cb(err)),
+    (cb) => consumer.shutdown((err) => cb(err)),
+    (cb) => consumer.run((err) => cb(err)),
+    (cb) => consumer.shutdown((err) => cb(err)),
+    (cb) => consumer.run((err) => cb(err)),
+    (cb) => consumer.shutdown((err) => cb(err)),
+], cb);
+let queueManager = null;
+redis_smq_common_1.async.waterfall([
+    (cb) => __1.QueueManager.createInstance({}, (err, instance) => {
+        if (err)
+            cb(err);
+        else {
+            queueManager = instance;
+            queueManager === null || queueManager === void 0 ? void 0 : queueManager.queue.create(queue, false, cb);
+        }
+    }),
+    (cb) => producer.run((err) => cb(err)),
+    (cb) => {
+        produceForever();
+        serialOnOff(cb);
+    },
+], (err) => {
     if (err)
         console.log(err);
     else {
-        queueManager === null || queueManager === void 0 ? void 0 : queueManager.queue.create(queue, false, (err) => {
-            if (err)
-                console.log(err);
-            else
-                consumer.consume(queue, (msg, cb) => cb(), produce);
-        });
+        producer.shutdown();
+        consumer.shutdown();
+        queueManager === null || queueManager === void 0 ? void 0 : queueManager.quit(() => void 0);
     }
 });
 //# sourceMappingURL=combined-run.js.map

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

@@ -10,7 +10,7 @@ export declare abstract class Base extends EventEmitter {
     protected logger: ICompatibleLogger;
     protected config: IRequiredConfig;
     protected eventListeners: IEventListener[];
-    constructor(config: IConfig);
+    constructor(config?: IConfig);
     protected setUpSharedRedisClient: (cb: ICallback<void>) => void;
     protected tearDownSharedRedisClient: (cb: ICallback<void>) => void;
     protected registerSystemEventListeners(): void;

package/dist/src/lib/base.js

@@ -7,7 +7,7 @@ const events_2 = require("../common/events/events");
 const configuration_1 = require("../config/configuration");
 const redis_smq_common_1 = require("redis-smq-common");
 class Base extends events_1.EventEmitter {
-    constructor(config) {
+    constructor(config = {}) {
         super();
         this.sharedRedisClient = null;
         this.eventListeners = [];
@@ -100,46 +100,36 @@ class Base extends events_1.EventEmitter {
         }
     }
     run(cb) {
-        if (this.powerManager.isGoingDown()) {
-            this.once(events_2.events.DOWN, () => this.run(cb));
+        const r = this.powerManager.goingUp();
+        if (r) {
+            this.emit(events_2.events.GOING_UP);
+            const tasks = this.goingUp();
+            redis_smq_common_1.async.waterfall(tasks, (err) => {
+                if (err) {
+                    if (cb)
+                        cb(err);
+                    else
+                        this.emit(events_2.events.ERROR, err);
+                }
+                else
+                    this.up(cb);
+            });
         }
         else {
-            const r = this.powerManager.goingUp();
-            if (r) {
-                this.emit(events_2.events.GOING_UP);
-                const tasks = this.goingUp();
-                redis_smq_common_1.async.waterfall(tasks, (err) => {
-                    if (err) {
-                        if (cb)
-                            cb(err);
-                        else
-                            this.emit(events_2.events.ERROR, err);
-                    }
-                    else
-                        this.up(cb);
-                });
-            }
-            else {
-                cb && cb(null, r);
-            }
+            cb && cb(null, r);
         }
     }
     shutdown(cb) {
-        if (this.powerManager.isGoingUp()) {
-            this.once(events_2.events.UP, () => this.shutdown(cb));
-        }
-        else {
-            const r = this.powerManager.goingDown();
-            if (r) {
-                this.emit(events_2.events.GOING_DOWN);
-                const tasks = this.goingDown();
-                redis_smq_common_1.async.waterfall(tasks, () => {
-                    this.down(cb);
-                });
-            }
-            else
-                cb && cb(null, r);
+        const r = this.powerManager.goingDown();
+        if (r) {
+            this.emit(events_2.events.GOING_DOWN);
+            const tasks = this.goingDown();
+            redis_smq_common_1.async.waterfall(tasks, () => {
+                this.down(cb);
+            });
         }
+        else
+            cb && cb(null, r);
     }
     isRunning() {
         return this.powerManager.isRunning();

package/dist/src/lib/producer/errors/producer-not-running.error.d.ts

@@ -0,0 +1,4 @@
+import { errors } from 'redis-smq-common';
+export declare class ProducerNotRunningError extends errors.RedisSMQError {
+    constructor(msg?: string);
+}

package/dist/src/lib/producer/errors/producer-not-running.error.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProducerNotRunningError = void 0;
+const redis_smq_common_1 = require("redis-smq-common");
+class ProducerNotRunningError extends redis_smq_common_1.errors.RedisSMQError {
+    constructor(msg = `Producer instance is not running. Before producing messages you need to run your producer instance.`) {
+        super(msg);
+    }
+}
+exports.ProducerNotRunningError = ProducerNotRunningError;
+//# sourceMappingURL=producer-not-running.error.js.map

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

@@ -1,10 +1,8 @@
-import { IConfig } from '../../../types';
 import { Message } from '../message/message';
 import { Base } from '../base';
 import { RedisClient } from 'redis-smq-common';
 import { ICallback, TUnaryFunction } from 'redis-smq-common/dist/types';
 export declare class Producer extends Base {
-    constructor(config?: IConfig);
     protected initProducerEventListeners: (cb: ICallback<void>) => void;
     protected goingUp(): TUnaryFunction<ICallback<void>>[];
     protected enqueue(redisClient: RedisClient, message: Message, cb: ICallback<void>): void;

package/dist/src/lib/producer/producer.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Producer = void 0;
 const events_1 = require("../../common/events/events");
 const base_1 = require("../base");
-const redis_smq_common_1 = require("redis-smq-common");
 const redis_keys_1 = require("../../common/redis-keys/redis-keys");
 const message_not_published_error_1 = require("./errors/message-not-published.error");
 const message_queue_required_error_1 = require("./errors/message-queue-required.error");
@@ -11,13 +10,13 @@ const message_already_published_error_1 = require("./errors/message-already-publ
 const redis_client_1 = require("../../common/redis-client/redis-client");
 const schedule_message_1 = require("./schedule-message");
 const queue_1 = require("../queue-manager/queue");
+const producer_not_running_error_1 = require("./errors/producer-not-running.error");
 class Producer extends base_1.Base {
-    constructor(config = {}) {
-        super(config);
+    constructor() {
+        super(...arguments);
         this.initProducerEventListeners = (cb) => {
             this.registerEventListeners(this.config.eventListeners.producerEventListeners, cb);
         };
-        this.run();
     }
     goingUp() {
         return super.goingUp().concat([this.initProducerEventListeners]);
@@ -55,18 +54,20 @@ class Producer extends base_1.Base {
             cb(new message_already_published_error_1.MessageAlreadyPublishedError());
         }
         else {
-            const queueParams = queue_1.Queue.getParams(this.config, queue);
-            message.setQueue(queueParams);
-            const messageId = message.getSetMetadata().getId();
-            const callback = (err) => {
-                if (err)
-                    cb(err);
-                else {
-                    this.emit(events_1.events.MESSAGE_PUBLISHED, message);
-                    cb();
-                }
-            };
-            const proceed = () => {
+            if (!this.powerManager.isUp())
+                cb(new producer_not_running_error_1.ProducerNotRunningError());
+            else {
+                const queueParams = queue_1.Queue.getParams(this.config, queue);
+                message.setQueue(queueParams);
+                const messageId = message.getSetMetadata().getId();
+                const callback = (err) => {
+                    if (err)
+                        cb(err);
+                    else {
+                        this.emit(events_1.events.MESSAGE_PUBLISHED, message);
+                        cb();
+                    }
+                };
                 const redisClient = this.getSharedRedisClient();
                 if (message.isSchedulable()) {
                     (0, schedule_message_1.scheduleMessage)(redisClient, message, (err) => {
@@ -88,17 +89,7 @@ class Producer extends base_1.Base {
                         }
                     });
                 }
-            };
-            if (!this.powerManager.isUp()) {
-                if (this.powerManager.isGoingUp()) {
-                    this.once(events_1.events.UP, proceed);
-                }
-                else {
-                    cb(new redis_smq_common_1.errors.PanicError(`Producer ID ${this.getId()} is not running`));
-                }
             }
-            else
-                proceed();
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-smq",
-  "version": "7.0.5",
+  "version": "7.0.6",
   "description": "A simple high-performance Redis message queue for Node.js.",
   "author": "Weyoss <weyoss@protonmail.com>",
   "license": "MIT",

package/dist/misc/health-check/on-off.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/misc/health-check/on-off.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const redis_smq_common_1 = require("redis-smq-common");
-const __1 = require("../..");
-const events_1 = require("../../src/common/events/events");
-const queue = `queue_${Date.now()}`;
-const producer = new __1.Producer();
-const produceForever = (err) => {
-    if (err)
-        console.log(err);
-    else {
-        if (producer.isGoingUp() || producer.isRunning()) {
-            const message = new __1.Message().setBody('some data').setQueue(queue);
-            producer.produce(message, produceForever);
-        }
-    }
-};
-const consumer = new __1.Consumer();
-consumer.consume(queue, (message, cb) => cb(), (err) => err && console.log(err));
-consumer.on(events_1.events.UP, () => {
-    console.log('UP');
-});
-consumer.on(events_1.events.DOWN, () => {
-    console.log('DOWN');
-});
-const serialOnOff = (cb) => redis_smq_common_1.async.waterfall([
-    (cb) => consumer.run((err) => cb(err)),
-    (cb) => consumer.shutdown((err) => cb(err)),
-    (cb) => consumer.run((err) => cb(err)),
-    (cb) => consumer.shutdown((err) => cb(err)),
-    (cb) => consumer.run((err) => cb(err)),
-    (cb) => consumer.shutdown((err) => cb(err)),
-    (cb) => consumer.run((err) => cb(err)),
-    (cb) => consumer.shutdown((err) => cb(err)),
-    (cb) => consumer.run((err) => cb(err)),
-    (cb) => consumer.shutdown((err) => cb(err)),
-], cb);
-redis_smq_common_1.async.waterfall([
-    (cb) => __1.QueueManager.createInstance({}, (err, queueManager) => {
-        if (err)
-            cb(err);
-        else
-            queueManager === null || queueManager === void 0 ? void 0 : queueManager.queue.create(queue, false, cb);
-    }),
-    (cb) => {
-        produceForever();
-        serialOnOff(cb);
-    },
-], (err) => {
-    if (err)
-        console.log(err);
-    else {
-        producer.shutdown();
-        consumer.shutdown();
-        __1.QueueManager.createInstance({}, (err, queueManager) => queueManager === null || queueManager === void 0 ? void 0 : queueManager.quit(() => void 0));
-    }
-});
-//# sourceMappingURL=on-off.js.map