CR

UPGRADE-3.0.md

@@ -110,8 +110,8 @@
 - Removed the `Stacktrace::toArray()` and `Stacktrace::jsonSerialize()` methods
 - Removed the `SpoolTransport` class and the `SpoolInterface` interface with related implementation
 - Made the `Event::__construct()` method `private`, use the named constructors instead
-- The signature of `ClientInterface::captureEvent` changed to `ClientInterface::captureEvent(Event $event, ?EventHint $hint = null, ?Scope $scope = null)`
-- The signature of `HubInterface::captureEvent` changed to `HubInterface::captureEvent(Event $event, ?EventHint $hint = null)`
-- The signature of `captureEvent` changed to `captureEvent(Event $event, ?EventHint $hint = null)`
-- The signature of `Scope::applyToEvent` changed to `Scope::applyToEvent(Event $event)`
-- Global and scope event processors will no longer receive a second argument, callable should now have the signature `callable(Event $event)`
+- The signature of `ClientInterface::captureEvent()` changed to `ClientInterface::captureEvent(Event $event, ?EventHint $hint = null, ?Scope $scope = null)`
+- The signature of `HubInterface::captureEvent()` changed to `HubInterface::captureEvent(Event $event, ?EventHint $hint = null)`
+- The signature of `captureEvent()` changed to `captureEvent(Event $event, ?EventHint $hint = null)`
+- The signature of `Scope::applyToEvent()` changed to `Scope::applyToEvent(Event $event, ?EventHint $hint = null)`
+- Global and scope event processors will now receive a `EventHint` as the second parameter, callable should now have the signature `callable(Event $event, EventHint $hint)`

src/Client.php

