✨ Include route in scope to allow middleware and other tools to extract its information

[tiangolo]

This is useful, in particular, for external tools handling errors, logs, observability, etc. like Sentry.

There's a counterpart PR in Sentry: getsentry/sentry-python#1349

---

If you need this now, you can update Sentry's middleware like this:

from typing import TYPE_CHECKING, Any, Optional

from fastapi import FastAPI
from fastapi.routing import APIRoute
from sentry_sdk.integrations.asgi import SentryAsgiMiddleware

if TYPE_CHECKING:
    from sentry_sdk._types import Event, Hint

app = FastAPI()


class CustomSentryAsgiMiddleware(SentryAsgiMiddleware):
    def event_processor(
        self, event: "Event", hint: "Hint", asgi_scope: Any
    ) -> "Optional[Event]":
        result_event = super().event_processor(event, hint, asgi_scope)
        route: Optional[APIRoute] = asgi_scope.get("route")
        if route and result_event:
            result_event["transaction"] = route.path
        return result_event


app.add_middleware(CustomSentryAsgiMiddleware)

[codecov]

Codecov Report

Merging #4603 (c5d8244) into master (1ce16c2) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master     #4603   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          525       526    +1     
  Lines        13281     13324   +43     
=========================================
+ Hits         13281     13324   +43     

Impacted Files	Coverage Δ
fastapi/routing.py	100.00% <100.00%> (ø)
tests/test_route_scope.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1ce16c2...c5d8244. Read the comment docs.

[github-actions]

🚀 Deployed on https://6213b498aee6da32925aeee1--fastapi.netlify.app

[github-actions]

📝 Docs preview for commit c5d8244 at: https://6213b4d698b17b2fc529aaeb--fastapi.netlify.app