comments

Author: cosmastech

src/Illuminate/Queue/Middleware/RetryIf.php

@@ -8,14 +8,18 @@
 class RetryIf
 {
     /**
-     * @param  \Closure(\Throwable, ?mixed): bool  $retryIf  The condition of the failure that will retry the job.
+     * A middleware that allows short-circuiting job retries. This does not
+     * override the retry mechanism of the job and queue, so do not use
+     * this middleware to extend tries beyond the those conditions.
+     *
+     * @param  \Closure(\Throwable, mixed): bool  $retryIf  The truth-test callback to determine if the job should be retried or failed.
      */
     public function __construct(protected Closure $retryIf)
     {
     }
 
     /**
-     * Do not retry if any of the exceptions were thrown.
+     * Short-circuit retries if any of the exceptions were thrown.
      *
      * @param  class-string<\Throwable>  ...$exceptions
      * @return static
@@ -34,7 +38,7 @@ public static function failureIsNot(...$exceptions): static
     }
 
     /**
-     * Only retry if the exception thrown matches.
+     * Continue retries for any of the specified exceptions.
      *
      * @param  class-string<\Throwable>  ...$exceptions
      * @return static

tests/Queue/RetryIfMiddlewareTest.php

@@ -15,6 +15,7 @@
 use Orchestra\Testbench\TestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\TestWith;
+use Throwable;
 
 class RetryIfMiddlewareTest extends TestCase
 {
@@ -25,7 +26,7 @@ protected function setUp(): void
     }
 
     /**
-     * @return array<string, array{class-string<\Throwable>, RetryIf}>
+     * @return array<string, array{class-string<\Throwable>, RetryIf, bool}>
      */
     public static function expectedToFailDataProvider(): array
     {
@@ -71,7 +72,7 @@ public function test_middleware(
                 'command' => serialize($job),
             ]);
             $this->fail('Did not throw exception');
-        } catch (\Throwable $e) {
+        } catch (Throwable $e) {
             $this->assertInstanceOf($thrown, $e);
         }
 
@@ -80,7 +81,7 @@ public function test_middleware(
 
     #[TestWith(['abc', false])]
     #[TestWith(['tots', true])]
-    public function test_can_test_against_job($value, bool $expectedToFail): void
+    public function test_can_test_against_job_properties($value, bool $expectedToFail): void
     {
         RetryIfMiddlewareJob::$_middleware = [new RetryIf(fn ($thrown, $job) => $job->value === 'abc')];
 
@@ -95,12 +96,11 @@ public function test_can_test_against_job($value, bool $expectedToFail): void
                 'command' => serialize($job),
             ]);
             $this->fail('Did not throw exception');
-        } catch (\Throwable $e) {
+        } catch (Throwable) {
             //
         }
 
         $expectedToFail ? $job->assertFailed() : $job->assertNotFailed();
-
     }
 }