codeigniter4 / queue Goto Github PK

View Code? Open in Web Editor NEW

43.0 9.0 11.0 808 KB

Queues for the CodeIgniter 4 framework

Home Page: https://queue.codeigniter.com/

License: MIT License

PHP 99.84% Hack 0.16%

codeigniter codeigniter4 queue queue-workers php81

queue's Introduction

CodeIgniter Queue

Queues for the CodeIgniter 4 framework.

Installation

composer require codeigniter4/queue

Migrate your database:

php spark migrate --all

Configuration

Publish configuration file:

php spark queue:publish

Create your first Job:

php spark queue:job Example

Add it to the $jobHandlers array in the app\Config\Queue.php file:

// ...

use App\Jobs\Example;

// ...

public array $jobHandlers = [
    'my-example' => Example::class
];

// ...

Basic usage

Add job to the queue:

service('queue')->push('queueName', 'my-example', ['data' => 'array']);

Run the queue worker:

php spark queue:work queueName

Docs

Read the full documentation: https://queue.codeigniter.com

Contributing

We accept and encourage contributions from the community in any shape. It doesn't matter whether you can code, write documentation, or help find bugs, all contributions are welcome. See the CONTRIBUTING.md file for details.

queue's People

Contributors

Stargazers

Watchers

Forkers

michalsn kenjis datamweb kgrruz the-shadoo phhuy38 luciocodeigniter ddevsr habtish-yimer warcooft karthik-code

queue's Issues

Dev: Postgresql queue:jobs

Hello everyone,
I don't know if you have performed any operations on postgresql.
I can't consume the jobs
php spark queue:job Email

attached the error image

Thanks,

php spark queue:work default error

Undefined array key "retyAfter"

at VENDORPATH\codeigniter4\queue\src\Commands\QueueWork.php:206

queue:work default - error after start job

CodeIgniter\CLI\CLI::print(): Argument #1 ($text) must be of type string, int given, called in \vendor\codeigniter4\queue\src\Commands\QueueWork.php on line 164

at SYSTEMPATH\CLI\CLI.php:449

Backtrace:
1 VENDORPATH\codeigniter4\queue\src\Commands\QueueWork.php:164
CodeIgniter\CLI\CLI::print()

2 SYSTEMPATH\CLI\Commands.php:65
CodeIgniter\Queue\Commands\QueueWork()->run()

3 SYSTEMPATH\CLI\Console.php:46
CodeIgniter\CLI\Commands()->run()

4 ROOTPATH\spark:102
CodeIgniter\CLI\Console()->run()

Bug: Queue Not Logging Failed Tasks with Transactions

Issue Description:
I have identified a bug in the CodeIgniter 4 queue system. When a task fails during execution, and that task involves a transaction, it fails to log the failure in the designated log file.

class ExampleJob
{
    public function process(string $data):
    {
        $db = db_connect();
        
        $db->transStart(); // Start Transaction
            
       // Job logic here and get RuntimeException

    }
}

When a job fails to execute, the system fails to log the failure in the queue_jobs_failed table. Furthermore, when utilizing the DatabaseHandler, the job record remains unremoved from the queue_jobs table.

This oversight results in a lack of visibility into failed jobs and may lead to potential data inconsistency within the job management system.

FOR UPDATE SKIP LOCKED

MariaDb 10.5 not work query

SELECT *
FROM `queue_jobs`
WHERE `queue` = 'price_import'
AND `status` = 0
AND `available_at` <= 1707854930
AND `priority` IN ('default')
ORDER BY `available_at` ASC, `id` ASC
 LIMIT 1 FOR UPDATE SKIP LOCKED

Dev: FOR UPDATE SKIP LOCKED issue when retrieving jobs in a queue

When retrieving jobs in a queue the function skipLocked() is called (QueueJobModel.php). The sql addon "FOR UPDATE SKIP LOCKED" is not available in new but not the newest MariaDB versions. This causes a "FALSE" on the query leading to an empty queue. Perhaps it's better to throw an exception than. Returning zero jobs is confusing.

by composer install error

[ErrorException]

Undefined array key 0

at VENDORPATH\codeigniter4\queue\src\Commands\QueuePublish.php:21

No return type in Services::queue()

https://github.com/michalsn/codeigniter-queue/blob/2ff57f5858934e9385450b55fd821ca7aff4702e/src/Config/Services.php#L11

This causes the following PHPStan (phpstan-codeigniter) error.

 ------ --------------------------------------------- 
  Line   app/Events/NewPostEvent.php                  
 ------ --------------------------------------------- 
  66     Service method 'queue' returns mixed.        
         💡 Perhaps you forgot to add a return type?  
 ------ ---------------------------------------------