Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dollarsignteam/nestjs-amqp
NestJS AMQP 1.0
https://github.com/dollarsignteam/nestjs-amqp
amqp amqp1-0 amqp10 nestjs typescript
Last synced: about 2 months ago
JSON representation
NestJS AMQP 1.0
- Host: GitHub
- URL: https://github.com/dollarsignteam/nestjs-amqp
- Owner: dollarsignteam
- License: mit
- Created: 2021-03-24T09:16:18.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-05T09:41:49.000Z (over 2 years ago)
- Last Synced: 2024-10-31T15:23:23.934Z (2 months ago)
- Topics: amqp, amqp1-0, amqp10, nestjs, typescript
- Language: TypeScript
- Homepage:
- Size: 974 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# NestJS AMQP 1.0
AMQP 1.0 module for [Nest][5]
[][1]
[][2]
[][3]
It is based on the [rhea-promise][6] package and inspired by [nest-amqp][7] package.
## Features
- Multiple connection
- Multiple consumer
- Concurrency
## Installation
### Yarn
```bash
yarn add @dollarsign/nestjs-amqp
```
### NPM
```bash
npm install --save @dollarsign/nestjs-amqp
```
## Usage
### Connection URI
```text
protocol://[username:password@]host:port
```
### Create connection
```typescript
import { AMQPModule } from '@dollarsign/nestjs-amqp';
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
@Module({
imports: [
AMQPModule.forRoot({
connectionUri: 'amqp://admin:admin@localhost:5671',
}),
AMQPModule.forRootAsync({
name: 'custom',
useFactory: () => {
return {
connectionOptions: {
hostname: 'localhost',
port: 5672,
username: 'admin',
password: 'admin',
reconnect: true,
},
};
},
}),
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}
```
### Lifecycle hook `enableShutdownHooks` method
```typescript
async function bootstrap(): Promise {
const app = await NestFactory.create(AppModule, { logger });
const port = process.env.APP_PORT || 3000;
app.enableShutdownHooks();
await app.listen(port);
}
```
### Send and Receive message
```typescript
import { Logger } from '@dollarsign/logger';
import { Consumer, MessageControl, ProducerService, SendOptions } from '@dollarsign/nestjs-amqp';
import { delay } from '@dollarsign/utils';
import { Injectable } from '@nestjs/common';
import { SimpleMessage } from './interfaces';
@Injectable()
export class AppService {
private readonly delayTime = 2000;
private readonly logger = new Logger({
name: AppService.name,
displayFilePath: false,
});
constructor(private readonly producer: ProducerService) {}
getHello(): string {
return 'Hello World!';
}
async sendMessage(): Promise {
const body = { timestamp: new Date().toISOString() };
const result = await this.producer.send('demo1', body);
const status = result.status ? 'success' : 'failed';
return `Send to demo1 of default connection: ${status}`;
}
getRandomGroupId(): string {
const index = Math.floor(Math.random() * 100) % 2;
const groups = ['GroupA', 'GroupB'];
return groups[index];
}
async sendMessageWithOptions(): Promise {
const messageId = new Date().getTime();
const groupId = this.getRandomGroupId();
const options: SendOptions = {
connectionName: 'custom',
group_id: groupId,
correlation_id: `GROUP:${groupId}`,
message_id: messageId,
message_annotations: {
JMSMessageID: 'A',
},
};
const body = { timestamp: new Date().toISOString() };
const result = await this.producer.send('demo2', body, options);
const status = result.status ? 'success' : 'failed';
return `Send to demo2 of custom connection: ${status}`;
}
async sendError(): Promise {
const message = { timestamp: new Date().toISOString() };
const result = await this.producer.send('demo3', message);
const status = result.status ? 'success' : 'failed';
return `Send to demo3 of default connection: ${status}`;
}
@Consumer('demo1')
async receiveMessage(body: SimpleMessage): Promise {
this.logger.info('Received from demo1', body);
await delay(this.delayTime);
}
@Consumer('demo2', { connectionName: 'custom', concurrency: 2 })
async receiveMessageWithOptions(body: SimpleMessage, control: MessageControl): Promise {
const { message_id, group_id } = control.message;
this.logger.info(`Received from demo2 id: ${message_id}, ${group_id}`, body);
await delay(this.delayTime);
control.accept();
}
@Consumer('demo3')
async receiveError(body: SimpleMessage): Promise {
this.logger.info('Received from demo3', body);
await delay(this.delayTime);
throw new Error(`Created at ${body.timestamp}`);
}
}
```
### Consumer options
```typescript
export interface ConsumerOptions {
// consumer count
concurrency?: number;
// connection name
connectionName?: string;
// number of messages to be processed at one time of each consumer
parallelMessageProcessing?: number;
}
```
### Message control
```typescript
// accept the message
control.accept();
// reject the message
control.reject('Processing failed');
// release the message
control.release();
// get context
const context = control.context;
// get message
const context = control.message;
```
## Contributing
Contributions welcome! See [Contributing][4].
## Author
Dollarsign
## License
Licensed under the MIT License - see the [LICENSE][3] file for details.
[1]: https://github.com/dollarsignteam/nestjs-amqp
[2]: https://www.npmjs.com/package/@dollarsign/nestjs-amqp
[3]: https://github.com/dollarsignteam/nestjs-amqp/blob/main/LICENSE
[4]: https://github.com/dollarsignteam/nestjs-amqp/blob/main/CONTRIBUTING.md
[5]: https://github.com/nestjs/nest
[6]: https://www.npmjs.com/package/rhea-promise
[7]: https://github.com/team-supercharge/nest-amqp