redis-smq 7.0.0-rc.0 → 7.0.0-rc.3

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # CHANGELOG
 
+## 7.0.0-rc.3 (2022-05-26)
+
+* Update migration/configuration/message/message-manager references (6d53877)
+* Update docs (df2eddb)
+* Bump up redis-smq-common to v1.0.0-rc.3, refactor (0508c75)
+* Bump up redis-smq-common to v1.0.0-rc.2 (f38d757)
+* Remove singletons, use instance based configuration (65f28ec)
+* Fix 'fsevents not accessible from jest-haste-map' error (1cbc786)
+* Use shared components from redis-smq-common (2abfb98)
+* Reorganize codebase folders (cdf25fa)
+* Clean up redis-keys.ts (c6b8af8)
+* Add PluginRegistrationNotAllowedError error, clean up (aa003a1)
+* Update tests (0950706)
+* Implement a plugging system for using the web-ui as an extension (e2b0cca)
+* Fix tests (ca01d66)
+* Reorganize codebase files (2cef191)
+* Remove the web ui from codebase, clean up (ffe03c9)
+* Update http-api.md (4023dc5)
+
+## 7.0.0-rc.2 (2022-05-18)
+
+* Fix typo (8002616)
+* Update docs (d40b1c2)
+* Update misc scripts (bde5171)
+* Clean up WebsocketRateStreamWorker, use incremental timestamp (918fac0)
+
+## 7.0.0-rc.1 (2022-05-15)
+
+* Update docs (41ee4bf)
+* Fix consuming-messages/test00015 test (8b3072a)
+* Clean up and simplify the consumer.consume() callback argument (bd98b65)
+* Update docs (9ede0f6)
+* Update tests (b1772aa)
+* Refactor configuration object (2ebe1ba)
+* Make QueueManager constructor private (c55cdad)
+* Update redisKeys version (add3e8d)
+* Update scheduling-messages.md (4b2bb2d)
+* Update multiplexing.md (f36f712)
+
 ## 7.0.0-rc.0 (2022-05-13)
 
 * Update LICENSE (2ef31db)

package/README.md

@@ -1,17 +1,22 @@
 <div align="center" style="text-align: center">
   <p><a href="https://github.com/weyoss/redis-smq"><img alt="RedisSMQ" src="./logo.png" /></a></p>
   <p>A simple high-performance Redis message queue for Node.js.</p>
-  <p>
-    <a href="https://github.com/weyoss/redis-smq/actions/workflows/tests.yml"><img src="https://github.com/weyoss/redis-smq/actions/workflows/tests.yml/badge.svg" alt="Tests" style="max-width:100%;" /></a>
-    <a href="https://coveralls.io/r/weyoss/redis-smq?branch=master" rel="nofollow"><img src="https://img.shields.io/coveralls/github/weyoss/redis-smq.svg" alt="Coverage Status" /></a>
-    <a href="https://npmjs.org/package/redis-smq" rel="nofollow"><img src="https://img.shields.io/npm/v/redis-smq.svg" alt="NPM version" /></a>
-    <a href="https://npmjs.org/package/redis-smq" rel="nofollow"><img src="https://img.shields.io/npm/dm/redis-smq.svg" alt="NPM downloads" /></a>
-    <a href="https://lgtm.com/projects/g/weyoss/redis-smq/context:javascript" rel="nofollow"><img src="https://img.shields.io/lgtm/grade/javascript/github/weyoss/redis-smq.svg?logo=lgtm&logoWidth=18" alt="Code quality" /></a>
-  </p>
 </div>
 
+# RedisSMQ
+
+<p>
+   <a href="https://github.com/weyoss/redis-smq/actions/workflows/tests.yml"><img src="https://github.com/weyoss/redis-smq/actions/workflows/tests.yml/badge.svg" alt="Tests" style="max-width:100%;" /></a>
+   <a href="https://coveralls.io/r/weyoss/redis-smq?branch=master" rel="nofollow"><img src="https://img.shields.io/coveralls/github/weyoss/redis-smq.svg" alt="Coverage Status" /></a>
+   <a href="https://npmjs.org/package/redis-smq" rel="nofollow"><img src="https://img.shields.io/npm/v/redis-smq.svg" alt="NPM version" /></a>
+   <a href="https://npmjs.org/package/redis-smq" rel="nofollow"><img src="https://img.shields.io/npm/dm/redis-smq.svg" alt="NPM downloads" /></a>
+   <a href="https://lgtm.com/projects/g/weyoss/redis-smq/context:javascript" rel="nofollow"><img src="https://img.shields.io/lgtm/grade/javascript/github/weyoss/redis-smq.svg?logo=lgtm&logoWidth=18" alt="Code quality" /></a>
+</p>
+
 RedisSMQ is a Node.js library for queuing messages (aka jobs) and processing them asynchronously with consumers. Backed by Redis, it allows scaling up your application with ease of use.
 
