README

Read-only split. This package is developed in denosyscore/framework under packages/queue. Open issues and pull requests there.

Queue manager, drivers, and job contracts

Installation

composer require denosyscore/queue

Quick start

Push jobs onto a queue and run them with a worker.

<?php

require __DIR__ . '/vendor/autoload.php';

use Denosys\Container\Container;
use Denosys\Queue\Driver\ArrayQueue;
use Denosys\Queue\Job;
use Denosys\Queue\JobRunner;

// Jobs carry payload data only; services are resolved when the job runs.
final class SendWelcomeEmail extends Job
{
    public function __construct(private readonly string $email)
    {
        parent::__construct();
    }

    public function handle(): void
    {
        echo "Welcome email sent to {$this->email}\n";
    }
}

$queue = new ArrayQueue();  // DatabaseQueue in production
$queue->push(new SendWelcomeEmail('ada@example.com'));
echo $queue->size(), " job waiting\n";  // 1 job waiting

// A worker pops, runs and deletes.
$runner = new JobRunner(new Container());
while ($popped = $queue->pop()) {
    $runner->run($popped['job']);
    $queue->delete($popped['id']);
}

Included Modules

src/Queue/*

Runtime services for queued jobs

Extend ContainerAwareJob when a job needs a service after it has been read from a queue. Store only serializable payload in the job. Implement handleWithContainer(ContainerInterface $container) and resolve services at execution time. QueueManager supplies a JobRunner to its synchronous driver. A database queue worker must call JobRunner::run($job) after popping the job; calling handle() directly on a container-aware job raises an error. Existing jobs that implement handle() continue to run through the runner.

$runner = new \Denosys\Queue\JobRunner($container);
$runner->run($popped['job']);

Do not serialize the container, mailers, connections, or other live services inside job payloads. A separately constructed SyncQueue can accept a JobRunner in its constructor when it must execute container-aware jobs.

Database reservations

The database driver conditionally claims each available row so competing workers cannot both take the same reservation. retry_after is the reservation lease in seconds, defaults to 90, and must be positive. A job whose worker stops before deleting or releasing it becomes available again after its lease expires. Configure a lease longer than normal job execution and make jobs idempotent: a worker can finish side effects but stop before deleting its row.

'connections' => [
    'database' => [
        'driver' => 'database',
        'retry_after' => 120,
    ],
],

The Composer requirement accepts database 0.2, 0.3, and 0.4.

Development

composer validate --strict find src -type f -name '*.php' -print0 | xargs -0 -n1 php -l composer test

Releases

After CI passes on main, create an annotated semantic version tag from that reviewed commit and push the tag. The Release workflow publishes a GitHub Release. Confirm the matching version is available in the Composer package index before updating dependent package constraints.

denosyscore / queue

Package info

Security

Statistics