fix(spotlight): Use the spotlight_url passed into the SDK when loading Spotlight (#3871)

BYK · sentrivana · web-flow · commit 81b806321fed · 2024-12-14T00:55:25.000Z
When we inject spotlight, we don't set the correct sidecar URL. This is an issue when a user defines a custom sidecar URL where we are able to load Spotlight UI from the correct URL but don't tell it the correct sidecar URL, making it non-functional.

---------

Co-authored-by: Ivana Kellyer &lt;ivana.kellyer@sentry.io&gt;
diff --git a/sentry_sdk/spotlight.py b/sentry_sdk/spotlight.py
@@ -66,7 +66,8 @@ def capture_envelope(self, envelope):
 
     SPOTLIGHT_JS_ENTRY_PATH = "/assets/main.js"
     SPOTLIGHT_JS_SNIPPET_PATTERN = (
-        '<script type="module" crossorigin src="{}"></script>'
+        "<script>window.__spotlight = {{ initOptions: {{ sidecarUrl: '{spotlight_url}', fullPage: false }} }};</script>\n"
+        '<script type="module" crossorigin src="{spotlight_js_url}"></script>\n'
     )
     SPOTLIGHT_ERROR_PAGE_SNIPPET = (
         '<html><base href="{spotlight_url}">\n'
@@ -113,7 +114,8 @@ def spotlight_script(self):
                     )
                     urllib.request.urlopen(req)
                     self._spotlight_script = SPOTLIGHT_JS_SNIPPET_PATTERN.format(
-                        spotlight_js_url
+                        spotlight_url=self._spotlight_url,
+                        spotlight_js_url=spotlight_js_url,
                     )
                 except urllib.error.URLError as err:
                     sentry_logger.debug(

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,8 @@ def capture_envelope(self, envelope):`
`66`	`66`
`67`	`67`	`SPOTLIGHT_JS_ENTRY_PATH = "/assets/main.js"`
`68`	`68`	`SPOTLIGHT_JS_SNIPPET_PATTERN = (`
`69`		`- '<script type="module" crossorigin src="{}"></script>'`
	`69`	`+ "<script>window.__spotlight = {{ initOptions: {{ sidecarUrl: '{spotlight_url}', fullPage: false }} }};</script>\n"`
	`70`	`+ '<script type="module" crossorigin src="{spotlight_js_url}"></script>\n'`
`70`	`71`	`)`
`71`	`72`	`SPOTLIGHT_ERROR_PAGE_SNIPPET = (`
`72`	`73`	`'<html><base href="{spotlight_url}">\n'`
`@@ -113,7 +114,8 @@ def spotlight_script(self):`
`113`	`114`	`)`
`114`	`115`	`urllib.request.urlopen(req)`
`115`	`116`	`self._spotlight_script = SPOTLIGHT_JS_SNIPPET_PATTERN.format(`
`116`		`- spotlight_js_url`
	`117`	`+ spotlight_url=self._spotlight_url,`
	`118`	`+ spotlight_js_url=spotlight_js_url,`
`117`	`119`	`)`
`118`	`120`	`except urllib.error.URLError as err:`
`119`	`121`	`sentry_logger.debug(`