feat: Report to Sentry if exceptions have been handled or not

cs278 · cs278 · commit 45a7c8caa44f · 2022-11-17T09:37:08.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- Report exceptions to Sentry as unhandled by default.
+- Exceptions from messages which will be retried are sent to Sentry as handled.
+
 ## 4.4.0 (2022-10-20)
 
 - feat: Add support for Dynamic Sampling (#665)
diff --git a/src/EventListener/ConsoleListener.php b/src/EventListener/ConsoleListener.php
@@ -4,6 +4,9 @@
 
 namespace Sentry\SentryBundle\EventListener;
 
+use Sentry\Event;
+use Sentry\EventHint;
+use Sentry\ExceptionMechanism;
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
@@ -82,7 +85,12 @@ public function handleConsoleErrorEvent(ConsoleErrorEvent $event): void
             $scope->setTag('console.command.exit_code', (string) $event->getExitCode());
 
             if ($this->captureErrors) {
-                $this->hub->captureException($event->getError());
+                $hint = EventHint::fromArray([
+                    'exception' => $event->getError(),
+                    'mechanism' => new ExceptionMechanism(ExceptionMechanism::TYPE_GENERIC, false),
+                ]);
+
+                $this->hub->captureEvent(Event::createEvent(), $hint);
             }
         });
     }
diff --git a/src/EventListener/ErrorListener.php b/src/EventListener/ErrorListener.php
@@ -4,6 +4,9 @@
 
 namespace Sentry\SentryBundle\EventListener;
 
+use Sentry\Event;
+use Sentry\EventHint;
+use Sentry\ExceptionMechanism;
 use Sentry\State\HubInterface;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 
@@ -35,9 +38,16 @@ public function __construct(HubInterface $hub)
     public function handleExceptionEvent(ErrorListenerExceptionEvent $event): void
     {
         if ($event instanceof ExceptionEvent) {
-            $this->hub->captureException($event->getThrowable());
+            $exception = $event->getThrowable();
         } else {
-            $this->hub->captureException($event->getException());
+            $exception = $event->getException();
         }
+
+        $hint = EventHint::fromArray([
+            'exception' => $exception,
+            'mechanism' => new ExceptionMechanism(ExceptionMechanism::TYPE_GENERIC, false),
+        ]);
+
+        $this->hub->captureEvent(Event::createEvent(), $hint);
     }
 }
diff --git a/src/EventListener/MessengerListener.php b/src/EventListener/MessengerListener.php
@@ -5,6 +5,8 @@
 namespace Sentry\SentryBundle\EventListener;
 
 use Sentry\Event;
+use Sentry\EventHint;
+use Sentry\ExceptionMechanism;
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
@@ -62,13 +64,7 @@ public function handleWorkerMessageFailedEvent(WorkerMessageFailedEvent $event):
                 $scope->setTag('messenger.message_bus', $messageBusStamp->getBusName());
             }
 
-            if ($exception instanceof HandlerFailedException) {
-                foreach ($exception->getNestedExceptions() as $nestedException) {
-                    $this->hub->captureException($nestedException);
-                }
-            } else {
-                $this->hub->captureException($exception);
-            }
+            $this->captureException($exception, $event->willRetry());
         });
 
         $this->flushClient();
@@ -86,6 +82,33 @@ public function handleWorkerMessageHandledEvent(WorkerMessageHandledEvent $event
         $this->flushClient();
     }
 
+    /**
+     * Creates Sentry events from the given exception.
+     *
+     * Unpacks multiple exceptions wrapped in a HandlerFailedException and notifies
+     * Sentry of each individual exception.
+     *
+     * If the message will be retried the exceptions will be marked as handled
+     * in Sentry.
+     */
+    private function captureException(\Throwable $exception, bool $willRetry): void
+    {
+        if ($exception instanceof HandlerFailedException) {
+            foreach ($exception->getNestedExceptions() as $nestedException) {
+                $this->captureException($nestedException, $willRetry);
+            }
+
+            return;
+        }
+
+        $hint = EventHint::fromArray([
+            'exception' => $exception,
+            'mechanism' => new ExceptionMechanism(ExceptionMechanism::TYPE_GENERIC, $willRetry),
+        ]);
+
+        $this->hub->captureEvent(Event::createEvent(), $hint);
+    }
+
     private function flushClient(): void
     {
         $client = $this->hub->getClient();
diff --git a/tests/EventListener/AbstractConsoleListenerTest.php b/tests/EventListener/AbstractConsoleListenerTest.php
@@ -7,6 +7,7 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Sentry\Event;
+use Sentry\EventHint;
 use Sentry\SentryBundle\EventListener\ConsoleListener;
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
@@ -113,8 +114,20 @@ public function testHandleConsoleErrorEvent(bool $captureErrors): void
             });
 
         $this->hub->expects($captureErrors ? $this->once() : $this->never())
-            ->method('captureException')
-            ->with($consoleEvent->getError());
+            ->method('captureEvent')
+            ->with(
+                $this->anything(),
+                $this->logicalAnd(
+                    $this->isInstanceOf(EventHint::class),
+                    $this->callback(function (EventHint $subject) use ($consoleEvent) {
+                        self::assertSame($consoleEvent->getError(), $subject->exception);
+                        self::assertNotNull($subject->mechanism);
+                        self::assertFalse($subject->mechanism->isHandled());
+
+                        return true;
+                    })
+                )
+            );
 
         $listener->handleConsoleErrorEvent($consoleEvent);
 
