Allow Response result in a messenger handler

Author: soyuka

features/main/input_output.feature

@@ -246,6 +246,7 @@ Feature: DTO input and output
     Then the response status code should be 201
     And the response should be empty
 
+  @!mongodb
   Scenario: Use messenger with an input where the handler gives a synchronous result
     When I add "Content-Type" header equal to "application/ld+json"
     And I send a "POST" request to "/messenger_with_inputs" with body:
@@ -267,3 +268,22 @@ Feature: DTO input and output
       "name": "test"
     }
     """
+
+  @!mongodb
+  Scenario: Use messenger with an input where the handler gives a synchronous Response result
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "POST" request to "/messenger_with_responses" with body:
+    """
+    {
+      "var": "test"
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/json"
+    And the JSON should be equal to:
+    """
+    {
+      "data": 123
+    }
+    """

src/Bridge/Symfony/Messenger/DataTransformer.php

@@ -48,7 +48,7 @@ public function supportsTransformation($data, string $to, array $context = []):
         if (
             \is_object($data) // data is not normalized yet, it should be an array
             ||
-            null === $className = $context['input']['class'] ?? null
+            null === ($context['input']['class'] ?? null)
         ) {
             return false;
         }

src/EventListener/RespondListener.php

@@ -45,7 +45,13 @@ public function onKernelView(GetResponseForControllerResultEvent $event): void
         $controllerResult = $event->getControllerResult();
         $request = $event->getRequest();
 
-        if ($controllerResult instanceof Response || !(($attributes = RequestAttributesExtractor::extractAttributes($request))['respond'] ?? $request->attributes->getBoolean('_api_respond', false))) {
+        $attributes = RequestAttributesExtractor::extractAttributes($request);
+        if ($controllerResult instanceof Response && ($attributes['respond'] ?? false)) {
+            $event->setResponse($controllerResult);
+
+            return;
+        }
+        if ($controllerResult instanceof Response || !($attributes['respond'] ?? $request->attributes->getBoolean('_api_respond', false))) {
             return;
         }
 

tests/EventListener/RespondListenerTest.php

@@ -180,4 +180,17 @@ public function testSetCustomStatus()
 
         $this->assertSame(Response::HTTP_ACCEPTED, $event->getResponse()->getStatusCode());
     }
+
+    public function testHandleResponse()
+    {
+        $request = new Request([], [], ['_api_resource_class' => Dummy::class, '_api_item_operation_name' => 'get', '_api_respond' => true]);
+        $response = new Response();
+        $eventProphecy = $this->prophesize(GetResponseForControllerResultEvent::class);
+        $eventProphecy->getControllerResult()->willReturn($response);
+        $eventProphecy->getRequest()->willReturn($request);
+        $eventProphecy->setResponse($response)->shouldBeCalled();
+
+        $listener = new RespondListener();
+        $listener->onKernelView($eventProphecy->reveal());
+    }
 }

tests/Fixtures/TestBundle/Dto/MessengerResponseInput.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Dto;
+
+class MessengerResponseInput
+{
+    /**
+     * @var string
+     */
+    public $var;
+}

tests/Fixtures/TestBundle/Entity/MessengerWithResponse.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Core\Annotation\ApiProperty;
+use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Dto\MessengerResponseInput;
+
+/**
+ * @ApiResource(messenger="input", input=MessengerResponseInput::class)
+ */
+class MessengerWithResponse
+{
+    /**
+     * @ApiProperty(identifier=true)
+     */
+    public $id;
+    /**
+     * @var string
+     */
+    public $name;
+}

tests/Fixtures/TestBundle/MessengerHandler/MessengerWithResponseHandler.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\MessengerHandler;
+
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Dto\MessengerResponseInput;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
+
+class MessengerWithResponseHandler implements MessageHandlerInterface
+{
+    public function __invoke(MessengerResponseInput $data)
+    {
+        $response = new Response();
+        $response->setContent(json_encode([
+            'data' => 123,
+        ]));
+        $response->headers->set('Content-Type', 'application/json');
+
+        return $response;
+    }
+}

tests/Fixtures/app/config/config_common.yml

@@ -244,3 +244,9 @@ services:
         public: false
         tags:
             -  { name: 'messenger.message_handler' }
+
+    app.messenger_handler.messenger_with_response:
+        class: 'ApiPlatform\Core\Tests\Fixtures\TestBundle\MessengerHandler\MessengerWithResponseHandler'
+        public: false
+        tags:
+            -  { name: 'messenger.message_handler' }