refactor: rename Input to RequestBody, remove validator from UserInpu…

…tResolver to split functionalities
symfony · GaryPEGEOT · Mar 3, 2022 · Mar 3, 2022 · Mar 3, 2022 · Mar 5, 2022
commit 5976a4bf8d2cfe172bec877392ae91a5d677cd2e
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -8,7 +8,6 @@ CHANGELOG
  * Load PHP configuration files by default in the `MicroKernelTrait`
  * Add `cache:pool:invalidate-tags` command
  * Add `xliff` support in addition to `xlf` for `XliffFileDumper`
- * Add an ArgumentResolver to deserialize & validate user input
 
 6.0
 ---

diff --git a/src/Symfony/Component/Serializer/Annotation/Input.php b/src/Symfony/Component/Serializer/Annotation/Input.php
@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Annotation;
+
+/**
+ * Indicates that this argument should be deserialized from request body.
+ *
+ * @author Gary PEGEOT <garypegeot@gmail.com>
+ */
+#[\Attribute(\Attribute::TARGET_PARAMETER)]
+class RequestBody
+{
+    /**
+     * @param string|null $format Will be guessed from request if empty, and default to JSON.
+     * @param array $context      The serialization context (Useful to set groups / ignore fields).
+     */
+    public function __construct(public readonly ?string $format = null, public readonly array $context = [])
+    {
+    }
+}
@@ -14,26 +14,18 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
-use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
-use Symfony\Component\Serializer\Annotation\Input;
-use Symfony\Component\Serializer\Exception\PartialDenormalizationException;
+use Symfony\Component\Serializer\Annotation\RequestBody;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use Symfony\Component\Serializer\SerializerInterface;
-use Symfony\Component\Validator\ConstraintViolation;
-use Symfony\Component\Validator\ConstraintViolationList;
-use Symfony\Component\Validator\Exception\InputValidationFailedException;
-use Symfony\Component\Validator\Validator\ValidatorInterface;
 
 /**
- * Deserialize & validate user input.
- *
- * Works in duo with Symfony\Bundle\FrameworkBundle\EventListener\InputValidationFailedExceptionListener.
+ * Deserialize request body if Symfony\Component\Serializer\Annotation\RequestBody attribute is present on an argument.
  *
  * @author Gary PEGEOT <garypegeot@gmail.com>
  */
 class UserInputResolver implements ArgumentValueResolverInterface
 {
-    public function __construct(private SerializerInterface $serializer, private ?ValidatorInterface $validator = null)
+    public function __construct(private SerializerInterface $serializer)
     {
     }
 
@@ -51,47 +43,16 @@ public function supports(Request $request, ArgumentMetadata $argument): bool
     public function resolve(Request $request, ArgumentMetadata $argument): iterable
     {
         $attribute = $this->getAttribute($argument);
-        $context = array_merge($attribute->serializationContext, [
+        $context = array_merge($attribute->context, [
             DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS => true,
         ]);
         $format = $attribute->format ?? $request->getContentType() ?? 'json';
 
-        try {
-            $input = $this->serializer->deserialize($request->getContent(), $argument->getType(), $format, $context);
-        } catch (PartialDenormalizationException $e) {
-            if (null === $this->validator) {
-                throw new UnprocessableEntityHttpException(message: $e->getMessage(), previous: $e);
-            }
-
-            $errors = new ConstraintViolationList();
-
-            foreach ($e->getErrors() as $exception) {
-                $message = sprintf('The type must be one of "%s" ("%s" given).', implode(', ', $exception->getExpectedTypes()), $exception->getCurrentType());
-                $parameters = [];
-
-                if ($exception->canUseMessageForUser()) {
-                    $parameters['hint'] = $exception->getMessage();
-                }
-
-                $errors->add(new ConstraintViolation($message, '', $parameters, null, $exception->getPath(), null));
-            }
-
-            throw new InputValidationFailedException(null, $errors);
-        }
-
-        if ($this->validator) {
-            $errors = $this->validator->validate(value: $input, groups: $attribute->validationGroups);
-
-            if ($errors->count() > 0) {
-                throw new InputValidationFailedException($input, $errors);
-            }
-        }
-
-        yield $input;
+        yield $this->serializer->deserialize($request->getContent(), $argument->getType(), $format, $context);
     }
 
-    private function getAttribute(ArgumentMetadata $argument): ?Input
+    private function getAttribute(ArgumentMetadata $argument): ?RequestBody
     {
-        return $argument->getAttributes(Input::class, ArgumentMetadata::IS_INSTANCEOF)[0] ?? null;
+        return $argument->getAttributes(RequestBody::class, ArgumentMetadata::IS_INSTANCEOF)[0] ?? null;
     }
 }
@@ -12,6 +12,7 @@ CHANGELOG
  * Deprecate `ContextAwareDecoderInterface`, use `DecoderInterface` instead
  * Deprecate supporting denormalization for `AbstractUid` in `UidNormalizer`, use one of `AbstractUid` child class instead
  * Deprecate denormalizing to an abstract class in `UidNormalizer`
+ * Add an ArgumentResolver to deserialize arguments with `Symfony\Component\Serializer\Annotation\RequestBody` attribute
 
 6.0
 ---

@@ -5,9 +5,10 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
-use Symfony\Component\Serializer\Annotation\Input;
+use Symfony\Component\Serializer\Annotation\RequestBody;
 use Symfony\Component\Serializer\ArgumentResolver\UserInputResolver;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
+use Symfony\Component\Serializer\Exception\PartialDenormalizationException;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 use Symfony\Component\Serializer\Serializer;
 use Symfony\Component\Serializer\Tests\Fixtures\DummyDto;
@@ -22,9 +23,8 @@ protected function setUp(): void
     {
         $encoders = [new JsonEncoder()];
         $normalizers = [new ObjectNormalizer()];
-        $validator = Validation::createValidatorBuilder()->enableAnnotationMapping()->getValidator();
 
-        $this->resolver = new UserInputResolver(serializer: new Serializer($normalizers, $encoders), validator: $validator);
+        $this->resolver = new UserInputResolver(new Serializer($normalizers, $encoders));
     }
 
     public function testSupports()
@@ -46,25 +46,15 @@ public function testResolveWithValidValue()
         $this->assertSame('Lorem ipsum', $resolved[0]->randomText);
     }
 
-    /**
-     * @dataProvider provideInvalidValues
-     */
-    public function testResolveWithInvalidValue(string $content, array $groups = ['Default'])
+    public function testResolveWithInvalidValue()
     {
-        $this->expectException(ValidationFailedException::class);
-        $request = new Request(content: $content);
+        $this->expectException(PartialDenormalizationException::class);
+        $request = new Request(content: '{"randomText": ["Did", "You", "Expect", "That?"]}');
 
-        iterator_to_array($this->resolver->resolve($request, $this->createMetadata([new Input(validationGroups: $groups)])));
+        iterator_to_array($this->resolver->resolve($request, $this->createMetadata()));
     }
 
-    public function provideInvalidValues(): \Generator
-    {
-        yield 'Invalid value' => ['{"itMustBeTrue": false}'];
-        yield 'Invalid value with groups' => ['{"randomText": "Valid"}', ['Default', 'Foo']];
-        yield 'Not normalizable' => ['{"randomText": ["Did", "You", "Expect", "That?"]}'];
-    }
-
-    private function createMetadata(?array $attributes = [new Input()]): ArgumentMetadata
+    private function createMetadata(?array $attributes = [new RequestBody()]): ArgumentMetadata
     {
         $arguments = [
             'name' => 'foo',