litestar-vite 0.1.1__py3-none-any.whl → 0.15.0rc2__py3-none-any.whl

litestar_vite/inertia/exception_handler.py

@@ -0,0 +1,172 @@
+import re
+from typing import TYPE_CHECKING, Any, cast
+
+from litestar import MediaType
+from litestar.connection import Request
+from litestar.connection.base import AuthT, StateT, UserT
+from litestar.exceptions import (
+    HTTPException,
+    ImproperlyConfiguredException,
+    InternalServerException,
+    NotAuthorizedException,
+    NotFoundException,
+    PermissionDeniedException,
+)
+from litestar.exceptions.responses import (
+    create_debug_response,  # pyright: ignore[reportUnknownVariableType]
+    create_exception_response,  # pyright: ignore[reportUnknownVariableType]
+)
+from litestar.plugins.flash import flash
+from litestar.repository.exceptions import (
+    ConflictError,  # pyright: ignore[reportUnknownVariableType,reportAttributeAccessIssue]
+    NotFoundError,  # pyright: ignore[reportUnknownVariableType,reportAttributeAccessIssue]
+    RepositoryError,  # pyright: ignore[reportUnknownVariableType,reportAttributeAccessIssue]
+)
+from litestar.response import Response
+from litestar.status_codes import (
+    HTTP_400_BAD_REQUEST,
+    HTTP_401_UNAUTHORIZED,
+    HTTP_404_NOT_FOUND,
+    HTTP_405_METHOD_NOT_ALLOWED,
+    HTTP_409_CONFLICT,
+    HTTP_422_UNPROCESSABLE_ENTITY,
+    HTTP_500_INTERNAL_SERVER_ERROR,
+)
+
+from litestar_vite.inertia.helpers import error
+from litestar_vite.inertia.request import InertiaRequest
+from litestar_vite.inertia.response import InertiaBack, InertiaRedirect, InertiaResponse
+
+if TYPE_CHECKING:
+    from litestar.connection import Request
+    from litestar.connection.base import AuthT, StateT, UserT
+    from litestar.response import Response
+
+    from litestar_vite.inertia.plugin import InertiaPlugin
+
+
+FIELD_ERR_RE = re.compile(r"field `(.+)`$")
+
+
+class _HTTPConflictException(HTTPException):
+    """Request conflict with the current state of the target resource."""
+
+    status_code: int = HTTP_409_CONFLICT
+
+
+def exception_to_http_response(request: "Request[UserT, AuthT, StateT]", exc: "Exception") -> "Response[Any]":
+    """Handler for all exceptions subclassed from HTTPException.
+
+    Inertia detection:
+
+    - For InertiaRequest instances, uses the request's derived flags (route component + headers).
+    - For plain Request instances (e.g., before routing/when middleware didn't run), falls back
+      to checking the ``X-Inertia`` header.
+
+    Args:
+        request: The request object.
+        exc: The exception to handle.
+
+    Returns:
+        The response object.
+    """
+    is_inertia_header = request.headers.get("x-inertia", "").lower() == "true"
+    if isinstance(request, InertiaRequest):
+        inertia_enabled = request.inertia_enabled or request.is_inertia or is_inertia_header
+    else:
+        inertia_enabled = is_inertia_header
+
+    if not inertia_enabled:
+        if isinstance(exc, HTTPException):
+            return cast("Response[Any]", create_exception_response(request, exc))
+        if isinstance(exc, NotFoundError):
+            http_exc = NotFoundException
+        elif isinstance(exc, (RepositoryError, ConflictError)):
+            http_exc = _HTTPConflictException  # type: ignore[assignment]
+        else:
+            http_exc = InternalServerException  # type: ignore[assignment]
+        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__))))  # pyright: ignore[reportUnknownArgumentType]
+    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.
+
+    This function handles exceptions for Inertia-enabled routes, returning appropriate
+    responses based on the exception type and status code.
+
+    Note:
+        This function uses defensive programming techniques to handle edge cases:
+        - Type-safe handling of exception ``extra`` attribute (may be string, list, dict, or None)
+        - Graceful handling when InertiaPlugin is not registered
+        - Broad exception handling for flash() calls (non-critical operation)
+
+    Args:
+        request: The request object.
+        exc: The exception to handle.
+
+    Returns:
+        The response object, either an InertiaResponse, InertiaRedirect, or InertiaBack.
+    """
+    is_inertia_header = request.headers.get("x-inertia", "").lower() == "true"
+    is_inertia = request.is_inertia if isinstance(request, InertiaRequest) else is_inertia_header
+
+    status_code = exc.status_code if isinstance(exc, HTTPException) else HTTP_500_INTERNAL_SERVER_ERROR
+    preferred_type = MediaType.HTML if not is_inertia else MediaType.JSON
+    detail = exc.detail if isinstance(exc, HTTPException) else str(exc)
+    extras: Any = None
+    if isinstance(exc, HTTPException):
+        try:
+            extras = exc.extra  # pyright: ignore[reportUnknownMemberType]
+        except AttributeError:
+            extras = None
+    content: dict[str, Any] = {"status_code": status_code, "message": detail}
+
+    inertia_plugin: "InertiaPlugin | None"
+    try:
+        inertia_plugin = request.app.plugins.get("InertiaPlugin")
+    except KeyError:
+        inertia_plugin = None
+
+    if extras:
+        content.update({"extra": extras})
+
+    try:
+        if detail:
+            flash(request, detail, category="error")
+    except (AttributeError, KeyError, RuntimeError, ImproperlyConfiguredException):
+        request.logger.warning("Unable to set flash message", exc_info=True)
+
+    if extras and isinstance(extras, (list, tuple)) and len(extras) >= 1:  # pyright: ignore[reportUnknownArgumentType]
+        first_extra = extras[0]  # pyright: ignore[reportUnknownVariableType]
+        if isinstance(first_extra, dict):
+            message: dict[str, str] = cast("dict[str, str]", first_extra)
+            key_value = message.get("key")
+            default_field = f"root.{key_value}" if key_value is not None else "root"
+            error_detail = str(message.get("message", detail) or detail)
+            match = FIELD_ERR_RE.search(error_detail)
+            field = match.group(1) if match else default_field
+            error(request, field, error_detail or detail)
+
+    if status_code in {HTTP_422_UNPROCESSABLE_ENTITY, HTTP_400_BAD_REQUEST}:
+        return InertiaBack(request)
+    if isinstance(exc, PermissionDeniedException):
+        return InertiaBack(request)
+
+    if inertia_plugin is None:
+        return InertiaResponse[Any](media_type=preferred_type, content=content, status_code=status_code)
+
+    if (status_code == HTTP_401_UNAUTHORIZED or isinstance(exc, NotAuthorizedException)) and (
+        inertia_plugin.config.redirect_unauthorized_to is not None
+        and request.url.path != inertia_plugin.config.redirect_unauthorized_to
+    ):
+        return InertiaRedirect(request, redirect_to=inertia_plugin.config.redirect_unauthorized_to)
+
+    if status_code in {HTTP_404_NOT_FOUND, HTTP_405_METHOD_NOT_ALLOWED} and (
+        inertia_plugin.config.redirect_404 is not None and request.url.path != inertia_plugin.config.redirect_404
+    ):
+        return InertiaRedirect(request, redirect_to=inertia_plugin.config.redirect_404)
+
+    return InertiaResponse[Any](media_type=preferred_type, content=content, status_code=status_code)