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.

navigation_views events: Use NavigationView pydantic types.

Evy Kassirer8f98e820a18d
diff --git a/zerver/actions/navigation_views.py b/zerver/actions/navigation_views.py
index 6e4fd97f809..fe2b1c9e724 100644
--- a/zerver/actions/navigation_views.py
+++ b/zerver/actions/navigation_views.py
@@ -1,12 +1,26 @@
+from typing import TypedDict
+
from django.db import transaction
from django.utils.timezone import now as timezone_now
+from zerver.lib.event_types import (
+ NavigationViewAddEvent,
+ NavigationViewFields,
+ NavigationViewFieldsForUpdate,
+ NavigationViewRemoveEvent,
+ NavigationViewUpdateEvent,
+)
from zerver.lib.navigation_views import get_navigation_view_dict
from zerver.models import NavigationView, RealmAuditLog, UserProfile
from zerver.models.realm_audit_logs import AuditLogEventType
from zerver.tornado.django_api import send_event_on_commit
+class NavigationViewUpdateDict(TypedDict, total=False):
+ name: str
+ is_pinned: bool
+
+
@transaction.atomic(durable=True)
def do_add_navigation_view(
user: UserProfile,
@@ -30,11 +44,9 @@ def do_add_navigation_view(
extra_data={"fragment": fragment},
)
- event = {
- "type": "navigation_view",
- "op": "add",
- "navigation_view": get_navigation_view_dict(navigation_view),
- }
+ event = NavigationViewAddEvent(
+ navigation_view=NavigationViewFields(**get_navigation_view_dict(navigation_view)),
+ )
send_event_on_commit(user.realm, event, [user.id])
return navigation_view
@@ -46,7 +58,10 @@ def do_update_navigation_view(
is_pinned: bool | None,
name: str | None = None,
) -> None:
- update_dict: dict[str, str | bool] = {}
+ # Only the fields the caller actually updated flow through to the
+ # event's data payload, so the serialized event omits keys for
+ # unchanged values (matching the legacy dict-based behavior).
+ update_dict: NavigationViewUpdateDict = {}
audit_logs_extra_data: list[dict[str, str | bool | None]] = []
if name is not None:
old_name = navigation_view.name
@@ -87,12 +102,10 @@ def do_update_navigation_view(
extra_data=audit_log_extra_data,
)
- event = {
- "type": "navigation_view",
- "op": "update",
- "fragment": navigation_view.fragment,
- "data": update_dict,
- }
+ event = NavigationViewUpdateEvent(
+ fragment=navigation_view.fragment,
+ data=NavigationViewFieldsForUpdate(**update_dict),
+ )
send_event_on_commit(user.realm, event, [user.id])
@@ -113,9 +126,5 @@ def do_remove_navigation_view(
extra_data={"fragment": fragment},
)
- event = {
- "type": "navigation_view",
- "op": "remove",
- "fragment": navigation_view.fragment,
- }
+ event = NavigationViewRemoveEvent(fragment=navigation_view.fragment)
send_event_on_commit(user.realm, event, [user.id])
diff --git a/zerver/lib/event_types.py b/zerver/lib/event_types.py
index e3a01ae7635..bc1e415b5a2 100644
--- a/zerver/lib/event_types.py
+++ b/zerver/lib/event_types.py
@@ -322,14 +322,14 @@ class NavigationViewFields(BaseModel):
class NavigationViewAddEvent(BaseEvent):
- type: Literal["navigation_view"]
- op: Literal["add"]
+ type: Literal["navigation_view"] = "navigation_view"
+ op: Literal["add"] = "add"
navigation_view: NavigationViewFields
class NavigationViewRemoveEvent(BaseEvent):
- type: Literal["navigation_view"]
- op: Literal["remove"]
+ type: Literal["navigation_view"] = "navigation_view"
+ op: Literal["remove"] = "remove"
fragment: str
@@ -339,8 +339,8 @@ class NavigationViewFieldsForUpdate(BaseModel):
class NavigationViewUpdateEvent(BaseEvent):
- type: Literal["navigation_view"]
- op: Literal["update"]
+ type: Literal["navigation_view"] = "navigation_view"
+ op: Literal["update"] = "update"
fragment: str
data: NavigationViewFieldsForUpdate