bug #46797 [Messenger] Ceil waiting time when multiplier is a float on retry (WissameMekhilef)

nicolas-grekas · nicolas-grekas · commit 99fa1937f1c6 · 2022-06-29T09:00:30.000+02:00
This PR was submitted for the 6.1 branch but it was squashed and merged into the 4.4 branch instead. Discussion ---------- [Messenger] Ceil waiting time when multiplier is a float on retry | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | #46795 | License | MIT | Doc PR | Not required In the Messenger - MultiplierRetryStrategy the return type for the function `getWaitingTime` is int, however with the computation of that function we were returning a float, this is because float * int returns a float and the attribute $multiplier is a float. With this fix, we are rounding up the delay and casting into an int. Commits ------- 3b62a06 [Messenger] Ceil waiting time when multiplier is a float on retry
diff --git a/src/Symfony/Component/Messenger/Retry/MultiplierRetryStrategy.php b/src/Symfony/Component/Messenger/Retry/MultiplierRetryStrategy.php
@@ -80,6 +80,6 @@ public function getWaitingTime(Envelope $message): int
             return $this->maxDelayMilliseconds;
         }
 
-        return $delay;
+        return (int) ceil($delay);
     }
 }
diff --git a/src/Symfony/Component/Messenger/Tests/Retry/MultiplierRetryStrategyTest.php b/src/Symfony/Component/Messenger/Tests/Retry/MultiplierRetryStrategyTest.php
@@ -52,7 +52,7 @@ public function testIsRetryableWithNoStamp()
     /**
      * @dataProvider getWaitTimeTests
      */
-    public function testGetWaitTime(int $delay, int $multiplier, int $maxDelay, int $previousRetries, int $expectedDelay)
+    public function testGetWaitTime(int $delay, float $multiplier, int $maxDelay, int $previousRetries, int $expectedDelay)
     {
         $strategy = new MultiplierRetryStrategy(10, $delay, $multiplier, $maxDelay);
         $envelope = new Envelope(new \stdClass(), [new RedeliveryStamp($previousRetries)]);
@@ -83,5 +83,10 @@ public function getWaitTimeTests(): iterable
         // never a delay
         yield [0, 2, 10000, 0, 0];
         yield [0, 2, 10000, 1, 0];
+
+        // Float delay
+        yield [1000, 1.5555, 5000, 0, 1000];
+        yield [1000, 1.5555, 5000, 1, 1555];
+        yield [1000, 1.5555, 5000, 2, 2419];
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,6 @@ public function getWaitingTime(Envelope $message): int`
`80`	`80`	`return $this->maxDelayMilliseconds;`
`81`	`81`	`}`
`82`	`82`
`83`		`- return $delay;`
	`83`	`+ return (int) ceil($delay);`
`84`	`84`	`}`
`85`	`85`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public function testIsRetryableWithNoStamp()`
`52`	`52`	`/**`
`53`	`53`	`* @dataProvider getWaitTimeTests`
`54`	`54`	`*/`
`55`		`- public function testGetWaitTime(int $delay, int $multiplier, int $maxDelay, int $previousRetries, int $expectedDelay)`
	`55`	`+ public function testGetWaitTime(int $delay, float $multiplier, int $maxDelay, int $previousRetries, int $expectedDelay)`
`56`	`56`	`{`
`57`	`57`	`$strategy = new MultiplierRetryStrategy(10, $delay, $multiplier, $maxDelay);`
`58`	`58`	`$envelope = new Envelope(new \stdClass(), [new RedeliveryStamp($previousRetries)]);`
`@@ -83,5 +83,10 @@ public function getWaitTimeTests(): iterable`
`83`	`83`	`// never a delay`
`84`	`84`	`yield [0, 2, 10000, 0, 0];`
`85`	`85`	`yield [0, 2, 10000, 1, 0];`
	`86`	`+`
	`87`	`+ // Float delay`
	`88`	`+ yield [1000, 1.5555, 5000, 0, 1000];`
	`89`	`+ yield [1000, 1.5555, 5000, 1, 1555];`
	`90`	`+ yield [1000, 1.5555, 5000, 2, 2419];`
`86`	`91`	`}`
`87`	`92`	`}`