refactor: Improve interface and variables

Author: KShivendu

supertokens_python/framework/django/django_request.py

@@ -29,6 +29,9 @@ def __init__(self, request: HttpRequest):
         super().__init__()
         self.request = request
 
+    def get_original_url(self) -> str:
+        return self.request.get_raw_uri()
+
     def get_query_param(
         self, key: str, default: Union[str, None] = None
     ) -> Union[str, None]:

supertokens_python/framework/fastapi/fastapi_request.py

@@ -28,6 +28,9 @@ def __init__(self, request: Request):
         super().__init__()
         self.request = request
 
+    def get_original_url(self) -> str:
+        return self.request.url.components.geturl()
+
     def get_query_param(
         self, key: str, default: Union[str, None] = None
     ) -> Union[str, None]:

supertokens_python/framework/flask/flask_request.py

@@ -27,6 +27,9 @@ def __init__(self, req: Request):
         super().__init__()
         self.request = req
 
+    def get_original_url(self) -> str:
+        return self.request.url
+
     def get_query_param(self, key: str, default: Union[str, None] = None):
         return self.request.args.get(key, default)
 

supertokens_python/recipe/dashboard/constants.py

@@ -8,8 +8,8 @@
 USER_SESSION_API = "/api/user/sessions"
 USER_PASSWORD_API = "/api/user/password"
 USER_EMAIL_VERIFY_TOKEN_API = "/api/user/email/verify/token"
-EMAIL_PASSWORD_SIGN_IN = "/api/signin"
-EMAIL_PASSSWORD_SIGNOUT = "/api/signout"
+SIGN_IN_API = "/api/signin"
+SIGN_OUT_API = "/api/signout"
 SEARCH_TAGS_API = "/api/search/tags"
 DASHBOARD_ANALYTICS_API = "/api/analytics"
 TENANTS_LIST_API = "/api/tenants/list"

supertokens_python/recipe/dashboard/recipe.py

@@ -14,7 +14,7 @@
 from __future__ import annotations
 
 from os import environ
-from typing import TYPE_CHECKING, Awaitable, Callable, List, Optional, Union, Dict, Any
+from typing import TYPE_CHECKING, Awaitable, Callable, List, Optional, Dict, Any
 
 from supertokens_python.normalised_url_path import NormalisedURLPath
 from supertokens_python.recipe_module import APIHandled, RecipeModule
