feat(api): implement MSC4143 RTC transports discovery endpoint #1442

Merged
nex merged 5 commits from 0xnim/continuwuity:feat/msc4143-rtc-transports-endpoint into main 2026-02-24 01:00:58 +00:00
Contributor

Add dedicated GET /_matrix/client/v1/rtc/transports and GET /_matrix/client/unstable/org.matrix.msc4143/rtc/transports endpoints for MatrixRTC focus discovery (MSC4143), replacing the deprecated well-known approach.

Move RTC foci configuration from [global.well_known] into a new [global.matrix_rtc] config section with a foci field. Remove rtc_foci from the .well-known/matrix/client response. Update LiveKit setup documentation accordingly.

Closes #1431

This pull request implements the dedicated MatrixRTC transport discovery endpoints defined in MSC4143. Previously in the .well-known/matrix/client response under the org.matrix.msc4143.rtc_foci key, which is now considered deprecated. The new dedicated endpoints (/_matrix/client/v1/rtc/transports stable and /_matrix/client/unstable/org.matrix.msc4143/rtc/transports unstable) provide the same information through a proper client API route.

Pull request checklist:

  • This pull request targets the main branch, and the branch is named something other than
    main.
  • I have written an appropriate pull request title and my description is clear.
  • I understand I am responsible for the contents of this pull request.
  • I have followed the contributing guidelines:
