[12.x] Introduce FailOnException job middleware (#56037)

* introduce RetryIf middleware

* test

* test

* test

* yoooo this testing setup is more complicated than it needs to be

* one more shot

* better name

* ok, this is it

* move namespace

* another method

* add job test

* comments

* rename

* Update FailOnException.php

* formatting

---------

Co-authored-by: Taylor Otwell <taylor@laravel.com>

Author: cosmastech

src/Illuminate/Queue/Middleware/FailOnException.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Illuminate\Queue\Middleware;
+
+use Closure;
+use Throwable;
+
+class FailOnException
+{
+    /**
+     * The truth-test callback to determine if the job should fail.
+     *
+     * @var \Closure(\Throwable, mixed): bool
+     */
+    protected Closure $callback;
+
+    /**
+     * Create a middleware instance.
+     *
+     * @param  (\Closure(\Throwable, mixed): bool)|array<array-key, class-string<\Throwable>>  $callback
+     */
+    public function __construct($callback)
+    {
+        if (is_array($callback)) {
+            $callback = $this->failForExceptions($callback);
+        }
+
+        $this->callback = $callback;
+    }
+
+    /**
+     * Indicate that the job should fail if it encounters the given exceptions.
+     *
+     * @param  array<array-key, class-string<\Throwable>>  $exceptions
+     * @return \Closure(\Throwable, mixed): bool
+     */
+    protected function failForExceptions(array $exceptions)
+    {
+        return static function (Throwable $throwable) use ($exceptions) {
+            foreach ($exceptions as $exception) {
+                if ($throwable instanceof $exception) {
+                    return true;
+                }
+            }
+
+            return false;
+        };
+    }
+
+    /**
+     * Mark the job as failed if an exception is thrown that passes a truth-test callback.
+     *
+     * @param  mixed  $job
+     * @param  callable  $next
+     * @return mixed
+     *
+     * @throws Throwable
+     */
+    public function handle($job, callable $next)
+    {
+        try {
+            return $next($job);
+        } catch (Throwable $e) {
+            if (call_user_func($this->callback, $e, $job) === true) {
+                $job->fail($e);
+            }
+
+            throw $e;
+        }
+    }
+}

tests/Queue/FailOnExceptionMiddlewareTest.php

@@ -0,0 +1,122 @@
+<?php
+
+namespace Illuminate\Tests\Queue;
+
+use Illuminate\Bus\Dispatcher;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\CallQueuedHandler;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\Jobs\FakeJob;
+use Illuminate\Queue\Middleware\FailOnException;
+use InvalidArgumentException;
+use LogicException;
+use Orchestra\Testbench\TestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\TestWith;
+use Throwable;
+
+class FailOnExceptionMiddlewareTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        FailOnExceptionMiddlewareTestJob::$_middleware = [];
+    }
+
+    /**
+     * @return array<string, array{class-string<\Throwable>, FailOnException, bool}>
+     */
+    public static function testMiddlewareDataProvider(): array
+    {
+        return [
+            'exception is in list' => [
+                InvalidArgumentException::class,
+                new FailOnException([InvalidArgumentException::class]),
+                true,
+            ],
+            'exception is not in list' => [
+                LogicException::class,
+                new FailOnException([InvalidArgumentException::class]),
+                false,
+            ],
+        ];
+    }
+
+    #[DataProvider('testMiddlewareDataProvider')]
+    public function test_middleware(
+        string $thrown,
+        FailOnException $middleware,
+        bool $expectedToFail
+    ): void {
+        FailOnExceptionMiddlewareTestJob::$_middleware = [$middleware];
+        $job = new FailOnExceptionMiddlewareTestJob($thrown);
+        $instance = new CallQueuedHandler(new Dispatcher($this->app), $this->app);
+
+        $fakeJob = new FakeJob();
+        $job->setJob($fakeJob);
+
+        try {
+            $instance->call($fakeJob, [
+                'command' => serialize($job),
+            ]);
+            $this->fail('Did not throw exception');
+        } catch (Throwable $e) {
+            $this->assertInstanceOf($thrown, $e);
+        }
+
+        $expectedToFail ? $job->assertFailed() : $job->assertNotFailed();
+    }
+
+    #[TestWith(['abc', true])]
+    #[TestWith(['tots', false])]
+    public function test_can_test_against_job_properties($value, bool $expectedToFail): void
+    {
+        FailOnExceptionMiddlewareTestJob::$_middleware = [
+            new FailOnException(fn ($thrown, $job) => $job->value === 'abc'),
+        ];
+
+        $job = new FailOnExceptionMiddlewareTestJob(InvalidArgumentException::class, $value);
+        $instance = new CallQueuedHandler(new Dispatcher($this->app), $this->app);
+
+        $fakeJob = new FakeJob();
+        $job->setJob($fakeJob);
+
+        try {
+            $instance->call($fakeJob, [
+                'command' => serialize($job),
+            ]);
+            $this->fail('Did not throw exception');
+        } catch (Throwable) {
+            //
+        }
+
+        $expectedToFail ? $job->assertFailed() : $job->assertNotFailed();
+    }
+}
+
+class FailOnExceptionMiddlewareTestJob implements ShouldQueue
+{
+    use InteractsWithQueue;
+    use Queueable;
+    use Dispatchable;
+
+    public static array $_middleware = [];
+
+    public int $tries = 2;
+
+    public function __construct(private $throws, public $value = null)
+    {
+    }
+
+    public function handle()
+    {
+        throw new $this->throws;
+    }
+
+    public function middleware(): array
+    {
+        return self::$_middleware;
+    }
+}