I try to implement Bull queue in Typescript and NestJS, my code:
@Injectable()
export class MailService {
constructor(
@InjectQueue('mail')
private readonly mailQueue: Queue
) {}
async addToQueue(): Promise<void> {
this.mailQueue.add(() => {
return this.sendMail();
})
}
async sendMail(): Promise<void> {
//logic to implement
this.addToQueue();
}
}
fast question: Is this implementation sufficient for my job queuing to work?, If not: what i must to do?
I recently wrote a blog post that seems to relate to your use-case:
https://firxworx.com/blog/coding/nodejs/email-module-for-nestjs-with-bull-queue-and-the-nest-mailer/
A few tips:
BullModule
(from @nestjs/bull
). For example, you need to configure with your queue name ("mail" in your case) and setup your queue. A common setup would include configuring with the redis hostname and port.user
and token
. My example would look like this: await this.mailQueue.add('confirmationEmail', { user, token })
@Processor(QUEUE_NAME)
decorator from @nestjs/bull
(@Processor('mail')
in your case). The processor handles jobs that are added to the queue.sendConfirmationEmail()
that handles the job named "confirmationEmail". You would decorate that method with @Process(JOB_NAME)
, e.g. @Process('confirmationEmail')
. The method can receive your payload. Per my example, the following method signature would provide the user
and token
: async sendConfirmationEmail(job: Job<{ user: User, token: string }>): Promise<any>
(note Job
is from the bull
package, and that you may wish to type your return vs. using any
). Here is where you would actually send out the email.@nestjs/bull
also provides special method decorators including @OnQueueActive()
, @OnQueueCompleted()
, @OnQueueFailed()
. Refer to the docs but you may find these useful for logging or other purposes.The idea is that your processor handles jobs in the queue when the app is otherwise idle.
Your mail module would presumably have at least a mail.module.ts
with configuration, a mail.service.ts
that adds jobs to the "mail" queue, and a mail.processor.ts
that takes care of completing any jobs added to the "mail" queue.
Further documentation from NestJS is available at: