Merge pull request #2960 from teohhanhui/fix/messenger-nested-handler-failed-exception

Unwrap nested HandlerFailedException

Author: teohhanhui

src/EventListener/ExceptionListener.php

@@ -45,18 +45,19 @@ 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);
+        // unwrap the exception thrown in handler for Symfony Messenger >= 4.3
+        while ($exception instanceof HandlerFailedException) {
+            /** @var \Throwable $exception */
+            $exception = $exception->getPrevious();
+            if (!$exception instanceof \Exception) {
+                throw $exception;
+            }
         }
 
+        $event->setException($exception);
+
         $this->exceptionListener->onKernelException($event);
     }
 }

tests/EventListener/ExceptionListenerTest.php

@@ -35,9 +35,10 @@ public function testOnKernelException(Request $request)
         $kernel->handle(Argument::type(Request::class), HttpKernelInterface::SUB_REQUEST, false)->willReturn(new Response())->shouldBeCalled();
 
         $eventProphecy = $this->prophesize(GetResponseForExceptionEvent::class);
-        $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
-        $eventProphecy->getException()->willReturn(new \Exception())->shouldBeCalled();
-        $eventProphecy->getKernel()->willReturn($kernel)->shouldBeCalled();
+        $eventProphecy->getRequest()->willReturn($request);
+        $eventProphecy->getException()->willReturn(new \Exception());
+        $eventProphecy->setException(Argument::type(\Exception::class))->will(function () {});
+        $eventProphecy->getKernel()->willReturn($kernel);
         $eventProphecy->setResponse(Argument::type(Response::class))->shouldBeCalled();
 
         $listener = new ExceptionListener('foo:bar');
@@ -55,7 +56,8 @@ public function getRequest()
     public function testDoNothingWhenNotAnApiCall()
     {
         $eventProphecy = $this->prophesize(GetResponseForExceptionEvent::class);
-        $eventProphecy->getRequest()->willReturn(new Request())->shouldBeCalled();
+        $eventProphecy->getRequest()->willReturn(new Request());
+        $eventProphecy->setResponse(Argument::type(Response::class))->shouldNotBeCalled();
 
         $listener = new ExceptionListener('foo:bar');
         $listener->onKernelException($eventProphecy->reveal());
@@ -67,7 +69,8 @@ public function testDoNothingWhenHtmlRequested()
         $request->setRequestFormat('html');
 
         $eventProphecy = $this->prophesize(GetResponseForExceptionEvent::class);
-        $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
+        $eventProphecy->getRequest()->willReturn($request);
+        $eventProphecy->setResponse(Argument::type(Response::class))->shouldNotBeCalled();
 
         $listener = new ExceptionListener('foo:bar');
         $listener->onKernelException($eventProphecy->reveal());