[HttpKernel] Support variadic with #[MapRequestPayload]

DjordyKoert · DjordyKoert · commit fc7b7c86f3e4 · 2024-05-02T14:38:16.000+02:00
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -11,6 +11,7 @@ CHANGELOG
  * Add `$type` argument to `#[MapRequestPayload]` that allows mapping a list of items
  * Deprecate `Extension::addAnnotatedClassesToCompile()` and related code infrastructure
  * Add `#[MapUploadedFile]` attribute to fetch, validate, and inject uploaded files into controller arguments
+ * Support variadic argument with `#[MapRequestPayload]`
 
 7.0
 ---
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestPayloadValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestPayloadValueResolver.php
@@ -79,7 +79,7 @@ public function resolve(Request $request, ArgumentMetadata $argument): iterable
             return [];
         }
 
-        if (!$attribute instanceof MapUploadedFile && $argument->isVariadic()) {
+        if ($attribute instanceof MapQueryString && $argument->isVariadic()) {
             throw new \LogicException(sprintf('Mapping variadic argument "$%s" is not supported.', $argument->getName()));
         }
 
@@ -170,7 +170,11 @@ public function onKernelControllerArguments(ControllerArgumentsEvent $event): vo
                 };
             }
 
-            $arguments[$i] = $payload;
+            if ($argument->metadata->isVariadic() && \is_array($payload)) {
+                array_splice($arguments, $i, 1, $payload);
+            } else {
+                $arguments[$i] = $payload;
+            }
         }
 
         $event->setArguments($arguments);
@@ -204,6 +208,8 @@ private function mapRequestPayload(Request $request, ArgumentMetadata $argument,
 
         if ('array' === $argument->getType() && null !== $attribute->type) {
             $type = $attribute->type.'[]';
+        } elseif ($argument->isVariadic()) {
+            $type = $argument->getType().'[]';
         } else {
             $type = $argument->getType();
         }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/RequestPayloadValueResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/RequestPayloadValueResolverTest.php
@@ -498,7 +498,7 @@ public function testItThrowsOnVariadicArgument()
         $resolver = new RequestPayloadValueResolver($serializer, $validator);
 
         $argument = new ArgumentMetadata('variadic', RequestPayload::class, true, false, null, false, [
-            MapRequestPayload::class => new MapRequestPayload(),
+            MapQueryString::class => new MapQueryString(),
         ]);
         $request = Request::create('/', 'POST');
 
@@ -874,6 +874,40 @@ public function testBoolArgumentInJsonBody()
 
         $this->assertTrue($event->getArguments()[0]->value);
     }
+
+    public function testMapRequestPayloadVariadic()
+    {
+        $input = [
+            ['price' => '50'],
+            ['price' => '23'],
+        ];
+        $payload = [
+            new RequestPayload(50),
+            new RequestPayload(23),
+        ];
+
+        $serializer = new Serializer([new ArrayDenormalizer(), new ObjectNormalizer()], ['json' => new JsonEncoder()]);
+
+        $validator = $this->createMock(ValidatorInterface::class);
+        $validator->expects($this->once())
+            ->method('validate')
+            ->willReturn(new ConstraintViolationList());
+
+        $resolver = new RequestPayloadValueResolver($serializer, $validator);
+
+        $argument = new ArgumentMetadata('prices', RequestPayload::class, true, false, null, false, [
+            MapRequestPayload::class => new MapRequestPayload(),
+        ]);
+        $request = Request::create('/', 'POST', $input);
+
+        $kernel = $this->createMock(HttpKernelInterface::class);
+        $arguments = $resolver->resolve($request, $argument);
+        $event = new ControllerArgumentsEvent($kernel, function () {}, $arguments, $request, HttpKernelInterface::MAIN_REQUEST);
+
+        $resolver->onKernelControllerArguments($event);
+
+        $this->assertEquals($payload, $event->getArguments());
+    }
 }
 
 class RequestPayload
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/UploadedFileValueResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/UploadedFileValueResolverTest.php
@@ -269,7 +269,7 @@ static function () {},
         $resolver->onKernelControllerArguments($event);
 
         /** @var UploadedFile[] $data */
-        $data = $event->getArguments()[0];
+        $data = $event->getArguments();
 
         $this->assertCount(2, $data);
         $this->assertSame('file-small.txt', $data[0]->getFilename());

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public function resolve(Request $request, ArgumentMetadata $argument): iterable`
`79`	`79`	`return [];`
`80`	`80`	`}`
`81`	`81`
`82`		`- if (!$attribute instanceof MapUploadedFile && $argument->isVariadic()) {`
	`82`	`+ if ($attribute instanceof MapQueryString && $argument->isVariadic()) {`
`83`	`83`	`throw new \LogicException(sprintf('Mapping variadic argument "$%s" is not supported.', $argument->getName()));`
`84`	`84`	`}`
`85`	`85`
`@@ -170,7 +170,11 @@ public function onKernelControllerArguments(ControllerArgumentsEvent $event): vo`
`170`	`170`	`};`
`171`	`171`	`}`
`172`	`172`
`173`		`- $arguments[$i] = $payload;`
	`173`	`+ if ($argument->metadata->isVariadic() && \is_array($payload)) {`
	`174`	`+ array_splice($arguments, $i, 1, $payload);`
	`175`	`+ } else {`
	`176`	`+ $arguments[$i] = $payload;`
	`177`	`+ }`
`174`	`178`	`}`
`175`	`179`
`176`	`180`	`$event->setArguments($arguments);`
`@@ -204,6 +208,8 @@ private function mapRequestPayload(Request $request, ArgumentMetadata $argument,`
`204`	`208`
`205`	`209`	`if ('array' === $argument->getType() && null !== $attribute->type) {`
`206`	`210`	`$type = $attribute->type.'[]';`
	`211`	`+ } elseif ($argument->isVariadic()) {`
	`212`	`+ $type = $argument->getType().'[]';`
`207`	`213`	`} else {`
`208`	`214`	`$type = $argument->getType();`
`209`	`215`	`}`