[10.x] Add progress option to PendingBatch

[orkhanahmadov]

The goal is to invoke a callback every time a job in batch successfully executes. Useful when we want to fire an event on progress, which will send a broadcast message to the user with a real progress percentage using \Illuminate\Bus\Batch progress value.

I named the new option progress, I believe it makes sense because a callback will be called only when the batch progresses. But feel free to rename it, or request rename.

[mvynhb]

@orkhanahmadov

Shouldn't the progress callback be called on both successful and failed jobs? As I understand the current progress percentage logic is based on both successful and failed jobs.

[orkhanahmadov]

@orkhanahmadov

Shouldn't the progress callback be called on both successful and failed jobs? As I understand the current progress percentage logic is based on both successful and failed jobs.

@mvynhb I believe it is not necessary. Batch already runs catch callbacks when a job in the batch fails. catch callbacks also receive a Batch instance, there you can still see the progress and everything that the Batch instance contains.
https://laravel.com/docs/10.x/queues#dispatching-batches

[taylorotwell]

Thanks for your pull request to Laravel!

Unfortunately, I'm going to delay merging this code for now. To preserve our ability to adequately maintain the framework, we need to be very careful regarding the amount of code we include.

If possible, please consider releasing your code as a package so that the community can still take advantage of your contributions!

If you feel absolutely certain that this code corrects a bug in the framework, please "@" mention me in a follow-up comment with further explanation so that GitHub will send me a notification of your response.