|
| 1 | +<p align="center"> |
| 2 | + <image src="nestjstools-logo.png" width="400"> |
| 3 | +</p> |
| 4 | + |
| 5 | +# @nestjstools/messaging-redis-extension |
| 6 | + |
| 7 | +A NestJS library for managing asynchronous and synchronous messages with support for buses, handlers, channels, and consumers. This library simplifies building scalable and decoupled applications by facilitating robust message handling pipelines while ensuring flexibility and reliability. |
| 8 | + |
| 9 | +## Installation |
| 10 | + |
| 11 | +```bash |
| 12 | +npm install @nestjstools/messaging @nestjstools/messaging-redis-extension |
| 13 | +``` |
| 14 | + |
| 15 | +or |
| 16 | + |
| 17 | +```bash |
| 18 | +yarn add @nestjstools/messaging @nestjstools/messaging-redis-extension |
| 19 | +``` |
| 20 | +## Redis Integration: Messaging Configuration Example |
| 21 | + |
| 22 | +--- |
| 23 | + |
| 24 | +```typescript |
| 25 | +import {MessagingModule} from '@nestjstools/messaging'; |
| 26 | +import {SendMessageHandler} from './handlers/send-message.handler'; |
| 27 | +import {MessagerRedisExtensionModule, RedisChannelConfig} from "@nestjstools/messager-redis-extension"; |
| 28 | + |
| 29 | +@Module({ |
| 30 | + imports: [ |
| 31 | + MessagerRedisExtensionModule, |
| 32 | + MessagingModule.forRoot({ |
| 33 | + buses: [ |
| 34 | + { |
| 35 | + name: 'message.bus', |
| 36 | + channels: ['my-channel'], |
| 37 | + }, |
| 38 | + { |
| 39 | + name: 'command.bus', //The naming is very flexible |
| 40 | + channels: ['redis-command'], //be sure if you defined same channels name as you defined below, you can bind multiple channels there, like send message to rabbitmq and redis at the same time |
| 41 | + }, |
| 42 | + { |
| 43 | + name: 'event.bus', |
| 44 | + channels: ['redis-event'], |
| 45 | + }, |
| 46 | + ], |
| 47 | + channels: [ |
| 48 | + new InMemoryChannelConfig({ |
| 49 | + name: 'my-channel', |
| 50 | + middlewares: [], |
| 51 | + avoidErrorsForNotExistedHandlers: true, |
| 52 | + }), |
| 53 | + new RedisChannelConfig({ |
| 54 | + name: 'redis-command', |
| 55 | + middlewares: [], |
| 56 | + avoidErrorsForNotExistedHandlers: false, |
| 57 | + queue: 'command-queue', |
| 58 | + connection: { |
| 59 | + port: 6379, |
| 60 | + host: '127.0.0.1', |
| 61 | + }, |
| 62 | + }), |
| 63 | + new RedisChannelConfig({ |
| 64 | + name: 'redis-event', |
| 65 | + middlewares: [], |
| 66 | + avoidErrorsForNotExistedHandlers: true, |
| 67 | + queue: 'event-queue', |
| 68 | + connection: { |
| 69 | + port: 6379, |
| 70 | + host: '127.0.0.1', |
| 71 | + }, |
| 72 | + }), |
| 73 | + ], |
| 74 | + debug: true, |
| 75 | + }), |
| 76 | + ], |
| 77 | +}) |
| 78 | +export class AppModule { |
| 79 | +} |
| 80 | +``` |
| 81 | + |
| 82 | +--- |
| 83 | + |
| 84 | +### Key Features: |
| 85 | + |
| 86 | +1. **Multiple Message Buses**: |
| 87 | + - Configure distinct buses for **commands**, and **events**: |
| 88 | + - `command.bus` (command processing). |
| 89 | + - `event.bus` (event processing). |
| 90 | + |
| 91 | +2. **In-Memory Channel**: |
| 92 | + - Simple and lightweight channel suitable for non-persistent messaging or testing purposes. |
| 93 | + |
| 94 | +3. **Redis Channels**: |
| 95 | + - Fully integrated Redis configuration using `RedisChannelConfig`. |
| 96 | + |
| 97 | +4. **Channel Details**: |
| 98 | + - `connection`: Specifies the Redis server connection. |
| 99 | + - `queue`: Specify a Redis queue name to consume messages from. |
| 100 | + |
| 101 | +5. **Error Handling**: |
| 102 | + - Use `avoidErrorsForNotExistedHandlers` in `redis-event` to gracefully handle missing handlers for event messages. |
| 103 | + |
| 104 | +6. **Debug Mode**: |
| 105 | + - Enable `debug: true` to assist in monitoring and troubleshooting messages. |
| 106 | + |
| 107 | +This configuration provides a solid foundation for integrating redis as part of your messaging system. It facilitates the decoupling of commands, events, and in-memory operations, ensuring reliable and scalable communication across distributed systems. |
| 108 | + |
| 109 | +--- |
| 110 | + |
| 111 | +## Configuration options |
| 112 | + |
| 113 | +### RedisChannel |
| 114 | + |
| 115 | +#### **RedisChannelConfig** |
| 116 | + |
| 117 | +| **Property** | **Description** | **Default Value** | |
| 118 | +|----------------------------------------|----------------------------------------------------------------------|-------------------| |
| 119 | +| **`name`** | Name of the Redis channel (e.g., `'redis-command'`). | | |
| 120 | +| **`connection`** | URI for the Redis connection`. | | |
| 121 | +| **`queue`** | The Redis queue to consume messages from (e.g., `'my_app.command'`). | | |
| 122 | +| **`enableConsumer`** | Enables or disables the consumer for this channel. | `true` | |
| 123 | +| **`avoidErrorsForNotExistedHandlers`** | Avoid errors if no handler is available for the message. | `false` | |
| 124 | + |
| 125 | +--- |
| 126 | + |
| 127 | +## Real world working example with RabbitMQ & Redis |
| 128 | +https://github.com/nestjstools/messaging-rabbitmq-example |
0 commit comments