Unwrap exception thrown in handler for Symfony Messenger 4.3

Author: teohhanhui

features/json/input_output.feature

@@ -7,7 +7,7 @@ Feature: JSON DTO input and output
     Given I add "Accept" header equal to "application/json"
     And I add "Content-Type" header equal to "application/json"
 
-  Scenario: Messenger handler returning output object
+  Scenario: Request a password reset
     And I send a "POST" request to "/users/password_reset_request" with body:
     """
     {
@@ -23,3 +23,15 @@ Feature: JSON DTO input and output
       "emailSentAt": "2019-07-05T15:44:00+00:00"
     }
     """
+
+  Scenario: Request a password reset for a non-existent user
+    And I send a "POST" request to "/users/password_reset_request" with body:
+    """
+    {
+      "email": "does-not-exist@example.com"
+    }
+    """
+    Then the response status code should be 404
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/problem+json; charset=utf-8"
+    And the JSON node "detail" should be equal to "User does not exist."

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -44,7 +44,7 @@
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
-use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
+use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Symfony\Component\Yaml\Yaml;
@@ -526,7 +526,7 @@ private function registerMercureConfiguration(ContainerBuilder $container, array
             $loader->load('doctrine_orm_mercure_publisher.xml');
 
             // BC for Symfony Messenger 4.2
-            if (interface_exists(MessageBusInterface::class) && !class_exists(UnrecoverableMessageHandlingException::class)) {
+            if (interface_exists(MessageBusInterface::class) && !class_exists(HandlerFailedException::class)) {
                 $container->getDefinition('api_platform.doctrine.listener.mercure.publish')->replaceArgument(5, new Reference('message_bus', ContainerInterface::IGNORE_ON_INVALID_REFERENCE));
             }
         }
@@ -541,7 +541,7 @@ private function registerMessengerConfiguration(ContainerBuilder $container, arr
         $loader->load('messenger.xml');
 
         // BC for Symfony Messenger 4.2
-        if (interface_exists(MessageBusInterface::class) && !class_exists(UnrecoverableMessageHandlingException::class)) {
+        if (interface_exists(MessageBusInterface::class) && !class_exists(HandlerFailedException::class)) {
             $container->setAlias('api_platform.message_bus', 'message_bus');
         }
     }

src/EventListener/ExceptionListener.php

@@ -17,6 +17,7 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
 use Symfony\Component\HttpKernel\EventListener\ExceptionListener as BaseExceptionListener;
+use Symfony\Component\Messenger\Exception\HandlerFailedException;
 
 /**
  * Handles requests errors.
@@ -44,6 +45,18 @@ public function onKernelException(GetResponseForExceptionEvent $event): void
             return;
         }
 
+        // unwrap the exception thrown in handler for Symfony Messenger >= 4.3
+        $exception = $event->getException();
+        if ($exception instanceof HandlerFailedException) {
+            /** @var \Throwable $previousException */
+            $previousException = $exception->getPrevious();
+            if (!$previousException instanceof \Exception) {
+                throw $previousException;
+            }
+
+            $event->setException($previousException);
+        }
+
         $this->exceptionListener->onKernelException($event);
     }
 }

tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php

@@ -92,7 +92,7 @@
 use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
+use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Serializer\Exception\ExceptionInterface;
 
 /**
@@ -494,7 +494,7 @@ public function testDisabledMessenger()
     {
         $containerBuilderProphecy = $this->getBaseContainerBuilderProphecy();
         $containerBuilderProphecy->setAlias('api_platform.message_bus', 'messenger.default_bus')->shouldNotBeCalled();
-        if (!class_exists(UnrecoverableMessageHandlingException::class)) {
+        if (!class_exists(HandlerFailedException::class)) {
             $containerBuilderProphecy->setAlias('api_platform.message_bus', 'message_bus')->shouldNotBeCalled();
         }
         $containerBuilderProphecy->setDefinition('api_platform.messenger.data_persister', Argument::type(Definition::class))->shouldNotBeCalled();
@@ -1175,7 +1175,7 @@ private function getBaseContainerBuilderProphecy(array $doctrineIntegrationsToLo
             $containerBuilderProphecy->setAlias($alias, $service)->shouldBeCalled();
         }
 
-        if (!class_exists(UnrecoverableMessageHandlingException::class)) {
+        if (!class_exists(HandlerFailedException::class)) {
             $containerBuilderProphecy->setAlias('api_platform.message_bus', 'message_bus')->shouldBeCalled();
         }
 

tests/Fixtures/TestBundle/MessageHandler/PasswordResetRequestHandler.php

@@ -15,12 +15,17 @@
 
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Dto\PasswordResetRequest;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Dto\PasswordResetRequestResult;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
 
 class PasswordResetRequestHandler implements MessageHandlerInterface
 {
     public function __invoke(PasswordResetRequest $passwordResetRequest): PasswordResetRequestResult
     {
+        if ('does-not-exist@example.com' === $passwordResetRequest->getEmail()) {
+            throw new NotFoundHttpException('User does not exist.');
+        }
+
         return new PasswordResetRequestResult(new \DateTimeImmutable('2019-07-05T15:44:00Z'));
     }
 }