Skip to content

Commit f266415

Browse files
antonpirkerantonpirker
committed
Merge branch 'master' into potel-base
2 parents b65b742 + 00f8140 commit f266415

File tree

3 files changed

+106
-2
lines changed

3 files changed

+106
-2
lines changed

‎sentry_sdk/client.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@
5858
from sentry_sdk.integrations import Integration
5959
from sentry_sdk.scope import Scope
6060
from sentry_sdk.session import Session
61+
from sentry_sdk.spotlight import SpotlightClient
6162
from sentry_sdk.transport import Transport
6263

6364
I = TypeVar("I", bound=Integration) # noqa: E741
@@ -139,6 +140,8 @@ class BaseClient:
139140
The basic definition of a client that is used for sending data to Sentry.
140141
"""
141142

143+
spotlight = None # type: Optional[SpotlightClient]
144+
142145
def __init__(self, options=None):
143146
# type: (Optional[Dict[str, Any]]) -> None
144147
self.options = (
@@ -337,7 +340,6 @@ def _capture_envelope(envelope):
337340
disabled_integrations=self.options["disabled_integrations"],
338341
)
339342

340-
self.spotlight = None
341343
spotlight_config = self.options.get("spotlight")
342344
if spotlight_config is None and "SENTRY_SPOTLIGHT" in os.environ:
343345
spotlight_env_value = os.environ["SENTRY_SPOTLIGHT"]

‎sentry_sdk/spotlight.py‎

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
import io
2+
import os
3+
import urllib.parse
4+
import urllib.request
5+
import urllib.error
26
import urllib3
37

48
from typing import TYPE_CHECKING
59

610
if TYPE_CHECKING:
711
from typing import Any
12+
from typing import Callable
813
from typing import Dict
914
from typing import Optional
1015

11-
from sentry_sdk.utils import logger
16+
from sentry_sdk.utils import logger, env_to_bool
1217
from sentry_sdk.envelope import Envelope
1318

1419

@@ -46,6 +51,47 @@ def capture_envelope(self, envelope):
4651
logger.warning(str(e))
4752

4853

54+
try:
55+
from django.http import HttpResponseServerError
56+
from django.conf import settings
57+
58+
class SpotlightMiddleware:
59+
def __init__(self, get_response):
60+
# type: (Any, Callable[..., Any]) -> None
61+
self.get_response = get_response
62+
63+
def __call__(self, request):
64+
# type: (Any, Any) -> Any
65+
return self.get_response(request)
66+
67+
def process_exception(self, _request, exception):
68+
# type: (Any, Any, Exception) -> Optional[HttpResponseServerError]
69+
if not settings.DEBUG:
70+
return None
71+
72+
import sentry_sdk.api
73+
74+
spotlight_client = sentry_sdk.api.get_client().spotlight
75+
if spotlight_client is None:
76+
return None
77+
78+
# Spotlight URL has a trailing `/stream` part at the end so split it off
79+
spotlight_url = spotlight_client.url.rsplit("/", 1)[0]
80+
81+
try:
82+
spotlight = (
83+
urllib.request.urlopen(spotlight_url).read().decode("utf-8")
84+
).replace("<html>", f'<html><base href="{spotlight_url}">')
85+
except urllib.error.URLError:
86+
return None
87+
else:
88+
sentry_sdk.api.capture_exception(exception)
89+
return HttpResponseServerError(spotlight)
90+
91+
except ImportError:
92+
settings = None
93+
94+
4995
def setup_spotlight(options):
5096
# type: (Dict[str, Any]) -> Optional[SpotlightClient]
5197

@@ -58,4 +104,9 @@ def setup_spotlight(options):
58104
else:
59105
return None
60106

107+
if settings is not None and env_to_bool(
108+
os.environ.get("SENTRY_SPOTLIGHT_ON_ERROR", "1")
109+
):
110+
settings.MIDDLEWARE.append("sentry_sdk.spotlight.SpotlightMiddleware")
111+
61112
return SpotlightClient(url)

‎tests/integrations/django/test_basic.py‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1250,3 +1250,54 @@ def test_transaction_http_method_custom(sentry_init, client, capture_events):
12501250
(event1, event2) = events
12511251
assert event1["request"]["method"] == "OPTIONS"
12521252
assert event2["request"]["method"] == "HEAD"
1253+
1254+
1255+
def test_ensures_spotlight_middleware_when_spotlight_is_enabled(sentry_init, settings):
1256+
"""
1257+
Test that ensures if Spotlight is enabled, relevant SpotlightMiddleware
1258+
is added to middleware list in settings.
1259+
"""
1260+
original_middleware = frozenset(settings.MIDDLEWARE)
1261+
1262+
sentry_init(integrations=[DjangoIntegration()], spotlight=True)
1263+
1264+
added = frozenset(settings.MIDDLEWARE) ^ original_middleware
1265+
1266+
assert "sentry_sdk.spotlight.SpotlightMiddleware" in added
1267+
1268+
1269+
def test_ensures_no_spotlight_middleware_when_env_killswitch_is_false(
1270+
monkeypatch, sentry_init, settings
1271+
):
1272+
"""
1273+
Test that ensures if Spotlight is enabled, but is set to a falsy value
1274+
the relevant SpotlightMiddleware is NOT added to middleware list in settings.
1275+
"""
1276+
monkeypatch.setenv("SENTRY_SPOTLIGHT_ON_ERROR", "no")
1277+
1278+
original_middleware = frozenset(settings.MIDDLEWARE)
1279+
1280+
sentry_init(integrations=[DjangoIntegration()], spotlight=True)
1281+
1282+
added = frozenset(settings.MIDDLEWARE) ^ original_middleware
1283+
1284+
assert "sentry_sdk.spotlight.SpotlightMiddleware" not in added
1285+
1286+
1287+
def test_ensures_no_spotlight_middleware_when_no_spotlight(
1288+
monkeypatch, sentry_init, settings
1289+
):
1290+
"""
1291+
Test that ensures if Spotlight is not enabled
1292+
the relevant SpotlightMiddleware is NOT added to middleware list in settings.
1293+
"""
1294+
# We should NOT have the middleware even if the env var is truthy if Spotlight is off
1295+
monkeypatch.setenv("SENTRY_SPOTLIGHT_ON_ERROR", "1")
1296+
1297+
original_middleware = frozenset(settings.MIDDLEWARE)
1298+
1299+
sentry_init(integrations=[DjangoIntegration()], spotlight=False)
1300+
1301+
added = frozenset(settings.MIDDLEWARE) ^ original_middleware
1302+
1303+
assert "sentry_sdk.spotlight.SpotlightMiddleware" not in added

0 commit comments

Comments
 (0)