Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
event_types: Forbid undeclared fields on event models.
Evy Kassirerbbd3d677d47c
diff --git a/zerver/lib/event_schema.py b/zerver/lib/event_schema.pyindex 8a1a62b8f5e..bf0a749cf8c 100644--- a/zerver/lib/event_schema.py+++ b/zerver/lib/event_schema.py@@ -135,10 +135,6 @@ from zerver.models.streams import StreamTopicsPolicyEnumdef validate_with_model(data: dict[str, object], model: type[BaseModel]) -> None:- allowed_fields = set(model.model_fields.keys())- if not set(data.keys()).issubset(allowed_fields): # nocoverage- raise ValueError(f"Extra fields not allowed: {set(data.keys()) - allowed_fields}")-model.model_validate(data, strict=True)diff --git a/zerver/lib/event_types.py b/zerver/lib/event_types.pyindex 9f888822de5..b6dab21f702 100644--- a/zerver/lib/event_types.py+++ b/zerver/lib/event_types.py@@ -2,7 +2,7 @@ from typing import Annotated, Literalfrom django.core.exceptions import ValidationErrorfrom django.core.validators import URLValidator-from pydantic import AfterValidator, BaseModel, Field+from pydantic import AfterValidator, BaseModel, ConfigDict, Fieldfrom zerver.lib.types import UserGroupMembersDictfrom zerver.models.realms import RealmExportSlug@@ -21,7 +21,14 @@ Url = Annotated[str, AfterValidator(check_url)]ReactionType = Literal["realm_emoji", "unicode_emoji", "zulip_extra_emoji"]-class BaseEvent(BaseModel):+# BaseEventModel is the BaseModel for events+class BaseEventModel(BaseModel):+ # An undeclared field is a schema bug; fail at construction rather+ # than silently dropping it from the event clients receive.+ model_config = ConfigDict(extra="forbid")+++class BaseEvent(BaseEventModel):pass@@ -30,7 +37,7 @@ class AlertWordsEvent(BaseEvent):alert_words: list[str]-class Attachment(BaseModel):+class Attachment(BaseEventModel):id: intname: strsize: int@@ -46,7 +53,7 @@ class AttachmentAddEvent(BaseEvent):upload_space_used: int-class AttachmentFieldForAttachmentRemoveEvent(BaseModel):+class AttachmentFieldForAttachmentRemoveEvent(BaseEventModel):id: int@@ -64,7 +71,7 @@ class AttachmentUpdateEvent(BaseEvent):upload_space_used: int-class ChannelFolderForChannelFolderAddEvent(BaseModel):+class ChannelFolderForChannelFolderAddEvent(BaseEventModel):id: intname: strdescription: str@@ -81,7 +88,7 @@ class ChannelFolderAddEvent(BaseEvent):channel_folder: ChannelFolderForChannelFolderAddEvent-class ChannelFolderDataForUpdate(BaseModel):+class ChannelFolderDataForUpdate(BaseEventModel):# TODO: fix types to avoid optional fieldsname: str | None = Nonedescription: str | None = None@@ -102,7 +109,7 @@ class ChannelFolderUpdateEvent(BaseEvent):data: ChannelFolderDataForUpdate-class DetailedCustomProfileCore(BaseModel):+class DetailedCustomProfileCore(BaseEventModel):id: inttype: intname: str@@ -124,7 +131,7 @@ class CustomProfileFieldsEvent(BaseEvent):fields: list[DetailedCustomProfile]-class StreamGroup(BaseModel):+class StreamGroup(BaseEventModel):name: strid: intdescription: str@@ -154,19 +161,19 @@ class DeleteMessageEvent(DeleteMessageCoreEvent):topic: str | None = None-class TopicLink(BaseModel):+class TopicLink(BaseEventModel):text: strurl: str-class DirectMessageDisplayRecipient(BaseModel):+class DirectMessageDisplayRecipient(BaseEventModel):id: intis_mirror_dummy: boolemail: strfull_name: str-class MessageFieldForDirectMessageEvent(BaseModel):+class MessageFieldForDirectMessageEvent(BaseEventModel):avatar_url: str | Noneclient: strcontent: str@@ -193,7 +200,7 @@ class DirectMessageEvent(BaseEvent):message: MessageFieldForDirectMessageEvent-class DraftFieldsCore(BaseModel):+class DraftFieldsCore(BaseEventModel):id: inttype: Literal["", "private", "stream"]to: list[int]@@ -242,7 +249,7 @@ class InvitesChangedEvent(BaseEvent):type: Literal["invites_changed"]-class MessageFieldForMessageEvent(BaseModel):+class MessageFieldForMessageEvent(BaseEventModel):avatar_url: str | Noneclient: strcontent: str@@ -275,7 +282,7 @@ class MutedTopicsEvent(BaseEvent):muted_topics: list[list[str | int]]-class MutedUser(BaseModel):+class MutedUser(BaseEventModel):id: inttimestamp: int@@ -285,7 +292,7 @@ class MutedUsersEvent(BaseEvent):muted_users: list[MutedUser]-class OnboardingSteps(BaseModel):+class OnboardingSteps(BaseEventModel):type: strname: str@@ -318,7 +325,7 @@ class DeviceUpdateEvent(BaseEvent):push_registration_error_code: str | None = None-class NavigationViewFields(BaseModel):+class NavigationViewFields(BaseEventModel):fragment: stris_pinned: boolname: str | None@@ -336,7 +343,7 @@ class NavigationViewRemoveEvent(BaseEvent):fragment: str-class NavigationViewFieldsForUpdate(BaseModel):+class NavigationViewFieldsForUpdate(BaseEventModel):is_pinned: bool | None = Nonename: str | None = None@@ -348,7 +355,7 @@ class NavigationViewUpdateEvent(BaseEvent):data: NavigationViewFieldsForUpdate-class LegacyPresence(BaseModel):+class LegacyPresence(BaseEventModel):status: Literal["active", "idle"]timestamp: intclient: str@@ -367,7 +374,7 @@ class LegacyPresenceEvent(LegacyPresenceCoreEvent):email: str | None = None-class ModernPresence(BaseModel):+class ModernPresence(BaseEventModel):active_timestamp: intidle_timestamp: int@@ -397,18 +404,18 @@ class ReactionRemoveEvent(BaseEvent):user_id: int-class BotServicesOutgoing(BaseModel):+class BotServicesOutgoing(BaseEventModel):base_url: Urlinterface: inttoken: str-class BotServicesEmbedded(BaseModel):+class BotServicesEmbedded(BaseEventModel):service_name: strconfig_data: dict[str, str]-class Bot(BaseModel):+class Bot(BaseEventModel):user_id: intdefault_all_public_streams: booldefault_events_register_stream: str | None@@ -422,7 +429,7 @@ class RealmBotAddEvent(BaseEvent):bot: Bot-class BotTypeForDelete(BaseModel):+class BotTypeForDelete(BaseEventModel):user_id: int@@ -432,7 +439,7 @@ class RealmBotDeleteEvent(BaseEvent):bot: BotTypeForDelete-class BotTypeForUpdateCore(BaseModel):+class BotTypeForUpdateCore(BaseEventModel):user_id: int@@ -456,7 +463,7 @@ class RealmDeactivatedEvent(BaseEvent):realm_id: int-class RealmDomain(BaseModel):+class RealmDomain(BaseEventModel):domain: strallow_subdomains: bool@@ -479,7 +486,7 @@ class RealmDomainsRemoveEvent(BaseEvent):domain: str-class RealmEmoji(BaseModel):+class RealmEmoji(BaseEventModel):id: strname: strsource_url: str@@ -494,7 +501,7 @@ class RealmEmojiAddEvent(BaseEvent):emoji: RealmEmoji-class RealmEmojiUpdateData(BaseModel):+class RealmEmojiUpdateData(BaseEventModel):deactivated: bool | None = None@@ -517,7 +524,7 @@ class RealmExportConsentEvent(BaseEvent):consented: bool-class Export(BaseModel):+class Export(BaseEventModel):id: intexport_time: float | intacting_user_id: int@@ -534,7 +541,7 @@ class RealmExportEvent(BaseEvent):exports: list[Export]-class RealmLinkifier(BaseModel):+class RealmLinkifier(BaseEventModel):pattern: strurl_template: strid: int@@ -548,7 +555,7 @@ class RealmLinkifiersEvent(BaseEvent):realm_linkifiers: list[RealmLinkifier]-class RealmPlayground(BaseModel):+class RealmPlayground(BaseEventModel):id: intname: strpygments_language: str@@ -560,11 +567,11 @@ class RealmPlaygroundsEvent(BaseEvent):realm_playgrounds: list[RealmPlayground]-class AllowMessageEditingData(BaseModel):+class AllowMessageEditingData(BaseEventModel):allow_message_editing: bool-class AuthenticationMethodDictCore(BaseModel):+class AuthenticationMethodDictCore(BaseEventModel):enabled: boolavailable: bool@@ -574,40 +581,40 @@ class AuthenticationMethodDict(AuthenticationMethodDictCore):unavailable_reason: str | None = None-class AuthenticationData(BaseModel):+class AuthenticationData(BaseEventModel):authentication_methods: dict[str, AuthenticationMethodDict]-class IconData(BaseModel):+class IconData(BaseEventModel):icon_url: stricon_source: str-class LogoData(BaseModel):+class LogoData(BaseEventModel):logo_url: strlogo_source: str-class MessageContentEditLimitSecondsData(BaseModel):+class MessageContentEditLimitSecondsData(BaseEventModel):message_content_edit_limit_seconds: int | None-class RealmTopicsPolicyData(BaseModel):+class RealmTopicsPolicyData(BaseEventModel):topics_policy: strmandatory_topics: bool-class RealmDescriptionData(BaseModel):+class RealmDescriptionData(BaseEventModel):description: strrendered_description: str-class NightLogoData(BaseModel):+class NightLogoData(BaseEventModel):night_logo_url: strnight_logo_source: str-class GroupSettingUpdateDataCore(BaseModel):+class GroupSettingUpdateDataCore(BaseEventModel):pass@@ -640,7 +647,7 @@ class GroupSettingUpdateData(GroupSettingUpdateDataCore):workplace_users_group: int | UserGroupMembersDict | None = None-class PlanTypeData(BaseModel):+class PlanTypeData(BaseEventModel):plan_type: intupload_quota_mib: int | Nonemax_file_upload_size_mib: int@@ -672,7 +679,7 @@ class RealmUpdateEvent(BaseEvent):rendered_description: str | None = None-class RealmUserCore(BaseModel):+class RealmUserCore(BaseEventModel):user_id: intemail: stravatar_url: str | None@@ -710,7 +717,7 @@ class RealmUserAddEvent(BaseEvent):person: Annotated[RealmHumanUser | RealmBotUser, Field(discriminator="is_bot")]-class RemovedUser(BaseModel):+class RemovedUser(BaseEventModel):user_id: intfull_name: str@@ -728,7 +735,7 @@ class RealmUserSettingsDefaultsUpdateEvent(BaseEvent):value: bool | int | str-class PersonAvatarFields(BaseModel):+class PersonAvatarFields(BaseEventModel):user_id: intavatar_source: stravatar_url: str | None@@ -736,12 +743,12 @@ class PersonAvatarFields(BaseModel):avatar_version: int-class PersonBotOwnerId(BaseModel):+class PersonBotOwnerId(BaseEventModel):user_id: intbot_owner_id: int-class CustomProfileFieldCore(BaseModel):+class CustomProfileFieldCore(BaseEventModel):id: intvalue: str | None@@ -751,48 +758,48 @@ class CustomProfileField(CustomProfileFieldCore):rendered_value: str | None = None-class PersonCustomProfileField(BaseModel):+class PersonCustomProfileField(BaseEventModel):user_id: intcustom_profile_field: CustomProfileField-class PersonDeliveryEmail(BaseModel):+class PersonDeliveryEmail(BaseEventModel):user_id: intdelivery_email: str | None-class PersonEmail(BaseModel):+class PersonEmail(BaseEventModel):user_id: intnew_email: str-class PersonFullName(BaseModel):+class PersonFullName(BaseEventModel):user_id: intfull_name: str-class PersonRole(BaseModel):+class PersonRole(BaseEventModel):user_id: introle: Literal[100, 200, 300, 400, 600]-class PersonTimezone(BaseModel):+class PersonTimezone(BaseEventModel):user_id: intemail: strtimezone: str-class PersonIsActive(BaseModel):+class PersonIsActive(BaseEventModel):user_id: intis_active: bool-class PersonIsImportedStub(BaseModel):+class PersonIsImportedStub(BaseEventModel):user_id: intis_imported_stub: bool-class PersonDateJoined(BaseModel):+class PersonDateJoined(BaseEventModel):user_id: intdate_joined: str@@ -823,7 +830,7 @@ class RestartEvent(BaseEvent):server_generation: int-class SavedSnippetFields(BaseModel):+class SavedSnippetFields(BaseEventModel):id: inttitle: strcontent: str@@ -848,7 +855,7 @@ class SavedSnippetsRemoveEvent(BaseEvent):saved_snippet_id: int-class ScheduledMessageFieldsCore(BaseModel):+class ScheduledMessageFieldsCore(BaseEventModel):scheduled_message_id: inttype: Literal["private", "stream"]to: list[int] | int@@ -881,7 +888,7 @@ class ScheduledMessagesUpdateEvent(BaseEvent):scheduled_message: ScheduledMessageFields-class ReminderFields(BaseModel):+class ReminderFields(BaseEventModel):reminder_id: inttype: Literal["private"]to: list[int]@@ -904,7 +911,7 @@ class RemindersRemoveEvent(BaseEvent):reminder_id: int-class BasicStreamFields(BaseModel):+class BasicStreamFields(BaseEventModel):is_archived: boolcan_add_subscribers_group: int | UserGroupMembersDictcan_administer_channel_group: int | UserGroupMembersDict@@ -978,7 +985,7 @@ class SubmessageEvent(BaseEvent):content: str-class SingleSubscription(BaseModel):+class SingleSubscription(BaseEventModel):is_archived: boolcan_add_subscribers_group: int | UserGroupMembersDictcan_administer_channel_group: int | UserGroupMembersDict@@ -1042,7 +1049,7 @@ class SubscriptionPeerRemoveEvent(BaseEvent):stream_ids: list[int]-class RemoveSub(BaseModel):+class RemoveSub(BaseEventModel):name: strstream_id: int@@ -1061,7 +1068,7 @@ class SubscriptionUpdateEvent(BaseEvent):value: bool | int | str-class TypingPerson(BaseModel):+class TypingPerson(BaseEventModel):email: struser_id: int@@ -1094,13 +1101,13 @@ class TypingStopEvent(TypingStopCoreEvent):topic: str | None = None-class RecipientFieldForTypingEditChannelMessage(BaseModel):+class RecipientFieldForTypingEditChannelMessage(BaseEventModel):type: Literal["channel"]channel_id: inttopic: str-class RecipientFieldForTypingEditDirectMessage(BaseModel):+class RecipientFieldForTypingEditDirectMessage(BaseEventModel):type: Literal["direct"]user_ids: list[int]@@ -1156,7 +1163,7 @@ class UpdateMessageFlagsAddEvent(BaseEvent):all: bool-class MessageDetailsCore(BaseModel):+class MessageDetailsCore(BaseEventModel):type: Literal["private", "stream"]@@ -1183,7 +1190,7 @@ class UpdateMessageFlagsRemoveEvent(UpdateMessageFlagsRemoveCoreEvent):message_details: dict[str, MessageDetails] | None = None-class Group(BaseModel):+class Group(BaseEventModel):id: intname: strcreator_id: int | None@@ -1241,7 +1248,7 @@ class UserGroupRemoveSubgroupsEvent(BaseEvent):direct_subgroup_ids: list[int]-class UserGroupDataCore(BaseModel):+class UserGroupDataCore(BaseEventModel):passdiff --git a/zerver/tests/test_events.py b/zerver/tests/test_events.pyindex 4ca8a3a60c1..b91f5c284fb 100644--- a/zerver/tests/test_events.py+++ b/zerver/tests/test_events.py@@ -5,6 +5,7 @@# and zerver/lib/data_types.py systems for validating the schemas of# events; it also uses the OpenAPI tools to validate our documentation.import copy+import inspectimport timefrom collections.abc import Callable, Iteratorfrom contextlib import contextmanager@@ -17,6 +18,7 @@ from unittest import mockimport orjsonimport time_machinefrom django.utils.timezone import now as timezone_now+from pydantic import BaseModelfrom typing_extensions import overridefrom zerver.actions.alert_words import do_add_alert_words, do_remove_alert_words@@ -164,6 +166,7 @@ from zerver.actions.users import (do_update_outgoing_webhook_service,)from zerver.actions.video_calls import do_set_video_call_provider_token+from zerver.lib import event_typesfrom zerver.lib.drafts import DraftData, do_create_drafts, do_delete_draft, do_edit_draftfrom zerver.lib.event_schema import (check_alert_words,@@ -5897,3 +5900,12 @@ class ChannelFolderActionTest(BaseAction):check_channel_folder_reorder("events[0]", events[0])self.assertEqual(events[0]["order"], new_order)+++class EventTypesTest(ZulipTestCase):+ def test_models_forbid_extra_fields(self) -> None:+ # A model extending pydantic's BaseModel directly would fall+ # back to extra="ignore" and silently drop undeclared fields.+ for name, model in inspect.getmembers(event_types, inspect.isclass):+ if model.__module__ == event_types.__name__ and issubclass(model, BaseModel):+ self.assertEqual(model.model_config.get("extra"), "forbid", name)