minor #43688 [RateLimiter] bug #42194 fix: sliding window policy to use microtime - fix test (jlekowski)

chalasr · chalasr · commit 1c79d8066fa8 · 2021-10-26T12:19:20.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [RateLimiter] bug #42194 fix: sliding window policy to use microtime - fix test | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | Fix #42194  | License | MIT | Doc PR | symfony/symfony-docs#...  As pointed out in the comment #43677 (comment), `RateLimitTest::testWaitUsesMicrotime()` fails intermittently. I have looked at all `PHPUnit` actions since the test was introduced and interestingly, the fails only occurred during `7.2` test, and the time difference was always ~1.3s. Commits ------- e616963 bug #42194 [RateLimiter] fix: sliding window policy to use microtime - fix test
diff --git a/src/Symfony/Component/RateLimiter/Tests/RateLimitTest.php b/src/Symfony/Component/RateLimiter/Tests/RateLimitTest.php
@@ -48,10 +48,10 @@ public function testEnsureAcceptedThrowsRateLimitExceptionIfNotAccepted()
     public function testWaitUsesMicrotime()
     {
         ClockMock::register(RateLimit::class);
-        $rateLimit = new RateLimit(10, new \DateTimeImmutable('+2500 ms'), true, 10);
+        $retryAfter = time() + 2.5; // get timestamp in the middle of a second (xxx.5)
+        $rateLimit = new RateLimit(10, \DateTimeImmutable::createFromFormat('U.u', $retryAfter), true, 10);
 
-        $start = microtime(true);
-        $rateLimit->wait(); // wait 2.5 seconds
-        $this->assertEqualsWithDelta($start + 2.5, microtime(true), 0.1);
+        $rateLimit->wait(); // wait until $retryAfter (~2.5 seconds)
+        $this->assertEqualsWithDelta($retryAfter, microtime(true), 0.49);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -48,10 +48,10 @@ public function testEnsureAcceptedThrowsRateLimitExceptionIfNotAccepted()`
`48`	`48`	`public function testWaitUsesMicrotime()`
`49`	`49`	`{`
`50`	`50`	`ClockMock::register(RateLimit::class);`
`51`		`- $rateLimit = new RateLimit(10, new \DateTimeImmutable('+2500 ms'), true, 10);`
	`51`	`+ $retryAfter = time() + 2.5; // get timestamp in the middle of a second (xxx.5)`
	`52`	`+ $rateLimit = new RateLimit(10, \DateTimeImmutable::createFromFormat('U.u', $retryAfter), true, 10);`
`52`	`53`
`53`		`- $start = microtime(true);`
`54`		`- $rateLimit->wait(); // wait 2.5 seconds`
`55`		`- $this->assertEqualsWithDelta($start + 2.5, microtime(true), 0.1);`
	`54`	`+ $rateLimit->wait(); // wait until $retryAfter (~2.5 seconds)`
	`55`	`+ $this->assertEqualsWithDelta($retryAfter, microtime(true), 0.49);`
`56`	`56`	`}`
`57`	`57`	`}`