Почему в yii2 очередях отрабатывают только триггеры: Queue::EVENT_BEFORE_PUSH и Queue::EVENT_AFTER_PUSH?

Question

[EVOSandru6]

Добрый день,

Сконфигурировал поддержку очердей как в документации:

https://github.com/yiisoft/yii2-queue

Сами очереди отрабатывают нормально. В качестве драйвера указал 'db' и создал mysql таблицу как в доке

Далее в основах:

https://github.com/yiisoft/yii2-queue/blob/master/...

Пытаюсь слушать события. Мне Интереснее всего следить за:

Queue::EVENT_AFTER_EXEC
ExecEvent
После каждого успешного выполнения задания

Но не могу в него попасть хотя очередь отабатывает успешно.

./yii queue/listen --color --verbose --isolate
----------------------
2018-10-09 14:43:10 [156] common\jobs\DownloadJob (attempt: 1, pid: 4297) - Started
2018-10-09 14:43:11 [156] common\jobs\DownloadJob (attempt: 1, pid: 4297) - Done (0.379 s)

Ловлю:

EVENT_BEFORE_PUSH
EVENT_AFTER_PUSH

Не ловлю:

EVENT_BEFORE_EXEC
EVENT_AFTER_EXEC
EVENT_AFTER_ERROR
EVENT_WORKER_START
EVENT_WORKER_LOOP
EVENT_WORKER_STOP

Пример отлова:

$afterExecAlert = function($event) {
            throw new \Exception('Hurra - EVENT_AFTER_EXEC');
        };
Yii::$app->queue->on(Queue::EVENT_AFTER_EXEC, $afterExecAlert);

Yii::$app->queue->push(new DownloadJob([
            'url' => 'https://picsum.photos/200/500',
            'file' => $full_path,
        ]));

Config:

'queue' => [
            'class' => \yii\queue\db\Queue::class,
            'db' => 'db', // DB connection component or its config
            'tableName' => '{{%queue}}', // Table name
            'channel' => 'default', // Queue channel key
            'mutex' => \yii\mutex\MysqlMutex::class, // Mutex used to sync queries
            'as log' => \yii\queue\LogBehavior::class
        ],

Подскажите пожалуйста в чем причина?

Answer 1

[Роман Журавлев]

Отправка и получение сообщений происходит в разных процессах. Вы вешаете обработчик EVENT_AFTER_EXEC в процессе, который отправляет сообщения. Воркер-процесс про это ничего не знает, а именно он триггерит EVENT_AFTER_EXEC.

Оформите обработчик события в виде Behavior-а ( по типу LogBehavior), и подключите его в общий конфиг. Это решит проблему.

Comments

[EVOSandru6]

Благодарю, если я правильно понял, надо так:

'queue' => [
            'class' => \yii\queue\db\Queue::class,
            'db' => 'db', // DB connection component or its config
            'tableName' => '{{%queue}}', // Table name
            'channel' => 'default', // Queue channel key
            'mutex' => \yii\mutex\MysqlMutex::class, // Mutex used to sync queries
            'as log' => \yii\queue\LogBehavior::class,
            'on '.yii\queue\Queue::EVENT_BEFORE_EXEC => function($event) {
                throw new \Exception('oops');
            }
        ],

В throw new \Exception('oops'); я не попадаю.

Возможно я не понял Вас в терминологии, просто я с Laravel пришел на Yii2 недавно.

И еще момент - если глобально навешать все таки удастся, то такой обработчик будет обрабатывать абсолютно все успешно завершенные воркеры. Но как быть если логика таких завершений может отличаться?

[Роман Журавлев]

если я правильно понял, надо так

Технически - да, ваш вариант работать будет. Но писать код в конфигах - плохая практика. Для этого есть Behavior-ы. В терминах Laravel и Symfony это что-то типа EventListener. В Yii2 нет отдельного event-диспетчера. Диспетчиризация происходит на уровне любого класса унаследованного от `\yii\base\Component`. Создается наследник `\yii\base\Behavior`, в котором нужно реализовать обработчики событий. И подключается в конфиг:

'queue' => [
    'class' => \yii\queue\db\Queue::class,
    'as xxx' => \...\MyQueueBehavior::class,
],

И еще момент - если глобально навешать все таки удастся, то такой обработчик будет обрабатывать абсолютно все успешно завершенные воркеры. Но как быть если логика таких завершений может отличаться?

Да, абсолютно все. В обработчик пробрасывается параметр типа `\yii\queue\JobEvent` в нем, кроме прочего, ссылка обрабатываемое задание. По нему и стройте условие, что обрабатывать, а что - нет.

[EVOSandru6]

Спасибо, но тяжеловато в понимании.

Так можно или нельзя несколько обработчиков в конфиге навешать?

Есть ли пример в документации с поведением?

[Роман Журавлев]

тяжеловато в понимании.

Это базовые принципы. Поведения хорошо описаны в документации yii2.

[Роман Журавлев]

Тут как создавать поведение. В одном поведении на одно событие можно повесить только один обработчик. Но к компоненту можно подключить несколько поведений, которые на одно и то же событие повесят свои обработчики. Логи из LogBehavior так же пишутся через события.

[EVOSandru6]

С поведениями понятно, они цепляются к компонентам или моделям как сквозная функциональность.

1) Допустим создали поведение с событием EVENT_AFTER_EXEC (где обработчик?)
2) К какому компоненту цеплять данное событие?

[Роман Журавлев]

К компоненту очереди, как описано выше:

'queue' => [
    'class' => \yii\queue\db\Queue::class,
    'as xxx' => \...\MyQueueBehavior::class, // <--
],