Merge pull request #365 from supertokens/refactor/user-context

refactor: Pass default user context for APIs in the framework middleware itself

Author: rishabhpoddar

supertokens_python/framework/django/django_middleware.py

@@ -28,6 +28,7 @@ def middleware(get_response: Any):
     from supertokens_python.supertokens import manage_session_post_response
 
     from django.http import HttpRequest
+    from supertokens_python.utils import default_user_context
 
     if asyncio.iscoroutinefunction(get_response):
 
@@ -37,8 +38,10 @@ async def __asyncMiddleware(request: HttpRequest):
             from django.http import HttpResponse
 
             response = DjangoResponse(HttpResponse())
+            user_context = default_user_context(custom_request)
+
             try:
-                result = await st.middleware(custom_request, response)
+                result = await st.middleware(custom_request, response, user_context)
                 if result is None:
                     result = await get_response(request)
                     result = DjangoResponse(result)

supertokens_python/framework/fastapi/fastapi_middleware.py

@@ -23,6 +23,7 @@
 
 def get_middleware():
     from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint
+    from supertokens_python.utils import default_user_context
 
     class Middleware(BaseHTTPMiddleware):
         def __init__(self, app: FastAPI):
@@ -46,8 +47,9 @@ async def dispatch(self, request: Request, call_next: RequestResponseEndpoint):
             try:
                 custom_request = FastApiRequest(request)
                 response = FastApiResponse(Response())
+                user_context = default_user_context(custom_request)
                 result: Union[BaseResponse, None] = await st.middleware(
-                    custom_request, response
+                    custom_request, response, user_context
                 )
                 if result is None:
                     response = await call_next(request)

supertokens_python/framework/flask/flask_middleware.py

@@ -34,6 +34,7 @@ def set_before_after_request(self):
         from supertokens_python.framework.flask.flask_request import FlaskRequest
         from supertokens_python.framework.flask.flask_response import FlaskResponse
         from supertokens_python.supertokens import manage_session_post_response
+        from supertokens_python.utils import default_user_context
 
         from flask.wrappers import Response
 
@@ -50,8 +51,11 @@ def _():
 
             request_ = FlaskRequest(request)
             response_ = FlaskResponse(Response())
+            user_context = default_user_context(request_)
 
-            result: Union[BaseResponse, None] = sync(st.middleware(request_, response_))
+            result: Union[BaseResponse, None] = sync(
+                st.middleware(request_, response_, user_context)
+            )
 
             if result is not None:
                 if isinstance(result, FlaskResponse):

supertokens_python/recipe/dashboard/api/analytics.py

@@ -14,7 +14,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Dict, Any
 
 from httpx import AsyncClient
 
@@ -35,7 +35,7 @@
 
 
 async def handle_analytics_post(
-    _: APIInterface, api_options: APIOptions
+    _: APIInterface, api_options: APIOptions, _user_context: Dict[str, Any]
 ) -> AnalyticsResponse:
     if not Supertokens.get_instance().telemetry:
         return AnalyticsResponse()

supertokens_python/recipe/dashboard/api/api_key_protector.py

@@ -13,7 +13,7 @@
 # under the License.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Callable, Optional, Awaitable
+from typing import TYPE_CHECKING, Callable, Optional, Awaitable, Dict, Any
 
 from supertokens_python.framework import BaseResponse
 
@@ -25,7 +25,6 @@
     from supertokens_python.types import APIResponse
 
 from supertokens_python.utils import (
-    default_user_context,
     send_200_response,
     send_non_200_response_with_message,
 )
@@ -34,9 +33,11 @@
 async def api_key_protector(
     api_implementation: APIInterface,
     api_options: APIOptions,
-    api_function: Callable[[APIInterface, APIOptions], Awaitable[APIResponse]],
+    api_function: Callable[
+        [APIInterface, APIOptions, Dict[str, Any]], Awaitable[APIResponse]
+    ],
+    user_context: Dict[str, Any],
 ) -> Optional[BaseResponse]:
-    user_context = default_user_context(api_options.request)
     should_allow_access = await api_options.recipe_implementation.should_allow_access(
         api_options.request, api_options.config, user_context
     )
@@ -46,5 +47,5 @@ async def api_key_protector(
             "Unauthorised access", 401, api_options.response
         )
 
-    response = await api_function(api_implementation, api_options)
+    response = await api_function(api_implementation, api_options, user_context)
     return send_200_response(response.to_json(), api_options.response)

supertokens_python/recipe/dashboard/api/dashboard.py

@@ -13,7 +13,7 @@
 # under the License.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING, Optional, Dict, Any
 
 from supertokens_python.framework import BaseResponse
 
@@ -23,16 +23,15 @@
         APIInterface,
     )
 
-from supertokens_python.utils import default_user_context
-
 
 async def handle_dashboard_api(
-    api_implementation: APIInterface, api_options: APIOptions
+    api_implementation: APIInterface,
+    api_options: APIOptions,
+    user_context: Dict[str, Any],
 ) -> Optional[BaseResponse]:
     if api_implementation.dashboard_get is None:
         return None
 
-    user_context = default_user_context(api_options.request)
     html_str = await api_implementation.dashboard_get(api_options, user_context)
 
     api_options.response.set_html_content(html_str)

supertokens_python/recipe/dashboard/api/search/getTags.py

@@ -13,7 +13,7 @@
 # under the License.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Dict, Any
 
 if TYPE_CHECKING:
     from supertokens_python.recipe.dashboard.interfaces import APIInterface, APIOptions
@@ -23,7 +23,9 @@
 from supertokens_python.recipe.dashboard.interfaces import SearchTagsOK
 
 
-async def handle_get_tags(_: APIInterface, __: APIOptions) -> SearchTagsOK:
+async def handle_get_tags(
+    _: APIInterface, __: APIOptions, _user_context: Dict[str, Any]
+) -> SearchTagsOK:
     response = await Querier.get_instance().send_get_request(
         NormalisedURLPath("/user/search/tags")
     )

supertokens_python/recipe/dashboard/api/signin.py

@@ -13,7 +13,7 @@
 # under the License.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Dict, Any
 
 if TYPE_CHECKING:
     from supertokens_python.recipe.dashboard.interfaces import APIInterface, APIOptions
@@ -24,7 +24,9 @@
 from supertokens_python.utils import send_200_response
 
 
-async def handle_emailpassword_signin_api(_: APIInterface, api_options: APIOptions):
+async def handle_emailpassword_signin_api(
+    _: APIInterface, api_options: APIOptions, _user_context: Dict[str, Any]
+):
     body = await api_options.request.json()
     if body is None:
         raise_bad_input_exception("Please send body")

supertokens_python/recipe/dashboard/api/signout.py

@@ -13,7 +13,7 @@
 # under the License.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Dict, Any
 
 if TYPE_CHECKING:
     from supertokens_python.recipe.dashboard.interfaces import APIInterface, APIOptions
@@ -26,7 +26,7 @@
 
 
 async def handle_emailpassword_signout_api(
-    _: APIInterface, api_options: APIOptions
+    _: APIInterface, api_options: APIOptions, _user_context: Dict[str, Any]
 ) -> SignOutOK:
     if api_options.config.auth_mode == "api-key":
         return SignOutOK()

supertokens_python/recipe/dashboard/api/userdetails/user_delete.py

@@ -1,10 +1,12 @@
+from typing import Any, Dict
+
 from ...interfaces import APIInterface, APIOptions, UserDeleteAPIResponse
 from supertokens_python.exceptions import raise_bad_input_exception
 from supertokens_python import Supertokens
 
 
 async def handle_user_delete(
-    _api_interface: APIInterface, api_options: APIOptions
+    _api_interface: APIInterface, api_options: APIOptions, _user_context: Dict[str, Any]
 ) -> UserDeleteAPIResponse:
     user_id = api_options.request.get_query_param("userId")