feature #51779 [Serializer] Make ProblemNormalizer give details about Messenger’s ValidationFailedException (MatTheCat)

fabpot · fabpot · commit 0a9df0c520fe · 2023-09-30T19:34:41.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Serializer] Make `ProblemNormalizer` give details about Messenger’s `ValidationFailedException` | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #51739 | License | MIT This PR fixes #51739 by handling `Symfony\Component\Messenger\Exception\ValidationFailedException` in the `ProblemNormalizer`. Commits ------- 43240ab [Serializer] Make `ProblemNormalizer` give details about Messenger’s `ValidationFailedException`
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGELOG
  * Deprecate passing an annotation reader to the constructor of `AnnotationLoader`
  * Allow the `Groups` attribute/annotation on classes
  * JsonDecode: Add `json_decode_detailed_errors` option
+ * Make `ProblemNormalizer` give details about Messenger's `ValidationFailedException`
 
 6.3
 ---
diff --git a/src/Symfony/Component/Serializer/Normalizer/ProblemNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ProblemNormalizer.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\ErrorHandler\Exception\FlattenException;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
+use Symfony\Component\Messenger\Exception\ValidationFailedException as MessageValidationFailedException;
 use Symfony\Component\Serializer\Exception\InvalidArgumentException;
 use Symfony\Component\Serializer\Exception\PartialDenormalizationException;
 use Symfony\Component\Serializer\SerializerAwareInterface;
@@ -84,7 +85,7 @@ public function normalize(mixed $object, string $format = null, array $context =
                     ),
                 ];
                 $data['detail'] = implode("\n", array_map(fn ($e) => $e['propertyPath'].': '.$e['title'], $data['violations']));
-            } elseif ($exception instanceof ValidationFailedException
+            } elseif (($exception instanceof ValidationFailedException || $exception instanceof MessageValidationFailedException)
                 && $this->serializer instanceof NormalizerInterface
                 && $this->serializer->supportsNormalization($exception->getViolations(), $format, $context)
             ) {
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/ProblemNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/ProblemNormalizerTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\ErrorHandler\Exception\FlattenException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
+use Symfony\Component\Messenger\Exception\ValidationFailedException as MessageValidationFailedException;
 use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
 use Symfony\Component\Serializer\Exception\PartialDenormalizationException;
 use Symfony\Component\Serializer\Normalizer\ConstraintViolationListNormalizer;
@@ -102,4 +103,28 @@ public function testNormalizeValidationFailedException()
         $exception = new HttpException(422, 'Validation Failed', $exception);
         $this->assertSame($expected, $this->normalizer->normalize(FlattenException::createFromThrowable($exception), null, ['exception' => $exception]));
     }
+
+    public function testNormalizeMessageValidationFailedException()
+    {
+        $this->normalizer->setSerializer(new Serializer([new ConstraintViolationListNormalizer()]));
+
+        $expected = [
+            'type' => 'https://symfony.com/errors/validation',
+            'title' => 'Validation Failed',
+            'status' => 422,
+            'detail' => 'Invalid value',
+            'violations' => [
+                [
+                    'propertyPath' => '',
+                    'title' => 'Invalid value',
+                    'template' => '',
+                    'parameters' => [],
+                ],
+            ],
+        ];
+
+        $exception = new MessageValidationFailedException(new \stdClass(), new ConstraintViolationList([new ConstraintViolation('Invalid value', '', [], '', null, null)]));
+        $exception = new HttpException(422, 'Validation Failed', $exception);
+        $this->assertSame($expected, $this->normalizer->normalize(FlattenException::createFromThrowable($exception), null, ['exception' => $exception]));
+    }
 }
diff --git a/src/Symfony/Component/Serializer/composer.json b/src/Symfony/Component/Serializer/composer.json
@@ -33,6 +33,7 @@
         "symfony/form": "^5.4|^6.0|^7.0",
         "symfony/http-foundation": "^5.4|^6.0|^7.0",
         "symfony/http-kernel": "^5.4|^6.0|^7.0",
+        "symfony/messenger": "^5.4|^6.0|^7.0",
         "symfony/mime": "^5.4|^6.0|^7.0",
         "symfony/property-access": "^5.4|^6.0|^7.0",
         "symfony/property-info": "^5.4.24|^6.2.11|^7.0",
