-
Notifications
You must be signed in to change notification settings - Fork 450
MSC4319: Room member events for invite and knock rooms in the /sync response
#4319
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
turt2live
merged 16 commits into
matrix-org:main
from
zecakeh:non-stripped-room-member-in-stripped-state
Jul 27, 2026
Merged
Changes from 3 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
bbf271f
Write proposal
zecakeh 3a07bc6
Add MSC number
zecakeh a4530d1
Fix filename
zecakeh 01c8ee4
Change stripped state format instead of mixing formats
zecakeh 1b81df4
Use full event format and move to state object
zecakeh f497f19
Fix typos
zecakeh 98a7a3e
Change MSC title
zecakeh 3bb2ab3
Add time limit to compatibility behavior
zecakeh e279119
Apply suggestion
zecakeh 3fb1fc9
Clarify that the stripped state change is for both CS and SS APIs
zecakeh ad5aa1f
Clarify purpose of the MSC
zecakeh 0c0d731
Add clarifications
zecakeh 8d67bda
Apply suggestions
zecakeh 8c44d6a
Add subsections
zecakeh 63aebd5
Update section title
zecakeh f673805
Add reference to matrix spec issue
zecakeh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # MSC4139: Non-stripped room member event in stripped state | ||
|
|
||
| In the Client-Server API, the response of the [`GET /sync`](https://spec.matrix.org/v1.15/client-server-api/#get_matrixclientv3sync) | ||
| endpoint, the `events` array in the `invite_state` for rooms under `invite` and in the `knock_state` | ||
| for rooms under `knock` are defined as containing the stripped state of the room. | ||
|
|
||
| This stripped state comes over federation, via the | ||
| [`PUT /invite`](https://spec.matrix.org/v1.15/server-server-api/#put_matrixfederationv2inviteroomideventid) | ||
| and [`PUT /send_knock`](https://spec.matrix.org/v1.15/server-server-api/#put_matrixfederationv1send_knockroomideventid) | ||
| endpoints in the Server-Server API. | ||
|
|
||
| In the definition of the [stripped state](https://spec.matrix.org/v1.15/client-server-api/#stripped-state) | ||
| it is recommended to contain the following state events: | ||
|
|
||
| - `m.room.create` | ||
| - `m.room.name` | ||
| - `m.room.avatar` | ||
| - `m.room.topic` | ||
| - `m.room.join_rules` | ||
| - `m.room.canonical_alias` | ||
| - `m.room.encryption` | ||
|
|
||
| Although these events are useful to be able to present information about the room, they don't | ||
| contain information about the event itself, like the sender of the invite, or when it occurred. | ||
|
|
||
| _Note that this specifies behavior that has been implemented for a long time in homeserver | ||
| implementations and that clients already rely on._ | ||
|
|
||
| ## Proposal | ||
|
|
||
| The `m.room.member` event that was created during the invite or knock process MUST be present in | ||
| the `events` of the `invite_state` or `knock_state`. Since servers have access to the whole event, | ||
| and for clients to be able to access the time of the event via the `origin_server_ts` field, it | ||
| MUST use the same format as can be found in the `events` of `timeline` and `state` for rooms under | ||
| `join`. This is the format currently defined as | ||
| [`ClientEventWithoutRoomID`](https://spec.matrix.org/v1.15/client-server-api/#get_matrixclientv3sync_response-200_clienteventwithoutroomid). | ||
|
|
||
| _Note that the example for the response of `GET /sync` already include the stripped `m.room.member` | ||
| event although it is not specified._ | ||
|
|
||
| Furthermore, clients need to be able to display information about the sender of an invite, like | ||
| their display name or avatar. The list of events that should be included in the stripped state is | ||
| extended with the stripped `m.room.member` event of the `sender` of the invite. | ||
|
|
||
| ## Potential issues | ||
|
|
||
| By showing more information about the sender of an invite, users might be subject to undesirable | ||
| content like abusive language or images. Mitigating this is out of scope of this MSC, and other MSCs | ||
| exist for this, like [MSC4278](https://github.com/matrix-org/matrix-spec-proposals/pull/4278). | ||
|
|
||
|
|
||
| ## Alternatives | ||
|
|
||
| No relevant alternatives. | ||
|
|
||
|
|
||
| ## Security considerations | ||
|
|
||
| No potential security issues are known to the author. | ||
|
|
||
|
|
||
| ## Unstable prefix | ||
|
|
||
| None necessary, this is adding existing event types into existing arrays. | ||
|
|
||
|
|
||
| ## Dependencies | ||
|
|
||
| None. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.