@pickk/nestjs-sqs

nestjs-sqs is a project to make SQS easier to use and control some required flows with NestJS. This module provides decorator-based message handling suited for simple use.

This library internally uses bbc/sqs-producer and bbc/sqs-consumer

Installation

$ npm i --save @pickk/nestjs-sqs

Quick Start

SqsModule

forRootAsync

For use SqsModule, You have to set SQS configurations. you can set SQS configurations by forRootAsync method. after forRootAsync method called, every sqs produers and consumers use SQS configurations returned by forRootAsync useFactory method

@Module({
  imports: [
    SqsModule.forRootAsync({
      imports: [ConfigModule],
      useFactory: (configService) => {
        const config = {
          region: configSerivce.region,
          endpoint: configSerivce.endpoint,
          accountNumber: configSerivce.accountNumber,
          credentials: {
            accessKeyId: configSerivce.accessKeyId,
            secretAccessKey: configService.secretAccessKey,
          },
        };
        return SqsConfig(config);
      },
      injects: [ConfigSerivce],
    }),
  ],
})
class AppModule {}

registerQueue

Second you have to register queues. register queues means create sqs-producer and sqs-consumer by queueOptions that passed into registerQueue parameter default type of queueOption is 'ALL'

SqsModule.registerQueue(
  {
    name: 'queueName',
    type?: SqsQueueType.Consumer // 'ALL'|'CONSUMER'|'PRODUCER'
    consumerOptions?: {},
    producerOptions?: {}
  },
  ...
);

consume message

You need to decorate providers and methods in your NestJS providers in order to have them be automatically attached as message(event) handlers for incoming SQS messages

@SqsProcess(/** name: */ queueName)
export class AppMessageHandler {
  @SqsMessageHandler(/** batch: */ false)
  public async handleMessage(message: AWS.SQS.Message) {}

  @SqsConsumerEventHandler(/** eventName: */ SqsConsumerEvent.PROCESSING_ERROR)
  public onProcessingError(error: Error, message: AWS.SQS.Message) {
    // report errors here
  }
}

You need to pass queueName to SqsProcess decorator. unless SqsModule won't register Consumer. One class can only handle one queue. so if you want to enroll dead letter queue, you have to make new class that handle dead letter queue

Produce messages

SqsService needs to be injected to produce the message.

export class AppService {
  public constructor(
    private readonly sqsService: SqsService,
  ) { }

  public async dispatchSomething() {
    await this.sqsService.send<BodyType>(/** name: */ 'queueName', {
      id: 'id',
      body: { ... },
      groupId: 'groupId',
      deduplicationId: 'deduplicationId',
      messageAttributes: { ... },
      delaySeconds: 0,
    });
  }
}

Configuration

See here, and note that we have same configuration as bbc/sqs-consumer's. In most time you just need to specify both name and queueUrl at the minimum requirements.

License

This project is licensed under the terms of the MIT license.