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.

saved_snippets events: Use SavedSnippetsAdd/Update/Remove types.

Evy Kassirerec1ec200b2f8
diff --git a/zerver/actions/saved_snippets.py b/zerver/actions/saved_snippets.py
index 522ac9d169f..d3a8a2d3372 100644
--- a/zerver/actions/saved_snippets.py
+++ b/zerver/actions/saved_snippets.py
@@ -4,6 +4,12 @@ from django.db import transaction
from django.utils.timezone import now as timezone_now
from django.utils.translation import gettext as _
+from zerver.lib.event_types import (
+ SavedSnippetFields,
+ SavedSnippetsAddEvent,
+ SavedSnippetsRemoveEvent,
+ SavedSnippetsUpdateEvent,
+)
from zerver.lib.exceptions import ResourceNotFoundError
from zerver.models import RealmAuditLog, SavedSnippet, UserProfile
from zerver.models.realm_audit_logs import AuditLogEventType
@@ -32,11 +38,9 @@ def do_create_saved_snippet(
extra_data={"saved_snippet_id": saved_snippet.id},
)
- event = {
- "type": "saved_snippets",
- "op": "add",
- "saved_snippet": saved_snippet.to_api_dict(),
- }
+ event = SavedSnippetsAddEvent(
+ saved_snippet=SavedSnippetFields(**saved_snippet.to_api_dict()),
+ )
send_event_on_commit(user_profile.realm, event, [user_profile.id])
return saved_snippet
@@ -61,11 +65,9 @@ def do_edit_saved_snippet(
with transaction.atomic(durable=True):
saved_snippet.save()
- event = {
- "type": "saved_snippets",
- "op": "update",
- "saved_snippet": saved_snippet.to_api_dict(),
- }
+ event = SavedSnippetsUpdateEvent(
+ saved_snippet=SavedSnippetFields(**saved_snippet.to_api_dict()),
+ )
send_event_on_commit(user_profile.realm, event, [user_profile.id])
return saved_snippet
@@ -87,5 +89,5 @@ def do_delete_saved_snippet(
raise ResourceNotFoundError(_("Saved snippet does not exist."))
saved_snippet.delete()
- event = {"type": "saved_snippets", "op": "remove", "saved_snippet_id": saved_snippet_id}
+ event = SavedSnippetsRemoveEvent(saved_snippet_id=saved_snippet_id)
send_event_on_commit(user_profile.realm, event, [user_profile.id])
diff --git a/zerver/lib/event_types.py b/zerver/lib/event_types.py
index c711524e427..e3a01ae7635 100644
--- a/zerver/lib/event_types.py
+++ b/zerver/lib/event_types.py
@@ -820,20 +820,20 @@ class SavedSnippetFields(BaseModel):
class SavedSnippetsAddEvent(BaseEvent):
- type: Literal["saved_snippets"]
- op: Literal["add"]
+ type: Literal["saved_snippets"] = "saved_snippets"
+ op: Literal["add"] = "add"
saved_snippet: SavedSnippetFields
class SavedSnippetsUpdateEvent(BaseEvent):
- type: Literal["saved_snippets"]
- op: Literal["update"]
+ type: Literal["saved_snippets"] = "saved_snippets"
+ op: Literal["update"] = "update"
saved_snippet: SavedSnippetFields
class SavedSnippetsRemoveEvent(BaseEvent):
- type: Literal["saved_snippets"]
- op: Literal["remove"]
+ type: Literal["saved_snippets"] = "saved_snippets"
+ op: Literal["remove"] = "remove"
saved_snippet_id: int