diff options
author | reivilibre <oliverw@matrix.org> | 2022-04-01 15:55:09 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-04-01 15:55:09 +0100 |
commit | c4cf916ed7d09d13d84f964dd683e1ecfd21815b (patch) | |
tree | 56a9673e2b30190f6f6b1a896bc987949ef1aaa6 | |
parent | Burn `check_signature` dev script. (#12351) (diff) | |
download | synapse-c4cf916ed7d09d13d84f964dd683e1ecfd21815b.tar.xz |
Default to `private` room visibility rather than `public` when a client does not specify one, according to spec. (#12350)
-rw-r--r-- | changelog.d/12350.bugfix | 1 | ||||
-rw-r--r-- | synapse/handlers/room.py | 4 | ||||
-rw-r--r-- | tests/module_api/test_api.py | 2 | ||||
-rw-r--r-- | tests/rest/client/utils.py | 11 | ||||
-rw-r--r-- | tests/storage/test_cleanup_extrems.py | 4 |
5 files changed, 15 insertions, 7 deletions
diff --git a/changelog.d/12350.bugfix b/changelog.d/12350.bugfix new file mode 100644 index 0000000000..9cbdc28038 --- /dev/null +++ b/changelog.d/12350.bugfix @@ -0,0 +1 @@ +Default to `private` room visibility rather than `public` when a client does not specify one, according to spec. \ No newline at end of file diff --git a/synapse/handlers/room.py b/synapse/handlers/room.py index 092e185c99..51a08fd2c0 100644 --- a/synapse/handlers/room.py +++ b/synapse/handlers/room.py @@ -771,7 +771,9 @@ class RoomCreationHandler: % (user_id,), ) - visibility = config.get("visibility", None) + # The spec says rooms should default to private visibility if + # `visibility` is not specified. + visibility = config.get("visibility", "private") is_public = visibility == "public" room_id = await self._generate_room_id( diff --git a/tests/module_api/test_api.py b/tests/module_api/test_api.py index 36dfe5c36a..dee248801d 100644 --- a/tests/module_api/test_api.py +++ b/tests/module_api/test_api.py @@ -292,7 +292,7 @@ class ModuleApiTestCase(HomeserverTestCase): # Create a user and room to play with user_id = self.register_user("kermit", "monkey") tok = self.login("kermit", "monkey") - room_id = self.helper.create_room_as(user_id, tok=tok) + room_id = self.helper.create_room_as(user_id, tok=tok, is_public=False) # The room should not currently be in the public rooms directory is_in_public_rooms = self.get_success( diff --git a/tests/rest/client/utils.py b/tests/rest/client/utils.py index 28663826fc..a0788b1bb0 100644 --- a/tests/rest/client/utils.py +++ b/tests/rest/client/utils.py @@ -88,7 +88,7 @@ class RestHelper: def create_room_as( self, room_creator: Optional[str] = None, - is_public: Optional[bool] = None, + is_public: Optional[bool] = True, room_version: Optional[str] = None, tok: Optional[str] = None, expect_code: int = HTTPStatus.OK, @@ -101,9 +101,12 @@ class RestHelper: Args: room_creator: The user ID to create the room with. is_public: If True, the `visibility` parameter will be set to - "public". If False, it will be set to "private". If left - unspecified, the server will set it to an appropriate default - (which should be "private" as per the CS spec). + "public". If False, it will be set to "private". + If None, doesn't specify the `visibility` parameter in which + case the server is supposed to make the room private according to + the CS API. + Defaults to public, since that is commonly needed in tests + for convenience where room privacy is not a problem. room_version: The room version to create the room as. Defaults to Synapse's default room version. tok: The access token to use in the request. diff --git a/tests/storage/test_cleanup_extrems.py b/tests/storage/test_cleanup_extrems.py index fe91c3fed8..b998ad42d9 100644 --- a/tests/storage/test_cleanup_extrems.py +++ b/tests/storage/test_cleanup_extrems.py @@ -266,7 +266,9 @@ class CleanupExtremDummyEventsTestCase(HomeserverTestCase): self.user = UserID.from_string(self.register_user("user1", "password")) self.token1 = self.login("user1", "password") self.requester = create_requester(self.user) - info, _ = self.get_success(self.room_creator.create_room(self.requester, {})) + info, _ = self.get_success( + self.room_creator.create_room(self.requester, {"visibility": "public"}) + ) self.room_id = info["room_id"] self.event_creator = homeserver.get_event_creation_handler() homeserver.config.consent.user_consent_version = self.CONSENT_VERSION |