[Serializer] Fix and improve constraintViolationListNormalizer's RFC7807 compliance

dunglas · fabpot · commit 3c789c610aa0 · 2018-05-21T17:32:31.000+02:00
diff --git a/src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ConstraintViolationListNormalizer.php
@@ -32,21 +32,37 @@ public function normalize($object, $format = null, array $context = array())
         $violations = array();
         $messages = array();
         foreach ($object as $violation) {
-            $violations[] = array(
-                'propertyPath' => $violation->getPropertyPath(),
-                'message' => $violation->getMessage(),
-                'code' => $violation->getCode(),
-            );
             $propertyPath = $violation->getPropertyPath();
+
+            $violationEntry = array(
+                'propertyPath' => $propertyPath,
+                'title' => $violation->getMessage(),
+            );
+            if (null !== $code = $violation->getCode()) {
+                $violationEntry['type'] = sprintf('urn:uuid:%s', $code);
+            }
+
+            $violations[] = $violationEntry;
+
             $prefix = $propertyPath ? sprintf('%s: ', $propertyPath) : '';
             $messages[] = $prefix.$violation->getMessage();
         }
 
-        return array(
-            'title' => isset($context['title']) ? $context['title'] : 'An error occurred',
-            'detail' => $messages ? implode("\n", $messages) : '',
-            'violations' => $violations,
+        $result = array(
+            'type' => $context['type'] ?? 'https://symfony.com/errors/validation',
+            'title' => $context['title'] ?? 'Validation Failed',
         );
+        if (isset($context['status'])) {
+            $result['status'] = $context['status'];
+        }
+        if ($messages) {
+            $result['detail'] = implode("\n", $messages);
+        }
+        if (isset($context['instance'])) {
+            $result['instance'] = $context['instance'];
+        }
+
+        return $result + array('violations' => $violations);
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/ConstraintViolationListNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/ConstraintViolationListNormalizerTest.php
@@ -43,19 +43,20 @@ public function testNormalize()
         ));
 
         $expected = array(
-            'title' => 'An error occurred',
+            'type' => 'https://symfony.com/errors/validation',
+            'title' => 'Validation Failed',
             'detail' => 'd: a
 4: 1',
             'violations' => array(
                     array(
                         'propertyPath' => 'd',
-                        'message' => 'a',
-                        'code' => 'f',
+                        'title' => 'a',
+                        'type' => 'urn:uuid:f',
                     ),
                     array(
                         'propertyPath' => '4',
-                        'message' => '1',
-                        'code' => '6',
+                        'title' => '1',
+                        'type' => 'urn:uuid:6',
                     ),
                 ),
         );
