MSC3266: Room summary API #3266

deepbluev7 · 2021-07-04T19:30:53Z

Somewhat related to MSC2946 this provides an API to get a summary for a specific room either from the local server or over federation.

Useful for a few cases, where you need to show a summary for a room like matrix.to, traveler bots, showing spaces, lightweight clients, etc.

Open design questions looking for feedback: see this comment chain: #3266 (comment) resolved as of 2021/10/06

Implementations:

matrix.to: matrix-org/matrix.to#219
Synapse: matrix-org/synapse#10394 (Only CS API) and matrix-org/synapse#11507 (for the federation bits)
Element Android: Better room preview, use room Summary API if available element-hq/element-android#3986
Element Web (for member counts on space invites): For space invite previews, use room summary API to get the right member count matrix-react-sdk#6982 and Add method to fetch the MSC3266 Room Summary of a Room matrix-js-sdk#1988
Nheko (to have a prettier join room preview): Nheko-Reborn/nheko@9d8d6b4
matrix-rust-sdk: room preview: use the room summary MSC3266 endpoint matrix-rust-sdk#3339

Signed-off-by: Nicolas Werner nicolas.werner@hotmail.de

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

proposals/3266-room-summary.md

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

proposals/3266-room-summary.md

t3chguy · 2021-07-14T10:20:40Z

proposals/3266-room-summary.md

+- The `/state` API could be used, but the response is much bigger than needed,
+    can't be cached as easily and may need more requests. This also doesn't work
+    over federation (yet).


Also the /state API also doesn't return stripped state events so would not have access to said data based on the Stripped State MSC https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-rooms-roomid-state

