Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
message_flags events: Use UpdateMessageFlagsAdd/Remove pydantic types.
Evy Kassirer92f5c7a151e8
diff --git a/zerver/actions/message_flags.py b/zerver/actions/message_flags.pyindex 241dbf4e15b..ac4bdc5e6c0 100644--- a/zerver/actions/message_flags.py+++ b/zerver/actions/message_flags.py@@ -1,6 +1,5 @@import timefrom collections import defaultdict-from dataclasses import asdict, dataclass, fieldfrom django.db import transactionfrom django.db.models import F@@ -8,6 +7,11 @@ from django.utils.timezone import now as timezone_nowfrom django.utils.translation import gettext as _from analytics.lib.counts import COUNT_STATS, do_increment_logging_stat+from zerver.lib.event_types import (+ BaseEvent,+ UpdateMessageFlagsAddEvent,+ UpdateMessageFlagsRemoveEvent,+)from zerver.lib.exceptions import JsonableErrorfrom zerver.lib.message import (bulk_access_messages,@@ -22,16 +26,6 @@ from zerver.models import Device, Message, PushDeviceToken, Recipient, UserMessafrom zerver.tornado.django_api import send_event_on_commit, send_event_rollback_unsafe-@dataclass-class ReadMessagesEvent:- messages: list[int]- all: bool- type: str = field(default="update_message_flags", init=False)- op: str = field(default="add", init=False)- operation: str = field(default="add", init=False)- flag: str = field(default="read", init=False)--def do_mark_all_as_read(user_profile: UserProfile, *, timeout: float | None = None) -> int | None:start_time = time.monotonic()@@ -89,11 +83,11 @@ def do_mark_all_as_read(user_profile: UserProfile, *, timeout: float | None = Noif updated_count < batch_size:break- event = asdict(- ReadMessagesEvent(- messages=[], # we don't send messages, since the client reloads anyway- all=True,- )+ event = UpdateMessageFlagsAddEvent(+ flag="read",+ # Empty list because the client reloads anyway.+ messages=[],+ all=True,)send_event_rollback_unsafe(user_profile.realm, event, [user_profile.id])@@ -130,12 +124,7 @@ def do_mark_stream_messages_as_read(flags=F("flags").bitor(UserMessage.flags.read),)- event = asdict(- ReadMessagesEvent(- messages=message_ids,- all=False,- )- )+ event = UpdateMessageFlagsAddEvent(flag="read", messages=message_ids, all=False)event_time = timezone_now()send_event_on_commit(user_profile.realm, event, [user_profile.id])@@ -179,12 +168,7 @@ def do_mark_muted_user_messages_as_read(flags=F("flags").bitor(UserMessage.flags.read),)- event = asdict(- ReadMessagesEvent(- messages=message_ids,- all=False,- )- )+ event = UpdateMessageFlagsAddEvent(flag="read", messages=message_ids, all=False)event_time = timezone_now()send_event_on_commit(user_profile.realm, event, [user_profile.id])@@ -422,24 +406,23 @@ def do_update_message_flags(else:to_update.update(flags=F("flags").bitand(~flagattr))- event = {- "type": "update_message_flags",- "op": operation,- "operation": operation,- "flag": flag,- "messages": messages,- "all": False,- }-- if flag == "read" and not is_adding:+ event: BaseEvent+ if is_adding:+ event = UpdateMessageFlagsAddEvent(flag=flag, messages=messages, all=False)+ elif flag == "read":# When removing the read flag (i.e. marking messages as# unread), extend the event with an additional object with# details on the messages required to update the client's# `unread_msgs` data structure.raw_unread_data = get_raw_unread_data(user_profile, messages)- event["message_details"] = format_unread_message_details(- user_profile.id, raw_unread_data+ event = UpdateMessageFlagsRemoveEvent(+ flag=flag,+ messages=messages,+ all=False,+ message_details=format_unread_message_details(user_profile.id, raw_unread_data),)+ else:+ event = UpdateMessageFlagsRemoveEvent(flag=flag, messages=messages, all=False)send_event_on_commit(user_profile.realm, event, [user_profile.id])diff --git a/zerver/lib/event_types.py b/zerver/lib/event_types.pyindex 8e6f868db5e..5e5dcbeda3b 100644--- a/zerver/lib/event_types.py+++ b/zerver/lib/event_types.py@@ -1126,9 +1126,9 @@ class UpdateMessageEvent(UpdateMessageCoreEvent):class UpdateMessageFlagsAddEvent(BaseEvent):- type: Literal["update_message_flags"]- op: Literal["add"]- operation: Literal["add"]+ type: Literal["update_message_flags"] = "update_message_flags"+ op: Literal["add"] = "add"+ operation: Literal["add"] = "add"flag: strmessages: list[int]all: bool@@ -1148,9 +1148,9 @@ class MessageDetails(MessageDetailsCore):class UpdateMessageFlagsRemoveCoreEvent(BaseEvent):- type: Literal["update_message_flags"]- op: Literal["remove"]- operation: Literal["remove"]+ type: Literal["update_message_flags"] = "update_message_flags"+ op: Literal["remove"] = "remove"+ operation: Literal["remove"] = "remove"flag: strmessages: list[int]all: booldiff --git a/zerver/lib/message.py b/zerver/lib/message.pyindex edac7227577..95c2a804e7b 100644--- a/zerver/lib/message.py+++ b/zerver/lib/message.py@@ -16,6 +16,7 @@ from analytics.lib.counts import COUNT_STATSfrom analytics.models import RealmCountfrom zerver.lib.cache import generic_bulk_cached_fetch, to_dict_cache_key_idfrom zerver.lib.display_recipient import get_display_recipient_by_id+from zerver.lib.event_types import MessageDetailsfrom zerver.lib.exceptions import JsonableError, MissingAuthenticationErrorfrom zerver.lib.markdown import MessageRenderingResultfrom zerver.lib.mention import MentionData, sender_can_mention_group, silent_mention_syntax_for_user@@ -62,7 +63,7 @@ from zerver.models.recipients import DirectMessageGroupclass MessageDetailsDict(TypedDict, total=False):- type: str+ type: Literal["private", "stream"]mentioned: booluser_ids: list[int]stream_id: int@@ -1289,7 +1290,7 @@ def remove_message_id_from_unread_mgs(state: RawUnreadMessagesResult, message_iddef format_unread_message_details(my_user_id: int,raw_unread_data: RawUnreadMessagesResult,-) -> dict[str, MessageDetailsDict]:+) -> dict[str, MessageDetails]:unread_data = {}for message_id, private_message_details in raw_unread_data["pm_dict"].items():@@ -1301,18 +1302,18 @@ def format_unread_message_details(# Note that user_ids excludes ourself, even for the case we send messages# to ourself.- message_details = MessageDetailsDict(+ message_details = MessageDetails(type="private",user_ids=user_ids,)if message_id in raw_unread_data["mentions"]:- message_details["mentioned"] = True+ message_details.mentioned = Trueunread_data[str(message_id)] = message_detailsfor message_id, stream_message_details in raw_unread_data["stream_dict"].items():unmuted_stream_msg = message_id in raw_unread_data["unmuted_stream_msgs"]- message_details = MessageDetailsDict(+ message_details = MessageDetails(type="stream",stream_id=stream_message_details["stream_id"],topic=stream_message_details["topic"],@@ -1320,7 +1321,7 @@ def format_unread_message_details(unmuted_stream_msg=unmuted_stream_msg,)if message_id in raw_unread_data["mentions"]:- message_details["mentioned"] = True+ message_details.mentioned = Trueunread_data[str(message_id)] = message_detailsfor message_id, huddle_message_details in raw_unread_data["huddle_dict"].items():@@ -1331,12 +1332,12 @@ def format_unread_message_details(for s in huddle_message_details["user_ids_string"].split(",")if (user_id := int(s)) != my_user_id)- message_details = MessageDetailsDict(+ message_details = MessageDetails(type="private",user_ids=user_ids,)if message_id in raw_unread_data["mentions"]:- message_details["mentioned"] = True+ message_details.mentioned = Trueunread_data[str(message_id)] = message_detailsreturn unread_datadiff --git a/zerver/tests/test_message_flags.py b/zerver/tests/test_message_flags.pyindex 74c6147ce70..17efaf5efef 100644--- a/zerver/tests/test_message_flags.py+++ b/zerver/tests/test_message_flags.py@@ -10,6 +10,7 @@ from zerver.actions.streams import do_change_stream_group_based_setting, do_chanfrom zerver.actions.user_groups import check_add_user_groupfrom zerver.actions.user_settings import do_change_user_settingfrom zerver.actions.user_topics import do_set_user_topic_visibility_policy+from zerver.lib.event_types import MessageDetailsfrom zerver.lib.fix_unreads import fix, fix_unsubscribedfrom zerver.lib.message import (MessageDetailsDict,@@ -2253,7 +2254,7 @@ class MarkUnreadTest(ZulipTestCase):self.assertEqual(message_details,{- str(message_id): dict(type="private", user_ids=[]),+ str(message_id): MessageDetails(type="private", user_ids=[]),},)diff --git a/zerver/tornado/django_api.py b/zerver/tornado/django_api.pyindex 8da73b38004..33d131f9537 100644--- a/zerver/tornado/django_api.py+++ b/zerver/tornado/django_api.py@@ -236,11 +236,12 @@ def _event_to_dict(event: Mapping[str, Any] | BaseEvent) -> Mapping[str, Any]:if name not in data:default = field_info.get_default(call_default_factory=True)if default is not None:- # Only the constant type/op discriminators are spelled- # as class defaults; a default on any other field would- # silently change which fields are sent by call sites- # that omit it.- assert name in ("type", "op")+ # Only the constant type/op discriminators (and the+ # legacy "operation" duplicate) are spelled as class+ # defaults; a default on any other field would silently+ # change which fields are sent by call sites that omit+ # it.+ assert name in ("type", "op", "operation")data[name] = defaultreturn datareturn event