Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Room summary is only provided for lazy loading /syncs #15017

Open
squahtx opened this issue Feb 7, 2023 · 0 comments
Open

Room summary is only provided for lazy loading /syncs #15017

squahtx opened this issue Feb 7, 2023 · 0 comments
Labels
A-Spec-Compliance places where synapse does not conform to the spec A-Sync defects related to /sync O-Occasional Affects or can be seen by some users regularly or most users rarely S-Tolerable Minor significance, cosmetic issues, low or no impact to users. T-Defect Bugs, crashes, hangs, security vulnerabilities, or other reported issues.

Comments

@squahtx
Copy link
Contributor

squahtx commented Feb 7, 2023

As noted by @S7evinK here:

Also see matrix-org/complement#553 and matrix-org/matrix-spec#1325, where we came to the conclusion, for now, that it's not clear by the spec when this field should be added.
Looking at RoomSummary and the m.heroes, it states that this is required, if the room has neither m.room.name nor m.room.canonical_alias. So given a room can have neither (e.g. DMs), shouldn't Synapse include a RoomSummary, no matter if lazy loading or not?

Synapse only provides a room summary in /sync responses when lazy loading is enabled. However, the spec says that many of summary's fields (but not summary itself) are required under some conditions. eg. m.heroes is required if the room’s m.room.name or m.room.canonical_alias state events are unset or empty.

We should provide a room summary under the conditions mentioned by the spec and not just when lazy loading.

@squahtx squahtx added A-Spec-Compliance places where synapse does not conform to the spec A-Sync defects related to /sync S-Tolerable Minor significance, cosmetic issues, low or no impact to users. O-Occasional Affects or can be seen by some users regularly or most users rarely labels Feb 7, 2023
@DMRobertson DMRobertson added the T-Defect Bugs, crashes, hangs, security vulnerabilities, or other reported issues. label Feb 8, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Spec-Compliance places where synapse does not conform to the spec A-Sync defects related to /sync O-Occasional Affects or can be seen by some users regularly or most users rarely S-Tolerable Minor significance, cosmetic issues, low or no impact to users. T-Defect Bugs, crashes, hangs, security vulnerabilities, or other reported issues.
Projects
None yet
Development

No branches or pull requests

2 participants