+> ☝ The master branch reflects the latest changes and updates. It is currently going under heavy development. To view the documentation of the latest stable release see [v6.4.2 docs](https://github.com/weyoss/redis-smq/tree/v6.4.2).
+
 ## Features
 
 * **[High-performance message processing](docs/performance.md)**
@@ -23,8 +28,8 @@ RedisSMQ is a Node.js library for queuing messages (aka jobs) and processing the
 * **[Scheduling Messages](docs/scheduling-messages.md)**: Messages can be configured to be delayed, delivered for N times with an optional period between deliveries, and to be scheduled using CRON expressions.
 * **[Reliable Priority Queues](docs/priority-queues.md)**: Supports priority messaging.
 * **[Multiplexing](docs/multiplexing.md)**: A feature which allows message handlers to use a single redis connection to dequeue and consume messages.  
-* **[HTTP API](docs/http-api.md)**: an HTTP interface is provided to interact with the MQ.
-* **[Web UI](docs/web-ui.md)**: RedisSMQ can be managed also from your web browser.
+* **[HTTP API](https://github.com/weyoss/redis-smq-monitor)**: an HTTP interface is provided to interact with the MQ.
+* **[Web UI](https://github.com/weyoss/redis-smq-monitor-client)**: RedisSMQ can be managed also from your web browser.
 * **[Logging](docs/logs.md)**: Comes with a built-in JSON logger. But you can also use your own logger instance.
 * **[Configurable](docs/configuration.md)**: Many options and features can be configured.
 * **Both redis & ioredis clients are supported**: RedisSMQ can be configured to use either `redis` or `ioredis` to connect to Redis server.
@@ -55,8 +60,8 @@ RedisSMQ is a Node.js library for queuing messages (aka jobs) and processing the
       4. [Multiplexing](docs/multiplexing.md)
       5. [Message Manager](docs/api/message-manager.md)
       6. [Queue Manager](docs/api/queue-manager.md)
-      7. [HTTP API](docs/http-api.md)
-      8. [Web UI](docs/web-ui.md)
+      7. [HTTP API](https://github.com/weyoss/redis-smq-monitor)
+      8. [Web UI](https://github.com/weyoss/redis-smq-monitor-client)
       9. [Logs](docs/logs.md)
 5. [RedisSMQ Architecture](docs/redis-smq-architecture.md)
 6. [Performance](#performance)
@@ -67,9 +72,8 @@ RedisSMQ is a Node.js library for queuing messages (aka jobs) and processing the
 
 **2022.05.13**
 
-:rocket: Release 7.0.0-rc.0 is ready! The RedisSMQ v7 is a refinement release with many improvements toward making 
-things more simple to use and removing any confusions that can occur while working with the message queue. If you are 
-upgrading your installation, take a look at the [migration guide](docs/migrating-from-v6-to-v7.md).
+:rocket: Release v7 is coming out! The RedisSMQ v7 is a refinement release with many improvements toward making 
+things more simple to use and removing any confusions that can occur while working with the message queue.
 
 ## Installation
 
@@ -95,7 +99,7 @@ You can create a queue, view existing queues, or delete a queue using the [Queue
 ```javascript
 const { QueueManager } = require('redis-smq');
 
-QueueManager.getSingletonInstance((err, queueManager) => {
+QueueManager.createInstance((err, queueManager) => {
   if (err) console.log(err);
   else queueManager.queue.create('test_queue', false, (err) => console.log(err));
 })
@@ -190,10 +194,8 @@ const messageHandler = (msg, cb) => {
    cb(); // acknowledging the message
 };
 
-consumer.consume('test_queue', messageHandler, (err, isRunning) => {
+consumer.consume('test_queue', messageHandler, (err) => {
    if (err) console.error(err);
-   // the message handler will be started only if the consumer is running
-   else console.log(`Message handler has been registered. Running status: ${isRunning}`);
 });
 
 consumer.run();
@@ -227,9 +229,9 @@ See [Consumer Reference](docs/api/consumer.md) for more details.
 
 * [Queue Manager](docs/api/queue-manager.md)
 
-* [HTTP API](docs/http-api.md)
+* [HTTP API](https://github.com/weyoss/redis-smq-monitor)
 
-* [Web UI](docs/web-ui.md)
+* [Web UI](https://github.com/weyoss/redis-smq-monitor-client)
 
 * [Logs](docs/logs.md)
 

package/dist/index.d.ts

@@ -1,8 +1,7 @@
-export { Consumer } from './src/consumer';
-export { Producer } from './src/producer';
-export { Message } from './src/message';
-export { MessageManager } from './src/message-manager';
-export { QueueManager } from './src/queue-manager';
-export { MonitorServer } from './src/monitor-server';
-export { setConfiguration } from './src/system/common/configuration/configuration';
-export { setLogger } from './src/system/common/logger';
+export { events } from './src/common/events/events';
+export { Consumer } from './src/lib/consumer/consumer';
+export { Producer } from './src/lib/producer/producer';
+export { Message } from './src/lib/message/message';
+export { MessageManager } from './src/lib/message-manager/message-manager';
+export { QueueManager } from './src/lib/queue-manager/queue-manager';
+export { registerProducerPlugin, registerConsumerPlugin, } from './src/plugins/plugins';

package/dist/index.js

@@ -1,20 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setLogger = exports.setConfiguration = exports.MonitorServer = exports.QueueManager = exports.MessageManager = exports.Message = exports.Producer = exports.Consumer = void 0;
-var consumer_1 = require("./src/consumer");
+exports.registerConsumerPlugin = exports.registerProducerPlugin = exports.QueueManager = exports.MessageManager = exports.Message = exports.Producer = exports.Consumer = exports.events = void 0;
+var events_1 = require("./src/common/events/events");
+Object.defineProperty(exports, "events", { enumerable: true, get: function () { return events_1.events; } });
+var consumer_1 = require("./src/lib/consumer/consumer");
 Object.defineProperty(exports, "Consumer", { enumerable: true, get: function () { return consumer_1.Consumer; } });
-var producer_1 = require("./src/producer");
+var producer_1 = require("./src/lib/producer/producer");
 Object.defineProperty(exports, "Producer", { enumerable: true, get: function () { return producer_1.Producer; } });
-var message_1 = require("./src/message");
+var message_1 = require("./src/lib/message/message");
 Object.defineProperty(exports, "Message", { enumerable: true, get: function () { return message_1.Message; } });
-var message_manager_1 = require("./src/message-manager");
+var message_manager_1 = require("./src/lib/message-manager/message-manager");
 Object.defineProperty(exports, "MessageManager", { enumerable: true, get: function () { return message_manager_1.MessageManager; } });
-var queue_manager_1 = require("./src/queue-manager");
+var queue_manager_1 = require("./src/lib/queue-manager/queue-manager");
 Object.defineProperty(exports, "QueueManager", { enumerable: true, get: function () { return queue_manager_1.QueueManager; } });
-var monitor_server_1 = require("./src/monitor-server");
-Object.defineProperty(exports, "MonitorServer", { enumerable: true, get: function () { return monitor_server_1.MonitorServer; } });
-var configuration_1 = require("./src/system/common/configuration/configuration");
-Object.defineProperty(exports, "setConfiguration", { enumerable: true, get: function () { return configuration_1.setConfiguration; } });
-var logger_1 = require("./src/system/common/logger");
-Object.defineProperty(exports, "setLogger", { enumerable: true, get: function () { return logger_1.setLogger; } });
+var plugins_1 = require("./src/plugins/plugins");
+Object.defineProperty(exports, "registerProducerPlugin", { enumerable: true, get: function () { return plugins_1.registerProducerPlugin; } });
+Object.defineProperty(exports, "registerConsumerPlugin", { enumerable: true, get: function () { return plugins_1.registerConsumerPlugin; } });
 //# sourceMappingURL=index.js.map

package/dist/misc/health-check/combined-run.d.ts

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

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

@@ -0,0 +1,40 @@
+"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) => {
+    if (err)
+        console.log(err);
+    else {
+        setTimeout(() => {
+            const m = new __1.Message().setBody(Date.now()).setQueue(queue);
+            producer.produce(m, produce);
+        }, 1000);
+    }
+};
+const queue = `queue_${Date.now()}`;
+__1.QueueManager.createInstance(config, (err, queueManager) => {
+    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);
+        });
+    }
+});
+//# sourceMappingURL=combined-run.js.map

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

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

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

@@ -0,0 +1,58 @@
+"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

package/dist/src/{system/common → common/events}/events.d.ts

@@ -1,17 +1,14 @@
 export declare const events: {
-    GOING_UP: string;
-    UP: string;
-    GOING_DOWN: string;
-    DOWN: string;
-    ERROR: string;
-    IDLE: string;
-    SHUTDOWN_READY: string;
     MESSAGE_PUBLISHED: string;
     MESSAGE_NEXT: string;
     MESSAGE_RECEIVED: string;
     MESSAGE_ACKNOWLEDGED: string;
     MESSAGE_UNACKNOWLEDGED: string;
     MESSAGE_DEAD_LETTERED: string;
-    RATE_TICK: string;
-    HEARTBEAT_TICK: string;
+    GOING_UP: string;
+    UP: string;
+    GOING_DOWN: string;
+    DOWN: string;
+    ERROR: string;
+    TICK: string;
 };

package/dist/src/common/events/events.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.events = void 0;
+const redis_smq_common_1 = require("redis-smq-common");
+exports.events = Object.assign(Object.assign({}, redis_smq_common_1.events), { MESSAGE_PUBLISHED: 'message_produced', MESSAGE_NEXT: 'message_next', MESSAGE_RECEIVED: 'message_received', MESSAGE_ACKNOWLEDGED: 'message_acknowledged', MESSAGE_UNACKNOWLEDGED: 'message_unacknowledged', MESSAGE_DEAD_LETTERED: 'message_dead_lettered' });
+//# sourceMappingURL=events.js.map

package/dist/src/common/redis-client/redis-client.d.ts

@@ -0,0 +1,9 @@
+export declare enum ELuaScriptName {
+    ENQUEUE_SCHEDULED_MESSAGE = "ENQUEUE_SCHEDULED_MESSAGE",
+    PUBLISH_MESSAGE = "PUBLISH_MESSAGE",
+    REQUEUE_MESSAGE = "REQUEUE_MESSAGE",
+    SCHEDULE_MESSAGE = "SCHEDULE_MESSAGE",
+    HAS_QUEUE_RATE_EXCEEDED = "HAS_QUEUE_RATE_EXCEEDED",
+    CREATE_QUEUE = "CREATE_QUEUE",
+    INIT_CONSUMER_QUEUE = "INIT_CONSUMER_QUEUE"
+}

package/dist/src/common/redis-client/redis-client.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ELuaScriptName = void 0;
+const redis_smq_common_1 = require("redis-smq-common");
+const fs = require("fs");
+var ELuaScriptName;
+(function (ELuaScriptName) {
+    ELuaScriptName["ENQUEUE_SCHEDULED_MESSAGE"] = "ENQUEUE_SCHEDULED_MESSAGE";
+    ELuaScriptName["PUBLISH_MESSAGE"] = "PUBLISH_MESSAGE";
+    ELuaScriptName["REQUEUE_MESSAGE"] = "REQUEUE_MESSAGE";
+    ELuaScriptName["SCHEDULE_MESSAGE"] = "SCHEDULE_MESSAGE";
+    ELuaScriptName["HAS_QUEUE_RATE_EXCEEDED"] = "HAS_QUEUE_RATE_EXCEEDED";
+    ELuaScriptName["CREATE_QUEUE"] = "CREATE_QUEUE";
+    ELuaScriptName["INIT_CONSUMER_QUEUE"] = "INIT_CONSUMER_QUEUE";
+})(ELuaScriptName = exports.ELuaScriptName || (exports.ELuaScriptName = {}));
+redis_smq_common_1.RedisClient.addScript(ELuaScriptName.ENQUEUE_SCHEDULED_MESSAGE, fs.readFileSync(`${__dirname}/lua/enqueue-scheduled-message.lua`).toString());
+redis_smq_common_1.RedisClient.addScript(ELuaScriptName.PUBLISH_MESSAGE, fs.readFileSync(`${__dirname}/lua/publish-message.lua`).toString());
+redis_smq_common_1.RedisClient.addScript(ELuaScriptName.REQUEUE_MESSAGE, fs.readFileSync(`${__dirname}/lua/requeue-message.lua`).toString());
+redis_smq_common_1.RedisClient.addScript(ELuaScriptName.SCHEDULE_MESSAGE, fs.readFileSync(`${__dirname}/lua/schedule-message.lua`).toString());
+redis_smq_common_1.RedisClient.addScript(ELuaScriptName.HAS_QUEUE_RATE_EXCEEDED, fs.readFileSync(`${__dirname}/lua/has-queue-rate-exceeded.lua`).toString());
+redis_smq_common_1.RedisClient.addScript(ELuaScriptName.CREATE_QUEUE, fs.readFileSync(`${__dirname}/lua/create-queue.lua`).toString());
+redis_smq_common_1.RedisClient.addScript(ELuaScriptName.INIT_CONSUMER_QUEUE, fs.readFileSync(`${__dirname}/lua/init-consumer-queue.lua`).toString());
+//# sourceMappingURL=redis-client.js.map

package/dist/src/common/redis-keys/redis-keys.d.ts

@@ -0,0 +1,86 @@
+import { TQueueParams } from '../../../types';
+export declare const redisKeys: {
+    getNamespaceKeys(ns: string): {
+        keyNsQueues: string;
+        keyQueues: string;
+        keyProcessingQueues: string;
+        keyHeartbeats: string;
+        keyHeartbeatConsumerWeight: string;
+        keyScheduledMessages: string;
+        keyScheduledMessageWeight: string;
+        keyLockConsumerWorkersRunner: string;
+        keyDelayedMessages: string;
+        keyRequeueMessages: string;
+        keyNamespaces: string;
+        keyQueueSettingsRateLimit: string;
+        keyQueueSettingsPriorityQueuing: string;
+    };
+    getQueueKeys(queueParams: TQueueParams): {
+        keyQueuePending: string;
+        keyQueueDL: string;
+        keyQueueProcessingQueues: string;
+        keyQueueAcknowledged: string;
+        keyQueuePendingPriorityMessageWeight: string;
+        keyQueuePendingPriorityMessages: string;
+        keyQueueConsumers: string;
+        keyQueueRateLimitCounter: string;
+        keyQueueSettings: string;
+        keyNsQueues: string;
+        keyQueues: string;
+        keyProcessingQueues: string;
+        keyHeartbeats: string;
+        keyHeartbeatConsumerWeight: string;
+        keyScheduledMessages: string;
+        keyScheduledMessageWeight: string;
+        keyLockConsumerWorkersRunner: string;
+        keyDelayedMessages: string;
+        keyRequeueMessages: string;
+        keyNamespaces: string;
+        keyQueueSettingsRateLimit: string;
+        keyQueueSettingsPriorityQueuing: string;
+    };
+    getConsumerKeys(instanceId: string): {
+        keyConsumerQueues: string;
+        keyQueues: string;
+        keyProcessingQueues: string;
+        keyHeartbeats: string;
+        keyHeartbeatConsumerWeight: string;
+        keyScheduledMessages: string;
+        keyScheduledMessageWeight: string;
+        keyLockConsumerWorkersRunner: string;
+        keyDelayedMessages: string;
+        keyRequeueMessages: string;
+        keyNamespaces: string;
+        keyQueueSettingsRateLimit: string;
+        keyQueueSettingsPriorityQueuing: string;
+    };
+    getQueueConsumerKeys(queueParams: TQueueParams, instanceId: string): {
+        keyQueueProcessing: string;
+        keyConsumerQueues: string;
+        keyQueues: string;
+        keyProcessingQueues: string;
+        keyHeartbeats: string;
+        keyHeartbeatConsumerWeight: string;
+        keyScheduledMessages: string;
+        keyScheduledMessageWeight: string;
+        keyLockConsumerWorkersRunner: string;
+        keyDelayedMessages: string;
+        keyRequeueMessages: string;
+        keyNamespaces: string;
+        keyQueueSettingsRateLimit: string;
+        keyQueueSettingsPriorityQueuing: string;
+        keyQueuePending: string;
+        keyQueueDL: string;
+        keyQueueProcessingQueues: string;
+        keyQueueAcknowledged: string;
+        keyQueuePendingPriorityMessageWeight: string;
+        keyQueuePendingPriorityMessages: string;
+        keyQueueConsumers: string;
+        keyQueueRateLimitCounter: string;
+        keyQueueSettings: string;
+        keyNsQueues: string;
+    };
+    getMainKeys(): Record<"keyQueues" | "keyProcessingQueues" | "keyHeartbeats" | "keyHeartbeatConsumerWeight" | "keyScheduledMessages" | "keyScheduledMessageWeight" | "keyLockConsumerWorkersRunner" | "keyDelayedMessages" | "keyRequeueMessages" | "keyNamespaces" | "keyQueueSettingsRateLimit" | "keyQueueSettingsPriorityQueuing", string>;
+    validateNamespace(ns: string): string;
+    validateRedisKey(key?: string | undefined): string;
+};

package/dist/src/common/redis-keys/redis-keys.error.d.ts

@@ -0,0 +1,3 @@
+import { errors } from 'redis-smq-common';
+export declare class RedisKeysError extends errors.RedisSMQError {
+}

package/dist/src/common/redis-keys/redis-keys.error.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisKeysError = void 0;
+const redis_smq_common_1 = require("redis-smq-common");
+class RedisKeysError extends redis_smq_common_1.errors.RedisSMQError {
+}
+exports.RedisKeysError = RedisKeysError;
+//# sourceMappingURL=redis-keys.error.js.map

package/dist/src/common/redis-keys/redis-keys.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redisKeys = void 0;
+const redis_keys_error_1 = require("./redis-keys.error");
+const keySegmentSeparator = ':';
+const nsPrefix = 'redis-smq-v700-rc0';
+const globalNamespace = 'global';
+var ERedisKey;
+(function (ERedisKey) {
+    ERedisKey[ERedisKey["KEY_QUEUE_PENDING"] = 1] = "KEY_QUEUE_PENDING";
+    ERedisKey[ERedisKey["KEY_QUEUE_PENDING_PRIORITY_MESSAGES"] = 2] = "KEY_QUEUE_PENDING_PRIORITY_MESSAGES";
+    ERedisKey[ERedisKey["KEY_QUEUE_PENDING_PRIORITY_MESSAGE_WEIGHT"] = 3] = "KEY_QUEUE_PENDING_PRIORITY_MESSAGE_WEIGHT";
+    ERedisKey[ERedisKey["KEY_QUEUE_DL"] = 4] = "KEY_QUEUE_DL";
+    ERedisKey[ERedisKey["KEY_QUEUE_PROCESSING"] = 5] = "KEY_QUEUE_PROCESSING";
+    ERedisKey[ERedisKey["KEY_QUEUE_ACKNOWLEDGED"] = 6] = "KEY_QUEUE_ACKNOWLEDGED";
+    ERedisKey[ERedisKey["KEY_QUEUE_CONSUMERS"] = 7] = "KEY_QUEUE_CONSUMERS";
+    ERedisKey[ERedisKey["KEY_QUEUE_PROCESSING_QUEUES"] = 8] = "KEY_QUEUE_PROCESSING_QUEUES";
+    ERedisKey[ERedisKey["KEY_LOCK_CONSUMER_WORKERS_RUNNER"] = 9] = "KEY_LOCK_CONSUMER_WORKERS_RUNNER";
+    ERedisKey[ERedisKey["KEY_DELAYED_MESSAGES"] = 10] = "KEY_DELAYED_MESSAGES";
+    ERedisKey[ERedisKey["KEY_REQUEUE_MESSAGES"] = 11] = "KEY_REQUEUE_MESSAGES";
+    ERedisKey[ERedisKey["KEY_SCHEDULED_MESSAGES"] = 12] = "KEY_SCHEDULED_MESSAGES";
+    ERedisKey[ERedisKey["KEY_SCHEDULED_MESSAGE_WEIGHT"] = 13] = "KEY_SCHEDULED_MESSAGE_WEIGHT";
+    ERedisKey[ERedisKey["KEY_HEARTBEATS"] = 14] = "KEY_HEARTBEATS";
+    ERedisKey[ERedisKey["KEY_HEARTBEAT_CONSUMER_WEIGHT"] = 15] = "KEY_HEARTBEAT_CONSUMER_WEIGHT";
+    ERedisKey[ERedisKey["KEY_QUEUES"] = 16] = "KEY_QUEUES";
+    ERedisKey[ERedisKey["KEY_PROCESSING_QUEUES"] = 17] = "KEY_PROCESSING_QUEUES";
+    ERedisKey[ERedisKey["KEY_CONSUMER_QUEUES"] = 18] = "KEY_CONSUMER_QUEUES";
+    ERedisKey[ERedisKey["KEY_NS_QUEUES"] = 19] = "KEY_NS_QUEUES";
+    ERedisKey[ERedisKey["KEY_NAMESPACES"] = 20] = "KEY_NAMESPACES";
+    ERedisKey[ERedisKey["KEY_QUEUE_RATE_LIMIT_COUNTER"] = 21] = "KEY_QUEUE_RATE_LIMIT_COUNTER";
+    ERedisKey[ERedisKey["KEY_QUEUE_SETTINGS"] = 22] = "KEY_QUEUE_SETTINGS";
+    ERedisKey[ERedisKey["KEY_QUEUE_SETTINGS_RATE_LIMIT"] = 23] = "KEY_QUEUE_SETTINGS_RATE_LIMIT";
+    ERedisKey[ERedisKey["KEY_QUEUE_SETTINGS_PRIORITY_QUEUING"] = 24] = "KEY_QUEUE_SETTINGS_PRIORITY_QUEUING";
+})(ERedisKey || (ERedisKey = {}));
+function makeNamespacedKeys(keys, namespace, ...rest) {
+    const result = {};
+    for (const k in keys) {
+        result[k] = [nsPrefix, namespace, keys[k], ...rest].join(keySegmentSeparator);
+    }
+    return result;
+}
+exports.redisKeys = {
+    getNamespaceKeys(ns) {
+        const mainKeys = this.getMainKeys();
+        const keys = {
+            keyNsQueues: ERedisKey.KEY_NS_QUEUES,
+        };
+        return Object.assign(Object.assign({}, mainKeys), makeNamespacedKeys(keys, ns));
+    },
+    getQueueKeys(queueParams) {
+        const nsKeys = this.getNamespaceKeys(queueParams.ns);
+        const queueKeys = {
+            keyQueuePending: ERedisKey.KEY_QUEUE_PENDING,
+            keyQueueDL: ERedisKey.KEY_QUEUE_DL,
+            keyQueueProcessingQueues: ERedisKey.KEY_QUEUE_PROCESSING_QUEUES,
+            keyQueueAcknowledged: ERedisKey.KEY_QUEUE_ACKNOWLEDGED,
+            keyQueuePendingPriorityMessageWeight: ERedisKey.KEY_QUEUE_PENDING_PRIORITY_MESSAGE_WEIGHT,
+            keyQueuePendingPriorityMessages: ERedisKey.KEY_QUEUE_PENDING_PRIORITY_MESSAGES,
+            keyQueueConsumers: ERedisKey.KEY_QUEUE_CONSUMERS,
+            keyQueueRateLimitCounter: ERedisKey.KEY_QUEUE_RATE_LIMIT_COUNTER,
+            keyQueueSettings: ERedisKey.KEY_QUEUE_SETTINGS,
+        };
+        return Object.assign(Object.assign({}, nsKeys), makeNamespacedKeys(queueKeys, queueParams.ns, queueParams.name));
+    },
+    getConsumerKeys(instanceId) {
+        const mainKeys = this.getMainKeys();
+        const consumerKeys = {
+            keyConsumerQueues: ERedisKey.KEY_CONSUMER_QUEUES,
+        };
+        return Object.assign(Object.assign({}, mainKeys), makeNamespacedKeys(consumerKeys, globalNamespace, instanceId));
+    },
+    getQueueConsumerKeys(queueParams, instanceId) {
+        const queueKeys = this.getQueueKeys(queueParams);
+        const consumerKeys = this.getConsumerKeys(instanceId);
+        const consumerQueueKeys = {
+            keyQueueProcessing: ERedisKey.KEY_QUEUE_PROCESSING,
+        };
+        return Object.assign(Object.assign(Object.assign({}, queueKeys), consumerKeys), makeNamespacedKeys(consumerQueueKeys, queueParams.ns, queueParams.name, instanceId));
+    },
+    getMainKeys() {
+        const mainKeys = {
+            keyQueues: ERedisKey.KEY_QUEUES,
+            keyProcessingQueues: ERedisKey.KEY_PROCESSING_QUEUES,
+            keyHeartbeats: ERedisKey.KEY_HEARTBEATS,
+            keyHeartbeatConsumerWeight: ERedisKey.KEY_HEARTBEAT_CONSUMER_WEIGHT,
+            keyScheduledMessages: ERedisKey.KEY_SCHEDULED_MESSAGES,
+            keyScheduledMessageWeight: ERedisKey.KEY_SCHEDULED_MESSAGE_WEIGHT,
+            keyLockConsumerWorkersRunner: ERedisKey.KEY_LOCK_CONSUMER_WORKERS_RUNNER,
+            keyDelayedMessages: ERedisKey.KEY_DELAYED_MESSAGES,
+            keyRequeueMessages: ERedisKey.KEY_REQUEUE_MESSAGES,
+            keyNamespaces: ERedisKey.KEY_NAMESPACES,
+            keyQueueSettingsRateLimit: ERedisKey.KEY_QUEUE_SETTINGS_RATE_LIMIT,
+            keyQueueSettingsPriorityQueuing: ERedisKey.KEY_QUEUE_SETTINGS_PRIORITY_QUEUING,
+        };
+        return makeNamespacedKeys(mainKeys, globalNamespace);
+    },
+    validateNamespace(ns) {
+        ns = this.validateRedisKey(ns);
+        if (ns === globalNamespace) {
+            throw new redis_keys_error_1.RedisKeysError(`Namespace [${ns}] is reserved. Use another one.`);
+        }
+        return ns;
+    },
+    validateRedisKey(key) {
+        if (!key || !key.length) {
+            throw new redis_keys_error_1.RedisKeysError('Invalid Redis key. Expected be a non empty string.');
+        }
+        const filtered = key.toLowerCase().replace(/[^a-z0-9_-]/g, '');
+        if (filtered.length !== key.length) {
+            throw new redis_keys_error_1.RedisKeysError('Invalid Redis key. Only letters (a-z), numbers (0-9) and (-_) are allowed.');
+        }
+        return filtered;
+    },
+};
+//# sourceMappingURL=redis-keys.js.map

package/dist/src/config/configuration.d.ts

@@ -0,0 +1,2 @@
+import { IConfig, IRequiredConfig } from '../../types';
+export declare function getConfiguration(config?: IConfig): IRequiredConfig;

package/dist/src/config/configuration.error.d.ts

@@ -0,0 +1,3 @@
+import { errors } from 'redis-smq-common';
+export declare class ConfigurationError extends errors.RedisSMQError {
+}

package/dist/src/config/configuration.error.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurationError = void 0;
+const redis_smq_common_1 = require("redis-smq-common");
+class ConfigurationError extends redis_smq_common_1.errors.RedisSMQError {
+}
+exports.ConfigurationError = ConfigurationError;
+//# sourceMappingURL=configuration.error.js.map

package/dist/src/config/configuration.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfiguration = void 0;
+const namespace_1 = require("./namespace");
+const redis_1 = require("./redis");
+const logger_1 = require("./logger");
+const messages_1 = require("./messages/messages");
+function getConfiguration(config = {}) {
+    return {
+        namespace: (0, namespace_1.default)(config),
+        redis: (0, redis_1.default)(config),
+        logger: (0, logger_1.default)(config),
+        messages: (0, messages_1.default)(config),
+    };
+}
+exports.getConfiguration = getConfiguration;
+//# sourceMappingURL=configuration.js.map

package/dist/src/{system/common/configuration → config}/logger.d.ts

@@ -1,2 +1,2 @@
-import { IConfig, IRequiredConfig } from '../../../../types';
+import { IConfig, IRequiredConfig } from '../../types';
 export default function Logger(userConfig: IConfig): IRequiredConfig['logger'];