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
    }
}

Need a 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
    }
}

Need a 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
    }
}

Need a 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
    }
}

Need a hint?

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