fix: Open relevant error when SpotlightMiddleware is on (#3614)

BYK · web-flow · commit a31c54f86eea · 2024-10-07T12:53:48.000Z
This fixes an issue with the recent SpotlightMiddleware patch where the error triggered the page was not highlighted/opened automatically. It changes the semapics of `capture_event` and methods depending on this a bit: we now return the event_id if the error is sent to spotlight even if it was not sent upstream to Sentry servers.
diff --git a/sentry_sdk/client.py b/sentry_sdk/client.py
@@ -753,18 +753,16 @@ def capture_event(
 
         :returns: An event ID. May be `None` if there is no DSN set or of if the SDK decided to discard the event for other reasons. In such situations setting `debug=True` on `init()` may help.
         """
-        if hint is None:
-            hint = {}
-        event_id = event.get("event_id")
         hint = dict(hint or ())  # type: Hint
 
-        if event_id is None:
-            event["event_id"] = event_id = uuid.uuid4().hex
         if not self._should_capture(event, hint, scope):
             return None
 
         profile = event.pop("profile", None)
 
+        event_id = event.get("event_id")
+        if event_id is None:
+            event["event_id"] = event_id = uuid.uuid4().hex
         event_opt = self._prepare_event(event, hint, scope)
         if event_opt is None:
             return None
@@ -812,15 +810,16 @@ def capture_event(
         for attachment in attachments or ():
             envelope.add_item(attachment.to_envelope_item())
 
+        return_value = None
         if self.spotlight:
             self.spotlight.capture_envelope(envelope)
+            return_value = event_id
 
-        if self.transport is None:
-            return None
-
-        self.transport.capture_envelope(envelope)
+        if self.transport is not None:
+            self.transport.capture_envelope(envelope)
+            return_value = event_id
 
-        return event_id
+        return return_value
 
     def capture_session(
         self, session  # type: Session
diff --git a/sentry_sdk/spotlight.py b/sentry_sdk/spotlight.py
@@ -79,14 +79,22 @@ def process_exception(self, _request, exception):
             spotlight_url = spotlight_client.url.rsplit("/", 1)[0]
 
             try:
-                spotlight = (
-                    urllib.request.urlopen(spotlight_url).read().decode("utf-8")
-                ).replace("<html>", f'<html><base href="{spotlight_url}">')
+                spotlight = urllib.request.urlopen(spotlight_url).read().decode("utf-8")
             except urllib.error.URLError:
                 return None
             else:
-                sentry_sdk.api.capture_exception(exception)
-                return HttpResponseServerError(spotlight)
+                event_id = sentry_sdk.api.capture_exception(exception)
+                return HttpResponseServerError(
+                    spotlight.replace(
+                        "<html>",
+                        (
+                            f'<html><base href="{spotlight_url}">'
+                            '<script>window.__spotlight = {{ initOptions: {{ startFrom: "/errors/{event_id}" }}}};</script>'.format(
+                                event_id=event_id
+                            )
+                        ),
+                    )
+                )
 
 except ImportError:
     settings = None
