backport should_bypass_for_scope

Author: provinzkraut

litestar/middleware/_utils.py

@@ -44,6 +44,15 @@ def build_exclude_path_pattern(
         ) from e
 
 
+def should_bypass_for_path_pattern(scope: Scope, pattern: Pattern | None = None) -> bool:
+    return bool(
+        pattern
+        and pattern.findall(
+            scope["raw_path"].decode() if getattr(scope.get("route_handler", {}), "is_mount", False) else scope["path"]
+        )
+    )
+
+
 def should_bypass_middleware(
     *,
     exclude_http_methods: Sequence[Method] | None = None,
@@ -73,9 +82,4 @@ def should_bypass_middleware(
     if exclude_http_methods and scope.get("method") in exclude_http_methods:
         return True
 
-    return bool(
-        exclude_path_pattern
-        and exclude_path_pattern.findall(
-            scope["raw_path"].decode() if getattr(scope.get("route_handler", {}), "is_mount", False) else scope["path"]
-        )
-    )
+    return should_bypass_for_path_pattern(scope, exclude_path_pattern)

litestar/middleware/base.py

@@ -1,12 +1,14 @@
 from __future__ import annotations
 
 import abc
+import warnings
 from abc import abstractmethod
 from typing import TYPE_CHECKING, Any, Callable, Protocol, runtime_checkable
 
 from litestar.enums import ScopeType
 from litestar.middleware._utils import (
     build_exclude_path_pattern,
+    should_bypass_for_path_pattern,
     should_bypass_middleware,
 )
 from litestar.utils.deprecation import warn_deprecation
@@ -246,16 +248,48 @@ def __call__(self, app: ASGIApp) -> ASGIApp:
         exclude_pattern = build_exclude_path_pattern(exclude=self.exclude_path_pattern, middleware_cls=type(self))
         scopes = set(self.scopes)
         exclude_opt_key = self.exclude_opt_key
+        should_bypass_for_scope = self.should_bypass_for_scope
+
+        def exclude_pattern_matches_handler_path(scope: Scope) -> bool:
+            if exclude_pattern is None:
+                return False
+            handler = scope["route_handler"]
+            return any(exclude_pattern.search(path) for path in handler.paths)
 
         async def middleware(scope: Scope, receive: Receive, send: Send) -> None:
-            if should_bypass_middleware(
-                scope=scope,
-                scopes=scopes,  # type: ignore[arg-type]
-                exclude_opt_key=exclude_opt_key,
-                exclude_path_pattern=exclude_pattern,
+            path_excluded = False
+            if (
+                should_bypass_middleware(
+                    scope=scope,
+                    scopes=scopes,  # type: ignore[arg-type]
+                    exclude_opt_key=exclude_opt_key,
+                )
+                or (path_excluded := should_bypass_for_path_pattern(scope, exclude_pattern))
+                or (should_bypass_for_scope and should_bypass_for_scope(scope))
             ):
+                if path_excluded and not exclude_pattern_matches_handler_path(scope):
+                    warnings.warn(
+                        f"{type(self).__name__}.exclude_path_pattern={exclude_pattern.pattern!r} "
+                        "did match the request path but did not match the route "
+                        "handler's path. When upgrading to Litestar 3, this middleware "
+                        "would NOT be excluded. To keep the current behaviour, use "
+                        "'should_bypass_for_scope' instead.",
+                        category=DeprecationWarning,
+                        stacklevel=2,
+                    )
+
                 await app(scope, receive, send)
             else:
+                if exclude_pattern_matches_handler_path(scope):
+                    warnings.warn(
+                        f"{type(self).__name__}.exclude_path_pattern={exclude_pattern.pattern!r} "
+                        "did not match the request path but did match the route "
+                        "handler's path. When upgrading to Litestar 3, this middleware "
+                        "would be excluded. To keep the current behaviour, use "
+                        "'should_bypass_for_scope' instead.",
+                        category=DeprecationWarning,
+                        stacklevel=2,
+                    )
                 await handle(scope=scope, receive=receive, send=send, next_app=app)
 
         return middleware

tests/unit/test_middleware/test_base_middleware.py

@@ -1,4 +1,5 @@
 from typing import TYPE_CHECKING, List, Tuple, Union
+from unittest.mock import MagicMock
 from warnings import catch_warnings
 
 import pytest
@@ -308,6 +309,38 @@ def handler(file_name: str) -> str:
         mock.assert_called_once_with("/test.txt")
 
 
+def test_asgi_middleware_path_exclude_warns_future_use() -> None:
+    mock = MagicMock()
+
+    class SubclassMiddleware(ASGIMiddleware):
+        def __init__(self, pattern: str) -> None:
+            self.exclude_path_pattern = pattern
+
+        async def handle(self, scope: "Scope", receive: "Receive", send: "Send", next_app: "ASGIApp") -> None:
+            mock(scope["path"])
+            await next_app(scope, receive, send)
+
+    @get("/{file_name:str}")
+    def handler(file_name: str) -> str:
+        return file_name
+
+    # this configuration would NOT be excluded in the future
+    with create_test_client([handler], middleware=[SubclassMiddleware(".jpg")]) as client:
+        with pytest.warns(DeprecationWarning, match=".*exclude_path_pattern.* did match the request path"):
+            assert client.get("/test.jpg").status_code == 200
+
+        assert client.get("/test.txt").status_code == 200
+        mock.assert_called_once_with("/test.txt")
+
+    mock.reset_mock()
+
+    # this configuration WOULD be excluded in the future
+    with create_test_client([handler], middleware=[SubclassMiddleware("str")]) as client:
+        with pytest.warns(DeprecationWarning, match=".*exclude_path_pattern.* did not match the request path"):
+            assert client.get("/test.jpg").status_code == 200
+            mock.assert_called_once_with("/test.jpg")
+
+
 @pytest.mark.parametrize("excludes", ["/", ("/", "/foo"), "/*", "/.*"])
 def test_asgi_middleware_exclude_by_pattern_warns_if_exclude_all(excludes: Union[str, Tuple[str, ...]]) -> None:
     class SubclassMiddleware(ASGIMiddleware):