Add get_userinfo_by_id method to ModuleApi

changelog.d/9581.feature

@@ -1 +1 @@
-Add get_userinfo_by_id method to ModuleApi.
+Add `get_userinfo_by_id` method to ModuleApi. `UserInfo` is a new type returned from the registration store. This also deprecates the `get_user_by_id` method on the registration store.

synapse/storage/databases/main/registration.py

@@ -146,6 +146,7 @@ def __init__(
 
     @cached()
     async def get_user_by_id(self, user_id: str) -> Optional[Dict[str, Any]]:
+        """Deprecated: use get_userinfo_by_id instead"""
         return await self.db_pool.simple_select_one(
             table="users",
             keyvalues={"name": user_id},
@@ -166,40 +167,31 @@ async def get_user_by_id(self, user_id: str) -> Optional[Dict[str, Any]]:
             desc="get_user_by_id",
         )
 
-    @cached()
     async def get_userinfo_by_id(self, user_id: str) -> Optional[UserInfo]:
-        user_data = await self.db_pool.simple_select_one(
-            table="users",
-            keyvalues={"name": user_id},
-            retcols=[
-                "name",
-                "password_hash",
-                "is_guest",
-                "admin",
-                "consent_version",
-                "consent_server_notice_sent",
-                "appservice_id",
-                "creation_ts",
-                "user_type",
-                "deactivated",
-                "shadow_banned",
-            ],
-            allow_none=True,
-            desc="get_userinfo_by_id",
-        )
+        """Get a UserInfo object for a user by user ID.
+
+        Note! Currently uses the cache of `get_user_by_id`. Once that deprecated method is removed,
+        this method should be cached.
+
+        Args:
+             user_id: The user to fetch user info for.
+        Returns:
+            `UserInfo` object if user found, otherwise `None`.
+        """
+        user_data = await self.get_user_by_id(user_id)
         if not user_data:
             return None
         return UserInfo(
-            appservice_id=user_data.get("appservice_id"),
-            consent_server_notice_sent=user_data.get("consent_server_notice_sent"),
-            consent_version=user_data.get("consent_version"),
-            creation_ts=user_data.get("creation_ts", 0),
-            is_admin=bool(user_data.get("admin")),
-            is_deactivated=bool(user_data.get("deactivated")),
-            is_guest=bool(user_data.get("is_guest")),
-            is_shadow_banned=bool(user_data.get("shadow_banned")),
-            user_id=UserID.from_string(str(user_data.get("name"))),
-            user_type=user_data.get("user_type"),
+            appservice_id=user_data["appservice_id"],
+            consent_server_notice_sent=user_data["consent_server_notice_sent"],
+            consent_version=user_data["consent_version"],
+            creation_ts=user_data["creation_ts"],
+            is_admin=bool(user_data["admin"]),
+            is_deactivated=bool(user_data["deactivated"]),
+            is_guest=bool(user_data["is_guest"]),
+            is_shadow_banned=bool(user_data["shadow_banned"]),
+            user_id=UserID.from_string(user_data["name"]),
+            user_type=user_data["user_type"],
         )
 
     async def is_trial_user(self, user_id: str) -> bool:

synapse/types.py

@@ -755,7 +755,7 @@ def get_verify_key_from_cross_signing_key(key_info):
 
 @attr.s(auto_attribs=True, frozen=True, slots=True)
 class UserInfo:
-    """Represents an object with information about a user.
+    """Holds information about a user. Result of get_userinfo_by_id.
 
     Attributes:
         user_id:  ID of the user.