Failed job handling in Laravel - Mini Project: Build & Apply

Failed Job Handling in Laravel Queues

📖 Scenario: You are building a Laravel application that processes user emails in the background using queues. Sometimes, jobs may fail due to temporary issues like network errors. You want to handle these failed jobs properly to retry or log them.

🎯 Goal: Build a Laravel queue job setup that handles failed jobs by configuring the failed jobs table, setting a retry limit, and implementing a failed job handler.

📋 What You'll Learn

Create a failed jobs database table using Laravel's migration

Configure the queue connection to use the failed jobs table

Create a queue job class with a retry limit

Implement a failed() method in the job class to handle failures

💡 Why This Matters

🌍 Real World

Handling failed jobs is essential in real-world Laravel applications to ensure background tasks are reliable and failures are tracked for fixing issues.

💼 Career

Understanding failed job handling is important for Laravel developers working on scalable applications that use queues for background processing.

1

Create the failed jobs table migration

Run the artisan command to create the failed jobs table migration file by typing php artisan queue:failed-table and then create the table by running php artisan migrate.

Laravel

# Run artisan commands to create and migrate the failed jobs table
# Your code here

Hint

Use Laravel artisan commands exactly as shown to create and migrate the failed jobs table.

2

Configure queue connection to use the failed jobs table

In the config/queue.php file, set the failed array's database key to mysql and table key to failed_jobs to enable failed job logging.

Laravel

# In config/queue.php, set the failed jobs database and table
# Your code here

Hint

Open config/queue.php and find the failed section to set the database and table names.

3

Create a queue job class with retry limit

Create a job class named SendEmailJob using php artisan make:job SendEmailJob. In the job class, add a public property $tries and set it to 3 to limit retries.

Laravel

# Create SendEmailJob class and add retry limit
# Your code here

Hint

Use the artisan command to create the job class, then add the $tries property inside the class.

4

Implement the failed() method to handle failed jobs

In the SendEmailJob class, add a public method failed() that accepts an \Exception $exception parameter. Inside, add code to log the failure or notify the admin.

Laravel

# Add the failed() method to SendEmailJob class
# Your code here

Hint

Add the failed() method inside the job class to handle failure events.

Practice

1. What is the primary purpose of the failed() method in a Laravel job class?

easy

A. To list all failed jobs in the queue

B. To retry a failed job automatically

C. To define actions when a queued job fails during execution

D. To clear all failed jobs from the database

Solution

1. Step 1: Understand the role of failed() method

   The failed() method is a special method in Laravel job classes that runs when the job fails after all retry attempts.

2. Step 2: Identify what failed() does

   This method allows you to define custom logic like sending notifications or logging when a job fails.

3. Final Answer:

   To define actions when a queued job fails during execution -> Option C

4. Quick Check:

   failed() handles failure actions [OK]

Hint: Remember: failed() runs only on job failure [OK]

Common Mistakes:

• Confusing failed() with retry commands
• Thinking it lists or clears failed jobs
• Assuming it runs on successful job completion

2. Which of the following is the correct Artisan command to retry all failed jobs in Laravel?

easy

A. php artisan queue:retry all

B. php artisan queue:retry --all

C. php artisan queue:retry --failed

D. php artisan queue:retry --all-jobs

Solution

1. Step 1: Recall the syntax for retrying failed jobs

   Laravel's command to retry failed jobs is php artisan queue:retry followed by the job IDs or all to retry all.

2. Step 2: Identify the correct option

   The correct command to retry all failed jobs is php artisan queue:retry all.

3. Final Answer:

   php artisan queue:retry all -> Option A

4. Quick Check:

   Retry all failed jobs = queue:retry all [OK]

Hint: Use 'all' after retry to retry every failed job [OK]

Common Mistakes:

• Adding extra flags like --all or --failed which don't exist
• Using incorrect command syntax
• Confusing retry with clear commands

3. Given this Laravel job class snippet, what will happen when the job fails?

class SendEmailJob implements ShouldQueue {
    public function handle() {
        // code that throws an exception
    }
    public function failed(Exception $exception) {
        Log::error('Email sending failed: ' . $exception->getMessage());
    }
}

medium

A. The job will be retried indefinitely without logging

B. The job will succeed despite the exception

C. The job will be removed silently without any action

D. The job failure will be logged with the error message

Solution

1. Step 1: Analyze the failed() method implementation

   The failed() method logs an error message when the job fails due to an exception.

2. Step 2: Understand job failure behavior

   When the job throws an exception, Laravel calls failed() and logs the failure message.

3. Final Answer:

   The job failure will be logged with the error message -> Option D

4. Quick Check:

   failed() logs failure message [OK]

Hint: Check if failed() logs or retries [OK]

Common Mistakes:

• Assuming job retries indefinitely without limit
• Thinking failure is ignored without logging
• Believing job succeeds despite exception

4. Consider this command to clear failed jobs:

php artisan queue:flush

What is the issue with this command?

medium

A. It clears all failed jobs correctly

B. The command does not exist; the correct command is queue:forget

C. It retries all failed jobs instead of clearing

D. It only clears jobs from the default queue, not all queues

Solution

1. Step 1: Verify the correct command to clear failed jobs

   The php artisan queue:flush command does not exist in Laravel. The correct command to remove failed jobs is php artisan queue:forget {id} for specific jobs or manually clearing the failed_jobs table.

2. Step 2: Confirm the issue

   Since queue:flush is not a valid command, it cannot clear failed jobs.

3. Final Answer:

   The command does not exist; the correct command is queue:forget -> Option B

4. Quick Check:

   queue:flush is invalid; use queue:forget [OK]

Hint: Remember: queue:flush is not a valid Artisan command [OK]

Common Mistakes:

• Thinking queue:flush does not exist
• Confusing it with queue:forget for specific jobs
• Mistaking it for a retry command

5. You want to notify the admin by email whenever a job fails in Laravel. Which approach correctly implements this using the failed() method?

hard

A. Add a failed() method in the job class that sends an email notification to the admin

B. Use php artisan queue:notify-admin command after job failure

C. Configure the failed_jobs table to send emails automatically

D. Set notify_admin = true in the job constructor

Solution

1. Step 1: Understand how to handle job failure notifications

   Laravel allows defining a failed() method in job classes to run custom logic on failure, such as sending emails.

2. Step 2: Identify the correct implementation

   Adding a failed() method that sends an email notification to the admin is the correct way to notify on failure.

3. Final Answer:

   Add a failed() method in the job class that sends an email notification to the admin -> Option A

4. Quick Check:

   Use failed() to notify admin on job failure [OK]

Hint: Put notification code inside failed() method [OK]

Common Mistakes:

• Expecting Artisan commands to notify admin automatically
• Assuming database config sends emails
• Trying to set flags in constructor for notifications