@@ -126,7 +126,6 @@ public function getOptions(): Options
     public function captureMessage(string $message, ?Severity $level = null, ?Scope $scope = null): ?EventId
     {
         $event = Event::createEvent();
-
         $event->setMessage($message);
         $event->setLevel($level);
 
@@ -207,7 +206,7 @@ public function flush(?int $timeout = null): PromiseInterface
      * Assembles an event and prepares it to be sent of to Sentry.
      *
      * @param Event          $event The payload that will be converted to an Event
-     * @param EventHint|null $hint  May contain additional information about the original exception
+     * @param EventHint|null $hint  May contain additional information about the event
      * @param Scope|null     $scope Optional scope which enriches the Event
      *
      * @return Event|null The prepared event object or null if it must be discarded
@@ -243,7 +242,7 @@ private function prepareEvent(Event $event, ?EventHint $hint = null, ?Scope $sco
 
         if (null !== $scope) {
             $previousEvent = $event;
-            $event = $scope->applyToEvent($event);
+            $event = $scope->applyToEvent($event, $hint);
 
             if (null === $event) {
                 $this->logger->info('The event will be discarded because one of the event processors returned "null".', ['event' => $previousEvent]);
@@ -266,17 +265,29 @@ private function prepareEvent(Event $event, ?EventHint $hint = null, ?Scope $sco
      * Optionally adds a missing stacktrace to the Event if the client is configured to do so.
      *
      * @param Event          $event The Event to add the missing stacktrace to
-     * @param EventHint|null $hint  May contain additional information about the original exception
+     * @param EventHint|null $hint  May contain additional information about the event
      */
     private function addMissingStacktraceToEvent(Event $event, ?EventHint $hint): void
     {
-        if ($this->options->shouldAttachStacktrace() && (null === $hint || null === $hint->exception) && null === $event->getStacktrace()) {
-            $event->setStacktrace($this->stacktraceBuilder->buildFromBacktrace(
-                debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS),
-                __FILE__,
-                __LINE__ - 3
-            ));
+        if (!$this->options->shouldAttachStacktrace()) {
+            return;
+        }
+
+        // If the hint contains an exception the stacktrace will be generated for that exception
+        if (null !== $hint && null !== $hint->exception) {
+            return;
         }
+
+        // We should not add a stacktrace when the event already has one or contains exceptions
+        if (null !== $event->getStacktrace() || !empty($event->getExceptions())) {
+            return;
+        }
+
+        $event->setStacktrace($this->stacktraceBuilder->buildFromBacktrace(
+            debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS),
+            __FILE__,
+            __LINE__ - 3
+        ));
     }
 
     /**

src/ClientInterface.php

@@ -48,7 +48,7 @@ public function captureLastError(?Scope $scope = null): ?EventId;
      * Captures a new event using the provided data.
      *
      * @param Event          $event The event being captured
-     * @param EventHint|null $hint  May contain additional information about the original exception
+     * @param EventHint|null $hint  May contain additional information about the event
      * @param Scope|null     $scope An optional scope keeping the state
      */
     public function captureEvent(Event $event, ?EventHint $hint = null, ?Scope $scope = null): ?EventId;

src/EventHint.php

@@ -23,12 +23,20 @@ final class EventHint
      */
     public $stacktrace;
 
+    /**
+     * Any extra data that might be needed to process the event.
+     *
+     * @var array
+     */
+    public $extra = [];
+
     /**
      * Create a EventHint instance from an array of values.
      *
      * @psalm-param array{
      *     exception?: \Throwable,
      *     stacktrace?: Event
+     *     extra?: array
      * } $hintData
      */
     public static function fromArray(array $hintData): self

src/Monolog/Handler.php

@@ -47,7 +47,6 @@ public function __construct(HubInterface $hub, $level = Logger::DEBUG, bool $bub
     protected function write(array $record): void
     {
         $event = Event::createEvent();
-
         $event->setLevel(self::getSeverityFromLevel($record['level']));
         $event->setMessage($record['message']);
         $event->setLogger(sprintf('monolog.%s', $record['channel']));

src/State/HubInterface.php

@@ -90,7 +90,7 @@ public function captureException(\Throwable $exception): ?EventId;
      * Captures a new event using the provided data.
      *
      * @param Event          $event The event being captured
-     * @param EventHint|null $hint  May contain additional information about the original exception
+     * @param EventHint|null $hint  May contain additional information about the event
      */
     public function captureEvent(Event $event, ?EventHint $hint = null): ?EventId;
 

src/State/Scope.php

@@ -6,6 +6,7 @@
 
 use Sentry\Breadcrumb;
 use Sentry\Event;
+use Sentry\EventHint;
 use Sentry\Severity;
 use Sentry\Tracing\Span;
 use Sentry\Tracing\Transaction;
@@ -305,7 +306,7 @@ public function clear(): self
      *
      * @param Event $event The event object that will be enriched with scope data
      */
-    public function applyToEvent(Event $event): ?Event
+    public function applyToEvent(Event $event, ?EventHint $hint = null): ?Event
     {
         $event->setFingerprint(array_merge($event->getFingerprint(), $this->fingerprint));
 
@@ -346,8 +347,13 @@ public function applyToEvent(Event $event): ?Event
             $event->setContext($name, $data);
         }
 
+        // We create a empty `EventHint` instance to allow processors to always recieve a `EventHint` instance even if there wasn't one
+        if (null === $hint) {
+            $hint = new EventHint();
+        }
+
         foreach (array_merge(self::$globalEventProcessors, $this->eventProcessors) as $processor) {
-            $event = $processor($event);
+            $event = $processor($event, $hint);
 
             if (null === $event) {
                 return null;

src/functions.php

@@ -43,8 +43,8 @@ function captureException(\Throwable $exception): ?EventId
 /**
  * Captures a new event using the provided data.
  *
- * @param Event                  $event The event being captured
- * @param \Sentry\EventHint|null $hint  May contain additional information about the original exception
+ * @param Event          $event The event being captured
+ * @param EventHint|null $hint  May contain additional information about the event
  */
 function captureEvent(Event $event, ?EventHint $hint = null): ?EventId
 {

tests/ClientTest.php

@@ -147,7 +147,6 @@ public function testCaptureEvent(): void
             ->getClient();
 
         $event = Event::createEvent();
-
         $event->setTransaction('foo bar');
         $event->setLevel(Severity::debug());
         $event->setLogger('foo');

tests/FunctionsTest.php

@@ -69,14 +69,12 @@ public function testCaptureEvent(): void
     {
         $event = Event::createEvent($eventId = EventId::generate());
 
-        $event->setMessage('foo');
-
         /** @var ClientInterface|MockObject $client */
         $client = $this->createMock(ClientInterface::class);
         $client->expects($this->once())
-               ->method('captureEvent')
-               ->with($event)
-               ->willReturn($eventId);
+            ->method('captureEvent')
+            ->with($event)
+            ->willReturn($eventId);
 
         SentrySdk::getCurrentHub()->bindClient($client);
 

tests/Integration/TransactionIntegrationTest.php

@@ -52,14 +52,11 @@ public function setupOnceDataProvider(): \Generator
             null,
         ];
 
-        yield [
-            (static function () {
-                $event = Event::createEvent();
-
-                $event->setTransaction('/foo/bar');
+        $event = Event::createEvent();
+        $event->setTransaction('/foo/bar');
 
-                return $event;
-            })(),
+        yield [
+            $event,
             true,
             [],
             '/foo/bar',