Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
events: Use pydantic types for the remaining single-field rewrites.
Evy Kassirer133c2ffca2d1
diff --git a/zerver/actions/create_user.py b/zerver/actions/create_user.pyindex a7d5ae1f07d..2ed2b585980 100644--- a/zerver/actions/create_user.py+++ b/zerver/actions/create_user.py@@ -23,14 +23,22 @@ from zerver.actions.user_groups import ()from zerver.actions.users import (change_user_is_active,- get_service_dicts_for_bot,+ get_services_for_bot,send_update_events_for_anonymous_group_settings,)from zerver.lib.avatar import generate_and_upload_jdenticon_avatarfrom zerver.lib.create_user import create_userfrom zerver.lib.default_streams import get_slim_realm_default_streamsfrom zerver.lib.email_notifications import enqueue_welcome_emails, send_account_registered_email+from zerver.lib.event_types import (+ Bot,+ PersonIsActive,+ RealmBotAddEvent,+ RealmExportConsentEvent,+ RealmUserUpdateEvent,+)from zerver.lib.exceptions import JsonableError+from zerver.lib.internal_event_types import InternalRealmUserAddEventfrom zerver.lib.invites import notify_invites_changedfrom zerver.lib.mention import silent_mention_syntax_for_userfrom zerver.lib.send_email import clear_scheduled_invitation_emails@@ -458,27 +466,29 @@ def notify_created_user(user_profile: UserProfile, notify_user_ids: list[int]) -if user_ids_with_real_email_access:assert person_for_real_email_access_users is not None- event: dict[str, Any] = dict(- type="realm_user", op="add", person=person_for_real_email_access_users+ event = InternalRealmUserAddEvent.model_validate(+ dict(person=person_for_real_email_access_users, inaccessible_user=False))send_event_on_commit(user_profile.realm, event, user_ids_with_real_email_access)if user_ids_without_real_email_access:assert person_for_without_real_email_access_users is not None- event = dict(type="realm_user", op="add", person=person_for_without_real_email_access_users)+ event = InternalRealmUserAddEvent.model_validate(+ dict(person=person_for_without_real_email_access_users, inaccessible_user=False)+ )send_event_on_commit(user_profile.realm, event, user_ids_without_real_email_access)if user_ids_without_access_to_created_user:- event = dict(- type="realm_user",- op="add",- person=get_data_for_inaccessible_user(user_profile.realm, user_profile.id),- inaccessible_user=True,+ event = InternalRealmUserAddEvent.model_validate(+ dict(+ person=get_data_for_inaccessible_user(user_profile.realm, user_profile.id),+ inaccessible_user=True,+ ))send_event_on_commit(user_profile.realm, event, user_ids_without_access_to_created_user)-def created_bot_event(user_profile: UserProfile) -> dict[str, Any]:+def created_bot_event(user_profile: UserProfile) -> RealmBotAddEvent:def stream_name(stream: Stream | None) -> str | None:if not stream:return None@@ -487,15 +497,15 @@ def created_bot_event(user_profile: UserProfile) -> dict[str, Any]:default_sending_stream_name = stream_name(user_profile.default_sending_stream)default_events_register_stream_name = stream_name(user_profile.default_events_register_stream)- bot = dict(+ bot = Bot(user_id=user_profile.id,default_sending_stream=default_sending_stream_name,default_events_register_stream=default_events_register_stream_name,default_all_public_streams=user_profile.default_all_public_streams,- services=get_service_dicts_for_bot(user_profile.id),+ services=get_services_for_bot(user_profile.id),)- return dict(type="realm_bot", op="add", bot=bot)+ return RealmBotAddEvent(bot=bot)def notify_created_bot(user_profile: UserProfile) -> None:@@ -756,14 +766,11 @@ def do_reactivate_user(user_profile: UserProfile, *, acting_user: UserProfile |update_billing_records_if_needed(user_profile.realm, user=user_profile, event_time=event_time)- event = dict(- type="realm_user", op="update", person=dict(user_id=user_profile.id, is_active=True)- )+ event = RealmUserUpdateEvent(person=PersonIsActive(user_id=user_profile.id, is_active=True))send_event_on_commit(user_profile.realm, event, get_user_ids_who_can_access_user(user_profile))if not user_profile.is_bot:- realm_export_consent_event = dict(- type="realm_export_consent",+ realm_export_consent_event = RealmExportConsentEvent(user_id=user_profile.id,consented=user_profile.allow_private_data_export,)diff --git a/zerver/actions/realm_emoji.py b/zerver/actions/realm_emoji.pyindex da3f5bc2863..3d885eec5b1 100644--- a/zerver/actions/realm_emoji.py+++ b/zerver/actions/realm_emoji.py@@ -8,6 +8,10 @@ from django.utils.translation import gettext as _from zerver.lib.emoji import get_emoji_file_namefrom zerver.lib.exceptions import JsonableError+from zerver.lib.internal_event_types import (+ InternalRealmEmojiAddEvent,+ InternalRealmEmojiUpdateOneEvent,+)from zerver.lib.mime_types import INLINE_MIME_TYPES, bare_content_typefrom zerver.lib.thumbnail import THUMBNAIL_ACCEPT_IMAGE_TYPES, BadImageErrorfrom zerver.lib.upload import upload_emoji_image@@ -60,7 +64,9 @@ def check_add_realm_emoji(# TODO/compatibility: Remove realm_emoji_dict once we can require that clients support# the individual_emoji_changes client capability.realm_emoji_dict = get_all_custom_emoji_for_realm(realm.id)- event = dict(type="realm_emoji", op="add", emoji=new_emoji, realm_emoji=realm_emoji_dict)+ event = InternalRealmEmojiAddEvent.model_validate(+ dict(emoji=new_emoji, realm_emoji=realm_emoji_dict)+ )send_event_on_commit(realm, event, active_user_ids(realm.id))return realm_emoji@@ -85,13 +91,11 @@ def do_remove_realm_emoji(realm: Realm, name: str, *, acting_user: UserProfile |# TODO/compatibility: Remove realm_emoji_dict once we can require that clients support# the individual_emoji_changes client capability.realm_emoji_dict = get_all_custom_emoji_for_realm(realm.id)- event = dict(- type="realm_emoji",- op="update_one",- emoji_id=str(realm_emoji.id),- data=dict(- deactivated=True,- ),- realm_emoji=realm_emoji_dict,+ event = InternalRealmEmojiUpdateOneEvent.model_validate(+ dict(+ emoji_id=str(realm_emoji.id),+ data=dict(deactivated=True),+ realm_emoji=realm_emoji_dict,+ ))send_event_on_commit(realm, event, active_user_ids(realm.id))diff --git a/zerver/actions/users.py b/zerver/actions/users.pyindex 087be81c08f..436a2259374 100644--- a/zerver/actions/users.py+++ b/zerver/actions/users.py@@ -27,7 +27,26 @@ from zerver.actions.user_settings import do_change_avatar_fields, do_change_fullfrom zerver.lib.bot_config import ConfigError, get_bot_config, get_bot_configs, set_bot_configfrom zerver.lib.cache import bot_dict_fields, flush_user_profilefrom zerver.lib.create_user import create_user_profile-from zerver.lib.event_types import BotServicesOutgoing+from zerver.lib.event_types import (+ BasicStreamFields,+ BotServicesEmbedded,+ BotServicesOutgoing,+ BotTypeForUpdate,+ PersonIsActive,+ PersonIsImportedStub,+ PersonRole,+ RealmBotUpdateEvent,+ RealmUpdateDictData,+ RealmUpdateDictEvent,+ RealmUserRemoveEvent,+ RealmUserUpdateEvent,+ RemovedUser,+ SubscriptionPeerAddEvent,+ UserGroupData,+ UserGroupRemoveMembersEvent,+ UserGroupUpdateEvent,+)+from zerver.lib.internal_event_types import InternalStreamCreateEventfrom zerver.lib.invites import revoke_invites_generated_by_userfrom zerver.lib.send_email import FromAddress, clear_scheduled_emails, send_emailfrom zerver.lib.sessions import delete_user_sessions@@ -267,11 +286,11 @@ def send_group_update_event_for_anonymous_group_setting(direct_members=group_members_dict[setting_group.id],direct_subgroups=group_subgroups_dict[setting_group.id],)- event = dict(- type="user_group",- op="update",+ event = UserGroupUpdateEvent(group_id=named_group.id,- data={setting_name: convert_to_user_group_members_dict(new_setting_value)},+ data=UserGroupData.model_validate(+ {setting_name: convert_to_user_group_members_dict(new_setting_value)}+ ),)send_event_on_commit(realm, event, notify_user_ids)return@@ -290,11 +309,11 @@ def send_realm_update_event_for_anonymous_group_setting(direct_members=group_members_dict[setting_group.id],direct_subgroups=group_subgroups_dict[setting_group.id],)- event = dict(- type="realm",- op="update_dict",+ event = RealmUpdateDictEvent(property="default",- data={setting_name: convert_to_user_group_members_dict(new_setting_value)},+ data=RealmUpdateDictData.model_validate(+ {setting_name: convert_to_user_group_members_dict(new_setting_value)}+ ),)send_event_on_commit(realm, event, notify_user_ids)return@@ -370,10 +389,8 @@ def send_events_for_user_deactivation(user_profile: UserProfile) -> None:send_peer_remove_events(user_profile.realm, streams, altered_user_dict)- event_deactivate_user = dict(- type="realm_user",- op="update",- person=dict(user_id=user_profile.id, is_active=False),+ event_deactivate_user = RealmUserUpdateEvent(+ person=PersonIsActive(user_id=user_profile.id, is_active=False))realm = user_profile.realm@@ -436,12 +453,7 @@ def send_events_for_user_deactivation(user_profile: UserProfile) -> None:else:deactivated_user_named_groups.append(group)for user_group in deactivated_user_named_groups:- event = dict(- type="user_group",- op="remove_members",- group_id=user_group.id,- user_ids=[user_profile.id],- )+ event = UserGroupRemoveMembersEvent(group_id=user_group.id, user_ids=[user_profile.id])send_event_on_commit(user_group.realm, event, list(users_without_access_to_deactivated_user))@@ -457,10 +469,10 @@ def send_events_for_user_deactivation(user_profile: UserProfile) -> None:peer_stream_subscribers - users_with_access_to_deactivated_user)if users_losing_access_to_deactivated_user:- event_remove_user = dict(- type="realm_user",- op="remove",- person=dict(user_id=user_profile.id, full_name=str(UserProfile.INACCESSIBLE_USER_NAME)),+ event_remove_user = RealmUserRemoveEvent(+ person=RemovedUser(+ user_id=user_profile.id, full_name=str(UserProfile.INACCESSIBLE_USER_NAME)+ ),)send_event_on_commit(realm, event_remove_user, list(users_losing_access_to_deactivated_user)@@ -566,13 +578,14 @@ def send_stream_events_for_role_update(now_accessible_streams)- event = dict(- type="stream",- op="create",+ event = InternalStreamCreateEvent(streams=[- stream_to_dict(stream, recent_traffic, anonymous_group_membership)+ BasicStreamFields.model_validate(+ stream_to_dict(stream, recent_traffic, anonymous_group_membership)+ )for stream in now_accessible_streams],+ for_unarchiving=False,)send_event_on_commit(user_profile.realm, event, [user_profile.id])@@ -580,9 +593,7 @@ def send_stream_events_for_role_update(user_profile.realm, now_accessible_streams)for stream_id, stream_subscriber_set in subscriber_peer_info.subscribed_ids.items():- peer_add_event = dict(- type="subscription",- op="peer_add",+ peer_add_event = SubscriptionPeerAddEvent(stream_ids=[stream_id],user_ids=sorted(stream_subscriber_set),)@@ -636,8 +647,8 @@ def do_change_user_role(},)- event = dict(- type="realm_user", op="update", person=dict(user_id=user_profile.id, role=user_profile.role)+ event = RealmUserUpdateEvent(+ person=PersonRole.model_validate(dict(user_id=user_profile.id, role=user_profile.role)))send_event_on_commit(user_profile.realm, event, get_user_ids_who_can_access_user(user_profile))@@ -821,22 +832,15 @@ def do_update_outgoing_webhook_service(service.save(update_fields=updated_fields)- # Keep the event payload of the updated bot service in sync with the- # schema expected by `bot_data.update()` method.- updated_service: dict[str, str | int] = BotServicesOutgoing(+ updated_service = BotServicesOutgoing(base_url=service.base_url,interface=service.interface,token=service.token,- ).model_dump()+ )send_event_on_commit(bot_profile.realm,- dict(- type="realm_bot",- op="update",- bot=dict(- user_id=bot_profile.id,- services=[updated_service],- ),+ RealmBotUpdateEvent(+ bot=BotTypeForUpdate(user_id=bot_profile.id, services=[updated_service])),bot_owner_user_ids(bot_profile),)@@ -847,39 +851,42 @@ def do_update_bot_config_data(bot_profile: UserProfile, config_data: dict[str, sfor key, value in config_data.items():set_bot_config(bot_profile, key, value)updated_config_data = get_bot_config(bot_profile)+ [service] = get_bot_services(bot_profile.id)send_event_on_commit(bot_profile.realm,- dict(- type="realm_bot",- op="update",- bot=dict(+ RealmBotUpdateEvent(+ bot=BotTypeForUpdate(user_id=bot_profile.id,- services=[dict(config_data=updated_config_data)],- ),+ services=[+ BotServicesEmbedded(service_name=service.name, config_data=updated_config_data)+ ],+ )),bot_owner_user_ids(bot_profile),)-def get_service_dicts_for_bot(user_profile_id: int) -> list[dict[str, Any]]:+def get_services_for_bot(+ user_profile_id: int,+) -> list[BotServicesOutgoing | BotServicesEmbedded]:user_profile = get_user_profile_by_id(user_profile_id)services = get_bot_services(user_profile_id)if user_profile.bot_type == UserProfile.OUTGOING_WEBHOOK_BOT:return [- {- "base_url": service.base_url,- "interface": service.interface,- "token": service.token,- }+ BotServicesOutgoing(+ base_url=service.base_url,+ interface=service.interface,+ token=service.token,+ )for service in services]elif user_profile.bot_type == UserProfile.EMBEDDED_BOT:try:return [- {- "config_data": get_bot_config(user_profile),- "service_name": services[0].name,- }+ BotServicesEmbedded(+ config_data=get_bot_config(user_profile),+ service_name=services[0].name,+ )]# A ConfigError just means that there are no config entries for user_profile.except ConfigError:@@ -1026,7 +1033,7 @@ def do_change_is_imported_stub(user_profile: UserProfile) -> None:event_time=timezone_now(),)- event = dict(- type="realm_user", op="update", person=dict(user_id=user_profile.id, is_imported_stub=False)+ event = RealmUserUpdateEvent(+ person=PersonIsImportedStub(user_id=user_profile.id, is_imported_stub=False))send_event_on_commit(user_profile.realm, event, get_user_ids_who_can_access_user(user_profile))diff --git a/zerver/lib/event_types.py b/zerver/lib/event_types.pyindex e331d027947..b65198a4a86 100644--- a/zerver/lib/event_types.py+++ b/zerver/lib/event_types.py@@ -496,8 +496,8 @@ class RealmEmoji(BaseEventModel):class RealmEmojiAddEvent(BaseEvent):- type: Literal["realm_emoji"]- op: Literal["add"]+ type: Literal["realm_emoji"] = "realm_emoji"+ op: Literal["add"] = "add"emoji: RealmEmoji@@ -506,8 +506,8 @@ class RealmEmojiUpdateData(BaseEventModel):class RealmEmojiUpdateOneEvent(BaseEvent):- type: Literal["realm_emoji"]- op: Literal["update_one"]+ type: Literal["realm_emoji"] = "realm_emoji"+ op: Literal["update_one"] = "update_one"emoji_id: strdata: RealmEmojiUpdateData@@ -676,8 +676,8 @@ class RealmBotUser(RealmUserCore):class RealmUserAddEvent(BaseEvent):- type: Literal["realm_user"]- op: Literal["add"]+ type: Literal["realm_user"] = "realm_user"+ op: Literal["add"] = "add"person: Annotated[RealmHumanUser | RealmBotUser, Field(discriminator="is_bot")]@@ -910,14 +910,14 @@ class BasicStreamFields(BaseEventModel):class StreamCreateEvent(BaseEvent):- type: Literal["stream"]- op: Literal["create"]+ type: Literal["stream"] = "stream"+ op: Literal["create"] = "create"streams: list[BasicStreamFields]class StreamDeleteEvent(BaseEvent):- type: Literal["stream"]- op: Literal["delete"]+ type: Literal["stream"] = "stream"+ op: Literal["delete"] = "delete"# Streams is a legacy field for backwards-compatibility, and will# be removed in the future.streams: list[dict[Literal["stream_id"], int]]diff --git a/zerver/lib/internal_event_types.py b/zerver/lib/internal_event_types.pyindex 59d1b7cafc1..ba3db4690da 100644--- a/zerver/lib/internal_event_types.py+++ b/zerver/lib/internal_event_types.py@@ -10,11 +10,48 @@ from zerver.lib.event_types import (DeleteMessageEvent,LegacyPresence,ModernPresence,+ RealmEmoji,+ RealmEmojiAddEvent,+ RealmEmojiUpdateOneEvent,+ RealmUserAddEvent,+ StreamCreateEvent,+ StreamDeleteEvent,UserGroupAddEvent,UserGroupUpdateEvent,)+class InternalRealmEmojiAddEvent(RealmEmojiAddEvent):+ # The full emoji dict, which process_realm_emoji_event sends as a+ # realm_emoji/update event to clients without the+ # individual_emoji_changes capability.+ realm_emoji: dict[str, RealmEmoji]+++class InternalRealmEmojiUpdateOneEvent(RealmEmojiUpdateOneEvent):+ realm_emoji: dict[str, RealmEmoji]+++class InternalRealmUserAddEvent(RealmUserAddEvent):+ # Lets process_realm_user_add_event skip clients with the+ # user_list_incomplete capability, which do not track users they+ # cannot access.+ inaccessible_user: bool+++class InternalStreamCreateEvent(StreamCreateEvent):+ # Lets process_stream_creation_event skip clients that never+ # stopped seeing the channel, because they receive archived+ # channels.+ for_unarchiving: bool+++class InternalStreamDeleteEvent(StreamDeleteEvent):+ # Lets process_stream_deletion_event skip clients that keep+ # seeing the channel, because they receive archived channels.+ for_archiving: bool++class InternalDeleteMessageEvent(DeleteMessageEvent):# Always the bulk form; process_deletion_event expands it into one# message_id event per message for clients without thediff --git a/zerver/lib/streams.py b/zerver/lib/streams.pyindex b38bc7d28f0..fed558468cc 100644--- a/zerver/lib/streams.py+++ b/zerver/lib/streams.py@@ -10,7 +10,7 @@ from django.utils.timezone import now as timezone_nowfrom django.utils.translation import gettext as _from zerver.lib.default_streams import get_default_stream_ids_for_realm-from zerver.lib.event_types import StreamUpdateEvent+from zerver.lib.event_types import BasicStreamFields, StreamUpdateEventfrom zerver.lib.exceptions import (CannotAdministerChannelError,CannotSetTopicsPolicyError,@@ -20,6 +20,7 @@ from zerver.lib.exceptions import (MissingAuthenticationError,OrganizationOwnerRequiredError,)+from zerver.lib.internal_event_types import InternalStreamCreateEvent, InternalStreamDeleteEventfrom zerver.lib.partial import partialfrom zerver.lib.stream_subscription import (get_guest_user_ids_for_streams,@@ -224,10 +225,12 @@ def send_stream_creation_event(anonymous_group_membership: dict[int, UserGroupMembersData] | None = None,for_unarchiving: bool = False,) -> None:- event = dict(- type="stream",- op="create",- streams=[stream_to_dict(stream, recent_traffic, anonymous_group_membership)],+ event = InternalStreamCreateEvent(+ streams=[+ BasicStreamFields.model_validate(+ stream_to_dict(stream, recent_traffic, anonymous_group_membership)+ )+ ],for_unarchiving=for_unarchiving,)send_event_on_commit(realm, event, user_ids)@@ -2157,11 +2160,9 @@ def check_update_all_streams_active_status(def send_stream_deletion_event(realm: Realm, user_ids: Iterable[int], streams: list[Stream], for_archiving: bool = False) -> None:- stream_deletion_event = dict(- type="stream",- op="delete",+ stream_deletion_event = InternalStreamDeleteEvent(# "streams" is deprecated, kept only for compatibility.- streams=[dict(stream_id=stream.id) for stream in streams],+ streams=[{"stream_id": stream.id} for stream in streams],stream_ids=[stream.id for stream in streams],for_archiving=for_archiving,)diff --git a/zerver/tests/test_events.py b/zerver/tests/test_events.pyindex 11213a23a02..a93d2315d94 100644--- a/zerver/tests/test_events.py+++ b/zerver/tests/test_events.py@@ -164,6 +164,7 @@ from zerver.actions.user_topics import do_set_user_topic_visibility_policyfrom zerver.actions.users import (do_change_is_imported_stub,do_deactivate_user,+ do_update_bot_config_data,do_update_outgoing_webhook_service,)from zerver.actions.video_calls import do_set_video_call_provider_token@@ -3696,6 +3697,23 @@ class NormalActionsTest(BaseAction):acting_user=self.user_profile,)+ def test_do_update_bot_config_data(self) -> None:+ bot = self.create_bot(+ "test_embedded",+ full_name="Embedded Bot",+ service_name="helloworld",+ config_data=orjson.dumps({"foo": "bar"}).decode(),+ bot_type=UserProfile.EMBEDDED_BOT,+ )+ with self.verify_action() as events:+ do_update_bot_config_data(bot, {"foo": "baz"})++ check_realm_bot_update("events[0]", events[0], "services")+ self.assertEqual(+ events[0]["bot"]["services"],+ [{"service_name": "helloworld", "config_data": {"foo": "baz"}}],+ )+def test_do_deactivate_bot(self) -> None:bot = self.create_bot("test")with self.verify_action(num_events=1) as events: