Fix and tests

sentry_sdk/client.py

@@ -269,6 +269,7 @@ def _capture_envelope(envelope):
                 ],
             )
 
+            self.spotlight = None
             if self.options["spotlight"]:
                 self.spotlight = setup_spotlight(self.options)
 

sentry_sdk/spotlight.py

@@ -36,22 +36,16 @@ def capture_envelope(self, envelope):
             logger.exception(str(e))
 
 
-instance = None
-
-
 def setup_spotlight(options):
     # type: (Dict[str, Any]) -> Optional[SpotlightSidecar]
-    global instance
 
-    if instance is None:
-        url = options["spotlight"]
-        if isinstance(url, str):
-            pass
-        elif url is True:
-            url = "http://localhost:8969/stream"
-        else:
-            return None
+    url = options["spotlight"]
 
-        instance = SpotlightSidecar(url)
+    if isinstance(url, str):
+        pass
+    elif url is True:
+        url = "http://localhost:8969/stream"
+    else:
+        return None
 
-    return instance
+    return SpotlightSidecar(url)

tests/test_spotlight.py

@@ -1,18 +1,56 @@
 import pytest
 
-from sentry_sdk import Client
+from sentry_sdk import Hub, capture_exception
 
 
-def test_send_to_spotlight(make_client):
-    client = make_client(
-        spotlight=False,
-    )
-    assert client.spotlight is None
+@pytest.fixture
+def capture_spotlight_envelopes(monkeypatch):
+    def inner():
+        envelopes = []
+        test_spotlight = Hub.current.client.spotlight
+        old_capture_envelope = test_spotlight.capture_envelope
 
+        def append_envelope(envelope):
+            envelopes.append(envelope)
+            return old_capture_envelope(envelope)
 
-@pytest.fixture
-def make_client(request):
-    def inner(**kwargs):
-        return Client("http://foobar@test.com/132", **kwargs)
+        monkeypatch.setattr(test_spotlight, "capture_envelope", append_envelope)
+        return envelopes
 
     return inner
+
+
+def test_spotlight_off_by_default(sentry_init):
+    sentry_init()
+    assert Hub.current.client.spotlight is None
+
+
+def test_spotlight_default_url(sentry_init):
+    sentry_init(spotlight=True)
+
+    spotlight = Hub.current.client.spotlight
+    assert spotlight is not None
+    assert spotlight.url == "http://localhost:8969/stream"
+
+
+def test_spotlight_custom_url(sentry_init):
+    sentry_init(spotlight="http://foobar@test.com/132")
+
+    spotlight = Hub.current.client.spotlight
+    assert spotlight is not None
+    assert spotlight.url == "http://foobar@test.com/132"
+
+
+def test_spotlight_envelope(sentry_init, capture_spotlight_envelopes):
+    sentry_init(spotlight=True)
+    envelopes = capture_spotlight_envelopes()
+
+    try:
+        raise ValueError("aha!")
+    except Exception:
+        capture_exception()
+
+    (envelope,) = envelopes
+    payload = envelope.items[0].payload.json
+
+    assert payload["exception"]["values"][0]["value"] == "aha!"

tox.ini

@@ -623,7 +623,7 @@ basepython =
     # some random Python 3 binary, but then you get guaranteed mismatches with
     # CI. Other tools such as mypy and black have options that pin the Python
     # version.
-    linters: python3.12
+    linters: python3.11
 
 commands =
     {py3.7,py3.8}-boto3: pip install urllib3<2.0.0