Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Show erasure status when listing users in the Admin API #14205

Merged
merged 15 commits into from
Oct 21, 2022
Merged

Show erasure status when listing users in the Admin API #14205

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
060d990
Show erasure status when listing users in the Admin API
tadzik Oct 17, 2022
30bd2bf
Use USING when joining erased_users
tadzik Oct 18, 2022
6e602fe
Add changelog entry
tadzik Oct 18, 2022
0906a17
Revert "Use USING when joining erased_users"
tadzik Oct 18, 2022
d5919fa
Make the erased check work on postgres
tadzik Oct 18, 2022
960205a
Merge branch 'develop' into tadzik/show-erased-status-in-admin-user-l…
tadzik Oct 18, 2022
fe544e7
Add a testcase for showing erased user status
tadzik Oct 18, 2022
5afe378
Appease the style linter
tadzik Oct 18, 2022
795f779
Explicitly convert `erased` to bool to make SQLite consistent with Po…
tadzik Oct 20, 2022
15ac386
Merge branch 'develop' into tadzik/show-erased-status-in-admin-user-l…
tadzik Oct 20, 2022
35c2a88
Move erasure status test to UsersListTestCase
tadzik Oct 20, 2022
84f27cf
Include user erased status when fetching user info via the admin API
tadzik Oct 20, 2022
576bc65
Document the erase status in user_admin_api
tadzik Oct 20, 2022
7aec8d7
Appease the linter and mypy
tadzik Oct 20, 2022
410bae2
Signpost comments in tests
DMRobertson Oct 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions synapse/storage/databases/main/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]:
Expand Down Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a significant impact on performance with an additional left join on a large list?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a query plan here: #14205 (comment)

There is a sequential scan mentioned under the sorting section, but that mentions the profiles table only, which we already join to before this change. I have a suggestion here: will raise an issue.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#14254

{where_clause}
"""
sql = "SELECT COUNT(*) as total_users " + sql_base
Expand All @@ -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 not null as erased
{sql_base}
ORDER BY {order_by_column} {order}, u.name ASC
LIMIT ? OFFSET ?
Expand Down