# # This file is licensed under the Affero General Public License (AGPL) version 3. # # Copyright 2021 The Matrix.org Foundation C.I.C. # Copyright (C) 2023 New Vector, Ltd # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as # published by the Free Software Foundation, either version 3 of the # License, or (at your option) any later version. # # See the GNU Affero General Public License for more details: # . # # Originally licensed under the Apache License, Version 2.0: # . # # [This file includes modifications made by New Vector Limited] # # from typing import List from twisted.test.proto_helpers import MemoryReactor from synapse.api.constants import Direction, EventTypes, RelationTypes from synapse.api.filtering import Filter from synapse.rest import admin from synapse.rest.client import login, room from synapse.server import HomeServer from synapse.types import JsonDict from synapse.util import Clock from tests.unittest import HomeserverTestCase class PaginationTestCase(HomeserverTestCase): """ Test the pre-filtering done in the pagination code. This is similar to some of the tests in tests.rest.client.test_rooms but here we ensure that the filtering done in the database is applied successfully. """ servlets = [ admin.register_servlets_for_client_rest_resource, room.register_servlets, login.register_servlets, ] def default_config(self) -> JsonDict: config = super().default_config() config["experimental_features"] = {"msc3874_enabled": True} return config def prepare( self, reactor: MemoryReactor, clock: Clock, homeserver: HomeServer ) -> None: self.user_id = self.register_user("test", "test") self.tok = self.login("test", "test") self.room_id = self.helper.create_room_as(self.user_id, tok=self.tok) self.second_user_id = self.register_user("second", "test") self.second_tok = self.login("second", "test") self.helper.join( room=self.room_id, user=self.second_user_id, tok=self.second_tok ) self.third_user_id = self.register_user("third", "test") self.third_tok = self.login("third", "test") self.helper.join(room=self.room_id, user=self.third_user_id, tok=self.third_tok) # Store a token which is after all the room creation events. self.from_token = self.get_success( self.hs.get_event_sources().get_current_token_for_pagination(self.room_id) ) # An initial event with a relation from second user. res = self.helper.send_event( room_id=self.room_id, type=EventTypes.Message, content={"msgtype": "m.text", "body": "Message 1"}, tok=self.tok, ) self.event_id_1 = res["event_id"] res = self.helper.send_event( room_id=self.room_id, type="m.reaction", content={ "m.relates_to": { "rel_type": RelationTypes.ANNOTATION, "event_id": self.event_id_1, "key": "👍", } }, tok=self.second_tok, ) self.event_id_annotation = res["event_id"] # Another event with a relation from third user. res = self.helper.send_event( room_id=self.room_id, type=EventTypes.Message, content={"msgtype": "m.text", "body": "Message 2"}, tok=self.tok, ) self.event_id_2 = res["event_id"] res = self.helper.send_event( room_id=self.room_id, type="m.reaction", content={ "m.relates_to": { "rel_type": RelationTypes.REFERENCE, "event_id": self.event_id_2, } }, tok=self.third_tok, ) self.event_id_reference = res["event_id"] # An event with no relations. res = self.helper.send_event( room_id=self.room_id, type=EventTypes.Message, content={"msgtype": "m.text", "body": "No relations"}, tok=self.tok, ) self.event_id_none = res["event_id"] def _filter_messages(self, filter: JsonDict) -> List[str]: """Make a request to /messages with a filter, returns the chunk of events.""" events, next_key = self.get_success( self.hs.get_datastores().main.paginate_room_events( room_id=self.room_id, from_key=self.from_token.room_key, to_key=None, direction=Direction.FORWARDS, limit=10, event_filter=Filter(self.hs, filter), ) ) return [ev.event_id for ev in events] def test_filter_relation_senders(self) -> None: # Messages which second user reacted to. filter = {"related_by_senders": [self.second_user_id]} chunk = self._filter_messages(filter) self.assertEqual(chunk, [self.event_id_1]) # Messages which third user reacted to. filter = {"related_by_senders": [self.third_user_id]} chunk = self._filter_messages(filter) self.assertEqual(chunk, [self.event_id_2]) # Messages which either user reacted to. filter = {"related_by_senders": [self.second_user_id, self.third_user_id]} chunk = self._filter_messages(filter) self.assertCountEqual(chunk, [self.event_id_1, self.event_id_2]) def test_filter_relation_type(self) -> None: # Messages which have annotations. filter = {"related_by_rel_types": [RelationTypes.ANNOTATION]} chunk = self._filter_messages(filter) self.assertEqual(chunk, [self.event_id_1]) # Messages which have references. filter = {"related_by_rel_types": [RelationTypes.REFERENCE]} chunk = self._filter_messages(filter) self.assertEqual(chunk, [self.event_id_2]) # Messages which have either annotations or references. filter = { "related_by_rel_types": [ RelationTypes.ANNOTATION, RelationTypes.REFERENCE, ] } chunk = self._filter_messages(filter) self.assertCountEqual(chunk, [self.event_id_1, self.event_id_2]) def test_filter_relation_senders_and_type(self) -> None: # Messages which second user reacted to. filter = { "related_by_senders": [self.second_user_id], "related_by_rel_types": [RelationTypes.ANNOTATION], } chunk = self._filter_messages(filter) self.assertEqual(chunk, [self.event_id_1]) def test_duplicate_relation(self) -> None: """An event should only be returned once if there are multiple relations to it.""" self.helper.send_event( room_id=self.room_id, type="m.reaction", content={ "m.relates_to": { "rel_type": RelationTypes.ANNOTATION, "event_id": self.event_id_1, "key": "A", } }, tok=self.second_tok, ) filter = {"related_by_senders": [self.second_user_id]} chunk = self._filter_messages(filter) self.assertEqual(chunk, [self.event_id_1]) def test_filter_rel_types(self) -> None: # Messages which are annotations. filter = {"org.matrix.msc3874.rel_types": [RelationTypes.ANNOTATION]} chunk = self._filter_messages(filter) self.assertEqual(chunk, [self.event_id_annotation]) # Messages which are references. filter = {"org.matrix.msc3874.rel_types": [RelationTypes.REFERENCE]} chunk = self._filter_messages(filter) self.assertEqual(chunk, [self.event_id_reference]) # Messages which are either annotations or references. filter = { "org.matrix.msc3874.rel_types": [ RelationTypes.ANNOTATION, RelationTypes.REFERENCE, ] } chunk = self._filter_messages(filter) self.assertCountEqual( chunk, [self.event_id_annotation, self.event_id_reference], ) def test_filter_not_rel_types(self) -> None: # Messages which are not annotations. filter = {"org.matrix.msc3874.not_rel_types": [RelationTypes.ANNOTATION]} chunk = self._filter_messages(filter) self.assertEqual( chunk, [ self.event_id_1, self.event_id_2, self.event_id_reference, self.event_id_none, ], ) # Messages which are not references. filter = {"org.matrix.msc3874.not_rel_types": [RelationTypes.REFERENCE]} chunk = self._filter_messages(filter) self.assertEqual( chunk, [ self.event_id_1, self.event_id_annotation, self.event_id_2, self.event_id_none, ], ) # Messages which are neither annotations or references. filter = { "org.matrix.msc3874.not_rel_types": [ RelationTypes.ANNOTATION, RelationTypes.REFERENCE, ] } chunk = self._filter_messages(filter) self.assertEqual(chunk, [self.event_id_1, self.event_id_2, self.event_id_none])