Queue workers in Laravel - Mini Project: Build & Apply

Queue Workers in Laravel

📖 Scenario: You are building a Laravel application that needs to send welcome emails to new users without making them wait. To do this, you will use Laravel's queue workers to handle email sending in the background.

🎯 Goal: Build a simple Laravel queue worker setup that pushes a job to the queue and processes it to send a welcome email.

📋 What You'll Learn

Create a job class called SendWelcomeEmail with a handle method

Create a queue connection configuration variable called QUEUE_CONNECTION set to database

Dispatch the SendWelcomeEmail job to the queue with a user email

Run the queue worker command to process the queued jobs

💡 Why This Matters

🌍 Real World

Queue workers help run time-consuming tasks like sending emails or processing images in the background, improving user experience by not making them wait.

💼 Career

Understanding Laravel queue workers is essential for backend developers to build scalable and responsive web applications.

1

Create the SendWelcomeEmail job class

Create a Laravel job class called SendWelcomeEmail with a constructor that accepts a $email parameter and stores it in a public property. Add a handle method that will later send the email.

Laravel

<?php

namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;

class SendWelcomeEmail implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    public $email;

    public function __construct($email)
    {
        // Your code here
    }

    public function handle()
    {
        // Your code here
    }
}

Hint

Remember to store the $email parameter in a public property inside the constructor.

2

Set the queue connection to database

In your Laravel .env file, set the variable QUEUE_CONNECTION to database to use the database queue driver.

Laravel

QUEUE_CONNECTION=database
# Your code here

Hint

Open the .env file and add or update the line QUEUE_CONNECTION=database.

3

Dispatch the SendWelcomeEmail job

In a controller or route closure, dispatch the SendWelcomeEmail job with the email [e-mail] using SendWelcomeEmail::dispatch('[e-mail]');.

Laravel

<?php

// Dispatch the SendWelcomeEmail job with '[e-mail]'
// Your code here

Hint

Use the static dispatch method on the SendWelcomeEmail class with the exact email string.

4

Run the queue worker to process jobs

Run the Laravel queue worker command php artisan queue:work in your terminal to start processing queued jobs.

Laravel

# Run the queue worker command in terminal
# Your code here

Hint

Open your terminal and type php artisan queue:work to start the worker.

Practice

1. What is the main purpose of a queue worker in Laravel?

easy

A. To run tasks in the background without slowing down the app

B. To handle user authentication

C. To serve web pages faster

D. To manage database migrations

Solution

1. Step 1: Understand what queue workers do

   Queue workers process jobs in the background, so the app stays responsive.

2. Step 2: Identify the correct purpose

   Running slow tasks in the background matches the description of queue workers.

3. Final Answer:

   To run tasks in the background without slowing down the app -> Option A

4. Quick Check:

   Queue workers = background task runners [OK]

Hint: Queue workers handle slow tasks silently in background [OK]

Common Mistakes:

• Confusing queue workers with web servers
• Thinking queue workers handle user login
• Assuming queue workers speed up page loading directly

2. Which command correctly starts a Laravel queue worker?

easy

A. php artisan queue:listen

B. php artisan serve

C. php artisan migrate

D. php artisan queue:work

Solution

1. Step 1: Recall Laravel queue worker commands

   The command to start a queue worker is php artisan queue:work.

2. Step 2: Compare options

   Options B and C are unrelated commands; php artisan queue:listen is similar but deprecated.

3. Final Answer:

   php artisan queue:work -> Option D

4. Quick Check:

   Start worker = queue:work [OK]

Hint: Use 'queue:work' to start workers, not 'serve' or 'migrate' [OK]

Common Mistakes:

• Using 'php artisan serve' to start workers
• Confusing 'queue:listen' with 'queue:work'
• Running migrations instead of workers

3. Given this code snippet, what will happen when the job is dispatched?

dispatch(new SendEmailJob($user));

medium

A. The job is added to the queue and processed by a worker later

B. The email is sent immediately during dispatch

C. The job fails because dispatch is not a valid function

D. The job runs only if the queue worker is not running

Solution

1. Step 1: Understand dispatch behavior

   Dispatching a job adds it to the queue for later processing by a worker.

2. Step 2: Analyze options

   The email is sent immediately during dispatch is wrong because dispatch does not run the job immediately. The job fails because dispatch is not a valid function is incorrect; dispatch is valid. The job runs only if the queue worker is not running is false because jobs run only if a worker is running.

3. Final Answer:

   The job is added to the queue and processed by a worker later -> Option A

4. Quick Check:

   dispatch() = queue job for worker [OK]

Hint: Dispatch adds job to queue, worker runs it later [OK]

Common Mistakes:

• Thinking dispatch runs job immediately
• Assuming dispatch is invalid syntax
• Believing jobs run without workers

4. Identify the error in this command to start a queue worker:

php artisan queue:work --queue=emails --delay=abc

medium

A. The --queue option is invalid

B. The --delay option value must be a number, not 'abc'

C. The command is missing the --tries option

D. The command should be 'php artisan queue:start'

Solution

1. Step 1: Check the --delay option value

   The --delay option expects a number of seconds to delay retries, not a string.

2. Step 2: Validate other options

   --queue=emails is valid, --tries is optional, and 'queue:start' is not a valid command.

3. Final Answer:

   The --delay option value must be a number, not 'abc' -> Option B

4. Quick Check:

   Delay value must be numeric [OK]

Hint: Delay must be numeric seconds, not text [OK]

Common Mistakes:

• Using text instead of number for delay
• Confusing queue names with options
• Using wrong artisan command

5. You want to process two different types of jobs separately: emails and notifications. How do you start queue workers to handle each queue independently?

hard

A. Run one command: php artisan queue:work --queue=emails,notifications

B. Run one command: php artisan queue:work without options

C. Run two commands: php artisan queue:work --queue=emails and php artisan queue:work --queue=notifications

D. Run two commands: php artisan queue:listen --queue=emails and php artisan queue:listen --queue=notifications

Solution

1. Step 1: Understand queue separation

   To process different queues independently, start separate workers for each queue.

2. Step 2: Analyze commands

   Run two commands: php artisan queue:work --queue=emails and php artisan queue:work --queue=notifications runs two workers, each for one queue. Run one command: php artisan queue:work --queue=emails,notifications tries to combine queues in one worker, which processes them together, not separately. Run one command: php artisan queue:work without options processes default queue only. Run two commands: php artisan queue:listen --queue=emails and php artisan queue:listen --queue=notifications uses deprecated 'queue:listen'.

3. Final Answer:

   Run two commands: php artisan queue:work --queue=emails and php artisan queue:work --queue=notifications -> Option C

4. Quick Check:

   Separate workers = separate queues [OK]

Hint: Start one worker per queue to separate processing [OK]

Common Mistakes:

• Combining queues in one worker expecting separation
• Using deprecated queue:listen command
• Running one worker without specifying queues