Resolve DateTime value using the clock

GromNaN · GromNaN · commit de3a0fc71109 · 2022-11-03T13:03:23.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.php
@@ -55,6 +55,9 @@
             ->tag('controller.argument_value_resolver', ['priority' => 100])
 
         ->set('argument_resolver.datetime', DateTimeValueResolver::class)
+            ->args([
+                service('clock')->nullOnInvalid()
+            ])
             ->tag('controller.argument_value_resolver', ['priority' => 100])
 
         ->set('argument_resolver.request_attribute', RequestAttributeValueResolver::class)
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/DateTimeValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/DateTimeValueResolver.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\HttpKernel\Controller\ArgumentResolver;
 
+use Symfony\Component\Clock\ClockInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Attribute\MapDateTime;
 use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
@@ -26,6 +27,11 @@
  */
 final class DateTimeValueResolver implements ArgumentValueResolverInterface, ValueResolverInterface
 {
+    public function __construct(
+        private readonly ?ClockInterface $clock = null,
+    ) {
+    }
+
     /**
      * @deprecated since Symfony 6.2, use resolve() instead
      */
@@ -53,15 +59,20 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
         }
 
         $class = \DateTimeInterface::class === $argument->getType() ? \DateTimeImmutable::class : $argument->getType();
+
+        if ($this->clock && !$value) {
+            $date = $this->clock->now();
+
+            return $date instanceof $class ? [$date] : [$class::createFromInterface($date)];
+        }
+
         $format = null;
 
         if ($attributes = $argument->getAttributes(MapDateTime::class, ArgumentMetadata::IS_INSTANCEOF)) {
             $attribute = $attributes[0];
             $format = $attribute->format;
         }
 
-        $date = false;
-
         if (null !== $format) {
             $date = $class::createFromFormat($format, $value);
 
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/DateTimeValueResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/DateTimeValueResolverTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\HttpKernel\Tests\Controller\ArgumentResolver;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Clock\MockClock;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Attribute\MapDateTime;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DateTimeValueResolver;
@@ -34,9 +35,12 @@ protected function tearDown(): void
 
     public function getTimeZones()
     {
-        yield ['UTC'];
-        yield ['Etc/GMT+9'];
-        yield ['Etc/GMT-14'];
+        yield ['UTC', false];
+        yield ['Etc/GMT+9', false];
+        yield ['Etc/GMT-14', false];
+        yield ['UTC', true];
+        yield ['Etc/GMT+9', true];
+        yield ['Etc/GMT-14', true];
     }
 
     /**
@@ -71,10 +75,10 @@ public function testUnsupportedArgument()
     /**
      * @dataProvider getTimeZones
      */
-    public function testFullDate(string $timezone)
+    public function testFullDate(string $timezone, bool $withClock)
     {
         date_default_timezone_set($timezone);
-        $resolver = new DateTimeValueResolver();
+        $resolver = new DateTimeValueResolver($withClock ? new MockClock() : null);
 
         $argument = new ArgumentMetadata('dummy', \DateTimeImmutable::class, false, false, null);
         $request = self::requestWithAttributes(['dummy' => '2012-07-21 00:00:00']);
@@ -90,10 +94,10 @@ public function testFullDate(string $timezone)
     /**
      * @dataProvider getTimeZones
      */
-    public function testUnixTimestamp(string $timezone)
+    public function testUnixTimestamp(string $timezone, bool $withClock)
     {
         date_default_timezone_set($timezone);
-        $resolver = new DateTimeValueResolver();
+        $resolver = new DateTimeValueResolver($withClock ? new MockClock('now', $timezone) : null);
 
         $argument = new ArgumentMetadata('dummy', \DateTimeImmutable::class, false, false, null);
         $request = self::requestWithAttributes(['dummy' => '989541720']);
@@ -150,10 +154,10 @@ public function testCustomClass()
     /**
      * @dataProvider getTimeZones
      */
-    public function testDateTimeImmutable(string $timezone)
+    public function testDateTimeImmutable(string $timezone, bool $withClock)
     {
         date_default_timezone_set($timezone);
-        $resolver = new DateTimeValueResolver();
+        $resolver = new DateTimeValueResolver($withClock ? new MockClock('now', $timezone) : null);
 
         $argument = new ArgumentMetadata('dummy', \DateTimeImmutable::class, false, false, null);
         $request = self::requestWithAttributes(['dummy' => '2016-09-08 00:00:00 +05:00']);
@@ -169,10 +173,10 @@ public function testDateTimeImmutable(string $timezone)
     /**
      * @dataProvider getTimeZones
      */
-    public function testWithFormat(string $timezone)
+    public function testWithFormat(string $timezone, bool $withClock)
     {
         date_default_timezone_set($timezone);
-        $resolver = new DateTimeValueResolver();
+        $resolver = new DateTimeValueResolver($withClock ? new MockClock('now', $timezone) : null);
 
         $argument = new ArgumentMetadata('dummy', \DateTimeInterface::class, false, false, null, false, [
             MapDateTime::class => new MapDateTime('m-d-y H:i:s'),
@@ -218,6 +222,27 @@ public function test404Exception(ArgumentMetadata $argument, Request $request)
         $resolver->resolve($request, $argument);
     }
 
+    /**
+     * @param class-string<\DateTimeInterface> $class
+     * @testWith ["DateTimeInterface"]
+     *           ["DateTimeImmutable"]
+     *           ["DateTime"]
+     */
+    public function testNowFromClock(string $class)
+    {
+        $clock = new MockClock('2022-02-20 22:20:02');
+        $resolver = new DateTimeValueResolver($clock);
+
+        $argument = new ArgumentMetadata('dummy', $class, false, false, null, false);
+        $request = self::requestWithAttributes(['dummy' => null]);
+
+        $results = $resolver->resolve($request, $argument);
+
+        $this->assertCount(1, $results);
+        $this->assertInstanceOf($class, $results[0]);
+        $this->assertEquals($clock->now(), $results[0]);
+    }
+
     private static function requestWithAttributes(array $attributes): Request
     {
         $request = Request::create('/');
diff --git a/src/Symfony/Component/HttpKernel/composer.json b/src/Symfony/Component/HttpKernel/composer.json
@@ -41,7 +41,8 @@
         "symfony/translation-contracts": "^1.1|^2|^3",
         "symfony/uid": "^5.4|^6.0",
         "psr/cache": "^1.0|^2.0|^3.0",
-        "twig/twig": "^2.13|^3.0.4"
+        "twig/twig": "^2.13|^3.0.4",
+        "symfony/clock": "^6.2"
     },
     "provide": {
         "psr/log-implementation": "1.0|2.0|3.0"
