Laravel Job Batching with Realtime Progress

Preview Realtime Job Batching

List of Contents

• Laravel Job Batching with Realtime Progress
  • Preview Realtime Job Batching
  • List of Contents
  • Requirement
  • Configuration
    • Migration Table
    • Install Package
    • Pusher Configuration
  • Implementation
    • Create Service Repository
    • Create Controller Function
    • Setup javascript
  • Changelog
  • Credits
  • License

Requirement

• PHP 7.4 or Higher
• Laravel 8 or Higher
• Laravel Job Queue
• Pusher

Configuration

Migration Table

• Make migration job table

php artisan queue:table

• Make migration job batches table

php artisan queue:batches-table

• Migrate table

php artisan migrate

Install Package

composer require yogameleniawan/realtime-job-batching

Pusher Configuration

• Install Pusher PHP SDK

composer require pusher/pusher-php-server

• Create Channels App Create Channel Pusher
• Setting Up your .env for pusher variable

PUSHER_APP_ID=your_pusher_app_id
PUSHER_APP_KEY=your_pusher_app_key
PUSHER_APP_SECRET=your_pusher_app_secret
PUSHER_HOST=
PUSHER_PORT=443
PUSHER_SCHEME=https
PUSHER_APP_CLUSTER=mt1

Implementation

Create Service Repository

• Create repository class on your_project\app\Repositories For example: VerificationRepository.php.

So now you have repository class your_project\app\Repositories\VerificationRepository.php

• Add implements RealtimeJobBatchInterface in your Repository Class

• Don't forget to import interface use YogaMeleniawan\JobBatchingWithRealtimeProgress\Interfaces\RealtimeJobBatchInterface;

• The interface has 2 methods. So, you should implement these methods :

  public function get_all(): Collection In this function you can get all data from your database and return it into Collection. Why you should return into Collection? First of all, the data will be looping with foreach method and then add one by one into job and then the process will executed one by one.

  public function save($data): void In this function you can make your own business logic to update/delete/something else that you want. So, this function doesn't have any return data that's why this function must be void type.

• This is the example of Repository Class

Create Controller Function

• Create function to handle your job process For example :

use YogaMeleniawan\JobBatchingWithRealtimeProgress\RealtimeJobBatch;
use App\Repositories\VerificationRepository;

RealtimeJobBatch::setRepository(new VerificationRepository())
                    ->execute(name: 'User Verification')

VerificationRepository() is your service repository that you have created before so don't forget to import this class use App\Repositories\VerificationRepository;

• Explanation about RealtimeJobBatch methods :
  • setRepository(RealtimeJobBatchInterface $repository):object is method to implement your repository class that you want to use and return to object. So, you can use RealtimeJobBatch class in another service with different repository.
  • execute($name): object is method to execute job service with your custom name that you want. This method will return object.

Setup javascript

• Add this script to your view (blade). For another view (React/Vue/Etc) you can check out from this link Setup Pusher
• Script Blade :

    <script src="https://js.pusher.com/7.2/pusher.min.js"></script>
    <script>
        var pusher = new Pusher('YOUR_PUSHER_APP_KEY', {
        cluster: 'mt1'
        });

        var channel = pusher.subscribe('channel-job-batching');
        channel.bind('broadcast-job-batching', function(data) {
            console.log(data)
        });

        var channel_finish = pusher.subscribe('channel-finished-job');
        channel_finish.bind('request-finished-job', function(data) {
            if (data.finished == true) {
                // reset your progress bar
            }
        });
    </script>

• Response from Pusher :

{
  "finished": false,
  "progress": 10,
  "pending": 90,
  "total": 100,
  "data": {}
},

Changelog

Please see CHANGELOG for more information what has changed recently.

Credits

• Yoga Meleniawan Pamungkas
• All Contributors

License

The MIT License (MIT). Please see License File for more information.