fix(starlette): Stop duplicating scope["root_path"] in URLs

sentry_sdk/integrations/_asgi_common.py

@@ -32,14 +32,19 @@
     asgi_scope: "Dict[str, Any]",
     default_scheme: "Literal['ws', 'http']",
     host: "Optional[Union[AnnotatedValue, str]]",
+    path_includes_root_path: "bool" = True,
 ) -> str:
     """
     Extract URL from the ASGI scope, without also including the querystring.
     """
     scheme = asgi_scope.get("scheme", default_scheme)
 
     server = asgi_scope.get("server", None)
-    path = asgi_scope.get("root_path", "") + asgi_scope.get("path", "")
+    path = (
+        asgi_scope.get("path", "")
+        if path_includes_root_path
+        else asgi_scope.get("root_path", "") + asgi_scope.get("path", "")
+    )
 
     if host:
         return "%s://%s%s" % (scheme, host, path)
@@ -81,7 +86,9 @@
     return asgi_scope.get("client")[0]
 
 
-def _get_request_data(asgi_scope: "Any") -> "Dict[str, Any]":
+def _get_request_data(
+    asgi_scope: "Any", path_includes_root_path: "bool" = True
+) -> "Dict[str, Any]":
     """
     Returns data related to the HTTP request from the ASGI scope.
     """
@@ -96,7 +103,10 @@
         request_data["query_string"] = _get_query(asgi_scope)
 
         request_data["url"] = _get_url(
-            asgi_scope, "http" if ty == "http" else "ws", headers.get("host")
+            asgi_scope,
+            "http" if ty == "http" else "ws",
+            headers.get("host"),
+            path_includes_root_path=path_includes_root_path,
         )
 
     client = asgi_scope.get("client")
@@ -106,7 +116,9 @@
     return request_data
 
 
-def _get_request_attributes(asgi_scope: "Any") -> "dict[str, Any]":
+def _get_request_attributes(
+    asgi_scope: "Any", path_includes_root_path: "bool" = True
+) -> "dict[str, Any]":
     """
     Return attributes related to the HTTP request from the ASGI scope.
     """
@@ -127,12 +139,15 @@
                 attributes["http.query"] = query
 
             url_without_query_string = _get_url(
-                asgi_scope, "http" if ty == "http" else "ws", headers.get("host")
+                asgi_scope,
+                "http" if ty == "http" else "ws",
+                headers.get("host"),
+                path_includes_root_path=path_includes_root_path,
             )
             query_string = _get_query(asgi_scope)
             attributes["url.full"] = (
                 f"{url_without_query_string}?{query_string}"
                 if query_string is not None
                 else url_without_query_string
             )
 

sentry_sdk/integrations/asgi.py

@@ -105,6 +105,7 @@
         "mechanism_type",
         "span_origin",
         "http_methods_to_capture",
