bug #47615 [Clock] Fix sleep() in MockClock (upyx)

nicolas-grekas · nicolas-grekas · commit a0b82ee0a7c9 · 2022-10-17T18:20:46.000+02:00
This PR was merged into the 6.2 branch. Discussion ---------- [Clock] Fix `sleep()` in `MockClock` | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | none | License | MIT | Doc PR | none It fixes losing precision in `$us = $seconds - $s` that occurs because the `$seconds` is float. Anyway, why so many calculation? Double precision is enough to represent any valid date and time: ```php public function sleep(float|int $seconds): void { $datetime = '@'. ((float)$this->now->format('U.u') + $seconds); $timezone = $this->now->getTimezone(); $this->now = (new \DateTimeImmutable($datetime))->setTimezone($timezone); } ``` Why is cloning needed for immutable? The beauty of immutables is that they don't need to be copied. ```php public function now(): \DateTimeImmutable { return clone $this->now; } ``` Commits ------- 066ed61 Fix `sleep()` in `MockClock`
diff --git a/src/Symfony/Component/Clock/MockClock.php b/src/Symfony/Component/Clock/MockClock.php
@@ -40,21 +40,11 @@ public function now(): \DateTimeImmutable
 
     public function sleep(float|int $seconds): void
     {
-        $now = explode('.', $this->now->format('U.u'));
-
-        if (0 < $s = (int) $seconds) {
-            $now[0] += $s;
-        }
-
-        if (0 < ($us = $seconds - $s) && 1E6 <= $now[1] += $us * 1E6) {
-            ++$now[0];
-            $now[1] -= 1E6;
-        }
-
-        $datetime = '@'.$now[0].'.'.str_pad($now[1], 6, '0', \STR_PAD_LEFT);
+        $now = (float) $this->now->format('Uu') + $seconds * 1e6;
+        $now = substr_replace(sprintf('@%07.0F', $now), '.', -6, 0);
         $timezone = $this->now->getTimezone();
 
-        $this->now = (new \DateTimeImmutable($datetime, $timezone))->setTimezone($timezone);
+        $this->now = (new \DateTimeImmutable($now, $timezone))->setTimezone($timezone);
     }
 
     public function withTimeZone(\DateTimeZone|string $timezone): static
diff --git a/src/Symfony/Component/Clock/Tests/MockClockTest.php b/src/Symfony/Component/Clock/Tests/MockClockTest.php
@@ -55,11 +55,11 @@ public function testNow()
 
     public function testSleep()
     {
-        $clock = new MockClock((new \DateTimeImmutable('@123.456'))->setTimezone(new \DateTimeZone('UTC')));
+        $clock = new MockClock((new \DateTimeImmutable('2112-09-17 23:53:00.999Z'))->setTimezone(new \DateTimeZone('UTC')));
         $tz = $clock->now()->getTimezone()->getName();
 
-        $clock->sleep(4.999);
-        $this->assertSame('128.455000', $clock->now()->format('U.u'));
+        $clock->sleep(2.002001);
+        $this->assertSame('2112-09-17 23:53:03.001001', $clock->now()->format('Y-m-d H:i:s.u'));
         $this->assertSame($tz, $clock->now()->getTimezone()->getName());
     }
 

Original file line number	Diff line number	Diff line change
`@@ -55,11 +55,11 @@ public function testNow()`
`55`	`55`
`56`	`56`	`public function testSleep()`
`57`	`57`	`{`
`58`		`- $clock = new MockClock((new \DateTimeImmutable('@123.456'))->setTimezone(new \DateTimeZone('UTC')));`
	`58`	`+ $clock = new MockClock((new \DateTimeImmutable('2112-09-17 23:53:00.999Z'))->setTimezone(new \DateTimeZone('UTC')));`
`59`	`59`	`$tz = $clock->now()->getTimezone()->getName();`
`60`	`60`
`61`		`- $clock->sleep(4.999);`
`62`		`- $this->assertSame('128.455000', $clock->now()->format('U.u'));`
	`61`	`+ $clock->sleep(2.002001);`
	`62`	`+ $this->assertSame('2112-09-17 23:53:03.001001', $clock->now()->format('Y-m-d H:i:s.u'));`
`63`	`63`	`$this->assertSame($tz, $clock->now()->getTimezone()->getName());`
`64`	`64`	`}`
`65`	`65`