matrix-org / matrix-org/matrix-spec

Clarify if notifications are cleared by stream ordering or topological ordering

Open
#1,167 3 comments 0 reactions 0 assignees View on GitHub
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/#receiving-notifications

**Issue**:

It is not stated clearly which notifications get cleared when a read receipt is received, currently the spec reads:

> When the user updates their read receipt (either by using the API or by sending an event), notifications prior to and including that event MUST be marked as read.

It is unclear if "prior to" refers to stream ordering or topological ordering. Synapse clears this based on stream ordering.

(Note that because of the inconsistency in `/sync` and `/messages` either could give odd results to a user.)

See conversation around https://matrix.to/#/!NasysSDfxKxZBzJJoE:matrix.org/$sb6NPRyuiu4wN7egyY8SJ6YoubvQqZvJSOlMFsTzVSE?via=matrix.org&via=libera.chat&via=element.io

Contributor guide

Open the contributing guide

Research direction

Start with the receiving notifications section of the Matrix client-server API specification and compare its read-receipt wording with Synapse's stream-ordering behavior. Review the linked conversation and determine whether stream ordering or topological ordering is intended; done means the specification explicitly identifies the ordering used to clear notifications.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.