fastlifeweb 0.7.0__tar.gz → 0.7.2__tar.gz

{fastlifeweb-0.7.0 → fastlifeweb-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastlifeweb
-Version: 0.7.0
+Version: 0.7.2
 Summary: High-level web framework
 Home-page: https://github.com/mardiros/fastlife
 License: BSD-derived

{fastlifeweb-0.7.0 → fastlifeweb-0.7.2}/pyproject.toml

@@ -15,7 +15,7 @@ classifiers = [
   "Topic :: Software Development :: Libraries :: Python Modules",
   "Topic :: Internet :: WWW/HTTP",
 ]
-version = "0.7.0"
+version = "0.7.2"
 
 [tool.poetry.dependencies]
 python = "^3.11"

{fastlifeweb-0.7.0 → fastlifeweb-0.7.2}/src/fastlife/configurator/configurator.py

@@ -22,7 +22,7 @@ from typing import (
 )
 
 import venusian  # type: ignore
-from fastapi import Depends, FastAPI, Response
+from fastapi import Depends, FastAPI, Request, Response
 from fastapi.params import Depends as DependsType
 from fastapi.staticfiles import StaticFiles
 
@@ -30,6 +30,7 @@ from fastlife.configurator.base import AbstractMiddleware
 from fastlife.configurator.route_handler import FastlifeRoute
 from fastlife.security.csrf import check_csrf
 
+from .route_handler import FastlifeRequest
 from .settings import Settings
 
 if TYPE_CHECKING:
@@ -63,7 +64,7 @@ class Configurator:
         self._app.router.route_class = FastlifeRoute
         self.scanner = venusian.Scanner(fastlife=self)
         self.include("fastlife.views")
-        self.include("fastlife.session")
+        self.include("fastlife.middlewares")
 
     def get_app(self) -> FastAPI:
         """
@@ -193,7 +194,12 @@ class Configurator:
         self, status_code_or_exc: int | Type[Exception], handler: Any
     ) -> "Configurator":
         """Add an exception handler the application."""
-        self._app.add_exception_handler(status_code_or_exc, handler)
+
+        def exception_handler(request: Request, exc: Exception) -> Any:
+            req = FastlifeRequest(self.registry, request)
+            return handler(req, exc)
+
+        self._app.add_exception_handler(status_code_or_exc, exception_handler)
         return self
 
 

{fastlifeweb-0.7.0 → fastlifeweb-0.7.2}/src/fastlife/configurator/route_handler.py

@@ -3,15 +3,14 @@ from typing import TYPE_CHECKING, Any, Callable, Coroutine
 from fastapi import Request as BaseRequest
 from fastapi.routing import APIRoute
 from starlette.responses import Response
-from starlette.types import Receive, Scope
 
 if TYPE_CHECKING:
     from .registry import AppRegistry  # coverage: ignore
 
 
 class FastlifeRequest(BaseRequest):
-    def __init__(self, registry: "AppRegistry", scope: Scope, receive: Receive) -> None:
-        super().__init__(scope, receive)
+    def __init__(self, registry: "AppRegistry", request: BaseRequest) -> None:
+        super().__init__(request.scope, request.receive)
         self.registry = registry
 
 
@@ -24,7 +23,7 @@ class FastlifeRoute(APIRoute):
         orig_route_handler = super().get_route_handler()
 
         async def route_handler(request: BaseRequest) -> FastlifeRequest:
-            req = FastlifeRequest(self.registry, request.scope, request.receive)
+            req = FastlifeRequest(self.registry, request)
             return await orig_route_handler(req)  # type: ignore
 
         return route_handler  # type: ignore

{fastlifeweb-0.7.0 → fastlifeweb-0.7.2}/src/fastlife/configurator/settings.py

@@ -1,4 +1,5 @@
 """Settings for the fastlife."""
+
 from datetime import timedelta
 from typing import Literal
 
@@ -77,7 +78,7 @@ class Settings(BaseSettings):
     should be true while using https on production.
     """
     session_serializer: str = Field(
-        default="fastlife.session.serializer:SignedSessionSerializer"
+        default="fastlife.middlewares.session.serializer:SignedSessionSerializer"
     )
     """Cookie serializer for the session cookie."""
 
@@ -86,3 +87,6 @@ class Settings(BaseSettings):
 
     check_permission: str = Field(default="fastlife.security.policy:check_permission")
     """Handler for checking permission set on any views using the configurator."""
+
+    decode_reverse_proxy_headers: bool = Field(default=True)
+    """Ensure that the request object has information based on http proxy headers."""

fastlifeweb-0.7.2/src/fastlife/middlewares/__init__.py

@@ -0,0 +1,7 @@
+from fastlife import Configurator, configure
+
+
+@configure
+def includeme(config: Configurator) -> None:
+    config.include(".reverse_proxy")
+    config.include(".session")

fastlifeweb-0.7.2/src/fastlife/middlewares/reverse_proxy/__init__.py

@@ -0,0 +1,10 @@
+from fastlife import Configurator, configure
+
+from .x_forwarded import XForwardedStar
+
+
+@configure
+def includeme(config: Configurator) -> None:
+    settings = config.registry.settings
+    if settings.decode_reverse_proxy_headers:
+        config.add_middleware(XForwardedStar)

fastlifeweb-0.7.2/src/fastlife/middlewares/reverse_proxy/x_forwarded.py

@@ -0,0 +1,50 @@
+"""
+A middleware that update the request scope for https behind a proxy.
+
+The attempt of this middleware is to fix Starlette behavior that use client and scheme
+header based on the header x-forwarded-* headers and the x-real-ip.
+
+the x-forwarded-for header is not parsed to find the appropriate value,
+the x-real-ip is used.
+notethat the x-forwarded-port header is not used.
+
+Note that uvicorn or hypercorn offer the same kind middleware.
+"""
+
+import logging
+from typing import Optional, Sequence, Tuple
+
+from starlette.types import ASGIApp, Receive, Scope, Send
+
+from fastlife.configurator.base import AbstractMiddleware
+
+
+log = logging.getLogger(__name__)
+
+
+def get_header(headers: Sequence[Tuple[bytes, bytes]], key: bytes) -> Optional[str]:
+    for hdr in headers:
+        if hdr[0].lower() == key:
+            return hdr[1].decode("latin1")
+    return None
+
+
+class XForwardedStar(AbstractMiddleware):
+    def __init__(
+        self,
+        app: ASGIApp,
+    ) -> None:
+        self.app = app
+
+    async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
+        if scope["type"] in ("http", "websocket"):
+
+            headers = scope["headers"]
+            new_vals = {
+                "client": get_header(headers, b"x-real-ip"),
+                "host": get_header(headers, b"x-forwarded-host"),
+                "scheme": get_header(headers, b"x-forwarded-proto"),
+            }
+            scope.update({key: val for key, val in new_vals.items() if val is not None})
+
+        await self.app(scope, receive, send)

{fastlifeweb-0.7.0 → fastlifeweb-0.7.2}/src/fastlife/testing/testclient.py

@@ -14,7 +14,7 @@ from multidict import MultiDict
 from starlette.types import ASGIApp
 
 from fastlife.configurator.settings import Settings
-from fastlife.session.serializer import AbsractSessionSerializer
+from fastlife.middlewares.session.serializer import AbsractSessionSerializer
 from fastlife.shared_utils.resolver import resolve
 
 CookieTypes = httpx._types.CookieTypes  # type: ignore