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

735 lines
35 KiB
Python
Raw Normal View History

minor: Clean up how we set flags in events. This is basically a simple fix, where we consistently set `flags` to an empty array when we pass it around. The history here is that we had kind of a nasty bug from setting it to `None`, which only showed up in the somewhat obscure circumstance of somebody subscribing to all stream events in our API. Fixes #7921
2018-03-28 21:42:06 +02:00
import time
tests: Simplify test_event_collapsing. We now use update_message_flags instead of pointer events.
2020-06-26 14:14:36 +02:00
from typing import Any, Callable, Dict, List, Tuple
python: Sort imports with isort. Fixes #2665. Regenerated by tabbott with `lint --fix` after a rebase and change in parameters. Note from tabbott: In a few cases, this converts technical debt in the form of unsorted imports into different technical debt in the form of our largest files having very long, ugly import sequences at the start. I expect this change will increase pressure for us to split those files, which isn't a bad thing. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-11 00:54:34 +02:00
from unittest import mock
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
python: Replace ujson with orjson. Fixes #6507. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-07 01:09:47 +02:00
import orjson
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
from django.http import HttpRequest, HttpResponse
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
python: Sort imports with isort. Fixes #2665. Regenerated by tabbott with `lint --fix` after a rebase and change in parameters. Note from tabbott: In a few cases, this converts technical debt in the form of unsorted imports into different technical debt in the form of our largest files having very long, ugly import sequences at the start. I expect this change will increase pressure for us to split those files, which isn't a bad thing. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-11 00:54:34 +02:00
from zerver.lib.actions import do_change_subscription_property, do_mute_topic
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
from zerver.lib.test_classes import ZulipTestCase
tests: Check JSON serializability of test data with mock_queue_publish.
2020-08-14 10:03:36 +02:00
from zerver.lib.test_helpers import POSTRequestMock, mock_queue_publish
test_event_queue: Make subscription management code readable. This test refactor makes the subscription/stream settings changes use standard APIs and thus be easier to follow (and more robust to subtle re-fetching bugs). This is a follow-up to #9181.
2018-08-08 21:39:19 +02:00
from zerver.models import Recipient, Stream, Subscription, UserProfile, get_stream
python: Sort imports with isort. Fixes #2665. Regenerated by tabbott with `lint --fix` after a rebase and change in parameters. Note from tabbott: In a few cases, this converts technical debt in the form of unsorted imports into different technical debt in the form of our largest files having very long, ugly import sequences at the start. I expect this change will increase pressure for us to split those files, which isn't a bad thing. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-11 00:54:34 +02:00
from zerver.tornado.event_queue import (
ClientDescriptor,
allocate_client_descriptor,
get_client_descriptor,
maybe_enqueue_notifications,
missedmessage_hook,
persistent_queue_filename,
)
from zerver.tornado.views import cleanup_event_queue, get_events
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
class MissedMessageNotificationsTest(ZulipTestCase):
"""Tests the logic for when missed-message notifications
should be triggered, based on user settings"""
python: Whitespace fixes from autopep8. Generated by autopep8, with the setup.cfg configuration from #14532. I’m not sure why pycodestyle didn’t already flag these. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-22 01:45:30 +02:00
zerver/tests: Use python 3 syntax for typing in most files.
2017-11-05 10:51:25 +01:00
def check_will_notify(self, *args: Any, **kwargs: Any) -> Tuple[str, str]:
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
email_notice = None
mobile_notice = None
tests: Check JSON serializability of test data with mock_queue_publish.
2020-08-14 10:03:36 +02:00
with mock_queue_publish("zerver.tornado.event_queue.queue_json_publish") as mock_queue_json_publish:
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
notified = maybe_enqueue_notifications(*args, **kwargs)
tests: Check JSON serializability of test data with mock_queue_publish.
2020-08-14 10:03:36 +02:00
for entry in mock_queue_json_publish.call_args_list:
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
args = entry[0]
if args[0] == "missedmessage_mobile_notifications":
mobile_notice = args[1]
if args[0] == "missedmessage_emails":
email_notice = args[1]
# Now verify the return value matches the queue actions
if email_notice:
self.assertTrue(notified['email_notified'])
else:
self.assertFalse(notified.get('email_notified', False))
if mobile_notice:
self.assertTrue(notified['push_notified'])
else:
self.assertFalse(notified.get('push_notified', False))
return email_notice, mobile_notice
zerver/tests: Use python 3 syntax for typing in most files.
2017-11-05 10:51:25 +01:00
def test_enqueue_notifications(self) -> None:
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
user_profile = self.example_user("hamlet")
message_id = 32
# Boring message doesn't send a notice
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=False,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=False,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
stream_name=None, always_push_notify=False, idle=True, already_notified={})
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
self.assertTrue(email_notice is None)
self.assertTrue(mobile_notice is None)
# Private message sends a notice
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=True,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=True,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
stream_name=None, always_push_notify=False, idle=True, already_notified={})
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
self.assertTrue(email_notice is not None)
self.assertTrue(mobile_notice is not None)
notifications: Fix double-sending in missedmessage_hook. While the missedmessage_hook logic originally did a reasonably good job of avoiding double-sending notifications, there was a corner case it didn't handle, namely a user who had been presence-idle when a message was sent and became also event-queue-idle as well within the next 10 minutes. For those users, they got a notification at message send time, and the missedmessage_hook would deliver it a second time. We fix this by just checking the conveniently available push_notified and email_notified variables that indicate whether the message already had a notification triggered. Fixes #7031.
2017-10-18 06:54:03 +02:00
# Private message won't double-send either notice if we've
# already sent notices before.
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=True,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=False,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
stream_name=None, always_push_notify=False, idle=True, already_notified={
notifications: Fix double-sending in missedmessage_hook. While the missedmessage_hook logic originally did a reasonably good job of avoiding double-sending notifications, there was a corner case it didn't handle, namely a user who had been presence-idle when a message was sent and became also event-queue-idle as well within the next 10 minutes. For those users, they got a notification at message send time, and the missedmessage_hook would deliver it a second time. We fix this by just checking the conveniently available push_notified and email_notified variables that indicate whether the message already had a notification triggered. Fixes #7031.
2017-10-18 06:54:03 +02:00
'push_notified': True,
'email_notified': False,
})
self.assertTrue(email_notice is not None)
self.assertTrue(mobile_notice is None)
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=True,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=False,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
stream_name=None, always_push_notify=False, idle=True, already_notified={
notifications: Fix double-sending in missedmessage_hook. While the missedmessage_hook logic originally did a reasonably good job of avoiding double-sending notifications, there was a corner case it didn't handle, namely a user who had been presence-idle when a message was sent and became also event-queue-idle as well within the next 10 minutes. For those users, they got a notification at message send time, and the missedmessage_hook would deliver it a second time. We fix this by just checking the conveniently available push_notified and email_notified variables that indicate whether the message already had a notification triggered. Fixes #7031.
2017-10-18 06:54:03 +02:00
'push_notified': False,
'email_notified': True,
})
self.assertTrue(email_notice is None)
self.assertTrue(mobile_notice is not None)
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
# Mention sends a notice
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=False,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=True, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=False,
stream_name=None, always_push_notify=False, idle=True, already_notified={})
self.assertTrue(email_notice is not None)
self.assertTrue(mobile_notice is not None)
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
# Wildcard mention triggers both email and push notices (Like a
# direct mention, whether the notice is actually delivered is
# determined later, in the email/push notification code)
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=False,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=True,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=False,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
stream_name=None, always_push_notify=False, idle=True, already_notified={})
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
self.assertTrue(email_notice is not None)
self.assertTrue(mobile_notice is not None)
# stream_push_notify pushes but doesn't email
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=False,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=True, stream_email_notify=False,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
stream_name="Denmark", always_push_notify=False, idle=True, already_notified={})
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
self.assertTrue(email_notice is None)
self.assertTrue(mobile_notice is not None)
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
# stream_email_notify emails but doesn't push
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=False,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=True,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
stream_name="Denmark", always_push_notify=False, idle=True, already_notified={})
self.assertTrue(email_notice is not None)
self.assertTrue(mobile_notice is None)
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
# Private message doesn't send a notice if not idle
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=True,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=True,
stream_name=None, always_push_notify=False, idle=False, already_notified={})
self.assertTrue(email_notice is None)
self.assertTrue(mobile_notice is None)
# Mention doesn't send a notice if not idle
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=False,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=True, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=False,
stream_name=None, always_push_notify=False, idle=False, already_notified={})
self.assertTrue(email_notice is None)
self.assertTrue(mobile_notice is None)
# Wildcard mention doesn't send a notice if not idle
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=False,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=True,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=False,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
stream_name=None, always_push_notify=False, idle=False, already_notified={})
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
self.assertTrue(email_notice is None)
self.assertTrue(mobile_notice is None)
# Private message sends push but not email if not idle but always_push_notify
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=True,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=False, stream_email_notify=True,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
stream_name=None, always_push_notify=True, idle=False, already_notified={})
tests: Add a test suite for maybe_enqueue_notifications. This ensures that as we expand the logic for under what circumstances email and push notifications should be sent, we can be confident about this code path always doing the right thing.
2017-09-27 20:27:04 +02:00
self.assertTrue(email_notice is None)
self.assertTrue(mobile_notice is not None)
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
settings: Decouple enable_push_notifications_offline from PM setting. Note that this setting has always applied to both streams and PMs; the test just clarifies that that is the case.
2019-04-18 03:58:25 +02:00
# Stream message sends push but not email if not idle but always_push_notify
email_notice, mobile_notice = self.check_will_notify(
user_profile.id, message_id, private_message=False,
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
mentioned=False, wildcard_mention_notify=False,
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
stream_push_notify=True, stream_email_notify=True,
settings: Decouple enable_push_notifications_offline from PM setting. Note that this setting has always applied to both streams and PMs; the test just clarifies that that is the case.
2019-04-18 03:58:25 +02:00
stream_name="Denmark", always_push_notify=True, idle=False, already_notified={})
self.assertTrue(email_notice is None)
self.assertTrue(mobile_notice is not None)
zerver/tests: Use python 3 syntax for typing in most files.
2017-11-05 10:51:25 +01:00
def tornado_call(self, view_func: Callable[[HttpRequest, UserProfile], HttpResponse],
user_profile: UserProfile, post_data: Dict[str, Any]) -> HttpResponse:
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
request = POSTRequestMock(post_data, user_profile)
return view_func(request, user_profile)
minor: Clean up how we set flags in events. This is basically a simple fix, where we consistently set `flags` to an empty array when we pass it around. The history here is that we had kind of a nasty bug from setting it to `None`, which only showed up in the somewhat obscure circumstance of somebody subscribing to all stream events in our API. Fixes #7921
2018-03-28 21:42:06 +02:00
def test_stream_watchers(self) -> None:
'''
We used to have a bug with stream_watchers, where we set their flags to
None.
'''
cordelia = self.example_user('cordelia')
hamlet = self.example_user('hamlet')
realm = hamlet.realm
stream_name = 'Denmark'
self.unsubscribe(hamlet, stream_name)
queue_data = dict(
all_public_streams=True,
apply_markdown=True,
client_gravatar=True,
docs: Fix more capitalization issues. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-10-23 02:43:28 +02:00
client_type_name='home grown API program',
minor: Clean up how we set flags in events. This is basically a simple fix, where we consistently set `flags` to an empty array when we pass it around. The history here is that we had kind of a nasty bug from setting it to `None`, which only showed up in the somewhat obscure circumstance of somebody subscribing to all stream events in our API. Fixes #7921
2018-03-28 21:42:06 +02:00
event_types=['message'],
last_connection_time=time.time(),
queue_timeout=0,
realm_id=realm.id,
user_profile_id=hamlet.id,
)
client = allocate_client_descriptor(queue_data)
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
self.send_stream_message(cordelia, stream_name)
minor: Clean up how we set flags in events. This is basically a simple fix, where we consistently set `flags` to an empty array when we pass it around. The history here is that we had kind of a nasty bug from setting it to `None`, which only showed up in the somewhat obscure circumstance of somebody subscribing to all stream events in our API. Fixes #7921
2018-03-28 21:42:06 +02:00
self.assertEqual(len(client.event_queue.contents()), 1)
# This next line of code should silently succeed and basically do
# nothing under the covers. This test is here to prevent a bug
# from re-appearing.
missedmessage_hook(
user_profile_id=hamlet.id,
client=client,
last_for_client=True,
)
zerver/tests: Use python 3 syntax for typing in most files.
2017-11-05 10:51:25 +01:00
def test_end_to_end_missedmessage_hook(self) -> None:
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
"""Tests what arguments missedmessage_hook passes into maybe_enqueue_notifications.
Combined with the previous test, this ensures that the missedmessage_hook is correct"""
user_profile = self.example_user('hamlet')
notifications: Enable online push notifications by default. For new user onboarding, it's important for it to be easy to verify that Zulip's mobile push notifications work without jumping through hoops or potentially making mistakes. For that reason, it makes sense to toggle the notification defaults for new users to the more aggressive mode (ignoring whether the user is currently actively online); they can set the more subtle mode if they find that the notifications are annoying.
2019-12-11 01:41:20 +01:00
user_profile.enable_online_push_notifications = False
user_profile.save()
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
# Fetch the Denmark stream for testing
stream = get_stream("Denmark", user_profile.realm)
sub = Subscription.objects.get(user_profile=user_profile, recipient__type=Recipient.STREAM,
recipient__type_id=stream.id)
tests: Limit email-based logins. We now have this API... If you really just need to log in and not do anything with the actual user: self.login('hamlet') If you're gonna use the user in the rest of the test: hamlet = self.example_user('hamlet') self.login_user(hamlet) If you are specifically testing email/password logins (used only in 4 places): self.login_by_email(email, password) And for failures uses this (used twice): self.assert_login_failure(email)
2020-03-06 18:40:46 +01:00
self.login_user(user_profile)
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
test_event_queue: Make subscription management code readable. This test refactor makes the subscription/stream settings changes use standard APIs and thus be easier to follow (and more robust to subtle re-fetching bugs). This is a follow-up to #9181.
2018-08-08 21:39:19 +02:00
def change_subscription_properties(user_profile: UserProfile, stream: Stream, sub: Subscription,
properties: Dict[str, bool]) -> None:
for property_name, value in properties.items():
do_change_subscription_property(user_profile, sub, stream, property_name, value)
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
def allocate_event_queue() -> ClientDescriptor:
result = self.tornado_call(get_events, user_profile,
python: Replace ujson with orjson. Fixes #6507. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-07 01:09:47 +02:00
{"apply_markdown": orjson.dumps(True).decode(),
"client_gravatar": orjson.dumps(True).decode(),
"event_types": orjson.dumps(["message"]).decode(),
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
"user_client": "website",
python: Replace ujson with orjson. Fixes #6507. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-07 01:09:47 +02:00
"dont_block": orjson.dumps(True).decode()})
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
self.assert_json_success(result)
python: Replace ujson with orjson. Fixes #6507. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-07 01:09:47 +02:00
queue_id = orjson.loads(result.content)["queue_id"]
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
return get_client_descriptor(queue_id)
def destroy_event_queue(queue_id: str) -> None:
result = self.tornado_call(cleanup_event_queue, user_profile,
{"queue_id": queue_id})
self.assert_json_success(result)
client_descriptor = allocate_event_queue()
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
# To test the missed_message hook, we first need to send a message
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("iago"), "Denmark")
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
# Verify that nothing happens if you call it as not the
# "last client descriptor", in which case the function
# short-circuits, since the `missedmessage_hook` handler
# for garbage-collection is only for the user's last queue.
missedmessage_hook(user_profile.id, client_descriptor, False)
mock_enqueue.assert_not_called()
# Now verify that we called the appropriate enqueue function
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
self.assertEqual(args_list, (user_profile.id, msg_id, False, False, False, False, False,
notifications: Fix double-sending in missedmessage_hook. While the missedmessage_hook logic originally did a reasonably good job of avoiding double-sending notifications, there was a corner case it didn't handle, namely a user who had been presence-idle when a message was sent and became also event-queue-idle as well within the next 10 minutes. For those users, they got a notification at message send time, and the missedmessage_hook would deliver it a second time. We fix this by just checking the conveniently available push_notified and email_notified variables that indicate whether the message already had a notification triggered. Fixes #7031.
2017-10-18 06:54:03 +02:00
"Denmark", False, True,
{'email_notified': False, 'push_notified': False}))
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
destroy_event_queue(client_descriptor.event_queue.id)
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
# Test the hook with a private message; this should trigger notifications
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
client_descriptor = allocate_event_queue()
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
self.assertTrue(client_descriptor.event_queue.empty())
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_personal_message(self.example_user("iago"), user_profile)
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
self.assertEqual(args_list, (user_profile.id, msg_id, True, False, False, False,
notifications: Fix double-sending in missedmessage_hook. While the missedmessage_hook logic originally did a reasonably good job of avoiding double-sending notifications, there was a corner case it didn't handle, namely a user who had been presence-idle when a message was sent and became also event-queue-idle as well within the next 10 minutes. For those users, they got a notification at message send time, and the missedmessage_hook would deliver it a second time. We fix this by just checking the conveniently available push_notified and email_notified variables that indicate whether the message already had a notification triggered. Fixes #7031.
2017-10-18 06:54:03 +02:00
False, None, False, True,
{'email_notified': True, 'push_notified': True}))
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
destroy_event_queue(client_descriptor.event_queue.id)
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
# Test the hook with a mention; this should trigger notifications
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
client_descriptor = allocate_event_queue()
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
self.assertTrue(client_descriptor.event_queue.empty())
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("iago"), "Denmark",
tests: Fix send_message calls in test_event_queue.py.
2017-10-28 16:22:01 +02:00
content="@**King Hamlet** what's up?")
tests: Add an end-to-end test for missedmessage_hook. This checks what arguments it passes into the enqueuing function. Note, however, that the arguments are wrong for various cases, we'll update the tests as we fix those bugs.
2017-09-27 20:55:58 +02:00
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
self.assertEqual(args_list, (user_profile.id, msg_id, False, True, False, False,
notifications: Fix double-sending in missedmessage_hook. While the missedmessage_hook logic originally did a reasonably good job of avoiding double-sending notifications, there was a corner case it didn't handle, namely a user who had been presence-idle when a message was sent and became also event-queue-idle as well within the next 10 minutes. For those users, they got a notification at message send time, and the missedmessage_hook would deliver it a second time. We fix this by just checking the conveniently available push_notified and email_notified variables that indicate whether the message already had a notification triggered. Fixes #7031.
2017-10-18 06:54:03 +02:00
False, "Denmark", False, True,
{'email_notified': True, 'push_notified': True}))
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
destroy_event_queue(client_descriptor.event_queue.id)
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
# Test the hook with a wildcard mention; this should trigger notifications
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
client_descriptor = allocate_event_queue()
self.assertTrue(client_descriptor.event_queue.empty())
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("iago"), "Denmark",
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
content="@**all** what's up?")
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
self.assertEqual(args_list, (user_profile.id, msg_id, False, False, True, False,
False, "Denmark", False, True,
{'email_notified': True, 'push_notified': True}))
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
destroy_event_queue(client_descriptor.event_queue.id)
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
# Test the hook with a wildcard mention sent by the user
# themself using a human client; should not notify.
client_descriptor = allocate_event_queue()
self.assertTrue(client_descriptor.event_queue.empty())
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("hamlet"), "Denmark",
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
content="@**all** what's up?",
sending_client_name="website")
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
self.assertEqual(args_list, (user_profile.id, msg_id, False, False, False, False,
False, "Denmark", False, True,
{'email_notified': False, 'push_notified': False}))
destroy_event_queue(client_descriptor.event_queue.id)
# Wildcard mentions in muted streams don't notify.
change_subscription_properties(user_profile, stream, sub, {'is_muted': True})
client_descriptor = allocate_event_queue()
self.assertTrue(client_descriptor.event_queue.empty())
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("iago"), "Denmark",
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
content="@**all** what's up?")
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
self.assertEqual(args_list, (user_profile.id, msg_id, False, False, False, False,
False, "Denmark", False, True,
{'email_notified': False, 'push_notified': False}))
destroy_event_queue(client_descriptor.event_queue.id)
change_subscription_properties(user_profile, stream, sub, {'is_muted': False})
# With wildcard_mentions_notify=False, we treat the user as not mentioned.
user_profile.wildcard_mentions_notify = False
user_profile.save()
client_descriptor = allocate_event_queue()
self.assertTrue(client_descriptor.event_queue.empty())
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("iago"), "Denmark",
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
content="@**all** what's up?")
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
self.assertEqual(args_list, (user_profile.id, msg_id, False, False, False, False,
False, "Denmark", False, True,
{'email_notified': False, 'push_notified': False}))
destroy_event_queue(client_descriptor.event_queue.id)
user_profile.wildcard_mentions_notify = True
user_profile.save()
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
wildcard_mentions_notify: Add per-stream override of global setting. Adds required API and front-end changes to modify and read the wildcard_mentions_notify field in the Subscription model. It includes front-end code to add the setting to the user's "manage streams" page. This setting will be greyed out when a stream is muted. The PR also includes back-end code to add the setting the initial state of a subscription. New automated tests were added for the API, events system and front-end. In manual testing, we checked that modifying the setting in the front end persisted the change in the Subscription model. We noticed the notifications were not behaving exactly as expected in manual testing; see https://github.com/zulip/zulip/issues/13073#issuecomment-560263081 . Tweaked by tabbott to fix real-time synchronization issues. Fixes: #13429.
2019-11-26 02:37:12 +01:00
# If wildcard_mentions_notify=True for a stream and False for a user, we treat the user
# as mentioned for that stream.
user_profile.wildcard_mentions_notify = False
sub.wildcard_mentions_notify = True
user_profile.save()
sub.save()
client_descriptor = allocate_event_queue()
self.assertTrue(client_descriptor.event_queue.empty())
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("iago"), "Denmark",
wildcard_mentions_notify: Add per-stream override of global setting. Adds required API and front-end changes to modify and read the wildcard_mentions_notify field in the Subscription model. It includes front-end code to add the setting to the user's "manage streams" page. This setting will be greyed out when a stream is muted. The PR also includes back-end code to add the setting the initial state of a subscription. New automated tests were added for the API, events system and front-end. In manual testing, we checked that modifying the setting in the front end persisted the change in the Subscription model. We noticed the notifications were not behaving exactly as expected in manual testing; see https://github.com/zulip/zulip/issues/13073#issuecomment-560263081 . Tweaked by tabbott to fix real-time synchronization issues. Fixes: #13429.
2019-11-26 02:37:12 +01:00
content="@**all** what's up?")
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
self.assertEqual(args_list, (user_profile.id, msg_id, False, False, True, False,
False, "Denmark", False, True,
{'email_notified': True, 'push_notified': True}))
destroy_event_queue(client_descriptor.event_queue.id)
user_profile.wildcard_mentions_notify = True
sub.wildcard_mentions_notify = None
user_profile.save()
sub.save()
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
# Test the hook with a stream message with stream_push_notify
settings: Add notification settings checkboxes for wildcard mentions. This change makes it possible for users to control the notification settings for wildcard mentions as a separate control from PMs and direct @-mentions.
2019-09-03 23:27:45 +02:00
change_subscription_properties(user_profile, stream, sub, {'push_notifications': True})
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
client_descriptor = allocate_event_queue()
event_queue: Fixed stream_push_notify code path in missedmessage_hook. This finishes implementing the stream_push_notify feature, which previously didn't work if you were not idle when the message was sent.
2017-09-28 00:04:32 +02:00
self.assertTrue(client_descriptor.event_queue.empty())
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("iago"), "Denmark",
tests: Fix send_message calls in test_event_queue.py.
2017-10-28 16:22:01 +02:00
content="what's up everyone?")
event_queue: Fixed stream_push_notify code path in missedmessage_hook. This finishes implementing the stream_push_notify feature, which previously didn't work if you were not idle when the message was sent.
2017-09-28 00:04:32 +02:00
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
self.assertEqual(args_list, (user_profile.id, msg_id, False, False, False,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
True, False, "Denmark", False, True,
{'email_notified': False, 'push_notified': False}))
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
destroy_event_queue(client_descriptor.event_queue.id)
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
# Test the hook with a stream message with stream_email_notify
client_descriptor = allocate_event_queue()
test_event_queue: Make subscription management code readable. This test refactor makes the subscription/stream settings changes use standard APIs and thus be easier to follow (and more robust to subtle re-fetching bugs). This is a follow-up to #9181.
2018-08-08 21:39:19 +02:00
change_subscription_properties(user_profile, stream, sub,
{'push_notifications': False,
'email_notifications': True})
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
self.assertTrue(client_descriptor.event_queue.empty())
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("iago"), "Denmark",
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
content="what's up everyone?")
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
self.assertEqual(args_list, (user_profile.id, msg_id, False, False, False,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
False, True, "Denmark", False, True,
notifications: Fix double-sending in missedmessage_hook. While the missedmessage_hook logic originally did a reasonably good job of avoiding double-sending notifications, there was a corner case it didn't handle, namely a user who had been presence-idle when a message was sent and became also event-queue-idle as well within the next 10 minutes. For those users, they got a notification at message send time, and the missedmessage_hook would deliver it a second time. We fix this by just checking the conveniently available push_notified and email_notified variables that indicate whether the message already had a notification triggered. Fixes #7031.
2017-10-18 06:54:03 +02:00
{'email_notified': False, 'push_notified': False}))
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
destroy_event_queue(client_descriptor.event_queue.id)
event_queue: Fixed stream_push_notify code path in missedmessage_hook. This finishes implementing the stream_push_notify feature, which previously didn't work if you were not idle when the message was sent.
2017-09-28 00:04:32 +02:00
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
# Test the hook with stream message with stream_push_notify on
# a muted topic, which we should not push notify for
client_descriptor = allocate_event_queue()
test_event_queue: Make subscription management code readable. This test refactor makes the subscription/stream settings changes use standard APIs and thus be easier to follow (and more robust to subtle re-fetching bugs). This is a follow-up to #9181.
2018-08-08 21:39:19 +02:00
change_subscription_properties(user_profile, stream, sub,
{'push_notifications': True,
'email_notifications': False})
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
notifications: Add failing test for push notifications on muted topics. This is some pre-work as part of #7059.
2017-10-18 07:49:03 +02:00
self.assertTrue(client_descriptor.event_queue.empty())
refactor: Remove recipient arg for do_mute_topic.
2020-10-16 17:29:05 +02:00
do_mute_topic(user_profile, stream, "mutingtest")
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("iago"), "Denmark",
tests: Fix send_message calls in test_event_queue.py.
2017-10-28 16:22:01 +02:00
content="what's up everyone?", topic_name="mutingtest")
notifications: Add failing test for push notifications on muted topics. This is some pre-work as part of #7059.
2017-10-18 07:49:03 +02:00
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
self.assertEqual(args_list, (user_profile.id, msg_id, False, False, False, False,
Excluded topic-muted users from stream push notifications. Fixes #7059
2017-10-24 00:07:03 +02:00
False, "Denmark", False, True,
notifications: Add failing test for push notifications on muted topics. This is some pre-work as part of #7059.
2017-10-18 07:49:03 +02:00
{'email_notified': False, 'push_notified': False}))
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
destroy_event_queue(client_descriptor.event_queue.id)
notifications: Add failing test for push notifications on muted topics. This is some pre-work as part of #7059.
2017-10-18 07:49:03 +02:00
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
# Test the hook with stream message with stream_email_notify on
# a muted stream, which we should not push notify for
client_descriptor = allocate_event_queue()
test_event_queue: Make subscription management code readable. This test refactor makes the subscription/stream settings changes use standard APIs and thus be easier to follow (and more robust to subtle re-fetching bugs). This is a follow-up to #9181.
2018-08-08 21:39:19 +02:00
change_subscription_properties(user_profile, stream, sub,
{'push_notifications': False,
'email_notifications': True})
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
notifications: Fix sending push notifications on muted streams. Apparently, the stream muting feature did not take priority over the stream_push_notify feature. This fixes that gap. Fixes zulip/zulip-mobile#1314.
2017-10-18 07:38:54 +02:00
self.assertTrue(client_descriptor.event_queue.empty())
models: Rename Subscription.in_home_view field to is_muted. This renames Subscription.in_home_view field to is_muted, for greater clarity as to what it does just from seeing the setting name, without having to look it up. Also disabled an obsolete test_migrations test. Fixes #10042.
2018-08-02 23:46:05 +02:00
change_subscription_properties(user_profile, stream, sub, {'is_muted': True})
tests: Use users in send_*_message. This commit mostly makes our tests less noisy, since emails are no longer an important detail of sending messages (they're not even really used in the API). It also sets us up to have more scrutiny on delivery_email/email in the future for things that actually matter. (This is a prep commit for something along those lines, kind of hard to explain the full plan.)
2020-03-07 11:43:05 +01:00
msg_id = self.send_stream_message(self.example_user("iago"), "Denmark",
tests: Fix send_message calls in test_event_queue.py.
2017-10-28 16:22:01 +02:00
content="what's up everyone?")
notifications: Fix sending push notifications on muted streams. Apparently, the stream muting feature did not take priority over the stream_push_notify feature. This fixes that gap. Fixes zulip/zulip-mobile#1314.
2017-10-18 07:38:54 +02:00
with mock.patch("zerver.tornado.event_queue.maybe_enqueue_notifications") as mock_enqueue:
missedmessage_hook(user_profile.id, client_descriptor, True)
mock_enqueue.assert_called_once()
args_list = mock_enqueue.call_args_list[0][0]
messages: Add email/push notifications for wildcard mentions. Historically, Zulip's implementation of wildcard mentions never triggered either email or push notifications, instead being limited to desktop notifications and the "mentions" counter. We fix this just by plumbing the "wildcard_mentioned" flag through our system. Implements much of https://github.com/zulip/zulip/issues/6040#issuecomment-510157264. We're also now ready to seriously work on #3750.
2019-08-26 04:40:07 +02:00
self.assertEqual(args_list, (user_profile.id, msg_id, False, False, False,
event_queue: Add stream_email_notify. This adds support to the event queue system for triggering missed-message notifications (whether push or email) to support the stream push notifications feature.
2017-11-21 07:24:24 +01:00
False, False, "Denmark", False, True,
notifications: Fix sending push notifications on muted streams. Apparently, the stream muting feature did not take priority over the stream_push_notify feature. This fixes that gap. Fixes zulip/zulip-mobile#1314.
2017-10-18 07:38:54 +02:00
{'email_notified': False, 'push_notified': False}))
test_event_queue: Clean up testing setup. Rather than continually resetting the contents of an existing event queue, we allocate a new one for each subtest. We also fix a rather confusing bundle of comments.
2019-08-26 04:35:47 +02:00
destroy_event_queue(client_descriptor.event_queue.id)
notifications: Fix sending push notifications on muted streams. Apparently, the stream muting feature did not take priority over the stream_push_notify feature. This fixes that gap. Fixes zulip/zulip-mobile#1314.
2017-10-18 07:38:54 +02:00
# Clean up the state we just changed (not necessary unless we add more test code below)
test_event_queue: Make subscription management code readable. This test refactor makes the subscription/stream settings changes use standard APIs and thus be easier to follow (and more robust to subtle re-fetching bugs). This is a follow-up to #9181.
2018-08-08 21:39:19 +02:00
change_subscription_properties(user_profile, stream, sub,
{'push_notifications': True,
models: Rename Subscription.in_home_view field to is_muted. This renames Subscription.in_home_view field to is_muted, for greater clarity as to what it does just from seeing the setting name, without having to look it up. Also disabled an obsolete test_migrations test. Fixes #10042.
2018-08-02 23:46:05 +02:00
'is_muted': False})
tornado: Support using a port-aware file for dumping event queues. This should make it possible for there to safely be multiple Tornado processes running on different ports on the same system. It may also fix a rare race bug in development, where previously, it was possible for the Tornados processes for Casper and the main development server to interfere; I haven't investigated whether this was a real bug or not, but now those two services will use independent Tornado files. We still need to add something to direct traffic between the different Tornado processes.
2018-10-04 00:22:39 +02:00
class FileReloadLogicTest(ZulipTestCase):
def test_persistent_queue_filename(self) -> None:
event_queue: Avoid hardcoded paths in /var/tmp. Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2019-01-15 03:03:10 +01:00
with self.settings(JSON_PERSISTENT_QUEUE_FILENAME_PATTERN="/home/zulip/tornado/event_queues%s.json"):
tornado: Move default production port to 9800. In development and test, we keep the Tornado port at 9993 and 9983, respectively; this allows tests to run while a dev instance is running. In production, moving to port 9800 consistently removes an odd edge case, when just one worker is on an entirely different port than if two workers are used.
2020-09-15 01:35:44 +02:00
self.assertEqual(persistent_queue_filename(9800),
event_queue: Avoid hardcoded paths in /var/tmp. Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2019-01-15 03:03:10 +01:00
"/home/zulip/tornado/event_queues.json")
tornado: Move default production port to 9800. In development and test, we keep the Tornado port at 9993 and 9983, respectively; this allows tests to run while a dev instance is running. In production, moving to port 9800 consistently removes an odd edge case, when just one worker is on an entirely different port than if two workers are used.
2020-09-15 01:35:44 +02:00
self.assertEqual(persistent_queue_filename(9800, last=True),
event_queue: Avoid hardcoded paths in /var/tmp. Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2019-01-15 03:03:10 +01:00
"/home/zulip/tornado/event_queues.json.last")
with self.settings(JSON_PERSISTENT_QUEUE_FILENAME_PATTERN="/home/zulip/tornado/event_queues%s.json",
tornado: Support using a port-aware file for dumping event queues. This should make it possible for there to safely be multiple Tornado processes running on different ports on the same system. It may also fix a rare race bug in development, where previously, it was possible for the Tornados processes for Casper and the main development server to interfere; I haven't investigated whether this was a real bug or not, but now those two services will use independent Tornado files. We still need to add something to direct traffic between the different Tornado processes.
2018-10-04 00:22:39 +02:00
TORNADO_PROCESSES=4):
tornado: Move default production port to 9800. In development and test, we keep the Tornado port at 9993 and 9983, respectively; this allows tests to run while a dev instance is running. In production, moving to port 9800 consistently removes an odd edge case, when just one worker is on an entirely different port than if two workers are used.
2020-09-15 01:35:44 +02:00
self.assertEqual(persistent_queue_filename(9800),
"/home/zulip/tornado/event_queues.9800.json")
self.assertEqual(persistent_queue_filename(9800, last=True),
"/home/zulip/tornado/event_queues.9800.last.json")
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
class EventQueueTest(ZulipTestCase):
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
def get_client_descriptor(self) -> ClientDescriptor:
hamlet = self.example_user('hamlet')
realm = hamlet.realm
queue_data = dict(
all_public_streams=False,
apply_markdown=False,
client_gravatar=True,
client_type_name='website',
event_types=None,
last_connection_time=time.time(),
queue_timeout=0,
realm_id=realm.id,
user_profile_id=hamlet.id,
)
client = allocate_client_descriptor(queue_data)
return client
def verify_to_dict_end_to_end(self, client: ClientDescriptor) -> None:
client_dict = client.to_dict()
new_client = ClientDescriptor.from_dict(client_dict)
self.assertEqual(client.to_dict(), new_client.to_dict())
events: Check last_event_id for validity, take 2. This verifies that the client passed a last_event_id that actually came from the queue instead of making up an ID from the future. It turns out one of our tests was making up such an ID, but legitimate clients are expected not to do so. The previous version of this commit (commit e00d4be6d57ca8282a668f9aec2c835d367c6f69, #12888) had to be reverted (commit b86c5cc4903e737bb95aafa240ca3706d090c453) because it was missing the `to_dict`/`from_dict` migration code. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-08-06 00:08:56 +02:00
client_dict = client.to_dict()
del client_dict['event_queue']['newest_pruned_id']
new_client = ClientDescriptor.from_dict(client_dict)
self.assertEqual(client_dict, new_client.to_dict())
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
def test_one_event(self) -> None:
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
client = self.get_client_descriptor()
queue = client.event_queue
pointer tests: Fix test_one_event.
2020-06-26 13:40:19 +02:00
in_dict = dict(
type="arbitrary",
x="foo",
y=42,
z=False,
timestamp="1",
)
out_dict = dict(
id=0,
**in_dict,
)
queue.push(in_dict)
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
self.assertFalse(queue.empty())
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.verify_to_dict_end_to_end(client)
pointer tests: Fix test_one_event.
2020-06-26 13:40:19 +02:00
self.assertEqual(queue.contents(), [out_dict])
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.verify_to_dict_end_to_end(client)
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
def test_event_collapsing(self) -> None:
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
client = self.get_client_descriptor()
queue = client.event_queue
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
tests: Simplify test_event_collapsing. We now use update_message_flags instead of pointer events.
2020-06-26 14:14:36 +02:00
'''
The update_message_flags events are special, because
they can be collapsed together. Given two umfe's, we:
* use the latest timestamp
* concatenate the messages
'''
def umfe(timestamp: int, messages: List[int]) -> Dict[str, Any]:
return dict(
type='update_message_flags',
operation='add',
flag='read',
all=False,
timestamp=timestamp,
messages=messages,
)
events = [
umfe(timestamp=1, messages=[101]),
umfe(timestamp=2, messages=[201, 202]),
dict(type='unknown'),
dict(type='restart', server_generation="1"),
umfe(timestamp=3, messages=[301, 302, 303]),
dict(type='restart', server_generation="2"),
umfe(timestamp=4, messages=[401, 402, 403, 404]),
]
for event in events:
queue.push(event)
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.verify_to_dict_end_to_end(client)
tests: Simplify test_event_collapsing. We now use update_message_flags instead of pointer events.
2020-06-26 14:14:36 +02:00
self.assertEqual(queue.contents(), [
dict(id=2, type='unknown'),
dict(id=5, type='restart', server_generation="2"),
dict(
id=6,
type='update_message_flags',
operation='add',
flag='read',
all=False,
timestamp=4,
messages=[101, 201, 202, 301, 302, 303, 401, 402, 403, 404],
),
])
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
tests: Simplify test_event_collapsing. We now use update_message_flags instead of pointer events.
2020-06-26 14:14:36 +02:00
'''
Note that calling queue.contents() has the side
effect that we will no longer be able to collapse
the previous events, so the next event will just
get added to the queue, rather than collapsed.
'''
queue.push(
umfe(timestamp=5, messages=[501, 502, 503, 504, 505]),
)
self.assertEqual(queue.contents(), [
dict(id=2, type='unknown'),
dict(id=5, type='restart', server_generation="2"),
dict(
id=6,
type='update_message_flags',
operation='add',
flag='read',
all=False,
timestamp=4,
messages=[101, 201, 202, 301, 302, 303, 401, 402, 403, 404],
),
dict(
id=7,
type='update_message_flags',
operation='add',
flag='read',
all=False,
timestamp=5,
messages=[501, 502, 503, 504, 505],
),
])
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
def test_flag_add_collapsing(self) -> None:
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
client = self.get_client_descriptor()
queue = client.event_queue
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
queue.push({"type": "update_message_flags",
"flag": "read",
"operation": "add",
"all": False,
"messages": [1, 2, 3, 4],
"timestamp": "1"})
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.verify_to_dict_end_to_end(client)
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
queue.push({"type": "update_message_flags",
"flag": "read",
"all": False,
"operation": "add",
"messages": [5, 6],
"timestamp": "1"})
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.verify_to_dict_end_to_end(client)
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
self.assertEqual(queue.contents(),
[{'id': 1,
'type': 'update_message_flags',
"all": False,
"flag": "read",
"operation": "add",
"messages": [1, 2, 3, 4, 5, 6],
"timestamp": "1"}])
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.verify_to_dict_end_to_end(client)
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
def test_flag_remove_collapsing(self) -> None:
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
client = self.get_client_descriptor()
queue = client.event_queue
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
queue.push({"type": "update_message_flags",
"flag": "collapsed",
"operation": "remove",
"all": False,
"messages": [1, 2, 3, 4],
"timestamp": "1"})
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.verify_to_dict_end_to_end(client)
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
queue.push({"type": "update_message_flags",
"flag": "collapsed",
"all": False,
"operation": "remove",
"messages": [5, 6],
"timestamp": "1"})
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.verify_to_dict_end_to_end(client)
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
self.assertEqual(queue.contents(),
[{'id': 1,
'type': 'update_message_flags',
"all": False,
"flag": "collapsed",
"operation": "remove",
"messages": [1, 2, 3, 4, 5, 6],
"timestamp": "1"}])
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.verify_to_dict_end_to_end(client)
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
def test_collapse_event(self) -> None:
pointer tests: Use restart for test_collapse_event. The restart event was always handled pretty similarly to pointer, so I use restart events now for this test (in preparation of eliminating pointer events).
2020-06-26 16:11:38 +02:00
'''
This mostly focues on the internals of
how we store "virtual_events" that we
can collapse if subsequent events are
of the same form. See the code in
EventQueue.push for more context.
'''
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
client = self.get_client_descriptor()
queue = client.event_queue
pointer tests: Use restart for test_collapse_event. The restart event was always handled pretty similarly to pointer, so I use restart events now for this test (in preparation of eliminating pointer events).
2020-06-26 16:11:38 +02:00
queue.push({"type": "restart",
"server_generation": 1,
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
"timestamp": "1"})
pointer tests: Use restart for test_collapse_event. The restart event was always handled pretty similarly to pointer, so I use restart events now for this test (in preparation of eliminating pointer events).
2020-06-26 16:11:38 +02:00
# Verify the server_generation event is stored as a virtual event
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.assertEqual(queue.virtual_events,
pointer tests: Use restart for test_collapse_event. The restart event was always handled pretty similarly to pointer, so I use restart events now for this test (in preparation of eliminating pointer events).
2020-06-26 16:11:38 +02:00
{'restart':
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
{'id': 0,
pointer tests: Use restart for test_collapse_event. The restart event was always handled pretty similarly to pointer, so I use restart events now for this test (in preparation of eliminating pointer events).
2020-06-26 16:11:38 +02:00
'type': 'restart',
'server_generation': 1,
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
"timestamp": "1"}})
# And we can reconstruct newest_pruned_id etc.
self.verify_to_dict_end_to_end(client)
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
queue.push({"type": "unknown",
"timestamp": "1"})
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
self.assertEqual(list(queue.queue),
[{'id': 1,
'type': 'unknown',
"timestamp": "1"}])
self.assertEqual(queue.virtual_events,
pointer tests: Use restart for test_collapse_event. The restart event was always handled pretty similarly to pointer, so I use restart events now for this test (in preparation of eliminating pointer events).
2020-06-26 16:11:38 +02:00
{'restart':
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
{'id': 0,
pointer tests: Use restart for test_collapse_event. The restart event was always handled pretty similarly to pointer, so I use restart events now for this test (in preparation of eliminating pointer events).
2020-06-26 16:11:38 +02:00
'type': 'restart',
'server_generation': 1,
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
"timestamp": "1"}})
# And we can still reconstruct newest_pruned_id etc. correctly
self.verify_to_dict_end_to_end(client)
# Verify virtual events are converted to real events by .contents()
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
self.assertEqual(queue.contents(),
[{'id': 0,
pointer tests: Use restart for test_collapse_event. The restart event was always handled pretty similarly to pointer, so I use restart events now for this test (in preparation of eliminating pointer events).
2020-06-26 16:11:38 +02:00
'type': 'restart',
"server_generation": 1,
tests: Move EventQueueTest to test_event_queue.py. This seems more appropriate, especially as we expand this library.
2019-08-02 21:50:27 +02:00
"timestamp": "1"},
{'id': 1,
'type': 'unknown',
"timestamp": "1"}])
event_queue: Expand testing of event queue save/restore. This verifies that every valid state of our event queue system will be properly save/restored via the from_dict methods.
2019-08-02 22:23:05 +02:00
# And now verify to_dict after pruning
queue.prune(0)
self.verify_to_dict_end_to_end(client)
queue.prune(1)
self.verify_to_dict_end_to_end(client)