litestar-vite 0.2.1__tar.gz → 0.2.3__tar.gz

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: litestar-vite
-Version: 0.2.1
+Version: 0.2.3
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/litestar_vite/inertia/_utils.py

@@ -15,6 +15,7 @@ class InertiaHeaders(str, Enum):
     PARTIAL_DATA = "X-Inertia-Partial-Data"
     PARTIAL_COMPONENT = "X-Inertia-Partial-Component"
     LOCATION = "X-Inertia-Location"
+    REFERER = "Referer"
 
 
 def get_enabled_header(enabled: bool = True) -> dict[str, Any]:

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/litestar_vite/inertia/config.py

@@ -21,5 +21,7 @@ class InertiaConfig:
     """An identifier to use on routes to exclude a route from the generated routes typescript file."""
     redirect_unauthorized_to: str | None = None
     """Optionally supply a path where unauthorized requests should redirect."""
-    extra_page_props: dict[str, Any] = field(default_factory=dict)
-    """A dictionary of values to automatically add in to page props on every request."""
+    extra_static_page_props: dict[str, Any] = field(default_factory=dict)
+    """A dictionary of values to automatically add in to page props on every response."""
+    extra_session_page_props: set[str] = field(default_factory=set)
+    """A set of session keys for which the value automatically be added (if it exists) to the response."""

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/litestar_vite/inertia/exception_handler.py

@@ -28,7 +28,6 @@ from litestar.status_codes import (
     HTTP_422_UNPROCESSABLE_ENTITY,
     HTTP_500_INTERNAL_SERVER_ERROR,
 )
-from litestar.types import Empty
 
 from litestar_vite.inertia.response import InertiaBack, InertiaRedirect, InertiaResponse, error
 
