feat: refactor Litestar framework integration and update middleware imports

Author: pythonhubdev

Makefile

@@ -26,6 +26,9 @@ freeze-dev-requirements:
 with-fastapi:
 	pip3 install -e .[fastapi]
 
+with-litestar:
+	pip3 install -e .[litestar]
+
 with-django:
 	pip3 install -e .[django]
 

examples/with-litestar/with-thirdpartyemailpassword/README.md

@@ -1,8 +1,8 @@
 ![SuperTokens banner](https://raw.githubusercontent.com/supertokens/supertokens-logo/master/images/Artboard%20%E2%80%93%2027%402x.png)
 
-# FastAPI example
+# Litestar example
 
-This is an example to show how to use supertokens-python library with FastAPI framework and ThirdpartyEmailpassword recipe.
+This is an example to show how to use supertokens-python library with Litestar framework and ThirdpartyEmailpassword recipe.
 
 This server code can be used to implement social auth using:
 - Google

examples/with-litestar/with-thirdpartyemailpassword/main.py

@@ -12,7 +12,7 @@
     get_all_cors_headers,
     init,
 )
-from supertokens_python.framework.litestar.litestar_middleware import LitestarMiddleware
+from supertokens_python.framework.litestar.middleware import LitestarMiddleware
 from supertokens_python.recipe import (
     dashboard,
     emailverification,

supertokens_python/framework/litestar/framework.py

@@ -11,8 +11,6 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
-from __future__ import annotations
-
 from typing import TYPE_CHECKING, Any
 
 from supertokens_python.framework.types import Framework
@@ -23,7 +21,7 @@
 
 class LitestarFramework(Framework):
     def wrap_request(self, unwrapped: Request[Any, Any, Any]):
-        from supertokens_python.framework.litestar.litestar_request import (
+        from supertokens_python.framework.litestar.request import (
             LitestarRequest,
         )
 

supertokens_python/framework/litestar/litestar_middleware.py renamed to supertokens_python/framework/litestar/middleware.py

@@ -7,8 +7,8 @@
 from litestar.types import ASGIApp, Message, Receive, Scope, Send
 from supertokens_python import Supertokens
 from supertokens_python.exceptions import SuperTokensError
-from supertokens_python.framework.litestar.litestar_request import LitestarRequest
-from supertokens_python.framework.litestar.litestar_response import LitestarResponse
+from supertokens_python.framework.litestar.request import LitestarRequest
+from supertokens_python.framework.litestar.response import LitestarResponse
 from supertokens_python.recipe.session import SessionContainer
 from supertokens_python.supertokens import manage_session_post_response
 from supertokens_python.utils import default_user_context

supertokens_python/framework/litestar/litestar_request.py renamed to supertokens_python/framework/litestar/request.py

@@ -11,11 +11,11 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
+import json
 from typing import Any, Dict, Union
 from urllib.parse import parse_qsl
 
 from litestar import Request
-from litestar.exceptions import SerializationException
 from supertokens_python.framework.request import BaseRequest
 from supertokens_python.recipe.session.interfaces import SessionContainer
 
@@ -36,10 +36,17 @@ def get_query_param(
     def get_query_params(self) -> Dict[str, Any]:
         return dict(self.request.query_params.items())  # type: ignore
 
-    async def json(self) -> Union[Any, None]:
+    async def json(self) -> dict:
+        """
+        Read the entire ASGI stream and JSON-decode it,
+        sidestepping Litestar’s internal max-body-size logic.
+        """
+        body_bytes = b"".join([chunk async for chunk in self.request.stream()])
+        if not body_bytes:
+            return {}
         try:
-            return await self.request.json()
-        except SerializationException:
+            return json.loads(body_bytes)
+        except json.JSONDecodeError:
             return {}
 
     def method(self) -> str:
@@ -61,7 +68,7 @@ def set_session_as_none(self):
         self.request.state.supertokens = None
 
     def get_path(self) -> str:
-        return self.request.url.path
+        return self.request.scope["raw_path"].decode("utf-8")
 
     async def form_data(self):
         return dict(parse_qsl((await self.request.body()).decode("utf-8")))

supertokens_python/framework/litestar/litestar_response.py renamed to supertokens_python/framework/litestar/response.py

@@ -14,13 +14,13 @@
 from math import ceil
 from typing import Any, Dict, Literal, Optional
 
+from litestar import Response
+from litestar.serialization import encode_json
 from supertokens_python.framework.response import BaseResponse
 from supertokens_python.utils import get_timestamp_ms
 
 
 class LitestarResponse(BaseResponse):
-    from litestar import Response
-
     def __init__(self, response: Response[Any]):
         super().__init__({})
         self.response = response
@@ -76,8 +76,6 @@ def set_status_code(self, status_code: int):
 
     def set_json_content(self, content: Dict[str, Any]):
         if not self.response_sent:
-            from litestar.serialization import encode_json
-
             body = encode_json(
                 content,
             )

supertokens_python/recipe/session/framework/litestar/__init__.py

@@ -18,17 +18,16 @@
 
 from supertokens_python import Supertokens
 from supertokens_python.exceptions import SuperTokensError
-from supertokens_python.framework.litestar.litestar_request import LitestarRequest
-from supertokens_python.framework.litestar.litestar_response import LitestarResponse
-from supertokens_python.recipe.session import SessionRecipe
+from supertokens_python.framework.litestar.request import LitestarRequest
+from supertokens_python.framework.litestar.response import LitestarResponse
+from supertokens_python.recipe.session import SessionContainer, SessionRecipe
+from supertokens_python.recipe.session.interfaces import SessionClaimValidator
 from supertokens_python.types import MaybeAwaitable
 from supertokens_python.utils import (
     default_user_context,
     set_request_in_user_context_if_not_defined,
 )
 
-from ...interfaces import SessionClaimValidator, SessionContainer
-
 
 def verify_session(
     anti_csrf_check: Union[bool, None] = None,

supertokens_python/supertokens.py

@@ -154,9 +154,7 @@ def __init__(
         self.website_base_path = NormalisedURLPath(website_base_path)
         if mode is not None:
             self.mode = mode
-        elif framework == "fastapi":
-            mode = "asgi"
-        elif framework == "litestar":
+        elif framework in ["fastapi", "litestar"]:
             mode = "asgi"
         else:
             mode = "wsgi"