-
Notifications
You must be signed in to change notification settings - Fork 412
MSC4319: Room member events in stripped state #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
Open
zecakeh
wants to merge
4
commits into
matrix-org:main
Choose a base branch
from
zecakeh:non-stripped-room-member-in-stripped-state
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+114
−0
Open
Changes from 3 commits
Commits
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively, because clients want access to the
origin_server_tsand generally speaking we don't want different formats for data in a list, this MSC could do two things:origin_server_tsto all stripped state eventsm.room.memberevent to the list of suggested stateUh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also found a use case for accessing
unsignedof an invitem.room.memberevent, for clients to be able to know if theinviteis after aknockby looking into theprev_content.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not seeing why that would be important to them, or why that needs to come from
unsignedinstead of somewhere elseThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To auto-accept an invite following a knock for example. If it's a new device there is no other place where this information can be found.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed the stripped state event format to include
origin_server_tsandunsigned(since this one is already optional in other event formats anyway).