matrix-org / matrix-org/matrix-widget-api

Exclude state events from read_events actions without a state_key

Open
#132 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
95
Forks
24
Avg merge
16h 16m
Merged PRs (30d)
1

Description

TBD: This might only need Element Web changes, I'm not sure yet.

https://github.com/matrix-org/matrix-spec-proposals/pull/4288 has clarified the meaning of `read_events` actions without a `state_key`: the client isn't supposed to respond with any state events. I think the current shape of the driver API assumes that the lack of a `state_key` should mean that any matching events - state events or otherwise - should be included in the response. We should eventually rectify this.

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 reading the linked Matrix spec proposal and tracing the driver API behavior for read_events actions without a state_key. Determine whether the required change belongs in this TypeScript API or Element Web; done means state events are excluded from the response when no state_key is supplied.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.