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

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

Author: zecakeh

crates/matrix-sdk/src/account.rs

@@ -41,7 +41,8 @@ use ruma::{
         error::ErrorKind,
         profile::{
             AvatarUrl, DisplayName, ProfileFieldName, ProfileFieldValue, StaticProfileField,
-            get_profile, get_profile_field, set_avatar_url, set_display_name, set_profile_field,
+            delete_profile_field, get_profile, get_profile_field, set_avatar_url, set_display_name,
+            set_profile_field,
         },
         uiaa::AuthData,
     },
@@ -416,6 +417,27 @@ impl Account {
         Ok(())
     }
 
+    /// Delete the given field of our own user's profile.
+    ///
+    /// [`Client::get_capabilities()`] should be called first to check it the
+    /// field can be modified on the homeserver.
+    ///
+    /// # Arguments
+    ///
+    /// * `field` - The profile field to delete.
+    ///
+    /// # Returns
+    ///
+    /// Returns an error if the server doesn't support extended profile fields
+    /// of if the request fails in some other way.
+    pub async fn delete_profile_field(&self, field: ProfileFieldName) -> Result<()> {
+        let user_id = self.client.user_id().ok_or(Error::AuthenticationRequired)?;
+        let request = delete_profile_field::v3::Request::new(user_id.to_owned(), field);
+        self.client.send(request).await?;
+
+        Ok(())
+    }
+
     /// Change the password of the account.
     ///
     /// # Arguments

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

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

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

@@ -153,3 +153,38 @@ async fn test_set_profile_field() {
     account.set_display_name(Some(display_name)).await.unwrap();
     account.set_profile_field(ProfileFieldValue::TimeZone(tz.to_owned())).await.unwrap();
 }
+
+#[async_test]
+async fn test_delete_profile_field() {
+    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_delete_profile_field(user_id, ProfileFieldName::TimeZone)
+        .ok()
+        .mock_once()
+        .named("delete 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(None).await.unwrap();
+    account.set_display_name(None).await.unwrap();
+    account.delete_profile_field(ProfileFieldName::TimeZone).await.unwrap();
+}