redis-smq 8.0.0-rc.16 → 8.0.0-rc.17

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 
 
+## [8.0.0-rc.17](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.16...v8.0.0-rc.17) (2024-01-30)
+
+
+### Documentation
+
+* add missing error classes ([753331e](https://github.com/weyoss/redis-smq/commit/753331e5ce4fb239cb29b3ae4c3246ba185b4d94))
+* simplify and unify class/method naming and referencing ([0299b31](https://github.com/weyoss/redis-smq/commit/0299b314e843c28d52e2f767ace150e39652287c))
+
+
+### Codebase Refactoring
+
+* improve MessageHandler error handling ([957d257](https://github.com/weyoss/redis-smq/commit/957d257e66cce6faaf9dad5bf949cdd1198cfae8))
+
 ## [8.0.0-rc.16](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.15...v8.0.0-rc.16) (2024-01-28)
 
 

package/dist/index.cjs

@@ -70,6 +70,8 @@ __export(redis_smq_exports, {
   ConsumerInvalidGroupIdError: () => ConsumerInvalidGroupIdError,
   ConsumerMessageHandlerAlreadyExistsError: () => ConsumerMessageHandlerAlreadyExistsError,
   ConsumerMessageHandlerError: () => ConsumerMessageHandlerError,
+  ConsumerMessageHandlerFileError: () => ConsumerMessageHandlerFileError,
+  ConsumerMessageHandlerFilenameExtensionError: () => ConsumerMessageHandlerFilenameExtensionError,
   ConsumerMessageHandlerWorkerError: () => ConsumerMessageHandlerWorkerError,
   EConsumeMessageDeadLetterCause: () => EConsumeMessageDeadLetterCause,
   EConsumeMessageUnacknowledgedCause: () => EConsumeMessageUnacknowledgedCause,
@@ -704,9 +706,27 @@ var ConsumerMessageHandlerError = class extends ConsumerError {
 // src/lib/consumer/message-handler/errors/consumer-message-handler-worker.error.ts
 var ConsumerMessageHandlerWorkerError = class extends ConsumerMessageHandlerError {
   constructor(msg) {
+    var _a;
     const { code, error } = msg;
+    const messageStr = `Error code: ${(_a = EWorkerThreadMessageCodeExit[code]) != null ? _a : EWorkerThreadMessageCodeConsume[code]}.${error ? ` Cause: ${error.name}(${error.message})` : ""}`;
+    super(messageStr);
+  }
+};
+
+// src/lib/consumer/message-handler/errors/consumer-message-handler-filename-extension.error.ts
+var ConsumerMessageHandlerFilenameExtensionError = class extends ConsumerMessageHandlerError {
+  constructor() {
+    super(
+      `Message handler filename must ends with a '.js' or '.cjs' extension depending on your project settings.`
+    );
+  }
+};
+
+// src/lib/consumer/message-handler/errors/consumer-message-handler-file.error.ts
+var ConsumerMessageHandlerFileError = class extends ConsumerMessageHandlerError {
+  constructor() {
     super(
-      `Error code: ${code}.${error ? `Message: ${error.name}: ${error.message}` : ""}`
+      `Make sure the message handler filename is an absolute file path pointing to an existing file in your project. `
     );
   }
 };
@@ -3092,11 +3112,11 @@ var MessageHandler = class extends import_redis_smq_common25.EventEmitter {
         (cb2) => {
           if (typeof this.handler === "string") {
             if (![".js", ".cjs"].includes(import_path3.default.extname(this.handler))) {
-              cb2(new ConsumerMessageHandlerError("Invalid file extension"));
+              cb2(new ConsumerMessageHandlerFilenameExtensionError());
             } else
               (0, import_fs.stat)(this.handler, (err) => {
                 if (err)
-                  cb2(new ConsumerMessageHandlerError(err.message));
+                  cb2(new ConsumerMessageHandlerFileError());
                 else
                   cb2();
               });
@@ -5828,6 +5848,8 @@ function disconnect(cb) {
   ConsumerInvalidGroupIdError,
   ConsumerMessageHandlerAlreadyExistsError,
   ConsumerMessageHandlerError,
+  ConsumerMessageHandlerFileError,
+  ConsumerMessageHandlerFilenameExtensionError,
   ConsumerMessageHandlerWorkerError,
   EConsumeMessageDeadLetterCause,
   EConsumeMessageUnacknowledgedCause,

package/dist/index.d.cts

@@ -549,6 +549,14 @@ declare class ConsumerMessageHandlerWorkerError extends ConsumerMessageHandlerEr
     constructor(msg: TWorkerThreadMessage);
 }
 
+declare class ConsumerMessageHandlerFilenameExtensionError extends ConsumerMessageHandlerError {
+    constructor();
+}
+
+declare class ConsumerMessageHandlerFileError extends ConsumerMessageHandlerError {
+    constructor();
+}
+
 declare class ConsumerHeartbeat extends EventEmitter<TRedisSMQEvent> {
     protected static readonly heartbeatTTL: number;
     protected redisClient: RedisClient;
@@ -1035,4 +1043,4 @@ declare class Configuration {
 
 declare function disconnect(cb: ICallback<void>): void;
 
-export { Configuration, Consumer, ConsumerError, ConsumerGroupDeleteError, ConsumerGroupIdNotFoundError, ConsumerGroupIdNotSupportedError, ConsumerGroupIdRequiredError, ConsumerGroups, ConsumerInvalidGroupIdError, ConsumerMessageHandlerAlreadyExistsError, ConsumerMessageHandlerError, ConsumerMessageHandlerWorkerError, EConsumeMessageDeadLetterCause, EConsumeMessageUnacknowledgedCause, EExchangeType, EMessagePriority, EMessageProperty, EMessagePropertyStatus, EQueueDeliveryModel, EQueueProperty, EQueueType, EWorkerThreadMessageCodeConsume, EWorkerThreadMessageCodeExit, ExchangeDirect, ExchangeError, ExchangeFanOut, ExchangeFanOutError, ExchangeInvalidDataError, ExchangeTopic, type IConsumerHeartbeat, type IConsumerHeartbeatPayload, type IConsumerMessageHandlerArgs, type IEventListener, type IExchange, type IExchangeSerialized, type IMessageParams, type IMessageStateTransferable, type IMessageTransferable, type IMessagesConfig, type IMessagesConfigStorage, type IMessagesConfigStorageOptions, type IMessagesConfigStorageOptionsRequired, type IMessagesConfigStorageRequired, type IQueueConsumerGroupParams, type IQueueGroupConsumersPendingCount, type IQueueMessages, type IQueueMessagesCount, type IQueueMessagesPage, type IQueueMessagesPageParams, type IQueueMessagesRequeuable, type IQueueParams, type IQueueParsedParams, type IQueueProperties, type IQueueRateLimit, type IRedisSMQConfig, type IRedisSMQConfigRequired, Message, MessageDeleteError, MessageDestinationQueueAlreadySetError, MessageDestinationQueueRequiredError, MessageError, MessageExchangeRequiredError, MessageNotFoundError, Namespace, Producer, ProducerError, ProducerInstanceNotRunningError, ProducerMessageExchangeRequiredError, ProducerMessageNotPublishedError, ProducerMessageNotScheduledError, ProducerQueueWithoutConsumerGroupsError, ProducibleMessage, Queue, QueueAcknowledgedMessages, QueueDeadLetteredMessages, QueueError, QueueExistsError, QueueHasRunningConsumersError, QueueMessageRequeueError, QueueMessages, QueueNamespaceNotFoundError, QueueNotEmptyError, QueueNotFoundError, QueuePendingMessages, QueueRateLimit, QueueRateLimitError, QueueScheduledMessages, type TConsumerMessageHandler, type TConsumerMessageHandlerFn, type TConsumerRedisKeys, type TEventListenersConfig, type TExchange, type TExchangeDirectBindingParams, type TExchangeFanOutBindingParams, type TExchangeSerialized, type TExchangeTopicBindingParams, type TMessageConsumeOptions, type TQueueConsumer, type TQueueExtendedParams, type TQueueMessagesPaginationParams, type TQueueMessagesParams, type TRedisSMQEvent, type TTopicParams, type TWorkerThreadError, type TWorkerThreadMessage, type TWorkerThreadMessageCode, disconnect };
+export { Configuration, Consumer, ConsumerError, ConsumerGroupDeleteError, ConsumerGroupIdNotFoundError, ConsumerGroupIdNotSupportedError, ConsumerGroupIdRequiredError, ConsumerGroups, ConsumerInvalidGroupIdError, ConsumerMessageHandlerAlreadyExistsError, ConsumerMessageHandlerError, ConsumerMessageHandlerFileError, ConsumerMessageHandlerFilenameExtensionError, ConsumerMessageHandlerWorkerError, EConsumeMessageDeadLetterCause, EConsumeMessageUnacknowledgedCause, EExchangeType, EMessagePriority, EMessageProperty, EMessagePropertyStatus, EQueueDeliveryModel, EQueueProperty, EQueueType, EWorkerThreadMessageCodeConsume, EWorkerThreadMessageCodeExit, ExchangeDirect, ExchangeError, ExchangeFanOut, ExchangeFanOutError, ExchangeInvalidDataError, ExchangeTopic, type IConsumerHeartbeat, type IConsumerHeartbeatPayload, type IConsumerMessageHandlerArgs, type IEventListener, type IExchange, type IExchangeSerialized, type IMessageParams, type IMessageStateTransferable, type IMessageTransferable, type IMessagesConfig, type IMessagesConfigStorage, type IMessagesConfigStorageOptions, type IMessagesConfigStorageOptionsRequired, type IMessagesConfigStorageRequired, type IQueueConsumerGroupParams, type IQueueGroupConsumersPendingCount, type IQueueMessages, type IQueueMessagesCount, type IQueueMessagesPage, type IQueueMessagesPageParams, type IQueueMessagesRequeuable, type IQueueParams, type IQueueParsedParams, type IQueueProperties, type IQueueRateLimit, type IRedisSMQConfig, type IRedisSMQConfigRequired, Message, MessageDeleteError, MessageDestinationQueueAlreadySetError, MessageDestinationQueueRequiredError, MessageError, MessageExchangeRequiredError, MessageNotFoundError, Namespace, Producer, ProducerError, ProducerInstanceNotRunningError, ProducerMessageExchangeRequiredError, ProducerMessageNotPublishedError, ProducerMessageNotScheduledError, ProducerQueueWithoutConsumerGroupsError, ProducibleMessage, Queue, QueueAcknowledgedMessages, QueueDeadLetteredMessages, QueueError, QueueExistsError, QueueHasRunningConsumersError, QueueMessageRequeueError, QueueMessages, QueueNamespaceNotFoundError, QueueNotEmptyError, QueueNotFoundError, QueuePendingMessages, QueueRateLimit, QueueRateLimitError, QueueScheduledMessages, type TConsumerMessageHandler, type TConsumerMessageHandlerFn, type TConsumerRedisKeys, type TEventListenersConfig, type TExchange, type TExchangeDirectBindingParams, type TExchangeFanOutBindingParams, type TExchangeSerialized, type TExchangeTopicBindingParams, type TMessageConsumeOptions, type TQueueConsumer, type TQueueExtendedParams, type TQueueMessagesPaginationParams, type TQueueMessagesParams, type TRedisSMQEvent, type TTopicParams, type TWorkerThreadError, type TWorkerThreadMessage, type TWorkerThreadMessageCode, disconnect };

package/dist/index.d.ts

@@ -549,6 +549,14 @@ declare class ConsumerMessageHandlerWorkerError extends ConsumerMessageHandlerEr
     constructor(msg: TWorkerThreadMessage);
 }
 
+declare class ConsumerMessageHandlerFilenameExtensionError extends ConsumerMessageHandlerError {
+    constructor();
+}
+
+declare class ConsumerMessageHandlerFileError extends ConsumerMessageHandlerError {
+    constructor();
+}
+
 declare class ConsumerHeartbeat extends EventEmitter<TRedisSMQEvent> {
     protected static readonly heartbeatTTL: number;
     protected redisClient: RedisClient;
@@ -1035,4 +1043,4 @@ declare class Configuration {
 
 declare function disconnect(cb: ICallback<void>): void;
 
-export { Configuration, Consumer, ConsumerError, ConsumerGroupDeleteError, ConsumerGroupIdNotFoundError, ConsumerGroupIdNotSupportedError, ConsumerGroupIdRequiredError, ConsumerGroups, ConsumerInvalidGroupIdError, ConsumerMessageHandlerAlreadyExistsError, ConsumerMessageHandlerError, ConsumerMessageHandlerWorkerError, EConsumeMessageDeadLetterCause, EConsumeMessageUnacknowledgedCause, EExchangeType, EMessagePriority, EMessageProperty, EMessagePropertyStatus, EQueueDeliveryModel, EQueueProperty, EQueueType, EWorkerThreadMessageCodeConsume, EWorkerThreadMessageCodeExit, ExchangeDirect, ExchangeError, ExchangeFanOut, ExchangeFanOutError, ExchangeInvalidDataError, ExchangeTopic, type IConsumerHeartbeat, type IConsumerHeartbeatPayload, type IConsumerMessageHandlerArgs, type IEventListener, type IExchange, type IExchangeSerialized, type IMessageParams, type IMessageStateTransferable, type IMessageTransferable, type IMessagesConfig, type IMessagesConfigStorage, type IMessagesConfigStorageOptions, type IMessagesConfigStorageOptionsRequired, type IMessagesConfigStorageRequired, type IQueueConsumerGroupParams, type IQueueGroupConsumersPendingCount, type IQueueMessages, type IQueueMessagesCount, type IQueueMessagesPage, type IQueueMessagesPageParams, type IQueueMessagesRequeuable, type IQueueParams, type IQueueParsedParams, type IQueueProperties, type IQueueRateLimit, type IRedisSMQConfig, type IRedisSMQConfigRequired, Message, MessageDeleteError, MessageDestinationQueueAlreadySetError, MessageDestinationQueueRequiredError, MessageError, MessageExchangeRequiredError, MessageNotFoundError, Namespace, Producer, ProducerError, ProducerInstanceNotRunningError, ProducerMessageExchangeRequiredError, ProducerMessageNotPublishedError, ProducerMessageNotScheduledError, ProducerQueueWithoutConsumerGroupsError, ProducibleMessage, Queue, QueueAcknowledgedMessages, QueueDeadLetteredMessages, QueueError, QueueExistsError, QueueHasRunningConsumersError, QueueMessageRequeueError, QueueMessages, QueueNamespaceNotFoundError, QueueNotEmptyError, QueueNotFoundError, QueuePendingMessages, QueueRateLimit, QueueRateLimitError, QueueScheduledMessages, type TConsumerMessageHandler, type TConsumerMessageHandlerFn, type TConsumerRedisKeys, type TEventListenersConfig, type TExchange, type TExchangeDirectBindingParams, type TExchangeFanOutBindingParams, type TExchangeSerialized, type TExchangeTopicBindingParams, type TMessageConsumeOptions, type TQueueConsumer, type TQueueExtendedParams, type TQueueMessagesPaginationParams, type TQueueMessagesParams, type TRedisSMQEvent, type TTopicParams, type TWorkerThreadError, type TWorkerThreadMessage, type TWorkerThreadMessageCode, disconnect };
+export { Configuration, Consumer, ConsumerError, ConsumerGroupDeleteError, ConsumerGroupIdNotFoundError, ConsumerGroupIdNotSupportedError, ConsumerGroupIdRequiredError, ConsumerGroups, ConsumerInvalidGroupIdError, ConsumerMessageHandlerAlreadyExistsError, ConsumerMessageHandlerError, ConsumerMessageHandlerFileError, ConsumerMessageHandlerFilenameExtensionError, ConsumerMessageHandlerWorkerError, EConsumeMessageDeadLetterCause, EConsumeMessageUnacknowledgedCause, EExchangeType, EMessagePriority, EMessageProperty, EMessagePropertyStatus, EQueueDeliveryModel, EQueueProperty, EQueueType, EWorkerThreadMessageCodeConsume, EWorkerThreadMessageCodeExit, ExchangeDirect, ExchangeError, ExchangeFanOut, ExchangeFanOutError, ExchangeInvalidDataError, ExchangeTopic, type IConsumerHeartbeat, type IConsumerHeartbeatPayload, type IConsumerMessageHandlerArgs, type IEventListener, type IExchange, type IExchangeSerialized, type IMessageParams, type IMessageStateTransferable, type IMessageTransferable, type IMessagesConfig, type IMessagesConfigStorage, type IMessagesConfigStorageOptions, type IMessagesConfigStorageOptionsRequired, type IMessagesConfigStorageRequired, type IQueueConsumerGroupParams, type IQueueGroupConsumersPendingCount, type IQueueMessages, type IQueueMessagesCount, type IQueueMessagesPage, type IQueueMessagesPageParams, type IQueueMessagesRequeuable, type IQueueParams, type IQueueParsedParams, type IQueueProperties, type IQueueRateLimit, type IRedisSMQConfig, type IRedisSMQConfigRequired, Message, MessageDeleteError, MessageDestinationQueueAlreadySetError, MessageDestinationQueueRequiredError, MessageError, MessageExchangeRequiredError, MessageNotFoundError, Namespace, Producer, ProducerError, ProducerInstanceNotRunningError, ProducerMessageExchangeRequiredError, ProducerMessageNotPublishedError, ProducerMessageNotScheduledError, ProducerQueueWithoutConsumerGroupsError, ProducibleMessage, Queue, QueueAcknowledgedMessages, QueueDeadLetteredMessages, QueueError, QueueExistsError, QueueHasRunningConsumersError, QueueMessageRequeueError, QueueMessages, QueueNamespaceNotFoundError, QueueNotEmptyError, QueueNotFoundError, QueuePendingMessages, QueueRateLimit, QueueRateLimitError, QueueScheduledMessages, type TConsumerMessageHandler, type TConsumerMessageHandlerFn, type TConsumerRedisKeys, type TEventListenersConfig, type TExchange, type TExchangeDirectBindingParams, type TExchangeFanOutBindingParams, type TExchangeSerialized, type TExchangeTopicBindingParams, type TMessageConsumeOptions, type TQueueConsumer, type TQueueExtendedParams, type TQueueMessagesPaginationParams, type TQueueMessagesParams, type TRedisSMQEvent, type TTopicParams, type TWorkerThreadError, type TWorkerThreadMessage, type TWorkerThreadMessageCode, disconnect };

package/dist/index.js

@@ -614,9 +614,27 @@ var ConsumerMessageHandlerError = class extends ConsumerError {
 // src/lib/consumer/message-handler/errors/consumer-message-handler-worker.error.ts
 var ConsumerMessageHandlerWorkerError = class extends ConsumerMessageHandlerError {
   constructor(msg) {
+    var _a;
     const { code, error } = msg;
+    const messageStr = `Error code: ${(_a = EWorkerThreadMessageCodeExit[code]) != null ? _a : EWorkerThreadMessageCodeConsume[code]}.${error ? ` Cause: ${error.name}(${error.message})` : ""}`;
+    super(messageStr);
+  }
+};
+
+// src/lib/consumer/message-handler/errors/consumer-message-handler-filename-extension.error.ts
+var ConsumerMessageHandlerFilenameExtensionError = class extends ConsumerMessageHandlerError {
+  constructor() {
+    super(
+      `Message handler filename must ends with a '.js' or '.cjs' extension depending on your project settings.`
+    );
+  }
+};
+
+// src/lib/consumer/message-handler/errors/consumer-message-handler-file.error.ts
+var ConsumerMessageHandlerFileError = class extends ConsumerMessageHandlerError {
+  constructor() {
     super(
-      `Error code: ${code}.${error ? `Message: ${error.name}: ${error.message}` : ""}`
+      `Make sure the message handler filename is an absolute file path pointing to an existing file in your project. `
     );
   }
 };
@@ -3041,11 +3059,11 @@ var MessageHandler = class extends EventEmitter4 {
         (cb2) => {
           if (typeof this.handler === "string") {
             if (![".js", ".cjs"].includes(path2.extname(this.handler))) {
-              cb2(new ConsumerMessageHandlerError("Invalid file extension"));
+              cb2(new ConsumerMessageHandlerFilenameExtensionError());
             } else
               stat(this.handler, (err) => {
                 if (err)
-                  cb2(new ConsumerMessageHandlerError(err.message));
+                  cb2(new ConsumerMessageHandlerFileError());
                 else
                   cb2();
               });
@@ -5820,6 +5838,8 @@ export {
   ConsumerInvalidGroupIdError,
   ConsumerMessageHandlerAlreadyExistsError,
   ConsumerMessageHandlerError,
+  ConsumerMessageHandlerFileError,
+  ConsumerMessageHandlerFilenameExtensionError,
   ConsumerMessageHandlerWorkerError,
   EConsumeMessageDeadLetterCause,
   EConsumeMessageUnacknowledgedCause,

package/package.json

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