chore: Update Ruma and use the new UserProfileUpdate type and merge function.

Author: pixlwave

Cargo.lock

@@ -70,7 +70,7 @@ rand = { version = "0.10.1", default-features = false, features = ["std", "std_r
 regex = { version = "1.12.2", default-features = false }
 reqwest = { version = "0.13.1", default-features = false }
 rmp-serde = { version = "1.3.0", default-features = false }
-ruma = { git = "https://github.com/ruma/ruma", rev = "b74d09e1a186c4eb87af581276fa26414ea1d7bb", features = [
+ruma = { git = "https://github.com/ruma/ruma", rev = "a494c58c541c63042b26380a9238a24bdda4d85c", features = [
     "client-api-c",
     "compat-unset-avatar",
     "compat-upload-signatures",

Cargo.toml

@@ -302,7 +302,7 @@ mod tests {
             },
         },
         mxc_uri, owned_event_id, owned_mxc_uri, owned_user_id,
-        profile::UserProfile,
+        profile::UserProfileUpdate,
         room_alias_id, room_id,
         serde::Raw,
         uint, user_id,
@@ -450,11 +450,11 @@ mod tests {
         let mut response = http::Response::new("0".to_owned());
         response.extensions.profiles.insert(
             alice.to_owned(),
-            UserProfile::from_iter([("displayname".to_owned(), json!("Alice"))]),
+            UserProfileUpdate::from_iter([("displayname".to_owned(), json!("Alice"))]),
         );
         response.extensions.profiles.insert(
             bob.to_owned(),
-            UserProfile::from_iter([("displayname".to_owned(), json!("Bob"))]),
+            UserProfileUpdate::from_iter([("displayname".to_owned(), json!("Bob"))]),
         );
 
         // When the response is processed.
@@ -490,7 +490,7 @@ mod tests {
         let mut response = http::Response::new("1".to_owned());
         response.extensions.profiles.insert(
             alice.to_owned(),
-            UserProfile::from_iter([("displayname".to_owned(), json!("Alice Updated"))]),
+            UserProfileUpdate::from_iter([("displayname".to_owned(), json!("Alice Updated"))]),
         );
 
         client

crates/matrix-sdk-base/src/sliding_sync.rs

@@ -37,7 +37,7 @@ use ruma::{
     },
     mxc_uri, owned_event_id, owned_mxc_uri,
     presence::PresenceState,
-    profile::UserProfile,
+    profile::UserProfileUpdate,
     push::Ruleset,
     room_id,
     room_version_rules::AuthorizationRules,
@@ -2159,7 +2159,7 @@ impl StateStoreIntegrationTests for DynStateStore {
         let mut fields = BTreeMap::new();
         fields.insert("displayname".to_owned(), json!("Alice"));
         fields.insert("avatar_url".to_owned(), json!(null));
-        let update = UserProfile::from_iter(fields);
+        let update = UserProfileUpdate::from_iter(fields);
 
         let mut changes = StateChanges::default();
         changes.global_profiles.insert(user_id.to_owned(), update);
@@ -2173,7 +2173,7 @@ impl StateStoreIntegrationTests for DynStateStore {
         let mut fields = BTreeMap::new();
         fields.insert("displayname".to_owned(), json!(null));
         fields.insert("avatar_url".to_owned(), json!("mxc://example.com/avatar"));
-        let update2 = UserProfile::from_iter(fields);
+        let update2 = UserProfileUpdate::from_iter(fields);
 
         let mut changes = StateChanges::default();
         changes.global_profiles.insert(user_id.to_owned(), update2);
@@ -2195,11 +2195,11 @@ impl StateStoreIntegrationTests for DynStateStore {
         let mut changes = StateChanges::default();
         changes.global_profiles.insert(
             alice.to_owned(),
-            UserProfile::from_iter([("displayname".to_owned(), json!("Alice"))]),
+            UserProfileUpdate::from_iter([("displayname".to_owned(), json!("Alice"))]),
         );
         changes.global_profiles.insert(
             bob.to_owned(),
-            UserProfile::from_iter([("displayname".to_owned(), json!("Bob"))]),
+            UserProfileUpdate::from_iter([("displayname".to_owned(), json!("Bob"))]),
         );
         self.save_changes(&changes).await?;
 

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

@@ -540,19 +540,9 @@ impl StateStore for MemoryStore {
         }
 
         for (user_id, profile_update) in &changes.global_profiles {
-            let merged = if let Some(existing_profile) = inner.global_profiles.get(user_id) {
-                super::traits::merge_profile(existing_profile.clone(), profile_update.clone())
-            } else {
-                // TODO: Confirm if this is actually necessary. Related:
-                // https://github.com/matrix-org/matrix-spec-proposals/pull/4262#discussion_r3466830101
-                let map: BTreeMap<String, serde_json::Value> = profile_update
-                    .clone()
-                    .into_iter()
-                    .filter(|(_, value)| !value.is_null())
-                    .collect();
-                UserProfile::from_iter(map)
-            };
-            inner.global_profiles.insert(user_id.clone(), merged);
+            let mut profile = inner.global_profiles.get(user_id).cloned().unwrap_or_default();
+            profile.merge(profile_update.clone());
+            inner.global_profiles.insert(user_id.clone(), profile);
         }
 
         debug!("Saved changes in {:?}", now.elapsed());

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

@@ -61,7 +61,7 @@ use ruma::{
             redaction::SyncRoomRedactionEvent,
         },
     },
-    profile::UserProfile,
+    profile::UserProfileUpdate,
     serde::Raw,
 };
 use serde::de::DeserializeOwned;
@@ -100,7 +100,7 @@ pub use self::{
         ComposerDraft, ComposerDraftType, DraftAttachment, DraftAttachmentContent, DraftThumbnail,
         DynStateStore, IncorrectMutexGuardError, IntoStateStore, SaveLockedStateStore, StateStore,
         StateStoreDataKey, StateStoreDataValue, StateStoreExt, SupportedVersionsResponse,
-        ThreadSubscriptionCatchupToken, WellKnownResponse, merge_profile,
+        ThreadSubscriptionCatchupToken, WellKnownResponse,
     },
 };
 
@@ -590,7 +590,7 @@ pub struct StateChanges {
     ///
     /// These follow the MSC4262 update pattern: fields with an explicit `null`
     /// value are removed, while fields that aren't present are left unchanged.
-    pub global_profiles: BTreeMap<OwnedUserId, UserProfile>,
+    pub global_profiles: BTreeMap<OwnedUserId, UserProfileUpdate>,
 }
 
 impl StateChanges {

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

@@ -2124,21 +2124,6 @@ where
     }
 }
 
-// TODO: Use Ruma once the PR is merged there instead of this local helper (https://github.com/ruma/ruma/pull/2518)
-/// Helper function to merge a profile update with an existing profile based on
-/// the MSC
-pub fn merge_profile(existing: UserProfile, update: UserProfile) -> UserProfile {
-    let mut map: BTreeMap<String, serde_json::Value> = existing.into_iter().collect();
-    for (key, value) in update {
-        if value.is_null() {
-            map.remove(&key);
-        } else {
-            map.insert(key, value);
-        }
-    }
-    UserProfile::from_iter(map)
-}
-
 /// Serialisable representation of get_supported_versions::Response.
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
 pub struct SupportedVersionsResponse {

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

@@ -1109,20 +1109,10 @@ impl_state_store!({
                 let existing: Option<UserProfile> =
                     store.get(&key).await?.map(|f| self.deserialize_value(&f)).transpose()?;
 
-                let merged = if let Some(existing_profile) = existing {
-                    matrix_sdk_base::store::merge_profile(existing_profile, profile_update.clone())
-                } else {
-                    // TODO: Confirm if this is actually necessary. Related:
-                    // https://github.com/matrix-org/matrix-spec-proposals/pull/4262#discussion_r3466830101
-                    let map: BTreeMap<String, serde_json::Value> = profile_update
-                        .clone()
-                        .into_iter()
-                        .filter(|(_, value)| !value.is_null())
-                        .collect();
-                    UserProfile::from_iter(map)
-                };
+                let mut profile = existing.unwrap_or_default();
+                profile.merge(profile_update.clone());
 
-                store.put(&self.serialize_value(&merged)?).with_key(key).build()?;
+                store.put(&self.serialize_value(&profile)?).with_key(key).build()?;
             }
         }
 

crates/matrix-sdk-indexeddb/src/state_store/mod.rs

@@ -1615,20 +1615,13 @@ impl StateStore for SqliteStateStore {
                         let existing_data: Option<Vec<u8>> =
                             select_stmt.query_row([&user_id], |row| row.get(0)).optional()?;
 
-                        let merged = if let Some(data) = existing_data {
-                            let existing_profile: UserProfile = this.deserialize_json(&data)?;
-                            matrix_sdk_base::store::merge_profile(existing_profile, profile_update)
-                        } else {
-                            // TODO: Confirm if this is actually necessary. Related:
-                            // https://github.com/matrix-org/matrix-spec-proposals/pull/4262#discussion_r3466830101
-                            let map: BTreeMap<String, serde_json::Value> = profile_update
-                                .into_iter()
-                                .filter(|(_, value)| !value.is_null())
-                                .collect();
-                            UserProfile::from_iter(map)
-                        };
+                        let mut profile: UserProfile = existing_data
+                            .map(|data| this.deserialize_json(&data))
+                            .transpose()?
+                            .unwrap_or_default();
+                        profile.merge(profile_update);
 
-                        let serialized = this.serialize_json(&merged)?;
+                        let serialized = this.serialize_json(&profile)?;
                         insert_stmt.execute((&user_id, serialized))?;
                     }
                 }