sdk: Cache the client well-known file and add Client::rtc_foci which uses it.

Author: pixlwave

Cargo.lock

@@ -60,7 +60,7 @@ reqwest = { version = "0.12.12", default-features = false }
 rmp-serde = "1.3.0"
 # Be careful to use commits from the https://github.com/ruma/ruma/tree/ruma-0.12
 # branch until a proper release with breaking changes happens.
-ruma = { version = "0.12.3", features = [
+ruma = { git = "https://github.com/ruma/ruma", rev = "d1d53e2b7aaf9190f11a5465b9edf6a19fc5b59a", features = [
     "client-api-c",
     "compat-upload-signatures",
     "compat-user-id",
@@ -73,11 +73,12 @@ ruma = { version = "0.12.3", features = [
     "unstable-msc3489",
     "unstable-msc4075",
     "unstable-msc4140",
+    "unstable-msc4143",
     "unstable-msc4171",
     "unstable-msc4278",
     "unstable-msc4286",
-    ] }
-ruma-common = "0.15.2"
+] }
+ruma-common = { git = "https://github.com/ruma/ruma", rev = "d1d53e2b7aaf9190f11a5465b9edf6a19fc5b59a" }
 sentry = "0.36.0"
 sentry-tracing = "0.36.0"
 serde = { version = "1.0.217", features = ["rc"] }

Cargo.toml

@@ -52,6 +52,9 @@ No notable changes in this release.
   ([#4897](https://github.com/matrix-org/matrix-rust-sdk/pull/4897))
 - [**breaking**] `RoomInfo::prev_state` has been removed due to being useless.
   ([#5054](https://github.com/matrix-org/matrix-rust-sdk/pull/5054))
+- The cached `ServerCapabilities` has been renamed to `ServerInfo` and additionally contains
+  the well-known response alongside the existing server versions. Despite the old name, it
+  does not contain the server capabilities (yet?!).
 
 ## [0.10.0] - 2025-02-04
 

crates/matrix-sdk-base/CHANGELOG.md

@@ -7,7 +7,10 @@ use assert_matches2::assert_let;
 use growable_bloom_filter::GrowableBloomBuilder;
 use matrix_sdk_test::{event_factory::EventFactory, test_json};
 use ruma::{
-    api::MatrixVersion,
+    api::{
+        client::discovery::discover_homeserver::{HomeserverInfo, RtcFocusInfo},
+        MatrixVersion,
+    },
     event_id,
     events::{
         presence::PresenceEvent,
@@ -34,7 +37,7 @@ use serde_json::{json, value::Value as JsonValue};
 
 use super::{
     send_queue::SentRequestKey, DependentQueuedRequestKind, DisplayName, DynStateStore,
-    RoomLoadSettings, ServerInfo,
+    RoomLoadSettings, ServerInfo, WellKnownResponse,
 };
 use crate::{
     deserialized_responses::MemberEvent,
@@ -477,6 +480,12 @@ impl StateStoreIntegrationTests for DynStateStore {
         let server_info = ServerInfo::new(
             versions.iter().map(|version| version.to_string()).collect(),
             [("org.matrix.experimental".to_owned(), true)].into(),
+            Some(WellKnownResponse {
+                homeserver: HomeserverInfo::new("matrix.example.com".to_owned()),
+                identity_server: None,
+                tile_server: None,
+                rtc_foci: vec![RtcFocusInfo::livekit("livekit.example.com".to_owned())],
+            }),
         );
 
         self.set_kv_data(

crates/matrix-sdk-base/src/store/integration_tests.rs

@@ -82,7 +82,7 @@ pub use self::{
     },
     traits::{
         ComposerDraft, ComposerDraftType, DynStateStore, IntoStateStore, ServerInfo, StateStore,
-        StateStoreDataKey, StateStoreDataValue, StateStoreExt,
+        StateStoreDataKey, StateStoreDataValue, StateStoreExt, WellKnownResponse,
     },
 };
 

crates/matrix-sdk-base/src/store/mod.rs

@@ -24,7 +24,16 @@ use async_trait::async_trait;
 use growable_bloom_filter::GrowableBloom;
 use matrix_sdk_common::AsyncTraitDeps;
 use ruma::{
-    api::{client::discovery::get_supported_versions, MatrixVersion},
+    api::{
+        client::discovery::{
+            discover_homeserver,
+            discover_homeserver::{
+                HomeserverInfo, IdentityServerInfo, RtcFocusInfo, TileServerInfo,
+            },
+            get_supported_versions,
+        },
+        MatrixVersion,
+    },
     events::{
         presence::PresenceEvent,
         receipt::{Receipt, ReceiptThread, ReceiptType},
@@ -960,6 +969,10 @@ pub struct ServerInfo {
     /// List of unstable features and their enablement status.
     pub unstable_features: BTreeMap<String, bool>,
 
+    /// Information about the server found in the client well-known file.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub well_known: Option<WellKnownResponse>,
+
     /// Last time we fetched this data from the server, in milliseconds since
     /// epoch.
     last_fetch_ts: f64,
@@ -970,8 +983,12 @@ impl ServerInfo {
     pub const STALE_THRESHOLD: f64 = (1000 * 60 * 60 * 24 * 7) as _; // seven days
 
     /// Encode server info into this serializable struct.
-    pub fn new(versions: Vec<String>, unstable_features: BTreeMap<String, bool>) -> Self {
-        Self { versions, unstable_features, last_fetch_ts: now_timestamp_ms() }
+    pub fn new(
+        versions: Vec<String>,
+        unstable_features: BTreeMap<String, bool>,
+        well_known: Option<WellKnownResponse>,
+    ) -> Self {
+        Self { versions, unstable_features, well_known, last_fetch_ts: now_timestamp_ms() }
     }
 
     /// Decode server info from this serializable struct.
@@ -998,6 +1015,33 @@ impl ServerInfo {
     }
 }
 
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+/// A serialisable representation of discover_homeserver::Response.
+pub struct WellKnownResponse {
+    /// Information about the homeserver to connect to.
+    pub homeserver: HomeserverInfo,
+
+    /// Information about the identity server to connect to.
+    pub identity_server: Option<IdentityServerInfo>,
+
+    /// Information about the tile server to use to display location data.
+    pub tile_server: Option<TileServerInfo>,
+
+    /// A list of the available MatrixRTC foci, ordered by priority.
+    pub rtc_foci: Vec<RtcFocusInfo>,
+}
+
+impl From<discover_homeserver::Response> for WellKnownResponse {
+    fn from(response: discover_homeserver::Response) -> Self {
+        Self {
+            homeserver: response.homeserver,
+            identity_server: response.identity_server,
+            tile_server: response.tile_server,
+            rtc_foci: response.rtc_foci,
+        }
+    }
+}
+
 /// Get the current timestamp as the number of milliseconds since Unix Epoch.
 fn now_timestamp_ms() -> f64 {
     SystemTime::now()
@@ -1180,6 +1224,7 @@ mod tests {
         let mut server_info = ServerInfo {
             versions: Default::default(),
             unstable_features: Default::default(),
+            well_known: Default::default(),
             last_fetch_ts: now_timestamp_ms() - ServerInfo::STALE_THRESHOLD - 1.0,
         };
 

crates/matrix-sdk-base/src/store/traits.rs

@@ -78,6 +78,9 @@ All notable changes to this project will be documented in this file.
   ([#5047](https://github.com/matrix-org/matrix-rust-sdk/pull/5047))
 - `Room::set_unread_flag()` is now a no-op if the unread flag already has the wanted value.
   ([#5055](https://github.com/matrix-org/matrix-rust-sdk/pull/5055))
+- `ClientServerCapabilities` has been renamed to `ClientServerInfo`. Alongside this,
+  `Client::reset_server_info` is now `Client::reset_server_info` and `Client::fetch_server_capabilities`
+  is now `Client::fetch_server_versions`, returning the server versions response directly.
 
 ## [0.11.0] - 2025-04-11
 

crates/matrix-sdk/CHANGELOG.md

@@ -516,7 +516,7 @@ async fn test_insecure_clients() -> anyhow::Result<()> {
     let server = MatrixMockServer::new().await;
     let server_url = server.server().uri();
 
-    server.mock_well_known().ok().expect(1).named("well_known").mount().await;
+    server.mock_well_known().ok().expect(1..).named("well_known").mount().await;
     server.mock_versions().ok().expect(1..).named("versions").mount().await;
 
     let oauth_server = server.oauth();

crates/matrix-sdk/src/authentication/oauth/tests.rs

@@ -53,6 +53,7 @@ pub(super) struct HomeserverDiscoveryResult {
     pub server: Option<Url>,
     pub homeserver: Url,
     pub supported_versions: Option<get_supported_versions::Response>,
+    pub well_known: Option<discover_homeserver::Response>,
 }
 
 impl HomeserverConfig {
@@ -68,6 +69,7 @@ impl HomeserverConfig {
                     server: None, // We can't know the `server` if we only have a `homeserver`.
                     homeserver,
                     supported_versions: None,
+                    well_known: None,
                 }
             }
 
@@ -79,18 +81,19 @@ impl HomeserverConfig {
                     server: Some(server),
                     homeserver: Url::parse(&well_known.homeserver.base_url)?,
                     supported_versions: None,
+                    well_known: Some(well_known),
                 }
             }
 
             Self::ServerNameOrHomeserverUrl(server_name_or_url) => {
-                let (server, homeserver, supported_versions) =
+                let (server, homeserver, supported_versions, well_known) =
                     discover_homeserver_from_server_name_or_url(
                         server_name_or_url.to_owned(),
                         http_client,
                     )
                     .await?;
 
-                HomeserverDiscoveryResult { server, homeserver, supported_versions }
+                HomeserverDiscoveryResult { server, homeserver, supported_versions, well_known }
             }
         })
     }
@@ -102,7 +105,15 @@ impl HomeserverConfig {
 async fn discover_homeserver_from_server_name_or_url(
     mut server_name_or_url: String,
     http_client: &HttpClient,
-) -> Result<(Option<Url>, Url, Option<get_supported_versions::Response>), ClientBuildError> {
+) -> Result<
+    (
+        Option<Url>,
+        Url,
+        Option<get_supported_versions::Response>,
+        Option<discover_homeserver::Response>,
+    ),
+    ClientBuildError,
+> {
     let mut discovery_error: Option<ClientBuildError> = None;
 
     // Attempt discovery as a server name first.
@@ -117,7 +128,12 @@ async fn discover_homeserver_from_server_name_or_url(
 
         match discover_homeserver(server_name, &protocol, http_client).await {
             Ok((server, well_known)) => {
-                return Ok((Some(server), Url::parse(&well_known.homeserver.base_url)?, None));
+                return Ok((
+                    Some(server),
+                    Url::parse(&well_known.homeserver.base_url)?,
+                    None,
+                    Some(well_known),
+                ));
             }
             Err(e) => {
                 debug!(error = %e, "Well-known discovery failed.");
@@ -138,7 +154,7 @@ async fn discover_homeserver_from_server_name_or_url(
         // Make sure the URL is definitely for a homeserver.
         match get_supported_versions(&homeserver_url, http_client).await {
             Ok(response) => {
-                return Ok((None, homeserver_url, Some(response)));
+                return Ok((None, homeserver_url, Some(response), None));
             }
             Err(e) => {
                 debug!(error = %e, "Checking supported versions failed.");

crates/matrix-sdk/src/client/builder/homeserver_config.rs

@@ -525,7 +525,7 @@ impl ClientBuilder {
         let http_client = HttpClient::new(inner_http_client.clone(), self.request_config);
 
         #[allow(unused_variables)]
-        let HomeserverDiscoveryResult { server, homeserver, supported_versions } =
+        let HomeserverDiscoveryResult { server, homeserver, supported_versions, well_known } =
             homeserver_cfg.discover(&http_client).await?;
 
         let sliding_sync_version = {
@@ -560,8 +560,11 @@ impl ClientBuilder {
         // Enable the send queue by default.
         let send_queue = Arc::new(SendQueueData::new(true));
 
-        let server_info =
-            ClientServerInfo { server_versions: self.server_versions, unstable_features: None };
+        let server_info = ClientServerInfo {
+            server_versions: self.server_versions,
+            unstable_features: None,
+            well_known: well_known.map(Into::into),
+        };
 
         let event_cache = OnceCell::new();
         let inner = ClientInner::new(