matrix-org / matrix-org/matrix-spec

Reduce confusion between topological and stream position tokens (SPEC-268)

Open
#125 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-Client-Server clarification spec-omission
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

The client-server API has two types of position identifiers, representing two views of the ordering of events:

  • topological (tNN-NNN_NNN_NNN_NNN) (aka pagination token)
  • stream (sNNN_NNN_NNN_NNN)

A topological position only makes sense within the context of a particular room, and refers to a particular point on the event DAG. The events between two topo tokens are subject to change, as the DAG changes over time.

A stream position is a global identifier across all rooms, and refers to a point on the timeline of when the server received the event (which may be wildly different to where it fits on the graph, or where it happened in a different server's timeline).

/sync returns events in the stream timeline order, and takes a stream position token as a 'since' parameter.

/room/<x>/messages works in the topological timeline order, and takes a topological token as a 'from' parameter.

It's easy to misunderstand what one can do with these tokens. In particular, /sync currently returns:

  • next_batch: a streaming token from which streaming can be resumed next time
  • rooms.x.timeline.prev_batch: a topological token. The idea is that you can back-populate from here.

We should do our best to reduce the confusion by making sure that we have a consistent set of names which make it clear what sort of token is expected.

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

(Reported by @richvdh)

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 by reviewing the Client-Server API descriptions of /sync and /room/<x>/messages, focusing on the next_batch, prev_batch, since, and from position tokens. Define consistent names that distinguish stream and topological positions, then confirm the terminology is used consistently throughout the affected specification sections.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.