fix(asgi): Stop duplicating root_path in URLs#6579
fix(asgi): Stop duplicating root_path in URLs#6579alexander-alderman-webb wants to merge 1 commit into
Conversation
| 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", "") |
There was a problem hiding this comment.
Default path_includes_root_path=True silently drops root_path from request URLs in _get_request_data and _get_request_attributes
The new default path_includes_root_path=True causes every unparameterised _get_url() call to omit root_path from the URL. Both _get_request_data (line 103) and _get_request_attributes (line 132) call _get_url without this argument, so the request.url and url.full fields in Sentry events will now be missing the root path prefix for Starlette versions < 0.33 (and any plain-ASGI app) where path does not already embed root_path.
Evidence
- Before this change,
pathwas always built asroot_path + path; now withpath_includes_root_path=True(the new default) onlyasgi_scope.get("path", "")is used. _get_request_data(line 103) and_get_request_attributes(line 132) call_get_urlwith nopath_includes_root_pathargument, inheriting the new defaultTrue.SentryAsgiMiddlewarecorrectly threadsself.path_includes_root_paththrough its own_get_urlcalls, but_get_request_data/_get_request_attributeshave no access to that flag.- For Starlette < 0.33,
patch_asgi_apppassespath_includes_root_path=Falseto the middleware, meaning the framework itself knowspathdoesn't containroot_path, yet the event-level URL functions still assume it does. - The result is that
event["request"]["url"]andspan.attributes["url.full"]will be missing the mount prefix for any deployment that sets a non-emptyroot_pathon Starlette < 0.33 or a bare ASGI server.
Also found at 2 additional locations
sentry_sdk/integrations/starlette.py:144-147sentry_sdk/integrations/starlette.py:452-455
Identified by Warden code-review · YAE-94S
Codecov Results 📊✅ 90848 passed | ⏭️ 6037 skipped | Total: 96885 | Pass Rate: 93.77% | Execution Time: 315m 51s 📊 Comparison with Base Branch
✨ No test changes detected All tests are passing successfully. ✅ Patch coverage is 100.00%. Project has 2421 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 89.75% 89.76% +0.01%
==========================================
Files 192 192 —
Lines 23630 23632 +2
Branches 8134 8134 —
==========================================
+ Hits 21208 21211 +3
- Misses 2422 2421 -1
- Partials 1341 1340 -1Generated by Codecov Action |
Description
Issues
Closes #6577
Reminders
uv run ruff.feat:,fix:,ref:,meta:)