Add an Admin API to fetch an event by ID #18963
Conversation
docs/admin_api/fetch_event.md
Outdated
| Response: | ||
| ```json | ||
| { | ||
| "event_id": "$hbFTSxFNaPau73B8fqGTFrkSqxOpaFjlnzOFEPw9tMA", |
There was a problem hiding this comment.
is this to match some other response format, or is it just redundant? (You already needed to know the event ID to query this API, also I think it may even feature within the event itself)
There was a problem hiding this comment.
Not to matching anything, the event id wasn't being returned as part of the event so I changed the serialization of the event to include it and removed from the top of the response.
synapse/rest/admin/events.py
Outdated
| await assert_requester_is_admin(self._auth, request) | ||
|
|
||
| event = await self._store.get_event( | ||
| event_id, EventRedactBehaviour.as_is, allow_none=True, allow_rejected=True |
There was a problem hiding this comment.
do we need to clearly document that we will return rejected events here? (I can see people benefitting from this being said, as well as maybe how you know from the response)
There was a problem hiding this comment.
probably helpful, and just to double-check - if an event is rejected there should be a rejection_reason in the unsigned field of the event, correct?
There was a problem hiding this comment.
Hmm, I'm not seeing anywhere that would be added. Have you seen this in practice?
There was a problem hiding this comment.
I haven't, and looking I actually don't see it added - my only thought was that if it ended up in internal_metadata it could be copied over at some point. Given that doesn't seem to be the case, I am unsure how you would tell if the event was rejected. My hope was to give admins as much information as possible, hence including the rejected events, but if admins have no way of telling if the event was rejected I am unsure of the utility of it.
There was a problem hiding this comment.
@reivilibre I've changed the search to not return rejected events - I wasn't sure how to indicate that the events had been rejected, and the utility of returning them is quite low to begin with.
There was a problem hiding this comment.
If you wanted it, I think the answer would probably be to include "rejected": false at the top-level (as a sibling of event) — I can't spot it being transferred over in any other way (I think only specific bits and pieces of internal_metadata are copied over, didn't see the rejection status though).
I don't mind either way, I'm not really sure whether people would find it useful or not.
|
pretty sure test failures are flakes, but I can't kick the ci to be sure |
synapse/rest/admin/events.py
Outdated
| await assert_requester_is_admin(self._auth, request) | ||
|
|
||
| event = await self._store.get_event( | ||
| event_id, EventRedactBehaviour.as_is, allow_none=True, allow_rejected=True |
There was a problem hiding this comment.
Hmm, I'm not seeing anywhere that would be added. Have you seen this in practice?
Adds an endpoint to allow server admins to fetch an event regardless of their membership in the originating room.