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: Refactor RealmUpdateDictEvent to use a Realm representation.

Ben Prewebf693e6547f
diff --git a/zerver/actions/realm_icon.py b/zerver/actions/realm_icon.py
index b8ae5050a93..607f659d162 100644
--- a/zerver/actions/realm_icon.py
+++ b/zerver/actions/realm_icon.py
@@ -1,7 +1,7 @@
from django.db import transaction
from django.utils.timezone import now as timezone_now
-from zerver.lib.event_types import IconData, RealmUpdateDictEvent
+from zerver.lib.event_types import RealmUpdateDictData, RealmUpdateDictEvent
from zerver.lib.realm_icon import realm_icon_url
from zerver.models import Realm, RealmAuditLog, UserProfile
from zerver.models.realm_audit_logs import AuditLogEventType
@@ -28,7 +28,7 @@ def do_change_icon_source(
event = RealmUpdateDictEvent(
property="icon",
- data=IconData(icon_source=realm.icon_source, icon_url=realm_icon_url(realm)),
+ data=RealmUpdateDictData(icon_source=realm.icon_source, icon_url=realm_icon_url(realm)),
)
send_event_on_commit(
realm,
diff --git a/zerver/actions/realm_settings.py b/zerver/actions/realm_settings.py
index f1118c61879..17702ab7b35 100644
--- a/zerver/actions/realm_settings.py
+++ b/zerver/actions/realm_settings.py
@@ -18,15 +18,9 @@ from zerver.actions.user_groups import update_users_in_full_members_system_group
from zerver.actions.user_settings import do_scrub_avatar_images
from zerver.lib.demo_organizations import demo_organization_owner_email_exists
from zerver.lib.event_types import (
- AllowMessageEditingData,
- AuthenticationData,
BaseEvent,
- GroupSettingUpdateData,
- MessageContentEditLimitSecondsData,
- PlanTypeData,
RealmDeactivatedEvent,
- RealmDescriptionData,
- RealmTopicsPolicyData,
+ RealmUpdateDictData,
RealmUpdateDictEvent,
RealmUpdateEvent,
RealmUserSettingsDefaultsUpdateEvent,
@@ -123,12 +117,12 @@ def do_set_realm_property(
if name == "allow_message_editing":
event = RealmUpdateDictEvent(
property="default",
- data=AllowMessageEditingData(allow_message_editing=value),
+ data=RealmUpdateDictData(allow_message_editing=value),
)
if name == "message_content_edit_limit_seconds":
event = RealmUpdateDictEvent(
property="default",
- data=MessageContentEditLimitSecondsData(message_content_edit_limit_seconds=value),
+ data=RealmUpdateDictData(message_content_edit_limit_seconds=value),
)
if name == "message_edit_history_visibility_policy":
event = RealmUpdateEvent(
@@ -138,7 +132,7 @@ def do_set_realm_property(
if name == "topics_policy":
event = RealmUpdateDictEvent(
property="default",
- data=RealmTopicsPolicyData(
+ data=RealmUpdateDictData(
topics_policy=RealmTopicsPolicyEnum(value).name,
mandatory_topics=value == RealmTopicsPolicyEnum.disable_empty_topic.value,
),
@@ -147,7 +141,7 @@ def do_set_realm_property(
assert realm.rendered_description is not None
event = RealmUpdateDictEvent(
property="default",
- data=RealmDescriptionData(
+ data=RealmUpdateDictData(
description=realm.description,
rendered_description=realm.rendered_description,
),
@@ -247,8 +241,8 @@ def do_change_realm_permission_group_setting(
event = RealmUpdateDictEvent(
property="default",
- data=GroupSettingUpdateData(
- **{setting_name: convert_to_user_group_members_dict(new_setting_api_value)}
+ data=RealmUpdateDictData.model_validate(
+ {setting_name: convert_to_user_group_members_dict(new_setting_api_value)}
),
)
@@ -430,7 +424,7 @@ def do_set_realm_authentication_methods(
event = RealmUpdateDictEvent(
property="default",
- data=AuthenticationData(
+ data=RealmUpdateDictData(
authentication_methods=get_realm_authentication_methods_for_page_params_api(
realm, updated_value
)
@@ -996,7 +990,7 @@ def do_change_realm_plan_type(
event = RealmUpdateDictEvent(
property="default",
- data=PlanTypeData(
+ data=RealmUpdateDictData(
plan_type=plan_type,
upload_quota_mib=optional_bytes_to_mib(realm.upload_quota_bytes()),
max_file_upload_size_mib=realm.get_max_file_upload_size_mebibytes(),
diff --git a/zerver/lib/event_schema.py b/zerver/lib/event_schema.py
index ccf07160012..04f3513be96 100644
--- a/zerver/lib/event_schema.py
+++ b/zerver/lib/event_schema.py
@@ -15,11 +15,9 @@ from pydantic import BaseModel
from zerver.lib.event_types import (
AlertWordsEvent,
- AllowMessageEditingData,
AttachmentAddEvent,
AttachmentRemoveEvent,
AttachmentUpdateEvent,
- AuthenticationData,
BaseEvent,
BotServicesEmbedded,
BotServicesOutgoing,
@@ -37,15 +35,11 @@ from zerver.lib.event_types import (
DraftsAddEvent,
DraftsRemoveEvent,
DraftsUpdateEvent,
- GroupSettingUpdateData,
HasWebexTokenEvent,
HasZoomTokenEvent,
HeartbeatEvent,
- IconData,
InvitesChangedEvent,
LegacyPresenceEvent,
- LogoData,
- MessageContentEditLimitSecondsData,
MessageEvent,
ModernPresenceEvent,
MutedTopicsEvent,
@@ -53,7 +47,6 @@ from zerver.lib.event_types import (
NavigationViewAddEvent,
NavigationViewRemoveEvent,
NavigationViewUpdateEvent,
- NightLogoData,
OnboardingStepsEvent,
PersonAvatarFields,
PersonBotOwnerId,
@@ -66,14 +59,12 @@ from zerver.lib.event_types import (
PersonIsImportedStub,
PersonRole,
PersonTimezone,
- PlanTypeData,
ReactionAddEvent,
ReactionRemoveEvent,
RealmBotAddEvent,
RealmBotDeleteEvent,
RealmBotUpdateEvent,
RealmDeactivatedEvent,
- RealmDescriptionData,
RealmDomainsAddEvent,
RealmDomainsChangeEvent,
RealmDomainsRemoveEvent,
@@ -84,7 +75,6 @@ from zerver.lib.event_types import (
RealmExportEvent,
RealmLinkifiersEvent,
RealmPlaygroundsEvent,
- RealmTopicsPolicyData,
RealmUpdateDictEvent,
RealmUpdateEvent,
RealmUserAddEvent,
@@ -208,6 +198,7 @@ check_realm_emoji_update_one = make_checker(RealmEmojiUpdateOneEvent)
check_realm_export_consent = make_checker(RealmExportConsentEvent)
check_realm_linkifiers = make_checker(RealmLinkifiersEvent)
check_realm_playgrounds = make_checker(RealmPlaygroundsEvent)
+check_realm_update_dict = make_checker(RealmUpdateDictEvent)
check_realm_user_add = make_checker(RealmUserAddEvent)
check_realm_user_remove = make_checker(RealmUserRemoveEvent)
check_reminder_add = make_checker(RemindersAddEvent)
@@ -268,7 +259,6 @@ _check_realm_default_update = make_checker(RealmUserSettingsDefaultsUpdateEvent)
_check_realm_emoji_update = make_checker(RealmEmojiUpdateEvent)
_check_realm_export = make_checker(RealmExportEvent)
_check_realm_update = make_checker(RealmUpdateEvent)
-_check_realm_update_dict = make_checker(RealmUpdateDictEvent)
_check_realm_user_update = make_checker(RealmUserUpdateEvent)
_check_stream_update = make_checker(StreamUpdateEvent)
_check_subscription_update = make_checker(SubscriptionUpdateEvent)
@@ -526,47 +516,6 @@ def check_realm_default_update(
assert isinstance(value, prop_type)
-def check_realm_update_dict(
- # handle union types
- var_name: str,
- event: dict[str, object],
-) -> None:
- _check_realm_update_dict(var_name, event)
-
- if event["property"] == "default":
- assert isinstance(event["data"], dict)
-
- if "allow_message_editing" in event["data"]:
- sub_type: type[BaseModel] = AllowMessageEditingData
- elif "message_content_edit_limit_seconds" in event["data"]:
- sub_type = MessageContentEditLimitSecondsData
- elif "authentication_methods" in event["data"]:
- sub_type = AuthenticationData
- elif any(
- setting_name in event["data"] for setting_name in Realm.REALM_PERMISSION_GROUP_SETTINGS
- ):
- sub_type = GroupSettingUpdateData
- elif "plan_type" in event["data"]:
- sub_type = PlanTypeData
- elif "topics_policy" in event["data"]:
- sub_type = RealmTopicsPolicyData
- elif "description" in event["data"]:
- sub_type = RealmDescriptionData
- else:
- raise AssertionError("unhandled fields in data")
-
- elif event["property"] == "icon":
- sub_type = IconData
- elif event["property"] == "logo":
- sub_type = LogoData
- elif event["property"] == "night_logo":
- sub_type = NightLogoData
- else:
- raise AssertionError("unhandled property: {event['property']}")
-
- validate_with_model(cast(dict[str, object], event["data"]), sub_type)
-
-
def check_realm_user_update(
# person_flavor tells us which extra fields we need
var_name: str,
diff --git a/zerver/lib/event_types.py b/zerver/lib/event_types.py
index 541074070d5..379b9529ad7 100644
--- a/zerver/lib/event_types.py
+++ b/zerver/lib/event_types.py
@@ -567,10 +567,6 @@ class RealmPlaygroundsEvent(BaseEvent):
realm_playgrounds: list[RealmPlayground]
-class AllowMessageEditingData(BaseEventModel):
- allow_message_editing: bool
-
-
class AuthenticationMethodDictCore(BaseEventModel):
enabled: bool
available: bool
@@ -581,45 +577,26 @@ class AuthenticationMethodDict(AuthenticationMethodDictCore):
unavailable_reason: str | None = None
-class AuthenticationData(BaseEventModel):
- authentication_methods: dict[str, AuthenticationMethodDict]
-
-
-class IconData(BaseEventModel):
- icon_url: str
- icon_source: str
-
-
-class LogoData(BaseEventModel):
- logo_url: str
- logo_source: str
-
-
-class MessageContentEditLimitSecondsData(BaseEventModel):
- message_content_edit_limit_seconds: int | None
-
-
-class RealmTopicsPolicyData(BaseEventModel):
- topics_policy: str
- mandatory_topics: bool
-
-
-class RealmDescriptionData(BaseEventModel):
- description: str
- rendered_description: str
-
-
-class NightLogoData(BaseEventModel):
- night_logo_url: str
- night_logo_source: str
-
-
-class GroupSettingUpdateDataCore(BaseEventModel):
- pass
-
-
-class GroupSettingUpdateData(GroupSettingUpdateDataCore):
- # TODO: fix types to avoid optional fields
+class RealmUpdateDictData(BaseEventModel):
+ # Every field is optional: each event sets only the subset of
+ # fields that changed, and unset fields are omitted when the event
+ # is sent.
+ allow_message_editing: bool | None = None
+ message_content_edit_limit_seconds: int | None = None
+ topics_policy: str | None = None
+ mandatory_topics: bool | None = None
+ description: str | None = None
+ rendered_description: str | None = None
+ authentication_methods: dict[str, AuthenticationMethodDict] | None = None
+ plan_type: int | None = None
+ upload_quota_mib: int | None = None
+ max_file_upload_size_mib: int | None = None
+ icon_url: str | None = None
+ icon_source: str | None = None
+ logo_url: str | None = None
+ logo_source: str | None = None
+ night_logo_url: str | None = None
+ night_logo_source: str | None = None
create_multiuse_invite_group: int | UserGroupMembersDict | None = None
can_access_all_users_group: int | UserGroupMembersDict | None = None
can_add_custom_emoji_group: int | UserGroupMembersDict | None = None
@@ -647,28 +624,11 @@ class GroupSettingUpdateData(GroupSettingUpdateDataCore):
workplace_users_group: int | UserGroupMembersDict | None = None
-class PlanTypeData(BaseEventModel):
- plan_type: int
- upload_quota_mib: int | None
- max_file_upload_size_mib: int
-
-
class RealmUpdateDictEvent(BaseEvent):
type: Literal["realm"] = "realm"
op: Literal["update_dict"] = "update_dict"
property: Literal["default", "icon", "logo", "night_logo"]
- data: (
- AllowMessageEditingData
- | AuthenticationData
- | IconData
- | LogoData
- | MessageContentEditLimitSecondsData
- | NightLogoData
- | GroupSettingUpdateData
- | PlanTypeData
- | RealmTopicsPolicyData
- | RealmDescriptionData
- )
+ data: RealmUpdateDictData
class RealmUpdateEvent(BaseEvent):
diff --git a/zerver/lib/realm_logo.py b/zerver/lib/realm_logo.py
index d3a971636cd..fb493171000 100644
--- a/zerver/lib/realm_logo.py
+++ b/zerver/lib/realm_logo.py
@@ -1,7 +1,7 @@
from django.conf import settings
from django.contrib.staticfiles.storage import staticfiles_storage
-from zerver.lib.event_types import LogoData, NightLogoData
+from zerver.lib.event_types import RealmUpdateDictData
from zerver.lib.upload import get_uploaded_realm_logo_url
from zerver.models import Realm
@@ -28,10 +28,12 @@ def get_realm_logo_url(realm: Realm, night: bool) -> str:
return staticfiles_storage.url("images/logo/zulip-org-logo.svg") + "?version=0"
-def get_realm_logo_data(realm: Realm, night: bool) -> LogoData | NightLogoData:
+def get_realm_logo_data(realm: Realm, night: bool) -> RealmUpdateDictData:
if night:
- return NightLogoData(
+ return RealmUpdateDictData(
night_logo_url=get_realm_logo_url(realm, night),
night_logo_source=realm.night_logo_source,
)
- return LogoData(logo_url=get_realm_logo_url(realm, night), logo_source=realm.logo_source)
+ return RealmUpdateDictData(
+ logo_url=get_realm_logo_url(realm, night), logo_source=realm.logo_source
+ )