@@ -57,25 +56,32 @@ def exception_to_http_response(request: Request[UserT, AuthT, StateT], exc: Exce
         if request.app.debug and http_exc not in (PermissionDeniedException, NotFoundError):
             return cast("Response[Any]", create_debug_response(request, exc))
         return cast("Response[Any]", create_exception_response(request, http_exc(detail=str(exc.__cause__))))
-    has_active_session = not (not request.session or request.scope["session"] is Empty)
+    return create_inertia_exception_response(request, exc)
+
+
+def create_inertia_exception_response(request: Request[UserT, AuthT, StateT], exc: Exception) -> Response[Any]:
+    """Create the inertia exception response"""
     is_inertia = getattr(request, "is_inertia", False)
     status_code = getattr(exc, "status_code", HTTP_500_INTERNAL_SERVER_ERROR)
-    preferred_type = MediaType.HTML if inertia_enabled and not is_inertia else MediaType.JSON
+    preferred_type = MediaType.HTML if not is_inertia else MediaType.JSON
     detail = getattr(exc, "detail", "")  # litestar exceptions
     extras = getattr(exc, "extra", "")  # msgspec exceptions
     content = {"status_code": status_code, "message": getattr(exc, "detail", "")}
     inertia_plugin = cast("InertiaPlugin", request.app.plugins.get("InertiaPlugin"))
     if extras:
         content.update({"extra": extras})
-    if has_active_session:
+    try:
         flash(request, detail, category="error")
+    except Exception as flash_exc:
+        msg = f"Failed to set the `flash` session state.  Reason: {flash_exc.__cause__!s}"
+        request.logger.exception(msg)
     if extras and len(extras) >= 1:
         message = extras[0]
         default_field = f"root.{message.get('key')}" if message.get("key", None) is not None else "root"  # type: ignore
         error_detail = cast("str", message.get("message", detail))  # type: ignore[union-attr] # pyright: ignore[reportUnknownMemberType,reportUnknownArgumentType]
         match = FIELD_ERR_RE.search(error_detail)
         field = match.group(1) if match else default_field
-        if isinstance(message, dict) and has_active_session:
+        if isinstance(message, dict):
             error(request, field, error_detail)
     if status_code in {HTTP_422_UNPROCESSABLE_ENTITY, HTTP_400_BAD_REQUEST} or isinstance(
         exc,
@@ -85,15 +91,15 @@ def exception_to_http_response(request: Request[UserT, AuthT, StateT], exc: Exce
     if isinstance(exc, PermissionDeniedException):
         return InertiaBack(request)
     if status_code == HTTP_401_UNAUTHORIZED or isinstance(exc, NotAuthorizedException):
-        redirect_to = (
+        if (
             inertia_plugin.config.redirect_unauthorized_to is not None
             and str(request.url) != inertia_plugin.config.redirect_unauthorized_to
-        )
-        if redirect_to:
-            return InertiaRedirect(request, redirect_to=cast("str", inertia_plugin.config.redirect_unauthorized_to))
-        return InertiaBack(request)
-    return InertiaResponse[Any](
-        media_type=preferred_type,
-        content=content,
-        status_code=status_code,
-    )
+        ):
+            return InertiaRedirect(request, redirect_to=inertia_plugin.config.redirect_unauthorized_to)
+        if str(request.url) != inertia_plugin.config.redirect_unauthorized_to:
+            return InertiaResponse[Any](
+                media_type=preferred_type,
+                content=content,
+                status_code=status_code,
+            )
+    return InertiaBack(request)

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/litestar_vite/inertia/middleware.py

@@ -15,7 +15,7 @@ if TYPE_CHECKING:
         StateT,
         UserT,
     )
-    from litestar.types import ASGIApp
+    from litestar.types import ASGIApp, Receive, Scope, Send
 
 
 async def redirect_on_asset_version_mismatch(request: Request[UserT, AuthT, StateT]) -> InertiaRedirect | None:
@@ -32,10 +32,6 @@ async def redirect_on_asset_version_mismatch(request: Request[UserT, AuthT, Stat
     return InertiaRedirect(request, redirect_to=str(request.url))
 
 
-if TYPE_CHECKING:
-    from litestar.types import Receive, Scope, Send
-
-
 class InertiaMiddleware(AbstractMiddleware):
     def __init__(self, app: ASGIApp) -> None:
         super().__init__(app)

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/litestar_vite/inertia/request.py

@@ -69,6 +69,11 @@ class InertiaDetails:
         """Partial Data Reload."""
         return self._get_header_value(InertiaHeaders.PARTIAL_DATA)
 
+    @cached_property
+    def referer(self) -> str | None:
+        """Partial Data Reload."""
+        return self._get_header_value(InertiaHeaders.REFERER)
+
     @cached_property
     def is_partial_render(self) -> bool:
         """Is Partial Data Reload."""

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/litestar_vite/inertia/response.py

@@ -16,7 +16,6 @@ from litestar.response import Redirect
 from litestar.response.base import ASGIResponse
 from litestar.serialization import get_serializer
 from litestar.status_codes import HTTP_200_OK, HTTP_303_SEE_OTHER, HTTP_307_TEMPORARY_REDIRECT, HTTP_409_CONFLICT
-from litestar.types import Empty
 from litestar.utils.deprecation import warn_deprecation
 from litestar.utils.empty import value_or_default
 from litestar.utils.helpers import get_enum_string_value
@@ -34,6 +33,7 @@ if TYPE_CHECKING:
     from litestar.connection.base import AuthT, StateT, UserT
     from litestar.types import ResponseCookies, ResponseHeaders, TypeEncodersMap
 
+    from litestar_vite.inertia.request import InertiaRequest
     from litestar_vite.inertia.routes import Routes
 
     from .plugin import InertiaPlugin
@@ -46,7 +46,11 @@ def share(
     key: str,
     value: Any,
 ) -> None:
-    connection.session.setdefault("_shared", {}).update({key: value})
+    try:
+        connection.session.setdefault("_shared", {}).update({key: value})
+    except Exception as exc:
+        msg = f"Failed to set the `share` session state.  Reason: {exc.__cause__!s}"
+        connection.logger.exception(msg)
 
 
 def error(
@@ -54,7 +58,11 @@ def error(
     key: str,
     message: str,
 ) -> None:
-    connection.session.setdefault("_errors", {}).update({key: message})
+    try:
+        connection.session.setdefault("_errors", {}).update({key: message})
+    except Exception as exc:
+        msg = f"Failed to set the `error` session state.  Reason: {exc.__cause__!s}"
+        connection.logger.exception(msg)
 
 
 def get_shared_props(request: ASGIConnection[Any, Any, Any, Any]) -> Dict[str, Any]:  # noqa: UP006
@@ -63,19 +71,26 @@ def get_shared_props(request: ASGIConnection[Any, Any, Any, Any]) -> Dict[str, A
 
     Be sure to call this before `self.create_template_context` if you would like to include the `flash` message details.
     """
-    error_bag = request.headers.get("X-Inertia-Error-Bag", None)
-    has_active_session = not (not request.session or request.scope["session"] is Empty)
-    errors: dict[str, Any] = request.session.pop("_errors", {}) if has_active_session else {}
-    props: dict[str, Any] = request.session.pop("_shared", {}) if has_active_session else {}
-    flash: dict[str, list[str]] = defaultdict(list)
-    for message in cast("List[Dict[str,Any]]", request.session.pop("_messages", []) if has_active_session else []):
-        flash[message["category"]].append(message["message"])
-
-    inertia_plugin = cast("InertiaPlugin", request.app.plugins.get("InertiaPlugin"))
-    props.update(inertia_plugin.config.extra_page_props)
+    props: dict[str, Any] = {}
+    try:
+        error_bag = request.headers.get("X-Inertia-Error-Bag", None)
+        errors: dict[str, Any] = request.session.pop("_errors", {})
+        props.update(cast("Dict[str,Any]", request.session.pop("_shared", {})))
+        flash: dict[str, list[str]] = defaultdict(list)
+        for message in cast("List[Dict[str,Any]]", request.session.pop("_messages", [])):
+            flash[message["category"]].append(message["message"])
+
+        inertia_plugin = cast("InertiaPlugin", request.app.plugins.get("InertiaPlugin"))
+        props.update(inertia_plugin.config.extra_static_page_props)
+        for session_prop in inertia_plugin.config.extra_session_page_props:
+            if session_prop not in props and session_prop in request.session:
+                props[session_prop] = request.session.get(session_prop)
+        props["flash"] = flash
+        props["errors"] = {error_bag: errors} if error_bag is not None else errors
+    except Exception as exc:
+        msg = f"Failed to set the `error` session state.  Reason: {exc.__cause__}"
+        request.logger.exception(msg)
     props["csrf_token"] = value_or_default(ScopeState.from_scope(request.scope).csrf_token, "")
-    props["flash"] = flash
-    props["errors"] = {error_bag: errors} if error_bag is not None else errors
     return props
 
 
@@ -339,8 +354,12 @@ class InertiaBack(Redirect):
         """Initialize external redirect, Set status code to 409 (required by Inertia),
         and pass redirect url.
         """
+        referer = request.headers.get("referer", str(request.base_url))
+        inertia_enabled = getattr(request, "inertia_enabled", False) or getattr(request, "is_inertia", False)
+        if inertia_enabled:
+            referer = cast("InertiaRequest[Any, Any, Any]", request).inertia.referer or referer
         super().__init__(
-            path=request.headers.get("referrer", str(request.base_url)),
+            path=request.headers.get("referer", str(request.base_url)),
             status_code=HTTP_307_TEMPORARY_REDIRECT if request.method == "GET" else HTTP_303_SEE_OTHER,
             cookies=request.cookies,
             **kwargs,

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/litestar_vite/plugin.py

@@ -28,7 +28,7 @@ def set_environment(config: ViteConfig) -> None:
     os.environ.setdefault("VITE_PORT", str(config.port))
     os.environ.setdefault("VITE_HOST", config.host)
     os.environ.setdefault("VITE_PROTOCOL", config.protocol)
-    os.environ.setdefault("APP_URL", "http://localhost:8000")
+    os.environ.setdefault("APP_URL", f"http://localhost:{os.environ.get('LITESTAR_PORT',8000)}")
     if config.dev_mode:
         os.environ.setdefault("VITE_DEV_MODE", str(config.dev_mode))
 

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/pyproject.toml

@@ -26,7 +26,7 @@ license = { text = "MIT" }
 name = "litestar-vite"
 readme = "README.md"
 requires-python = ">=3.8"
-version = "0.2.1"
+version = "0.2.3"
 
 [project.urls]
 Changelog = "https://cofin.github.io/litestar-vite/latest/changelog"

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/tests/test_inertia/test_inertia_request.py

@@ -73,7 +73,7 @@ async def test_is_inertia_true(inertia_plugin: InertiaPlugin, vite_plugin: ViteP
         response = client.get("/", headers={InertiaHeaders.ENABLED.value: "true"})
         assert (
             response.text
-            == '{"component":null,"url":"/","version":"1.0","props":{"content":true,"csrf_token":"","flash":{},"errors":{}}}'
+            == '{"component":null,"url":"/","version":"1.0","props":{"content":true,"flash":{},"errors":{},"csrf_token":""}}'
         )
 
 

{litestar_vite-0.2.1 → litestar_vite-0.2.3}/tests/test_inertia/test_inertia_response.py

@@ -49,7 +49,7 @@ async def test_component_inertia_header_enabled(inertia_plugin: InertiaPlugin, v
         response = client.get("/", headers={InertiaHeaders.ENABLED.value: "true"})
         assert (
             response.content
-            == b'{"component":"Home","url":"/","version":"1.0","props":{"content":{"thing":"value"},"csrf_token":"","flash":{},"errors":{}}}'
+            == b'{"component":"Home","url":"/","version":"1.0","props":{"content":{"thing":"value"},"flash":{},"errors":{},"csrf_token":""}}'
         )
 
 
@@ -72,7 +72,7 @@ async def test_component_inertia_flash_header_enabled(inertia_plugin: InertiaPlu
         response = client.get("/", headers={InertiaHeaders.ENABLED.value: "true"})
         assert (
             response.content
-            == b'{"component":"Home","url":"/","version":"1.0","props":{"content":{"thing":"value"},"csrf_token":"","flash":{"info":["a flash message"]},"errors":{}}}'
+            == b'{"component":"Home","url":"/","version":"1.0","props":{"content":{"thing":"value"},"flash":{"info":["a flash message"]},"errors":{},"csrf_token":""}}'
         )
 
 
@@ -99,7 +99,7 @@ async def test_component_inertia_shared_flash_header_enabled(
         response = client.get("/", headers={InertiaHeaders.ENABLED.value: "true"})
         assert (
             response.content
-            == b'{"component":"Home","url":"/","version":"1.0","props":{"content":{"thing":"value"},"auth":{"user":"nobody"},"csrf_token":"","flash":{"info":["a flash message"]},"errors":{}}}'
+            == b'{"component":"Home","url":"/","version":"1.0","props":{"content":{"thing":"value"},"auth":{"user":"nobody"},"flash":{"info":["a flash message"]},"errors":{},"csrf_token":""}}'
         )
 
 
@@ -135,5 +135,5 @@ async def test_component_inertia_version_redirect(inertia_plugin: InertiaPlugin,
         )
         assert (
             response.content
-            == b'{"component":"Home","url":"/","version":"1.0","props":{"content":{"thing":"value"},"csrf_token":"","flash":{},"errors":{}}}'
+            == b'{"component":"Home","url":"/","version":"1.0","props":{"content":{"thing":"value"},"flash":{},"errors":{},"csrf_token":""}}'
         )