refactor: refactor RetryMiddlewareTest to use backoff option

Author: teandr

tests/Downloader/Middleware/RetryMiddlewareTest.php

@@ -13,11 +13,12 @@
 
 namespace RoachPHP\Tests\Downloader\Middleware;
 
+use InvalidArgumentException;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use RoachPHP\Downloader\Middleware\RetryMiddleware;
 use RoachPHP\Scheduling\ArrayRequestScheduler;
 use RoachPHP\Scheduling\Timing\ClockInterface;
-use RoachPHP\Scheduling\Timing\FakeClock;
 use RoachPHP\Testing\Concerns\InteractsWithRequestsAndResponses;
 use RoachPHP\Testing\FakeLogger;
 
@@ -69,7 +70,7 @@ public function testRetriesARetryableResponse(): void
         $this->middleware->configure([
             'retryOnStatus' => [503],
             'maxRetries' => 2,
-            'initialDelay' => 500,
+            'backoff' => [1, 2, 3],
         ]);
 
         $result = $this->middleware->handleResponse($response);
@@ -82,14 +83,14 @@ public function testRetriesARetryableResponse(): void
         $retriedRequest = $retriedRequests[0];
         self::assertSame(1, $retriedRequest->getMeta('retry_count'));
         self::assertSame('https://example.com', $retriedRequest->getUri());
-        self::assertSame(500, $retriedRequest->getOptions()['delay']);
+        self::assertSame(1000, $retriedRequest->getOptions()['delay']);
     }
 
     public function testStopsRetryingAfterMaxRetries(): void
     {
         $request = $this->makeRequest()->withMeta('retry_count', 3);
         $response = $this->makeResponse(request: $request, status: 500);
-        $this->middleware->configure(['maxRetries' => 3]);
+        $this->middleware->configure(['maxRetries' => 3, 'backoff' => [1, 2, 3]]);
 
         $result = $this->middleware->handleResponse($response);
 
@@ -98,20 +99,61 @@ public function testStopsRetryingAfterMaxRetries(): void
         self::assertCount(0, $this->scheduler->forceNextRequests(10));
     }
 
-    public function testCalculatesExponentialBackoffCorrectly(): void
+    public function testUsesBackoffArrayForDelay(): void
     {
         $request = $this->makeRequest()->withMeta('retry_count', 2);
         $response = $this->makeResponse(request: $request, status: 500);
-        $this->middleware->configure([
-            'initialDelay' => 1000, // 1s
-            'delayMultiplier' => 2.0,
-        ]);
+        $this->middleware->configure(['backoff' => [1, 5, 10]]);
+
+        $this->middleware->handleResponse($response);
+
+        $retriedRequest = $this->scheduler->forceNextRequests(10)[0];
+        self::assertSame(10000, $retriedRequest->getOptions()['delay']);
+    }
+
+    public function testUsesLastBackoffValueIfRetriesExceedBackoffCount(): void
+    {
+        $request = $this->makeRequest()->withMeta('retry_count', 5);
+        $response = $this->makeResponse(request: $request, status: 500);
+        $this->middleware->configure(['backoff' => [1, 5, 10], 'maxRetries' => 6]);
+
+        $this->middleware->handleResponse($response);
+
+        $retriedRequest = $this->scheduler->forceNextRequests(10)[0];
+        self::assertSame(10000, $retriedRequest->getOptions()['delay']);
+    }
+
+    public function testUsesIntegerBackoffForDelay(): void
+    {
+        $request = $this->makeRequest()->withMeta('retry_count', 2);
+        $response = $this->makeResponse(request: $request, status: 500);
+        $this->middleware->configure(['backoff' => 5]);
 
         $this->middleware->handleResponse($response);
 
-        // initialDelay * (delayMultiplier ^ retry_count)
-        // 1000 * (2.0 ^ 2) = 1000 * 4 = 4000ms
         $retriedRequest = $this->scheduler->forceNextRequests(10)[0];
-        self::assertSame(4000, $retriedRequest->getOptions()['delay']);
+        self::assertSame(5000, $retriedRequest->getOptions()['delay']);
+    }
+
+    public static function invalidBackoffProvider(): array
+    {
+        return [
+            'empty array' => [[], 'backoff array cannot be empty.'],
+            'array with non-int' => [[1, 'a', 3], 'backoff array must contain only integers. Found: string'],
+            'string' => ['not-an-array', 'backoff must be an integer or array, string given.'],
+            'float' => [1.23, 'backoff must be an integer or array, double given.'],
+        ];
+    }
+
+    #[DataProvider('invalidBackoffProvider')]
+    public function testThrowsExceptionOnInvalidBackoff(mixed $backoff, string $expectedMessage): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage($expectedMessage);
+
+        $response = $this->makeResponse(status: 500);
+        $this->middleware->configure(['backoff' => $backoff]);
+
+        $this->middleware->handleResponse($response);
     }
 }