mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2025-08-10 09:30:04 -04:00
Support filtering by relations per MSC3440 (#11236)
Adds experimental support for `relation_types` and `relation_senders` fields for filters.
This commit is contained in:
Patrick Cloke
GitHub
parent
4b3e30c276
commit
a19d01c3d9
15 changed files with 680 additions and 110 deletions
|
|
@ -15,6 +15,8 @@
|
|||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
from unittest.mock import patch
|
||||
|
||||
import jsonschema
|
||||
|
||||
from synapse.api.constants import EventContentFields
|
||||
|
|
@ -51,9 +53,8 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
{"presence": {"senders": ["@bar;pik.test.com"]}},
|
||||
]
|
||||
for filter in invalid_filters:
|
||||
with self.assertRaises(SynapseError) as check_filter_error:
|
||||
with self.assertRaises(SynapseError):
|
||||
self.filtering.check_valid_filter(filter)
|
||||
self.assertIsInstance(check_filter_error.exception, SynapseError)
|
||||
|
||||
def test_valid_filters(self):
|
||||
valid_filters = [
|
||||
|
|
@ -119,12 +120,12 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
definition = {"types": ["m.room.message", "org.matrix.foo.bar"]}
|
||||
event = MockEvent(sender="@foo:bar", type="m.room.message", room_id="!foo:bar")
|
||||
|
||||
self.assertTrue(Filter(definition).check(event))
|
||||
self.assertTrue(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_types_works_with_wildcards(self):
|
||||
definition = {"types": ["m.*", "org.matrix.foo.bar"]}
|
||||
event = MockEvent(sender="@foo:bar", type="m.room.message", room_id="!foo:bar")
|
||||
self.assertTrue(Filter(definition).check(event))
|
||||
self.assertTrue(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_types_works_with_unknowns(self):
|
||||
definition = {"types": ["m.room.message", "org.matrix.foo.bar"]}
|
||||
|
|
@ -133,24 +134,24 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
type="now.for.something.completely.different",
|
||||
room_id="!foo:bar",
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_not_types_works_with_literals(self):
|
||||
definition = {"not_types": ["m.room.message", "org.matrix.foo.bar"]}
|
||||
event = MockEvent(sender="@foo:bar", type="m.room.message", room_id="!foo:bar")
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_not_types_works_with_wildcards(self):
|
||||
definition = {"not_types": ["m.room.message", "org.matrix.*"]}
|
||||
event = MockEvent(
|
||||
sender="@foo:bar", type="org.matrix.custom.event", room_id="!foo:bar"
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_not_types_works_with_unknowns(self):
|
||||
definition = {"not_types": ["m.*", "org.*"]}
|
||||
event = MockEvent(sender="@foo:bar", type="com.nom.nom.nom", room_id="!foo:bar")
|
||||
self.assertTrue(Filter(definition).check(event))
|
||||
self.assertTrue(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_not_types_takes_priority_over_types(self):
|
||||
definition = {
|
||||
|
|
@ -158,35 +159,35 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
"types": ["m.room.message", "m.room.topic"],
|
||||
}
|
||||
event = MockEvent(sender="@foo:bar", type="m.room.topic", room_id="!foo:bar")
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_senders_works_with_literals(self):
|
||||
definition = {"senders": ["@flibble:wibble"]}
|
||||
event = MockEvent(
|
||||
sender="@flibble:wibble", type="com.nom.nom.nom", room_id="!foo:bar"
|
||||
)
|
||||
self.assertTrue(Filter(definition).check(event))
|
||||
self.assertTrue(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_senders_works_with_unknowns(self):
|
||||
definition = {"senders": ["@flibble:wibble"]}
|
||||
event = MockEvent(
|
||||
sender="@challenger:appears", type="com.nom.nom.nom", room_id="!foo:bar"
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_not_senders_works_with_literals(self):
|
||||
definition = {"not_senders": ["@flibble:wibble"]}
|
||||
event = MockEvent(
|
||||
sender="@flibble:wibble", type="com.nom.nom.nom", room_id="!foo:bar"
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_not_senders_works_with_unknowns(self):
|
||||
definition = {"not_senders": ["@flibble:wibble"]}
|
||||
event = MockEvent(
|
||||
sender="@challenger:appears", type="com.nom.nom.nom", room_id="!foo:bar"
|
||||
)
|
||||
self.assertTrue(Filter(definition).check(event))
|
||||
self.assertTrue(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_not_senders_takes_priority_over_senders(self):
|
||||
definition = {
|
||||
|
|
@ -196,14 +197,14 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
event = MockEvent(
|
||||
sender="@misspiggy:muppets", type="m.room.topic", room_id="!foo:bar"
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_rooms_works_with_literals(self):
|
||||
definition = {"rooms": ["!secretbase:unknown"]}
|
||||
event = MockEvent(
|
||||
sender="@foo:bar", type="m.room.message", room_id="!secretbase:unknown"
|
||||
)
|
||||
self.assertTrue(Filter(definition).check(event))
|
||||
self.assertTrue(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_rooms_works_with_unknowns(self):
|
||||
definition = {"rooms": ["!secretbase:unknown"]}
|
||||
|
|
@ -212,7 +213,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
type="m.room.message",
|
||||
room_id="!anothersecretbase:unknown",
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_not_rooms_works_with_literals(self):
|
||||
definition = {"not_rooms": ["!anothersecretbase:unknown"]}
|
||||
|
|
@ -221,7 +222,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
type="m.room.message",
|
||||
room_id="!anothersecretbase:unknown",
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_not_rooms_works_with_unknowns(self):
|
||||
definition = {"not_rooms": ["!secretbase:unknown"]}
|
||||
|
|
@ -230,7 +231,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
type="m.room.message",
|
||||
room_id="!anothersecretbase:unknown",
|
||||
)
|
||||
self.assertTrue(Filter(definition).check(event))
|
||||
self.assertTrue(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_not_rooms_takes_priority_over_rooms(self):
|
||||
definition = {
|
||||
|
|
@ -240,7 +241,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
event = MockEvent(
|
||||
sender="@foo:bar", type="m.room.message", room_id="!secretbase:unknown"
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_combined_event(self):
|
||||
definition = {
|
||||
|
|
@ -256,7 +257,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
type="m.room.message", # yup
|
||||
room_id="!stage:unknown", # yup
|
||||
)
|
||||
self.assertTrue(Filter(definition).check(event))
|
||||
self.assertTrue(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_combined_event_bad_sender(self):
|
||||
definition = {
|
||||
|
|
@ -272,7 +273,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
type="m.room.message", # yup
|
||||
room_id="!stage:unknown", # yup
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_combined_event_bad_room(self):
|
||||
definition = {
|
||||
|
|
@ -288,7 +289,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
type="m.room.message", # yup
|
||||
room_id="!piggyshouse:muppets", # nope
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_definition_combined_event_bad_type(self):
|
||||
definition = {
|
||||
|
|
@ -304,7 +305,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
type="muppets.misspiggy.kisses", # nope
|
||||
room_id="!stage:unknown", # yup
|
||||
)
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_filter_labels(self):
|
||||
definition = {"org.matrix.labels": ["#fun"]}
|
||||
|
|
@ -315,7 +316,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
content={EventContentFields.LABELS: ["#fun"]},
|
||||
)
|
||||
|
||||
self.assertTrue(Filter(definition).check(event))
|
||||
self.assertTrue(Filter(self.hs, definition)._check(event))
|
||||
|
||||
event = MockEvent(
|
||||
sender="@foo:bar",
|
||||
|
|
@ -324,7 +325,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
content={EventContentFields.LABELS: ["#notfun"]},
|
||||
)
|
||||
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_filter_not_labels(self):
|
||||
definition = {"org.matrix.not_labels": ["#fun"]}
|
||||
|
|
@ -335,7 +336,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
content={EventContentFields.LABELS: ["#fun"]},
|
||||
)
|
||||
|
||||
self.assertFalse(Filter(definition).check(event))
|
||||
self.assertFalse(Filter(self.hs, definition)._check(event))
|
||||
|
||||
event = MockEvent(
|
||||
sender="@foo:bar",
|
||||
|
|
@ -344,7 +345,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
content={EventContentFields.LABELS: ["#notfun"]},
|
||||
)
|
||||
|
||||
self.assertTrue(Filter(definition).check(event))
|
||||
self.assertTrue(Filter(self.hs, definition)._check(event))
|
||||
|
||||
def test_filter_presence_match(self):
|
||||
user_filter_json = {"presence": {"types": ["m.*"]}}
|
||||
|
|
@ -362,7 +363,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
)
|
||||
)
|
||||
|
||||
results = user_filter.filter_presence(events=events)
|
||||
results = self.get_success(user_filter.filter_presence(events=events))
|
||||
self.assertEquals(events, results)
|
||||
|
||||
def test_filter_presence_no_match(self):
|
||||
|
|
@ -386,7 +387,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
)
|
||||
)
|
||||
|
||||
results = user_filter.filter_presence(events=events)
|
||||
results = self.get_success(user_filter.filter_presence(events=events))
|
||||
self.assertEquals([], results)
|
||||
|
||||
def test_filter_room_state_match(self):
|
||||
|
|
@ -405,7 +406,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
)
|
||||
)
|
||||
|
||||
results = user_filter.filter_room_state(events=events)
|
||||
results = self.get_success(user_filter.filter_room_state(events=events))
|
||||
self.assertEquals(events, results)
|
||||
|
||||
def test_filter_room_state_no_match(self):
|
||||
|
|
@ -426,7 +427,7 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
)
|
||||
)
|
||||
|
||||
results = user_filter.filter_room_state(events)
|
||||
results = self.get_success(user_filter.filter_room_state(events))
|
||||
self.assertEquals([], results)
|
||||
|
||||
def test_filter_rooms(self):
|
||||
|
|
@ -441,10 +442,52 @@ class FilteringTestCase(unittest.HomeserverTestCase):
|
|||
"!not_included:example.com", # Disallowed because not in rooms.
|
||||
]
|
||||
|
||||
filtered_room_ids = list(Filter(definition).filter_rooms(room_ids))
|
||||
filtered_room_ids = list(Filter(self.hs, definition).filter_rooms(room_ids))
|
||||
|
||||
self.assertEquals(filtered_room_ids, ["!allowed:example.com"])
|
||||
|
||||
@unittest.override_config({"experimental_features": {"msc3440_enabled": True}})
|
||||
def test_filter_relations(self):
|
||||
events = [
|
||||
# An event without a relation.
|
||||
MockEvent(
|
||||
event_id="$no_relation",
|
||||
sender="@foo:bar",
|
||||
type="org.matrix.custom.event",
|
||||
room_id="!foo:bar",
|
||||
),
|
||||
# An event with a relation.
|
||||
MockEvent(
|
||||
event_id="$with_relation",
|
||||
sender="@foo:bar",
|
||||
type="org.matrix.custom.event",
|
||||
room_id="!foo:bar",
|
||||
),
|
||||
# Non-EventBase objects get passed through.
|
||||
{},
|
||||
]
|
||||
|
||||
# For the following tests we patch the datastore method (intead of injecting
|
||||
# events). This is a bit cheeky, but tests the logic of _check_event_relations.
|
||||
|
||||
# Filter for a particular sender.
|
||||
definition = {
|
||||
"io.element.relation_senders": ["@foo:bar"],
|
||||
}
|
||||
|
||||
async def events_have_relations(*args, **kwargs):
|
||||
return ["$with_relation"]
|
||||
|
||||
with patch.object(
|
||||
self.datastore, "events_have_relations", new=events_have_relations
|
||||
):
|
||||
filtered_events = list(
|
||||
self.get_success(
|
||||
Filter(self.hs, definition)._check_event_relations(events)
|
||||
)
|
||||
)
|
||||
self.assertEquals(filtered_events, events[1:])
|
||||
|
||||
def test_add_filter(self):
|
||||
user_filter_json = {"room": {"state": {"types": ["m.*"]}}}
|
||||
|
||||
|
|
|
|||
|
|
@ -13,10 +13,11 @@
|
|||
# limitations under the License.
|
||||
|
||||
from typing import Optional
|
||||
from unittest.mock import Mock
|
||||
|
||||
from synapse.api.constants import EventTypes, JoinRules
|
||||
from synapse.api.errors import Codes, ResourceLimitError
|
||||
from synapse.api.filtering import DEFAULT_FILTER_COLLECTION
|
||||
from synapse.api.filtering import Filtering
|
||||
from synapse.api.room_versions import RoomVersions
|
||||
from synapse.handlers.sync import SyncConfig
|
||||
from synapse.rest import admin
|
||||
|
|
@ -197,7 +198,7 @@ def generate_sync_config(
|
|||
_request_key += 1
|
||||
return SyncConfig(
|
||||
user=UserID.from_string(user_id),
|
||||
filter_collection=DEFAULT_FILTER_COLLECTION,
|
||||
filter_collection=Filtering(Mock()).DEFAULT_FILTER_COLLECTION,
|
||||
is_guest=False,
|
||||
request_key=("request_key", _request_key),
|
||||
device_id=device_id,
|
||||
|
|
|
|||
|
|
@ -25,7 +25,12 @@ from urllib import parse as urlparse
|
|||
from twisted.internet import defer
|
||||
|
||||
import synapse.rest.admin
|
||||
from synapse.api.constants import EventContentFields, EventTypes, Membership
|
||||
from synapse.api.constants import (
|
||||
EventContentFields,
|
||||
EventTypes,
|
||||
Membership,
|
||||
RelationTypes,
|
||||
)
|
||||
from synapse.api.errors import Codes, HttpResponseException
|
||||
from synapse.handlers.pagination import PurgeStatus
|
||||
from synapse.rest import admin
|
||||
|
|
@ -2157,6 +2162,153 @@ class LabelsTestCase(unittest.HomeserverTestCase):
|
|||
return event_id
|
||||
|
||||
|
||||
class RelationsTestCase(unittest.HomeserverTestCase):
|
||||
servlets = [
|
||||
synapse.rest.admin.register_servlets_for_client_rest_resource,
|
||||
room.register_servlets,
|
||||
login.register_servlets,
|
||||
]
|
||||
|
||||
def default_config(self):
|
||||
config = super().default_config()
|
||||
config["experimental_features"] = {"msc3440_enabled": True}
|
||||
return config
|
||||
|
||||
def prepare(self, reactor, clock, homeserver):
|
||||
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)
|
||||
|
||||
# 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"]
|
||||
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,
|
||||
)
|
||||
|
||||
# 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"]
|
||||
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,
|
||||
)
|
||||
|
||||
# An event with no relations.
|
||||
self.helper.send_event(
|
||||
room_id=self.room_id,
|
||||
type=EventTypes.Message,
|
||||
content={"msgtype": "m.text", "body": "No relations"},
|
||||
tok=self.tok,
|
||||
)
|
||||
|
||||
def _filter_messages(self, filter: JsonDict) -> List[JsonDict]:
|
||||
"""Make a request to /messages with a filter, returns the chunk of events."""
|
||||
channel = self.make_request(
|
||||
"GET",
|
||||
"/rooms/%s/messages?filter=%s&dir=b" % (self.room_id, json.dumps(filter)),
|
||||
access_token=self.tok,
|
||||
)
|
||||
self.assertEqual(channel.code, 200, channel.result)
|
||||
|
||||
return channel.json_body["chunk"]
|
||||
|
||||
def test_filter_relation_senders(self):
|
||||
# Messages which second user reacted to.
|
||||
filter = {"io.element.relation_senders": [self.second_user_id]}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0]["event_id"], self.event_id_1)
|
||||
|
||||
# Messages which third user reacted to.
|
||||
filter = {"io.element.relation_senders": [self.third_user_id]}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0]["event_id"], self.event_id_2)
|
||||
|
||||
# Messages which either user reacted to.
|
||||
filter = {
|
||||
"io.element.relation_senders": [self.second_user_id, self.third_user_id]
|
||||
}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 2, chunk)
|
||||
self.assertCountEqual(
|
||||
[c["event_id"] for c in chunk], [self.event_id_1, self.event_id_2]
|
||||
)
|
||||
|
||||
def test_filter_relation_type(self):
|
||||
# Messages which have annotations.
|
||||
filter = {"io.element.relation_types": [RelationTypes.ANNOTATION]}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0]["event_id"], self.event_id_1)
|
||||
|
||||
# Messages which have references.
|
||||
filter = {"io.element.relation_types": [RelationTypes.REFERENCE]}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0]["event_id"], self.event_id_2)
|
||||
|
||||
# Messages which have either annotations or references.
|
||||
filter = {
|
||||
"io.element.relation_types": [
|
||||
RelationTypes.ANNOTATION,
|
||||
RelationTypes.REFERENCE,
|
||||
]
|
||||
}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 2, chunk)
|
||||
self.assertCountEqual(
|
||||
[c["event_id"] for c in chunk], [self.event_id_1, self.event_id_2]
|
||||
)
|
||||
|
||||
def test_filter_relation_senders_and_type(self):
|
||||
# Messages which second user reacted to.
|
||||
filter = {
|
||||
"io.element.relation_senders": [self.second_user_id],
|
||||
"io.element.relation_types": [RelationTypes.ANNOTATION],
|
||||
}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0]["event_id"], self.event_id_1)
|
||||
|
||||
|
||||
class ContextTestCase(unittest.HomeserverTestCase):
|
||||
|
||||
servlets = [
|
||||
|
|
|
|||
207
tests/storage/test_stream.py
Normal file
207
tests/storage/test_stream.py
Normal file
|
|
@ -0,0 +1,207 @@
|
|||
# Copyright 2021 The Matrix.org Foundation C.I.C.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
from typing import List
|
||||
|
||||
from synapse.api.constants import EventTypes, RelationTypes
|
||||
from synapse.api.filtering import Filter
|
||||
from synapse.events import EventBase
|
||||
from synapse.rest import admin
|
||||
from synapse.rest.client import login, room
|
||||
from synapse.types import JsonDict
|
||||
|
||||
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):
|
||||
config = super().default_config()
|
||||
config["experimental_features"] = {"msc3440_enabled": True}
|
||||
return config
|
||||
|
||||
def prepare(self, reactor, clock, homeserver):
|
||||
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)
|
||||
|
||||
# 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"]
|
||||
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,
|
||||
)
|
||||
|
||||
# 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"]
|
||||
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,
|
||||
)
|
||||
|
||||
# An event with no relations.
|
||||
self.helper.send_event(
|
||||
room_id=self.room_id,
|
||||
type=EventTypes.Message,
|
||||
content={"msgtype": "m.text", "body": "No relations"},
|
||||
tok=self.tok,
|
||||
)
|
||||
|
||||
def _filter_messages(self, filter: JsonDict) -> List[EventBase]:
|
||||
"""Make a request to /messages with a filter, returns the chunk of events."""
|
||||
|
||||
from_token = self.get_success(
|
||||
self.hs.get_event_sources().get_current_token_for_pagination()
|
||||
)
|
||||
|
||||
events, next_key = self.get_success(
|
||||
self.hs.get_datastore().paginate_room_events(
|
||||
room_id=self.room_id,
|
||||
from_key=from_token.room_key,
|
||||
to_key=None,
|
||||
direction="b",
|
||||
limit=10,
|
||||
event_filter=Filter(self.hs, filter),
|
||||
)
|
||||
)
|
||||
|
||||
return events
|
||||
|
||||
def test_filter_relation_senders(self):
|
||||
# Messages which second user reacted to.
|
||||
filter = {"io.element.relation_senders": [self.second_user_id]}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0].event_id, self.event_id_1)
|
||||
|
||||
# Messages which third user reacted to.
|
||||
filter = {"io.element.relation_senders": [self.third_user_id]}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0].event_id, self.event_id_2)
|
||||
|
||||
# Messages which either user reacted to.
|
||||
filter = {
|
||||
"io.element.relation_senders": [self.second_user_id, self.third_user_id]
|
||||
}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 2, chunk)
|
||||
self.assertCountEqual(
|
||||
[c.event_id for c in chunk], [self.event_id_1, self.event_id_2]
|
||||
)
|
||||
|
||||
def test_filter_relation_type(self):
|
||||
# Messages which have annotations.
|
||||
filter = {"io.element.relation_types": [RelationTypes.ANNOTATION]}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0].event_id, self.event_id_1)
|
||||
|
||||
# Messages which have references.
|
||||
filter = {"io.element.relation_types": [RelationTypes.REFERENCE]}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0].event_id, self.event_id_2)
|
||||
|
||||
# Messages which have either annotations or references.
|
||||
filter = {
|
||||
"io.element.relation_types": [
|
||||
RelationTypes.ANNOTATION,
|
||||
RelationTypes.REFERENCE,
|
||||
]
|
||||
}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 2, chunk)
|
||||
self.assertCountEqual(
|
||||
[c.event_id for c in chunk], [self.event_id_1, self.event_id_2]
|
||||
)
|
||||
|
||||
def test_filter_relation_senders_and_type(self):
|
||||
# Messages which second user reacted to.
|
||||
filter = {
|
||||
"io.element.relation_senders": [self.second_user_id],
|
||||
"io.element.relation_types": [RelationTypes.ANNOTATION],
|
||||
}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0].event_id, self.event_id_1)
|
||||
|
||||
def test_duplicate_relation(self):
|
||||
"""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 = {"io.element.relation_senders": [self.second_user_id]}
|
||||
chunk = self._filter_messages(filter)
|
||||
self.assertEqual(len(chunk), 1, chunk)
|
||||
self.assertEqual(chunk[0].event_id, self.event_id_1)
|
||||
Loading…
Add table
Add a link
Reference in a new issue