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.

event_types: Split RealmUser into human and bot variants.

Evy Kassirer507f143b13d7
diff --git a/web/tests/lib/events.cjs b/web/tests/lib/events.cjs
index bca1aebd9f3..ae88704007c 100644
--- a/web/tests/lib/events.cjs
+++ b/web/tests/lib/events.cjs
@@ -652,6 +652,7 @@ exports.fixtures = {
role: Role.MEMBER,
is_bot: false,
is_guest: false,
+ is_imported_stub: false,
profile_data: {},
timezone: "America/New_York",
date_joined: "2020-01-01",
@@ -672,7 +673,9 @@ exports.fixtures = {
role: Role.MEMBER,
is_bot: true,
is_guest: false,
- profile_data: {},
+ is_imported_stub: false,
+ bot_type: 1,
+ bot_owner_id: 11,
timezone: "America/New_York",
date_joined: "2020-01-01",
delivery_email: "[email protected]",
diff --git a/zerver/lib/event_types.py b/zerver/lib/event_types.py
index b050db61ffc..4d485db8229 100644
--- a/zerver/lib/event_types.py
+++ b/zerver/lib/event_types.py
@@ -2,7 +2,7 @@ from typing import Annotated, Literal
from django.core.exceptions import ValidationError
from django.core.validators import URLValidator
-from pydantic import AfterValidator, BaseModel
+from pydantic import AfterValidator, BaseModel, Field
from zerver.lib.types import UserGroupMembersDict
from zerver.models.realms import RealmExportSlug
@@ -678,7 +678,7 @@ class RealmUpdateEvent(BaseEvent):
rendered_description: str | None = None
-class RealmUser(BaseModel):
+class RealmUserCore(BaseModel):
user_id: int
email: str
avatar_url: str | None
@@ -686,20 +686,34 @@ class RealmUser(BaseModel):
full_name: str
is_admin: bool
is_owner: bool
- is_bot: bool
is_guest: bool
role: Literal[100, 200, 300, 400, 600]
is_active: bool
- profile_data: dict[str, dict[str, object]]
+ is_imported_stub: bool
timezone: str
date_joined: str
delivery_email: str | None
+ # TODO: fix types to avoid optional fields
+ is_deleted: bool | None = None
+
+
+class RealmHumanUser(RealmUserCore):
+ is_bot: Literal[False]
+ profile_data: dict[str, dict[str, object]]
+
+
+class RealmBotUser(RealmUserCore):
+ is_bot: Literal[True]
+ bot_type: int
+ bot_owner_id: int | None
+ # TODO: fix types to avoid optional fields
+ is_system_bot: bool | None = None
class RealmUserAddEvent(BaseEvent):
type: Literal["realm_user"]
op: Literal["add"]
- person: RealmUser
+ person: Annotated[RealmHumanUser | RealmBotUser, Field(discriminator="is_bot")]
class RemovedUser(BaseModel):
diff --git a/zerver/tests/test_events.py b/zerver/tests/test_events.py
index 0b60b2614b7..398464fc529 100644
--- a/zerver/tests/test_events.py
+++ b/zerver/tests/test_events.py
@@ -3518,6 +3518,12 @@ class NormalActionsTest(BaseAction):
self.create_bot("test")
check_realm_bot_add("events[3]", events[3], UserProfile.DEFAULT_BOT)
+ # Bots also get a realm_user/add event, whose person carries
+ # the bot-only fields.
+ [user_add_event] = (event for event in events if event["type"] == "realm_user")
+ check_realm_user_add("realm_user_add_event", user_add_event)
+ self.assertEqual(user_add_event["person"]["bot_type"], UserProfile.DEFAULT_BOT)
+
with self.verify_action(num_events=4) as events:
self.create_bot(
"test_outgoing_webhook",