diff --git a/tests/EventListener/ErrorListenerTest.php b/tests/EventListener/ErrorListenerTest.php
@@ -6,6 +6,7 @@
 
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Sentry\EventHint;
 use Sentry\SentryBundle\EventListener\ErrorListener;
 use Sentry\State\HubInterface;
 use Symfony\Component\HttpFoundation\Request;
@@ -40,9 +41,23 @@ protected function setUp(): void
      */
     public function testHandleExceptionEvent($event): void
     {
+        $expectedException = $event instanceof ExceptionEvent ? $event->getThrowable() : $event->getException();
+
         $this->hub->expects($this->once())
-            ->method('captureException')
-            ->with($event instanceof ExceptionEvent ? $event->getThrowable() : $event->getException());
+            ->method('captureEvent')
+            ->with(
+                $this->anything(),
+                $this->logicalAnd(
+                    $this->isInstanceOf(EventHint::class),
+                    $this->callback(function (EventHint $subject) use ($expectedException) {
+                        self::assertSame($expectedException, $subject->exception);
+                        self::assertNotNull($subject->mechanism);
+                        self::assertFalse($subject->mechanism->isHandled());
+
+                        return true;
+                    })
+                )
+            );
 
         $this->listener->handleExceptionEvent($event);
     }
diff --git a/tests/EventListener/MessengerListenerTest.php b/tests/EventListener/MessengerListenerTest.php
@@ -8,6 +8,7 @@
 use PHPUnit\Framework\TestCase;
 use Sentry\ClientInterface;
 use Sentry\Event;
+use Sentry\EventHint;
 use Sentry\SentryBundle\EventListener\MessengerListener;
 use Sentry\SentryBundle\Tests\End2End\App\Kernel;
 use Sentry\State\HubInterface;
@@ -43,7 +44,7 @@ protected function setUp(): void
      * @param \Throwable[]          $exceptions
      * @param array<string, string> $expectedTags
      */
-    public function testHandleWorkerMessageFailedEvent(array $exceptions, WorkerMessageFailedEvent $event, array $expectedTags): void
+    public function testHandleWorkerMessageFailedEvent(array $exceptions, WorkerMessageFailedEvent $event, array $expectedTags, bool $expectedIsHandled): void
     {
         if (!$this->supportsMessenger()) {
             $this->markTestSkipped('Messenger not supported in this environment.');
@@ -58,9 +59,21 @@ public function testHandleWorkerMessageFailedEvent(array $exceptions, WorkerMess
             });
 
         $this->hub->expects($this->exactly(\count($exceptions)))
-            ->method('captureException')
-            ->withConsecutive(...array_map(static function (\Throwable $exception): array {
-                return [$exception];
+            ->method('captureEvent')
+            ->withConsecutive(...array_map(function (\Throwable $expectedException) use ($expectedIsHandled): array {
+                return [
+                    $this->anything(),
+                    $this->logicalAnd(
+                        $this->isInstanceOf(EventHint::class),
+                        $this->callback(function (EventHint $subject) use ($expectedException, $expectedIsHandled) {
+                            self::assertSame($expectedException, $subject->exception);
+                            self::assertNotNull($subject->mechanism);
+                            self::assertSame($expectedIsHandled, $subject->mechanism->isHandled());
+
+                            return true;
+                        })
+                    ),
+                ];
             }, $exceptions));
 
         $this->hub->expects($this->once())
@@ -98,6 +111,17 @@ public function handleWorkerMessageFailedEventDataProvider(): \Generator
                 'messenger.receiver_name' => 'receiver',
                 'messenger.message_class' => \get_class($envelope->getMessage()),
             ],
+            false,
+        ];
+
+        yield 'envelope.throwable INSTANCEOF HandlerFailedException - RETRYING' => [
+            $exceptions,
+            $this->getMessageFailedEvent($envelope, 'receiver', new HandlerFailedException($envelope, $exceptions), true),
+            [
+                'messenger.receiver_name' => 'receiver',
+                'messenger.message_class' => \get_class($envelope->getMessage()),
+            ],
+            true,
         ];
 
         yield 'envelope.throwable INSTANCEOF Exception' => [
@@ -107,6 +131,17 @@ public function handleWorkerMessageFailedEventDataProvider(): \Generator
                 'messenger.receiver_name' => 'receiver',
                 'messenger.message_class' => \get_class($envelope->getMessage()),
             ],
+            false,
+        ];
+
+        yield 'envelope.throwable INSTANCEOF Exception - RETRYING' => [
+            [$exceptions[0]],
+            $this->getMessageFailedEvent($envelope, 'receiver', $exceptions[0], true),
+            [
+                'messenger.receiver_name' => 'receiver',
+                'messenger.message_class' => \get_class($envelope->getMessage()),
+            ],
+            true,
         ];
 
         $envelope = new Envelope((object) [], [new BusNameStamp('bus.foo')]);
@@ -119,6 +154,7 @@ public function handleWorkerMessageFailedEventDataProvider(): \Generator
                 'messenger.message_class' => \get_class($envelope->getMessage()),
                 'messenger.message_bus' => 'bus.foo',
             ],
+            false,
         ];
     }
 
