Capture all messenger exceptions (#340)

* Capture exceptions thrown by all messenger handlers

* Standardise flush calls on messenger listener

* Wrap all test errors in HandlerFailed

* Ensure all raised errors are captured

* CS space

* Capture all errors, not just HandlerFailedException

Author: emarref

src/EventListener/MessengerListener.php

@@ -41,13 +41,15 @@ public function onWorkerMessageFailed(WorkerMessageFailedEvent $event): void
 
         $error = $event->getThrowable();
 
-        if ($error instanceof HandlerFailedException && null !== $error->getPrevious()) {
-            // Unwrap the messenger exception to get the original error
-            $error = $error->getPrevious();
+        if ($error instanceof HandlerFailedException) {
+            foreach ($error->getNestedExceptions() as $nestedException) {
+                $this->client->captureException($nestedException);
+            }
+        } else {
+            $this->client->captureException($error);
         }
 
-        $this->client->captureException($error);
-        $this->client->flush();
+        $this->flush();
     }
 
     /**
@@ -57,6 +59,11 @@ public function onWorkerMessageHandled(WorkerMessageHandledEvent $event): void
     {
         // Flush normally happens at shutdown... which only happens in the worker if it is run with a lifecycle limit
         // such as --time=X or --limit=Y. Flush immediately in a background worker.
+        $this->flush();
+    }
+
+    private function flush(): void
+    {
         $this->client->flush();
     }
 }

test/EventListener/MessengerListenerTest.php

@@ -28,15 +28,37 @@ public function testSoftFailsAreRecorded(): void
             self::markTestSkipped('Messenger not supported in this environment.');
         }
 
+        $message = (object) ['foo' => 'bar'];
+        $envelope = Envelope::wrap($message);
+
         $error = new \RuntimeException();
+        $wrappedError = new HandlerFailedException($envelope, [$error]);
 
         $this->client->captureException($error)->shouldBeCalled();
         $this->client->flush()->shouldBeCalled();
 
         $listener = new MessengerListener($this->client->reveal(), true);
+        $event = $this->getMessageFailedEvent($envelope, 'receiver', $wrappedError, true);
+
+        $listener->onWorkerMessageFailed($event);
+    }
+
+    public function testNonMessengerErrorsAreRecorded(): void
+    {
+        if (! $this->supportsMessenger()) {
+            self::markTestSkipped('Messenger not supported in this environment.');
+        }
+
         $message = (object) ['foo' => 'bar'];
         $envelope = Envelope::wrap($message);
-        $event = $this->getMessageFailedEvent($envelope, 'receiver', $error, true);
+
+        $error = new \RuntimeException();
+
+        $this->client->captureException($error)->shouldBeCalled();
+        $this->client->flush()->shouldBeCalled();
+
+        $listener = new MessengerListener($this->client->reveal(), true);
+        $event = $this->getMessageFailedEvent($envelope, 'receiver', $error, false);
 
         $listener->onWorkerMessageFailed($event);
     }
@@ -47,15 +69,17 @@ public function testHardFailsAreRecorded(): void
             self::markTestSkipped('Messenger not supported in this environment.');
         }
 
+        $message = (object) ['foo' => 'bar'];
+        $envelope = Envelope::wrap($message);
+
         $error = new \RuntimeException();
+        $wrappedError = new HandlerFailedException($envelope, [$error]);
 
         $this->client->captureException($error)->shouldBeCalled();
         $this->client->flush()->shouldBeCalled();
 
         $listener = new MessengerListener($this->client->reveal(), true);
-        $message = (object) ['foo' => 'bar'];
-        $envelope = Envelope::wrap($message);
-        $event = $this->getMessageFailedEvent($envelope, 'receiver', $error, false);
+        $event = $this->getMessageFailedEvent($envelope, 'receiver', $wrappedError, false);
 
         $listener->onWorkerMessageFailed($event);
     }
@@ -66,15 +90,17 @@ public function testSoftFailsAreNotRecorded(): void
             self::markTestSkipped('Messenger not supported in this environment.');
         }
 
+        $message = (object) ['foo' => 'bar'];
+        $envelope = Envelope::wrap($message);
+
         $error = new \RuntimeException();
+        $wrappedError = new HandlerFailedException($envelope, [$error]);
 
         $this->client->captureException($error)->shouldNotBeCalled();
         $this->client->flush()->shouldNotBeCalled();
 
         $listener = new MessengerListener($this->client->reveal(), false);
-        $message = (object) ['foo' => 'bar'];
-        $envelope = Envelope::wrap($message);
-        $event = $this->getMessageFailedEvent($envelope, 'receiver', $error, true);
+        $event = $this->getMessageFailedEvent($envelope, 'receiver', $wrappedError, true);
 
         $listener->onWorkerMessageFailed($event);
     }
@@ -85,15 +111,17 @@ public function testHardFailsAreRecordedWithCaptureSoftDisabled(): void
             self::markTestSkipped('Messenger not supported in this environment.');
         }
 
+        $message = (object) ['foo' => 'bar'];
+        $envelope = Envelope::wrap($message);
+
         $error = new \RuntimeException();
+        $wrappedError = new HandlerFailedException($envelope, [$error]);
 
         $this->client->captureException($error)->shouldBeCalled();
         $this->client->flush()->shouldBeCalled();
 
         $listener = new MessengerListener($this->client->reveal(), false);
-        $message = (object) ['foo' => 'bar'];
-        $envelope = Envelope::wrap($message);
-        $event = $this->getMessageFailedEvent($envelope, 'receiver', $error, false);
+        $event = $this->getMessageFailedEvent($envelope, 'receiver', $wrappedError, false);
 
         $listener->onWorkerMessageFailed($event);
     }
@@ -106,12 +134,14 @@ public function testHandlerFailedExceptionIsUnwrapped(): void
 
         $message = (object) ['foo' => 'bar'];
         $envelope = Envelope::wrap($message);
-        $error = new \RuntimeException();
-        $wrappedError = new HandlerFailedException($envelope, [$error]);
+        $error1 = new \RuntimeException();
+        $error2 = new \RuntimeException();
+        $wrappedError = new HandlerFailedException($envelope, [$error1, $error2]);
 
         $event = $this->getMessageFailedEvent($envelope, 'receiver', $wrappedError, false);
 
-        $this->client->captureException($error)->shouldBeCalled();
+        $this->client->captureException($error1)->shouldBeCalled();
+        $this->client->captureException($error2)->shouldBeCalled();
         $this->client->flush()->shouldBeCalled();
 
         $listener = new MessengerListener($this->client->reveal());