This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Repository navigation
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Synapse returns unspecced property original_event from /relations #12930
Description
Synapse's implementation of /relations returns an unspecced property original_event:
https://github.com/matrix-org/synapse/blob/v1.60.0/synapse/handlers/relations.py#L166
This is not defined in the MSC so should be removed.
Activity
clokep commentedon Jun 1, 2022
Or should it be defined in MSC2676? See #5626 for why this was originally included. Maybe this is no longer necessary with #12476 though?
revidee commentedon Jun 1, 2022
Another use-case to consider:
With it removed, there is no "easy" way to retrieve the most up-to-date version of an event in all cases. the
/event/endpoint currently does not aggregate edits and returns the original event (by design in MSC2676). The server should bundle all relations viam.relationsin theunsignedcontent, however, for e2ee rooms, this is not the case form.replaceevents, sinceget_bundled_aggregationscallsget_applicable_editswhich only returns applicable edits of typem.room.message, but notm.room.encrypted(SQL 1, SQL 2) (This may be a bug in of itself, I'm not sure). Therefore, the client then needs to also make an additional request to/relations/(with an filter onm.replace) in order to fetch the most recent applicable edit (decided client-sided). Maybe more, if the client needs to paginate through the relations.When does this happen? After an initial sync without the whole history loaded and in the case client needs to render some out-of-timeline event due to a reference to an (potentially very) old event (
m.reference,m.in_reply_to), the client needs to load this single event from the server, and preferably with all edits applied to it.So in short, in order to then query the most recent state of an event, one would have to call the
/event/endpoint to get the original message, then, call/relations/to get all edits and apply the most recent applicable.With the
original_eventstill included in the/relations/result, the client would save 1 RTT and only needs to call/relations/.richvdh commentedon Jun 1, 2022
Well, MSC2676 is concluded and in the process of being specced, so it would need to be a new MSC if there is a viable usecase for it.
richvdh commentedon Jun 1, 2022
I haven't fully grokked your comment, but this part is incorrect: you can use
/contextfor this.revidee commentedon Jun 1, 2022
Unfortunately, not. In the case of e2ee rooms, the last applicable edit will not return anything, since the query (SQL 1, 2 in my comment) only checks for m.room.message. Hence, the server won't return the most-up-to-date-version.
richvdh commentedon Jun 1, 2022
well, that sounds like a separate bug:
#12793Edit: #12503 actually I thinkclokep commentedon Jun 1, 2022
Ah, I had missed this already had FCP proposed on it.
I think you're correct though that with a combination of using
/eventor/contextand fixing #12503, this becomes unnecessary.richvdh commentedon Jun 6, 2022
Sorry, this is incorrect; I must have been confusing it with some other MSC. (MSC2675, possibly, which specs
/relations).clokep commentedon Sep 30, 2022
It looks like the matrix-js-sdk, matrix-android-sdk2 and matrix-ios-sdk all use this field in the response.
matrix-js-sdkactually uses the field, I haven't really checked the other SDKs.richvdh commentedon Oct 3, 2022
Thanks for checking into that, @clokep. Would you be able to raise issues against the relevant projects?
richvdh commentedon Oct 3, 2022
(I'd like us to set a timeline for removing this field. Is 6 months realistic?)
clokep commentedon Oct 3, 2022
/relationsendpoint (and its unspeccedoriginal_eventfield) matrix-js-sdk#2725original_eventfield from the/relationsresponse matrix-ios-sdk#1591original_eventfield from the/relationsresponse element-hq/element-android#7275original_eventfield from the/relationsresponse turt2live/matrix-bot-sdk#263The following SDKs do not seem to use this property:
I also shouted in the client devs room.
clokep commentedon Oct 3, 2022
#14025 removes this field when using the
/v1version of the endpoint. It is still returned when querying via the/unstableendpoint. There are not currently any callers of the/v1endpoint on matrix.org in the logs.turt2live commentedon Oct 4, 2022
ftr, bot-sdk's usage is in an unstable part of the codebase, so if people are using it then that sucks for them :p
turt2live commentedon Oct 4, 2022
Per matrix-org/matrix-widget-api#75, the field was also (safely) used by the widget-api. At a glance, it looks like it won't explode if the field goes missing.