Skip to content
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

MSC3429: Individual room preview API #3429

Closed
wants to merge 2 commits into from

Conversation

turt2live
Copy link
Member

@turt2live turt2live commented Oct 5, 2021

@turt2live turt2live changed the title MSC: Individual room preview API MSC3429: Individual room preview API Oct 5, 2021
@turt2live turt2live added client-server Client-Server API kind:feature MSC for not-core and not-maintenance stuff needs-implementation This MSC does not have a qualifying implementation for the SCT to review. The MSC cannot enter FCP. proposal A matrix spec change proposal proposal-in-review labels Oct 5, 2021
Copy link
Contributor

@ShadowJonathan ShadowJonathan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taking a glance at this, and the mention of MSC3266 and the comparison, I think it's interesting to see what users of MSC3266 can say about this, and if this fits their usecase.

I say this, because i think stripped-state (which is used in multiple places), compared to the summary mechanism (which is only used in MSC3266, and is its own mechanism), would allow for code re-use and a more standard way to approach this.

This approach seems also easily expandable (by simply allowing more state event types), whereas the summary approach does not.

@clokep
Copy link
Contributor

clokep commented Oct 6, 2021

I say this, because i think stripped-state (which is used in multiple places), compared to the summary mechanism (which is only used in MSC3266, and is its own mechanism), would allow for code re-use and a more standard way to approach this.

MSC3266 is based on MSC2946, which attempts to re-use the response format of /publicRooms.

Stripped state is only used for invites/knocking IIRC.

Please use threads. :)

changes, the suggestion from the author is to use the same caching semantics as the room directory.
If a room becomes non-public, it should be evicted from the cache.

## Alternatives
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we just use the spaces summary? #3266 (comment)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a client author, I like #3266 shape more - as its author states, it is easier to extract data specifically for the room preview case, even if at the expense of having to add fields to yet another endpoint whenever the stripped state definition gets extended. Compared to that MSC, the current MSC looks like half-way to room peeking. I'd rather use peeking to get a richer/live preview if that provided by #3266 (or hereby) is not enough; but I don't see a lot of value in full-blown stripped state events to address a simpler preview case. The wider interface calls for unneeded questions like whether it's the same stripped state returned by /sync for invited rooms and if yes, should unsigned/prev_content also be returned - all those rather answered by the peeking MSC.

Copy link
Member

@KitsuneRal KitsuneRal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a client author, I like #3266 shape more - as its author states, it is easier to extract data specifically for the room preview case, even if at the expense of having to add fields to yet another endpoint whenever the stripped state definition gets extended. Compared to that MSC, the current MSC looks like half-way to room peeking. I'd rather use peeking to get a richer/live preview if that provided by #3266 (or hereby) is not enough; but I don't see a lot of value in full-blown stripped state events to address a simpler preview case. The wider interface calls for unneeded questions like whether it's the same stripped state returned by /sync for invited rooms and if yes, should unsigned/prev_content also be returned - all those rather answered by the peeking MSC.

Update: copied to the relevant thread.

@turt2live
Copy link
Member Author

@KitsuneRal can we get that as a thread for consideration please?

@richvdh
Copy link
Member

richvdh commented Jul 19, 2022

Given that MSC3266 is in production and generally seems preferred... can we just close this?

@turt2live
Copy link
Member Author

Sure.

@turt2live turt2live closed this Jul 19, 2022
@turt2live turt2live deleted the travis/msc/individual-room-summary branch July 19, 2022 15:03
@turt2live turt2live added the obsolete A proposal which has been overtaken by other proposals label Jul 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client-server Client-Server API hacktoberfest-accepted kind:feature MSC for not-core and not-maintenance stuff needs-implementation This MSC does not have a qualifying implementation for the SCT to review. The MSC cannot enter FCP. obsolete A proposal which has been overtaken by other proposals proposal A matrix spec change proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants