Unwrap HandlerFailedException for sync Messenger messages too

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Unwrap Messenger failures (`HandlerFailedException`) when using sync transport (#475)
+
 ## 4.2.1 (2021-08-24)
 
 - Fix return type for `TracingDriver::getDatabase()` method (#541)

src/EventListener/ErrorListener.php

@@ -6,6 +6,7 @@
 
 use Sentry\State\HubInterface;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
+use Symfony\Component\Messenger\Exception\HandlerFailedException;
 
 /**
  * This listener listens for error events and logs them to Sentry.
@@ -36,9 +37,17 @@ public function handleExceptionEvent(ErrorListenerExceptionEvent $event): void
     {
         /** @psalm-suppress RedundantCondition */
         if ($event instanceof ExceptionEvent) {
-            $this->hub->captureException($event->getThrowable());
+            $error = $event->getThrowable();
         } else {
-            $this->hub->captureException($event->getException());
+            $error = $event->getException();
+        }
+
+        if ($error instanceof HandlerFailedException) {
+            foreach ($error->getNestedExceptions() as $nestedException) {
+                $this->hub->captureException($nestedException);
+            }
+        } else {
+            $this->hub->captureException($error);
         }
     }
 }

tests/End2End/App/Controller/MessengerController.php

@@ -5,6 +5,7 @@
 namespace Sentry\SentryBundle\Tests\End2End\App\Controller;
 
 use Sentry\SentryBundle\Tests\End2End\App\Messenger\FooMessage;
+use Sentry\SentryBundle\Tests\End2End\App\Messenger\SyncMessage;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Messenger\MessageBusInterface;
 
@@ -33,4 +34,11 @@ public function dispatchUnrecoverableMessage(): Response
 
         return new Response('Success');
     }
+
+    public function dispatchUnrecoverableSyncMessage(): Response
+    {
+        $this->messenger->dispatch(new SyncMessage());
+
+        return new Response('Success');
+    }
 }

tests/End2End/App/Messenger/IgnorableException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Messenger;
+
+final class IgnorableException extends \Exception
+{
+}

tests/End2End/App/Messenger/SyncMessage.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Messenger;
+
+final class SyncMessage
+{
+}

tests/End2End/App/Messenger/SyncMessageHandler.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Messenger;
+
+use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
+
+final class SyncMessageHandler implements MessageHandlerInterface
+{
+    public function __invoke(SyncMessage $message): void
+    {
+        throw new IgnorableException('This is an intentional failure while handling a message of class ' . \get_class($message));
+    }
+}

tests/End2End/App/config.yml

@@ -5,6 +5,8 @@ sentry:
     capture_silenced_errors: true
     error_types: E_ALL & ~E_USER_DEPRECATED
     traces_sample_rate: 0
+    integrations:
+      - 'Sentry\Integration\IgnoreErrorsIntegration'
 
 framework:
   router: { resource: "%routing_config_dir%/routing.yml" }
@@ -29,6 +31,12 @@ services:
   Sentry\SentryBundle\Tests\End2End\App\Command\MainCommand:
     tags: [{ name: 'console.command', command: 'main-command' }]
 
+  Sentry\Integration\IgnoreErrorsIntegration:
+    arguments:
+      $options:
+        ignore_exceptions:
+          - '\Sentry\SentryBundle\Tests\End2End\App\Messenger\IgnorableException'
+
 monolog:
   handlers:
     main:

tests/End2End/App/messenger.yml

@@ -8,6 +8,9 @@ services:
   Sentry\SentryBundle\Tests\End2End\App\Messenger\FooMessageHandler:
     class: \Sentry\SentryBundle\Tests\End2End\App\Messenger\FooMessageHandler
 
+  Sentry\SentryBundle\Tests\End2End\App\Messenger\SyncMessageHandler:
+    class: \Sentry\SentryBundle\Tests\End2End\App\Messenger\SyncMessageHandler
+
   Sentry\SentryBundle\Tests\End2End\App\Controller\MessengerController:
     autowire: true
     tags:
@@ -16,12 +19,15 @@ services:
 framework:
   messenger:
     transports:
+      sync:
+        dsn: 'sync://'
       async:
         dsn: 'static://'
         retry_strategy:
           max_retries: 1
     routing:
-      '*': async
+      Sentry\SentryBundle\Tests\End2End\App\Messenger\FooMessage: async
+      Sentry\SentryBundle\Tests\End2End\App\Messenger\SyncMessage: sync
 
 sentry:
   messenger:

tests/End2End/App/routing.yml

@@ -30,6 +30,10 @@ dispatch_unrecoverable:
   path: /dispatch-unrecoverable-message
   defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\MessengerController::dispatchUnrecoverableMessage' }
 
+dispatch_unrecoverable_sync:
+  path: /dispatch-unrecoverable-sync-message
+  defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\MessengerController::dispatchUnrecoverableSyncMessage' }
+
 tracing_ping_database:
   path: /tracing/ping-database
   defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\TracingController::pingDatabase' }

tests/End2End/End2EndTest.php

@@ -228,6 +228,22 @@ public function testMessengerCaptureSoftFailCanBeDisabled(): void
         $this->assertLastEventIdIsNull($client);
     }
 
+    public function testMessengerSyncDispatchUnwrapsErrors(): void
+    {
+        $this->skipIfMessengerIsMissing();
+
+        $client = static::createClient();
+
+        $client->request('GET', '/dispatch-unrecoverable-sync-message');
+
+        $response = $client->getResponse();
+
+        $this->assertInstanceOf(Response::class, $response);
+        $this->assertSame(500, $response->getStatusCode());
+
+        $this->assertLastEventIdIsNull($client);
+    }
+
     private function consumeOneMessage(KernelInterface $kernel): void
     {
         $application = new Application($kernel);