Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

notifications: Remove the stray notification trigger strings. 

This commit removes the stray strings used to refer to
various types of notification triggers.

We use the attributes of the 'NotificationTriggers' class instead.
This commit is contained in:
Prakhar Pratyush 2023-07-24 17:56:43 +05:30 committed by Tim Abbott
parent e760e57bce
commit af648833f2
10 changed files with 189 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
zerver/actions/message_send.py
View File

@ -80,6 +80,7 @@ from zerver.lib.widget import do_widget_post_save_actions
from zerver.models import (
Client,
Message,
NotificationTriggers,
Realm,
Recipient,
Stream,
@ -516,7 +517,7 @@ def get_service_bot_events(
trigger = "mention"
# Direct message triggers for personal and huddle messages
elif (not is_stream) and (user_profile_id in active_user_ids):
trigger = "private_message"
trigger = NotificationTriggers.PRIVATE_MESSAGE
else:
return

25
zerver/lib/email_notifications.py
View File

@ -451,28 +451,29 @@ def do_send_missedmessage_events_reply_in_zulip(
unique_triggers = set(triggers)
personal_mentioned = any(
message["trigger"] == "mentioned" and message["mentioned_user_group_id"] is None
message["trigger"] == NotificationTriggers.MENTION
and message["mentioned_user_group_id"] is None
for message in missed_messages
)
mention = (
"mentioned" in unique_triggers
or "topic_wildcard_mentioned" in unique_triggers
or "stream_wildcard_mentioned" in unique_triggers
or "topic_wildcard_mentioned_in_followed_topic" in unique_triggers
or "stream_wildcard_mentioned_in_followed_topic" in unique_triggers
NotificationTriggers.MENTION in unique_triggers
or NotificationTriggers.TOPIC_WILDCARD_MENTION in unique_triggers
or NotificationTriggers.STREAM_WILDCARD_MENTION in unique_triggers
or NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC in unique_triggers
or NotificationTriggers.STREAM_WILDCARD_MENTION_IN_FOLLOWED_TOPIC in unique_triggers
)
context.update(
mention=mention,
personal_mentioned=personal_mentioned,
topic_wildcard_mentioned="topic_wildcard_mentioned" in unique_triggers,
stream_wildcard_mentioned="stream_wildcard_mentioned" in unique_triggers,
stream_email_notify="stream_email_notify" in unique_triggers,
followed_topic_email_notify="followed_topic_email_notify" in unique_triggers,
topic_wildcard_mentioned_in_followed_topic="topic_wildcard_mentioned_in_followed_topic"
topic_wildcard_mentioned=NotificationTriggers.TOPIC_WILDCARD_MENTION in unique_triggers,
stream_wildcard_mentioned=NotificationTriggers.STREAM_WILDCARD_MENTION in unique_triggers,
stream_email_notify=NotificationTriggers.STREAM_EMAIL in unique_triggers,
followed_topic_email_notify=NotificationTriggers.FOLLOWED_TOPIC_EMAIL in unique_triggers,
topic_wildcard_mentioned_in_followed_topic=NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC
in unique_triggers,
stream_wildcard_mentioned_in_followed_topic="stream_wildcard_mentioned_in_followed_topic"
stream_wildcard_mentioned_in_followed_topic=NotificationTriggers.STREAM_WILDCARD_MENTION_IN_FOLLOWED_TOPIC
in unique_triggers,
mentioned_user_group_name=mentioned_user_group_name,
)

5
zerver/lib/notification_data.py
View File

@ -323,7 +323,10 @@ def get_mentioned_user_group_name(
messages instead.
"""
for message in messages:
if message["mentioned_user_group_id"] is None and message["trigger"] == "mentioned":
if (
message["mentioned_user_group_id"] is None
and message["trigger"] == NotificationTriggers.MENTION
):
# The user has also been personally mentioned, so that gets prioritized.
return None

12
zerver/lib/soft_deactivation.py
View File

@ -14,6 +14,7 @@ from zerver.lib.queue import queue_json_publish
from zerver.lib.utils import assert_is_not_none
from zerver.models import (
Message,
NotificationTriggers,
Realm,
RealmAuditLog,
Recipient,
@ -417,11 +418,16 @@ def soft_reactivate_if_personal_notification(
if not user_profile.long_term_idle:
return
private_message = "private_message" in unique_triggers
personal_mention = "mentioned" in unique_triggers and mentioned_user_group_name is None
private_message = NotificationTriggers.PRIVATE_MESSAGE in unique_triggers
personal_mention = (
NotificationTriggers.MENTION in unique_triggers and mentioned_user_group_name is None
)
topic_wildcard_mention = any(
trigger in unique_triggers
for trigger in ["topic_wildcard_mentioned", "topic_wildcard_mentioned_in_followed_topic"]
for trigger in [
NotificationTriggers.TOPIC_WILDCARD_MENTION,
NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC,
]
)
if not private_message and not personal_mention and not topic_wildcard_mention:
return

146
zerver/tests/test_email_notifications.py
View File

@ -37,6 +37,7 @@ from zerver.lib.email_notifications import (
from zerver.lib.send_email import FromAddress, deliver_scheduled_emails, send_custom_email
from zerver.lib.test_classes import ZulipTestCase
from zerver.models import (
NotificationTriggers,
Realm,
ScheduledEmail,
UserMessage,
@ -548,7 +549,8 @@ class TestMissedMessages(ZulipTestCase):
"zerver.lib.email_notifications.do_send_missedmessage_events_reply_in_zulip"
) as m:
handle_missedmessage_emails(
cordelia.id, {message.id: MissedMessageData(trigger="private_message")}
cordelia.id,
{message.id: MissedMessageData(trigger=NotificationTriggers.PRIVATE_MESSAGE)},
)
m.assert_not_called()
@ -557,7 +559,8 @@ class TestMissedMessages(ZulipTestCase):
"zerver.lib.email_notifications.do_send_missedmessage_events_reply_in_zulip"
) as m:
handle_missedmessage_emails(
hamlet.id, {message.id: MissedMessageData(trigger="private_message")}
hamlet.id,
{message.id: MissedMessageData(trigger=NotificationTriggers.PRIVATE_MESSAGE)},
)
m.assert_called_once()
@ -573,7 +576,8 @@ class TestMissedMessages(ZulipTestCase):
"zerver.lib.email_notifications.do_send_missedmessage_events_reply_in_zulip"
) as m:
handle_missedmessage_emails(
hamlet.id, {message.id: MissedMessageData(trigger="private_message")}
hamlet.id,
{message.id: MissedMessageData(trigger=NotificationTriggers.PRIVATE_MESSAGE)},
)
m.assert_not_called()
@ -702,7 +706,7 @@ class TestMissedMessages(ZulipTestCase):
send_as_user,
show_message_content=show_message_content,
verify_body_does_not_include=verify_body_does_not_include,
trigger="mentioned",
trigger=NotificationTriggers.MENTION,
)
def _extra_context_in_missed_stream_messages_topic_wildcard_mention_in_followed_topic(
@ -743,7 +747,7 @@ class TestMissedMessages(ZulipTestCase):
send_as_user,
show_message_content=show_message_content,
verify_body_does_not_include=verify_body_does_not_include,
trigger="topic_wildcard_mentioned_in_followed_topic",
trigger=NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC,
)
def _extra_context_in_missed_stream_messages_stream_wildcard_mention_in_followed_topic(
@ -785,7 +789,7 @@ class TestMissedMessages(ZulipTestCase):
send_as_user,
show_message_content=show_message_content,
verify_body_does_not_include=verify_body_does_not_include,
trigger="stream_wildcard_mentioned_in_followed_topic",
trigger=NotificationTriggers.STREAM_WILDCARD_MENTION_IN_FOLLOWED_TOPIC,
)
def _extra_context_in_missed_stream_messages_topic_wildcard_mention(
@ -826,7 +830,7 @@ class TestMissedMessages(ZulipTestCase):
send_as_user,
show_message_content=show_message_content,
verify_body_does_not_include=verify_body_does_not_include,
trigger="topic_wildcard_mentioned",
trigger=NotificationTriggers.TOPIC_WILDCARD_MENTION,
)
def _extra_context_in_missed_stream_messages_stream_wildcard_mention(
@ -868,7 +872,7 @@ class TestMissedMessages(ZulipTestCase):
send_as_user,
show_message_content=show_message_content,
verify_body_does_not_include=verify_body_does_not_include,
trigger="stream_wildcard_mentioned",
trigger=NotificationTriggers.STREAM_WILDCARD_MENTION,
)
def _extra_context_in_missed_stream_messages_email_notify(self, send_as_user: bool) -> None:
@ -882,7 +886,11 @@ class TestMissedMessages(ZulipTestCase):
]
email_subject = "#Denmark > test"
self._test_cases(
msg_id, verify_body_include, email_subject, send_as_user, trigger="stream_email_notify"
msg_id,
verify_body_include,
email_subject,
send_as_user,
trigger=NotificationTriggers.STREAM_EMAIL,
)
def _extra_context_in_missed_stream_messages_mention_two_senders(
@ -902,7 +910,11 @@ class TestMissedMessages(ZulipTestCase):
]
email_subject = "#Denmark > test"
self._test_cases(
msg_id, verify_body_include, email_subject, send_as_user, trigger="mentioned"
msg_id,
verify_body_include,
email_subject,
send_as_user,
trigger=NotificationTriggers.MENTION,
)
def _resolved_topic_missed_stream_messages_thread_friendly(self, send_as_user: bool) -> None:
@ -925,7 +937,11 @@ class TestMissedMessages(ZulipTestCase):
]
email_subject = "[resolved] #Denmark > threading and so forth"
self._test_cases(
msg_id, verify_body_include, email_subject, send_as_user, trigger="stream_email_notify"
msg_id,
verify_body_include,
email_subject,
send_as_user,
trigger=NotificationTriggers.STREAM_EMAIL,
)
def _extra_context_in_missed_personal_messages(
@ -1081,7 +1097,9 @@ class TestMissedMessages(ZulipTestCase):
self.login("othello")
result = self.client_patch("/json/messages/" + str(msg_id), {"content": " "})
self.assert_json_success(result)
handle_missedmessage_emails(hamlet.id, {msg_id: MissedMessageData(trigger="mentioned")})
handle_missedmessage_emails(
hamlet.id, {msg_id: MissedMessageData(trigger=NotificationTriggers.MENTION)}
)
self.assert_length(mail.outbox, 0)
def _deleted_message_in_missed_personal_messages(self, send_as_user: bool) -> None:
@ -1096,7 +1114,7 @@ class TestMissedMessages(ZulipTestCase):
result = self.client_patch("/json/messages/" + str(msg_id), {"content": " "})
self.assert_json_success(result)
handle_missedmessage_emails(
hamlet.id, {msg_id: MissedMessageData(trigger="private_message")}
hamlet.id, {msg_id: MissedMessageData(trigger=NotificationTriggers.PRIVATE_MESSAGE)}
)
self.assert_length(mail.outbox, 0)
@ -1116,10 +1134,12 @@ class TestMissedMessages(ZulipTestCase):
result = self.client_patch("/json/messages/" + str(msg_id), {"content": " "})
self.assert_json_success(result)
handle_missedmessage_emails(
hamlet.id, {msg_id: MissedMessageData(trigger="private_message")}
hamlet.id, {msg_id: MissedMessageData(trigger=NotificationTriggers.PRIVATE_MESSAGE)}
)
self.assert_length(mail.outbox, 0)
handle_missedmessage_emails(iago.id, {msg_id: MissedMessageData(trigger="private_message")})
handle_missedmessage_emails(
iago.id, {msg_id: MissedMessageData(trigger=NotificationTriggers.PRIVATE_MESSAGE)}
)
self.assert_length(mail.outbox, 0)
def test_smaller_user_group_mention_priority(self) -> None:
@ -1143,10 +1163,11 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
hamlet_only_message_id: MissedMessageData(
trigger="mentioned", mentioned_user_group_id=hamlet_only.id
trigger=NotificationTriggers.MENTION, mentioned_user_group_id=hamlet_only.id
),
hamlet_and_cordelia_message_id: MissedMessageData(
trigger="mentioned", mentioned_user_group_id=hamlet_and_cordelia.id
trigger=NotificationTriggers.MENTION,
mentioned_user_group_id=hamlet_and_cordelia.id,
),
},
)
@ -1179,9 +1200,12 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
user_group_mentioned_message_id: MissedMessageData(
trigger="mentioned", mentioned_user_group_id=hamlet_and_cordelia.id
trigger=NotificationTriggers.MENTION,
mentioned_user_group_id=hamlet_and_cordelia.id,
),
personal_mentioned_message_id: MissedMessageData(
trigger=NotificationTriggers.MENTION
),
personal_mentioned_message_id: MissedMessageData(trigger="mentioned"),
},
)
@ -1213,10 +1237,11 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
topic_wildcard_mentioned_in_followed_topic_message_id: MissedMessageData(
trigger="topic_wildcard_mentioned_in_followed_topic"
trigger=NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC
),
user_group_mentioned_message_id: MissedMessageData(
trigger="mentioned", mentioned_user_group_id=hamlet_and_cordelia.id
trigger=NotificationTriggers.MENTION,
mentioned_user_group_id=hamlet_and_cordelia.id,
),
},
)
@ -1246,10 +1271,10 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
stream_wildcard_mentioned_in_followed_topic_message_id: MissedMessageData(
trigger="stream_wildcard_mentioned_in_followed_topic"
trigger=NotificationTriggers.STREAM_WILDCARD_MENTION_IN_FOLLOWED_TOPIC
),
topic_wildcard_mentioned_in_followed_topic_message_id: MissedMessageData(
trigger="topic_wildcard_mentioned_in_followed_topic"
trigger=NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC
),
},
)
@ -1277,10 +1302,10 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
topic_wildcard_mentioned_message_id: MissedMessageData(
trigger="topic_wildcard_mentioned"
trigger=NotificationTriggers.TOPIC_WILDCARD_MENTION
),
stream_wildcard_mentioned_in_followed_topic_message_id: MissedMessageData(
trigger="stream_wildcard_mentioned_in_followed_topic"
trigger=NotificationTriggers.STREAM_WILDCARD_MENTION_IN_FOLLOWED_TOPIC
),
},
)
@ -1308,10 +1333,10 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
stream_wildcard_mentioned_message_id: MissedMessageData(
trigger="stream_wildcard_mentioned"
trigger=NotificationTriggers.STREAM_WILDCARD_MENTION
),
topic_wildcard_mentioned_message_id: MissedMessageData(
trigger="topic_wildcard_mentioned"
trigger=NotificationTriggers.TOPIC_WILDCARD_MENTION
),
},
)
@ -1337,10 +1362,10 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
followed_topic_mentioned_message_id: MissedMessageData(
trigger="followed_topic_email_notify"
trigger=NotificationTriggers.FOLLOWED_TOPIC_EMAIL
),
stream_wildcard_mentioned_message_id: MissedMessageData(
trigger="stream_wildcard_mentioned"
trigger=NotificationTriggers.STREAM_WILDCARD_MENTION
),
},
)
@ -1363,9 +1388,11 @@ class TestMissedMessages(ZulipTestCase):
handle_missedmessage_emails(
hamlet.id,
{
stream_mentioned_message_id: MissedMessageData(trigger="stream_email_notify"),
stream_mentioned_message_id: MissedMessageData(
trigger=NotificationTriggers.STREAM_EMAIL
),
followed_topic_mentioned_message_id: MissedMessageData(
trigger="followed_topic_email_notify"
trigger=NotificationTriggers.FOLLOWED_TOPIC_EMAIL
),
},
)
@ -1752,9 +1779,9 @@ class TestMissedMessages(ZulipTestCase):
handle_missedmessage_emails(
hamlet.id,
{
msg_id_1: MissedMessageData(trigger="mentioned"),
msg_id_2: MissedMessageData(trigger="stream_email_notify"),
msg_id_3: MissedMessageData(trigger="private_message"),
msg_id_1: MissedMessageData(trigger=NotificationTriggers.MENTION),
msg_id_2: MissedMessageData(trigger=NotificationTriggers.STREAM_EMAIL),
msg_id_3: MissedMessageData(trigger=NotificationTriggers.PRIVATE_MESSAGE),
},
)
@ -1797,8 +1824,8 @@ class TestMissedMessages(ZulipTestCase):
handle_missedmessage_emails(
hamlet.id,
{
msg_id_1: MissedMessageData(trigger="private_message"),
msg_id_2: MissedMessageData(trigger="private_message"),
msg_id_1: MissedMessageData(trigger=NotificationTriggers.PRIVATE_MESSAGE),
msg_id_2: MissedMessageData(trigger=NotificationTriggers.PRIVATE_MESSAGE),
},
)
self.assert_length(mail.outbox, 2)
@ -1815,8 +1842,8 @@ class TestMissedMessages(ZulipTestCase):
handle_missedmessage_emails(
hamlet.id,
{
msg_id_1: MissedMessageData(trigger="stream_email_notify"),
msg_id_2: MissedMessageData(trigger="stream_email_notify"),
msg_id_1: MissedMessageData(trigger=NotificationTriggers.STREAM_EMAIL),
msg_id_2: MissedMessageData(trigger=NotificationTriggers.STREAM_EMAIL),
},
)
self.assert_length(mail.outbox, 1)
@ -1834,8 +1861,8 @@ class TestMissedMessages(ZulipTestCase):
handle_missedmessage_emails(
hamlet.id,
{
msg_id_1: MissedMessageData(trigger="stream_email_notify"),
msg_id_2: MissedMessageData(trigger="mentioned"),
msg_id_1: MissedMessageData(trigger=NotificationTriggers.STREAM_EMAIL),
msg_id_2: MissedMessageData(trigger=NotificationTriggers.MENTION),
},
)
self.assert_length(mail.outbox, 1)
@ -1861,7 +1888,7 @@ class TestMissedMessages(ZulipTestCase):
handle_missedmessage_emails(
late_subscribed_user.id,
{mention_msg_id: MissedMessageData(trigger="mentioned")},
{mention_msg_id: MissedMessageData(trigger=NotificationTriggers.MENTION)},
)
self.assert_length(mail.outbox, 1)
@ -1889,9 +1916,9 @@ class TestMissedMessages(ZulipTestCase):
handle_missedmessage_emails(
hamlet.id,
{
msg_id_1: MissedMessageData(trigger="mentioned"),
msg_id_2: MissedMessageData(trigger="mentioned"),
msg_id_3: MissedMessageData(trigger="stream_email_notify"),
msg_id_1: MissedMessageData(trigger=NotificationTriggers.MENTION),
msg_id_2: MissedMessageData(trigger=NotificationTriggers.MENTION),
msg_id_3: MissedMessageData(trigger=NotificationTriggers.STREAM_EMAIL),
},
)
self.assert_length(mail.outbox, 1)
@ -1909,8 +1936,8 @@ class TestMissedMessages(ZulipTestCase):
handle_missedmessage_emails(
hamlet.id,
{
msg_id_1: MissedMessageData(trigger="stream_email_notify"),
msg_id_2: MissedMessageData(trigger="stream_email_notify"),
msg_id_1: MissedMessageData(trigger=NotificationTriggers.STREAM_EMAIL),
msg_id_2: MissedMessageData(trigger=NotificationTriggers.STREAM_EMAIL),
},
)
self.assert_length(mail.outbox, 2)
@ -2056,7 +2083,7 @@ class TestMissedMessages(ZulipTestCase):
verify_body_include,
email_subject,
send_as_user,
trigger="mentioned",
trigger=NotificationTriggers.MENTION,
verify_body_does_not_include=verify_body_does_not_include,
)
@ -2107,7 +2134,11 @@ class TestMissedMessages(ZulipTestCase):
stream_mentioned_message_id = self.send_stream_message(othello, "Denmark", mention)
handle_missedmessage_emails(
hamlet.id,
{stream_mentioned_message_id: MissedMessageData(trigger="mentioned")},
{
stream_mentioned_message_id: MissedMessageData(
trigger=NotificationTriggers.MENTION
)
},
)
# Direct message should soft reactivate the user
@ -2116,7 +2147,11 @@ class TestMissedMessages(ZulipTestCase):
personal_message_id = self.send_personal_message(othello, hamlet, "Message")
handle_missedmessage_emails(
hamlet.id,
{personal_message_id: MissedMessageData(trigger="private_message")},
{
personal_message_id: MissedMessageData(
trigger=NotificationTriggers.PRIVATE_MESSAGE
)
},
)
# Hamlet FOLLOWS the topic.
@ -2140,7 +2175,7 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
stream_mentioned_message_id: MissedMessageData(
trigger="topic_wildcard_mentioned_in_followed_topic"
trigger=NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC
),
},
)
@ -2153,7 +2188,7 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
stream_mentioned_message_id: MissedMessageData(
trigger="stream_wildcard_mentioned_in_followed_topic"
trigger=NotificationTriggers.STREAM_WILDCARD_MENTION_IN_FOLLOWED_TOPIC
),
},
)
@ -2175,7 +2210,7 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
stream_mentioned_message_id: MissedMessageData(
trigger="topic_wildcard_mentioned"
trigger=NotificationTriggers.TOPIC_WILDCARD_MENTION
),
},
)
@ -2188,7 +2223,7 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
stream_mentioned_message_id: MissedMessageData(
trigger="stream_wildcard_mentioned"
trigger=NotificationTriggers.STREAM_WILDCARD_MENTION
),
},
)
@ -2201,7 +2236,8 @@ class TestMissedMessages(ZulipTestCase):
hamlet.id,
{
stream_mentioned_message_id: MissedMessageData(
trigger="mentioned", mentioned_user_group_id=large_user_group.id
trigger=NotificationTriggers.MENTION,
mentioned_user_group_id=large_user_group.id,
),
},
)
@ -2213,7 +2249,7 @@ class TestMissedMessages(ZulipTestCase):
handle_missedmessage_emails(
hamlet.id,
{msg_id: MissedMessageData(trigger="followed_topic_email_notify")},
{msg_id: MissedMessageData(trigger=NotificationTriggers.FOLLOWED_TOPIC_EMAIL)},
)
self.assert_length(mail.outbox, 1)
email_subject = mail.outbox[0].subject

6
zerver/tests/test_message_edit_notifications.py
View File

@ -8,7 +8,7 @@ from zerver.actions.user_topics import do_set_user_topic_visibility_policy
from zerver.lib.push_notifications import get_apns_badge_count, get_apns_badge_count_future
from zerver.lib.test_classes import ZulipTestCase
from zerver.lib.test_helpers import mock_queue_publish
from zerver.models import Subscription, UserPresence, UserTopic, get_stream
from zerver.models import NotificationTriggers, Subscription, UserPresence, UserTopic, get_stream
from zerver.tornado.event_queue import maybe_enqueue_notifications
@ -203,13 +203,13 @@ class EditMessageSideEffectsTest(ZulipTestCase):
mobile_event = queue_messages[0]["event"]
self.assertEqual(mobile_event["user_profile_id"], cordelia.id)
self.assertEqual(mobile_event["trigger"], "mentioned")
self.assertEqual(mobile_event["trigger"], NotificationTriggers.MENTION)
self.assertEqual(queue_messages[1]["queue_name"], "missedmessage_emails")
email_event = queue_messages[1]["event"]
self.assertEqual(email_event["user_profile_id"], cordelia.id)
self.assertEqual(email_event["trigger"], "mentioned")
self.assertEqual(email_event["trigger"], NotificationTriggers.MENTION)
def test_second_mention_is_ignored(self) -> None:
original_content = "hello @**Cordelia, Lear's daughter**"

35
zerver/tests/test_notification_data.py
View File

@ -2,6 +2,7 @@ from zerver.actions.user_groups import check_add_user_group
from zerver.lib.mention import MentionBackend, MentionData
from zerver.lib.notification_data import UserMessageNotificationsData, get_user_group_mentions_data
from zerver.lib.test_classes import ZulipTestCase
from zerver.models import NotificationTriggers
class TestNotificationData(ZulipTestCase):
@ -26,7 +27,7 @@ class TestNotificationData(ZulipTestCase):
user_data = self.create_user_notifications_data_object(user_id=user_id, pm_push_notify=True)
self.assertEqual(
user_data.get_push_notification_trigger(acting_user_id=acting_user_id, idle=True),
"private_message",
NotificationTriggers.PRIVATE_MESSAGE,
)
self.assertTrue(user_data.is_push_notifiable(acting_user_id=acting_user_id, idle=True))
@ -36,7 +37,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_push_notification_trigger(acting_user_id=acting_user_id, idle=True),
"mentioned",
NotificationTriggers.MENTION,
)
self.assertTrue(user_data.is_push_notifiable(acting_user_id=acting_user_id, idle=True))
@ -46,7 +47,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_push_notification_trigger(acting_user_id=acting_user_id, idle=True),
"topic_wildcard_mentioned",
NotificationTriggers.TOPIC_WILDCARD_MENTION,
)
self.assertTrue(user_data.is_push_notifiable(acting_user_id=acting_user_id, idle=True))
@ -56,7 +57,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_push_notification_trigger(acting_user_id=acting_user_id, idle=True),
"stream_wildcard_mentioned",
NotificationTriggers.STREAM_WILDCARD_MENTION,
)
self.assertTrue(user_data.is_push_notifiable(acting_user_id=acting_user_id, idle=True))
@ -66,7 +67,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_push_notification_trigger(acting_user_id=acting_user_id, idle=True),
"stream_push_notify",
NotificationTriggers.STREAM_PUSH,
)
self.assertTrue(user_data.is_push_notifiable(acting_user_id=acting_user_id, idle=True))
@ -76,7 +77,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_push_notification_trigger(acting_user_id=acting_user_id, idle=True),
"followed_topic_push_notify",
NotificationTriggers.FOLLOWED_TOPIC_PUSH,
)
self.assertTrue(user_data.is_push_notifiable(acting_user_id=acting_user_id, idle=True))
@ -86,7 +87,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_push_notification_trigger(acting_user_id=acting_user_id, idle=True),
"topic_wildcard_mentioned_in_followed_topic",
NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC,
)
self.assertTrue(user_data.is_push_notifiable(acting_user_id=acting_user_id, idle=True))
@ -96,7 +97,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_push_notification_trigger(acting_user_id=acting_user_id, idle=True),
"stream_wildcard_mentioned_in_followed_topic",
NotificationTriggers.STREAM_WILDCARD_MENTION_IN_FOLLOWED_TOPIC,
)
self.assertTrue(user_data.is_push_notifiable(acting_user_id=acting_user_id, idle=True))
@ -115,7 +116,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_push_notification_trigger(acting_user_id=acting_user_id, idle=False),
"private_message",
NotificationTriggers.PRIVATE_MESSAGE,
)
self.assertTrue(user_data.is_push_notifiable(acting_user_id=acting_user_id, idle=False))
@ -194,7 +195,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_email_notification_trigger(acting_user_id=acting_user_id, idle=True),
"private_message",
NotificationTriggers.PRIVATE_MESSAGE,
)
self.assertTrue(user_data.is_email_notifiable(acting_user_id=acting_user_id, idle=True))
@ -204,7 +205,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_email_notification_trigger(acting_user_id=acting_user_id, idle=True),
"mentioned",
NotificationTriggers.MENTION,
)
self.assertTrue(user_data.is_email_notifiable(acting_user_id=acting_user_id, idle=True))
@ -214,7 +215,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_email_notification_trigger(acting_user_id=acting_user_id, idle=True),
"topic_wildcard_mentioned",
NotificationTriggers.TOPIC_WILDCARD_MENTION,
)
self.assertTrue(user_data.is_email_notifiable(acting_user_id=acting_user_id, idle=True))
@ -224,7 +225,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_email_notification_trigger(acting_user_id=acting_user_id, idle=True),
"stream_wildcard_mentioned",
NotificationTriggers.STREAM_WILDCARD_MENTION,
)
self.assertTrue(user_data.is_email_notifiable(acting_user_id=acting_user_id, idle=True))
@ -234,7 +235,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_email_notification_trigger(acting_user_id=acting_user_id, idle=True),
"stream_email_notify",
NotificationTriggers.STREAM_EMAIL,
)
self.assertTrue(user_data.is_email_notifiable(acting_user_id=acting_user_id, idle=True))
@ -244,7 +245,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_email_notification_trigger(acting_user_id=acting_user_id, idle=True),
"followed_topic_email_notify",
NotificationTriggers.FOLLOWED_TOPIC_EMAIL,
)
self.assertTrue(user_data.is_email_notifiable(acting_user_id=acting_user_id, idle=True))
@ -254,7 +255,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_email_notification_trigger(acting_user_id=acting_user_id, idle=True),
"topic_wildcard_mentioned_in_followed_topic",
NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC,
)
self.assertTrue(user_data.is_email_notifiable(acting_user_id=acting_user_id, idle=True))
@ -264,7 +265,7 @@ class TestNotificationData(ZulipTestCase):
)
self.assertEqual(
user_data.get_email_notification_trigger(acting_user_id=acting_user_id, idle=True),
"stream_wildcard_mentioned_in_followed_topic",
NotificationTriggers.STREAM_WILDCARD_MENTION_IN_FOLLOWED_TOPIC,
)
self.assertTrue(user_data.is_email_notifiable(acting_user_id=acting_user_id, idle=True))

11
zerver/tests/test_outgoing_webhook_interfaces.py
View File

@ -11,7 +11,14 @@ from zerver.lib.outgoing_webhook import get_service_interface_class, process_suc
from zerver.lib.test_classes import ZulipTestCase
from zerver.lib.timestamp import datetime_to_timestamp
from zerver.lib.topic import TOPIC_NAME
from zerver.models import SLACK_INTERFACE, Message, get_realm, get_stream, get_user
from zerver.models import (
SLACK_INTERFACE,
Message,
NotificationTriggers,
get_realm,
get_stream,
get_user,
)
from zerver.openapi.openapi import validate_against_openapi_schema
@ -174,7 +181,7 @@ class TestSlackOutgoingWebhookService(ZulipTestCase):
"user_profile_id": 24,
"service_name": "test-service",
"command": "test content",
"trigger": "private_message",
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
"message": {
"sender_id": 3,
"sender_realm_str": "zulip",

59
zerver/tests/test_push_notifications.py
View File

@ -1106,7 +1106,7 @@ class HandlePushNotificationTest(PushNotificationTest):
missed_message = {
"message_id": message.id,
"trigger": "private_message",
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
}
with mock.patch(
"zerver.lib.push_notifications.gcm_client"
@ -1168,7 +1168,7 @@ class HandlePushNotificationTest(PushNotificationTest):
missed_message = {
"message_id": message.id,
"trigger": "private_message",
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
}
with mock.patch(
"zerver.lib.push_notifications.gcm_client"
@ -1227,7 +1227,7 @@ class HandlePushNotificationTest(PushNotificationTest):
missed_message = {
"user_profile_id": self.user_profile.id,
"message_id": message.id,
"trigger": "private_message",
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
}
assert settings.PUSH_NOTIFICATION_BOUNCER_URL is not None
URL = settings.PUSH_NOTIFICATION_BOUNCER_URL + "/api/v1/remotes/push/notify"
@ -1257,7 +1257,7 @@ class HandlePushNotificationTest(PushNotificationTest):
missed_message = {
"message_id": message.id,
"trigger": "private_message",
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
}
# If the message is unread, we should send push notifications.
@ -1297,7 +1297,7 @@ class HandlePushNotificationTest(PushNotificationTest):
)
missed_message = {
"message_id": message.id,
"trigger": "private_message",
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
}
# Now, delete the message the normal way
do_delete_messages(user_profile.realm, [message])
@ -1330,7 +1330,7 @@ class HandlePushNotificationTest(PushNotificationTest):
)
missed_message = {
"message_id": message.id,
"trigger": "private_message",
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
}
# Now delete the message forcefully, so it just doesn't exist.
message.delete()
@ -1366,7 +1366,7 @@ class HandlePushNotificationTest(PushNotificationTest):
missed_message = {
"message_id": message.id,
"trigger": "private_message",
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
}
with self.settings(PUSH_NOTIFICATION_BOUNCER_URL=True), mock.patch(
"zerver.lib.push_notifications.get_message_payload_apns", return_value={"apns": True}
@ -1416,7 +1416,7 @@ class HandlePushNotificationTest(PushNotificationTest):
missed_message = {
"message_id": message.id,
"trigger": "private_message",
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
}
with mock.patch(
"zerver.lib.push_notifications.get_message_payload_apns", return_value={"apns": True}
@ -1614,7 +1614,7 @@ class HandlePushNotificationTest(PushNotificationTest):
message_id = self.send_stream_message(sender, "public_stream", "test")
missed_message = {
"message_id": message_id,
"trigger": "stream_push_notify",
"trigger": NotificationTriggers.STREAM_PUSH,
}
android_devices = list(
@ -1665,7 +1665,10 @@ class HandlePushNotificationTest(PushNotificationTest):
stream_mentioned_message_id = self.send_stream_message(othello, "Denmark", mention)
handle_push_notification(
self.user_profile.id,
{"message_id": stream_mentioned_message_id, "trigger": "mentioned"},
{
"message_id": stream_mentioned_message_id,
"trigger": NotificationTriggers.MENTION,
},
)
# Direct message should soft reactivate the user
@ -1674,7 +1677,10 @@ class HandlePushNotificationTest(PushNotificationTest):
personal_message_id = self.send_personal_message(othello, self.user_profile, "Message")
handle_push_notification(
self.user_profile.id,
{"message_id": personal_message_id, "trigger": "private_message"},
{
"message_id": personal_message_id,
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
},
)
# User FOLLOWS the topic.
@ -1700,7 +1706,7 @@ class HandlePushNotificationTest(PushNotificationTest):
self.user_profile.id,
{
"message_id": stream_mentioned_message_id,
"trigger": "topic_wildcard_mentioned_in_followed_topic",
"trigger": NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC,
},
)
@ -1712,7 +1718,7 @@ class HandlePushNotificationTest(PushNotificationTest):
self.user_profile.id,
{
"message_id": stream_mentioned_message_id,
"trigger": "stream_wildcard_mentioned_in_followed_topic",
"trigger": NotificationTriggers.STREAM_WILDCARD_MENTION_IN_FOLLOWED_TOPIC,
},
)
@ -1733,7 +1739,10 @@ class HandlePushNotificationTest(PushNotificationTest):
stream_mentioned_message_id = self.send_stream_message(othello, "Denmark", mention)
handle_push_notification(
self.user_profile.id,
{"message_id": stream_mentioned_message_id, "trigger": "topic_wildcard_mentioned"},
{
"message_id": stream_mentioned_message_id,
"trigger": NotificationTriggers.TOPIC_WILDCARD_MENTION,
},
)
# Stream Wildcard mention should NOT soft reactivate the user
@ -1742,7 +1751,10 @@ class HandlePushNotificationTest(PushNotificationTest):
stream_mentioned_message_id = self.send_stream_message(othello, "Denmark", mention)
handle_push_notification(
self.user_profile.id,
{"message_id": stream_mentioned_message_id, "trigger": "stream_wildcard_mentioned"},
{
"message_id": stream_mentioned_message_id,
"trigger": NotificationTriggers.STREAM_WILDCARD_MENTION,
},
)
# Group mention should NOT soft reactivate the user
@ -1753,7 +1765,7 @@ class HandlePushNotificationTest(PushNotificationTest):
self.user_profile.id,
{
"message_id": stream_mentioned_message_id,
"trigger": "mentioned",
"trigger": NotificationTriggers.MENTION,
"mentioned_user_group_id": large_user_group.id,
},
)
@ -1777,7 +1789,7 @@ class HandlePushNotificationTest(PushNotificationTest):
missed_message = {
"message_id": message.id,
"trigger": "private_message",
"trigger": NotificationTriggers.PRIVATE_MESSAGE,
}
handle_push_notification(user_profile.id, missed_message)
mock_push_notifications.assert_called_once()
@ -2345,14 +2357,14 @@ class TestGetGCMPayload(PushNotificationTest):
def test_get_message_payload_gcm_personal_mention(self) -> None:
self._test_get_message_payload_gcm_mentions(
"mentioned", "King Hamlet mentioned you in #Verona"
NotificationTriggers.MENTION, "King Hamlet mentioned you in #Verona"
)
def test_get_message_payload_gcm_user_group_mention(self) -> None:
# Note that the @mobile_team user group doesn't actually
# exist; this test is just verifying the formatting logic.
self._test_get_message_payload_gcm_mentions(
"mentioned",
NotificationTriggers.MENTION,
"King Hamlet mentioned @mobile_team in #Verona",
mentioned_user_group_id=3,
mentioned_user_group_name="mobile_team",
@ -2360,23 +2372,24 @@ class TestGetGCMPayload(PushNotificationTest):
def test_get_message_payload_gcm_topic_wildcard_mention_in_followed_topic(self) -> None:
self._test_get_message_payload_gcm_mentions(
"topic_wildcard_mentioned_in_followed_topic", "TODO - 2"
NotificationTriggers.TOPIC_WILDCARD_MENTION_IN_FOLLOWED_TOPIC, "TODO - 2"
)
def test_get_message_payload_gcm_stream_wildcard_mention_in_followed_topic(self) -> None:
self._test_get_message_payload_gcm_mentions(
"stream_wildcard_mentioned_in_followed_topic", "TODO"
NotificationTriggers.STREAM_WILDCARD_MENTION_IN_FOLLOWED_TOPIC, "TODO"
)
def test_get_message_payload_gcm_topic_wildcard_mention(self) -> None:
self._test_get_message_payload_gcm_mentions(
"topic_wildcard_mentioned",
NotificationTriggers.TOPIC_WILDCARD_MENTION,
"King Hamlet mentioned all topic participants in #Verona > Test topic",
)
def test_get_message_payload_gcm_stream_wildcard_mention(self) -> None:
self._test_get_message_payload_gcm_mentions(
"stream_wildcard_mentioned", "King Hamlet mentioned everyone in #Verona"
NotificationTriggers.STREAM_WILDCARD_MENTION,
"King Hamlet mentioned everyone in #Verona",
)
def test_get_message_payload_gcm_private_message(self) -> None:

8
zerver/tests/test_service_bot_system.py
View File

@ -15,7 +15,7 @@ from zerver.lib.bot_storage import StateError
from zerver.lib.test_classes import ZulipTestCase
from zerver.lib.test_helpers import mock_queue_publish
from zerver.lib.validator import check_string
from zerver.models import Recipient, UserProfile, get_realm
from zerver.models import NotificationTriggers, Recipient, UserProfile, get_realm
BOT_TYPE_TO_QUEUE_NAME = {
UserProfile.OUTGOING_WEBHOOK_BOT: "outgoing_webhooks",
@ -56,7 +56,7 @@ class TestServiceBotBasics(ZulipTestCase):
expected = dict(
outgoing_webhooks=[
dict(trigger="private_message", user_profile_id=outgoing_bot.id),
dict(trigger=NotificationTriggers.PRIVATE_MESSAGE, user_profile_id=outgoing_bot.id),
],
)
@ -533,7 +533,7 @@ class TestServiceBotEventTriggers(ZulipTestCase):
assert self.bot_profile.bot_type
self.assertEqual(queue_name, BOT_TYPE_TO_QUEUE_NAME[self.bot_profile.bot_type])
self.assertEqual(trigger_event["user_profile_id"], self.bot_profile.id)
self.assertEqual(trigger_event["trigger"], "private_message")
self.assertEqual(trigger_event["trigger"], NotificationTriggers.PRIVATE_MESSAGE)
self.assertEqual(trigger_event["message"]["sender_email"], sender.email)
display_recipients = [
trigger_event["message"]["display_recipient"][0]["email"],
@ -576,7 +576,7 @@ class TestServiceBotEventTriggers(ZulipTestCase):
self.assertEqual(queue_name, BOT_TYPE_TO_QUEUE_NAME[self.bot_profile.bot_type])
self.assertIn(trigger_event["user_profile_id"], profile_ids)
profile_ids.remove(trigger_event["user_profile_id"])
self.assertEqual(trigger_event["trigger"], "private_message")
self.assertEqual(trigger_event["trigger"], NotificationTriggers.PRIVATE_MESSAGE)
self.assertEqual(trigger_event["message"]["sender_email"], sender.email)
self.assertEqual(trigger_event["message"]["type"], "private")