Add dedicated `GET /_matrix/client/v1/rtc/transports` and `GET /_matrix/client/unstable/org.matrix.msc4143/rtc/transports` endpoints for MatrixRTC focus discovery (MSC4143), replacing the deprecated well-known approach. Move RTC foci configuration from `[global.well_known]` into a new `[global.matrix_rtc]` config section with a `foci` field. Remove `rtc_foci` from the `.well-known/matrix/client` response. Update LiveKit setup documentation accordingly. Closes #1431 <!-- In order to help reviewers know what your pull request does at a glance, you should ensure that 1. Your PR title is a short, single sentence describing what you changed 2. You have described in more detail what you have changed, why you have changed it, what the intended effect is, and why you think this will be beneficial to the project. If you have made any potentially strange/questionable design choices, but didn't feel they'd benefit from code comments, please don't mention them here - after opening your pull request, go to "files changed", and click on the "+" symbol in the line number gutter, and attach comments to the lines that you think would benefit from some clarification. --> This pull request implements the dedicated MatrixRTC transport discovery endpoints defined in MSC4143. Previously in the .well-known/matrix/client response under the org.matrix.msc4143.rtc_foci key, which is now considered deprecated. The new dedicated endpoints (`/_matrix/client/v1/rtc/transports` stable and `/_matrix/client/unstable/org.matrix.msc4143/rtc/transports` unstable) provide the same information through a proper client API route. <!-- Example: This pull request allows us to warp through time and space ten times faster than before by double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more efficient. This resolves the common issue where we have to wait more than 10 milliseconds to engage, use, and disengage the warp drive when travelling between galaxies. --> <!-- Fixes: #... --> <!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request by superseding it. Replace `#...` with the issue/pr number, such as `#123`. --> **Pull request checklist:** <!-- You need to complete these before your PR can be considered. If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. --> - [X] This pull request targets the `main` branch, and the branch is named something other than `main`. - [X] I have written an appropriate pull request title and my description is clear. - [X] I understand I am responsible for the contents of this pull request. - I have followed the [contributing guidelines][c1]: - [X] My contribution follows the [code style][c2], if applicable. - [X] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [X] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [X] My commit messages follow the [commit message format][c1cm] and are descriptive. - [X] I have written a [news fragment][n1] for this PR, if applicable<!--(can be done after hitting open!)-->. <!-- Notes on these requirements: - While not required, we encourage you to sign your commits with GPG or SSH to attest the authenticity of your changes. - While we allow LLM-assisted contributions, we do not appreciate contributions that are low quality, which is typical of machine-generated contributions that have not had a lot of love and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up the codebase with a +-100,000 diff. - In the case of code style violations, reviewers may leave review comments/change requests indicating what the ideal change would look like. For example, a reviewer may suggest you lower a log level, or use `match` instead of `if/else` etc. - In the case of code style violations, pre-commit check failures, minor things like typos/spelling errors, and in some cases commit format violations, reviewers may modify your branch directly, typically by making changes and adding a commit. Particularly in the latter case, a reviewer may rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword commit messages that don't satisfy the format. - Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be bypassed in exceptional circumstances. If your CI flakes, let us know in matrix:r/dev:continuwuity.org. - Pull requests have to be based on the latest `main` commit before being merged. If the main branch changes while you're making your changes, you should make sure you rebase on main before opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind. - We typically only do fast-forward merges, so your entire commit log will be included. Once in main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras! --> [c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md [c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx [c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks [c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally [c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages [n1]: https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments
feat(api): implement MSC4143 RTC transports discovery endpoint
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
9e5d7f1aaa
Add dedicated \`GET /_matrix/client/v1/rtc/transports\` and \`GET /_matrix/client/unstable/org.matrix.msc4143/rtc/transports\` endpoints for MatrixRTC focus discovery (MSC4143), replacing the deprecated well-known approach.

Move RTC foci configuration from \`[global.well_known]\` into a new \`[global.matrix_rtc]\` config section with a \`foci\` field. Remove \`rtc_foci\` from the \`.well-known/matrix/client\` response. Update LiveKit setup documentation accordingly.

Closes #1431
chore(changelog): add news fragment for #1442
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m56s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 18m47s
183beccd9d
Jade left a comment
Owner

The main thing is compatibillity - at the moment this breaks compatibility with existing configurations and the currently released version of EC. Once that's done, I'm OK to merge

The main thing is compatibillity - at the moment this breaks compatibility with existing configurations and the currently released version of EC. Once that's done, I'm OK to merge
@ -28,3 +28,3 @@
sliding_sync_proxy: Some(SlidingSyncProxyInfo { url: client_url }),
tile_server: None,
rtc_foci: services.config.well_known.rtc_focus_server_urls.clone(),
rtc_foci: vec![],
Owner

Rather than removing this, it should be kept for a time until most clients stop using it

Rather than removing this, it should be kept for a time until most clients stop using it
Owner

(Element Call hasn't released the version that replaces it, and they don't have a migration so we'll have to support both for a time)

(Element Call hasn't released the version that replaces it, and they don't have a migration so we'll have to support both for a time)
Owner

I lie, they do include a fallback, but the version that uses the new endpoint hasn't been released yet

I lie, they do include a fallback, but the version that uses the new endpoint hasn't been released yet
0xnim marked this conversation as resolved
@ -187,0 +191,4 @@
.route(
"/_matrix/client/unstable/org.matrix.msc4143/rtc/transports",
get(client::get_rtc_transports),
)
Owner

Ideally should be a ruma route if you can pull that into ruwuma. If not, can fix later.

Ideally should be a ruma route if you can pull that into ruwuma. If not, can fix later.
Author
Contributor

@Jade is this good for ruwuma? continuwuation/ruwuma#48

@Jade is this good for ruwuma? continuwuation/ruwuma#48
0xnim marked this conversation as resolved
@ -2137,4 +2134,0 @@
///
/// default: []
#[serde(default = "default_rtc_focus_urls")]
pub rtc_focus_server_urls: Vec<RtcFocusInfo>,
Owner

Can we keep compatibility with existing configs so people don't have to update their settings, even if it's just hiding this and using it as the default value for the new option?

Can we keep compatibility with existing configs so people don't have to update their settings, even if it's just hiding this and using it as the default value for the new option?
0xnim marked this conversation as resolved
nex added this to the next milestone 2026-02-23 16:00:24 +00:00
0xnim changed title from feat(api): implement MSC4143 RTC transports discovery endpoint to WIP: feat(api): implement MSC4143 RTC transports discovery endpoint 2026-02-23 17:51:13 +00:00
fix(api): restore backwards compatibility for RTC foci config
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m50s
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 14m51s
7bb6317804
chore(deps): update ruwuma revision
Some checks are pending
Documentation / Build and Deploy Documentation (pull_request) Blocked by required conditions
Checks / Prek / Pre-commit & Formatting (pull_request) Blocked by required conditions
Checks / Prek / Clippy and Cargo Tests (pull_request) Blocked by required conditions
Update flake hashes / update-flake-hashes (pull_request) Blocked by required conditions
cddb163f94
0xnim changed title from WIP: feat(api): implement MSC4143 RTC transports discovery endpoint to feat(api): implement MSC4143 RTC transports discovery endpoint 2026-02-23 23:00:51 +00:00
0xnim force-pushed feat/msc4143-rtc-transports-endpoint from cddb163f94
Some checks are pending
Documentation / Build and Deploy Documentation (pull_request) Blocked by required conditions
Checks / Prek / Pre-commit & Formatting (pull_request) Blocked by required conditions
Checks / Prek / Clippy and Cargo Tests (pull_request) Blocked by required conditions
Update flake hashes / update-flake-hashes (pull_request) Blocked by required conditions
to 1e6d95583c
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 25s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m32s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
2026-02-23 23:01:17 +00:00
Compare
Author
Contributor

I need to change the fragment

I need to change the fragment
fixup! fix(api): restore backwards compatibility for RTC foci config
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 57s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m56s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 33m28s
Documentation / Build and Deploy Documentation (push) Successful in 1m45s
Checks / Prek / Pre-commit & Formatting (push) Successful in 5m26s
Release Docker Image / Build linux-amd64 (release) (push) Successful in 27m5s
Release Docker Image / Build linux-arm64 (release) (push) Successful in 23m45s
Release Docker Image / Create Multi-arch Release Manifest (push) Successful in 1m56s
Checks / Prek / Clippy and Cargo Tests (push) Failing after 1h0m0s
Release Docker Image / Build linux-arm64 (max-perf) (push) Successful in 18m1s
Release Docker Image / Build linux-amd64 (max-perf) (push) Successful in 20m10s
Release Docker Image / Create Max-Perf Manifest (push) Successful in 21s
763d9b3de8
nex approved these changes 2026-02-23 23:11:12 +00:00
nex merged commit 763d9b3de8 into main 2026-02-24 01:00:58 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1442
No description provided.