Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Use a real room in the notification rotation tests. (#13260)
Browse files Browse the repository at this point in the history 
Instead of manually inserting fake data. This fixes some issues with
having to manually calculate stream orderings and other oddities.
  • Loading branch information
@clokep
clokep authored Jul 15, 2022
1 parent 7281591 commit 3343035
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 116 deletions.
1 change: 1 addition & 0 deletions changelog.d/13260.misc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clean-up tests for notifications.
195 changes: 79 additions & 116 deletions tests/storage/test_event_push_actions.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.

from unittest.mock import Mock

from twisted.test.proto_helpers import MemoryReactor

from synapse.rest import admin
from synapse.rest.client import login, room
from synapse.server import HomeServer
from synapse.storage.databases.main.event_push_actions import NotifCounts
from synapse.util import Clock
Expand All @@ -24,15 +24,14 @@

USER_ID = "@user:example.com"

PlAIN_NOTIF = ["notify", {"set_tweak": "highlight", "value": False}]
HIGHLIGHT = [
"notify",
{"set_tweak": "sound", "value": "default"},
{"set_tweak": "highlight"},
]


class EventPushActionsStoreTestCase(HomeserverTestCase):
servlets = [
admin.register_servlets,
room.register_servlets,
login.register_servlets,
]

def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
self.store = hs.get_datastores().main
persist_events_store = hs.get_datastores().persist_events
Expand All @@ -54,154 +53,118 @@ def test_get_unread_push_actions_for_user_in_range_for_email(self) -> None:
)

def test_count_aggregation(self) -> None:
room_id = "!foo:example.com"
user_id = "@user1235:test"
# Create a user to receive notifications and send receipts.
user_id = self.register_user("user1235", "pass")
token = self.login("user1235", "pass")

# And another users to send events.
other_id = self.register_user("other", "pass")
other_token = self.login("other", "pass")

# Create a room and put both users in it.
room_id = self.helper.create_room_as(user_id, tok=token)
self.helper.join(room_id, other_id, tok=other_token)

last_read_stream_ordering = [0]
last_event_id: str

def _assert_counts(noitf_count: int, highlight_count: int) -> None:
def _assert_counts(
noitf_count: int, unread_count: int, highlight_count: int
) -> None:
counts = self.get_success(
self.store.db_pool.runInteraction(
"",
self.store._get_unread_counts_by_pos_txn,
"get-unread-counts",
self.store._get_unread_counts_by_receipt_txn,
room_id,
user_id,
last_read_stream_ordering[0],
)
)
self.assertEqual(
counts,
NotifCounts(
notify_count=noitf_count,
unread_count=0, # Unread counts are tested in the sync tests.
unread_count=unread_count,
highlight_count=highlight_count,
),
)

def _inject_actions(stream: int, action: list) -> None:
event = Mock()
event.room_id = room_id
event.event_id = f"$test{stream}:example.com"
event.internal_metadata.stream_ordering = stream
event.internal_metadata.is_outlier.return_value = False
event.depth = stream

self.store._events_stream_cache.entity_has_changed(room_id, stream)

self.get_success(
self.store.db_pool.simple_insert(
table="events",
values={
"stream_ordering": stream,
"topological_ordering": stream,
"type": "m.room.message",
"room_id": room_id,
"processed": True,
"outlier": False,
"event_id": event.event_id,
},
)
def _create_event(highlight: bool = False) -> str:
result = self.helper.send_event(
room_id,
type="m.room.message",
content={"msgtype": "m.text", "body": user_id if highlight else "msg"},
tok=other_token,
)
nonlocal last_event_id
last_event_id = result["event_id"]
return last_event_id

self.get_success(
self.store.add_push_actions_to_staging(
event.event_id,
{user_id: action},
False,
)
)
self.get_success(
self.store.db_pool.runInteraction(
"",
self.persist_events_store._set_push_actions_for_event_and_users_txn,
[(event, None)],
[(event, None)],
)
)

def _rotate(stream: int) -> None:
self.get_success(
self.store.db_pool.runInteraction(
"rotate-receipts", self.store._handle_new_receipts_for_notifs_txn
)
)

self.get_success(
self.store.db_pool.runInteraction(
"rotate-notifs", self.store._rotate_notifs_before_txn, stream
)
)

def _mark_read(stream: int, depth: int) -> None:
last_read_stream_ordering[0] = stream
def _rotate() -> None:
self.get_success(self.store._rotate_notifs())

def _mark_read(event_id: str) -> None:
self.get_success(
self.store.insert_receipt(
room_id,
"m.read",
user_id=user_id,
event_ids=[f"$test{stream}:example.com"],
event_ids=[event_id],
data={},
)
)

_assert_counts(0, 0)
_inject_actions(1, PlAIN_NOTIF)
_assert_counts(1, 0)
_rotate(1)
_assert_counts(1, 0)
_assert_counts(0, 0, 0)
_create_event()
_assert_counts(1, 1, 0)
_rotate()
_assert_counts(1, 1, 0)

_inject_actions(3, PlAIN_NOTIF)
_assert_counts(2, 0)
_rotate(3)
_assert_counts(2, 0)
event_id = _create_event()
_assert_counts(2, 2, 0)
_rotate()
_assert_counts(2, 2, 0)

_inject_actions(5, PlAIN_NOTIF)
_mark_read(3, 3)
_assert_counts(1, 0)
_create_event()
_mark_read(event_id)
_assert_counts(1, 1, 0)

_mark_read(5, 5)
_assert_counts(0, 0)
_mark_read(last_event_id)
_assert_counts(0, 0, 0)

_inject_actions(6, PlAIN_NOTIF)
_rotate(6)
_assert_counts(1, 0)

self.get_success(
self.store.db_pool.simple_delete(
table="event_push_actions", keyvalues={"1": 1}, desc=""
)
)
_create_event()
_rotate()
_assert_counts(1, 1, 0)

_assert_counts(1, 0)
# Delete old event push actions, this should not affect the (summarised) count.
self.get_success(self.store._remove_old_push_actions_that_have_rotated())
_assert_counts(1, 1, 0)

_mark_read(6, 6)
_assert_counts(0, 0)
_mark_read(last_event_id)
_assert_counts(0, 0, 0)

_inject_actions(8, HIGHLIGHT)
_assert_counts(1, 1)
_rotate(8)
_assert_counts(1, 1)
event_id = _create_event(True)
_assert_counts(1, 1, 1)
_rotate()
_assert_counts(1, 1, 1)

# Check that adding another notification and rotating after highlight
# works.
_inject_actions(10, PlAIN_NOTIF)
_rotate(10)
_assert_counts(2, 1)
_create_event()
_rotate()
_assert_counts(2, 2, 1)

# Check that sending read receipts at different points results in the
# right counts.
_mark_read(8, 8)
_assert_counts(1, 0)
_mark_read(10, 10)
_assert_counts(0, 0)

_inject_actions(11, HIGHLIGHT)
_assert_counts(1, 1)
_mark_read(11, 11)
_assert_counts(0, 0)
_rotate(11)
_assert_counts(0, 0)
_mark_read(event_id)
_assert_counts(1, 1, 0)
_mark_read(last_event_id)
_assert_counts(0, 0, 0)

_create_event(True)
_assert_counts(1, 1, 1)
_mark_read(last_event_id)
_assert_counts(0, 0, 0)
_rotate()
_assert_counts(0, 0, 0)

def test_find_first_stream_ordering_after_ts(self) -> None:
def add_event(so: int, ts: int) -> None:
Expand Down

0 comments on commit 3343035

Please sign in to comment.