-
Notifications
You must be signed in to change notification settings - Fork 418
MSC4376: Remove /v1/send_join #4376
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
Johennes
wants to merge
1
commit into
matrix-org:main
Choose a base branch
from
Johennes:johannes/remove-send-join-v1
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.
Open
Changes from all 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
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's an open question whether or not to include |
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,94 @@ | ||
| # MSC4376: Remove /v1/send_join | ||
|
|
||
| [/_matrix/federation/v1/send_join/{roomId}/{eventId}] has been superseded by a `v2` endpoint and | ||
| deprecated with [MSC1802] in [r0.1.4] of the federation API in 2020. Given the time elapsed and the | ||
| fact that the continued presence of the derpecated endpoint occasionally causes confusion[^1], it | ||
| should be removed from the spec. | ||
|
|
||
| ## Proposal | ||
|
|
||
| [/_matrix/federation/v1/send_join/{roomId}/{eventId}] is removed from the spec. | ||
|
|
||
| ## Potential issues | ||
|
|
||
| Compatibility issues appear unlikely as the ecosystem seems to have adapted rather well. | ||
|
|
||
| ### Synapse | ||
|
|
||
| Synapse has started supporting the `v2` endpoint for incoming requests in [v1.8.0] (January 2020). | ||
| In the same version, Synapse has also started preferring the `v2` endpoint for outgoing requests, | ||
| falling back to `v1` only when `v2` is unavailable. | ||
|
|
||
| - https://github.com/matrix-org/synapse/commit/54ae52ba960df2bcc1daa76b6ef83b125ab9aac9#diff-b8a7e2066859e82776a9d0803499bfdc19707b3279e8fd43457f69f18c5cfecfL524-R548 | ||
| (incoming) | ||
| - https://github.com/matrix-org/synapse/commit/54ae52ba960df2bcc1daa76b6ef83b125ab9aac9#diff-3cf3f534d150a0319b7bdd81c884daff978bba8f8c603d7f023d5dd5d73e1ab1R600-R632 | ||
| (outgoing) | ||
|
|
||
| This behaviour is still present in the currently latest release [v1.141.0] (October 2025). | ||
|
|
||
| - https://github.com/element-hq/synapse/blob/v1.141.0/synapse/federation/transport/server/federation.py#L422 | ||
| (incoming) | ||
| - https://github.com/element-hq/synapse/blob/v1.141.0/synapse/federation/federation_client.py#L1356 | ||
| (outgoing) | ||
|
|
||
| ### Dendrite | ||
|
|
||
| Dendrite has stopped supporting the `v1` endpoint for incoming requests in December 2019 and to this | ||
| day only offers `v2`. | ||
|
|
||
| - https://github.com/matrix-org/dendrite/commit/af9568ba4468eb106ec305df496fbe1319fd74eb | ||
|
|
||
| For outgoing requests Dendrite relies on gomatrixserverlib which since June 2020 is preferring `v2`, | ||
| falling back to `v1` only when `v2` is not available. | ||
|
|
||
| - https://github.com/matrix-org/gomatrixserverlib/commit/5539854e4abc4ce179e991fbffaccde06b695dbc | ||
|
|
||
| ### Conduit & friends | ||
|
|
||
| Conduit has first started to support the `v2` endpoint for incoming requests in April 2021. | ||
|
|
||
| - https://gitlab.com/famedly/conduit/-/commit/eedac4fd9610feee34963d0bb227b354f97cd210?expanded=1 | ||
| (see `server_server.rs`, line 1755) | ||
|
|
||
| Support for the `v1` endpoint was added shortly afterwards in July 2021. | ||
|
|
||
| - https://gitlab.com/famedly/conduit/-/commit/48494c946496c36b2d1f85da1e8877ac95e2d664?expanded=1 | ||
|
|
||
| As of writing, this behaviour is still present in Conduit and derivates such as tuwunel today. | ||
|
|
||
| - https://github.com/matrix-construct/tuwunel/blob/d24986edf198cc8b37a47ed94b50a72a566c5cca/src/api/server/send_join.rs#L265 | ||
|
|
||
| When Conduit first gained support for joining federated rooms in August 2020, it used `v2` | ||
| exclusively without falling back. | ||
|
|
||
| - https://gitlab.com/famedly/conduit/-/commit/eedac4fd9610feee34963d0bb227b354f97cd210 (see | ||
| `membership.rs`, line 95) | ||
|
|
||
| Again, this behaviour is still present in Conduit and derivates such as tuwunel today. | ||
|
|
||
| - https://github.com/matrix-construct/tuwunel/blob/d24986edf198cc8b37a47ed94b50a72a566c5cca/src/service/membership/join.rs#L710 | ||
|
|
||
| ## Alternatives | ||
|
|
||
| None. | ||
|
|
||
| ## Security considerations | ||
|
|
||
| None. | ||
|
|
||
| ## Unstable prefix | ||
|
|
||
| None. | ||
|
|
||
| ## Dependencies | ||
|
|
||
| None. | ||
|
|
||
| [^1]: See e.g. https://github.com/matrix-org/matrix-spec/issues/1514 and | ||
| https://github.com/matrix-org/matrix-spec/issues/1515. | ||
|
|
||
| [/_matrix/federation/v1/send_join/{roomId}/{eventId}]: https://spec.matrix.org/v1.16/server-server-api/#put_matrixfederationv1send_joinroomideventid | ||
| [MSC1802]: https://github.com/matrix-org/matrix-spec-proposals/blob/old_master/proposals/1802-standardised-federation-response-format.md | ||
| [r0.1.4]: https://spec.matrix.org/legacy/server_server/r0.1.4.html | ||
| [v1.8.0]: https://github.com/matrix-org/synapse/releases/tag/v1.8.0 | ||
| [v1.141.0]: https://github.com/element-hq/synapse/releases/tag/v1.141.0 |
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.
Implementation requirements waived given time, security context, and implementation of fallback.