fix: Code config improvement + readme

Author: Sebastian-Iwanczyszyn

README.md

@@ -124,10 +124,11 @@ This configuration provides a solid foundation for integrating redis as part of
 | **Property**                           | **Description**                                                      | **Default Value** |
 |----------------------------------------|----------------------------------------------------------------------|-------------------|
 | **`name`**                             | Name of the Redis channel (e.g., `'redis-command'`).                 |                   |
-| **`connection`**                       | URI for the Redis connection`.                                       |                   |
+| **`connection`**                       | Redis connection configuration (host, port, password, db).           |                   |
 | **`queue`**                            | The Redis queue to consume messages from (e.g., `'my_app.command'`). |                   |
 | **`enableConsumer`**                   | Enables or disables the consumer for this channel.                   | `true`            |
 | **`avoidErrorsForNotExistedHandlers`** | Avoid errors if no handler is available for the message.             | `false`           |
+| **`keyPrefix`**                        | Optional prefix for keys stored in Redis.                            |                   |
 
 ---
 

src/channel/redis.channel-config.ts

@@ -1,7 +1,9 @@
 import { ChannelConfig } from '@nestjstools/messaging';
+
 export class RedisChannelConfig extends ChannelConfig {
   public readonly connection: Connection;
   public readonly queue: string;
+  public readonly keyPrefix?: string;
 
   constructor({
     name,
@@ -11,6 +13,7 @@ export class RedisChannelConfig extends ChannelConfig {
     avoidErrorsForNotExistedHandlers,
     middlewares,
     normalizer,
+    keyPrefix,
   }: RedisChannelConfig) {
     super(
       name,
@@ -21,6 +24,7 @@ export class RedisChannelConfig extends ChannelConfig {
     );
     this.connection = connection;
     this.queue = queue;
+    this.keyPrefix = keyPrefix;
   }
 }
 
@@ -29,9 +33,4 @@ interface Connection {
   port: number;
   password?: string;
   db?: number;
-  /**
-   * This prefix is not used as RedisOptions keyPrefix, it is used as prefix for BullMQ
-   * Read more: https://github.com/taskforcesh/bullmq/issues/1219#issuecomment-1113903785
-   */
-  keyPrefix?: string;
 }

src/channel/redis.channel.ts

@@ -9,13 +9,8 @@ export class RedisChannel extends Channel<RedisChannelConfig> {
   constructor(config: RedisChannelConfig) {
     super(config);
     this.queue = new Queue(config.queue, {
-      connection: {
-        host: config.connection.host,
-        port: config.connection.port,
-        password: config.connection.password,
-        db: config.connection.db,
-      },
-      prefix: config.connection.keyPrefix,
+      connection: this.config.connection,
+      prefix: config.keyPrefix,
     });
   }
 }

src/consumer/redis-messaging.consumer.ts

@@ -26,13 +26,8 @@ export class RedisMessagingConsumer
         dispatcher.dispatch(new ConsumerMessage(job.data, job.name));
       },
       {
-        connection: {
-          host: channel.config.connection.host,
-          port: channel.config.connection.port,
-          password: channel.config.connection.password,
-          db: channel.config.connection.db,
-        },
-        prefix: channel.config.connection.keyPrefix,
+        connection: this.channel.config.connection,
+        prefix: channel.config.keyPrefix,
       },
     );
 
@@ -53,10 +48,3 @@ export class RedisMessagingConsumer
     }
   }
 }
-
-interface RabbitMQMessage {
-  contentType: string;
-  body: object;
-  routingKey: string;
-  headers: { [key: string]: string };
-}

src/message-bus/redis-message.bus.ts

@@ -7,7 +7,7 @@ import { RedisChannel } from '../channel/redis.channel';
 export class RedisMessageBus implements IMessageBus {
   constructor(private readonly redisChannel: RedisChannel) {}
 
-  async dispatch(message: RoutingMessage): Promise<object | void> {
-    this.redisChannel.queue.add(message.messageRoutingKey, message.message);
+  async dispatch(message: RoutingMessage): Promise<void> {
+    await this.redisChannel.queue.add(message.messageRoutingKey, message.message);
   }
 }