Job retries and failure in Laravel - Mini Project: Build & Apply

Job retries and failure handling in Laravel

📖 Scenario: You are building a Laravel application that processes user-uploaded files in the background using jobs. Sometimes, jobs may fail due to temporary issues like network errors. You want to handle retries and failures properly to ensure reliability.

🎯 Goal: Build a Laravel job class that retries up to 3 times on failure and handles the failure by logging an error message.

📋 What You'll Learn

Create a Laravel job class named ProcessFileJob with a handle method

Add a public property $tries set to 3 to specify retry attempts

Implement a failed method that logs the failure message

Use Laravel's Log facade to log the failure inside the failed method

💡 Why This Matters

🌍 Real World

Handling retries and failures in background jobs is important for building reliable Laravel applications that process tasks asynchronously.

💼 Career

Understanding job retries and failure handling is essential for backend developers working with Laravel queues and background processing.

1

Create the job class with the handle method

Create a Laravel job class named ProcessFileJob with a public method handle that is empty for now.

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 ProcessFileJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

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

Hint

Use php artisan make:job ProcessFileJob to generate the job class, then add the handle method.

2

Add retry attempts property

Add a public property $tries to the ProcessFileJob class and set it to 3 to specify the maximum retry attempts.

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 ProcessFileJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    public $tries = 3;

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

Hint

Add public $tries = 3; inside the class but outside any method.

3

Implement the failed method to handle job failure

Add a public method failed to the ProcessFileJob class that accepts an \Exception $exception parameter. Inside this method, use the Laravel Log facade to log an error message 'Job failed: ' . $exception->getMessage().

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;
use Illuminate\Support\Facades\Log;

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

    public $tries = 3;

    public function handle()
    {
        // Job logic will go here
    }

    public function failed(\Exception $exception)
    {
        // Your code here
    }
}

Hint

Import the Log facade with use Illuminate\Support\Facades\Log; and call Log::error() inside the failed method.

4

Complete the job class with all parts combined

Ensure the ProcessFileJob class includes the public $tries = 3; property, the handle method, and the failed method that logs the failure using Log::error. The class should import all necessary Laravel traits and facades.

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;
use Illuminate\Support\Facades\Log;

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

    public $tries = 3;

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

    public function failed(\Exception $exception)
    {
        // Your code here
    }
}

Hint

Make sure all parts are included and the class imports Log facade.

Practice

1. In Laravel, what does setting the $tries property in a job class control?

easy

A. The number of times the job will be retried if it fails

B. The maximum execution time of the job

C. The priority of the job in the queue

D. The database connection used by the job

Solution

1. Step 1: Understand the role of $tries in Laravel jobs

   The $tries property defines how many times Laravel will attempt to run the job if it fails.

2. Step 2: Differentiate from other job properties

   It does not control execution time, priority, or database connection, only retry attempts.

3. Final Answer:

   The number of times the job will be retried if it fails -> Option A

4. Quick Check:

   $tries controls retry attempts [OK]

Hint: Remember: $tries means retry count for failed jobs [OK]

Common Mistakes:

• Confusing $tries with job timeout
• Thinking $tries sets job priority
• Assuming $tries controls database connection

2. Which of the following is the correct way to define a job retry limit of 5 attempts in a Laravel job class?

easy

A. public $tries = 5;

B. protected $retry = 5;

C. public $retryAttempts = 5;

D. protected $triesCount = 5;

Solution

1. Step 1: Recall the correct property name for retry attempts

   Laravel uses $tries as a public property to set retry limits.

2. Step 2: Check syntax and visibility

   The property should be public and named exactly $tries to work properly.

3. Final Answer:

   public $tries = 5; -> Option A

4. Quick Check:

   Correct property is public $tries [OK]

Hint: Use public $tries = number; to set retries [OK]

Common Mistakes:

• Using protected instead of public
• Using wrong property names like $retry or $triesCount
• Confusing retry limit with timeout

3. Given this Laravel job class snippet:

class SendEmailJob implements ShouldQueue {
    public $tries = 3;
    public function handle() {
        // code that may fail
        throw new \Exception('Failed');
    }
    public function failed() {
        // handle failure
        Log::info('Job failed permanently');
    }
}

How many times will Laravel attempt to run this job before calling failed()?

medium

A. 1 time

B. 3 times

C. 4 times

D. It will retry indefinitely

Solution

1. Step 1: Understand how $tries works

   The $tries property sets the maximum number of times the job will be attempted, including the initial attempt.

2. Step 2: Calculate total attempts

   With $tries = 3, Laravel attempts the job 3 times total before calling failed().

3. Final Answer:

   3 times -> Option B

4. Quick Check:

   Total attempts = $tries = 3 [OK]

Hint: Total attempts = $tries [OK]

Common Mistakes:

• Thinking total attempts = 1 + $tries
• Assuming retries are unlimited
• Confusing failed() call timing

4. Examine this Laravel job code:

class ProcessOrder implements ShouldQueue {
    public $tries = 2;
    public function handle() {
        // some code
        throw new \Exception('Error');
    }
    public function failed() {
        // log failure
        Log::error('Order processing failed');
    }
}

Why might the failed() method never be called after job failures?

medium

A. Because the $tries property is set to 2, so it retries infinitely

B. Because the job is not implementing the ShouldQueue interface

C. Because the job is failing but failed() is not triggered until retries are exhausted

D. Because the failed() method must accept an Exception parameter

Solution

1. Step 1: Check method signature for failed()

   Laravel expects failed() to accept an Exception parameter to receive failure details.

2. Step 2: Understand impact of missing parameter

   If failed() lacks the Exception parameter, Laravel may not call it properly after retries.

3. Final Answer:

   The failed() method must accept an Exception parameter -> Option D

4. Quick Check:

   failed(Exception $exception) required [OK]

Hint: Add Exception parameter to failed() method [OK]

Common Mistakes:

• Assuming $tries = 2 means infinite retries
• Forgetting to implement ShouldQueue interface
• Ignoring method signature requirements

5. You want a Laravel job to retry 3 times on failure, but after the last failure, you want to notify the user by email. Which is the best way to implement this behavior?

hard

A. Set public $tries = 3; and use a separate job to send the email without failed()

B. Set public $tries = 3; and send the email inside the handle() method after catching exceptions

C. Set public $tries = 3; and define a failed(Exception $exception) method to send the email notification

D. Set public $maxAttempts = 3; and send the email in the constructor

Solution

1. Step 1: Use $tries to limit retry attempts

   Setting public $tries = 3; ensures the job retries 3 times on failure.

2. Step 2: Use failed(Exception $exception) to handle final failure

   Defining failed() with the Exception parameter allows sending email after all retries fail.

3. Final Answer:

   Set public $tries = 3; and define a failed(Exception $exception) method to send the email notification -> Option C

4. Quick Check:

   Retries + failed() method for final failure handling [OK]

Hint: Use $tries and failed(Exception $exception) for retries and notification [OK]

Common Mistakes:

• Trying to send email inside handle() ignoring retries
• Using wrong property name like $maxAttempts
• Not using failed() method for final failure