The specific state API does return stripped state (because consistency, what's that) https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-rooms-roomid-state-eventtype-statekey

But would require MANY API hits and not be able to reach all the data (e.g num_joined_members would not be possible)

proposals/3266-room-summary.md

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

…est of the path separate Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

That way the requesting server knows, if any user would have access to that room and it can forward the room to the user. Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

proposals/3266-room-summary.md

t3chguy · 2022-10-24T09:40:02Z

An interesting future consumer of this work could be shields.io - https://github.com/badges/shields/blob/master/services/matrix/matrix.service.js currently registers a bunch of guests and uses the /state/ API so a dedicated API which doesn't require auth would be ideal.

proposals/3266-room-summary.md

richvdh · 2022-12-13T16:03:56Z

Still lots of outstanding questions from previous reviews here. @deepbluev7 are you still interested in pursuing this?

deepbluev7 · 2022-12-14T01:39:42Z

Yeah, I am still pursuing this, but I need to update it to work with the new room join rule, since there knocking and restricted joins are not distinguishable, so the allowed roomids need to be exposed, possibly prefiltered. But since my clients now need the unstable endpoint anyway in a few released versions, I am not as much in a hurry anymore.

turt2live · 2022-12-14T18:34:08Z

I'm going to take this off the SCT's priority list in that case. There is a bit of a problem if clients are relying on the unstable endpoint existing (as we're seeing happen outside of just your clients) - ideally, the MSC moves forward at a more hurried pace to avoid problems related to defacto spec.

For reference, how we'd likely avoid defacto spec being an issue here is recommend the feature for removal from Synapse, forcing clients to treat the functionality as unstable.

deepbluev7 · 2022-12-14T18:50:13Z

Well, the spec team told me to prioritize #3664, so that's what I did. Now that is stuck again. Before that, this MSC was stuck because there weren't enough implementations and half of the comments are nitpicking about wording or names, instead of actually being helpful to the content of the MSC, so it simply takes a bit of time to work on things. I changed some sentences 3 or more times. It simply takes a bit of time to please everyone with the wording, since if you react quickly, you end up just changing it back again on the next comment.

I think the 2 open points, that are actually important for the functionality of the MSC are:

error codes
No information about if you can join a restricted_knock room

The rest, in my opinion, is arguing about how specific things are worded or if a specific sentence "is important".

proposals/3266-room-summary.md

Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>

melroy89 · 2023-06-25T19:50:56Z

Also still not merged? We have a lot of users now complaining they can't see the rooms in the Matrix space. Most likely people are using Dendrite. Please consider making it out of beta this year...

deepbluev7 · 2023-06-25T19:52:29Z

@melroy89 Previewing rooms in a space is already part of the spec. This is for rooms outside the space hierarchy.

melroy89 · 2023-06-25T20:04:56Z

@melroy89 Previewing rooms in a space is already part of the spec. This is for rooms outside the space hierarchy.

Ah I see, since that still needs to be enabled manually in Dendrite?
https://github.com/matrix-org/dendrite/blob/main/docs/FAQ.md#does-dendrite-support-space-summaries

deepbluev7 · 2023-06-25T20:06:14Z

That's because the devs didn't get around to stabilizing it and has little to do with the spec.

aine-etke · 2023-11-09T16:57:40Z

@deepbluev7 could you update the implementations list with MRS, please?

@clokep

Synapse 1.107.0 (2024-05-14) ============================ No significant changes since 1.107.0rc1. - Add preliminary support for [MSC3823: Account Suspension](matrix-org/matrix-spec-proposals#3823). ([\#17051](element-hq/synapse#17051)) - Declare support for [Matrix v1.10](https://matrix.org/blog/2024/03/22/matrix-v1.10-release/). Contributed by @clokep. ([\#17082](element-hq/synapse#17082)) - Add support for [MSC4115: membership metadata on events](matrix-org/matrix-spec-proposals#4115). ([\#17104](element-hq/synapse#17104), [\#17137](element-hq/synapse#17137)) - Fixed search feature of Element Android on homesevers using SQLite by returning search terms as search highlights. ([\#17000](element-hq/synapse#17000)) - Fixes a bug introduced in v1.52.0 where the `destination` query parameter for the [Destination Rooms Admin API](https://element-hq.github.io/synapse/v1.105/usage/administration/admin_api/federation.html#destination-rooms) failed to actually filter returned rooms. ([\#17077](element-hq/synapse#17077)) - For MSC3266 room summaries, support queries at the recommended endpoint of `/_matrix/client/unstable/im.nheko.summary/summary/{roomIdOrAlias}`. The existing endpoint of `/_matrix/client/unstable/im.nheko.summary/rooms/{roomIdOrAlias}/summary` is deprecated. ([\#17078](element-hq/synapse#17078)) - Apply user email & picture during OIDC registration if present & selected. ([\#17120](element-hq/synapse#17120)) - Improve error message for cross signing reset with [MSC3861](matrix-org/matrix-spec-proposals#3861) enabled. ([\#17121](element-hq/synapse#17121)) - Fix a bug which meant that to-device messages received over federation could be dropped when the server was under load or networking problems caused problems between Synapse processes or the database. ([\#17127](element-hq/synapse#17127)) - Fix bug where `StreamChangeCache` would not respect configured cache factors. ([\#17152](element-hq/synapse#17152)) - Correct licensing metadata on Docker image. ([\#17141](element-hq/synapse#17141)) - Update the `event_cache_size` and `global_factor` configuration options' documentation. ([\#17071](element-hq/synapse#17071)) - Remove broken sphinx docs. ([\#17073](element-hq/synapse#17073), [\#17148](element-hq/synapse#17148)) - Add RuntimeDirectory to example matrix-synapse.service systemd unit. ([\#17084](element-hq/synapse#17084)) - Fix various small typos throughout the docs. ([\#17114](element-hq/synapse#17114)) - Update enable_notifs configuration documentation. ([\#17116](element-hq/synapse#17116)) - Update the Upgrade Notes with the latest minimum supported Rust version of 1.66.0. Contributed by @jahway603. ([\#17140](element-hq/synapse#17140)) - Enable [MSC3266](matrix-org/matrix-spec-proposals#3266) by default in the Synapse Complement image. ([\#17105](element-hq/synapse#17105)) - Add optimisation to `StreamChangeCache.get_entities_changed(..)`. ([\#17130](element-hq/synapse#17130)) * Bump furo from 2024.1.29 to 2024.4.27. ([\#17133](element-hq/synapse#17133)) * Bump idna from 3.6 to 3.7. ([\#17136](element-hq/synapse#17136)) * Bump jsonschema from 4.21.1 to 4.22.0. ([\#17157](element-hq/synapse#17157)) * Bump lxml from 5.1.0 to 5.2.1. ([\#17158](element-hq/synapse#17158)) * Bump phonenumbers from 8.13.29 to 8.13.35. ([\#17106](element-hq/synapse#17106)) - Bump pillow from 10.2.0 to 10.3.0. ([\#17146](element-hq/synapse#17146)) * Bump pydantic from 2.6.4 to 2.7.0. ([\#17107](element-hq/synapse#17107)) * Bump pydantic from 2.7.0 to 2.7.1. ([\#17160](element-hq/synapse#17160)) * Bump pyicu from 2.12 to 2.13. ([\#17109](element-hq/synapse#17109)) * Bump serde from 1.0.197 to 1.0.198. ([\#17111](element-hq/synapse#17111)) * Bump serde from 1.0.198 to 1.0.199. ([\#17132](element-hq/synapse#17132)) * Bump serde from 1.0.199 to 1.0.200. ([\#17161](element-hq/synapse#17161)) * Bump serde_json from 1.0.115 to 1.0.116. ([\#17112](element-hq/synapse#17112)) - Update `tornado` Python dependency from 6.2 to 6.4. ([\#17131](element-hq/synapse#17131)) * Bump twisted from 23.10.0 to 24.3.0. ([\#17135](element-hq/synapse#17135)) * Bump types-bleach from 6.1.0.1 to 6.1.0.20240331. ([\#17110](element-hq/synapse#17110)) * Bump types-pillow from 10.2.0.20240415 to 10.2.0.20240423. ([\#17159](element-hq/synapse#17159)) * Bump types-setuptools from 69.0.0.20240125 to 69.5.0.20240423. ([\#17134](element-hq/synapse#17134))

deepbluev7 · 2024-05-30T21:35:10Z

proposals/3266-room-summary.md

+| num_joined_members | Required. Member count of the room                                                                                                                    | Copied from `publicRooms`.                                                                                                            |
+| topic              | Optional. Topic of the room                                                                                                                           | Copied from `publicRooms`.                                                                                                            |
+| world_readable     | Required. If the room history can be read without joining.                                                                                            | Copied from `publicRooms`.                                                                                                            |
+| join_rule          | Optional. Join rules of the room                                                                                                                      | Copied from `publicRooms`.                                                                                                            |


With the introduction of knock_restricted, knowing the join rule isn't sufficient to know which method the room can be joined via. As such the response should also include the allowedRoomIds, that the user is joined to or so.

deepbluev7 · 2024-05-30T21:36:21Z

proposals/3266-room-summary.md

+The API returns a summary of the given room, provided the user is either already
+a member, or has the necessary permissions to join. (For example, the user may
+be a member of a room mentioned in an `allow` condition in the join rules of a


It's not clear if this includes invites. It probably should, but that should be explicitly mentioned in the MSC.

AndrewFerr · 2024-10-01T12:53:29Z

proposals/3266-room-summary.md

+This API could also be used for denial of service type attacks. Appropriate
+ratelimiting and caching should be able to mitigate that.
+
+## Unstable prefix


This should also define a new unstable_features flag for GET /_matrix/client/versions.

For example, adapting from MSC3026:

servers implementing this MSC must expose a flag in GET /_matrix/client/versions responses, under unstable_features, named im.nheko.msc3266, which is set to true.

Other MSCs that define an unstable_features are MSC2432, MSC2666, MSC2285, MSC3827, and MSC3440.

Room summary proposal

642f4e1

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

deepbluev7 changed the title ~~Room summary proposal~~ MSC3266: Room summary proposal Jul 4, 2021

deepbluev7 force-pushed the room-summaries branch from 855306e to 642f4e1 Compare July 4, 2021 19:32

deepbluev7 changed the title ~~MSC3266: Room summary proposal~~ MSC3266: Room summary Jul 4, 2021

Sorunome reviewed Jul 5, 2021

View reviewed changes

proposals/3266-room-summary.md Show resolved Hide resolved

deepbluev7 commented Jul 5, 2021

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

tulir reviewed Jul 5, 2021

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

tulir reviewed Jul 5, 2021

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

Remove alias resolution step from the federation API

188b6e5

haslersn reviewed Jul 9, 2021

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

KitsuneRal reviewed Jul 11, 2021

View reviewed changes

proposals/3266-room-summary.md Show resolved Hide resolved

deepbluev7 changed the title ~~MSC3266: Room summary~~ MSC3266: Room summary API Jul 11, 2021

Reference matrix-org#688 in the alternatives section

dc5b372

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

t3chguy reviewed Jul 14, 2021

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

t3chguy reviewed Jul 14, 2021

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

t3chguy reviewed Jul 14, 2021

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

t3chguy reviewed Jul 14, 2021

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

t3chguy mentioned this pull request Jul 14, 2021

Initial MSC3266 implementation with tweaks for displaying Spaces matrix-org/matrix.to#219

Merged

t3chguy reviewed Jul 14, 2021

View reviewed changes

proposals/3266-room-summary.md Show resolved Hide resolved

deepbluev7 added 3 commits July 14, 2021 20:09

Remove is_direct from response

975ece5

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

Fix unstable prefixes for implementations which keep the prefix and r…

d148acf

…est of the path separate Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

Add allowed_room_ids field

6776863

That way the requesting server knows, if any user would have access to that room and it can forward the room to the user. Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

t3chguy reviewed Jul 14, 2021

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

t3chguy reviewed Jul 14, 2021

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

anoadragon453 mentioned this pull request Oct 12, 2022

Remove invite_room_state, knock_room_state from the CS API. Fix examples in SS API matrix-org/matrix-spec#1273

Closed

richvdh reviewed Dec 13, 2022

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

Update proposals/3266-room-summary.md

2ad832c

KitsuneRal reviewed Dec 16, 2022

View reviewed changes

proposals/3266-room-summary.md Outdated Show resolved Hide resolved

Update proposals/3266-room-summary.md

81fd904

Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>

SimonBrandner mentioned this pull request Mar 27, 2023

MSC3985: Break-out rooms #3985

Open

This was referenced Jun 28, 2023

Skip room join until we run into a 403 Forbidden and peek into world_readable rooms matrix-org/matrix-viewer#272

Draft

MSC2291: Configuration to Control Crawling #2291

Open

AndrewFerr mentioned this pull request Apr 11, 2024

Improve compliance with MSC3266 matrix-org/matrix-js-sdk#4155

Merged

4 tasks

t3chguy mentioned this pull request May 7, 2024

Matrix badges not working badges/shields#10138

Open

deepbluev7 commented May 30, 2024

View reviewed changes

anoadragon453 mentioned this pull request Sep 30, 2024

MSC3266 in unstable features element-hq/synapse#17721

Open

3 tasks

AndrewFerr reviewed Oct 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MSC3266: Room summary API #3266

MSC3266: Room summary API #3266

deepbluev7 commented Jul 4, 2021 •

edited by ara4n

Loading

t3chguy Jul 14, 2021 •

edited

Loading

t3chguy commented Oct 24, 2022

richvdh commented Dec 13, 2022

deepbluev7 commented Dec 14, 2022

turt2live commented Dec 14, 2022

deepbluev7 commented Dec 14, 2022

melroy89 commented Jun 25, 2023

deepbluev7 commented Jun 25, 2023

melroy89 commented Jun 25, 2023

deepbluev7 commented Jun 25, 2023

aine-etke commented Nov 9, 2023

deepbluev7 May 30, 2024

deepbluev7 May 30, 2024

AndrewFerr Oct 1, 2024

MSC3266: Room summary API #3266

Are you sure you want to change the base?

MSC3266: Room summary API #3266

Conversation

deepbluev7 commented Jul 4, 2021 • edited by ara4n Loading

t3chguy Jul 14, 2021 • edited Loading

Choose a reason for hiding this comment

t3chguy commented Oct 24, 2022

richvdh commented Dec 13, 2022

deepbluev7 commented Dec 14, 2022

turt2live commented Dec 14, 2022

deepbluev7 commented Dec 14, 2022

melroy89 commented Jun 25, 2023

deepbluev7 commented Jun 25, 2023

melroy89 commented Jun 25, 2023

deepbluev7 commented Jun 25, 2023

aine-etke commented Nov 9, 2023

deepbluev7 May 30, 2024

Choose a reason for hiding this comment

deepbluev7 May 30, 2024

Choose a reason for hiding this comment

AndrewFerr Oct 1, 2024

Choose a reason for hiding this comment

deepbluev7 commented Jul 4, 2021 •

edited by ara4n

Loading

t3chguy Jul 14, 2021 •

edited

Loading