feat: support collect denormalization errors (#5170)

* feat: support collect dernormalization errors * feat: complete collectDenormalizationErrors implementation Co-authored-by: Alan Poulain <[email protected]>
api-platform · Jan 13, 2023 · 10da65f · 10da65f
1 parent 902b135
commit 10da65f
Show file tree

Hide file tree

Showing 37 changed files with 402 additions and 43 deletions.
diff --git a/features/main/relation.feature b/features/main/relation.feature
@@ -502,7 +502,7 @@ Feature: Relations support
           "pattern": "^An error occurred$"
         },
         "hydra:description": {
-          "pattern": "^Expected IRI or document for resource \"ApiPlatform\\\\Tests\\\\Fixtures\\\\TestBundle\\\\(Document|Entity)\\\\RelatedDummy\", \"integer\" given.$"
+          "pattern": "^The type of the \"ApiPlatform\\\\Tests\\\\Fixtures\\\\TestBundle\\\\(Document|Entity)\\\\RelatedDummy\" resource must be \"array\" \\(nested document\\) or \"string\" \\(IRI\\), \"integer\" given.$"
         }
       },
       "required": [

diff --git a/features/main/validation.feature b/features/main/validation.feature
@@ -72,3 +72,70 @@ Feature: Using validations groups
     }
     """
     And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+
+  @!mongodb
+  @createSchema
+  Scenario: Create a resource with collectDenormalizationErrors
+    When I add "Content-type" header equal to "application/ld+json"
+    And I send a "POST" request to "/dummy_collect_denormalization" with body:
+    """
+      {
+        "foo": 3,
+        "bar": "baz",
+        "qux": true,
+        "uuid": "y",
+        "relatedDummy": 8,
+        "relatedDummies": 76
+      }
+    """
+    Then the response status code should be 422
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be equal to:
+    """
+    {
+      "@context": "/contexts/ConstraintViolationList",
+      "@type": "ConstraintViolationList",
+      "hydra:title": "An error occurred",
+      "hydra:description": "This value should be of type unknown.\nqux: This value should be of type string.\nfoo: This value should be of type bool.\nbar: This value should be of type int.\nuuid: This value should be of type uuid.\nrelatedDummy: This value should be of type array|string.\nrelatedDummies: This value should be of type array.",
+      "violations": [
+        {
+          "propertyPath": "",
+          "message": "This value should be of type unknown.",
+          "code": "0",
+          "hint": "Failed to create object because the class misses the \"baz\" property."
+        },
+        {
+          "propertyPath": "qux",
+          "message": "This value should be of type string.",
+          "code": "0"
+        },
+        {
+          "propertyPath": "foo",
+          "message": "This value should be of type bool.",
+          "code": "0"
+        },
+        {
+          "propertyPath": "bar",
+          "message": "This value should be of type int.",
+          "code": "0"
+        },
+        {
+          "propertyPath": "uuid",
+          "message": "This value should be of type uuid.",
+          "code": "0",
+          "hint": "Invalid UUID string: y"
+        },
+        {
+          "propertyPath": "relatedDummy",
+          "message": "This value should be of type array|string.",
+          "code": "0"
+        },
+        {
+          "propertyPath": "relatedDummies",
+          "message": "This value should be of type array.",
+          "code": "0"
+        }
+      ]
+    }
+    """
diff --git a/features/serializer/vo_relations.feature b/features/serializer/vo_relations.feature
@@ -158,7 +158,7 @@ Feature: Value object as ApiResource
           "pattern": "^An error occurred$"
         },
         "hydra:description": {
-          "pattern": "^Cannot create an instance of ApiPlatform\\\\Tests\\\\Fixtures\\\\TestBundle\\\\(Document|Entity)\\\\VoDummyCar from serialized data because its constructor requires parameter \"drivers\" to be present.$"
+          "pattern": "^Cannot create an instance of \"ApiPlatform\\\\Tests\\\\Fixtures\\\\TestBundle\\\\(Document|Entity)\\\\VoDummyCar\" from serialized data because its constructor requires parameter \"drivers\" to be present.$"
         }
       },
       "required": [

diff --git a/src/JsonApi/Serializer/ItemNormalizer.php b/src/JsonApi/Serializer/ItemNormalizer.php
@@ -192,12 +192,12 @@ protected function setAttributeValue(object $object, string $attribute, mixed $v
      * @see http://jsonapi.org/format/#document-resource-object-linkage
      *
      * @throws RuntimeException
-     * @throws NotNormalizableValueException
+     * @throws UnexpectedValueException
      */
     protected function denormalizeRelation(string $attributeName, ApiProperty $propertyMetadata, string $className, mixed $value, ?string $format, array $context): object
     {
         if (!\is_array($value) || !isset($value['id'], $value['type'])) {
-            throw new NotNormalizableValueException('Only resource linkage supported currently, see: http://jsonapi.org/format/#document-resource-object-linkage.');
+            throw new UnexpectedValueException('Only resource linkage supported currently, see: http://jsonapi.org/format/#document-resource-object-linkage.');
         }
 
         try {

diff --git a/src/Metadata/ApiResource.php b/src/Metadata/ApiResource.php
@@ -112,6 +112,7 @@ public function __construct(
         protected ?array $cacheHeaders = null,
         protected ?array $normalizationContext = null,
         protected ?array $denormalizationContext = null,
+        protected ?bool $collectDenormalizationErrors = null,
         protected ?array $hydraContext = null,
         protected ?array $openapiContext = null, // TODO Remove in 4.0
         protected bool|OpenApiOperation|null $openapi = null,
@@ -537,6 +538,19 @@ public function withDenormalizationContext(array $denormalizationContext): self
         return $self;
     }
 
+    public function getCollectDenormalizationErrors(): ?bool
+    {
+        return $this->collectDenormalizationErrors;
+    }
+
+    public function withCollectDenormalizationErrors(bool $collectDenormalizationErrors = null): self
+    {
+        $self = clone $this;
+        $self->collectDenormalizationErrors = $collectDenormalizationErrors;
+
+        return $self;
+    }
+
     /**
      * @return string[]|null
      */

diff --git a/src/Metadata/Delete.php b/src/Metadata/Delete.php
@@ -68,6 +68,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,

diff --git a/src/Metadata/Extractor/XmlResourceExtractor.php b/src/Metadata/Extractor/XmlResourceExtractor.php
@@ -135,6 +135,7 @@ private function buildBase(\SimpleXMLElement $resource): array
             'securityPostValidationMessage' => $this->phpize($resource, 'securityPostValidationMessage', 'string'),
             'normalizationContext' => isset($resource->normalizationContext->values) ? $this->buildValues($resource->normalizationContext->values) : null,
             'denormalizationContext' => isset($resource->denormalizationContext->values) ? $this->buildValues($resource->denormalizationContext->values) : null,
+            'collectDenormalizationErrors' => $this->phpize($resource, 'collectDenormalizationErrors', 'bool'),
             'validationContext' => isset($resource->validationContext->values) ? $this->buildValues($resource->validationContext->values) : null,
             'filters' => $this->buildArrayValue($resource, 'filter'),
             'order' => isset($resource->order->values) ? $this->buildValues($resource->order->values) : null,

diff --git a/src/Metadata/Extractor/YamlResourceExtractor.php b/src/Metadata/Extractor/YamlResourceExtractor.php
@@ -159,6 +159,7 @@ private function buildBase(array $resource): array
             'output' => $this->phpize($resource, 'output', 'bool|string'),
             'normalizationContext' => $this->buildArrayValue($resource, 'normalizationContext'),
             'denormalizationContext' => $this->buildArrayValue($resource, 'denormalizationContext'),
+            'collectDenormalizationErrors' => $this->phpize($resource, 'collectDenormalizationErrors', 'bool'),
             'validationContext' => $this->buildArrayValue($resource, 'validationContext'),
             'filters' => $this->buildArrayValue($resource, 'filters'),
             'order' => $this->buildArrayValue($resource, 'order'),

diff --git a/src/Metadata/Extractor/schema/resources.xsd b/src/Metadata/Extractor/schema/resources.xsd
@@ -459,6 +459,7 @@
         <xsd:attribute type="xsd:string" name="securityPostDenormalizeMessage"/>
         <xsd:attribute type="xsd:string" name="securityPostValidation"/>
         <xsd:attribute type="xsd:string" name="securityPostValidationMessage"/>
+        <xsd:attribute type="xsd:boolean" name="collectDenormalizationErrors"/>
     </xsd:attributeGroup>
 
     <xsd:attributeGroup name="extendedBase">

diff --git a/src/Metadata/Get.php b/src/Metadata/Get.php
@@ -68,6 +68,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,

diff --git a/src/Metadata/GetCollection.php b/src/Metadata/GetCollection.php
@@ -70,6 +70,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,
@@ -100,7 +101,7 @@ public function __construct(
         ?OptionsInterface $stateOptions = null,
         array $extraProperties = [],
     ) {
-        parent::__construct(self::METHOD_GET, $uriTemplate, $types, $formats, $inputFormats, $outputFormats, $uriVariables, $routePrefix, $routeName, $defaults, $requirements, $options, $stateless, $sunset, $acceptPatch, $status, $host, $schemes, $condition, $controller, $cacheHeaders, $hydraContext, $openapiContext, $openapi, $exceptionToStatus, $queryParameterValidationEnabled, $shortName, $class, $paginationEnabled, $paginationType, $paginationItemsPerPage, $paginationMaximumItemsPerPage, $paginationPartial, $paginationClientEnabled, $paginationClientItemsPerPage, $paginationClientPartial, $paginationFetchJoinCollection, $paginationUseOutputWalkers, $paginationViaCursor, $order, $description, $normalizationContext, $denormalizationContext, $security, $securityMessage, $securityPostDenormalize, $securityPostDenormalizeMessage, $securityPostValidation, $securityPostValidationMessage, $deprecationReason, $filters, $validationContext, $input, $output, $mercure, $messenger, $elasticsearch, $urlGenerationStrategy, $read, $deserialize, $validate, $write, $serialize, $fetchPartial, $forceEager, $priority, $name, $provider, $processor, $stateOptions, $extraProperties);
+        parent::__construct(self::METHOD_GET, $uriTemplate, $types, $formats, $inputFormats, $outputFormats, $uriVariables, $routePrefix, $routeName, $defaults, $requirements, $options, $stateless, $sunset, $acceptPatch, $status, $host, $schemes, $condition, $controller, $cacheHeaders, $hydraContext, $openapiContext, $openapi, $exceptionToStatus, $queryParameterValidationEnabled, $shortName, $class, $paginationEnabled, $paginationType, $paginationItemsPerPage, $paginationMaximumItemsPerPage, $paginationPartial, $paginationClientEnabled, $paginationClientItemsPerPage, $paginationClientPartial, $paginationFetchJoinCollection, $paginationUseOutputWalkers, $paginationViaCursor, $order, $description, $normalizationContext, $denormalizationContext, $collectDenormalizationErrors, $security, $securityMessage, $securityPostDenormalize, $securityPostDenormalizeMessage, $securityPostValidation, $securityPostValidationMessage, $deprecationReason, $filters, $validationContext, $input, $output, $mercure, $messenger, $elasticsearch, $urlGenerationStrategy, $read, $deserialize, $validate, $write, $serialize, $fetchPartial, $forceEager, $priority, $name, $provider, $processor, $stateOptions, $extraProperties);
         $this->itemUriTemplate = $itemUriTemplate;
     }
 

diff --git a/src/Metadata/GraphQl/DeleteMutation.php b/src/Metadata/GraphQl/DeleteMutation.php
@@ -45,6 +45,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,

diff --git a/src/Metadata/GraphQl/Operation.php b/src/Metadata/GraphQl/Operation.php
@@ -49,6 +49,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,
@@ -75,7 +76,7 @@ public function __construct(
         ?string $name = null,
         ?string $provider = null,
         ?string $processor = null,
-        protected ?OptionsInterface $stateOptions = null,
+        ?OptionsInterface $stateOptions = null,
         array $extraProperties = [],
     ) {
         // Abstract operation properties
@@ -96,6 +97,7 @@ public function __construct(
         $this->description = $description;
         $this->normalizationContext = $normalizationContext;
         $this->denormalizationContext = $denormalizationContext;
+        $this->collectDenormalizationErrors = $collectDenormalizationErrors;
         $this->security = $security;
         $this->securityMessage = $securityMessage;
         $this->securityPostDenormalize = $securityPostDenormalize;
@@ -122,6 +124,7 @@ public function __construct(
         $this->name = $name;
         $this->provider = $provider;
         $this->processor = $processor;
+        $this->stateOptions = $stateOptions;
         $this->extraProperties = $extraProperties;
     }
 

diff --git a/src/Metadata/GraphQl/Query.php b/src/Metadata/GraphQl/Query.php
@@ -44,6 +44,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,

diff --git a/src/Metadata/GraphQl/QueryCollection.php b/src/Metadata/GraphQl/QueryCollection.php
@@ -45,6 +45,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,

diff --git a/src/Metadata/GraphQl/Subscription.php b/src/Metadata/GraphQl/Subscription.php
@@ -44,6 +44,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,

diff --git a/src/Metadata/HttpOperation.php b/src/Metadata/HttpOperation.php
@@ -121,6 +121,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,
@@ -157,6 +158,7 @@ public function __construct(
         $this->deprecationReason = $deprecationReason;
         $this->normalizationContext = $normalizationContext;
         $this->denormalizationContext = $denormalizationContext;
+        $this->collectDenormalizationErrors = $collectDenormalizationErrors;
         $this->validationContext = $validationContext;
         $this->filters = $filters;
         $this->elasticsearch = $elasticsearch;

diff --git a/src/Metadata/NotExposed.php b/src/Metadata/NotExposed.php
@@ -76,6 +76,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,

diff --git a/src/Metadata/Operation.php b/src/Metadata/Operation.php
@@ -60,6 +60,7 @@ public function __construct(
         protected ?string $description = null,
         protected ?array $normalizationContext = null,
         protected ?array $denormalizationContext = null,
+        protected ?bool $collectDenormalizationErrors = null,
         protected ?string $security = null,
         protected ?string $securityMessage = null,
         protected ?string $securityPostDenormalize = null,
@@ -327,6 +328,19 @@ public function withDenormalizationContext(array $denormalizationContext = []):
         return $self;
     }
 
+    public function getCollectDenormalizationErrors(): ?bool
+    {
+        return $this->collectDenormalizationErrors;
+    }
+
+    public function withCollectDenormalizationErrors(bool $collectDenormalizationErrors = null): self
+    {
+        $self = clone $this;
+        $self->collectDenormalizationErrors = $collectDenormalizationErrors;
+
+        return $self;
+    }
+
     public function getSecurity(): ?string
     {
         return $this->security;

diff --git a/src/Metadata/Patch.php b/src/Metadata/Patch.php
@@ -69,6 +69,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,

diff --git a/src/Metadata/Post.php b/src/Metadata/Post.php
@@ -71,6 +71,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,

diff --git a/src/Metadata/Put.php b/src/Metadata/Put.php
@@ -69,6 +69,7 @@ public function __construct(
         ?string $description = null,
         ?array $normalizationContext = null,
         ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
         ?string $security = null,
         ?string $securityMessage = null,
         ?string $securityPostDenormalize = null,

diff --git a/src/RamseyUuid/Serializer/UuidDenormalizer.php b/src/RamseyUuid/Serializer/UuidDenormalizer.php
@@ -29,7 +29,7 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
         try {
             return Uuid::fromString($data);
         } catch (InvalidUuidStringException $e) {
-            throw new NotNormalizableValueException($e->getMessage(), $e->getCode(), $e);
+            throw NotNormalizableValueException::createForUnexpectedDataType($e->getMessage(), $data, ['uuid'], $context['deserialization_path'] ?? null, true, $e->getCode(), $e);
         }
     }
 

diff --git a/src/Serializer/AbstractConstraintViolationListNormalizer.php b/src/Serializer/AbstractConstraintViolationListNormalizer.php
@@ -62,6 +62,10 @@ protected function getMessagesAndViolations(ConstraintViolationListInterface $co
                 'code' => $violation->getCode(),
             ];
 
+            if ($hint = $violation->getParameters()['hint'] ?? false) {
+                $violationData['hint'] = $hint;
+            }
+
             $constraint = $violation instanceof ConstraintViolation ? $violation->getConstraint() : null;
             if (
                 [] !== $this->serializePayloadFields &&