From 407a7aff4e060290e4d38be5d458a23ea2def9b2 Mon Sep 17 00:00:00 2001
From: Emelie Graven <e.graven@famedly.com>
Date: Tue, 6 Dec 2022 09:32:54 +0100
Subject: [PATCH] Stabilize set_displayname() in module API (#14628)

---
 changelog.d/14629.feature      |  1 +
 synapse/module_api/__init__.py | 27 +++++++++++++++++++++++++++
 tests/module_api/test_api.py   | 18 ++++++++++++++++++
 3 files changed, 46 insertions(+)
 create mode 100644 changelog.d/14629.feature

diff --git a/changelog.d/14629.feature b/changelog.d/14629.feature
new file mode 100644
index 000000000000..78f5fc24035f
--- /dev/null
+++ b/changelog.d/14629.feature
@@ -0,0 +1 @@
+Adds a `set_displayname()` method to the module API for setting a user's display name.
diff --git a/synapse/module_api/__init__.py b/synapse/module_api/__init__.py
index 6f4a934b0509..f10f8ac8df87 100644
--- a/synapse/module_api/__init__.py
+++ b/synapse/module_api/__init__.py
@@ -1585,6 +1585,33 @@ async def create_room(
 
         return room_id_and_alias["room_id"], room_id_and_alias.get("room_alias", None)
 
+    async def set_displayname(
+        self,
+        user_id: UserID,
+        new_displayname: str,
+        deactivation: bool = False,
+    ) -> None:
+        """Sets a user's display name.
+
+        Added in Synapse v1.75.0.
+
+        Args:
+            user_id:
+                The user whose display name is to be changed.
+            new_displayname:
+                The new display name to give the user.
+            deactivation:
+                Whether this change was made while deactivating the user.
+        """
+        requester = create_requester(user_id)
+        await self._hs.get_profile_handler().set_displayname(
+            target_user=user_id,
+            requester=requester,
+            new_displayname=new_displayname,
+            by_admin=True,
+            deactivation=deactivation,
+        )
+
 
 class PublicRoomListManager:
     """Contains methods for adding to, removing from and querying whether a room
diff --git a/tests/module_api/test_api.py b/tests/module_api/test_api.py
index b0f3f4374da8..2b0916cf9d17 100644
--- a/tests/module_api/test_api.py
+++ b/tests/module_api/test_api.py
@@ -110,6 +110,24 @@ def test_can_set_admin(self):
         self.assertEqual(found_user.user_id.to_string(), user_id)
         self.assertIdentical(found_user.is_admin, True)
 
+    def test_can_set_displayname(self):
+        localpart = "alice_wants_a_new_displayname"
+        self.register_user(localpart, "1234", displayname="Alice", admin=False)
+        found_user_info = self.get_success(
+            self.module_api.get_userinfo_by_id(localpart)
+        )
+
+        self.get_success(
+            self.module_api.set_displayname(
+                found_user_info.user_id, "Bob", deactivation=False
+            )
+        )
+        found_profile = self.get_success(
+            self.module_api.get_profile_for_user(localpart)
+        )
+
+        self.assertEqual(found_profile.display_name, "Bob")
+
     def test_get_userinfo_by_id(self):
         user_id = self.register_user("alice", "1234")
         found_user = self.get_success(self.module_api.get_userinfo_by_id(user_id))