send RFC 7807 compatible content type header

Author: xabbuh

Serializer/Normalizer/FlattenExceptionHandler.php

@@ -49,11 +49,19 @@ public static function getSubscribingMethods(): array
 
     public function serializeToJson(JsonSerializationVisitor $visitor, FlattenException $exception, array $type, Context $context)
     {
+        if ($this->rfc7807) {
+            $exception->setHeaders($exception->getHeaders() + ['Content-Type' => 'application/problem+json']);
+        }
+
         return $visitor->visitArray($this->convertToArray($exception, $context), $type, $context);
     }
 
     public function serializeToXml(XmlSerializationVisitor $visitor, FlattenException $exception, array $type, Context $context)
     {
+        if ($this->rfc7807) {
+            $exception->setHeaders($exception->getHeaders() + ['Content-Type' => 'application/problem+xml']);
+        }
+
         $rootName = $this->rfc7807 ? 'response' : 'result';
 
         $data = $this->convertToArray($exception, $context);

Serializer/Normalizer/FlattenExceptionNormalizer.php

@@ -52,6 +52,12 @@ public function normalize($exception, $format = null, array $context = [])
         }
 
         if ($this->rfc7807) {
+            if ('json' === $format) {
+                $exception->setHeaders($exception->getHeaders() + ['Content-Type' => 'application/problem+json']);
+            } elseif ('xml' === $format) {
+                $exception->setHeaders($exception->getHeaders() + ['Content-Type' => 'application/problem+xml']);
+            }
+
             return [
                 'type' => $context['type'] ?? 'https://tools.ietf.org/html/rfc2616#section-10',
                 'title' => $context['title'] ?? 'An error occurred',

Tests/Functional/SerializerErrorTest.php

@@ -60,7 +60,7 @@ public function serializeExceptionJsonProvider()
     /**
      * @dataProvider serializeExceptionJsonUsingErrorRendererProvider
      */
-    public function testSerializeExceptionJsonUsingErrorRenderer(string $testCase, array $expectedJson)
+    public function testSerializeExceptionJsonUsingErrorRenderer(string $testCase, array $expectedJson, string $expectedContentType)
     {
         if (!class_exists(SerializerErrorRenderer::class)) {
             $this->markTestSkipped();
@@ -71,6 +71,7 @@ public function testSerializeExceptionJsonUsingErrorRenderer(string $testCase, a
         $client = $this->createClient(['test_case' => $testCase, 'debug' => false]);
         $client->request('GET', '/serializer-error/exception.json');
 
+        $this->assertStringStartsWith($expectedContentType, $client->getResponse()->headers->get('Content-Type'));
         $this->assertEquals(json_encode($expectedJson), $client->getResponse()->getContent());
     }
 
@@ -80,23 +81,23 @@ public function serializeExceptionJsonUsingErrorRendererProvider(): array
             ['FlattenExceptionNormalizerLegacyFormat', [
                 'code' => 500,
                 'message' => 'Something bad happened.',
-            ]],
+            ], 'application/json'],
             ['FlattenExceptionNormalizerRfc7807Format', [
                 'type' => 'https://tools.ietf.org/html/rfc2616#section-10',
                 'title' => 'An error occurred',
                 'status' => 500,
                 'detail' => 'Something bad happened.',
-            ]],
+            ], 'application/problem+json'],
             ['FlattenExceptionHandlerLegacyFormat', [
                 'code' => 500,
                 'message' => 'Something bad happened.',
-            ]],
+            ], 'application/json'],
             ['FlattenExceptionHandlerRfc7807Format', [
                 'type' => 'https://tools.ietf.org/html/rfc2616#section-10',
                 'title' => 'An error occurred',
                 'status' => 500,
                 'detail' => 'Something bad happened.',
-            ]],
+            ], 'application/problem+json'],
         ];
     }
 
@@ -195,7 +196,7 @@ public function serializeExceptionXmlProvider()
     /**
      * @dataProvider serializeExceptionXmlUsingErrorRendererProvider
      */
-    public function testSerializeExceptionXmlUsingErrorRenderer(string $testCase, string $expectedContent)
+    public function testSerializeExceptionXmlUsingErrorRenderer(string $testCase, string $expectedContent, string $expectedContentType)
     {
         if (!class_exists(SerializerErrorRenderer::class)) {
             $this->markTestSkipped();
@@ -206,6 +207,7 @@ public function testSerializeExceptionXmlUsingErrorRenderer(string $testCase, st
         $client = $this->createClient(['test_case' => $testCase, 'debug' => false]);
         $client->request('GET', '/serializer-error/exception.xml');
 
+        $this->assertStringStartsWith($expectedContentType, $client->getResponse()->headers->get('Content-Type'));
         $this->assertXmlStringEqualsXmlString($expectedContent, $client->getResponse()->getContent());
     }
 
@@ -236,10 +238,10 @@ public function serializeExceptionXmlUsingErrorRendererProvider(): array
 XML;
 
         return [
-            ['FlattenExceptionNormalizerLegacyFormat', $expectedLegacyContent],
-            ['FlattenExceptionNormalizerRfc7807Format', $expectedRfc7807Content],
-            ['FlattenExceptionHandlerLegacyFormat', $expectedLegacyJmsContent],
-            ['FlattenExceptionHandlerRfc7807Format', $expectedRfc7807Content],
+            ['FlattenExceptionNormalizerLegacyFormat', $expectedLegacyContent, 'text/xml'],
+            ['FlattenExceptionNormalizerRfc7807Format', $expectedRfc7807Content, 'application/problem+xml'],
+            ['FlattenExceptionHandlerLegacyFormat', $expectedLegacyJmsContent, 'text/xml'],
+            ['FlattenExceptionHandlerRfc7807Format', $expectedRfc7807Content, 'application/problem+xml'],
         ];
     }