queueworker / sansdaemon
Batch process Laravel Queue without a daemon; Processes queue jobs and kills the process
Installs: 121 578
Dependents: 3
Suggesters: 0
Security: 0
Stars: 176
Watchers: 5
Forks: 17
Open Issues: 3
Requires
- php: ^7.2|^8.0
- illuminate/support: ^6.0|^7.0|^8.0|^9.0|^10.0
Requires (Dev)
- mockery/mockery: ^1.1
- orchestra/testbench: ^4.0
- phpunit/phpunit: ^8
README
Introduction
Batch process Laravel Queue without a daemon; Processes all jobs on the queue(s) and exits without running on daemon mode. This is useful in cases where you just want to process jobs on the queue and exit the worker process so they don't pile up in memory.
Installation
To install the latest version of SansDaemon, simply use composer
Download
composer require queueworker/sansdaemon
- If your Laravel version is below 5.5, you'll need to add the service provider to your
config/app.php
file.
Queueworker\SansDaemon\SansDaemonServiceProvider::class,
Usage
SansDaemon is a console application that extends the functionality of laravel's WorkCommand
- Illuminate\Queue\Console\WorkCommand
. See Laravel Queue documentation.
To run the queue worker sans-daemon mode, simply add the --sansdaemon
option to the original laravel queue worker command:
php artisan queue:work --sansdaemon
Argument and Options
Since this package extends laravel's WorkCommand
, it takes exactly all the arguments and options the original WorkCommand takes with three added options:
--sansdaemon
option tell the worker to process jobs on the queue without running in daemon mode.--jobs
(default: 0, optional) - It allows you to specify the number of jobs to process each time the command runs. The default value0
means it'll process all available jobs in the queue.--max_exec_time
(default:ini_get('max_execution_time') - 5s
, optional) - On some webhosts, your scripts will be killed, if it exceeds some amount of time. To prevent this behavior on really full queue, worker will stop after--max_exec_time
. This is especially useful if you're running this command via your application's route or controller. See Laravel Documentation on how to run your queue programmatically.
Note on --max_exec_time
0
(zero) means the worker will run forever, which in this context means until the worker process is done. This is the default behavior when run from CLI.- This option will not prevent
Maximum execution time exceeded
error, it'll try to avoid it by not running the next job on the queue if the script is reaching its max_execution_time
Testing
composer test
License
MIT license (MIT) - Check out the License File for more.