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

KShivendu · KShivendu · commit 43a9fa14495b · 2023-07-05T17:25:16.000+05:30
diff --git a/supertokens_python/framework/django/django_middleware.py b/supertokens_python/framework/django/django_middleware.py
@@ -18,6 +18,8 @@
 
 from asgiref.sync import async_to_sync
 
+from supertokens_python.utils import default_user_context
+
 
 def middleware(get_response: Any):
     from supertokens_python import Supertokens
@@ -37,8 +39,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)
diff --git a/supertokens_python/framework/fastapi/fastapi_middleware.py b/supertokens_python/framework/fastapi/fastapi_middleware.py
@@ -16,6 +16,7 @@
 from typing import TYPE_CHECKING, Union
 
 from supertokens_python.framework import BaseResponse
+from supertokens_python.utils import default_user_context
 
 if TYPE_CHECKING:
     from fastapi import FastAPI, Request
@@ -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)
diff --git a/supertokens_python/framework/flask/flask_middleware.py b/supertokens_python/framework/flask/flask_middleware.py
@@ -18,6 +18,7 @@
 
 from supertokens_python.async_to_sync_wrapper import sync
 from supertokens_python.framework import BaseResponse
+from supertokens_python.utils import default_user_context
 
 if TYPE_CHECKING:
     from flask import Flask
@@ -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):
diff --git a/supertokens_python/recipe/dashboard/recipe.py b/supertokens_python/recipe/dashboard/recipe.py
@@ -15,7 +15,7 @@
 
 import re
 from os import environ
-from typing import TYPE_CHECKING, Awaitable, Callable, List, Optional, Union
+from typing import TYPE_CHECKING, Awaitable, Callable, List, Optional, Union, Dict, Any
 
 from supertokens_python.normalised_url_path import NormalisedURLPath
 from supertokens_python.recipe_module import APIHandled, RecipeModule, ApiIdWithTenantId
@@ -133,6 +133,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ) -> Optional[BaseResponse]:
         api_options = APIOptions(
             request,
@@ -247,7 +248,7 @@ def reset():
         DashboardRecipe.__instance = None
 
     def return_api_id_if_can_handle_request(
-        self, path: NormalisedURLPath, method: str
+        self, path: NormalisedURLPath, method: str, user_context: Dict[str, Any]
     ) -> Union[ApiIdWithTenantId, None]:
         dashboard_bundle_path = self.app_info.api_base_path.append(
             NormalisedURLPath(DASHBOARD_API)
diff --git a/supertokens_python/recipe/emailpassword/recipe.py b/supertokens_python/recipe/emailpassword/recipe.py
@@ -175,6 +175,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ):
         api_options = APIOptions(
             request,
diff --git a/supertokens_python/recipe/emailverification/recipe.py b/supertokens_python/recipe/emailverification/recipe.py
@@ -170,6 +170,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ) -> Union[BaseResponse, None]:
         api_options = APIOptions(
             request,
diff --git a/supertokens_python/recipe/jwt/recipe.py b/supertokens_python/recipe/jwt/recipe.py
@@ -14,7 +14,7 @@
 from __future__ import annotations
 
 from os import environ
-from typing import TYPE_CHECKING, List, Union, Optional
+from typing import TYPE_CHECKING, List, Union, Optional, Dict, Any
 
 from supertokens_python.querier import Querier
 from supertokens_python.recipe.jwt.api.implementation import APIImplementation
@@ -85,6 +85,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ):
         options = APIOptions(
             request,
diff --git a/supertokens_python/recipe/multitenancy/recipe.py b/supertokens_python/recipe/multitenancy/recipe.py
@@ -127,6 +127,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ) -> Union[BaseResponse, None]:
         api_options = APIOptions(
             request,
diff --git a/supertokens_python/recipe/openid/recipe.py b/supertokens_python/recipe/openid/recipe.py
@@ -14,7 +14,7 @@
 from __future__ import annotations
 
 from os import environ
-from typing import TYPE_CHECKING, List, Union, Optional
+from typing import TYPE_CHECKING, List, Union, Optional, Any, Dict
 
 from supertokens_python.querier import Querier
 from supertokens_python.recipe.jwt import JWTRecipe
@@ -94,6 +94,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ):
         options = APIOptions(
             request,
@@ -108,7 +109,7 @@ async def handle_api_request(
                 self.api_implementation, options
             )
         return await self.jwt_recipe.handle_api_request(
-            request_id, tenant_id, request, path, method, response
+            request_id, tenant_id, request, path, method, response, user_context
         )
 
     async def handle_error(
diff --git a/supertokens_python/recipe/passwordless/recipe.py b/supertokens_python/recipe/passwordless/recipe.py
@@ -190,6 +190,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ):
         options = APIOptions(
             request,
diff --git a/supertokens_python/recipe/session/recipe.py b/supertokens_python/recipe/session/recipe.py
@@ -192,6 +192,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ) -> Union[BaseResponse, None]:
         if request_id == SESSION_REFRESH:
             return await handle_refresh_api(
@@ -216,7 +217,7 @@ async def handle_api_request(
                 ),
             )
         return await self.openid_recipe.handle_api_request(
-            request_id, tenant_id, request, path, method, response
+            request_id, tenant_id, request, path, method, response, user_context
         )
 
     async def handle_error(
diff --git a/supertokens_python/recipe/thirdparty/recipe.py b/supertokens_python/recipe/thirdparty/recipe.py
@@ -126,6 +126,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ):
         api_options = APIOptions(
             request,
diff --git a/supertokens_python/recipe/thirdpartyemailpassword/recipe.py b/supertokens_python/recipe/thirdpartyemailpassword/recipe.py
@@ -14,7 +14,7 @@
 from __future__ import annotations
 
 from os import environ
-from typing import TYPE_CHECKING, List, Union, Optional
+from typing import TYPE_CHECKING, List, Union, Optional, Dict, Any
 
 from supertokens_python.framework.response import BaseResponse
 from supertokens_python.ingredients.emaildelivery.types import EmailDeliveryConfig
@@ -215,23 +215,26 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ):
         if (
-            self.email_password_recipe.return_api_id_if_can_handle_request(path, method)
+            self.email_password_recipe.return_api_id_if_can_handle_request(
+                path, method, user_context
+            )
             is not None
         ):
             return await self.email_password_recipe.handle_api_request(
-                request_id, tenant_id, request, path, method, response
+                request_id, tenant_id, request, path, method, response, user_context
             )
         if (
             self.third_party_recipe is not None
             and self.third_party_recipe.return_api_id_if_can_handle_request(
-                path, method
+                path, method, user_context
             )
             is not None
         ):
             return await self.third_party_recipe.handle_api_request(
-                request_id, tenant_id, request, path, method, response
+                request_id, tenant_id, request, path, method, response, user_context
             )
         return None
 
diff --git a/supertokens_python/recipe/thirdpartypasswordless/recipe.py b/supertokens_python/recipe/thirdpartypasswordless/recipe.py
@@ -229,23 +229,26 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ):
         if (
-            self.passwordless_recipe.return_api_id_if_can_handle_request(path, method)
+            self.passwordless_recipe.return_api_id_if_can_handle_request(
+                path, method, user_context
+            )
             is not None
         ):
             return await self.passwordless_recipe.handle_api_request(
-                request_id, tenant_id, request, path, method, response
+                request_id, tenant_id, request, path, method, response, user_context
             )
         if (
             self.third_party_recipe is not None
             and self.third_party_recipe.return_api_id_if_can_handle_request(
-                path, method
+                path, method, user_context
             )
             is not None
         ):
             return await self.third_party_recipe.handle_api_request(
-                request_id, tenant_id, request, path, method, response
+                request_id, tenant_id, request, path, method, response, user_context
             )
         return None
 
diff --git a/supertokens_python/recipe/usermetadata/recipe.py b/supertokens_python/recipe/usermetadata/recipe.py
@@ -15,7 +15,7 @@
 from __future__ import annotations
 
 from os import environ
-from typing import List, Union, Optional
+from typing import List, Union, Optional, Dict, Any
 
 from supertokens_python.exceptions import SuperTokensError, raise_general_exception
 from supertokens_python.framework import BaseRequest, BaseResponse
@@ -71,6 +71,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ) -> Union[BaseResponse, None]:
         raise Exception("Should never come here")
 
