Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

events: Pass realm to fetch_initial_state_data always. 

This commit makes passing realm mandatory to fetch_initial_state_data.

This is a prep commit for refetching the realm object with
select_related for group setting fields so that extra queries
can be avoided when computing "/registe" response.
This commit is contained in:
Sahil Batra 2024-06-15 10:42:06 +05:30 committed by Tim Abbott
parent 1455a68aef
commit dea62a3fd9
3 changed files with 26 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
zerver/lib/events.py
View File

@ -122,7 +122,7 @@ def always_want(msg_type: str) -> bool:
def fetch_initial_state_data(
user_profile: Optional[UserProfile],
*,
realm: Optional[Realm] = None,
realm: Realm,
event_types: Optional[Iterable[str]] = None,
queue_id: Optional[str] = "",
client_gravatar: bool = False,
@ -148,10 +148,6 @@ def fetch_initial_state_data(
corresponding events for changes in the data structures and new
code to apply_events (and add a test in test_events.py).
"""
if realm is None:
assert user_profile is not None
realm = user_profile.realm
state: Dict[str, Any] = {"queue_id": queue_id}
if event_types is None:
@ -1705,6 +1701,7 @@ def do_events_register(
ret = fetch_initial_state_data(
user_profile,
realm=realm,
event_types=event_types_set,
queue_id=queue_id,
client_gravatar=client_gravatar,

26
zerver/tests/test_event_system.py
View File

@ -612,7 +612,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
def test_realm_bots_non_admin(self) -> None:
user_profile = self.example_user("cordelia")
self.assertFalse(user_profile.is_realm_admin)
result = fetch_initial_state_data(user_profile)
result = fetch_initial_state_data(user_profile, realm=user_profile.realm)
self.assert_length(result["realm_bots"], 0)
# additionally the API key for a random bot is not present in the data
@ -624,14 +624,14 @@ class FetchInitialStateDataTest(ZulipTestCase):
user_profile = self.example_user("hamlet")
do_change_user_role(user_profile, UserProfile.ROLE_REALM_ADMINISTRATOR, acting_user=None)
self.assertTrue(user_profile.is_realm_admin)
result = fetch_initial_state_data(user_profile)
result = fetch_initial_state_data(user_profile, realm=user_profile.realm)
self.assertGreater(len(result["realm_bots"]), 2)
def test_max_message_id_with_no_history(self) -> None:
user_profile = self.example_user("aaron")
# Delete all historical messages for this user
UserMessage.objects.filter(user_profile=user_profile).delete()
result = fetch_initial_state_data(user_profile)
result = fetch_initial_state_data(user_profile, realm=user_profile.realm)
self.assertEqual(result["max_message_id"], -1)
def test_delivery_email_presence_for_non_admins(self) -> None:
@ -646,7 +646,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
UserProfile.EMAIL_ADDRESS_VISIBILITY_EVERYONE,
acting_user=None,
)
result = fetch_initial_state_data(user_profile)
result = fetch_initial_state_data(user_profile, realm=user_profile.realm)
(hamlet_obj,) = (value for key, value in result["raw_users"].items() if key == hamlet.id)
self.assertEqual(hamlet_obj["delivery_email"], hamlet.delivery_email)
@ -657,7 +657,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
UserProfile.EMAIL_ADDRESS_VISIBILITY_ADMINS,
acting_user=None,
)
result = fetch_initial_state_data(user_profile)
result = fetch_initial_state_data(user_profile, realm=user_profile.realm)
(hamlet_obj,) = (value for key, value in result["raw_users"].items() if key == hamlet.id)
self.assertIsNone(hamlet_obj["delivery_email"])
@ -674,7 +674,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
UserProfile.EMAIL_ADDRESS_VISIBILITY_EVERYONE,
acting_user=None,
)
result = fetch_initial_state_data(user_profile)
result = fetch_initial_state_data(user_profile, realm=user_profile.realm)
(hamlet_obj,) = (value for key, value in result["raw_users"].items() if key == hamlet.id)
self.assertEqual(hamlet_obj["delivery_email"], hamlet.delivery_email)
@ -685,7 +685,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
UserProfile.EMAIL_ADDRESS_VISIBILITY_ADMINS,
acting_user=None,
)
result = fetch_initial_state_data(user_profile)
result = fetch_initial_state_data(user_profile, realm=user_profile.realm)
(hamlet_obj,) = (value for key, value in result["raw_users"].items() if key == hamlet.id)
self.assertIn("delivery_email", hamlet_obj)
@ -706,6 +706,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
result = fetch_initial_state_data(
user_profile=hamlet,
realm=hamlet.realm,
user_avatar_url_field_optional=True,
)
@ -729,6 +730,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
# Test again with client_gravatar = True
result = fetch_initial_state_data(
user_profile=hamlet,
realm=hamlet.realm,
client_gravatar=True,
user_avatar_url_field_optional=True,
)
@ -745,6 +747,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
hamlet = self.example_user("hamlet")
result = fetch_initial_state_data(
user_profile=hamlet,
realm=hamlet.realm,
user_settings_object=True,
)
self.assertIn("user_settings", result)
@ -754,6 +757,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
result = fetch_initial_state_data(
user_profile=hamlet,
realm=hamlet.realm,
user_settings_object=False,
)
self.assertIn("user_settings", result)
@ -779,6 +783,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
result = fetch_initial_state_data(
user_profile=user,
realm=user.realm,
linkifier_url_template=True,
)
self.assertEqual(result["realm_filters"], [])
@ -791,6 +796,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
# The default behavior should be `linkifier_url_template=False`
result = fetch_initial_state_data(
user_profile=user,
realm=user.realm,
)
self.assertEqual(result["realm_filters"], [])
self.assertEqual(result["realm_linkifiers"], [])
@ -799,6 +805,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
hamlet = self.example_user("hamlet")
result = fetch_initial_state_data(
user_profile=hamlet,
realm=hamlet.realm,
pronouns_field_type_supported=False,
)
self.assertIn("custom_profile_fields", result)
@ -808,6 +815,7 @@ class FetchInitialStateDataTest(ZulipTestCase):
result = fetch_initial_state_data(
user_profile=hamlet,
realm=hamlet.realm,
pronouns_field_type_supported=True,
)
self.assertIn("custom_profile_fields", result)
@ -1159,7 +1167,7 @@ class FetchQueriesTest(ZulipTestCase):
with self.assert_database_query_count(43):
with mock.patch("zerver.lib.events.always_want") as want_mock:
fetch_initial_state_data(user)
fetch_initial_state_data(user, realm=user.realm)
expected_counts = dict(
alert_words=1,
@ -1212,7 +1220,7 @@ class FetchQueriesTest(ZulipTestCase):
else:
event_types = [event_type]
fetch_initial_state_data(user, event_types=event_types)
fetch_initial_state_data(user, realm=user.realm, event_types=event_types)
class TestEventsRegisterAllPublicStreamsDefaults(ZulipTestCase):

12
zerver/tests/test_events.py
View File

@ -329,6 +329,7 @@ class BaseAction(ZulipTestCase):
# normal_state = do action then fetch at the end (the "normal" code path)
hybrid_state = fetch_initial_state_data(
self.user_profile,
realm=self.user_profile.realm,
event_types=event_types,
client_gravatar=client_gravatar,
user_avatar_url_field_optional=user_avatar_url_field_optional,
@ -397,6 +398,7 @@ class BaseAction(ZulipTestCase):
normal_state = fetch_initial_state_data(
self.user_profile,
realm=self.user_profile.realm,
event_types=event_types,
client_gravatar=client_gravatar,
user_avatar_url_field_optional=user_avatar_url_field_optional,
@ -2623,7 +2625,7 @@ class NormalActionsTest(BaseAction):
def test_realm_update_org_type(self) -> None:
realm = self.user_profile.realm
state_data = fetch_initial_state_data(self.user_profile)
state_data = fetch_initial_state_data(self.user_profile, realm=realm)
self.assertEqual(state_data["realm_org_type"], Realm.ORG_TYPES["business"]["id"])
with self.verify_action() as events:
@ -2632,7 +2634,7 @@ class NormalActionsTest(BaseAction):
)
check_realm_update("events[0]", events[0], "org_type")
state_data = fetch_initial_state_data(self.user_profile)
state_data = fetch_initial_state_data(self.user_profile, realm=realm)
self.assertEqual(state_data["realm_org_type"], Realm.ORG_TYPES["government"]["id"])
def test_realm_update_plan_type(self) -> None:
@ -2642,7 +2644,7 @@ class NormalActionsTest(BaseAction):
realm, "can_access_all_users_group", members_group, acting_user=None
)
state_data = fetch_initial_state_data(self.user_profile)
state_data = fetch_initial_state_data(self.user_profile, realm=realm)
self.assertEqual(state_data["realm_plan_type"], Realm.PLAN_TYPE_SELF_HOSTED)
self.assertEqual(state_data["zulip_plan_is_not_limited"], True)
@ -2652,7 +2654,7 @@ class NormalActionsTest(BaseAction):
check_realm_update_dict("events[1]", events[1])
check_realm_update("events[2]", events[2], "plan_type")
state_data = fetch_initial_state_data(self.user_profile)
state_data = fetch_initial_state_data(self.user_profile, realm=realm)
self.assertEqual(state_data["realm_plan_type"], Realm.PLAN_TYPE_LIMITED)
self.assertEqual(state_data["zulip_plan_is_not_limited"], False)
@ -3201,7 +3203,7 @@ class NormalActionsTest(BaseAction):
message = Message.objects.get(id=msg_id)
with self.verify_action(state_change_expected=True):
do_delete_messages(self.user_profile.realm, [message])
result = fetch_initial_state_data(user_profile)
result = fetch_initial_state_data(user_profile, realm=user_profile.realm)
self.assertEqual(result["max_message_id"], -1)
def test_do_delete_message_with_no_messages(self) -> None: