Queue producers in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a queue producer in NestJS?

A queue producer in NestJS is a part of the application that sends messages or jobs to a queue for processing later by consumers. It helps to decouple tasks and improve scalability.

beginner

Which NestJS package is commonly used to implement queue producers?

The @nestjs/bull package is commonly used to implement queue producers in NestJS. It integrates Bull, a popular Redis-based queue system.

intermediate

How do you inject a queue into a NestJS service to act as a producer?

You inject a queue by using the @InjectQueue() decorator from @nestjs/bull in the service constructor. This gives access to the queue's methods like add() to send jobs.

beginner

What method does a NestJS queue producer use to add a job to the queue?

The producer uses the add() method on the injected queue instance to add a job. For example, queue.add('jobName', jobData) sends a job with data to the queue.

beginner

Why is using queue producers beneficial in a NestJS application?

Queue producers help by offloading heavy or slow tasks to be processed asynchronously. This keeps the app responsive and allows scaling workers independently.

Which decorator is used to inject a queue in a NestJS service?

A @Queue()

B @Inject()

C @InjectQueue()

D @UseQueue()

The @InjectQueue() decorator from @nestjs/bull is used to inject a queue instance into a service.

What does the add() method do in a NestJS queue producer?

A Processes a job immediately

B Removes a job from the queue

C Creates a new queue

D Adds a job to the queue

The add() method adds a new job with data to the queue for later processing.

Which package integrates Bull queues with NestJS?

A @nestjs/queue

B @nestjs/bull

C bullmq

D @nestjs/bullmq

@nestjs/bull is the official NestJS package to integrate Bull queues.

Why use queue producers in NestJS applications?

A To handle tasks asynchronously and improve scalability

B To block the main thread

C To store data permanently

D To create UI components

Queue producers send tasks to be processed later, keeping the app responsive and scalable.

What type of system does Bull use for queues?

A Redis

B MongoDB

C MySQL

D File system

Bull uses Redis as its backend to manage queues efficiently.

Explain how to create a queue producer in NestJS using @nestjs/bull.

Think about module setup, injection, and sending jobs.

Describe the benefits of using queue producers in a NestJS app.

Consider how queues help with workload and app performance.

Practice

1. What is the main role of a queue producer in a NestJS application?

easy

A. To monitor the queue status and logs

B. To process tasks received from the queue

C. To delete completed tasks from the queue

D. To send tasks or messages to a queue for later processing

Solution

1. Step 1: Understand the role of queue producer

   A queue producer is responsible for sending tasks or messages to a queue, not processing them.

2. Step 2: Differentiate producer from consumer

   Consumers process tasks, while producers only add tasks to the queue.

3. Final Answer:

   To send tasks or messages to a queue for later processing -> Option D

4. Quick Check:

   Queue producer = sends tasks [OK]

Hint: Producers add tasks; consumers process them [OK]

Common Mistakes:

• Confusing producer with consumer
• Thinking producer processes tasks
• Assuming producer deletes tasks

2. Which of the following is the correct way to inject a queue named 'email' in a NestJS producer service?

easy

A. @InjectQueue('email') emailQueue: Queue = new Queue();

B. @InjectQueue private emailQueue: Queue('email');

C. @InjectQueue('email') private readonly emailQueue: Queue;

D. @InjectQueue('email') private emailQueue = Queue;

Solution

1. Step 1: Recall correct syntax for @InjectQueue

   The decorator requires the queue name as a string and the property must be typed as Queue.

2. Step 2: Check property declaration

   It should be private readonly with type Queue, no manual instantiation needed.

3. Final Answer:

   @InjectQueue('email') private readonly emailQueue: Queue; -> Option C

4. Quick Check:

   @InjectQueue('name') private readonly queue: Queue [OK]

Hint: Use @InjectQueue('name') private readonly queue: Queue [OK]

Common Mistakes:

• Missing private or readonly keywords
• Trying to instantiate Queue manually
• Incorrect decorator usage without queue name

3. Given the following code snippet in a NestJS producer service, what will be the output when sendEmail() is called?

async sendEmail() {
  await this.emailQueue.add('send_email', { to: '[e-mail]' });
  return 'Email task added';
}

medium

A. An error because 'send_email' is not a valid job name

B. 'Email task added'

C. The email is sent immediately

D. Nothing happens because add() is asynchronous

Solution

1. Step 1: Understand queue.add() behavior

   The add() method adds a job to the queue asynchronously but does not send the email immediately.

2. Step 2: Check return value of sendEmail()

   After adding the job, the function returns the string 'Email task added'.

3. Final Answer:

   'Email task added' -> Option B

4. Quick Check:

   queue.add() adds job, function returns confirmation [OK]

Hint: queue.add() adds job; function returns confirmation string [OK]

Common Mistakes:

• Assuming add() sends email immediately
• Thinking add() returns error for job name
• Ignoring async nature of add()

4. Identify the error in this NestJS queue producer code:

@Injectable()
export class NotificationProducer {
  constructor(@InjectQueue('notifications') private notificationsQueue: Queue) {}

  async sendNotification(data: any) {
    this.notificationsQueue.add('notify', data);
  }
}

medium

A. Missing await before this.notificationsQueue.add()

B. Incorrect queue name in @InjectQueue decorator

C. sendNotification should not be async

D. notificationsQueue should be public, not private

Solution

1. Step 1: Check async method usage

   The add() method returns a promise, so it should be awaited inside an async function to handle completion properly.

2. Step 2: Verify other parts

   The queue name and access modifiers are correct; async keyword is appropriate.

3. Final Answer:

   Missing await before this.notificationsQueue.add() -> Option A

4. Quick Check:

   Async add() needs await to handle promise [OK]

Hint: Always await queue.add() inside async methods [OK]

Common Mistakes:

• Forgetting await on async queue.add()
• Changing queue name incorrectly
• Removing async keyword unnecessarily

5. You want to create a NestJS queue producer that sends different types of jobs to the same queue with different priorities. Which approach correctly implements this?

hard

A. Use queue.add(jobName, data, { priority: number }) to set priority per job

B. Create multiple queues with different names for each priority level

C. Set priority globally on the queue during injection with @InjectQueue

D. Use queue.add(jobName, data) and sort jobs manually later

Solution

1. Step 1: Understand job priority in queues

   Queue jobs can have individual priorities set when added, using options like { priority: number }.

2. Step 2: Evaluate options

   Creating multiple queues or setting priority globally is not the recommended way; manual sorting is inefficient.

3. Final Answer:

   Use queue.add(jobName, data, { priority: number }) to set priority per job -> Option A

4. Quick Check:

   Set priority per job with add() options [OK]

Hint: Set priority in add() options per job [OK]

Common Mistakes:

• Trying to set priority globally on queue
• Creating many queues instead of one
• Ignoring built-in priority support