Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle wildcard type filters properly #14984

Merged
merged 9 commits into from
Jan 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/14984.bugfix
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Handle wildcard type filters properly for room messages endpoint. Contributed by Mo Balaa.
23 changes: 17 additions & 6 deletions synapse/storage/databases/main/stream.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
27 changes: 27 additions & 0 deletions tests/rest/client/test_rooms.py
Original file line number Diff line number Diff line change
Expand Up @@ -2155,6 +2155,33 @@ def test_room_messages_purge(self) -> None:
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,
Expand Down
3 changes: 2 additions & 1 deletion tests/rest/client/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,7 @@ def send(
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"
Expand All @@ -372,7 +373,7 @@ def send(

return self.send_event(
room_id,
"m.room.message",
type,
content,
txn_id,
tok,
Expand Down
Loading