use a clock to create datetime instances

xabbuh · xabbuh · commit c1d629783739 · 2024-05-24T21:59:22.000+02:00
diff --git a/src/Symfony/Component/Notifier/Bridge/Bluesky/BlueskyTransport.php b/src/Symfony/Component/Notifier/Bridge/Bluesky/BlueskyTransport.php
@@ -12,6 +12,8 @@
 namespace Symfony\Component\Notifier\Bridge\Bluesky;
 
 use Psr\Log\LoggerInterface;
+use Symfony\Component\Clock\Clock;
+use Symfony\Component\Clock\ClockInterface;
 use Symfony\Component\Mime\Part\File;
 use Symfony\Component\Notifier\Exception\TransportException;
 use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
@@ -32,15 +34,19 @@
 final class BlueskyTransport extends AbstractTransport
 {
     private array $authSession = [];
+    private ClockInterface $clock;
 
     public function __construct(
         #[\SensitiveParameter] private string $user,
         #[\SensitiveParameter] private string $password,
         private LoggerInterface $logger,
         ?HttpClientInterface $client = null,
         ?EventDispatcherInterface $dispatcher = null,
+        ?ClockInterface $clock = null,
     ) {
         parent::__construct($client, $dispatcher);
+
+        $this->clock = $clock ?? Clock::get();
     }
 
     public function __toString(): string
@@ -66,7 +72,7 @@ protected function doSend(MessageInterface $message): SentMessage
         $post = [
             '$type' => 'app.bsky.feed.post',
             'text' => $message->getSubject(),
-            'createdAt' => \DateTimeImmutable::createFromFormat('U', time())->format('Y-m-d\\TH:i:s.u\\Z'),
+            'createdAt' => $this->clock->now()->format('Y-m-d\\TH:i:s.u\\Z'),
         ];
         if ([] !== $facets = $this->parseFacets($post['text'])) {
             $post['facets'] = $facets;
diff --git a/src/Symfony/Component/Notifier/Bridge/Bluesky/Tests/BlueskyTransportTest.php b/src/Symfony/Component/Notifier/Bridge/Bluesky/Tests/BlueskyTransportTest.php
@@ -12,7 +12,7 @@
 namespace Symfony\Component\Notifier\Bridge\Bluesky\Tests;
 
 use Psr\Log\NullLogger;
-use Symfony\Bridge\PhpUnit\ClockMock;
+use Symfony\Component\Clock\MockClock;
 use Symfony\Component\HttpClient\MockHttpClient;
 use Symfony\Component\HttpClient\Response\JsonMockResponse;
 use Symfony\Component\Mime\Part\File;
@@ -28,15 +28,16 @@
 
 final class BlueskyTransportTest extends TransportTestCase
 {
+    private static $clock;
+
     protected function setUp(): void
     {
-        ClockMock::register(self::class);
-        ClockMock::withClockMock(1714293617);
+        self::$clock = new MockClock(new \DateTimeImmutable('@1714293617'));
     }
 
     public static function createTransport(?HttpClientInterface $client = null): BlueskyTransport
     {
-        $blueskyTransport = new BlueskyTransport('username', 'password', new NullLogger(), $client ?? new MockHttpClient());
+        $blueskyTransport = new BlueskyTransport('username', 'password', new NullLogger(), $client ?? new MockHttpClient(), null, self::$clock);
         $blueskyTransport->setHost('bsky.social');
 
         return $blueskyTransport;
diff --git a/src/Symfony/Component/Notifier/Bridge/Bluesky/composer.json b/src/Symfony/Component/Notifier/Bridge/Bluesky/composer.json
@@ -22,6 +22,7 @@
     "require": {
         "php": ">=8.2",
         "psr/log": "^1|^2|^3",
+        "symfony/clock": "^6.4|^7.0",
         "symfony/http-client": "^6.4|^7.0",
         "symfony/notifier": "^7.2",
         "symfony/string": "^6.4|^7.0"
diff --git a/src/Symfony/Component/Notifier/Bridge/Ntfy/NtfyOptions.php b/src/Symfony/Component/Notifier/Bridge/Ntfy/NtfyOptions.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Notifier\Bridge\Ntfy;
 
+use Symfony\Component\Clock\Clock;
+use Symfony\Component\Clock\ClockInterface;
 use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Message\MessageOptionsInterface;
 use Symfony\Component\Notifier\Notification\Notification;
@@ -26,9 +28,13 @@ final class NtfyOptions implements MessageOptionsInterface
     public const PRIORITY_LOW = 2;
     public const PRIORITY_MIN = 1;
 
+    private ClockInterface $clock;
+
     public function __construct(
         private array $options = [],
+        ?ClockInterface $clock = null,
     ) {
+        $this->clock = $clock ?? Clock::get();
     }
 
     public static function fromNotification(Notification $notification): self
@@ -103,7 +109,7 @@ public function setTags(array $tags): self
 
     public function setDelay(\DateTimeInterface $dateTime): self
     {
-        if ($dateTime > (new \DateTime())) {
+        if ($dateTime > $this->clock->now()) {
             $this->options['delay'] = (string) $dateTime->getTimestamp();
         } else {
             throw new LogicException('Delayed date must be defined in the future.');
diff --git a/src/Symfony/Component/Notifier/Bridge/Ntfy/composer.json b/src/Symfony/Component/Notifier/Bridge/Ntfy/composer.json
@@ -17,6 +17,7 @@
     ],
     "require": {
         "php": ">=8.2",
+        "symfony/clock": "^6.4|^7.0",
         "symfony/http-client": "^6.4|^7.0",
         "symfony/notifier": "^6.4|^7.0"
     },
diff --git a/src/Symfony/Component/Notifier/Bridge/PagerDuty/PagerDutyOptions.php b/src/Symfony/Component/Notifier/Bridge/PagerDuty/PagerDutyOptions.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Notifier\Bridge\PagerDuty;
 
+use Symfony\Component\Clock\Clock;
+use Symfony\Component\Clock\ClockInterface;
 use Symfony\Component\Notifier\Exception\InvalidArgumentException;
 use Symfony\Component\Notifier\Message\MessageOptionsInterface;
 
@@ -19,7 +21,9 @@
  */
 final class PagerDutyOptions implements MessageOptionsInterface
 {
-    public function __construct(string $routingKey, string $eventAction, string $severity, private array $options = [])
+    private ClockInterface $clock;
+
+    public function __construct(string $routingKey, string $eventAction, string $severity, private array $options = [], ?ClockInterface $clock)
     {
         if (!\in_array($eventAction, ['trigger', 'acknowledge', 'resolve'], true)) {
             throw new InvalidArgumentException('Invalid "event_action" option given.');
@@ -52,6 +56,8 @@ public function __construct(string $routingKey, string $eventAction, string $sev
         if (null === $dedupKey && \in_array($eventAction, ['acknowledge', 'resolve'], true)) {
             throw new InvalidArgumentException('Option "dedup_key" must be set for event actions: "acknowledge" & "resolve".');
         }
+
+        $this->clock = $clock ?? Clock::get();
     }
 
     public function toArray(): array
diff --git a/src/Symfony/Component/Notifier/Bridge/PagerDuty/composer.json b/src/Symfony/Component/Notifier/Bridge/PagerDuty/composer.json
@@ -17,6 +17,7 @@
     ],
     "require": {
         "php": ">=8.2",
+        "symfony/clock": "^6.4|^7.0",
         "symfony/http-client": "^6.4|^7.0",
         "symfony/notifier": "^6.4|^7.0"
     },
diff --git a/src/Symfony/Component/Notifier/Bridge/Smsbox/SmsboxOptions.php b/src/Symfony/Component/Notifier/Bridge/Smsbox/SmsboxOptions.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Notifier\Bridge\Smsbox;
 
+use Symfony\Component\Clock\Clock;
+use Symfony\Component\Clock\ClockInterface;
 use Symfony\Component\Intl\Countries;
 use Symfony\Component\Notifier\Bridge\Smsbox\Enum\Charset;
 use Symfony\Component\Notifier\Bridge\Smsbox\Enum\Day;
@@ -28,9 +30,13 @@
  */
 final class SmsboxOptions implements MessageOptionsInterface
 {
+    private ClockInterface $clock;
+
     public function __construct(
         private array $options = [],
+        ?ClockInterface $clock = null,
     ) {
+        $this->clock = $clock ?? Clock::get();
     }
 
     public function getRecipientId(): null
@@ -103,7 +109,7 @@ public function dateTime(\DateTimeImmutable $dateTime): static
             throw new InvalidArgumentException(sprintf('Either %1$s::dateTime() or %1$s::date() and %1$s::hour() must be called, but not both.', self::class));
         }
 
-        if ($dateTime < new \DateTimeImmutable('now')) {
+        if ($dateTime < $this->clock->now()) {
             throw new InvalidArgumentException('The given DateTime must be greater to the current date.');
         }
 
diff --git a/src/Symfony/Component/Notifier/Bridge/Smsbox/composer.json b/src/Symfony/Component/Notifier/Bridge/Smsbox/composer.json
@@ -25,6 +25,7 @@
     ],
     "require": {
         "php": ">=8.2",
+        "symfony/clock": "^6.4|^7.0",
         "symfony/http-client": "^6.4|^7.0",
         "symfony/notifier": "^7.1",
         "symfony/polyfill-php83": "^1.28"

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\Notifier\Bridge\Bluesky\Tests;`
`13`	`13`
`14`	`14`	`use Psr\Log\NullLogger;`
`15`		`-use Symfony\Bridge\PhpUnit\ClockMock;`
	`15`	`+use Symfony\Component\Clock\MockClock;`
`16`	`16`	`use Symfony\Component\HttpClient\MockHttpClient;`
`17`	`17`	`use Symfony\Component\HttpClient\Response\JsonMockResponse;`
`18`	`18`	`use Symfony\Component\Mime\Part\File;`
`@@ -28,15 +28,16 @@`
`28`	`28`
`29`	`29`	`final class BlueskyTransportTest extends TransportTestCase`
`30`	`30`	`{`
	`31`	`+ private static $clock;`
	`32`	`+`
`31`	`33`	`protected function setUp(): void`
`32`	`34`	`{`
`33`		`- ClockMock::register(self::class);`
`34`		`- ClockMock::withClockMock(1714293617);`
	`35`	`+ self::$clock = new MockClock(new \DateTimeImmutable('@1714293617'));`
`35`	`36`	`}`
`36`	`37`
`37`	`38`	`public static function createTransport(?HttpClientInterface $client = null): BlueskyTransport`
`38`	`39`	`{`
`39`		`- $blueskyTransport = new BlueskyTransport('username', 'password', new NullLogger(), $client ?? new MockHttpClient());`
	`40`	`+ $blueskyTransport = new BlueskyTransport('username', 'password', new NullLogger(), $client ?? new MockHttpClient(), null, self::$clock);`
`40`	`41`	`$blueskyTransport->setHost('bsky.social');`
`41`	`42`
`42`	`43`	`return $blueskyTransport;`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Notifier\Bridge\PagerDuty;`
`13`	`13`
	`14`	`+use Symfony\Component\Clock\Clock;`
	`15`	`+use Symfony\Component\Clock\ClockInterface;`
`14`	`16`	`use Symfony\Component\Notifier\Exception\InvalidArgumentException;`
`15`	`17`	`use Symfony\Component\Notifier\Message\MessageOptionsInterface;`
`16`	`18`
`@@ -19,7 +21,9 @@`
`19`	`21`	`*/`
`20`	`22`	`final class PagerDutyOptions implements MessageOptionsInterface`
`21`	`23`	`{`
`22`		`- public function __construct(string $routingKey, string $eventAction, string $severity, private array $options = [])`
	`24`	`+ private ClockInterface $clock;`
	`25`	`+`
	`26`	`+ public function __construct(string $routingKey, string $eventAction, string $severity, private array $options = [], ?ClockInterface $clock)`
`23`	`27`	`{`
`24`	`28`	`if (!\in_array($eventAction, ['trigger', 'acknowledge', 'resolve'], true)) {`
`25`	`29`	`throw new InvalidArgumentException('Invalid "event_action" option given.');`
`@@ -52,6 +56,8 @@ public function __construct(string $routingKey, string $eventAction, string $sev`
`52`	`56`	`if (null === $dedupKey && \in_array($eventAction, ['acknowledge', 'resolve'], true)) {`
`53`	`57`	`throw new InvalidArgumentException('Option "dedup_key" must be set for event actions: "acknowledge" & "resolve".');`
`54`	`58`	`}`
	`59`	`+`
	`60`	`+ $this->clock = $clock ?? Clock::get();`
`55`	`61`	`}`
`56`	`62`
`57`	`63`	`public function toArray(): array`