+        "path_includes_root_path",
     )
 
     def __init__(
@@ -116,6 +117,7 @@
         span_origin: str = "manual",
         http_methods_to_capture: "Tuple[str, ...]" = DEFAULT_HTTP_METHODS_TO_CAPTURE,
         asgi_version: "Optional[int]" = None,
+        path_includes_root_path: bool = True,
     ) -> None:
         """
         Instrument an ASGI application with Sentry. Provides HTTP/websocket
@@ -148,10 +150,11 @@
             )
 
         self.transaction_style = transaction_style
         self.mechanism_type = mechanism_type
         self.span_origin = span_origin
         self.app = app
         self.http_methods_to_capture = http_methods_to_capture
+        self.path_includes_root_path = path_includes_root_path
 
         if asgi_version is None:
             if _looks_like_asgi3(app):
@@ -319,7 +322,8 @@
                     with span_ctx as span:
                         if isinstance(span, StreamedSpan):
                             for attribute, value in _get_request_attributes(
-                                scope
+                                scope,
+                                path_includes_root_path=self.path_includes_root_path,
                             ).items():
                                 span.set_attribute(attribute, value)
 
@@ -401,7 +405,11 @@
         self, event: "Event", hint: "Hint", asgi_scope: "Any"
     ) -> "Optional[Event]":
         request_data = event.get("request", {})
-        request_data.update(_get_request_data(asgi_scope))
+        request_data.update(
+            _get_request_data(
+                asgi_scope, path_includes_root_path=self.path_includes_root_path
+            )
+        )
         event["request"] = deepcopy(request_data)
 
         # Only set transaction name if not already set by Starlette or FastAPI (or other frameworks)
@@ -447,7 +455,12 @@
             if endpoint:
                 name = transaction_from_function(endpoint) or ""
             else:
-                name = _get_url(asgi_scope, "http" if ty == "http" else "ws", host=None)
+                name = _get_url(
+                    asgi_scope,
+                    "http" if ty == "http" else "ws",
+                    host=None,
+                    path_includes_root_path=self.path_includes_root_path,
+                )
                 source = TransactionSource.URL
 
         elif transaction_style == "url":
@@ -459,7 +472,12 @@
                 if path is not None:
                     name = path
             else:
-                name = _get_url(asgi_scope, "http" if ty == "http" else "ws", host=None)
+                name = _get_url(
+                    asgi_scope,
+                    "http" if ty == "http" else "ws",
+                    host=None,
+                    path_includes_root_path=self.path_includes_root_path,
+                )
                 source = TransactionSource.URL
 
         if name is None:
@@ -484,7 +502,12 @@
             if endpoint:
                 name = qualname_from_function(endpoint) or ""
             else:
-                name = _get_url(asgi_scope, "http" if ty == "http" else "ws", host=None)
+                name = _get_url(
+                    asgi_scope,
+                    "http" if ty == "http" else "ws",
+                    host=None,
+                    path_includes_root_path=self.path_includes_root_path,
+                )
                 source = SegmentSource.URL.value
 
         elif segment_style == "url":
@@ -496,7 +519,12 @@
                 if path is not None:
                     name = path
             else:
-                name = _get_url(asgi_scope, "http" if ty == "http" else "ws", host=None)
+                name = _get_url(
+                    asgi_scope,
+                    "http" if ty == "http" else "ws",
+                    host=None,
+                    path_includes_root_path=self.path_includes_root_path,
+                )
                 source = SegmentSource.URL.value
 
         if name is None:

sentry_sdk/integrations/django/asgi.py

@@ -96,6 +96,7 @@ async def sentry_patched_asgi_handler(
             unsafe_context_data=True,
             span_origin=DjangoIntegration.origin,
             http_methods_to_capture=integration.http_methods_to_capture,
+            path_includes_root_path=False,
         )._run_asgi3
 
         return await middleware(scope, receive, send)

sentry_sdk/integrations/litestar.py

@@ -92,6 +92,7 @@
             mechanism_type="asgi",
             span_origin=span_origin,
             asgi_version=3,
+            path_includes_root_path=False,
         )
 
     def _capture_request_exception(self, exc: Exception) -> None:

sentry_sdk/integrations/quart.py

@@ -96,6 +96,7 @@
             lambda *a, **kw: old_app(self, *a, **kw),
             span_origin=QuartIntegration.origin,
             asgi_version=3,
+            path_includes_root_path=False,
         )
         return await middleware(scope, receive, send)
 

sentry_sdk/integrations/starlette.py

@@ -143,7 +143,10 @@
             )
 
         patch_middlewares()
-        patch_asgi_app()
+        # Starlette's Mount includes scope["root_path"] in scope["path"] starting with:
+        # https://github.com/Kludex/starlette/commit/e8f0dcd54e4ceec47e02c45f5275374e292339ad.
+        path_includes_root_path = version >= (0, 33)
+        patch_asgi_app(path_includes_root_path=path_includes_root_path)
         patch_request_response()
 
         if version >= (0, 24):
@@ -427,7 +430,7 @@
         Middleware.__init__ = _sentry_middleware_init
 
 
-def patch_asgi_app() -> None:
+def patch_asgi_app(path_includes_root_path: "bool") -> None:
     """
     Instrument Starlette ASGI app using the SentryAsgiMiddleware.
     """
@@ -451,6 +454,7 @@
                 else DEFAULT_HTTP_METHODS_TO_CAPTURE
             ),
             asgi_version=3,
+            path_includes_root_path=path_includes_root_path,
         )
 
         return await middleware(scope, receive, send)

tests/integrations/fastapi/test_fastapi.py

@@ -62,6 +62,7 @@
 
 def fastapi_app_factory():
     app = FastAPI()
+    mounted_app = FastAPI()
 
     @app.get("/error")
     async def _error():
@@ -74,6 +75,7 @@
         capture_message("Hi")
         return {"message": "Hi"}
 
+    @mounted_app.get("/nomessage")
     @app.delete("/nomessage")
     @app.get("/nomessage")
     @app.head("/nomessage")
@@ -117,7 +119,9 @@
     ):
         capture_message("hi")
         return {"status": "ok"}
 
+    app.mount("/root", mounted_app)
+
     return app
 
 
@@ -1043,6 +1047,47 @@
     assert event2["request"]["method"] == "HEAD"
 
 
+@pytest.mark.parametrize("span_streaming", [True, False])
+def test_request_url(sentry_init, capture_events, capture_items, span_streaming):
+    sentry_init(
+        traces_sample_rate=1.0,
+        send_default_pii=True,
+        integrations=[
+            StarletteIntegration(),
+        ],
+        _experiments={
+            "trace_lifecycle": "stream" if span_streaming else "static",
+        },
+    )
+
+    starlette_app = fastapi_app_factory()
+
+    client = TestClient(starlette_app)
+
+    if span_streaming:
+        items = capture_items("span")
+
+        client.get("/root/nomessage")
+        sentry_sdk.flush()
+        spans = [item.payload for item in items]
+
+        (server_span,) = (
+            span
+            for span in spans
+            if span["attributes"].get("sentry.op") == "http.server"
+        )
+        assert server_span["attributes"]["url.full"] == (
+            "http://testserver/root/nomessage"
+        )
+    else:
+        events = capture_events()
+
+        client.get("/root/nomessage")
+
+        (event,) = events
+        assert event["request"]["url"] == "http://testserver/root/nomessage"
+
+
 @parametrize_test_configurable_status_codes
 def test_configurable_status_codes(
     sentry_init,

tests/integrations/starlette/test_starlette.py

@@ -146,6 +146,12 @@
         "TRACE",
     ]
 
+    mounted_app = starlette.applications.Starlette(
+        routes=[
+            starlette.routing.Route("/nomessage", _nomessage, methods=all_methods),
+        ],
+    )
+
     app = starlette.applications.Starlette(
         debug=debug,
         routes=[
@@ -160,6 +166,7 @@
             starlette.routing.Route("/body/json", _body_json, methods=["POST"]),
             starlette.routing.Route("/body/form", _body_form, methods=["POST"]),
             starlette.routing.Route("/body/raw", _body_raw, methods=["POST"]),
+            starlette.routing.Mount("/root", app=mounted_app),
         ],
         middleware=middleware,
     )
@@ -1477,6 +1484,47 @@
     assert event["request"]["method"] == "GET"
 
 
+@pytest.mark.parametrize("span_streaming", [True, False])
+def test_request_url(sentry_init, capture_events, capture_items, span_streaming):
+    sentry_init(
+        traces_sample_rate=1.0,
+        send_default_pii=True,
+        integrations=[
+            StarletteIntegration(),
+        ],
+        _experiments={
+            "trace_lifecycle": "stream" if span_streaming else "static",
+        },
+    )
+
+    starlette_app = starlette_app_factory()
+
+    client = TestClient(starlette_app)
+
+    if span_streaming:
+        items = capture_items("span")
+
+        client.get("/root/nomessage")
+        sentry_sdk.flush()
+        spans = [item.payload for item in items]
+
+        (server_span,) = (
+            span
+            for span in spans
+            if span["attributes"].get("sentry.op") == "http.server"
+        )
+        assert server_span["attributes"]["url.full"] == (
+            "http://testserver/root/nomessage"
+        )
+    else:
+        events = capture_events()
+
+        client.get("/root/nomessage")
+
+        (event,) = events
+        assert event["request"]["url"] == "http://testserver/root/nomessage"
+
+
 @pytest.mark.skipif(
     STARLETTE_VERSION < (0, 21),
     reason="Requires Starlette >= 0.21, because earlier versions do not support HTTP 'HEAD' requests",