adonis-bullmq

adonis-bullmq is a queue system based on BullMQ for AdonisJS.

Note

You must have a Redis server running on your machine.

---

Getting Started

This package is available in the npm registry.

npm install adonis-bullmq bullmq

Next, configure the package by running the following command.

node ace configure adonis-bullmq

and... Voilà!

Dashboard

To use the dashboard, you need to execute the following command to install the required dependencies first.

npm install @bull-board/api @bull-board/express

Execute the queue:dashboard command to start the dashboard.

Usage

The Queue provider gives you access to the dispatch method. It will dispatch the linked job to the queue with the given payload.

import { Queue } from '@ioc:Adonis/Addons/Queue';

Queue.dispatch('App/Jobs/RegisterStripeCustomer', {...});

Queue.dispatch('App/Jobs/RegisterStripeCustomer', {...}, {
  queueName: 'stripe',
});

You can create a job by running node ace make:job {job}. This will create the job within your app/Jobs directory.

The handle method is what gets called when the jobs is processed while the failed method is called when the max attempts of the job has been reached.

You can remove the failed method if you choose as the processor checks if the method exists. Since the job instance is passed to the constructor, you can easily send notifications with the failed method. See this page for full documentation on the job instance.

Example job file:

// app/Jobs/RegisterStripeCustomer.ts
import { JobContract, JobsList } from '@ioc:Adonis/Addons/Queue';

export type RegisterStripeCustomerPayload = {
	userId: string;
};

export default class implements JobContract {
	public async handle(payload: JobsList['App/Jobs/TestJob']) {
		// ...
	}

	/**
	 * This is an optional method that gets called if it exists when the retries has exceeded and is marked failed.
	 */
	public async failed() {}
}

Job Attempts

By default, all jobs have a retry of 3 and this is set within your config/queue.ts under the jobs object.

You can also set the attempts on a call basis by passing the overide as shown below:

Queue.dispatch('App/Jobs/Somejob', {...}, { attempts: 3 })

Delayed retries

If you need to add delays inbetween retries, you can either set it globally via by adding this to your config/queue.ts:

// config/queue.ts
  ...
  jobs: {
    attempts: 3,
    backoff: {
      type: 'exponential',
      delay: 5000,
    },
  }

Or... you can also do it per job:

Queue.dispatch('App/Jobs/Somejob', {...}, {
  attempts: 3,
  backoff: { type: 'exponential', delay: 5000 }
})

With that configuration above, BullMQ will first add a 5s delay before the first retry, 20s before the 2nd, and 40s for the 3rd.

You can visit this page on further explanation / other retry options.

Running the queue

Run the queue worker with the following ace command:

node ace queue:listen

# or

node ace queue:listen --queue=stripe

# or

node ace queue:listen --queue=stripe,cloudflare

Once done, you will see the message Queue processing started.

Typings

You can define the payload's type for a given job inside the contracts/queue.ts file.

import type { RegisterStripeCustomerPayload } from 'App/Jobs/RegisterStripeCustomer';

declare module '@ioc:Adonis/Addons/Queue' {
	interface JobsList {
		'App/Jobs/RegisterStripeCustomer': RegisterStripeCustomerPayload;
	}
}