matrix-org / matrix-org/matrix-spec

Define semantics for state when filtered (SPEC-337)

Open
#150 3 comments 0 reactions 0 assignees View on GitHub
A-Client-Server clarification p2
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

What should happen if a user does a `/sync`, with a filter that excludes state from the timeline, but includes it in the state section?

Before, the "state" key included the state at the _end_ of the timeline, now it is the state at the _start_ of the timeline. This is problematic due to the fact you won't see any of the state updates in the timeline section (if filtered in timeline), and so the client can't work out the current state.

(Imported from https://matrix.org/jira/browse/SPEC-337)

(Reported by @erikjohnston)

Contributor guide

Open the contributing guide

Research direction

Start with the /sync behavior described in this issue, focusing on how filters affect the timeline and state sections. Determine and document the agreed semantics for state when state updates are excluded from the timeline; the issue is complete when the behavior is explicitly specified.

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
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.