Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

user_groups: Add helper for bulk recursive membership groups.

Sahil Batra63ffe3818f75
diff --git a/zerver/lib/user_groups.py b/zerver/lib/user_groups.py
index 7cfa7d13faf..873bc207f5f 100644
--- a/zerver/lib/user_groups.py
+++ b/zerver/lib/user_groups.py
@@ -889,6 +889,31 @@ def get_recursive_membership_groups(user_profile: UserProfile) -> QuerySet[UserG
return with_cte(cte, select=cte.join(UserGroup, id=cte.col.group_id))
+def get_user_id_annotated_recursive_membership_groups_for_users(
+ user_ids: list[int],
+) -> QuerySet[UserGroup]:
+ if len(user_ids) == 0:
+ return UserGroup.objects.none()
+
+ # Same as get_recursive_membership_groups but for many users at once:
+ # annotates each group a user belongs to (directly or transitively)
+ # with that user_id, so one recursive query serves all users.
+ cte = CTE.recursive(
+ lambda cte: (
+ UserGroupMembership.objects.filter(user_profile_id__in=user_ids)
+ .values(group_id=F("user_group_id"), user_id=F("user_profile_id"))
+ .union(
+ cte.join(GroupGroupMembership, subgroup_id=cte.col.group_id).values(
+ group_id=F("supergroup_id"), user_id=cte.col.user_id
+ )
+ )
+ )
+ )
+ return with_cte(cte, select=cte.join(UserGroup, id=cte.col.group_id)).annotate(
+ user_id=cte.col.user_id
+ )
+
+
def user_has_permission_for_group_setting(
user_group_id: int,
user: UserProfile,
diff --git a/zerver/tests/test_user_groups.py b/zerver/tests/test_user_groups.py
index fde576139f7..989c9a90040 100644
--- a/zerver/tests/test_user_groups.py
+++ b/zerver/tests/test_user_groups.py
@@ -1,3 +1,4 @@
+from collections import defaultdict
from collections.abc import Iterable
from datetime import datetime, timedelta
from unittest import mock
@@ -52,6 +53,7 @@ from zerver.lib.user_groups import (
get_subgroup_ids,
get_system_user_group_by_name,
get_user_group_member_ids,
+ get_user_id_annotated_recursive_membership_groups_for_users,
has_user_group_access_for_subgroup,
is_any_user_in_group,
is_user_in_group,
@@ -811,6 +813,37 @@ class UserGroupTestCase(ZulipTestCase):
with self.assertRaises(JsonableError):
user_group_ids_to_user_groups([hamletcharacters_group.id, admins_group.id], realm)
+ def test_user_id_annotated_recursive_membership_groups_for_users(self) -> None:
+ iago = self.example_user("iago")
+ hamlet = self.example_user("hamlet")
+ polonius = self.example_user("polonius")
+
+ self.assert_length(get_user_id_annotated_recursive_membership_groups_for_users([]), 0)
+
+ group_memberships = get_user_id_annotated_recursive_membership_groups_for_users(
+ [iago.id, hamlet.id, polonius.id]
+ )
+ membership_dict = defaultdict(list)
+ for membership in group_memberships:
+ membership_dict[membership.user_id].append(membership.id) # type: ignore[attr-defined] # user_id is an annotated field.
+
+ # We just want to ensure that get_user_id_annotated_recursive_membership_groups_for_users
+ # returns the user ID annotated queryset for all recursive membership groups for
+ # users and we keep the test simple by just comparing the values with
+ # get_recursive_membership_groups which is already tested well enough.
+ self.assertCountEqual(
+ membership_dict[iago.id],
+ list(get_recursive_membership_groups(iago).values_list("id", flat=True)),
+ )
+ self.assertCountEqual(
+ membership_dict[hamlet.id],
+ list(get_recursive_membership_groups(hamlet).values_list("id", flat=True)),
+ )
+ self.assertCountEqual(
+ membership_dict[polonius.id],
+ list(get_recursive_membership_groups(polonius).values_list("id", flat=True)),
+ )
+
class UserGroupAPITestCase(UserGroupTestCase):
def test_user_group_create(self) -> None: