Add Spaces to the spec #3610
Merged
Add Spaces to the spec #3610
Conversation
This file contains 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
turt2live
force-pushed
the
travis/spec/spaces-1-1772-3288-2946
branch
2 times, most recently
from
d5003cc
to
e68dc2f
Compare
turt2live
added this to Needs idea feedback / initial review
in Spec Core Team Backlog
via automation
turt2live
moved this from Needs idea feedback / initial review
to Requires spec review (post-FCP)
in Spec Core Team Backlog
This was referenced Dec 31, 2021
Merged
clokep
reviewed
Jan 4, 2022
Comment on lines
+18
to
+23
| aliases: | ||
| type: array | ||
| description: Aliases of the room. May be empty. | ||
| items: | ||
| type: string | ||
| example: ["#general:example.org"] |
There was a problem hiding this comment.
This is being discussed on matrix-org/synapse#11667 (comment), but to cross-link. It seems that Synapse no longer returns aliases for /publicRooms, although MSC2432 never specified that change.
There was a problem hiding this comment.
Removed in #3624 because it's a bit more clear that way.
turt2live
added a commit
that referenced
this pull request
Jan 5, 2022
Through attempting to land [Synapse#11667](matrix-org/synapse#11667) it was found that Synapse doesn't return the `aliases` property on `/publicRooms` as it was [removed](matrix-org/synapse#6970) by a [tracking issue](matrix-org/synapse#6898) referencing [MSC2432](#2432) as its base. Though MSC2432 does not make mention of this, the [document](https://docs.google.com/document/d/1NNDkobiFLeUkJtyj0H6qvKIedgvIkZnFKo78-03cGEk/edit) the MSC is based upon makes deliberate effort to mention the endpoint and the removal of `aliases`. Thus, it is determined as a likely accidental omission from the formal MSC and therefore the formal spec. This has been corrected here by amending the MSC (per the process) and removing the field, basing itself off of the [spec PR for spaces](#3610) for diff clarity.
turt2live
force-pushed
the
travis/spec/spaces-1-1772-3288-2946
branch
from
51bbc2e
to
e68dc2f
Compare
turt2live
added a commit
that referenced
this pull request
Jan 5, 2022
Through attempting to land [Synapse#11667](matrix-org/synapse#11667) it was found that Synapse doesn't return the `aliases` property on `/publicRooms` as it was [removed](matrix-org/synapse#6970) by a [tracking issue](matrix-org/synapse#6898) referencing [MSC2432](#2432) as its base. Though MSC2432 does not make mention of this, the [document](https://docs.google.com/document/d/1NNDkobiFLeUkJtyj0H6qvKIedgvIkZnFKo78-03cGEk/edit) the MSC is based upon makes deliberate effort to mention the endpoint and the removal of `aliases`. Thus, it is determined as a likely accidental omission from the formal MSC and therefore the formal spec. This has been corrected here by amending the MSC (per the process) and removing the field, basing itself off of the [spec PR for spaces](#3610) for diff clarity.
|
Apologies for the force push - the merge from main->here didn't fix the diff like how I thought it would because of our squash merging (was hoping it'd cancel out the stripped state commit and become a clean PR, but that only works with merge commits rather than squashes) |
MSCs: * #3288 * #2946 * #1772 Note that this makes modifications to the underlying MSCs as well. These are intended to be minor edits to aid clarity/accuracy of the MSCs, as per the proposal process. Functionally, clients and servers might need to change their behaviour slightly as is expected of implementing this stuff early. Synapse has these changes (alongside backwards compatibility) here: matrix-org/synapse#11667
richvdh
force-pushed
the
travis/spec/spaces-1-1772-3288-2946
branch
from
6616a5e
to
493f730
Compare
|
I've rebased this, because it was hard to comment on otherwise. Apologies for any review comments it has outdated. |
richvdh
pushed a commit
that referenced
this pull request
Jan 11, 2022
Through attempting to land [Synapse#11667](matrix-org/synapse#11667) it was found that Synapse doesn't return the `aliases` property on `/publicRooms` as it was [removed](matrix-org/synapse#6970) by a [tracking issue](matrix-org/synapse#6898) referencing [MSC2432](#2432) as its base. Though MSC2432 does not make mention of this, the [document](https://docs.google.com/document/d/1NNDkobiFLeUkJtyj0H6qvKIedgvIkZnFKo78-03cGEk/edit) the MSC is based upon makes deliberate effort to mention the endpoint and the removal of `aliases`. Thus, it is determined as a likely accidental omission from the formal MSC and therefore the formal spec. This has been corrected here by amending the MSC (per the process) and removing the field, basing itself off of the [spec PR for spaces](#3610) for diff clarity.
richvdh
reviewed
Jan 11, 2022
Comment on lines
+60
to
+61
| When using this approach, the state events get sent into the space-room which is the | ||
| parent to the room. The `state_key` for the event is the child room's ID. |
There was a problem hiding this comment.
I think it might be clearer/more intuitive to say a state event is set on than sent into ?
Suggested change
| When using this approach, the state events get sent into the space-room which is the | |
| parent to the room. The `state_key` for the event is the child room's ID. | |
| When using this approach, `m.state.child` state events are set on the space-room which is the | |
| parent to the room. The `state_key` for the event is the child room's ID. |
ymmv, just a suggestion. Probably needs updates elsewhere for consistency if you want to adopt this.
There was a problem hiding this comment.
We don't really talk about setting things "onto" a room in the spec, so am hesitant to introduce the concept here.
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
turt2live
moved this from Requires spec review (post-FCP)
to Done to some definition
in Spec Core Team Backlog
turt2live
added a commit
that referenced
this pull request
Jan 17, 2022
Through attempting to land [Synapse#11667](matrix-org/synapse#11667) it was found that Synapse doesn't return the `aliases` property on `/publicRooms` as it was [removed](matrix-org/synapse#6970) by a [tracking issue](matrix-org/synapse#6898) referencing [MSC2432](#2432) as its base. Though MSC2432 does not make mention of this, the [document](https://docs.google.com/document/d/1NNDkobiFLeUkJtyj0H6qvKIedgvIkZnFKo78-03cGEk/edit) the MSC is based upon makes deliberate effort to mention the endpoint and the removal of `aliases`. Thus, it is determined as a likely accidental omission from the formal MSC and therefore the formal spec. This has been corrected here by amending the MSC (per the process) and removing the field, basing itself off of the [spec PR for spaces](#3610) for diff clarity.
turt2live
added a commit
that referenced
this pull request
Jan 18, 2022
Through attempting to land [Synapse#11667](matrix-org/synapse#11667) it was found that Synapse doesn't return the `aliases` property on `/publicRooms` as it was [removed](matrix-org/synapse#6970) by a [tracking issue](matrix-org/synapse#6898) referencing [MSC2432](#2432) as its base. Though MSC2432 does not make mention of this, the [document](https://docs.google.com/document/d/1NNDkobiFLeUkJtyj0H6qvKIedgvIkZnFKo78-03cGEk/edit) the MSC is based upon makes deliberate effort to mention the endpoint and the removal of `aliases`. Thus, it is determined as a likely accidental omission from the formal MSC and therefore the formal spec. This has been corrected here by amending the MSC (per the process) and removing the field, basing itself off of the [spec PR for spaces](#3610) for diff clarity.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Requires #3606 (already landed)Please see pull/3606/head...pull/3610/head for the true diff. Because of squash merges and how this branch was built it's not easy/recommended to remove 3606 from this PR for now - it should still merge cleanly.MSCs:
/_matrix/identity/v2/store-inviteAPI #3288Note that this makes modifications to the underlying MSCs as well. These are intended to be minor edits to aid clarity/accuracy of the MSCs, as per the proposal process. Functionally, clients and servers might need to change their behaviour slightly as is expected of implementing this stuff early. Synapse has these changes (alongside backwards compatibility) here: matrix-org/synapse#11667
Preview: https://pr3610--matrix-org-previews.netlify.app