Search by

delvark / yii2-queue

delvark

Driver-independent unique jobs and pending notification coalescing for Yii2 Queue

Package info

gitverse.ru/delvark/yii2-queue

Issues

Type:yii2-extension

pkg:composer/delvark/yii2-queue

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

v1.1.0 2026-11-21 19:16 UTC

This package is not auto-updated.

Last update: 2026-11-22 11:49:10 UTC


README

Уникальные задачи и объединение повторных уведомлений поверх yiisoft/yii2-queue. Расширение атомарно занимает ключ в Redis, пропускает дубликат или заменяет payload ожидающей задачи. Поддерживаются адаптеры всех десяти штатных драйверов upstream.

Требуются PHP ^8.5, Yii2 ^2.0.55, yiisoft/yii2-queue ~2.3.9 и сервер Redis. Redis нужен для реестра уникальности при любом драйвере очереди, включая File и DB.

Установка

composer require delvark/yii2-queue:^1.0

Подключение

Добавьте общую конфигурацию в web-приложение и console-приложение worker:

return [
    'bootstrap' => ['queue'],
    'components' => [
        'redis' => [
            'class' => yii\redis\Connection::class,
            'hostname' => '127.0.0.1',
            'port' => 6379,
            'database' => 0,
        ],
        'queue' => [
            'class' => delvark\queue\drivers\file\Queue::class,
            'path' => '@runtime/queue',
            'ttr' => 300,
            'attempts' => 3,
        ],
        'uniqueQueue' => [
            'class' => delvark\queue\UniqueQueue::class,
            'queue' => 'queue',
            'componentId' => 'uniqueQueue',
            'scope' => 'shop:order-mail',
            'leaseGrace' => 5,
            'store' => [
                'class' => delvark\queue\RedisStore::class,
                'redis' => 'redis',
                'prefix' => 'shop:unique:',
            ],
        ],
    ],
];

Producer и worker должны использовать одинаковые componentId, scope, Redis, prefix, сериализатор payload и настройки соответствующей очереди. Для File им нужен доступ к одним файлам очереди. componentId должен совпадать с именем компонента UniqueQueue в приложении. Используйте адаптер delvark, а не исходный класс yii\queue\<driver>\Queue.

Постановка

EmailJob — класс приложения, реализующий yii\queue\JobInterface:

use delvark\queue\DuplicatePolicy;
use delvark\queue\PushStatus;

$result = Yii::$app->uniqueQueue->push(
    new EmailJob(['orderId' => $orderId]),
    key: 'email_' . $orderId,
    ttl: 900,
    policy: DuplicatePolicy::Update,
    delay: 300,
);

if ($result->status === PushStatus::Created) {
    $messageId = $result->messageId;
}

При Update повтор меняет payload до начала первого выполнения; письмо остаётся запланированным относительно первой постановки. Для пропуска повторов используйте DuplicatePolicy::Skip — это значение по умолчанию. Worker запускается штатно:

php yii queue/listen

Параметры push: job, key, ttl = 3600, policy = Skip, delay = 0, priority = null, ttr = null. Ключ содержит 1–1024 байта; TTL и TTR положительные, delay неотрицательный. TTR по умолчанию берётся из RetryableJobInterface::getTtr() или queue.ttr. PushResult содержит status (Created, Updated, Skipped), generation и messageId; native ID возвращается только для Created.

TTL задаёт окно дедупликации от первой постановки. Его истечение допускает новую задачу с тем же ключом и сохраняет возможность выполнения старой. Успех или терминальная ошибка освобождают свой ключ раньше TTL. После истечения TTL разные поколения одного ключа могут выполняться одновременно. Update не продлевает TTL и не меняет delay, priority или TTR; несовместимый TTR отклоняется.

Обычные задачи без уникальности можно по-прежнему отправлять через Yii::$app->queue->push($job).

Подробнее

Лицензия: MIT.