feat(sdk): Add support for setting custom profile fields

Signed-off-by: Kévin Commaille <[email protected]>

Author: zecakeh

crates/matrix-sdk/src/account.rs

@@ -41,7 +41,7 @@ use ruma::{
         error::ErrorKind,
         profile::{
             AvatarUrl, DisplayName, ProfileFieldName, ProfileFieldValue, StaticProfileField,
-            get_profile, get_profile_field, set_avatar_url, set_display_name,
+            get_profile, get_profile_field, set_avatar_url, set_display_name, set_profile_field,
         },
         uiaa::AuthData,
     },
@@ -396,6 +396,26 @@ impl Account {
         Ok(response.value)
     }
 
+    /// Set the given field of our own user's profile.
+    ///
+    /// [`Client::get_capabilities()`] should be called first to check it the
+    /// field can be set on the homeserver.
+    ///
+    /// # Arguments
+    ///
+    /// * `value` - The value of the profile field to set.
+    ///
+    /// # Returns
+    ///
+    /// Returns an error if the request fails.
+    pub async fn set_profile_field(&self, value: ProfileFieldValue) -> Result<()> {
+        let user_id = self.client.user_id().ok_or(Error::AuthenticationRequired)?;
+        let request = set_profile_field::v3::Request::new(user_id.to_owned(), value);
+        self.client.send(request).await?;
+
+        Ok(())
+    }
+
     /// Change the password of the account.
     ///
     /// # Arguments

crates/matrix-sdk/src/test_utils/mocks/mod.rs

@@ -1634,6 +1634,17 @@ impl MatrixMockServer {
             .and(path(format!("/_matrix/client/v3/profile/{user_id}/{field}")));
         self.mock_endpoint(mock, GetProfileFieldEndpoint { field })
     }
+
+    /// Create a prebuilt mock for the endpoint used to set a profile field.
+    pub fn mock_set_profile_field(
+        &self,
+        user_id: &UserId,
+        field: ProfileFieldName,
+    ) -> MockEndpoint<'_, SetProfileFieldEndpoint> {
+        let mock = Mock::given(method("PUT"))
+            .and(path(format!("/_matrix/client/v3/profile/{user_id}/{field}")));
+        self.mock_endpoint(mock, SetProfileFieldEndpoint).expect_default_access_token()
+    }
 }
 
 /// A specification for a push rule ID.
@@ -4689,3 +4700,13 @@ impl<'a> MockEndpoint<'a, GetProfileFieldEndpoint> {
         }
     }
 }
+
+/// A prebuilt mock for `PUT /_matrix/client/*/profile/{user_id}/{key_name}`.
+pub struct SetProfileFieldEndpoint;
+
+impl<'a> MockEndpoint<'a, SetProfileFieldEndpoint> {
+    /// Returns a successful empty response.
+    pub fn ok(self) -> MatrixMock<'a> {
+        self.ok_empty_json()
+    }
+}

crates/matrix-sdk/tests/integration/account.rs

@@ -1,9 +1,12 @@
 use assert_matches2::assert_matches;
 use matrix_sdk::test_utils::mocks::MatrixMockServer;
 use matrix_sdk_test::async_test;
-use ruma::api::{
-    MatrixVersion,
-    client::profile::{ProfileFieldName, ProfileFieldValue, TimeZone},
+use ruma::{
+    api::{
+        MatrixVersion,
+        client::profile::{ProfileFieldName, ProfileFieldValue, TimeZone},
+    },
+    mxc_uri,
 };
 use serde_json::json;
 use wiremock::{
@@ -111,3 +114,42 @@ async fn test_fetch_profile_field() {
         account.fetch_profile_field_of_static::<TimeZone>(user_id.to_owned()).await.unwrap();
     assert_eq!(res_tz.as_deref(), Some(tz));
 }
+
+#[async_test]
+async fn test_set_profile_field() {
+    let tz = "Africa/Bujumbura";
+    let display_name = "Alice";
+    let avatar_url = mxc_uri!("mxc://localhost/1mA63");
+
+    let server = MatrixMockServer::new().await;
+    let client = server.client_builder().server_versions(vec![MatrixVersion::V1_16]).build().await;
+    let user_id = client.user_id().unwrap();
+
+    server
+        .mock_set_profile_field(user_id, ProfileFieldName::TimeZone)
+        .ok()
+        .mock_once()
+        .named("set m.tz profile field")
+        .mount()
+        .await;
+    server
+        .mock_set_profile_field(user_id, ProfileFieldName::DisplayName)
+        .ok()
+        .mock_once()
+        .named("set displayname profile field")
+        .mount()
+        .await;
+    server
+        .mock_set_profile_field(user_id, ProfileFieldName::AvatarUrl)
+        .ok()
+        .mock_once()
+        .named("set avatar_url profile field")
+        .mount()
+        .await;
+
+    let account = client.account();
+
+    account.set_avatar_url(Some(avatar_url)).await.unwrap();
+    account.set_display_name(Some(display_name)).await.unwrap();
+    account.set_profile_field(ProfileFieldValue::TimeZone(tz.to_owned())).await.unwrap();
+}