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.

events: Use pydantic types for message and update_message events.

Evy Kassirer4bae1c54f50c
diff --git a/zerver/actions/message_edit.py b/zerver/actions/message_edit.py
index c3cdf61d941..af56df60baa 100644
--- a/zerver/actions/message_edit.py
+++ b/zerver/actions/message_edit.py
@@ -27,6 +27,7 @@ from zerver.actions.uploads import AttachmentChangeResult, check_attachment_refe
from zerver.actions.user_topics import bulk_do_set_user_topic_visibility_policy
from zerver.lib import utils
from zerver.lib.cache import cache_delete_many, to_dict_cache_key_id
+from zerver.lib.event_types import TopicLink
from zerver.lib.exceptions import (
JsonableError,
MessageMoveError,
@@ -36,7 +37,7 @@ from zerver.lib.exceptions import (
TopicsNotAllowedError,
TopicWildcardMentionNotAllowedError,
)
-from zerver.lib.internal_event_types import InternalDeleteMessageEvent
+from zerver.lib.internal_event_types import InternalDeleteMessageEvent, InternalUpdateMessageEvent
from zerver.lib.markdown import MessageRenderingResult, topic_links
from zerver.lib.markdown import version as markdown_version
from zerver.lib.mention import MentionBackend, MentionData, silent_mention_syntax_for_user
@@ -71,10 +72,7 @@ from zerver.lib.string_validation import check_stream_topic
from zerver.lib.thumbnail import manifest_and_get_user_upload_previews, rewrite_thumbnailed_images
from zerver.lib.timestamp import datetime_to_timestamp
from zerver.lib.topic import (
- ORIG_TOPIC,
RESOLVED_TOPIC_PREFIX,
- TOPIC_LINKS,
- TOPIC_NAME,
get_topic_display_name,
maybe_rename_general_chat_to_empty_topic,
messages_for_topic,
@@ -84,7 +82,12 @@ from zerver.lib.topic import (
update_messages_for_topic_edit,
)
from zerver.lib.topic_link_util import get_stream_topic_link_syntax
-from zerver.lib.types import DirectMessageEditRequest, EditHistoryEvent, StreamMessageEditRequest
+from zerver.lib.types import (
+ DirectMessageEditRequest,
+ EditHistoryEvent,
+ PropagateMode,
+ StreamMessageEditRequest,
+)
from zerver.lib.url_encoding import stream_message_url
from zerver.lib.user_groups import (
UserGroupMembershipDetails,
@@ -133,7 +136,7 @@ def validate_message_edit_payload(
message: Message,
stream_id: int | None,
topic_name: str | None,
- propagate_mode: str | None,
+ propagate_mode: PropagateMode | None,
content: str | None,
prev_content_sha256: str | None,
) -> None:
@@ -485,16 +488,15 @@ def do_update_embedded_data(
message.save(update_fields=update_fields)
update_message_cache([message])
- event: dict[str, Any] = {
- "type": "update_message",
- "user_id": None,
- "edit_timestamp": datetime_to_timestamp(timezone_now()),
- "message_id": message.id,
- "message_ids": [message.id],
- "content": message.content,
- "rendered_content": message.rendered_content,
- "rendering_only": True,
- }
+ event = InternalUpdateMessageEvent(
+ user_id=None,
+ edit_timestamp=datetime_to_timestamp(timezone_now()),
+ message_id=message.id,
+ message_ids=[message.id],
+ content=message.content,
+ rendered_content=message.rendered_content,
+ rendering_only=True,
+ )
users_to_notify = event_recipient_ids_for_action_on_messages(
[message.id], message.is_channel_message
@@ -542,7 +544,7 @@ def update_message_content(
rendering_result: MessageRenderingResult,
prior_mention_user_ids: set[int],
mention_data: MentionData,
- event: dict[str, Any],
+ event: InternalUpdateMessageEvent,
edit_history_event: EditHistoryEvent,
stream_topic: StreamTopicTarget | None,
) -> None:
@@ -567,11 +569,11 @@ def update_message_content(
edit_history_event["prev_rendered_content"] = target_message.rendered_content
edit_history_event["prev_rendered_content_version"] = target_message.rendered_content_version
- event["orig_content"] = target_message.content
- event["orig_rendered_content"] = target_message.rendered_content
- event["content"] = content
- event["rendered_content"] = rendering_result.rendered_content
- event["is_me_message"] = Message.is_status_message(content, rendering_result.rendered_content)
+ event.orig_content = target_message.content
+ event.orig_rendered_content = target_message.rendered_content
+ event.content = content
+ event.rendered_content = rendering_result.rendered_content
+ event.is_me_message = Message.is_status_message(content, rendering_result.rendered_content)
target_message.content = content
target_message.rendered_content = rendering_result.rendered_content
@@ -586,36 +588,36 @@ def update_message_content(
possible_stream_wildcard_mention=mention_data.message_has_stream_wildcards(),
)
- event["online_push_user_ids"] = list(info.online_push_user_ids)
- event["dm_mention_push_disabled_user_ids"] = list(info.dm_mention_push_disabled_user_ids)
- event["dm_mention_email_disabled_user_ids"] = list(info.dm_mention_email_disabled_user_ids)
- event["stream_push_user_ids"] = list(info.stream_push_user_ids)
- event["stream_email_user_ids"] = list(info.stream_email_user_ids)
- event["followed_topic_push_user_ids"] = list(info.followed_topic_push_user_ids)
- event["followed_topic_email_user_ids"] = list(info.followed_topic_email_user_ids)
- event["muted_sender_user_ids"] = list(info.muted_sender_user_ids)
- event["prior_mention_user_ids"] = list(prior_mention_user_ids)
- event["presence_idle_user_ids"] = filter_presence_idle_user_ids(info.active_user_ids)
- event["all_bot_user_ids"] = list(info.all_bot_user_ids)
- event["push_device_registered_user_ids"] = list(info.push_device_registered_user_ids)
+ event.online_push_user_ids = list(info.online_push_user_ids)
+ event.dm_mention_push_disabled_user_ids = list(info.dm_mention_push_disabled_user_ids)
+ event.dm_mention_email_disabled_user_ids = list(info.dm_mention_email_disabled_user_ids)
+ event.stream_push_user_ids = list(info.stream_push_user_ids)
+ event.stream_email_user_ids = list(info.stream_email_user_ids)
+ event.followed_topic_push_user_ids = list(info.followed_topic_push_user_ids)
+ event.followed_topic_email_user_ids = list(info.followed_topic_email_user_ids)
+ event.muted_sender_user_ids = list(info.muted_sender_user_ids)
+ event.prior_mention_user_ids = list(prior_mention_user_ids)
+ event.presence_idle_user_ids = filter_presence_idle_user_ids(info.active_user_ids)
+ event.all_bot_user_ids = list(info.all_bot_user_ids)
+ event.push_device_registered_user_ids = list(info.push_device_registered_user_ids)
if rendering_result.mentions_stream_wildcard:
- event["stream_wildcard_mention_user_ids"] = list(info.stream_wildcard_mention_user_ids)
- event["stream_wildcard_mention_in_followed_topic_user_ids"] = list(
+ event.stream_wildcard_mention_user_ids = list(info.stream_wildcard_mention_user_ids)
+ event.stream_wildcard_mention_in_followed_topic_user_ids = list(
info.stream_wildcard_mention_in_followed_topic_user_ids
)
else:
- event["stream_wildcard_mention_user_ids"] = []
- event["stream_wildcard_mention_in_followed_topic_user_ids"] = []
+ event.stream_wildcard_mention_user_ids = []
+ event.stream_wildcard_mention_in_followed_topic_user_ids = []
if rendering_result.mentions_topic_wildcard:
- event["topic_wildcard_mention_user_ids"] = list(info.topic_wildcard_mention_user_ids)
- event["topic_wildcard_mention_in_followed_topic_user_ids"] = list(
+ event.topic_wildcard_mention_user_ids = list(info.topic_wildcard_mention_user_ids)
+ event.topic_wildcard_mention_in_followed_topic_user_ids = list(
info.topic_wildcard_mention_in_followed_topic_user_ids
)
topic_participant_user_ids = info.topic_participant_user_ids
else:
- event["topic_wildcard_mention_user_ids"] = []
- event["topic_wildcard_mention_in_followed_topic_user_ids"] = []
+ event.topic_wildcard_mention_user_ids = []
+ event.topic_wildcard_mention_in_followed_topic_user_ids = []
topic_participant_user_ids = set()
update_user_message_flags(rendering_result, ums, topic_participant_user_ids)
@@ -940,17 +942,16 @@ def do_update_message(
timestamp = timezone_now()
target_message.last_edit_time = timestamp
- event: dict[str, Any] = {
- "type": "update_message",
- "user_id": user_profile.id,
- "edit_timestamp": datetime_to_timestamp(timestamp),
- "message_id": target_message.id,
- "rendering_only": False,
- }
+ event = InternalUpdateMessageEvent(
+ user_id=user_profile.id,
+ edit_timestamp=datetime_to_timestamp(timestamp),
+ message_id=target_message.id,
+ rendering_only=False,
+ )
edit_history_event: EditHistoryEvent = {
"user_id": user_profile.id,
- "timestamp": event["edit_timestamp"],
+ "timestamp": event.edit_timestamp,
}
realm = user_profile.realm
@@ -1005,7 +1006,7 @@ def do_update_message(
# This does message.save(update_fields=[...])
save_message_for_edit_use_case(message=target_message)
- event["message_ids"] = sorted(update_message_cache([target_message]))
+ event.message_ids = sorted(update_message_cache([target_message]))
users_to_be_notified = list(map(user_info, ums))
send_event_on_commit(user_profile.realm, event, users_to_be_notified)
@@ -1019,11 +1020,11 @@ def do_update_message(
stream_being_edited = message_edit_request.orig_stream
orig_topic_name = message_edit_request.orig_topic_name
- event["stream_name"] = stream_being_edited.name
- event["stream_id"] = stream_being_edited.id
+ event.stream_name = stream_being_edited.name
+ event.stream_id = stream_being_edited.id
if message_edit_request.is_message_moved:
- event["propagate_mode"] = message_edit_request.propagate_mode
+ event.propagate_mode = message_edit_request.propagate_mode
users_losing_access = UserProfile.objects.none()
user_ids_gaining_usermessages: list[int] = []
@@ -1032,12 +1033,12 @@ def do_update_message(
edit_history_event["prev_stream"] = stream_being_edited.id
edit_history_event["stream"] = new_stream.id
- event[ORIG_TOPIC] = orig_topic_name
+ event.orig_subject = orig_topic_name
assert new_stream.recipient_id is not None
target_message.recipient_id = new_stream.recipient_id
- event["new_stream_id"] = new_stream.id
- event["propagate_mode"] = message_edit_request.propagate_mode
+ event.new_stream_id = new_stream.id
+ event.propagate_mode = message_edit_request.propagate_mode
# When messages are moved from one stream to another, some
# users may lose access to those messages, including guest
@@ -1101,9 +1102,11 @@ def do_update_message(
target_message.set_topic_name(topic_name)
# These fields have legacy field names.
- event[ORIG_TOPIC] = orig_topic_name
- event[TOPIC_NAME] = topic_name
- event[TOPIC_LINKS] = topic_links(target_message.realm_id, topic_name)
+ event.orig_subject = orig_topic_name
+ event.subject = topic_name
+ event.topic_links = [
+ TopicLink(**link) for link in topic_links(target_message.realm_id, topic_name)
+ ]
edit_history_event["prev_topic"] = orig_topic_name
edit_history_event["topic"] = topic_name
@@ -1222,7 +1225,7 @@ def do_update_message(
transaction.on_commit(
lambda: cache_delete_many(to_dict_cache_key_id(msg_id) for msg_id in changed_message_ids)
)
- event["message_ids"] = sorted(changed_message_ids)
+ event.message_ids = sorted(changed_message_ids)
# The following blocks arranges that users who are subscribed to a
# stream and can see history from before they subscribed get
@@ -1634,7 +1637,7 @@ def build_message_edit_request(
*,
message: Message,
user_profile: UserProfile,
- propagate_mode: str,
+ propagate_mode: PropagateMode,
stream_id: int | None = None,
topic_name: str | None = None,
content: str | None = None,
@@ -1765,7 +1768,7 @@ def check_update_message(
message_id: int,
stream_id: int | None = None,
topic_name: str | None = None,
- propagate_mode: str = "change_one",
+ propagate_mode: PropagateMode = "change_one",
send_notification_to_old_thread: bool = True,
send_notification_to_new_thread: bool = True,
content: str | None = None,
diff --git a/zerver/actions/message_send.py b/zerver/actions/message_send.py
index 2a4e42c2e0f..516fadc34cd 100644
--- a/zerver/actions/message_send.py
+++ b/zerver/actions/message_send.py
@@ -44,6 +44,7 @@ from zerver.lib.exceptions import (
TopicsNotAllowedError,
TopicWildcardMentionNotAllowedError,
)
+from zerver.lib.internal_event_types import InternalMessageEvent
from zerver.lib.markdown import MessageRenderingResult, render_message_markdown
from zerver.lib.markdown import version as markdown_version
from zerver.lib.mention import MentionBackend, MentionData, silent_mention_syntax_for_user
@@ -1329,8 +1330,7 @@ def do_send_messages(
) in send_request.recipients_for_user_creation_events.items():
notify_created_user(new_accessible_user, list(notify_user_ids))
- event = dict(
- type="message",
+ event = InternalMessageEvent(
message=send_request.message.id,
message_dict=wide_message_dict,
presence_idle_user_ids=presence_idle_user_ids,
@@ -1369,18 +1369,18 @@ def do_send_messages(
assert send_request.stream is not None
stream_update_fields = []
if send_request.stream.is_public():
- event["realm_id"] = send_request.stream.realm_id
- event["stream_name"] = send_request.stream.name
+ event.realm_id = send_request.stream.realm_id
+ event.stream_name = send_request.stream.name
# Tornado uses these to exclude guest users' clients
# registered for all public channels from receiving the
# events for unsubscribed non web-public channel
# messages, since guests can only access such channels
# when subscribed.
- event["realm_guest_user_ids"] = active_guest_user_ids(send_request.stream.realm_id)
+ event.realm_guest_user_ids = active_guest_user_ids(send_request.stream.realm_id)
if send_request.stream.invite_only:
- event["invite_only"] = True
+ event.invite_only = True
if send_request.stream.is_web_public:
- event["is_web_public"] = True
+ event.is_web_public = True
if send_request.stream.first_message_id is None:
send_request.stream.first_message_id = send_request.message.id
stream_update_fields.append("first_message_id")
@@ -1412,12 +1412,12 @@ def do_send_messages(
user_ids_without_access_to_sender = user_ids_receiving_event - set(
user_ids_who_can_access_sender
)
- event["user_ids_without_access_to_sender"] = list(user_ids_without_access_to_sender)
+ event.user_ids_without_access_to_sender = list(user_ids_without_access_to_sender)
if send_request.local_id is not None:
- event["local_id"] = send_request.local_id
+ event.local_id = send_request.local_id
if send_request.sender_queue_id is not None:
- event["sender_queue_id"] = send_request.sender_queue_id
+ event.sender_queue_id = send_request.sender_queue_id
send_event_on_commit(send_request.realm, event, users)
if send_request.links_for_embed:
@@ -1443,13 +1443,13 @@ def do_send_messages(
assert send_request.message_triggered_bot_queue_events is not None
for queue_name, events in send_request.message_triggered_bot_queue_events.items():
- for event in events:
+ for bot_queue_event in events:
queue_event_on_commit(
queue_name,
{
"message": wide_message_dict,
- "trigger": event["trigger"],
- "user_profile_id": event["user_profile_id"],
+ "trigger": bot_queue_event["trigger"],
+ "user_profile_id": bot_queue_event["user_profile_id"],
},
)
diff --git a/zerver/lib/event_types.py b/zerver/lib/event_types.py
index b65198a4a86..743c83818ee 100644
--- a/zerver/lib/event_types.py
+++ b/zerver/lib/event_types.py
@@ -4,7 +4,7 @@ from django.core.exceptions import ValidationError
from django.core.validators import URLValidator
from pydantic import AfterValidator, BaseModel, ConfigDict, Field
-from zerver.lib.types import UserGroupMembersDict
+from zerver.lib.types import PropagateMode, UserGroupMembersDict
from zerver.models.realms import RealmExportSlug
@@ -1102,7 +1102,7 @@ class UpdateMessageCoreEvent(BaseEvent):
rendering_only: bool
-class UpdateMessageEvent(UpdateMessageCoreEvent):
+class UpdateMessageOptionalFields(BaseEventModel):
# TODO: fix types to avoid optional fields
stream_id: int | None = None
stream_name: str | None = None
@@ -1114,10 +1114,14 @@ class UpdateMessageEvent(UpdateMessageCoreEvent):
topic_links: list[TopicLink] | None = None
subject: str | None = None
new_stream_id: int | None = None
- propagate_mode: Literal["change_all", "change_later", "change_one"] | None = None
+ propagate_mode: PropagateMode | None = None
orig_subject: str | None = None
+class UpdateMessageEvent(UpdateMessageCoreEvent, UpdateMessageOptionalFields):
+ pass
+
+
class UpdateMessageFlagsAddEvent(BaseEvent):
type: Literal["update_message_flags"] = "update_message_flags"
op: Literal["add"] = "add"
diff --git a/zerver/lib/internal_event_types.py b/zerver/lib/internal_event_types.py
index ba3db4690da..2d7ca4a8b9a 100644
--- a/zerver/lib/internal_event_types.py
+++ b/zerver/lib/internal_event_types.py
@@ -16,6 +16,7 @@ from zerver.lib.event_types import (
RealmUserAddEvent,
StreamCreateEvent,
StreamDeleteEvent,
+ UpdateMessageOptionalFields,
UserGroupAddEvent,
UserGroupUpdateEvent,
)
@@ -71,6 +72,77 @@ class InternalPresenceEvent(BaseEvent):
modern_presence: ModernPresence
+class InternalMessageEvent(BaseEvent):
+ # Not a subclass of the model clients receive: message is the
+ # message id and message_dict the wide dict, from which
+ # process_message_event finalizes the payload per client.
+ type: Literal["message"] = "message"
+ message: int
+ message_dict: dict[str, object]
+ realm_host: str
+ # The per-recipient inputs process_message_event uses to decide
+ # push and email notifications.
+ presence_idle_user_ids: list[int]
+ online_push_user_ids: list[int]
+ dm_mention_push_disabled_user_ids: list[int]
+ dm_mention_email_disabled_user_ids: list[int]
+ stream_push_user_ids: list[int]
+ stream_email_user_ids: list[int]
+ topic_wildcard_mention_user_ids: list[int]
+ stream_wildcard_mention_user_ids: list[int]
+ followed_topic_push_user_ids: list[int]
+ followed_topic_email_user_ids: list[int]
+ topic_wildcard_mention_in_followed_topic_user_ids: list[int]
+ stream_wildcard_mention_in_followed_topic_user_ids: list[int]
+ muted_sender_user_ids: list[int]
+ all_bot_user_ids: list[int]
+ push_device_registered_user_ids: list[int]
+ disable_external_notifications: bool
+ # Set for channel messages, to route to clients registered for all
+ # public channels and to withhold the sender from users who cannot
+ # access them.
+ realm_id: int | None = None
+ stream_name: str | None = None
+ realm_guest_user_ids: list[int] | None = None
+ invite_only: bool | None = None
+ is_web_public: bool | None = None
+ user_ids_without_access_to_sender: list[int] | None = None
+ # Echoed back to the sending client only.
+ local_id: str | None = None
+ sender_queue_id: str | None = None
+
+
+class InternalUpdateMessageEvent(UpdateMessageOptionalFields, BaseEvent):
+ # The required fields of UpdateMessageEvent, except flags, which
+ # process_message_update_event adds per recipient, and message_ids,
+ # which do_update_message only knows once the edit has been applied
+ # to every affected message.
+ type: Literal["update_message"] = "update_message"
+ user_id: int | None
+ edit_timestamp: int
+ message_id: int
+ rendering_only: bool
+ message_ids: list[int] | None = None
+ # The per-recipient inputs process_message_update_event uses to
+ # decide push and email notifications, set only for content edits.
+ prior_mention_user_ids: list[int] | None = None
+ presence_idle_user_ids: list[int] | None = None
+ online_push_user_ids: list[int] | None = None
+ dm_mention_push_disabled_user_ids: list[int] | None = None
+ dm_mention_email_disabled_user_ids: list[int] | None = None
+ stream_push_user_ids: list[int] | None = None
+ stream_email_user_ids: list[int] | None = None
+ topic_wildcard_mention_user_ids: list[int] | None = None
+ stream_wildcard_mention_user_ids: list[int] | None = None
+ followed_topic_push_user_ids: list[int] | None = None
+ followed_topic_email_user_ids: list[int] | None = None
+ topic_wildcard_mention_in_followed_topic_user_ids: list[int] | None = None
+ stream_wildcard_mention_in_followed_topic_user_ids: list[int] | None = None
+ muted_sender_user_ids: list[int] | None = None
+ all_bot_user_ids: list[int] | None = None
+ push_device_registered_user_ids: list[int] | None = None
+
+
class InternalUserGroupAddEvent(UserGroupAddEvent):
# Lets process_user_group_creation_event skip clients that never
# stopped seeing the group, because they receive deactivated groups.
diff --git a/zerver/lib/types.py b/zerver/lib/types.py
index 605e3ce1c62..79edb047bbe 100644
--- a/zerver/lib/types.py
+++ b/zerver/lib/types.py
@@ -2,7 +2,7 @@ from collections.abc import Callable
from dataclasses import dataclass, field
from datetime import datetime
from enum import IntEnum
-from typing import TYPE_CHECKING, Any, TypeAlias, TypeVar
+from typing import TYPE_CHECKING, Any, Literal, TypeAlias, TypeVar
if TYPE_CHECKING:
from zerver.models import Stream
@@ -411,6 +411,9 @@ class AnalyticsDataUploadLevel(IntEnum):
ALL = 3
+PropagateMode = Literal["change_all", "change_later", "change_one"]
+
+
@dataclass
class StreamMessageEditRequest:
is_content_edited: bool
@@ -426,7 +429,7 @@ class StreamMessageEditRequest:
orig_content: str
orig_topic_name: str
orig_stream: "Stream"
- propagate_mode: str
+ propagate_mode: PropagateMode
@dataclass
diff --git a/zerver/tests/test_events.py b/zerver/tests/test_events.py
index a93d2315d94..82738d8b3f8 100644
--- a/zerver/tests/test_events.py
+++ b/zerver/tests/test_events.py
@@ -279,6 +279,7 @@ from zerver.lib.topic import TOPIC_NAME
from zerver.lib.types import (
Invitee,
ProfileDataElementUpdateDict,
+ PropagateMode,
UserGroupMembersData,
UserGroupMembersDict,
)
@@ -1046,7 +1047,7 @@ class NormalActionsTest(BaseAction):
# Verify stream message editing - topic only
topic_name = "new_topic"
- propagate_mode = "change_all"
+ propagate_mode: PropagateMode = "change_all"
message_edit_request = build_message_edit_request(
message=message,
diff --git a/zerver/tests/test_message_edit.py b/zerver/tests/test_message_edit.py
index f64df3f543a..d5a894ab0e1 100644
--- a/zerver/tests/test_message_edit.py
+++ b/zerver/tests/test_message_edit.py
@@ -1750,10 +1750,10 @@ class EditMessageTest(ZulipTestCase):
called = False
for call_args in mock_send_event.call_args_list:
(_arg_realm, arg_event, arg_notified_users) = call_args[0]
- if arg_event["type"] == "update_message":
- self.assertEqual(arg_event["type"], "update_message")
+ if arg_event.type == "update_message":
+ self.assertEqual(arg_event.type, "update_message")
self.assertEqual(
- arg_event["topic_wildcard_mention_in_followed_topic_user_ids"], [hamlet.id]
+ arg_event.topic_wildcard_mention_in_followed_topic_user_ids, [hamlet.id]
)
self.assertEqual(
sorted(arg_notified_users, key=itemgetter("id")), users_to_be_notified
@@ -1808,10 +1808,10 @@ class EditMessageTest(ZulipTestCase):
called = False
for call_args in mock_send_event.call_args_list:
(_arg_realm, arg_event, arg_notified_users) = call_args[0]
- if arg_event["type"] == "update_message":
- self.assertEqual(arg_event["type"], "update_message")
+ if arg_event.type == "update_message":
+ self.assertEqual(arg_event.type, "update_message")
self.assertEqual(
- arg_event["stream_wildcard_mention_in_followed_topic_user_ids"], [hamlet.id]
+ arg_event.stream_wildcard_mention_in_followed_topic_user_ids, [hamlet.id]
)
self.assertEqual(
sorted(arg_notified_users, key=itemgetter("id")), users_to_be_notified
@@ -1863,9 +1863,9 @@ class EditMessageTest(ZulipTestCase):
called = False
for call_args in mock_send_event.call_args_list:
(_arg_realm, arg_event, arg_notified_users) = call_args[0]
- if arg_event["type"] == "update_message":
- self.assertEqual(arg_event["type"], "update_message")
- self.assertEqual(arg_event["topic_wildcard_mention_user_ids"], [hamlet.id])
+ if arg_event.type == "update_message":
+ self.assertEqual(arg_event.type, "update_message")
+ self.assertEqual(arg_event.topic_wildcard_mention_user_ids, [hamlet.id])
self.assertEqual(
sorted(arg_notified_users, key=itemgetter("id")), users_to_be_notified
)
@@ -1924,9 +1924,9 @@ class EditMessageTest(ZulipTestCase):
called = False
for call_args in mock_send_event.call_args_list:
(_arg_realm, arg_event, arg_notified_users) = call_args[0]
- if arg_event["type"] == "update_message":
- self.assertEqual(arg_event["type"], "update_message")
- self.assertEqual(arg_event["stream_wildcard_mention_user_ids"], [])
+ if arg_event.type == "update_message":
+ self.assertEqual(arg_event.type, "update_message")
+ self.assertEqual(arg_event.stream_wildcard_mention_user_ids, [])
self.assertEqual(
sorted(arg_notified_users, key=itemgetter("id")), users_to_be_notified
)
@@ -2049,10 +2049,10 @@ class EditMessageTest(ZulipTestCase):
called = False
for call_args in mock_send_event.call_args_list:
(_arg_realm, arg_event, arg_notified_users) = call_args[0]
- if arg_event["type"] == "update_message":
- self.assertEqual(arg_event["type"], "update_message")
+ if arg_event.type == "update_message":
+ self.assertEqual(arg_event.type, "update_message")
self.assertEqual(
- arg_event["stream_wildcard_mention_user_ids"], [cordelia.id, hamlet.id]
+ arg_event.stream_wildcard_mention_user_ids, [cordelia.id, hamlet.id]
)
self.assertEqual(
sorted(arg_notified_users, key=itemgetter("id")), users_to_be_notified
@@ -2112,9 +2112,9 @@ class EditMessageTest(ZulipTestCase):
called = False
for call_args in mock_send_event.call_args_list:
(_arg_realm, arg_event, arg_notified_users) = call_args[0]
- if arg_event["type"] == "update_message":
- self.assertEqual(arg_event["type"], "update_message")
- self.assertEqual(arg_event["stream_wildcard_mention_user_ids"], [])
+ if arg_event.type == "update_message":
+ self.assertEqual(arg_event.type, "update_message")
+ self.assertEqual(arg_event.stream_wildcard_mention_user_ids, [])
self.assertEqual(
sorted(arg_notified_users, key=itemgetter("id")), users_to_be_notified
)
diff --git a/zerver/views/message_edit.py b/zerver/views/message_edit.py
index b28982ba378..38714bc84a8 100644
--- a/zerver/views/message_edit.py
+++ b/zerver/views/message_edit.py
@@ -1,5 +1,4 @@
from datetime import timedelta
-from typing import Literal
import orjson
from django.contrib.auth.models import AnonymousUser
@@ -27,7 +26,7 @@ from zerver.lib.streams import can_delete_any_message_in_channel, can_delete_own
from zerver.lib.timestamp import datetime_to_timestamp
from zerver.lib.topic import maybe_rename_empty_topic_to_general_chat
from zerver.lib.typed_endpoint import OptionalTopic, PathOnly, typed_endpoint
-from zerver.lib.types import EditHistoryEvent, FormattedEditHistoryEvent
+from zerver.lib.types import EditHistoryEvent, FormattedEditHistoryEvent, PropagateMode
from zerver.models import Message, UserProfile
from zerver.models.realms import MessageEditHistoryVisibilityPolicyEnum
from zerver.models.streams import Stream, get_stream_by_id_in_realm
@@ -154,7 +153,7 @@ def update_message_backend(
content: str | None = None,
message_id: PathOnly[NonNegativeInt],
prev_content_sha256: str | None = None,
- propagate_mode: Literal["change_later", "change_one", "change_all"] = "change_one",
+ propagate_mode: PropagateMode = "change_one",
send_notification_to_new_thread: Json[bool] = True,
send_notification_to_old_thread: Json[bool] = False,
stream_id: Json[NonNegativeInt] | None = None,