do not auto-attach a backtrace when logging an exception

this fixes #957. The sentry server prefers the event's stacktrace over an attached exception's stacktrace, so if a stacktrace is attached to an event containing an exception, the web interface would show the backtrace to where the exception was captured rather than the exception's backtrace.
getsentry · Jan 17, 2020 · 8fc7b60 · 8fc7b60
1 parent 161bd50
commit 8fc7b60
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 6 deletions.
diff --git a/src/Client.php b/src/Client.php
@@ -176,7 +176,12 @@ private function prepareEvent(array $payload, ?Scope $scope = null, bool $withSt
             return null;
         }
 
-        if ($withStacktrace) {
+        // when 'exception' is set, no backtrace should be auto-attached (#957)
+        if (
+            $withStacktrace
+            && !isset($payload['exception'])
+            && !isset($payload['stacktrace'])
+        ) {
             $event = $this->eventFactory->createWithStacktrace($payload);
         } else {
             $event = $this->eventFactory->create($payload);

diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -140,7 +140,7 @@ public function testCaptureEvent(): void
     /**
      * @dataProvider captureEventAttachesStacktraceAccordingToAttachStacktraceOptionDataProvider
      */
-    public function testCaptureEventAttachesStacktraceAccordingToAttachStacktraceOption(bool $shouldAttachStacktrace): void
+    public function testCaptureEventAttachesStacktraceAccordingToAttachStacktraceOption(bool $attachConfigSetting, array $payload, bool $shouldAttachStacktrace): void
     {
         /** @var TransportInterface&MockObject $transport */
         $transport = $this->createMock(TransportInterface::class);
@@ -159,18 +159,21 @@ public function testCaptureEventAttachesStacktraceAccordingToAttachStacktraceOpt
             }))
             ->willReturn('500a339f3ab2450b96dee542adf36ba7');
 
-        $client = ClientBuilder::create(['attach_stacktrace' => $shouldAttachStacktrace])
+        $client = ClientBuilder::create(['attach_stacktrace' => $attachConfigSetting])
             ->setTransportFactory($this->createTransportFactory($transport))
             ->getClient();
 
-        $this->assertEquals('500a339f3ab2450b96dee542adf36ba7', $client->captureEvent([]));
+        $this->assertEquals('500a339f3ab2450b96dee542adf36ba7', $client->captureEvent($payload));
     }
 
     public function captureEventAttachesStacktraceAccordingToAttachStacktraceOptionDataProvider(): array
     {
         return [
-            [true],
-            [false],
+            [true, [], true],
+            [false, [], false],
+            // when 'exception' is set, no backtrace should be auto-attached (#957)
+            [true, ['exception' => new \Exception()], false],
+            [false, ['exception' => new \Exception()], false],
         ];
     }