mirror of
https://github.com/zulip/zulip.git
synced 2025-11-15 11:22:04 +00:00
bc0325922e
This commit adds a 'skip-delay' option to the 'send_zulip_update_announcements' management command. It will be useful for self-hosted servers after 9.0 upgrade to avoid the 24 hour delay to receive update messages after group DM is sent to the admins. One can run the management command with the --skip-delay flag to immediately send the update messages.
309 lines
14 KiB
Python
309 lines
14 KiB
Python
from datetime import timedelta
|
|
from unittest import mock
|
|
|
|
import time_machine
|
|
from django.conf import settings
|
|
from django.utils.timezone import now as timezone_now
|
|
from typing_extensions import override
|
|
|
|
from zerver.lib.message import remove_single_newlines
|
|
from zerver.lib.test_classes import ZulipTestCase
|
|
from zerver.lib.zulip_update_announcements import (
|
|
ZulipUpdateAnnouncement,
|
|
send_zulip_update_announcements,
|
|
)
|
|
from zerver.models.messages import Message
|
|
from zerver.models.realms import get_realm
|
|
from zerver.models.recipients import Recipient, get_huddle_user_ids
|
|
from zerver.models.streams import get_stream
|
|
from zerver.models.users import get_system_bot
|
|
|
|
|
|
class ZulipUpdateAnnouncementsTest(ZulipTestCase):
|
|
@override
|
|
def setUp(self) -> None:
|
|
super().setUp()
|
|
|
|
self.zulip_update_announcements = [
|
|
ZulipUpdateAnnouncement(
|
|
level=1,
|
|
message="Announcement message 1.",
|
|
),
|
|
ZulipUpdateAnnouncement(
|
|
level=2,
|
|
message="Announcement message 2.",
|
|
),
|
|
]
|
|
|
|
def test_send_zulip_update_announcements(self) -> None:
|
|
with mock.patch(
|
|
"zerver.lib.zulip_update_announcements.zulip_update_announcements",
|
|
self.zulip_update_announcements,
|
|
):
|
|
realm = get_realm("zulip")
|
|
|
|
# realm predates the "zulip updates" feature with the
|
|
# zulip_update_announcements_stream set to None.
|
|
realm.zulip_update_announcements_level = None
|
|
realm.zulip_update_announcements_stream = None
|
|
realm.save(
|
|
update_fields=[
|
|
"zulip_update_announcements_level",
|
|
"zulip_update_announcements_stream",
|
|
]
|
|
)
|
|
|
|
group_direct_messages = Message.objects.filter(
|
|
realm=realm, recipient__type=Recipient.DIRECT_MESSAGE_GROUP
|
|
)
|
|
self.assertFalse(group_direct_messages.exists())
|
|
|
|
admin_user_ids = set(realm.get_human_admin_users().values_list("id", flat=True))
|
|
notification_bot = get_system_bot(settings.NOTIFICATION_BOT, realm.id)
|
|
expected_group_direct_message_user_ids = admin_user_ids | {notification_bot.id}
|
|
|
|
now = timezone_now()
|
|
with time_machine.travel(now, tick=False):
|
|
send_zulip_update_announcements(skip_delay=False)
|
|
|
|
realm.refresh_from_db()
|
|
group_direct_message = group_direct_messages.first()
|
|
assert group_direct_message is not None
|
|
self.assertEqual(group_direct_message.sender, notification_bot)
|
|
self.assertEqual(group_direct_message.date_sent, now)
|
|
self.assertEqual(
|
|
set(get_huddle_user_ids(group_direct_message.recipient)),
|
|
expected_group_direct_message_user_ids,
|
|
)
|
|
self.assertEqual(realm.zulip_update_announcements_level, 0)
|
|
self.assertIn(
|
|
"These notifications are currently turned off in your organization.",
|
|
group_direct_message.content,
|
|
)
|
|
|
|
# Wait for one week before starting to skip sending updates.
|
|
with time_machine.travel(now + timedelta(days=2), tick=False):
|
|
send_zulip_update_announcements(skip_delay=False)
|
|
realm.refresh_from_db()
|
|
self.assertEqual(realm.zulip_update_announcements_level, 0)
|
|
|
|
with time_machine.travel(now + timedelta(days=8), tick=False):
|
|
send_zulip_update_announcements(skip_delay=False)
|
|
realm.refresh_from_db()
|
|
self.assertEqual(realm.zulip_update_announcements_level, 2)
|
|
|
|
# Configure a stream. Two new updates added.
|
|
verona = get_stream("verona", realm)
|
|
realm.zulip_update_announcements_stream = verona
|
|
realm.save(update_fields=["zulip_update_announcements_stream"])
|
|
new_updates = [
|
|
ZulipUpdateAnnouncement(
|
|
level=3,
|
|
message="Announcement message 3.",
|
|
),
|
|
ZulipUpdateAnnouncement(
|
|
level=4,
|
|
message="Announcement message 4.",
|
|
),
|
|
]
|
|
self.zulip_update_announcements.extend(new_updates)
|
|
|
|
# verify zulip update announcements sent to configured stream.
|
|
with time_machine.travel(now + timedelta(days=10), tick=False):
|
|
send_zulip_update_announcements(skip_delay=False)
|
|
realm.refresh_from_db()
|
|
stream_messages = Message.objects.filter(
|
|
realm=realm,
|
|
sender=notification_bot,
|
|
recipient__type_id=verona.id,
|
|
date_sent__gte=now + timedelta(days=10),
|
|
).order_by("id")
|
|
self.assert_length(stream_messages, 2)
|
|
self.assertEqual(stream_messages[0].content, "Announcement message 3.")
|
|
self.assertEqual(stream_messages[1].content, "Announcement message 4.")
|
|
self.assertEqual(realm.zulip_update_announcements_level, 4)
|
|
|
|
def test_send_zulip_update_announcements_with_stream_configured(self) -> None:
|
|
with mock.patch(
|
|
"zerver.lib.zulip_update_announcements.zulip_update_announcements",
|
|
self.zulip_update_announcements,
|
|
):
|
|
realm = get_realm("zulip")
|
|
|
|
# realm predates the "zulip updates" feature with the
|
|
# zulip_update_announcements_stream configured.
|
|
realm.zulip_update_announcements_level = None
|
|
realm.zulip_update_announcements_stream = get_stream("verona", realm)
|
|
realm.save(
|
|
update_fields=[
|
|
"zulip_update_announcements_level",
|
|
"zulip_update_announcements_stream",
|
|
]
|
|
)
|
|
|
|
group_direct_messages = Message.objects.filter(
|
|
realm=realm, recipient__type=Recipient.DIRECT_MESSAGE_GROUP
|
|
)
|
|
self.assertFalse(group_direct_messages.exists())
|
|
|
|
now = timezone_now()
|
|
with time_machine.travel(now, tick=False):
|
|
send_zulip_update_announcements(skip_delay=False)
|
|
|
|
realm.refresh_from_db()
|
|
self.assertTrue(group_direct_messages.exists())
|
|
self.assertEqual(realm.zulip_update_announcements_level, 0)
|
|
|
|
# Wait for 24 hours before starting to send updates.
|
|
with time_machine.travel(now + timedelta(hours=10), tick=False):
|
|
send_zulip_update_announcements(skip_delay=False)
|
|
realm.refresh_from_db()
|
|
self.assertEqual(realm.zulip_update_announcements_level, 0)
|
|
|
|
with time_machine.travel(now + timedelta(days=1), tick=False):
|
|
send_zulip_update_announcements(skip_delay=False)
|
|
realm.refresh_from_db()
|
|
self.assertEqual(realm.zulip_update_announcements_level, 2)
|
|
|
|
# Two new updates added.
|
|
new_updates = [
|
|
ZulipUpdateAnnouncement(
|
|
level=3,
|
|
message="Announcement message 3.",
|
|
),
|
|
ZulipUpdateAnnouncement(
|
|
level=4,
|
|
message="Announcement message 4.",
|
|
),
|
|
]
|
|
self.zulip_update_announcements.extend(new_updates)
|
|
|
|
# verify zulip update announcements sent to configured stream.
|
|
with time_machine.travel(now + timedelta(days=2), tick=False):
|
|
send_zulip_update_announcements(skip_delay=False)
|
|
realm.refresh_from_db()
|
|
notification_bot = get_system_bot(settings.NOTIFICATION_BOT, realm.id)
|
|
stream_messages = Message.objects.filter(
|
|
realm=realm,
|
|
sender=notification_bot,
|
|
recipient__type_id=realm.zulip_update_announcements_stream.id,
|
|
date_sent__gte=now + timedelta(days=2),
|
|
).order_by("id")
|
|
self.assert_length(stream_messages, 2)
|
|
self.assertEqual(stream_messages[0].content, "Announcement message 3.")
|
|
self.assertEqual(stream_messages[1].content, "Announcement message 4.")
|
|
self.assertEqual(realm.zulip_update_announcements_level, 4)
|
|
|
|
def test_send_zulip_update_announcements_skip_delay(self) -> None:
|
|
with mock.patch(
|
|
"zerver.lib.zulip_update_announcements.zulip_update_announcements",
|
|
self.zulip_update_announcements,
|
|
):
|
|
realm = get_realm("zulip")
|
|
|
|
# realm predates the "zulip updates" feature with the
|
|
# zulip_update_announcements_stream configured.
|
|
realm.zulip_update_announcements_level = None
|
|
realm.zulip_update_announcements_stream = get_stream("verona", realm)
|
|
realm.save(
|
|
update_fields=[
|
|
"zulip_update_announcements_level",
|
|
"zulip_update_announcements_stream",
|
|
]
|
|
)
|
|
|
|
group_direct_messages = Message.objects.filter(
|
|
realm=realm, recipient__type=Recipient.DIRECT_MESSAGE_GROUP
|
|
)
|
|
self.assertFalse(group_direct_messages.exists())
|
|
|
|
# post-upgrade hook sends a group DM.
|
|
now = timezone_now()
|
|
with time_machine.travel(now, tick=False):
|
|
send_zulip_update_announcements(skip_delay=False)
|
|
|
|
realm.refresh_from_db()
|
|
self.assertTrue(group_direct_messages.exists())
|
|
self.assertEqual(realm.zulip_update_announcements_level, 0)
|
|
|
|
# For self-hosted servers, 9.0 upgrade notes suggests to run
|
|
# 'send_zulip_update_announcements' management command with
|
|
# '--skip-delay' argument to immediately send update messages.
|
|
# 'zulip_update_announcements_stream' should be configured.
|
|
with time_machine.travel(now, tick=False):
|
|
send_zulip_update_announcements(skip_delay=True)
|
|
|
|
realm.refresh_from_db()
|
|
self.assertEqual(realm.zulip_update_announcements_level, 2)
|
|
|
|
def test_group_direct_message_with_zulip_updates_stream_set(self) -> None:
|
|
realm = get_realm("zulip")
|
|
|
|
# realm predates the "zulip updates" feature.
|
|
realm.zulip_update_announcements_level = None
|
|
realm.save(update_fields=["zulip_update_announcements_level"])
|
|
|
|
self.assertIsNotNone(realm.zulip_update_announcements_stream)
|
|
|
|
group_direct_messages = Message.objects.filter(
|
|
realm=realm, recipient__type=Recipient.DIRECT_MESSAGE_GROUP
|
|
)
|
|
self.assertFalse(group_direct_messages.exists())
|
|
|
|
admin_user_ids = set(realm.get_human_admin_users().values_list("id", flat=True))
|
|
notification_bot = get_system_bot(settings.NOTIFICATION_BOT, realm.id)
|
|
expected_group_direct_message_user_ids = admin_user_ids | {notification_bot.id}
|
|
|
|
now = timezone_now()
|
|
with time_machine.travel(now, tick=False):
|
|
send_zulip_update_announcements(skip_delay=False)
|
|
|
|
realm.refresh_from_db()
|
|
group_direct_message = group_direct_messages.first()
|
|
assert group_direct_message is not None
|
|
self.assertEqual(group_direct_message.sender, notification_bot)
|
|
self.assertEqual(group_direct_message.date_sent, now)
|
|
self.assertEqual(
|
|
set(get_huddle_user_ids(group_direct_message.recipient)),
|
|
expected_group_direct_message_user_ids,
|
|
)
|
|
self.assertEqual(realm.zulip_update_announcements_level, 0)
|
|
self.assertIn(
|
|
"Starting tomorrow, users in your organization will receive "
|
|
"[updates](/help/configure-automated-notices#zulip-update-announcements) about new Zulip features in "
|
|
f"#**{realm.zulip_update_announcements_stream}>{realm.ZULIP_UPDATE_ANNOUNCEMENTS_TOPIC_NAME}**",
|
|
group_direct_message.content,
|
|
)
|
|
|
|
def test_remove_single_newlines(self) -> None:
|
|
# single newlines and double newlines
|
|
input_text = "This is a sentence.\nThis is another sentence.\n\nThis is a third sentence."
|
|
expected_output = (
|
|
"This is a sentence. This is another sentence.\n\nThis is a third sentence."
|
|
)
|
|
self.assertEqual(remove_single_newlines(input_text), expected_output)
|
|
|
|
# single newline at the beginning
|
|
input_text = "\nThis is a sentence.\nThis is another sentence.\n\nThis is a third sentence."
|
|
expected_output = (
|
|
"This is a sentence. This is another sentence.\n\nThis is a third sentence."
|
|
)
|
|
self.assertEqual(remove_single_newlines(input_text), expected_output)
|
|
|
|
# single newline at the end
|
|
input_text = "This is a sentence.\nThis is another sentence.\n\nThis is a third sentence.\n"
|
|
expected_output = (
|
|
"This is a sentence. This is another sentence.\n\nThis is a third sentence."
|
|
)
|
|
self.assertEqual(remove_single_newlines(input_text), expected_output)
|
|
|
|
# only single newlines in the middle
|
|
input_text = "This is a sentence.\nThis is another sentence.\nThis is a third sentence.\nThis is a fourth sentence."
|
|
expected_output = "This is a sentence. This is another sentence. This is a third sentence. This is a fourth sentence."
|
|
self.assertEqual(remove_single_newlines(input_text), expected_output)
|
|
|
|
# Bulleted lists on lines.
|
|
input_text = "- This is a bullet.\n- This is another bullet.\n\n1. This is a list\n1. This is more list."
|
|
expected_output = "- This is a bullet.\n- This is another bullet.\n\n1. This is a list\n1. This is more list."
|
|
self.assertEqual(remove_single_newlines(input_text), expected_output)
|