Named jobs in NestJS - Mini Project: Build & Apply

Named Jobs with NestJS Bull Queue

📖 Scenario: You are building a NestJS application that processes background tasks using Bull queues. You want to organize your jobs by giving each job a specific name. This helps you identify and manage different types of jobs easily.

🎯 Goal: Create a Bull queue in NestJS and add named jobs to it. Then, set up a processor that listens for jobs by their names and handles them accordingly.

📋 What You'll Learn

Create a Bull queue named emailQueue

Add a named job sendWelcomeEmail with data containing userId: 123

Add a named job sendPasswordReset with data containing userId: 456

Create a processor that listens for sendWelcomeEmail jobs and logs the userId

Create a processor that listens for sendPasswordReset jobs and logs the userId

💡 Why This Matters

🌍 Real World

Named jobs help organize background tasks like sending different types of emails or processing different workflows in a clear way.

💼 Career

Understanding named jobs in queues is important for backend developers working with task queues, microservices, and scalable applications.

1

Setup Bull queue in NestJS

Import BullModule in your module and register a queue named emailQueue using BullModule.registerQueue.

NestJS

import { Module } from '@nestjs/common';
import { BullModule } from '@nestjs/bull';

@Module({
  imports: [
    // Register the queue here
  ],
})
export class AppModule {}

Hint

Use BullModule.registerQueue({ name: 'emailQueue' }) inside the imports array.

2

Add named jobs to the queue

Inject the emailQueue using @InjectQueue('emailQueue') in a service. Add two named jobs: sendWelcomeEmail with data { userId: 123 } and sendPasswordReset with data { userId: 456 } using emailQueue.add.

NestJS

import { Injectable } from '@nestjs/common';
import { InjectQueue } from '@nestjs/bull';
import { Queue } from 'bull';

@Injectable()
export class EmailService {
  constructor(@InjectQueue('emailQueue') private emailQueue: Queue) {}

  async addJobs() {
    // Add sendWelcomeEmail job
    // Add sendPasswordReset job
  }
}

Hint

Use this.emailQueue.add('sendWelcomeEmail', { userId: 123 }) and similarly for sendPasswordReset.

3

Create processors for named jobs

Create a processor class decorated with @Processor('emailQueue'). Add two methods decorated with @Process('sendWelcomeEmail') and @Process('sendPasswordReset'). Each method receives a job and logs job.data.userId.

NestJS

import { Processor, Process } from '@nestjs/bull';
import { Job } from 'bull';

@Processor('emailQueue')
export class EmailProcessor {
  @Process('sendWelcomeEmail')
  async handleWelcomeEmail(job: Job) {
    // Log userId from job.data
  }

  @Process('sendPasswordReset')
  async handlePasswordReset(job: Job) {
    // Log userId from job.data
  }
}

Hint

Use @Processor('emailQueue') on the class and @Process('sendWelcomeEmail') and @Process('sendPasswordReset') on methods.

4

Trigger job addition in application

In the EmailService, add a method called start that calls addJobs(). Then, in the AppModule, inject EmailService and call start() in the constructor to trigger job addition when the app starts.

NestJS

import { Module } from '@nestjs/common';
import { BullModule, Processor, Process } from '@nestjs/bull';
import { Injectable } from '@nestjs/common';
import { InjectQueue } from '@nestjs/bull';
import { Queue, Job } from 'bull';

@Injectable()
export class EmailService {
  constructor(@InjectQueue('emailQueue') private emailQueue: Queue) {}

  async addJobs() {
    await this.emailQueue.add('sendWelcomeEmail', { userId: 123 });
    await this.emailQueue.add('sendPasswordReset', { userId: 456 });
  }

  // Add start method here
}

@Processor('emailQueue')
export class EmailProcessor {
  @Process('sendWelcomeEmail')
  async handleWelcomeEmail(job: Job) {
    console.log(`Welcome email userId: ${job.data.userId}`);
  }

  @Process('sendPasswordReset')
  async handlePasswordReset(job: Job) {
    console.log(`Password reset userId: ${job.data.userId}`);
  }
}

@Module({
  imports: [
    BullModule.registerQueue({
      name: 'emailQueue',
    }),
  ],
  providers: [EmailService, EmailProcessor],
})
export class AppModule {
  constructor(private emailService: EmailService) {
    // Call start method here
  }
}

Hint

Create a start method in EmailService that calls addJobs(). Then call this.emailService.start() in AppModule constructor.

Practice

1. What is the main benefit of using named jobs in NestJS queues?

