Bull queue integration in NestJS - Mini Project: Build & Apply

Bull queue integration

📖 Scenario: You are building a NestJS application that needs to process tasks asynchronously using a queue system. Bull is a popular library for managing queues with Redis. You will set up a simple Bull queue to add jobs and process them.

🎯 Goal: Build a NestJS service that integrates Bull queue. You will create a queue, configure it, add jobs to the queue, and process those jobs asynchronously.

📋 What You'll Learn

Create a Bull queue named taskQueue

Configure the queue with Redis connection options

Add a job to the taskQueue with specific data

Process jobs from the taskQueue with a processor function

💡 Why This Matters

🌍 Real World

Queues help handle tasks like sending emails, processing images, or running background jobs without blocking the main app.

💼 Career

Understanding Bull queue integration is essential for backend developers working with NestJS to build scalable and efficient applications.

1

Create the Bull queue instance

Create a Bull queue instance called taskQueue using new Queue('taskQueue') from the bull package.

NestJS

// Create a Bull queue instance named taskQueue
// Your code here

Hint

Import Queue from bull and create a new instance with the name 'taskQueue'.

2

Configure Redis connection for the queue

Add Redis connection options to the taskQueue by passing an object with redis: { host: 'localhost', port: 6379 } when creating the queue.

NestJS

import { Queue } from 'bull';

// Create taskQueue with Redis connection options
// Your code here

Hint

Pass a second argument to new Queue() with the Redis connection details.

3

Add a job to the queue

Use taskQueue.add() to add a job with data { taskId: 1, description: 'Send email' } to the queue.

NestJS

import { Queue } from 'bull';

const taskQueue = new Queue('taskQueue', {
  redis: { host: 'localhost', port: 6379 }
});

// Add a job with taskId 1 and description 'Send email'
// Your code here

Hint

Call add() on taskQueue with the exact data object.

4

Process jobs from the queue

Use taskQueue.process() to define a processor function that receives a job and returns Promise.resolve() after logging the job data.

NestJS

import { Queue } from 'bull';

const taskQueue = new Queue('taskQueue', {
  redis: { host: 'localhost', port: 6379 }
});

taskQueue.add({ taskId: 1, description: 'Send email' });

// Add a processor function to handle jobs
// Your code here

Hint

Use taskQueue.process() with an async function that logs job.data and returns a resolved promise.

Practice

1. What is the main purpose of integrating Bull queues in a NestJS application?

easy

A. To manage database migrations

B. To create REST API endpoints

C. To handle tasks asynchronously in the background

D. To style the frontend components

Solution

1. Step 1: Understand Bull queue role

   Bull queues are used to process jobs asynchronously, meaning tasks run in the background without blocking the main app.

2. Step 2: Compare options with Bull's purpose

   Database migrations, creating REST API endpoints, and styling frontend components relate to other app parts, not background task handling.

3. Final Answer:

   To handle tasks asynchronously in the background -> Option C

4. Quick Check:

   Bull queues = background task handling [OK]

Hint: Bull queues = background jobs, not API or styling [OK]

Common Mistakes:

• Confusing Bull queues with API routing
• Thinking Bull manages database schema
• Assuming Bull is for frontend styling

2. Which decorator is used in NestJS to define a job handler method for a Bull queue?

easy

A. @QueueJob

B. @QueueHandler

C. @JobListener

D. @Process

Solution

1. Step 1: Recall Bull job handler decorators

   In NestJS Bull integration, @Process decorates methods that handle jobs from a queue.

2. Step 2: Verify other options

   @QueueHandler, @JobListener, and @QueueJob are not valid NestJS Bull decorators.

3. Final Answer:

   @Process -> Option D

4. Quick Check:

   Job handler method uses @Process [OK]

Hint: Job handler methods use @Process decorator [OK]

Common Mistakes:

• Using non-existent decorators like @QueueHandler
• Confusing @Processor with @Process (class vs method)
• Missing the @Process decorator on job methods

3. Given this NestJS Bull processor code snippet, what will be logged when a job with data { name: 'task1' } is processed?

@Processor('email')
export class EmailProcessor {
  @Process('send')
  async handleSend(job: Job) {
    console.log(`Processing job: ${job.data.name}`);
    return 'done';
  }
}

medium

A. Processing job: task1

B. Processing job: undefined

C. Error: job.data is undefined

D. No output because method is not called

Solution

1. Step 1: Understand job data access

   The job object passed to handleSend contains a data property with { name: 'task1' }.

2. Step 2: Analyze console.log output

   The template string uses job.data.name, which is 'task1', so it logs "Processing job: task1".

3. Final Answer:

   Processing job: task1 -> Option A

4. Quick Check:

   job.data.name = 'task1' logs correctly [OK]

Hint: job.data contains the job payload object [OK]

Common Mistakes:

• Assuming job.data is undefined
• Forgetting to await async method
• Thinking method won't be called without explicit call

4. Identify the error in this NestJS Bull queue registration code:

@Module({
  imports: [
    BullModule.registerQueue({
      name: 'notifications',
      redis: {
        host: 'localhost',
        port: '6379'
      }
    })
  ]
})
export class NotificationModule {}

medium

A. The port value should be a number, not a string

B. The queue name must be an array, not a string

C. Redis host cannot be 'localhost', must be IP address

D. BullModule.registerQueue is not a valid method

Solution

1. Step 1: Check Redis config types

   Redis port must be a number, but here it is given as string '6379'.

2. Step 2: Validate other parts

   Queue name as string is valid; 'localhost' is acceptable; BullModule.registerQueue is correct method.

3. Final Answer:

   The port value should be a number, not a string -> Option A

4. Quick Check:

   Redis port must be number [OK]

Hint: Redis port must be numeric, not quoted string [OK]

Common Mistakes:

• Passing port as string instead of number
• Thinking queue name must be array
• Assuming 'localhost' is invalid host
• Confusing BullModule.registerQueue with other methods

5. You want to process two different job types, 'email' and 'sms', in the same NestJS Bull processor class. Which approach correctly handles both jobs?

hard

A. Create two separate @Processor classes, one for 'email' and one for 'sms', each with a single @Process method

B. Use one @Processor('messages') class with two methods decorated by @Process('email') and @Process('sms')

C. Use one @Processor class with a single @Process('email') method handling both job types by checking job.name

D. Register two queues with the same name and use one @Process method

Solution

1. Step 1: Understand @Processor and @Process usage

   A single @Processor class can handle multiple job types from the same queue by defining multiple @Process methods with different job names.

2. Step 2: Evaluate options

   Use one @Processor('messages') class with two methods decorated by @Process('email') and @Process('sms') correctly uses one processor class with two @Process methods for 'email' and 'sms'. Create two separate @Processor classes, one for 'email' and one for 'sms', each with a single @Process method splits into classes unnecessarily. Use one @Processor class with a single @Process('email') method handling both job types by checking job.name cannot handle 'sms' jobs since only 'email' jobs trigger the method. Register two queues with the same name and use one @Process method registers duplicate queues which is invalid.

3. Final Answer:

   Use one @Processor('messages') class with two methods decorated by @Process('email') and @Process('sms') -> Option B

4. Quick Check:

   Multiple @Process methods in one @Processor class [OK]

Hint: One @Processor class can have many @Process methods [OK]

Common Mistakes:

• Creating multiple processor classes unnecessarily
• Using a single named @Process method for multiple job types
• Registering duplicate queues with same name