[HttpClient] Force int conversion for floated multiplier for GenericRetryStrategy

francisbesset · francisbesset · commit 962050ae9da6 · 2023-06-18T22:04:30.000+02:00
diff --git a/src/Symfony/Component/HttpClient/Retry/GenericRetryStrategy.php b/src/Symfony/Component/HttpClient/Retry/GenericRetryStrategy.php
@@ -102,7 +102,7 @@ public function getDelay(AsyncContext $context, ?string $responseContent, ?Trans
         $delay = $this->delayMs * $this->multiplier ** $context->getInfo('retry_count');
 
         if ($this->jitter > 0) {
-            $randomness = $delay * $this->jitter;
+            $randomness = (int) ($delay * $this->jitter);
             $delay = $delay + random_int(-$randomness, +$randomness);
         }
 
diff --git a/src/Symfony/Component/HttpClient/Tests/Retry/GenericRetryStrategyTest.php b/src/Symfony/Component/HttpClient/Tests/Retry/GenericRetryStrategyTest.php
@@ -67,7 +67,7 @@ public function testGetDelay(int $delay, int $multiplier, int $maxDelay, int $pr
 
     public static function provideDelay(): iterable
     {
-        // delay, multiplier, maxDelay, retries, expectedDelay
+        // delay, multiplier, maxDelay, previousRetries, expectedDelay
         yield [1000, 1, 5000, 0, 1000];
         yield [1000, 1, 5000, 1, 1000];
         yield [1000, 1, 5000, 2, 1000];
@@ -90,13 +90,16 @@ public static function provideDelay(): iterable
         yield [0, 2, 10000, 1, 0];
     }
 
-    public function testJitter()
+    /**
+     * @dataProvider provideJitter
+     */
+    public function testJitter(float $multiplier, int $previousRetries)
     {
-        $strategy = new GenericRetryStrategy([], 1000, 1, 0, 1);
+        $strategy = new GenericRetryStrategy([], 1000, $multiplier, 0, 1);
         $min = 2000;
         $max = 0;
         for ($i = 0; $i < 50; ++$i) {
-            $delay = $strategy->getDelay($this->getContext(0, 'GET', 'http://example.com/', 200), null, null);
+            $delay = $strategy->getDelay($this->getContext($previousRetries, 'GET', 'http://example.com/', 200), null, null);
             $min = min($min, $delay);
             $max = max($max, $delay);
         }
@@ -105,6 +108,13 @@ public function testJitter()
         $this->assertLessThanOrEqual(1000, $min);
     }
 
+    public static function provideJitter(): iterable
+    {
+        // multiplier, previousRetries
+        yield [1, 0];
+        yield [1.1, 2];
+    }
+
     private function getContext($retryCount, $method, $url, $statusCode): AsyncContext
     {
         $passthru = null;

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ public function getDelay(AsyncContext $context, ?string $responseContent, ?Trans`
`102`	`102`	`$delay = $this->delayMs * $this->multiplier ** $context->getInfo('retry_count');`
`103`	`103`
`104`	`104`	`if ($this->jitter > 0) {`
`105`		`- $randomness = $delay * $this->jitter;`
	`105`	`+ $randomness = (int) ($delay * $this->jitter);`
`106`	`106`	`$delay = $delay + random_int(-$randomness, +$randomness);`
`107`	`107`	`}`
`108`	`108`