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.

channel_folders events: Use ChannelFolder pydantic types.

Evy Kassirer7d9325fe5252
diff --git a/zerver/actions/channel_folders.py b/zerver/actions/channel_folders.py
index e26e2fecf61..080d4e11846 100644
--- a/zerver/actions/channel_folders.py
+++ b/zerver/actions/channel_folders.py
@@ -5,6 +5,13 @@ from django.utils.timezone import now as timezone_now
from django.utils.translation import gettext as _
from zerver.lib.channel_folders import get_channel_folder_data, render_channel_folder_description
+from zerver.lib.event_types import (
+ ChannelFolderAddEvent,
+ ChannelFolderDataForUpdate,
+ ChannelFolderForChannelFolderAddEvent,
+ ChannelFolderReorderEvent,
+ ChannelFolderUpdateEvent,
+)
from zerver.lib.exceptions import JsonableError
from zerver.models import ChannelFolder, Realm, RealmAuditLog, UserProfile
from zerver.models.realm_audit_logs import AuditLogEventType
@@ -38,10 +45,10 @@ def check_add_channel_folder(
modified_channel_folder=channel_folder,
)
- event = dict(
- type="channel_folder",
- op="add",
- channel_folder=asdict(get_channel_folder_data(channel_folder)),
+ event = ChannelFolderAddEvent(
+ channel_folder=ChannelFolderForChannelFolderAddEvent(
+ **asdict(get_channel_folder_data(channel_folder))
+ ),
)
send_event_on_commit(realm, event, active_user_ids(realm.id))
@@ -59,19 +66,15 @@ def try_reorder_realm_channel_folders(realm: Realm, order: list[int]) -> None:
channel_folder.order = order_mapping[channel_folder.id]
channel_folder.save(update_fields=["order"])
- event = dict(
- type="channel_folder",
- op="reorder",
- order=order,
- )
+ event = ChannelFolderReorderEvent(order=order)
send_event_on_commit(realm, event, active_user_ids(realm.id))
def do_send_channel_folder_update_event(
- channel_folder: ChannelFolder, data: dict[str, str | bool]
+ channel_folder: ChannelFolder, data: ChannelFolderDataForUpdate
) -> None:
realm = channel_folder.realm
- event = dict(type="channel_folder", op="update", channel_folder_id=channel_folder.id, data=data)
+ event = ChannelFolderUpdateEvent(channel_folder_id=channel_folder.id, data=data)
send_event_on_commit(realm, event, active_user_ids(realm.id))
@@ -95,7 +98,7 @@ def do_change_channel_folder_name(
},
)
- do_send_channel_folder_update_event(channel_folder, dict(name=name))
+ do_send_channel_folder_update_event(channel_folder, ChannelFolderDataForUpdate(name=name))
@transaction.atomic(durable=True)
@@ -123,7 +126,10 @@ def do_change_channel_folder_description(
)
do_send_channel_folder_update_event(
- channel_folder, dict(description=description, rendered_description=rendered_description)
+ channel_folder,
+ ChannelFolderDataForUpdate(
+ description=description, rendered_description=rendered_description
+ ),
)
@@ -140,7 +146,9 @@ def do_archive_channel_folder(channel_folder: ChannelFolder, *, acting_user: Use
modified_channel_folder=channel_folder,
)
- do_send_channel_folder_update_event(channel_folder, dict(is_archived=True))
+ do_send_channel_folder_update_event(
+ channel_folder, ChannelFolderDataForUpdate(is_archived=True)
+ )
@transaction.atomic(durable=True)
@@ -156,4 +164,6 @@ def do_unarchive_channel_folder(channel_folder: ChannelFolder, *, acting_user: U
modified_channel_folder=channel_folder,
)
- do_send_channel_folder_update_event(channel_folder, dict(is_archived=False))
+ do_send_channel_folder_update_event(
+ channel_folder, ChannelFolderDataForUpdate(is_archived=False)
+ )
diff --git a/zerver/lib/event_types.py b/zerver/lib/event_types.py
index 4d485db8229..736101b5447 100644
--- a/zerver/lib/event_types.py
+++ b/zerver/lib/event_types.py
@@ -76,8 +76,8 @@ class ChannelFolderForChannelFolderAddEvent(BaseModel):
class ChannelFolderAddEvent(BaseEvent):
- type: Literal["channel_folder"]
- op: Literal["add"]
+ type: Literal["channel_folder"] = "channel_folder"
+ op: Literal["add"] = "add"
channel_folder: ChannelFolderForChannelFolderAddEvent
@@ -90,14 +90,14 @@ class ChannelFolderDataForUpdate(BaseModel):
class ChannelFolderReorderEvent(BaseEvent):
- type: Literal["channel_folder"]
- op: Literal["reorder"]
+ type: Literal["channel_folder"] = "channel_folder"
+ op: Literal["reorder"] = "reorder"
order: list[int]
class ChannelFolderUpdateEvent(BaseEvent):
- type: Literal["channel_folder"]
- op: Literal["update"]
+ type: Literal["channel_folder"] = "channel_folder"
+ op: Literal["update"] = "update"
channel_folder_id: int
data: ChannelFolderDataForUpdate