Named jobs in NestJS

Introduction

Named jobs let you give a clear label to background tasks. This helps you find, manage, or cancel specific jobs easily.

You want to run a background task like sending emails and track it by name.

You need to update or remove a specific job later by referring to its name.

You want to organize multiple jobs and avoid confusion by naming each one.

You want to check the status of a particular job in your queue.

You want to prevent duplicate jobs by checking if a named job already exists.

Syntax

NestJS

queue.add('jobName', data, options);

The first argument is the job's name as a string.

The second argument is the data the job needs.

Examples

Adds a job named 'sendWelcomeEmail' with user data to the email queue.

NestJS

await emailQueue.add('sendWelcomeEmail', { userId: 123 });

Adds a delayed job named 'generateReport' that starts after 60 seconds.

NestJS

await reportQueue.add('generateReport', { reportId: 456 }, { delay: 60000 });

Adds a job named 'sendPush' with retry attempts set to 3.

NestJS

await notificationQueue.add('sendPush', { deviceId: 'abc' }, { attempts: 3 });

Sample Program

This example shows how to add a named job 'sendWelcomeEmail' to an email queue in NestJS. The processor listens for jobs with that name and runs the handler. The service adds the job with user data.

NestJS

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

@Processor('email')
export class EmailProcessor {
  @Process('sendWelcomeEmail')
  async handleSendWelcomeEmail(job: Job) {
    console.log(`Sending welcome email to user ${job.data.userId}`);
    // Simulate email sending logic here
  }
}

// Somewhere in your service or controller
import { InjectQueue } from '@nestjs/bull';
import { Queue } from 'bull';

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

  async sendWelcome(userId: number) {
    await this.emailQueue.add('sendWelcomeEmail', { userId });
  }
}

// Usage example
// Assume emailQueueInstance is an instance of Queue injected properly
const emailService = new EmailService(emailQueueInstance);
emailService.sendWelcome(42);

Important Notes

Named jobs help you organize and control your background tasks better.

You can have multiple processors for different named jobs in the same queue.

Always use meaningful names to make your code easier to understand.

Summary

Named jobs let you label background tasks clearly.

This makes managing, tracking, and canceling jobs easier.

Use descriptive names to keep your queues organized.

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