[10.x] Allow pruning all cancelled and unfinished queue batches

[jameshulse]

Overview

I was previously unable to prune all queue batches on my local system during developemnt. This is due to a bug with how php artisan queue:prune-batches handles the flags --unfinished=0 --cancelled=0. With this change users will have a slightly nicer experience while developing against the Queue Batches feature.

Before:

After:

Changes in depth

There is a minor bug in the php artisan queue:prune-batches command when trying to delete all batches through pruning with the number of hours set to 0.

The command allows you to prune unfinished and cancelled batches with the --unfinished and --cancelled flags respectively. These flags take a value of the number of hours to prune from, however, unlike the main --hours flag, these flags previously didn't support passing 0 (zero) as a value.

When passing --unfinished=0 or --cancelled=0 the command wouldn't acknowledge that you had passed the option at all. This was due to the check for these options:

if ($this->option('unfinished')) {
    ...
}

When 0 is passed then the above will evaluate to false. The fix is to explicitly check whether the option is null:

if ($this->option('unfinished') !== null) {
    ...
}

Testing

All Laravel tests passed locally after this change. I added a basic test to cover each flag with a value of 0.

Future

It could be useful to have a flag like php artisan queue:prune-batches --all. Although this flag would be potentially dangerous in production, it would short-hand the command that I have been running during development.

[francoism90]

Does this work with Laravel Horizon as well? It would be really useful on development or when you launched an incorrect batch for example.

[dammy001]

@francoism90 No. It doesn't work with horizon.

[francoism90]

@dammy001 Ok, maybe it could be added at some point.

Thanks for the PR. 👍

[jameshulse]

Does this work with Laravel Horizon as well? It would be really useful on development or when you launched an incorrect batch for example.

If I understand your request correctly, it actually does work with Horizon as that was what I was using. Although Horizon uses Redis for tracking jobs, it still uses the database to track batches.