matrix-org / matrix-org/matrix-spec

Clarify if initial sync should populate `leave` with past room membership

Open
#939 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Link to problem area: https://spec.matrix.org/latest/client-server-api/#syncing

Issue
This was brought up in #synapse-dev while i was writing https://github.com/matrix-org/dendrite/issues/2066, it seems there is some expectancy that we could still fetch "leave" room memberships even after the fact.

https://github.com/matrix-org/matrix-doc/issues/534 is related.

However, i think that if this grows, it could bloat initial sync size, so there should probably be a way to turn it off.

Above dendrite issue seems to somewhat-softly assume that leave should contain all left-rooms since the beginning of time, thus another reason for this issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Matrix client-server API's syncing section and compare the questions raised in matrix-doc issue #534 and Dendrite issue #2066. Clarify whether initial sync should include historical leave memberships and whether an opt-out is needed; done means the specification states the expected behavior and any scope or limits.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.