Matrix-Mirrors/synapse-product
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse-product.git synced 2024-12-17 05:24:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

Use a real room in the notification rotation tests. (#13260)

Browse Source 
Instead of manually inserting fake data. This fixes some issues with
having to manually calculate stream orderings and other oddities.
This commit is contained in:
Patrick Cloke 2022-07-15 08:22:43 -04:00 committed by GitHub
parent 7281591f4c
commit 3343035a06
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 79 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/13260.misc Normal file
View File

@ -0,0 +1 @@
Clean-up tests for notifications.

195
tests/storage/test_event_push_actions.py
View File

@ -12,10 +12,10 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
from unittest.mock import Mock
from twisted.test.proto_helpers import MemoryReactor 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.server import HomeServer
from synapse.storage.databases.main.event_push_actions import NotifCounts from synapse.storage.databases.main.event_push_actions import NotifCounts
from synapse.util import Clock from synapse.util import Clock
@ -24,15 +24,14 @@ from tests.unittest import HomeserverTestCase
USER_ID = "@user:example.com" 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): class EventPushActionsStoreTestCase(HomeserverTestCase):
servlets = [
admin.register_servlets,
room.register_servlets,
login.register_servlets,
]
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None: def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
self.store = hs.get_datastores().main self.store = hs.get_datastores().main
persist_events_store = hs.get_datastores().persist_events persist_events_store = hs.get_datastores().persist_events
@ -54,154 +53,118 @@ class EventPushActionsStoreTestCase(HomeserverTestCase):
) )
def test_count_aggregation(self) -> None: def test_count_aggregation(self) -> None:
room_id = "!foo:example.com" # Create a user to receive notifications and send receipts.
user_id = "@user1235:test" user_id = self.register_user("user1235", "pass")
token = self.login("user1235", "pass")
last_read_stream_ordering = [0] # And another users to send events.
other_id = self.register_user("other", "pass")
other_token = self.login("other", "pass")
def _assert_counts(noitf_count: int, highlight_count: int) -> None: # 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_event_id: str
def _assert_counts(
noitf_count: int, unread_count: int, highlight_count: int
) -> None:
counts = self.get_success( counts = self.get_success(
self.store.db_pool.runInteraction( self.store.db_pool.runInteraction(
"", "get-unread-counts",
self.store._get_unread_counts_by_pos_txn, self.store._get_unread_counts_by_receipt_txn,
room_id, room_id,
user_id, user_id,
last_read_stream_ordering[0],
) )
) )
self.assertEqual( self.assertEqual(
counts, counts,
NotifCounts( NotifCounts(
notify_count=noitf_count, notify_count=noitf_count,
unread_count=0, # Unread counts are tested in the sync tests. unread_count=unread_count,
highlight_count=highlight_count, highlight_count=highlight_count,
), ),
) )
def _inject_actions(stream: int, action: list) -> None: def _create_event(highlight: bool = False) -> str:
event = Mock() result = self.helper.send_event(
event.room_id = room_id room_id,
event.event_id = f"$test{stream}:example.com" type="m.room.message",
event.internal_metadata.stream_ordering = stream content={"msgtype": "m.text", "body": user_id if highlight else "msg"},
event.internal_metadata.is_outlier.return_value = False tok=other_token,
event.depth = stream )
nonlocal last_event_id
last_event_id = result["event_id"]
return last_event_id
self.store._events_stream_cache.entity_has_changed(room_id, stream) def _rotate() -> None:
self.get_success(self.store._rotate_notifs())
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,
},
)
)
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 _mark_read(event_id: str) -> None:
self.get_success( self.get_success(
self.store.insert_receipt( self.store.insert_receipt(
room_id, room_id,
"m.read", "m.read",
user_id=user_id, user_id=user_id,
event_ids=[f"$test{stream}:example.com"], event_ids=[event_id],
data={}, data={},
) )
) )
_assert_counts(0, 0) _assert_counts(0, 0, 0)
_inject_actions(1, PlAIN_NOTIF) _create_event()
_assert_counts(1, 0) _assert_counts(1, 1, 0)
_rotate(1) _rotate()
_assert_counts(1, 0) _assert_counts(1, 1, 0)
_inject_actions(3, PlAIN_NOTIF) event_id = _create_event()
_assert_counts(2, 0) _assert_counts(2, 2, 0)
_rotate(3) _rotate()
_assert_counts(2, 0) _assert_counts(2, 2, 0)
_inject_actions(5, PlAIN_NOTIF) _create_event()
_mark_read(3, 3) _mark_read(event_id)
_assert_counts(1, 0) _assert_counts(1, 1, 0)
_mark_read(5, 5) _mark_read(last_event_id)
_assert_counts(0, 0) _assert_counts(0, 0, 0)
_inject_actions(6, PlAIN_NOTIF) _create_event()
_rotate(6) _rotate()
_assert_counts(1, 0) _assert_counts(1, 1, 0)
self.get_success( # Delete old event push actions, this should not affect the (summarised) count.
self.store.db_pool.simple_delete( self.get_success(self.store._remove_old_push_actions_that_have_rotated())
table="event_push_actions", keyvalues={"1": 1}, desc="" _assert_counts(1, 1, 0)
)
)
_assert_counts(1, 0) _mark_read(last_event_id)
_assert_counts(0, 0, 0)
_mark_read(6, 6) event_id = _create_event(True)
_assert_counts(0, 0) _assert_counts(1, 1, 1)
_rotate()
_inject_actions(8, HIGHLIGHT) _assert_counts(1, 1, 1)
_assert_counts(1, 1)
_rotate(8)
_assert_counts(1, 1)
# Check that adding another notification and rotating after highlight # Check that adding another notification and rotating after highlight
# works. # works.
_inject_actions(10, PlAIN_NOTIF) _create_event()
_rotate(10) _rotate()
_assert_counts(2, 1) _assert_counts(2, 2, 1)
# Check that sending read receipts at different points results in the # Check that sending read receipts at different points results in the
# right counts. # right counts.
_mark_read(8, 8) _mark_read(event_id)
_assert_counts(1, 0) _assert_counts(1, 1, 0)
_mark_read(10, 10) _mark_read(last_event_id)
_assert_counts(0, 0) _assert_counts(0, 0, 0)
_inject_actions(11, HIGHLIGHT) _create_event(True)
_assert_counts(1, 1) _assert_counts(1, 1, 1)
_mark_read(11, 11) _mark_read(last_event_id)
_assert_counts(0, 0) _assert_counts(0, 0, 0)
_rotate(11) _rotate()
_assert_counts(0, 0) _assert_counts(0, 0, 0)
def test_find_first_stream_ordering_after_ts(self) -> None: def test_find_first_stream_ordering_after_ts(self) -> None:
def add_event(so: int, ts: int) -> None: def add_event(so: int, ts: int) -> None: