Matrix/synapse
Matrix/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse synced 2024-07-04 15:43:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Default to private room visibility rather than public when a client does not specify one, according to spec. (#12350)

Browse source
This commit is contained in:
reivilibre 2022-04-01 15:55:09 +01:00 committed by GitHub
parent 336bff1104
commit c4cf916ed7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/12350.bugfix Normal file
View file

@ -0,0 +1 @@
Default to `private` room visibility rather than `public` when a client does not specify one, according to spec.

4
synapse/handlers/room.py
View file

@ -771,7 +771,9 @@ class RoomCreationHandler:
% (user_id,), % (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" is_public = visibility == "public"
room_id = await self._generate_room_id( room_id = await self._generate_room_id(

2
tests/module_api/test_api.py
View file

@ -292,7 +292,7 @@ class ModuleApiTestCase(HomeserverTestCase):
# Create a user and room to play with # Create a user and room to play with
user_id = self.register_user("kermit", "monkey") user_id = self.register_user("kermit", "monkey")
tok = self.login("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 # The room should not currently be in the public rooms directory
is_in_public_rooms = self.get_success( is_in_public_rooms = self.get_success(

11
tests/rest/client/utils.py
View file

@ -88,7 +88,7 @@ class RestHelper:
def create_room_as( def create_room_as(
self, self,
room_creator: Optional[str] = None, room_creator: Optional[str] = None,
is_public: Optional[bool] = None, is_public: Optional[bool] = True,
room_version: Optional[str] = None, room_version: Optional[str] = None,
tok: Optional[str] = None, tok: Optional[str] = None,
expect_code: int = HTTPStatus.OK, expect_code: int = HTTPStatus.OK,
@ -101,9 +101,12 @@ class RestHelper:
Args: Args:
room_creator: The user ID to create the room with. room_creator: The user ID to create the room with.
is_public: If True, the `visibility` parameter will be set to is_public: If True, the `visibility` parameter will be set to
"public". If False, it will be set to "private". If left "public". If False, it will be set to "private".
unspecified, the server will set it to an appropriate default If None, doesn't specify the `visibility` parameter in which
(which should be "private" as per the CS spec). 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 room_version: The room version to create the room as. Defaults to Synapse's
default room version. default room version.
tok: The access token to use in the request. tok: The access token to use in the request.

4
tests/storage/test_cleanup_extrems.py
View file

@ -266,7 +266,9 @@ class CleanupExtremDummyEventsTestCase(HomeserverTestCase):
self.user = UserID.from_string(self.register_user("user1", "password")) self.user = UserID.from_string(self.register_user("user1", "password"))
self.token1 = self.login("user1", "password") self.token1 = self.login("user1", "password")
self.requester = create_requester(self.user) 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.room_id = info["room_id"]
self.event_creator = homeserver.get_event_creation_handler() self.event_creator = homeserver.get_event_creation_handler()
homeserver.config.consent.user_consent_version = self.CONSENT_VERSION homeserver.config.consent.user_consent_version = self.CONSENT_VERSION