Add the ability to filter by state event type on admin room state endpoint #18035
+68
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anoadragon453
requested changes
Dec 23, 2024
anoadragon453
approved these changes
Jan 3, 2025
tests/rest/admin/test_room.py
Outdated
| room_id = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok) | ||
|
|
||
| channel = self.make_request( | ||
| "GET", | ||
| f"/_synapse/admin/v1/rooms/{room_id}/state?type=m.something.else", | ||
| f"/_synapse/admin/v1/rooms/{room_id}/state?type=''", |
There was a problem hiding this comment.
I think this would just be:
Suggested change
| f"/_synapse/admin/v1/rooms/{room_id}/state?type=''", | |
| f"/_synapse/admin/v1/rooms/{room_id}/state?type=", |
else you'll end up with type = "''".
There was a problem hiding this comment.
Turns out if you do ?type=, then you indeed end up with type = "".
Of course, then we end up ignoring type altogether due do the if type, which is falsy for an empty string.
So all state is returned, and test_room_state_param_empty fails.
I think this behaviour makes sense (ignore if empty string) rather than having no results returned. You can't have an empty type for an event, so this is an invalid parameter value.
If you agree, could you update the test to say that 5 results should have been returned, such that it passes?
H-Shay
force-pushed
the
shay/admin_filter_state
branch
from
25c0726 to
46d5240
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a query param
typeto/_synapse/admin/v1/rooms/{room_id}/statethat filters the state event query by state event type.