|
| 1 | +# |
| 2 | +# This file is licensed under the Affero General Public License (AGPL) version 3. |
| 3 | +# |
| 4 | +# Copyright (C) 2025 New Vector, Ltd |
| 5 | +# |
| 6 | +# This program is free software: you can redistribute it and/or modify |
| 7 | +# it under the terms of the GNU Affero General Public License as |
| 8 | +# published by the Free Software Foundation, either version 3 of the |
| 9 | +# License, or (at your option) any later version. |
| 10 | +# |
| 11 | +# See the GNU Affero General Public License for more details: |
| 12 | +# <https://www.gnu.org/licenses/agpl-3.0.html>. |
| 13 | +# |
| 14 | +# |
| 15 | + |
| 16 | +from twisted.test.proto_helpers import MemoryReactor |
| 17 | + |
| 18 | +import synapse.rest.admin |
| 19 | +from synapse.rest.client import login, room, sync |
| 20 | +from synapse.server import HomeServer |
| 21 | +from synapse.types import JsonDict |
| 22 | +from synapse.util import Clock |
| 23 | + |
| 24 | +from tests import unittest |
| 25 | +from tests.unittest import override_config |
| 26 | +from tests.utils import default_config |
| 27 | + |
| 28 | +DEFAULT_SERVER_NOTICES_CONFIG = { |
| 29 | + "system_mxid_localpart": "notices", |
| 30 | + "system_mxid_display_name": "test display name", |
| 31 | + "system_mxid_avatar_url": None, |
| 32 | + "room_name": "Server Notices", |
| 33 | + "auto_join": False, |
| 34 | +} |
| 35 | + |
| 36 | + |
| 37 | +class ServerNoticesTests(unittest.HomeserverTestCase): |
| 38 | + servlets = [ |
| 39 | + sync.register_servlets, |
| 40 | + synapse.rest.admin.register_servlets, |
| 41 | + login.register_servlets, |
| 42 | + room.register_servlets, |
| 43 | + ] |
| 44 | + |
| 45 | + def default_config(self) -> JsonDict: |
| 46 | + config = default_config("test") |
| 47 | + |
| 48 | + config.update({"server_notices": DEFAULT_SERVER_NOTICES_CONFIG}) |
| 49 | + |
| 50 | + # apply any additional config which was specified via the override_config |
| 51 | + # decorator. |
| 52 | + if self._extra_config is not None: |
| 53 | + config.update(self._extra_config) |
| 54 | + |
| 55 | + return config |
| 56 | + |
| 57 | + def prepare( |
| 58 | + self, reactor: MemoryReactor, clock: Clock, homeserver: HomeServer |
| 59 | + ) -> None: |
| 60 | + self._admin_user_id = self.register_user( |
| 61 | + "server_notices_admin", "abc123", admin=True |
| 62 | + ) |
| 63 | + self._admin_user_access_token = self.login("server_notices_admin", "abc123") |
| 64 | + |
| 65 | + self._test_user_id = self.register_user("server_notices_test_user", "abc123") |
| 66 | + self._test_user_access_token = self.login("server_notices_test_user", "abc123") |
| 67 | + |
| 68 | + self._server_notice_content = { |
| 69 | + "msgtype": "m.text", |
| 70 | + "formatted_body": "<p>Do the hussle.</p>", |
| 71 | + "body": "Do the hussle.", |
| 72 | + "format": "org.matrix.custom.html", |
| 73 | + } |
| 74 | + |
| 75 | + def _send_server_notice( |
| 76 | + self, |
| 77 | + admin_access_token: str, |
| 78 | + target_user_id: str, |
| 79 | + notice_content: JsonDict, |
| 80 | + ) -> None: |
| 81 | + # Send a server notice. |
| 82 | + channel = self.make_request( |
| 83 | + "POST", |
| 84 | + "/_synapse/admin/v1/send_server_notice", |
| 85 | + content={ |
| 86 | + "user_id": target_user_id, |
| 87 | + "content": notice_content, |
| 88 | + }, |
| 89 | + access_token=admin_access_token, |
| 90 | + ) |
| 91 | + self.assertEqual(channel.code, 200, channel.json_body) |
| 92 | + |
| 93 | + def _check_user_received_server_notice( |
| 94 | + self, |
| 95 | + target_user_id: str, |
| 96 | + target_access_token: str, |
| 97 | + expected_content: JsonDict, |
| 98 | + user_accepts_invite: bool, |
| 99 | + ) -> None: |
| 100 | + # Have the target user sync. |
| 101 | + channel = self.make_request( |
| 102 | + "GET", "/_matrix/client/v3/sync", access_token=target_access_token |
| 103 | + ) |
| 104 | + self.assertEqual(channel.code, 200, channel.json_body) |
| 105 | + sync_body = channel.json_body |
| 106 | + |
| 107 | + if user_accepts_invite: |
| 108 | + # Get the Room ID to join |
| 109 | + room_id = list(sync_body["rooms"]["invite"].keys())[0] |
| 110 | + |
| 111 | + # Join the room |
| 112 | + self.helper.join(room_id, target_user_id, tok=target_access_token) |
| 113 | + |
| 114 | + for _ in range(5): |
| 115 | + # Sync until we're joined to the room. |
| 116 | + channel = self.make_request( |
| 117 | + "GET", "/_matrix/client/v3/sync", access_token=target_access_token |
| 118 | + ) |
| 119 | + self.assertEqual(channel.code, 200, channel.json_body) |
| 120 | + sync_body = channel.json_body |
| 121 | + |
| 122 | + if "join" in sync_body["rooms"] and len(sync_body["rooms"]["join"]) > 0: |
| 123 | + # Retrieve the server notices message. |
| 124 | + room_id = list(sync_body["rooms"]["join"].keys())[0] |
| 125 | + room = sync_body["rooms"]["join"][room_id] |
| 126 | + messages = [ |
| 127 | + x |
| 128 | + for x in room["timeline"]["events"] |
| 129 | + if x["type"] == "m.room.message" |
| 130 | + ] |
| 131 | + break |
| 132 | + |
| 133 | + # Sleep and try again. |
| 134 | + self.clock.sleep(0.1) |
| 135 | + else: |
| 136 | + self.fail( |
| 137 | + f"Failed to join the server notices room. No 'join' field in sync_body['rooms']: {sync_body['rooms']}" |
| 138 | + ) |
| 139 | + |
| 140 | + # Should be the expected server notices content. |
| 141 | + self.assertDictEqual(messages[-1]["content"], expected_content) |
| 142 | + |
| 143 | + def test_send_server_notice(self) -> None: |
| 144 | + """ |
| 145 | + Test the happy path of sending a server notice to a user. |
| 146 | + """ |
| 147 | + # Send a server notice. The server notice room does not yet exist. |
| 148 | + self._send_server_notice( |
| 149 | + self._admin_user_access_token, |
| 150 | + self._test_user_id, |
| 151 | + self._server_notice_content, |
| 152 | + ) |
| 153 | + |
| 154 | + self._check_user_received_server_notice( |
| 155 | + self._test_user_id, |
| 156 | + self._test_user_access_token, |
| 157 | + self._server_notice_content, |
| 158 | + # User must accept the invite manually. |
| 159 | + True, |
| 160 | + ) |
| 161 | + |
| 162 | + # Send another server notice. In this case, the room already exists. |
| 163 | + self._send_server_notice( |
| 164 | + self._admin_user_access_token, |
| 165 | + self._test_user_id, |
| 166 | + self._server_notice_content, |
| 167 | + ) |
| 168 | + |
| 169 | + self._check_user_received_server_notice( |
| 170 | + self._test_user_id, |
| 171 | + self._test_user_access_token, |
| 172 | + self._server_notice_content, |
| 173 | + # User is already in the room, no need to join it. |
| 174 | + False, |
| 175 | + ) |
| 176 | + |
| 177 | + @override_config( |
| 178 | + { |
| 179 | + "server_notices": { |
| 180 | + **DEFAULT_SERVER_NOTICES_CONFIG, |
| 181 | + "auto_join": True, |
| 182 | + } |
| 183 | + } |
| 184 | + ) |
| 185 | + def test_send_server_notice_auto_join(self) -> None: |
| 186 | + """ |
| 187 | + Test the happy path of sending a server notice to a user, with auto_join enabled. |
| 188 | + """ |
| 189 | + # Send a server notice. The server notice room does not yet exist. |
| 190 | + self._send_server_notice( |
| 191 | + self._admin_user_access_token, |
| 192 | + self._test_user_id, |
| 193 | + self._server_notice_content, |
| 194 | + ) |
| 195 | + |
| 196 | + self._check_user_received_server_notice( |
| 197 | + self._test_user_id, |
| 198 | + self._test_user_access_token, |
| 199 | + self._server_notice_content, |
| 200 | + # User does not need to join the room manually. They should be auto-joined. |
| 201 | + False, |
| 202 | + ) |
| 203 | + |
| 204 | + @override_config( |
| 205 | + { |
| 206 | + "server_notices": { |
| 207 | + **DEFAULT_SERVER_NOTICES_CONFIG, |
| 208 | + "auto_join": True, |
| 209 | + } |
| 210 | + } |
| 211 | + ) |
| 212 | + def test_send_server_notice_suspended_user_auto_join(self) -> None: |
| 213 | + """Test sending a server notice to a user that's suspended, with auto-join enabled. |
| 214 | +
|
| 215 | + This is a regression test for https://github.com/element-hq/synapse/pull/18750, where |
| 216 | + previously the suspended user would not be allowed to join the server notices room. |
| 217 | + """ |
| 218 | + # Suspend the target user. |
| 219 | + channel = self.make_request( |
| 220 | + "PUT", |
| 221 | + f"/_synapse/admin/v1/suspend/{self._test_user_id}", |
| 222 | + content={"suspend": True}, |
| 223 | + access_token=self._admin_user_access_token, |
| 224 | + ) |
| 225 | + self.assertEqual(channel.code, 200, channel.json_body) |
| 226 | + |
| 227 | + # Send a server notice. The server notices room will be created and the user auto-joined. |
| 228 | + self._send_server_notice( |
| 229 | + self._admin_user_access_token, |
| 230 | + self._test_user_id, |
| 231 | + self._server_notice_content, |
| 232 | + ) |
| 233 | + |
| 234 | + self._check_user_received_server_notice( |
| 235 | + self._test_user_id, |
| 236 | + self._test_user_access_token, |
| 237 | + self._server_notice_content, |
| 238 | + # User does not need to join the room manually. They should be auto-joined. |
| 239 | + False, |
| 240 | + ) |
0 commit comments