easy

A. They automatically speed up job processing.

B. They help identify and manage specific background tasks easily.

C. They encrypt job data for security.

D. They allow jobs to run without a queue.

Solution

1. Step 1: Understand the purpose of named jobs

   Named jobs provide a clear label to background tasks, making them easier to find and manage.

2. Step 2: Compare options with the purpose

   Only They help identify and manage specific background tasks easily. matches this purpose. Options B, C, and D describe unrelated features.

3. Final Answer:

   They help identify and manage specific background tasks easily. -> Option B

4. Quick Check:

   Named jobs = easier management [OK]

Hint: Named jobs label tasks for easy tracking [OK]

Common Mistakes:

• Thinking named jobs improve speed
• Confusing named jobs with security features
• Assuming named jobs remove the need for queues

2. Which of the following is the correct way to add a named job to a queue in NestJS?

easy

A. queue.pushJob('emailJob', { to: '[e-mail]' });

B. queue.createJob('emailJob', { to: '[e-mail]' });

C. queue.runJob('emailJob', { to: '[e-mail]' });

D. queue.add('emailJob', { to: '[e-mail]' });

Solution

1. Step 1: Recall the NestJS queue method for adding jobs

   The correct method to add a job with a name is queue.add(name, data).

2. Step 2: Match the method with options

   Only queue.add('emailJob', { to: '[e-mail]' }); uses queue.add with a job name and data correctly.

3. Final Answer:

   queue.add('emailJob', { to: '[e-mail]' }); -> Option D

4. Quick Check:

   Use queue.add(name, data) [OK]

Hint: Use queue.add('jobName', data) to name jobs [OK]

Common Mistakes:

• Using non-existent methods like createJob or pushJob
• Forgetting to pass the job name as first argument
• Confusing job execution with job creation

3. Given this code snippet, what will be the output when checking the job name?

const job = await queue.add('reportGeneration', { userId: 42 });
console.log(job.name);

medium

A. 'reportGeneration'

B. 'default'

C. undefined

D. Throws an error

Solution

1. Step 1: Understand job creation with a name

   When adding a job with queue.add('reportGeneration', data), the job's name property is set to 'reportGeneration'.

2. Step 2: Check the console.log output

   Logging job.name will print 'reportGeneration'.

3. Final Answer:

   'reportGeneration' -> Option A

4. Quick Check:

   Job name property = 'reportGeneration' [OK]

Hint: Job.name matches the string passed to queue.add [OK]

Common Mistakes:

• Assuming default name is used if a name is given
• Expecting undefined if name is not accessed properly
• Thinking job creation throws error without processor

4. Identify the error in this NestJS queue job addition:

queue.add({ name: 'cleanupJob' }, { force: true });

medium

A. Job name should be a string, not inside an object.

B. The second argument must be a string, not an object.

C. The method add() does not exist on queue.

D. The job data cannot contain boolean values.

Solution

1. Step 1: Review the correct syntax for named jobs

   The queue.add method expects the first argument as a string name, not an object.

2. Step 2: Analyze the given code

   The code passes an object { name: 'cleanupJob' } instead of a string, causing a syntax error.

3. Final Answer:

   Job name should be a string, not inside an object. -> Option A

4. Quick Check:

   First argument to add() = string name [OK]

Hint: Pass job name as string, not object, to queue.add [OK]

Common Mistakes:

• Passing job name inside an object instead of string
• Confusing job data with job name argument
• Assuming add() method is missing or invalid

5. You want to cancel all jobs named 'emailNotification' in a queue. Which approach correctly uses named jobs to achieve this?

hard

A. Restart the queue to clear all jobs named 'emailNotification'.

B. Call queue.removeJobs('emailNotification') directly without fetching jobs.

C. Use queue.getJobs(['emailNotification']) and then call remove() on each job.

D. Filter jobs by data property { type: 'emailNotification' } and delete them.

Solution

1. Step 1: Understand how to retrieve named jobs

   Named jobs can be fetched using queue.getJobs(['jobName']) which returns jobs with that name.

2. Step 2: Remove each fetched job

   After fetching, calling remove() on each job deletes them from the queue.

3. Final Answer:

   Use queue.getJobs(['emailNotification']) and then call remove() on each job. -> Option C

4. Quick Check:

   Fetch named jobs then remove [OK]

Hint: Fetch named jobs first, then remove them one by one [OK]

Common Mistakes:

• Trying to remove jobs by name without fetching them
• Filtering jobs by data instead of name
• Restarting queue does not selectively remove jobs