diff --git a/supertokens_python/recipe/userroles/recipe.py b/supertokens_python/recipe/userroles/recipe.py
@@ -89,6 +89,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ) -> Union[BaseResponse, None]:
         raise Exception("Should never come here")
 
diff --git a/supertokens_python/recipe_module.py b/supertokens_python/recipe_module.py
@@ -16,7 +16,7 @@
 
 import abc
 import re
-from typing import TYPE_CHECKING, List, Union, Optional
+from typing import TYPE_CHECKING, List, Union, Optional, Dict, Any
 
 from typing_extensions import Literal
 
@@ -49,8 +49,10 @@ def get_app_info(self):
         return self.app_info
 
     def return_api_id_if_can_handle_request(
-        self, path: NormalisedURLPath, method: str
+        self, path: NormalisedURLPath, method: str, user_context: Dict[str, Any]
     ) -> Union[ApiIdWithTenantId, None]:
+        _ = user_context
+
         from supertokens_python.recipe.multitenancy.constants import DEFAULT_TENANT_ID
 
         apis_handled = self.get_apis_handled()
@@ -102,6 +104,7 @@ async def handle_api_request(
         path: NormalisedURLPath,
         method: str,
         response: BaseResponse,
+        user_context: Dict[str, Any],
     ) -> Union[BaseResponse, None]:
         pass
 
diff --git a/supertokens_python/supertokens.py b/supertokens_python/supertokens.py
@@ -464,7 +464,7 @@ async def update_or_delete_user_id_mapping_info(  # pylint: disable=no-self-use
         raise_general_exception("Please upgrade the SuperTokens core to >= 3.15.0")
 
     async def middleware(  # pylint: disable=no-self-use
-        self, request: BaseRequest, response: BaseResponse
+        self, request: BaseRequest, response: BaseResponse, user_context: Dict[str, Any]
     ) -> Union[BaseResponse, None]:
         log_debug_message("middleware: Started")
         path = Supertokens.get_instance().app_info.api_gateway_path.append(
@@ -499,7 +499,7 @@ async def middleware(  # pylint: disable=no-self-use
                     break
             if matched_recipe is not None:
                 api_and_tenant_id = matched_recipe.return_api_id_if_can_handle_request(
-                    path, method
+                    path, method, user_context
                 )
         else:
             for recipe in Supertokens.get_instance().recipe_modules:
@@ -508,7 +508,7 @@ async def middleware(  # pylint: disable=no-self-use
                     recipe.get_recipe_id(),
                 )
                 api_and_tenant_id = recipe.return_api_id_if_can_handle_request(
-                    path, method
+                    path, method, user_context
                 )
                 if api_and_tenant_id is not None:
                     matched_recipe = recipe
@@ -538,6 +538,7 @@ async def middleware(  # pylint: disable=no-self-use
                 path,
                 method,
                 response,
+                user_context,
             )
             if api_resp is None:
                 log_debug_message("middleware: Not handled because API returned None")
