matrix-org / matrix-org/matrix-spec
Lazy loading read receipts
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Currently we send an m.room.receipt event for each and every member of a room in the initial sync - e.g. old Matrix HQ had 16,000 read receipt objects bulking out the initial sync.
Just as we have the option of lazy loading members over at https://github.com/matrix-org/matrix-doc/issues/1227, we should have a separate option for lazy loading read receipts to save sync bandwidth.
The semantics would be to only send RRs for the events which are returned in the current piece of timeline.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the current Matrix initial-sync and read-receipt semantics, then compare the lazy-loading member option described in matrix-doc issue 1227. Define the separate option and specify that receipts are returned only for events in the current timeline piece; done means the protocol behavior and compatibility details are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100