Skip to content

[CHA-0] Fix QueryReminders to use filter parameter and improve test assertions #214

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.

Sign up for GitHub

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

Merged
nijeesh-stream merged 2 commits into from
Nov 20, 2025
Merged

[CHA-0] Fix QueryReminders to use filter parameter and improve test assertions #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e72029b
feat: Fix QueryReminders to use filter parameter instead of filter_co…
nijeesh-stream Nov 19, 2025
087b355
feat: Improve QueryReminders tests to verify filter results actually …
nijeesh-stream Nov 19, 2025
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
2 changes: 1 addition & 1 deletion stream_chat/async_chat/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -965,7 +965,7 @@ async def query_reminders(
:return: API response with reminders
"""
params = options.copy()
params["filter_conditions"] = filter_conditions or {}
params["filter"] = filter_conditions or {}
Copy link

@10printhello 10printhello Nov 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note: if you've renamed the param to filter here, should the func arg (filter_conditions) change also as the other args match the params (user_id & user_id etc)?

Appreciate this might be a breaking change which is why you haven't. Thought worth mentioning for consistency.

Copy link
Contributor Author

@nijeesh-stream nijeesh-stream Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same, i didn't want to change it as its a breaking change

params["sort"] = sort or [{"field": "remind_at", "direction": 1}]
params["user_id"] = user_id
return await self.post("reminders/query", data=params)
Expand Down
2 changes: 1 addition & 1 deletion stream_chat/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -919,7 +919,7 @@ def query_reminders(
:return: API response with reminders
"""
params = options.copy()
params["filter_conditions"] = filter_conditions or {}
params["filter"] = filter_conditions or {}
params["sort"] = sort or [{"field": "remind_at", "direction": 1}]
params["user_id"] = user_id
return self.post("reminders/query", data=params)
Expand Down
21 changes: 20 additions & 1 deletion stream_chat/tests/async_chat/test_reminders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,11 +158,30 @@ async def test_query_reminders(self, client: StreamChatAsync, channel, random_us
random_user["id"], filter_conditions
)
assert response is not None
assert "reminders" in response
# Verify all returned reminders match the filter
for reminder in response["reminders"]:
assert reminder["message_id"] in [message_ids[0]]

# Test case 3: Query reminders by channel CID
# Test case 3: Query reminders by single message ID
filter_conditions = {"message_id": message_ids[0]}
response = await client.query_reminders(random_user["id"], filter_conditions)
assert response is not None
assert "reminders" in response
assert len(response["reminders"]) >= 1
# Verify all returned reminders have the exact message_id
for reminder in response["reminders"]:
assert reminder["message_id"] == message_ids[0]

# Test case 4: Query reminders by channel CID
filter_conditions = {"channel_cid": channel_cid}
response = await client.query_reminders(random_user["id"], filter_conditions)
assert response is not None
assert "reminders" in response
assert len(response["reminders"]) >= 3
# Verify all returned reminders belong to the channel
for reminder in response["reminders"]:
assert reminder["channel_cid"] == channel_cid

# Clean up - try to delete the reminders
for message_id in message_ids:
Expand Down
21 changes: 20 additions & 1 deletion stream_chat/tests/test_reminders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,11 +146,30 @@ def test_query_reminders(self, client: StreamChat, channel, random_user):
filter_conditions = {"message_id": {"$in": [message_ids[0]]}}
response = client.query_reminders(random_user["id"], filter_conditions)
assert response is not None
assert "reminders" in response
# Verify all returned reminders match the filter
for reminder in response["reminders"]:
assert reminder["message_id"] in [message_ids[0]]

# Test case 3: Query reminders by channel CID
# Test case 3: Query reminders by single message ID
filter_conditions = {"message_id": message_ids[0]}
response = client.query_reminders(random_user["id"], filter_conditions)
assert response is not None
assert "reminders" in response
assert len(response["reminders"]) >= 1
# Verify all returned reminders have the exact message_id
for reminder in response["reminders"]:
assert reminder["message_id"] == message_ids[0]

# Test case 4: Query reminders by channel CID
filter_conditions = {"channel_cid": channel_cid}
response = client.query_reminders(random_user["id"], filter_conditions)
assert response is not None
assert "reminders" in response
assert len(response["reminders"]) >= 3
# Verify all returned reminders belong to the channel
for reminder in response["reminders"]:
assert reminder["channel_cid"] == channel_cid

# Clean up - try to delete the reminders
for message_id in message_ids:
Expand Down