README

A small Craft CMS module that releases matching queue jobs after they fail, instead of leaving them in the failed-jobs list. Pairs with webhubworks/craft-flare so failures are still reported, just not stuck in the queue.

Useful for queue jobs that won't recover on retry — revoked API credentials, deleted remote resources, deactivated accounts, malformed external state.

Requirements

PHP 8.2+
Craft CMS 5
(Optional but recommended) webhubworks/craft-flare for error reporting

Installation

composer require jorisnoo/craft-queue-failure-handler

return [
    'modules' => [
        'queue-failure-handler' => \Noo\CraftQueueFailureHandler\Module::class,
    ],
    'bootstrap' => ['queue-failure-handler'],
];

Configuration

Create config/queue-failure-handler.php:

<?php

use verbb\formie\jobs\TriggerIntegration;

return [
    'rules' => [
        // Drop Formie Mailchimp jobs whose account has been deactivated.
        [
            'jobClass' => TriggerIntegration::class,
            'message' => '/User Disabled|account has been deactivated/i',
        ],
    ],
];

Each rule is either:

A callable fn(\yii\queue\ExecEvent $event): bool — full control, do whatever you want with the event.
An array with optional jobClass and message keys. Both must match if both are present.
- jobClass — fully-qualified class name; matched with instanceof.
- message — matched against $event->error->getMessage(). Substring by default, regex if it starts with /.

When a rule matches, the queue row is deleted and $event->retry is set to false. Errors that don't match any rule keep Craft's default behaviour (retry until attempts are exhausted, then sit in the failed list).

How It Works

The module listens on craft\queue\Queue::EVENT_AFTER_ERROR. When a rule matches, it calls Craft::$app->getQueue()->release($event->id) to drop the job from the queue table.

It does not report errors itself. If webhubworks/craft-flare is installed, its own listener on the same event handles reporting — the report still lands in Flare even though the queue row is gone.

License

MIT — see LICENSE.md.

jorisnoo / craft-queue-failure-handler

Maintainers

Package info

Statistics

Security