Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
muted_users events: Use MutedUsersEvent pydantic type.
Evy Kassirercc639dceadeb
diff --git a/zerver/actions/muted_users.py b/zerver/actions/muted_users.pyindex c585b698c6a..c8b368ea520 100644--- a/zerver/actions/muted_users.py+++ b/zerver/actions/muted_users.py@@ -4,6 +4,7 @@ from django.db import transactionfrom django.utils.timezone import now as timezone_nowfrom zerver.actions.message_flags import do_mark_muted_user_messages_as_read+from zerver.lib.event_types import MutedUsersEventfrom zerver.lib.muted_users import add_user_mute, get_user_mutesfrom zerver.models import MutedUser, RealmAuditLog, UserProfilefrom zerver.models.realm_audit_logs import AuditLogEventType@@ -20,7 +21,7 @@ def do_mute_user(date_muted = timezone_now()add_user_mute(user_profile, muted_user, date_muted)do_mark_muted_user_messages_as_read(user_profile, muted_user)- event = dict(type="muted_users", muted_users=get_user_mutes(user_profile))+ event = MutedUsersEvent(muted_users=get_user_mutes(user_profile))send_event_on_commit(user_profile.realm, event, [user_profile.id])RealmAuditLog.objects.create(@@ -38,7 +39,7 @@ def do_unmute_user(mute_object: MutedUser) -> None:user_profile = mute_object.user_profilemuted_user = mute_object.muted_usermute_object.delete()- event = dict(type="muted_users", muted_users=get_user_mutes(user_profile))+ event = MutedUsersEvent(muted_users=get_user_mutes(user_profile))send_event_on_commit(user_profile.realm, event, [user_profile.id])RealmAuditLog.objects.create(diff --git a/zerver/lib/event_types.py b/zerver/lib/event_types.pyindex 00ad39dbe7b..5d73ea99831 100644--- a/zerver/lib/event_types.py+++ b/zerver/lib/event_types.py@@ -278,7 +278,7 @@ class MutedUser(BaseModel):class MutedUsersEvent(BaseEvent):- type: Literal["muted_users"]+ type: Literal["muted_users"] = "muted_users"muted_users: list[MutedUser]diff --git a/zerver/lib/events.py b/zerver/lib/events.pyindex 6e4ef88a154..2fa25e6fc2c 100644--- a/zerver/lib/events.py+++ b/zerver/lib/events.py@@ -359,7 +359,11 @@ def fetch_initial_state_data(state["muted_topics"] = [] if user_profile is None else get_topic_mutes(user_profile)if want("muted_users"):- state["muted_users"] = [] if user_profile is None else get_user_mutes(user_profile)+ state["muted_users"] = (+ []+ if user_profile is None+ else [muted_user.model_dump() for muted_user in get_user_mutes(user_profile)]+ )if want("presence"):if presence_last_update_id_fetched_by_client is not None or simplified_presence_events:diff --git a/zerver/lib/muted_users.py b/zerver/lib/muted_users.pyindex 4fe2eb5353a..4e470d42efa 100644--- a/zerver/lib/muted_users.py+++ b/zerver/lib/muted_users.py@@ -1,21 +1,22 @@from datetime import datetimefrom zerver.lib.cache import cache_with_key, get_muting_users_cache_key+from zerver.lib.event_types import MutedUser as MutedUserDatafrom zerver.lib.timestamp import datetime_to_timestampfrom zerver.lib.utils import assert_is_not_nonefrom zerver.models import MutedUser, UserProfile-def get_user_mutes(user_profile: UserProfile) -> list[dict[str, int]]:+def get_user_mutes(user_profile: UserProfile) -> list[MutedUserData]:rows = MutedUser.objects.filter(user_profile=user_profile).values("muted_user_id","date_muted",)return [- {- "id": row["muted_user_id"],- "timestamp": datetime_to_timestamp(assert_is_not_none(row["date_muted"])),- }+ MutedUserData(+ id=row["muted_user_id"],+ timestamp=datetime_to_timestamp(assert_is_not_none(row["date_muted"])),+ )for row in rows]diff --git a/zerver/tests/test_muted_users.py b/zerver/tests/test_muted_users.pyindex 4b9acd59c59..aa9b091f8fd 100644--- a/zerver/tests/test_muted_users.py+++ b/zerver/tests/test_muted_users.py@@ -5,6 +5,7 @@ import time_machinefrom zerver.actions.users import do_deactivate_userfrom zerver.lib.cache import cache_get, get_muting_users_cache_key+from zerver.lib.event_types import MutedUser as MutedUserDatafrom zerver.lib.muted_users import get_mute_object, get_muting_users, get_user_mutesfrom zerver.lib.test_classes import ZulipTestCasefrom zerver.lib.timestamp import datetime_to_timestamp@@ -30,12 +31,12 @@ class MutedUsersTests(ZulipTestCase):muted_users = get_user_mutes(hamlet)self.assert_length(muted_users, 1)- self.assertDictEqual(+ self.assertEqual(muted_users[0],- {- "id": cordelia.id,- "timestamp": datetime_to_timestamp(mute_time),- },+ MutedUserData(+ id=cordelia.id,+ timestamp=datetime_to_timestamp(mute_time),+ ),)def test_add_muted_user_mute_self(self) -> None:@@ -94,10 +95,10 @@ class MutedUsersTests(ZulipTestCase):self.assert_json_success(result)self.assertIn(- {- "id": cordelia.id,- "timestamp": datetime_to_timestamp(mute_time),- },+ MutedUserData(+ id=cordelia.id,+ timestamp=datetime_to_timestamp(mute_time),+ ),get_user_mutes(hamlet),)self.assertIsNotNone(get_mute_object(hamlet, cordelia))@@ -154,10 +155,10 @@ class MutedUsersTests(ZulipTestCase):self.assert_json_success(result)self.assertNotIn(- {- "id": cordelia.id,- "timestamp": datetime_to_timestamp(mute_time),- },+ MutedUserData(+ id=cordelia.id,+ timestamp=datetime_to_timestamp(mute_time),+ ),get_user_mutes(hamlet),)self.assertIsNone(get_mute_object(hamlet, cordelia))