Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shipsaas/laravel-priority-queue
Priority Queues driver implementation for Laravel. Utilizing DB Driver.
https://github.com/shipsaas/laravel-priority-queue
laravel laravel-framework laravel-package php priority-queue queue
Last synced: 1 day ago
JSON representation
Priority Queues driver implementation for Laravel. Utilizing DB Driver.
- Host: GitHub
- URL: https://github.com/shipsaas/laravel-priority-queue
- Owner: shipsaas
- License: mit
- Created: 2023-03-28T07:58:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-21T11:16:03.000Z (6 months ago)
- Last Synced: 2024-04-22T10:57:10.385Z (5 months ago)
- Topics: laravel, laravel-framework, laravel-package, php, priority-queue, queue
- Language: PHP
- Homepage:
- Size: 141 KB
- Stars: 47
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ShipSaaS - Laravel Priority Queue Driver
[](https://packagist.org/packages/shipsaas/laravel-priority-queue)
[](https://packagist.org/packages/shipsaas/laravel-priority-queue)
[](https://codecov.io/gh/shipsaas/laravel-priority-queue)
[](https://github.com/shipsaas/laravel-priority-queue/actions/workflows/build.yml)
[](https://github.com/shipsaas/laravel-priority-queue/actions/workflows/build-laravel.yml)
A simple Priority Queue Driver for your Laravel Applications to serve your priority messages and
makes users happy 🔋.
With the famous Repository Pattern of Laravel, Priority Queue Driver is easily get injected into
Laravel's Lifecycle without any hassle/hurdle.
We can use built-in artisan command `php artisan queue:work` 😎.
## Supports
- Laravel 11 (supports by default)
- Laravel 10 (supports until Laravel drops the bug fixes at [August 6th, 2024](https://laravel.com/docs/11.x/releases))
- PHP 8.2 & 8.3
- Any database that Laravel supported.
## Architecture Diagram
### Why Priority Queue Driver use Database?
- Everybody knows Database (MySQL, PgSQL, etc) 👀.
- Easy and simple to implement ❤️.
- Utilize the `ORDER BY` and `INDEX` for fast queue msgs pop process. Faster than any other stuff 🔥.
- Highest visibility (you can view the jobs and their data in DB) ⭐️.
- Highest flexibility (you can change the weight directly in DB to unblock important msgs) 💰.
- No extra tool involved. Just Laravel 🥰.
## Install Laravel Priority Queue
```bash
composer require shipsaas/laravel-priority-queue
```
### One-Time Setup
Export and run the migration (one-time). We don't load migration by default just in case you want to customize the migration schema 😎.
```bash
php artisan vendor:publish --tag=priority-queue-migrations
php artisan migrate
```
Open `config/queue.php` and add this to the `connections` array:
```php
'connections' => [
// ... a lot of connections above
// then our lovely guy here
'database-priority' => [
'driver' => 'database-priority',
'connection' => 'mysql',
'table' => 'priority_jobs',
'queue' => 'default',
'retry_after' => 90,
'after_commit' => false, // or true, depends on your need
],
],
```
## Scale/Reliability Consideration
It is recommended to use a different database connection (eg `mysql_secondary`) to avoid the worker processes ramming your
primary database.
## Usage
### The Job Weight
The default job weight is **500**.
You can define a hardcoded weight for your job by using the `$jobWeight` property.
```php
class SendEmail implements ShouldQueue
{
public int $jobWeight = 500;
}
```
Or if you want to calculate the job weight on runtime, you can use the `UseJobPrioritization` trait:
```php
use ShipSaasPriorityQueue\Traits\UseJobPrioritization;
class SendEmail implements ShouldQueue
{
use UseJobPrioritization;
public function getJobWeight() : int
{
return $this->user->isUsingProPlan()
? 1000
: 500;
}
}
```
### Dispatch the Queue
You can use the normal Dispatcher or Queue Facade,... to dispatch the Queue Msgs
### As primary queue
```env
QUEUE_CONNECTION=database-priority
```
And you're ready to roll.
### As secondary queue
Specify the `database-priority` connection when dispatching a queue msg.
```php
// use Dispatcher
SendEmail::dispatch($user, $emailContent)
->onConnection('database-priority');
// use Queue Facade
use Illuminate\Support\Facades\Queue;
Queue::connection('database-priority')
->push(new SendEmail($user, $emailContent));
```
I get that you guys might don't want to explicitly put the connection name. Alternatively, you can do this:
```php
class SendEmail implements ShouldQueue
{
// first option
public $connection = 'database-priority';
public function __construct()
{
// second option
$this->onConnection('database-priority');
}
}
```
## Run The Queue Worker
Nothing different from the Laravel Documentation 😎. Just need to include the `database-priority` driver.
```bash
php artisan queue:work database-priority
# Extra win, priority on topic
php artisan queue:work database-priority --queue=custom
```
## Testing
Run `composer test` 😆
Available Tests:
- Unit Testing
- Integration Testing against MySQL and `queue:work` command
## Contributors
- Seth Phat
## Contributions & Support the Project
Feel free to submit any PR, please follow PSR-1/PSR-12 coding conventions and unit test is a must.
If this package is helpful, please give it a ⭐️⭐️⭐️. Thank you!
## License
MIT License