Added route to request scope

Author: mongkok

debug_toolbar/middleware.py

@@ -15,7 +15,7 @@
 from debug_toolbar.api import render_panel
 from debug_toolbar.settings import DebugToolbarSettings
 from debug_toolbar.toolbar import DebugToolbar
-from debug_toolbar.utils import import_string
+from debug_toolbar.utils import import_string, matched_route
 
 
 def show_toolbar(request: Request, settings: DebugToolbarSettings) -> bool:
@@ -60,8 +60,11 @@ async def dispatch(
         request: Request,
         call_next: RequestResponseEndpoint,
     ) -> Response:
+        request.scope["route"] = matched_route(request)
+
         if (
-            not self.show_toolbar(request, self.settings)
+            not request.scope["route"]
+            or not self.show_toolbar(request, self.settings)
             or self.settings.API_URL in request.url.path
         ):
             return await call_next(request)

debug_toolbar/panels/logging.py

@@ -7,7 +7,7 @@
 
 from debug_toolbar.panels import Panel
 from debug_toolbar.types import Stats
-from debug_toolbar.utils import is_coroutine, matched_endpoint, pluralize
+from debug_toolbar.utils import is_coroutine, pluralize
 
 try:
     import threading
@@ -92,12 +92,7 @@ def nav_subtitle(self) -> str:
         return f"{record_count} message{pluralize(record_count)}"
 
     async def process_request(self, request: Request) -> Response:
-        endpoint = matched_endpoint(request)
-
-        if endpoint is None:
-            return await super().process_request(request)
-
-        if is_coroutine(endpoint):
+        if is_coroutine(request.scope["route"].endpoint):
             self.thread_id = threading.get_ident()
         else:
             self.thread_id = await run_in_threadpool(threading.get_ident)

debug_toolbar/panels/profiling.py

@@ -6,7 +6,7 @@
 
 from debug_toolbar.panels import Panel
 from debug_toolbar.types import Stats
-from debug_toolbar.utils import is_coroutine, matched_endpoint
+from debug_toolbar.utils import is_coroutine
 
 
 class ProfilingPanel(Panel):
@@ -15,12 +15,7 @@ class ProfilingPanel(Panel):
 
     async def process_request(self, request: Request) -> Response:
         self.profiler = Profiler(**self.toolbar.settings.PROFILER_OPTIONS)
-        endpoint = matched_endpoint(request)
-
-        if endpoint is None:
-            return await super().process_request(request)
-
-        is_async = is_coroutine(endpoint)
+        is_async = is_coroutine(request.scope["route"].endpoint)
 
         async def call(func: t.Callable) -> None:
             await run_in_threadpool(func) if not is_async else func()

debug_toolbar/panels/sqlalchemy.py

@@ -4,14 +4,12 @@
 from fastapi import Request, Response
 from fastapi.concurrency import AsyncExitStack
 from fastapi.dependencies.utils import solve_dependencies
-from fastapi.routing import APIRoute
 from sqlalchemy import event
 from sqlalchemy.engine import Connection, Engine
 from sqlalchemy.engine.default import DefaultExecutionContext
 from sqlalchemy.orm import Session
 
 from debug_toolbar.panels.sql import SQLPanel
-from debug_toolbar.utils import matched_route
 
 
 class SQLAlchemyPanel(SQLPanel):
@@ -55,11 +53,9 @@ def after_execute(
 
     async def process_request(self, request: Request) -> Response:
         engines: t.Set[Engine] = set()
-        route = matched_route(request)
+        route = request.scope["route"]
 
         if hasattr(route, "dependant"):
-            route = t.cast(APIRoute, route)
-
             if request.scope.get("fastapi_astack") is None:
                 async with AsyncExitStack() as stack:
                     request.scope["fastapi_astack"] = stack

debug_toolbar/utils.py

@@ -8,7 +8,6 @@
 from fastapi.routing import APIRoute
 from pydantic.color import Color
 from starlette.routing import Match
-from starlette.staticfiles import StaticFiles
 
 
 def import_string(import_name: str) -> t.Any:
@@ -43,20 +42,11 @@ def get_name_from_obj(obj: t.Any) -> str:
 def matched_route(request: Request) -> t.Optional[APIRoute]:
     for route in request.app.routes:
         match, _ = route.matches(request.scope)
-        if match == Match.FULL:
-            return route
-    return None
-
 
-def matched_endpoint(request: Request) -> t.Optional[t.Callable]:
-    route = matched_route(request)
-    if route is not None:
-        endpoint = getattr(route, "endpoint", None)
-
-        if endpoint is not None:
-            return endpoint
-        if not isinstance(route.app, StaticFiles):
-            return route.app
+        if match == Match.FULL:
+            if hasattr(route, "endpoint"):
+                return route
+            break
     return None