Spec lazy-loading room members #2035
Merged
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
The options also work on /messages
Note: This makes assumptions on what the TODO comment in Synapse means: https://github.com/matrix-org/synapse/blob/e26e6b3230f0b55376f0f3bf823dd789ac7064d0/synapse/handlers/pagination.py#L262 Due to lack of implementation, it is assumed that using the same filter across multiple calls to /sync OR /messages will result in the redundant members being excluded in the next request. For example, calling /sync, then /messages which returns some members, then /sync again will exclude the members due to them being in /messages.
This was referenced May 28, 2019
Closed
bwindels
reviewed
May 28, 2019
jryans
reviewed
May 28, 2019
jryans
reviewed
May 28, 2019
richvdh
reviewed
Jun 6, 2019
| Information about the room which clients may need to | ||
| correctly render it to users. | ||
| properties: | ||
| "m.heroes": |
There was a problem hiding this comment.
are these properties not required ?
There was a problem hiding this comment.
no, because if they are omitted then the client should interpret it as "no change".
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
richvdh
reviewed
Jun 7, 2019
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
ara4n
reviewed
Jun 10, 2019
ara4n
reviewed
Jun 10, 2019
ara4n
reviewed
Jun 10, 2019
ara4n
reviewed
Jun 10, 2019
ara4n
reviewed
Jun 10, 2019
ara4n
reviewed
Jun 10, 2019
…azy-loading incorporate LL review from matthew
|
Shoving this back into the queue to get a checkmark (hopefully) from someone on the team. There's a few people who have reviewed this, so picking on someone isn't super obvious. |
|
i'm happy with it from my pov fwiw, but i guess my rewrite needs some review if someone can face it. |
|
arguably this is fine to merge as I reviewed your edits, but I think a third opinion would be good given the amount of review on here. |
ara4n
approved these changes
Jun 11, 2019
|
let's just merge it. |
3 tasks
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.
Reviewers: Although this has team review requested, I would appreciate particular review from @ara4n as the proposal author and @KitsuneRal as having gone through the gauntlet. Feedback in addition is more than appreciated.
Disclaimer: Although the implementation is lacking in areas (see below), it is believed by the spec core team that lazy-loading has enough benefits to be added to the spec, as per the MSC guidelines.
Implementation references:
/membersadditions/contextbecoming aware of LL/sync&/messagesbehaviourNotable lacks of implementation:
/members- https://github.com/matrix-org/synapse/blob/e26e6b3230f0b55376f0f3bf823dd789ac7064d0/synapse/rest/client/v1/room.py#L394m.heroes- Synapse doesn't send left members as heroes synapse#4926/messages- https://github.com/matrix-org/synapse/blob/b54b03f9e1abc1964fe5f00115a165a2b8e10df5/synapse/handlers/pagination.py#L262Spec references:
atandnot_membershipparameters #1945Alterations from the proposals:
summaryshould be required. The implementation only does so when lazy-loading is active, however this seems like a bug. Written as required so that clients can usem.heroesto name the room.(note: due to these proposals being older Google Doc MSCs, they have had the alterations described here represented in the applicable threaded comments instead of the body of the proposal. This is to hopefully more clearly represent the changes.)