Added ExceptionWrapperSerializeHandler so ExceptionWrapper could be serialized properly

Author: munkie

Resources/config/view.xml

@@ -11,6 +11,7 @@
         <parameter key="fos_rest.view.exception_wrapper_handler" />
         <parameter key="fos_rest.view_handler.default.class">FOS\RestBundle\View\ViewHandler</parameter>
         <parameter key="fos_rest.view_handler.jsonp.class">FOS\RestBundle\View\JsonpHandler</parameter>
+        <parameter key="fos_rest.serializer.exception_wrapper_serialize_handler.class">FOS\RestBundle\Serializer\ExceptionWrapperSerializeHandler</parameter>
     </parameters>
 
     <services>
@@ -42,5 +43,9 @@
 
         <service id="fos_rest.view.exception_wrapper_handler" class="%fos_rest.view.exception_wrapper_handler%" />
 
+        <service id="fos_rest.serializer.exception_wrapper_serialize_handler" class="%fos_rest.serializer.exception_wrapper_serialize_handler.class%">
+            <tag name="jms_serializer.subscribing_handler" />
+        </service>
+
     </services>
 </container>

Serializer/ExceptionWrapperSerializeHandler.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace FOS\RestBundle\Serializer;
+
+use FOS\RestBundle\Util\ExceptionWrapper;
+use JMS\Serializer\Context;
+use JMS\Serializer\GraphNavigator;
+use JMS\Serializer\Handler\SubscribingHandlerInterface;
+use JMS\Serializer\VisitorInterface;
+
+class ExceptionWrapperSerializeHandler implements SubscribingHandlerInterface
+{
+    /**
+     * @return array
+     */
+    public static function getSubscribingMethods()
+    {
+        return array(
+            array(
+                'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
+                'format' => 'json',
+                'type' => 'FOS\\RestBundle\\Util\\ExceptionWrapper',
+                'method' => 'serializeToJson'
+            )
+        );
+    }
+
+    /**
+     * @param VisitorInterface $visitor
+     * @param ExceptionWrapper $value
+     * @param array $type
+     * @param Context $context
+     * @return string
+     */
+    public function serializeToJson(
+        VisitorInterface $visitor,
+        ExceptionWrapper $value,
+        array $type,
+        Context $context
+    ) {
+        $type['name'] = 'array';
+        $data = array(
+            'code' => $value->getCode(),
+            'message' => $value->getMessage(),
+            'errors' => $value->getErrors(),
+        );
+        return $visitor->visitArray($data, $type, $context);
+    }
+}

Tests/View/ViewHandlerTest.php

@@ -11,12 +11,22 @@
 
 namespace FOS\RestBundle\Tests\View;
 
+use FOS\RestBundle\Serializer\ExceptionWrapperSerializeHandler;
+use FOS\RestBundle\Util\ExceptionWrapper;
 use FOS\RestBundle\View\ExceptionWrapperHandler;
 use FOS\RestBundle\View\View;
 use FOS\RestBundle\View\ViewHandler;
+use JMS\Serializer\EventDispatcher\EventDispatcher;
+use JMS\Serializer\Handler\FormErrorHandler;
+use JMS\Serializer\Handler\HandlerRegistry;
+use JMS\Serializer\SerializerBuilder;
 use Symfony\Bundle\FrameworkBundle\Templating\TemplateReference;
 use FOS\RestBundle\Util\Codes;
 use Symfony\Component\DependencyInjection\Container;
+use Symfony\Component\Form\Form;
+use Symfony\Component\Form\FormBuilder;
+use Symfony\Component\Form\FormError;
+use Symfony\Component\Form\Forms;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Form\FormView;
@@ -546,4 +556,92 @@ public function testConfigurableViewHandlerInterface()
         $this->assertEquals('1.1', $context->attributes->get('version')->getOrThrow(new \Exception('Serialization version not set as expected')));
         $this->assertTrue($context->shouldSerializeNull());
     }
+
+    public function testCreateResponseWithFormErrorsAndSerializationGroups()
+    {
+        $builder = Forms::createFormFactory()->createBuilder();
+        $form = $builder
+            ->add('name', 'text')
+            ->add('description', 'text')
+            ->getForm();
+
+        $exceptionWrapper = new ExceptionWrapper(
+            array(
+                'status_code' => 400,
+                'message' => 'Validation Failed',
+                'errors' => $form
+            )
+        );
+
+        $view = new View($exceptionWrapper);
+        $view->getSerializationContext()->setGroups(array('Custom'));
+
+        $handler = new ExceptionWrapperSerializeHandler();
+        $formErrorHandlerMock = $this->getMock(
+            'JMS\Serializer\Handler\FormErrorHandler',
+            array('serializeFormToJson'),
+            array(),
+            '',
+            false
+        );
+        $formErrorHandlerMock
+            ->expects($this->once())
+            ->method('serializeFormToJson')
+            ->with(
+                $this->isInstanceOf('JMS\\Serializer\\JsonSerializationVisitor'),
+                $form,
+                array(
+                    'name' => 'Symfony\Component\Form\Form',
+                    'params' => array()
+                )
+            )
+            ->will(
+                $this->returnValue(
+                    array(
+                        'children' => array(
+                            'name' => array(
+                                'errors' => array(
+                                    'Invalid name'
+                                )
+                            ),
+                        )
+                    )
+                )
+            );
+
+        $serializer = SerializerBuilder::create()
+            ->configureHandlers(function (HandlerRegistry $handlerRegistry) use ($handler, $formErrorHandlerMock) {
+                $handlerRegistry->registerSubscribingHandler($handler);
+                $handlerRegistry->registerSubscribingHandler($formErrorHandlerMock);
+            })
+            ->build();
+
+        $container = $this->getMock('Symfony\Component\DependencyInjection\Container', array('get'));
+        $container
+            ->expects($this->once())
+            ->method('get')
+            ->with('fos_rest.serializer')
+            ->will($this->returnValue($serializer));
+
+        $viewHandler = new ViewHandler(array());
+        $viewHandler->setContainer($container);
+
+        $response = $viewHandler->createResponse($view, new Request(), 'json');
+
+        $expected = array(
+            'code' => 400,
+            'message' => 'Validation Failed',
+            'errors' => array(
+                'children' => array(
+                    'name' => array(
+                        'errors' => array(
+                            'Invalid name'
+                        )
+                    )
+                )
+            )
+        );
+
+        $this->assertEquals($expected, json_decode($response->getContent(), true));
+    }
 }

Util/ExceptionWrapper.php

@@ -11,6 +11,8 @@
 
 namespace FOS\RestBundle\Util;
 
+use Symfony\Component\Form\FormInterface;
+
 /**
  * Wraps an exception into the FOSRest exception format.
  */
@@ -32,4 +34,28 @@ public function __construct($data)
             $this->errors = $data['errors'];
         }
     }
+
+    /**
+     * @return int
+     */
+    public function getCode()
+    {
+        return $this->code;
+    }
+
+    /**
+     * @return FormInterface
+     */
+    public function getErrors()
+    {
+        return $this->errors;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMessage()
+    {
+        return $this->message;
+    }
 }