feat: Use User and UserWithMetadata to strongly type the dashboard recipe

Author: KShivendu

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

@@ -1,18 +1,17 @@
-from supertokens_python.exceptions import raise_bad_input_exception
+from typing import Union
 
+from supertokens_python.exceptions import raise_bad_input_exception
+from supertokens_python.recipe.dashboard.utils import get_user_for_recipe_id
 from supertokens_python.recipe.usermetadata import UserMetadataRecipe
 from supertokens_python.recipe.usermetadata.asyncio import get_user_metadata
 
-from supertokens_python.recipe.dashboard.utils import get_user_for_recipe_id
-
 from ...interfaces import (
     APIInterface,
     APIOptions,
     UserGetAPINoUserFoundError,
     UserGetAPIOkResponse,
 )
 from ...utils import is_valid_recipe_id
-from typing import Union
 
 
 async def handle_user_get(
@@ -36,23 +35,19 @@ async def handle_user_get(
 
     user = user_response.user
 
-    # FIXME: Shouldn't be required, no?
-    recipe_id_: str = recipe_id  # type: ignore
-    user_id_: str = user_id  # type: ignore
-
     try:
         UserMetadataRecipe.get_instance()
     except Exception:
         user.first_name = "FEATURE_NOT_ENABLED"
         user.last_name = "FEATURE_NOT_ENABLED"
 
-        return UserGetAPIOkResponse(recipe_id_, user)
+        return UserGetAPIOkResponse(recipe_id, user)
 
-    user_metadata = await get_user_metadata(user_id_)
+    user_metadata = await get_user_metadata(user_id)
     first_name = user_metadata.metadata.get("first_name", "")
     last_name = user_metadata.metadata.get("last_name", "")
 
     user.first_name = first_name
     user.last_name = last_name
 
-    return UserGetAPIOkResponse(recipe_id_, user)
+    return UserGetAPIOkResponse(recipe_id, user)

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

@@ -93,7 +93,7 @@ async def update_email_for_recipe_id(
     if recipe_id == "thirdpartyemailpassword":
         form_fields = (
             ThirdPartyEmailPasswordRecipe.get_instance().email_password_recipe.config.sign_up_feature.form_fields
-        )  # TODO: Using config of EP recipe object here. Verify if it is correct.
+        )
         email_form_fields = [
             form_field
             for form_field in form_fields

supertokens_python/recipe/dashboard/api/users_get.py

@@ -14,17 +14,13 @@
 from __future__ import annotations
 
 import asyncio
-from typing import TYPE_CHECKING, Any, Awaitable, Dict, List
+from typing import TYPE_CHECKING, Any, Awaitable, List
 
-from supertokens_python.recipe.dashboard.utils import DashboardUser
 from supertokens_python.supertokens import Supertokens
 
 from ...usermetadata import UserMetadataRecipe
 from ...usermetadata.asyncio import get_user_metadata
-from ..interfaces import (
-    DashboardUsersGetResponse,
-    DashboardUsersGetResponseWithMetadata,
-)
+from ..interfaces import DashboardUsersGetResponse, UserWithMetadata
 
 if TYPE_CHECKING:
     from supertokens_python.recipe.dashboard.interfaces import (
@@ -69,9 +65,9 @@ async def handle_users_get_api(
             users_response.users, users_response.next_pagination_token
         )
 
-    updated_users_arr: List[Dict[str, Any]] = DashboardUsersGetResponse(
-        users_response.users, users_response.next_pagination_token
-    ).users
+    users_with_metadata: List[UserWithMetadata] = [
+        UserWithMetadata(user) for user in users_response.users
+    ]
     metadata_fetch_awaitables: List[Awaitable[Any]] = []
 
     async def get_user_metadata_and_update_user(user_idx: int) -> None:
@@ -80,12 +76,9 @@ async def get_user_metadata_and_update_user(user_idx: int) -> None:
         first_name = user_metadata.metadata.get("first_name")
         last_name = user_metadata.metadata.get("last_name")
 
-        updated_users_arr[user_idx]["user"].update(
-            {
-                "firstName": first_name,
-                "lastName": last_name,  # None becomes null which is acceptable for the dashboard.
-            }
-        )
+        # None becomes null which is acceptable for the dashboard.
+        users_with_metadata[user_idx].first_name = first_name
+        users_with_metadata[user_idx].last_name = last_name
 
     # Batch calls to get user metadata:
     for i, _ in enumerate(users_response.users):
@@ -110,7 +103,7 @@ async def get_user_metadata_and_update_user(user_idx: int) -> None:
 
         promise_arr_start_position += batch_size
 
-    return DashboardUsersGetResponseWithMetadata(
-        updated_users_arr,
+    return DashboardUsersGetResponse(
+        users_with_metadata,
         users_response.next_pagination_token,
     )

supertokens_python/recipe/dashboard/interfaces.py

@@ -14,11 +14,11 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING, Any, Awaitable, Callable, Dict, List, Optional
+from typing import TYPE_CHECKING, Any, Awaitable, Callable, Dict, List, Optional, Union
 
 from ...supertokens import AppInfo
 from ...types import APIResponse, User
-from .utils import DashboardConfig, DashboardUser
+from .utils import DashboardConfig, GetUserForRecipeUser
 
 if TYPE_CHECKING:
     from supertokens_python.framework import BaseRequest, BaseResponse
@@ -69,49 +69,43 @@ def __init__(self):
         ] = None
 
 
-class DashboardUsersGetResponse(APIResponse):
-    status: str = "OK"
-
-    def __init__(self, users: List[User], next_pagination_token: Optional[str]):
-        self.users = users
-        self.next_pagination_token = next_pagination_token
+class UserWithMetadata:
+    def __init__(
+        self,
+        user: User,
+        first_name: Optional[str] = None,
+        last_name: Optional[str] = None,
+    ):
+        self.user = user
+        self.first_name = first_name
+        self.last_name = last_name
 
     def to_json(self) -> Dict[str, Any]:
-        users_json = [
+        res = self.user.to_json()
+        res["user"].update(
             {
-                "recipeId": u.recipe_id,
-                "user": {
-                    "id": u.user_id,
-                    "email": u.email,
-                    "timeJoined": u.time_joined,
-                    "thirdParty": None
-                    if u.third_party_info is None
-                    else u.third_party_info.__dict__,
-                    "phoneNumber": u.phone_number,
-                },
+                "firstName": self.first_name,
+                "lastName": self.last_name,
             }
-            for u in self.users
-        ]
-        return {
-            "status": self.status,
-            "users": users_json,
-            "nextPaginationToken": self.next_pagination_token,
-        }
+        )
+        return res
 
 
-class DashboardUsersGetResponseWithMetadata(APIResponse):
+class DashboardUsersGetResponse(APIResponse):
     status: str = "OK"
 
     def __init__(
-        self, users: List[Dict[str, Any]], next_pagination_token: Optional[str]
+        self,
+        users: Union[List[User], List[UserWithMetadata]],
+        next_pagination_token: Optional[str],
     ):
         self.users = users
         self.next_pagination_token = next_pagination_token
 
     def to_json(self) -> Dict[str, Any]:
         return {
             "status": self.status,
-            "users": self.users,
+            "users": [u.to_json() for u in self.users],
             "nextPaginationToken": self.next_pagination_token,
         }
 
@@ -129,7 +123,7 @@ def to_json(self) -> Dict[str, Any]:
 class UserGetAPIOkResponse(APIResponse):
     status: str = "OK"
 
-    def __init__(self, recipe_id: str, user: DashboardUser):
+    def __init__(self, recipe_id: str, user: GetUserForRecipeUser):
         self.recipe_id = recipe_id
         self.user = user
 

supertokens_python/recipe/dashboard/utils.py

@@ -53,6 +53,9 @@
 if TYPE_CHECKING:
     from .interfaces import APIInterface, RecipeInterface
 
+from supertokens_python.recipe.dashboard.interfaces import UserWithMetadata
+from supertokens_python.types import User
+
 
 class InputOverrideConfig:
     def __init__(
@@ -152,99 +155,70 @@ def is_valid_recipe_id(recipe_id: str) -> bool:
     return recipe_id in ("emailpassword", "thirdparty", "passwordless")
 
 
-class DashboardUser:
-    def __init__(self, user: Dict[str, Any]):
-        self.user_id: str = user["user_id"]
-        self.email: Optional[str] = user.get("email")
-        self.phone: Optional[str] = user.get("phone")
-        self.time_joined: int = user["time_joined"]
-        self.first_name: Optional[str] = user.get("first_name")
-        self.last_name: Optional[str] = user.get("last_name")
-
-    def to_json(self) -> Dict[str, Any]:
-        return {
-            "id": self.user_id,
-            "email": self.email,
-            "phoneNumber": self.phone,
-            "timeJoined": self.time_joined,
-            "firstName": self.first_name,
-            "lastName": self.last_name,
-        }
-
-
 class GetUserForRecipeIdResult:
-    def __init__(self, user: DashboardUser, recipe: str):
+    def __init__(self, user: UserWithMetadata, recipe: str):
         self.user = user
         self.recipe = recipe
 
 
 async def get_user_for_recipe_id(
     user_id: str, recipe_id: str
 ) -> Optional[GetUserForRecipeIdResult]:
-    user: Optional[Dict[str, Any]] = None
+    user: Optional[UserWithMetadata] = None
     recipe: Optional[str] = None
 
-    async def update_user(
-        get_user_func1: Callable[[str], Awaitable[Any]],
-        get_user_func2: Callable[[str], Awaitable[Any]],
+    async def update_user_dict(
+        get_user_func1: Callable[[str], Awaitable[Optional[User]]],
+        get_user_func2: Callable[[str], Awaitable[Optional[User]]],
         recipe1: str,
         recipe2: str,
     ):
         nonlocal user, user_id, recipe
 
         try:
-            user_response = await get_user_func1(user_id)  # type: ignore
-
-            if user_response is not None:
-                user = {
-                    **user_response.__dict__,
-                    "firstName": "",
-                    "lastName": "",
-                }
+            matching_user = await get_user_func1(user_id)  # type: ignore
+
+            if matching_user is not None:
+                user = UserWithMetadata(matching_user, first_name="", last_name="")
                 recipe = recipe1
         except Exception:
             pass
 
         if user is None:
             try:
-                user_response = await get_user_func2(user_id)
-
-                if user_response is not None:
-                    user = {
-                        **user_response.__dict__,
-                        "firstName": "",
-                        "lastName": "",
-                    }
+                matching_user = await get_user_func2(user_id)
+
+                if matching_user is not None:
+                    user = UserWithMetadata(matching_user, first_name="", last_name="")
                     recipe = recipe2
             except Exception:
                 pass
 
     if recipe_id == EmailPasswordRecipe.recipe_id:
-        await update_user(
+        await update_user_dict(
             ep_get_user_by_id,
             tpep_get_user_by_id,
             "emailpassword",
             "thirdpartyemailpassword",
         )
 
     elif recipe_id == ThirdPartyRecipe.recipe_id:
-        await update_user(
+        await update_user_dict(
             tp_get_user_by_idx,
             tpep_get_user_by_id,
             "thirdparty",
             "thirdpartyemailpassword",
         )
 
     elif recipe_id == PasswordlessRecipe.recipe_id:
-        await update_user(
+        await update_user_dict(
             pless_get_user_by_id,
             tppless_get_user_by_id,
             "passwordless",
             "thirdpartypasswordless",
         )
 
     if user is not None and recipe is not None:
-        dashboard_user = DashboardUser(user)
-        return GetUserForRecipeIdResult(dashboard_user, recipe)
+        return GetUserForRecipeIdResult(user, recipe)
 
     return None

supertokens_python/types.py

@@ -12,7 +12,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 from abc import ABC, abstractmethod
-from typing import Any, Dict, List, Union, TypeVar, Awaitable
+from typing import Any, Awaitable, Dict, List, TypeVar, Union
 
 _T = TypeVar("_T")
 
@@ -40,6 +40,21 @@ def __init__(
         self.third_party_info = third_party_info
         self.phone_number = phone_number
 
+    def to_json(self) -> Dict[str, Any]:
+
+        return {
+            "recipeId": self.recipe_id,
+            "user": {
+                "id": self.user_id,
+                "email": self.email,
+                "timeJoined": self.time_joined,
+                "thirdParty": None
+                if self.third_party_info is None
+                else self.third_party_info.__dict__,
+                "phoneNumber": self.phone_number,
+            },
+        }
+
 
 class UsersResponse:
     def __init__(self, users: List[User], next_pagination_token: Union[str, None]):