diff options
author | Mo Balaa <thebalaa@users.noreply.github.com> | 2024-01-22 04:46:30 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-22 10:46:30 +0000 |
commit | b99f6db0396629187b7c7e0e869e8ecc082154a5 (patch) | |
tree | 5dbd55692d832ef39c85d7267f79d259b8218193 | |
parent | Bump actions/cache from 3 to 4 (#16832) (diff) | |
download | synapse-b99f6db0396629187b7c7e0e869e8ecc082154a5.tar.xz |
Handle wildcard type filters properly (#14984)
-rw-r--r-- | changelog.d/14984.bugfix | 1 | ||||
-rw-r--r-- | synapse/storage/databases/main/stream.py | 23 | ||||
-rw-r--r-- | tests/rest/client/test_rooms.py | 27 | ||||
-rw-r--r-- | tests/rest/client/utils.py | 3 |
4 files changed, 47 insertions, 7 deletions
diff --git a/changelog.d/14984.bugfix b/changelog.d/14984.bugfix new file mode 100644 index 0000000000..b694f6d167 --- /dev/null +++ b/changelog.d/14984.bugfix @@ -0,0 +1 @@ +Handle wildcard type filters properly for room messages endpoint. Contributed by Mo Balaa. diff --git a/synapse/storage/databases/main/stream.py b/synapse/storage/databases/main/stream.py index aeeb74b46d..9a2940d7a1 100644 --- a/synapse/storage/databases/main/stream.py +++ b/synapse/storage/databases/main/stream.py @@ -398,14 +398,25 @@ def filter_to_clause(event_filter: Optional[Filter]) -> Tuple[str, List[str]]: clauses = [] args = [] + # Handle event types with potential wildcard characters if event_filter.types: - clauses.append( - "(%s)" % " OR ".join("event.type = ?" for _ in event_filter.types) - ) - args.extend(event_filter.types) - + type_clauses = [] + for typ in event_filter.types: + if "*" in typ: + type_clauses.append("event.type LIKE ?") + typ = typ.replace("*", "%") # Replace * with % for SQL LIKE pattern + else: + type_clauses.append("event.type = ?") + args.append(typ) + clauses.append("(%s)" % " OR ".join(type_clauses)) + + # Handle event types to exclude with potential wildcard characters for typ in event_filter.not_types: - clauses.append("event.type != ?") + if "*" in typ: + clauses.append("event.type NOT LIKE ?") + typ = typ.replace("*", "%") + else: + clauses.append("event.type != ?") args.append(typ) if event_filter.senders: diff --git a/tests/rest/client/test_rooms.py b/tests/rest/client/test_rooms.py index 0e71cdcd88..89b161dd0a 100644 --- a/tests/rest/client/test_rooms.py +++ b/tests/rest/client/test_rooms.py @@ -2155,6 +2155,33 @@ class RoomMessageListTestCase(RoomBase): self.assertEqual(len(chunk), 0, [event["content"] for event in chunk]) +class RoomMessageFilterTestCase(RoomBase): + """Tests /rooms/$room_id/messages REST events.""" + + user_id = "@sid1:red" + + def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None: + self.room_id = self.helper.create_room_as(self.user_id) + + def test_room_message_filter_wildcard(self) -> None: + # Send a first message in the room, which will be removed by the purge. + self.helper.send(self.room_id, "message 1", type="f.message.1") + self.helper.send(self.room_id, "message 1", type="f.message.2") + self.helper.send(self.room_id, "not returned in filter") + channel = self.make_request( + "GET", + "/rooms/%s/messages?access_token=x&dir=b&filter=%s" + % ( + self.room_id, + json.dumps({"types": ["f.message.*"]}), + ), + ) + self.assertEqual(channel.code, HTTPStatus.OK, channel.json_body) + + chunk = channel.json_body["chunk"] + self.assertEqual(len(chunk), 2, [event["content"] for event in chunk]) + + class RoomSearchTestCase(unittest.HomeserverTestCase): servlets = [ synapse.rest.admin.register_servlets_for_client_rest_resource, diff --git a/tests/rest/client/utils.py b/tests/rest/client/utils.py index 7bcbed246b..3bf3663e3a 100644 --- a/tests/rest/client/utils.py +++ b/tests/rest/client/utils.py @@ -364,6 +364,7 @@ class RestHelper: tok: Optional[str] = None, expect_code: int = HTTPStatus.OK, custom_headers: Optional[Iterable[Tuple[AnyStr, AnyStr]]] = None, + type: str = "m.room.message", ) -> JsonDict: if body is None: body = "body_text_here" @@ -372,7 +373,7 @@ class RestHelper: return self.send_event( room_id, - "m.room.message", + type, content, txn_id, tok, |