Named jobs in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a named job in NestJS when using queues?

A named job is a specific job given a unique name within a queue. It helps identify and manage jobs individually, allowing you to add, process, or remove jobs by their name.

beginner

How do you define a named job processor in NestJS with Bull?

You use the @Process('jobName') decorator on a method inside a processor class to handle jobs with that specific name.

intermediate

Why use named jobs instead of anonymous jobs in NestJS queues?

Named jobs let you target specific job types for processing, retrying, or removing. This makes your queue management clearer and more organized.

beginner

How do you add a named job to a queue in NestJS?

You call the queue's add() method with the job name as the first argument and the job data as the second, like queue.add('jobName', data).

intermediate

What happens if you add multiple jobs with the same name to a NestJS queue?

Each job is treated as a separate instance but shares the same processing logic defined for that job name. They will be processed one by one or concurrently based on your setup.

In NestJS, which decorator is used to process a named job in a Bull queue?

A @Job('jobName')

B @Process('jobName')

C @Queue('jobName')

D @Handle('jobName')

The @Process('jobName') decorator marks a method to handle jobs with the given name.

How do you add a named job called 'email' with data to a queue in NestJS?

A queue.push('email', data)

B queue.process('email', data)

C queue.create('email', data)

D queue.add('email', data)

The add() method with the job name as the first argument adds a named job to the queue.

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

A Easier to manage and process specific job types

B Jobs run faster automatically

C Jobs do not need data

D Named jobs use less memory

Named jobs help organize and target specific job types for processing.

If you have multiple jobs with the same name in a queue, how are they processed?

A Only the first job is processed

B Jobs are merged into one

C Each job is processed separately using the same handler

D Jobs are ignored

Each job instance is processed individually by the handler for that job name.

Which package is commonly used with NestJS to handle named jobs in queues?

A @nestjs/bull

B @nestjs/queue

C @nestjs/jobs

D @nestjs/tasks

The @nestjs/bull package integrates Bull queues with NestJS and supports named jobs.

Explain how to create and process a named job in a NestJS queue using Bull.

Think about how you name and handle tasks in a to-do list.

Describe the advantages of using named jobs in NestJS queue management.

Consider how naming files helps you find them quickly.

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