Show erasure status when listing users in the Admin API

changelog.d/14205.feature

@@ -0,0 +1 @@
+Show erasure status when listing users in the Admin API.

synapse/storage/databases/main/__init__.py

@@ -201,7 +201,7 @@ async def get_users_paginate(
         name: Optional[str] = None,
         guests: bool = True,
         deactivated: bool = False,
-        order_by: str = UserSortOrder.USER_ID.value,
+        order_by: str = UserSortOrder.NAME.value,
         direction: str = "f",
         approved: bool = True,
     ) -> Tuple[List[JsonDict], int]:
@@ -261,6 +261,7 @@ def get_users_paginate_txn(
             sql_base = f"""
                 FROM users as u
                 LEFT JOIN profiles AS p ON u.name = '@' || p.user_id || ':' || ?
+                LEFT JOIN erased_users AS eu ON u.name = eu.user_id
                 {where_clause}
                 """
             sql = "SELECT COUNT(*) as total_users " + sql_base
@@ -269,7 +270,8 @@ def get_users_paginate_txn(
 
             sql = f"""
                 SELECT name, user_type, is_guest, admin, deactivated, shadow_banned,
-                displayname, avatar_url, creation_ts * 1000 as creation_ts, approved
+                displayname, avatar_url, creation_ts * 1000 as creation_ts, approved,
+                eu.user_id is not null as erased
                 {sql_base}
                 ORDER BY {order_by_column} {order}, u.name ASC
                 LIMIT ? OFFSET ?

tests/rest/admin/test_user.py

@@ -1092,8 +1092,10 @@ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
 
         self.other_user = self.register_user("user", "pass", displayname="User1")
         self.other_user_token = self.login("user", "pass")
-        self.url_other_user = "/_synapse/admin/v2/users/%s" % urllib.parse.quote(
-            self.other_user
+        self.url_users = "/_synapse/admin/v2/users"
+        self.url_other_user = "%s/%s" % (
+            self.url_users,
+            urllib.parse.quote(self.other_user),
         )
         self.url = "/_synapse/admin/v1/deactivate/%s" % urllib.parse.quote(
             self.other_user
@@ -1222,6 +1224,17 @@ def test_deactivate_user_erase_true(self) -> None:
 
         self._is_erased("@user:test", True)
 
+        channel = self.make_request(
+            "GET",
+            self.url_users + "?deactivated=true",
+            access_token=self.admin_user_tok,
+        )
+
+        self.assertEqual(
+            1,
+            len(list(filter(lambda user: user["erased"], channel.json_body["users"]))),
+        )
+
     @override_config({"max_avatar_size": 1234})
     def test_deactivate_user_erase_true_avatar_nonnull_but_empty(self) -> None:
         """Check we can erase a user whose avatar is the empty string.