Merge pull request #2354 from teohhanhui/fix/serialize-listener-killswitch

Fix SerializeListener to respect _api_respond request attribute

Author: soyuka

src/EventListener/RespondListener.php

@@ -36,7 +36,7 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
         $controllerResult = $event->getControllerResult();
         $request = $event->getRequest();
 
-        if ($controllerResult instanceof Response || !$request->attributes->get('_api_respond')) {
+        if ($controllerResult instanceof Response || !$request->attributes->getBoolean('_api_respond', true)) {
             return;
         }
 

src/EventListener/SerializeListener.php

@@ -47,7 +47,7 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
         $controllerResult = $event->getControllerResult();
         $request = $event->getRequest();
 
-        if ($controllerResult instanceof Response) {
+        if ($controllerResult instanceof Response || !$request->attributes->getBoolean('_api_respond', true)) {
             return;
         }
 
@@ -80,10 +80,6 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
      */
     private function serializeRawData(GetResponseForControllerResultEvent $event, Request $request, $controllerResult)
     {
-        if (!$request->attributes->get('_api_respond')) {
-            return;
-        }
-
         if (\is_object($controllerResult)) {
             $event->setControllerResult($this->serializer->serialize($controllerResult, $request->getRequestFormat(), $request->attributes->get('_api_normalization_context', [])));
 

tests/EventListener/RespondListenerTest.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\EventListener\RespondListener;
 use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
@@ -28,11 +29,24 @@ class RespondListenerTest extends TestCase
     public function testDoNotHandleResponse()
     {
         $request = new Request();
-        $request->setRequestFormat('xml');
 
         $eventProphecy = $this->prophesize(GetResponseForControllerResultEvent::class);
-        $eventProphecy->getControllerResult()->willReturn(new Response())->shouldBeCalled();
-        $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
+        $eventProphecy->getControllerResult()->willReturn(new Response());
+        $eventProphecy->getRequest()->willReturn($request);
+        $eventProphecy->setResponse(Argument::any())->shouldNotBeCalled();
+
+        $listener = new RespondListener();
+        $listener->onKernelView($eventProphecy->reveal());
+    }
+
+    public function testDoNotHandleWhenRespondFlagIsFalse()
+    {
+        $request = new Request([], [], ['_api_respond' => false]);
+
+        $eventProphecy = $this->prophesize(GetResponseForControllerResultEvent::class);
+        $eventProphecy->getControllerResult()->willReturn('foo');
+        $eventProphecy->getRequest()->willReturn($request);
+        $eventProphecy->setResponse(Argument::any())->shouldNotBeCalled();
 
         $listener = new RespondListener();
         $listener->onKernelView($eventProphecy->reveal());

tests/EventListener/SerializeListenerTest.php

@@ -32,7 +32,7 @@ class SerializeListenerTest extends TestCase
     public function testDoNotSerializeResponse()
     {
         $serializerProphecy = $this->prophesize(SerializerInterface::class);
-        $serializerProphecy->serialize()->shouldNotBeCalled();
+        $serializerProphecy->serialize(Argument::cetera())->shouldNotBeCalled();
 
         $request = new Request();
         $request->setRequestFormat('xml');
@@ -42,61 +42,25 @@ public function testDoNotSerializeResponse()
         $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
 
         $serializerContextBuilderProphecy = $this->prophesize(SerializerContextBuilderInterface::class);
-        $serializerContextBuilderProphecy->createFromRequest()->shouldNotBeCalled();
+        $serializerContextBuilderProphecy->createFromRequest(Argument::cetera())->shouldNotBeCalled();
 
         $listener = new SerializeListener($serializerProphecy->reveal(), $serializerContextBuilderProphecy->reveal());
         $listener->onKernelView($eventProphecy->reveal());
     }
 
-    public function testDoNotSerializeWhenFormatNotSet()
+    public function testDoNotSerializeWhenRespondFlagIsFalse()
     {
         $serializerProphecy = $this->prophesize(SerializerInterface::class);
-        $serializerProphecy->serialize()->shouldNotBeCalled();
-
-        $eventProphecy = $this->prophesize(GetResponseForControllerResultEvent::class);
-        $eventProphecy->getControllerResult()->willReturn(new \stdClass())->shouldBeCalled();
-        $eventProphecy->getRequest()->willReturn(new Request())->shouldBeCalled();
-
-        $serializerContextBuilderProphecy = $this->prophesize(SerializerContextBuilderInterface::class);
-        $serializerContextBuilderProphecy->createFromRequest()->shouldNotBeCalled();
-
-        $listener = new SerializeListener($serializerProphecy->reveal(), $serializerContextBuilderProphecy->reveal());
-        $listener->onKernelView($eventProphecy->reveal());
-    }
-
-    public function testDoNotSerializeWhenResourceClassNotSet()
-    {
-        $serializerProphecy = $this->prophesize(SerializerInterface::class);
-        $serializerProphecy->serialize()->shouldNotBeCalled();
-
-        $request = new Request([], [], ['_api_collection_operation_name' => 'get']);
-        $request->setRequestFormat('xml');
-
-        $eventProphecy = $this->prophesize(GetResponseForControllerResultEvent::class);
-        $eventProphecy->getControllerResult()->willReturn(new \stdClass())->shouldBeCalled();
-        $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
+        $serializerProphecy->serialize(Argument::cetera())->shouldNotBeCalled();
 
         $serializerContextBuilderProphecy = $this->prophesize(SerializerContextBuilderInterface::class);
-        $serializerContextBuilderProphecy->createFromRequest()->shouldNotBeCalled();
 
-        $listener = new SerializeListener($serializerProphecy->reveal(), $serializerContextBuilderProphecy->reveal());
-        $listener->onKernelView($eventProphecy->reveal());
-    }
-
-    public function testDoNotSerializeWhenOperationNotSet()
-    {
-        $serializerProphecy = $this->prophesize(SerializerInterface::class);
-        $serializerProphecy->serialize()->shouldNotBeCalled();
-
-        $request = new Request([], [], ['_api_resource_class' => 'Foo']);
-        $request->setRequestFormat('xml');
+        $request = new Request([], [], ['_api_respond' => false]);
 
         $eventProphecy = $this->prophesize(GetResponseForControllerResultEvent::class);
-        $eventProphecy->getControllerResult()->willReturn(new \stdClass())->shouldBeCalled();
-        $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
-
-        $serializerContextBuilderProphecy = $this->prophesize(SerializerContextBuilderInterface::class);
-        $serializerContextBuilderProphecy->createFromRequest()->shouldNotBeCalled();
+        $eventProphecy->getControllerResult()->willReturn(new \stdClass());
+        $eventProphecy->getRequest()->willReturn($request);
+        $eventProphecy->setControllerResult(Argument::any())->shouldNotBeCalled();
 
         $listener = new SerializeListener($serializerProphecy->reveal(), $serializerContextBuilderProphecy->reveal());
         $listener->onKernelView($eventProphecy->reveal());
@@ -178,7 +142,7 @@ public function testEncode()
         $serializerProphecy = $this->prophesize(SerializerInterface::class);
         $serializerProphecy->willImplement(EncoderInterface::class);
         $serializerProphecy->encode(Argument::any(), 'xml')->willReturn('bar')->shouldBeCalled();
-        $serializerProphecy->serialize()->shouldNotBeCalled();
+        $serializerProphecy->serialize(Argument::cetera())->shouldNotBeCalled();
 
         $request = new Request([], [], ['_api_respond' => true]);
         $request->setRequestFormat('xml');