@@ -59,8 +59,8 @@
 from .constants import (
     DASHBOARD_ANALYTICS_API,
     DASHBOARD_API,
-    EMAIL_PASSSWORD_SIGNOUT,
-    EMAIL_PASSWORD_SIGN_IN,
+    SIGN_OUT_API,
+    SIGN_IN_API,
     SEARCH_TAGS_API,
     USER_API,
     USER_EMAIL_VERIFY_API,
@@ -125,11 +125,9 @@ def get_apis_handled(self) -> List[APIHandled]:
                 False,
             ),
             APIHandled(
-                NormalisedURLPath(
-                    get_api_path_with_dashboard_base(EMAIL_PASSWORD_SIGN_IN)
-                ),
+                NormalisedURLPath(get_api_path_with_dashboard_base(SIGN_IN_API)),
                 "post",
-                EMAIL_PASSWORD_SIGN_IN,
+                SIGN_IN_API,
                 False,
             ),
             APIHandled(
@@ -139,11 +137,9 @@ def get_apis_handled(self) -> List[APIHandled]:
                 False,
             ),
             APIHandled(
-                NormalisedURLPath(
-                    get_api_path_with_dashboard_base(EMAIL_PASSSWORD_SIGNOUT)
-                ),
+                NormalisedURLPath(get_api_path_with_dashboard_base(SIGN_OUT_API)),
                 "post",
-                EMAIL_PASSSWORD_SIGNOUT,
+                SIGN_OUT_API,
                 False,
             ),
             APIHandled(
@@ -279,7 +275,7 @@ async def handle_api_request(
             return await handle_validate_key_api(
                 self.api_implementation, api_options, user_context
             )
-        if request_id == EMAIL_PASSWORD_SIGN_IN:
+        if request_id == SIGN_IN_API:
             return await handle_emailpassword_signin_api(
                 self.api_implementation, api_options, user_context
             )
@@ -320,7 +316,7 @@ async def handle_api_request(
             api_function = handle_user_password_put
         elif request_id == USER_EMAIL_VERIFY_TOKEN_API:
             api_function = handle_email_verify_token_post
-        elif request_id == EMAIL_PASSSWORD_SIGNOUT:
+        elif request_id == SIGN_OUT_API:
             api_function = handle_emailpassword_signout_api
         elif request_id == SEARCH_TAGS_API:
             api_function = handle_get_tags
@@ -352,7 +348,7 @@ def get_all_cors_headers(self) -> List[str]:
     @staticmethod
     def init(
         api_key: Optional[str],
-        admins: Optional[List[str]],
+        admins: Optional[List[str]] = None,
         override: Optional[InputOverrideConfig] = None,
     ):
         def func(app_info: AppInfo):

supertokens_python/recipe/dashboard/recipe_implementation.py

@@ -18,11 +18,11 @@
 from supertokens_python.constants import DASHBOARD_VERSION
 from supertokens_python.framework import BaseRequest
 from supertokens_python.normalised_url_path import NormalisedURLPath
-from supertokens_python.utils import log_debug_message
+from supertokens_python.utils import log_debug_message, normalise_http_method
 from supertokens_python.querier import Querier
 from supertokens_python.recipe.dashboard.constants import (
     DASHBOARD_ANALYTICS_API,
-    EMAIL_PASSSWORD_SIGNOUT,
+    SIGN_OUT_API,
 )
 
 from .interfaces import RecipeInterface
@@ -58,13 +58,13 @@ async def should_allow_access(
 
             # For all non GET requests we also want to check if the
             # user is allowed to perform this operation
-            if request.method() != "GET":  # TODO: Use normalize http method?
+            if normalise_http_method(request.method()) != "get":
                 # We dont want to block the analytics API
                 if request.get_original_url().startswith(DASHBOARD_ANALYTICS_API):
                     return True
 
                 # We do not want to block the sign out request
-                if request.get_original_url().endswith(EMAIL_PASSSWORD_SIGNOUT):
+                if request.get_original_url().endswith(SIGN_OUT_API):
                     return True
 
                 admins = config.admins

supertokens_python/recipe/dashboard/utils.py

@@ -49,8 +49,8 @@
 from .constants import (
     DASHBOARD_ANALYTICS_API,
     DASHBOARD_API,
-    EMAIL_PASSSWORD_SIGNOUT,
-    EMAIL_PASSWORD_SIGN_IN,
+    SIGN_OUT_API,
+    SIGN_IN_API,
     SEARCH_TAGS_API,
     USER_API,
     USER_EMAIL_VERIFY_API,
@@ -259,10 +259,10 @@ def get_api_if_matched(path: NormalisedURLPath, method: str) -> Optional[str]:
         return USER_PASSWORD_API
     if path_str.endswith(USER_EMAIL_VERIFY_TOKEN_API) and method == "post":
         return USER_EMAIL_VERIFY_TOKEN_API
-    if path_str.endswith(EMAIL_PASSWORD_SIGN_IN) and method == "post":
-        return EMAIL_PASSWORD_SIGN_IN
-    if path_str.endswith(EMAIL_PASSSWORD_SIGNOUT) and method == "post":
-        return EMAIL_PASSSWORD_SIGNOUT
+    if path_str.endswith(SIGN_IN_API) and method == "post":
+        return SIGN_IN_API
+    if path_str.endswith(SIGN_OUT_API) and method == "post":
+        return SIGN_OUT_API
     if path_str.endswith(SEARCH_TAGS_API) and method == "get":
         return SEARCH_TAGS_API
     if path_str.endswith(DASHBOARD_ANALYTICS_API) and method == "post":