fix mapping exception classes to response status codes

Author: xabbuh

CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+2.8.2
+-----
+
+* fixed embedding status codes in the response body when a mapping of exception classes to status
+  codes is configured
+
 2.8.1
 -----
 

DependencyInjection/FOSRestExtension.php

@@ -420,13 +420,13 @@ private function loadException(array $config, XmlFileLoader $loader, ContainerBu
                 ->replaceArgument(0, $config['exception']['messages']);
 
             $container->getDefinition('fos_rest.serializer.flatten_exception_handler')
-                ->replaceArgument(1, $config['exception']['debug']);
+                ->replaceArgument(2, $config['exception']['debug']);
             $container->getDefinition('fos_rest.serializer.flatten_exception_handler')
-                ->replaceArgument(2, 'rfc7807' === $config['exception']['flatten_exception_format']);
+                ->replaceArgument(3, 'rfc7807' === $config['exception']['flatten_exception_format']);
             $container->getDefinition('fos_rest.serializer.flatten_exception_normalizer')
-                ->replaceArgument(1, $config['exception']['debug']);
+                ->replaceArgument(2, $config['exception']['debug']);
             $container->getDefinition('fos_rest.serializer.flatten_exception_normalizer')
-                ->replaceArgument(2, 'rfc7807' === $config['exception']['flatten_exception_format']);
+                ->replaceArgument(3, 'rfc7807' === $config['exception']['flatten_exception_format']);
 
             if ($config['exception']['serialize_exceptions']) {
                 $container->getDefinition('fos_rest.serializer.exception_normalizer.jms')

Resources/config/exception.xml

@@ -47,13 +47,15 @@
         </service>
 
         <service id="fos_rest.serializer.flatten_exception_handler" class="FOS\RestBundle\Serializer\Normalizer\FlattenExceptionHandler" public="false">
+            <argument type="service" id="fos_rest.exception.codes_map" /> <!-- exception messages -->
             <argument type="service" id="fos_rest.exception.messages_map" /> <!-- exception messages -->
             <argument /><!-- show exception message -->
             <argument /><!-- render according to RFC 7807 -->
             <tag name="jms_serializer.subscribing_handler" />
         </service>
 
         <service id="fos_rest.serializer.flatten_exception_normalizer" class="FOS\RestBundle\Serializer\Normalizer\FlattenExceptionNormalizer" public="false">
+            <argument type="service" id="fos_rest.exception.codes_map" /> <!-- exception messages -->
             <argument type="service" id="fos_rest.exception.messages_map" /> <!-- exception messages -->
             <argument /><!-- show exception message -->
             <argument /><!-- render according to RFC 7807 -->

Serializer/Normalizer/FlattenExceptionHandler.php

@@ -18,12 +18,14 @@
  */
 class FlattenExceptionHandler implements SubscribingHandlerInterface
 {
+    private $statusCodeMap;
     private $messagesMap;
     private $debug;
     private $rfc7807;
 
-    public function __construct(ExceptionValueMap $messagesMap, bool $debug, bool $rfc7807)
+    public function __construct(ExceptionValueMap $statusCodeMap, ExceptionValueMap $messagesMap, bool $debug, bool $rfc7807)
     {
+        $this->statusCodeMap = $statusCodeMap;
         $this->messagesMap = $messagesMap;
         $this->debug = $debug;
         $this->rfc7807 = $rfc7807;
@@ -94,7 +96,7 @@ private function convertToArray(FlattenException $exception, Context $context):
     {
         if ($context->hasAttribute('status_code')) {
             $statusCode = $context->getAttribute('status_code');
-        } else {
+        } elseif (false === $statusCode = $this->statusCodeMap->resolveFromClassName($exception->getClass())) {
             $statusCode = $exception->getStatusCode();
         }
 

Serializer/Normalizer/FlattenExceptionNormalizer.php

@@ -23,12 +23,14 @@
  */
 final class FlattenExceptionNormalizer implements NormalizerInterface
 {
+    private $statusCodeMap;
     private $messagesMap;
     private $debug;
     private $rfc7807;
 
-    public function __construct(ExceptionValueMap $messagesMap, bool $debug, bool $rfc7807)
+    public function __construct(ExceptionValueMap $statusCodeMap, ExceptionValueMap $messagesMap, bool $debug, bool $rfc7807)
     {
+        $this->statusCodeMap = $statusCodeMap;
         $this->messagesMap = $messagesMap;
         $this->debug = $debug;
         $this->rfc7807 = $rfc7807;
@@ -38,7 +40,7 @@ public function normalize($exception, $format = null, array $context = [])
     {
         if (isset($context['status_code'])) {
             $statusCode = $context['status_code'];
-        } else {
+        } elseif (false === $statusCode = $this->statusCodeMap->resolveFromClassName($exception->getClass())) {
             $statusCode = $exception->getStatusCode();
         }
 

Tests/Functional/Bundle/TestBundle/Controller/SerializerErrorController.php

@@ -33,6 +33,11 @@ public function unknownExceptionAction()
         throw new \OutOfBoundsException('Unknown exception message.');
     }
 
+    public function invalidArgumentExceptionAction()
+    {
+        throw new \InvalidArgumentException('Invalid argument given.');
+    }
+
     /**
      * @View
      */

Tests/Functional/Bundle/TestBundle/Resources/config/routing.yml

@@ -10,6 +10,10 @@ test_serializer_unknown_exception:
     path:     /serializer-error/unknown_exception.{_format}
     defaults: { _controller: FOS\RestBundle\Tests\Functional\Bundle\TestBundle\Controller\SerializerErrorController::unknownExceptionAction }
 
+test_serializer_invalid_argument_exception:
+    path:     /serializer-error/invalid-argument-exception.{_format}
+    defaults: { _controller: FOS\RestBundle\Tests\Functional\Bundle\TestBundle\Controller\SerializerErrorController::invalidArgumentExceptionAction }
+
 test_serializer_error_invalid_form:
     path:     /serializer-error/invalid-form.{_format}
     defaults: { _controller: FOS\RestBundle\Tests\Functional\Bundle\TestBundle\Controller\SerializerErrorController::invalidFormAction }

Tests/Functional/SerializerErrorTest.php

@@ -155,6 +155,61 @@ public function testSerializeUnknownExceptionJsonWithoutDebugUsingErrorRenderer(
         $this->assertEquals('{"code":500,"message":"Internal Server Error"}', $client->getResponse()->getContent());
     }
 
+    /**
+     * @dataProvider serializeExceptionCodeMappedToResponseStatusCodeJsonProvider
+     */
+    public function testSerializeExceptionCodeMappedToResponseStatusCodeJsonUsingErrorRenderer(string $testCase, array $expectedJson)
+    {
+        if (!class_exists(SerializerErrorRenderer::class)) {
+            $this->markTestSkipped();
+        }
+
+        $this->iniSet('error_log', file_exists('/dev/null') ? '/dev/null' : 'nul');
+
+        $client = $this->createClient(array('test_case' => $testCase, 'debug' => false));
+        $client->request('GET', '/serializer-error/invalid-argument-exception.json');
+
+        $this->assertEquals(json_encode($expectedJson), $client->getResponse()->getContent());
+    }
+
+    public function serializeExceptionCodeMappedToResponseStatusCodeJsonProvider(): array
+    {
+        return [
+            [
+                'FlattenExceptionHandlerLegacyFormat',
+                [
+                    'code' => 400,
+                    'message' => 'Invalid argument given.',
+                ],
+            ],
+            [
+                'FlattenExceptionHandlerRfc7807Format',
+                [
+                    'type' => 'https://tools.ietf.org/html/rfc2616#section-10',
+                    'title' => 'An error occurred',
+                    'status' => 400,
+                    'detail' => 'Invalid argument given.',
+                ],
+            ],
+            [
+                'FlattenExceptionNormalizerLegacyFormat',
+                [
+                    'code' => 400,
+                    'message' => 'Invalid argument given.',
+                ],
+            ],
+            [
+                'FlattenExceptionNormalizerRfc7807Format',
+                [
+                    'type' => 'https://tools.ietf.org/html/rfc2616#section-10',
+                    'title' => 'An error occurred',
+                    'status' => 400,
+                    'detail' => 'Invalid argument given.',
+                ],
+            ],
+        ];
+    }
+
     /**
      * @group legacy
      *

Tests/Functional/app/FlattenExceptionHandlerLegacyFormat/config.yml

@@ -4,6 +4,8 @@ imports:
 
 fos_rest:
     exception:
+        codes:
+            'InvalidArgumentException': 400
         exception_listener: false
         serialize_exceptions: false
         flatten_exception_format: 'legacy'

Tests/Functional/app/FlattenExceptionHandlerRfc7807Format/config.yml

@@ -4,6 +4,8 @@ imports:
 
 fos_rest:
     exception:
+        codes:
+            'InvalidArgumentException': 400
         exception_listener: false
         serialize_exceptions: false
         flatten_exception_format: 'rfc7807'