This repository was archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Remove deprecated user_may_create_room_with_invites callback #11950
Merged
babolivier
merged 6 commits into
develop
from
babolivier/user_may_create_room_with_invites
Feb 11, 2022
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
015dde7
Remove deprecated user_may_create_room_with_invites callback
babolivier aac7329
Changelog
babolivier 5625445
Lint
babolivier ee69b26
Add removal notice to the upgrade notes
babolivier 7109c08
Merge branch 'develop' of github.com:matrix-org/synapse into babolivi…
babolivier 0691a2f
Update docs/upgrade.md
babolivier File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Remove deprecated `user_may_create_room_with_invites` spam checker callback. See the [upgrade notes](https://matrix-org.github.io/synapse/latest/upgrade.html#removal-of-user_may_create_room_with_invites) for more information. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -48,9 +48,6 @@ | |
| USER_MAY_INVITE_CALLBACK = Callable[[str, str, str], Awaitable[bool]] | ||
| USER_MAY_SEND_3PID_INVITE_CALLBACK = Callable[[str, str, str, str], Awaitable[bool]] | ||
| USER_MAY_CREATE_ROOM_CALLBACK = Callable[[str], Awaitable[bool]] | ||
| USER_MAY_CREATE_ROOM_WITH_INVITES_CALLBACK = Callable[ | ||
| [str, List[str], List[Dict[str, str]]], Awaitable[bool] | ||
| ] | ||
| USER_MAY_CREATE_ROOM_ALIAS_CALLBACK = Callable[[str, RoomAlias], Awaitable[bool]] | ||
| USER_MAY_PUBLISH_ROOM_CALLBACK = Callable[[str, str], Awaitable[bool]] | ||
| CHECK_USERNAME_FOR_SPAM_CALLBACK = Callable[[Dict[str, str]], Awaitable[bool]] | ||
|
|
@@ -174,9 +171,6 @@ def __init__(self) -> None: | |
| USER_MAY_SEND_3PID_INVITE_CALLBACK | ||
| ] = [] | ||
| self._user_may_create_room_callbacks: List[USER_MAY_CREATE_ROOM_CALLBACK] = [] | ||
| self._user_may_create_room_with_invites_callbacks: List[ | ||
| USER_MAY_CREATE_ROOM_WITH_INVITES_CALLBACK | ||
| ] = [] | ||
| self._user_may_create_room_alias_callbacks: List[ | ||
| USER_MAY_CREATE_ROOM_ALIAS_CALLBACK | ||
| ] = [] | ||
|
|
@@ -198,9 +192,6 @@ def register_callbacks( | |
| user_may_invite: Optional[USER_MAY_INVITE_CALLBACK] = None, | ||
| user_may_send_3pid_invite: Optional[USER_MAY_SEND_3PID_INVITE_CALLBACK] = None, | ||
| user_may_create_room: Optional[USER_MAY_CREATE_ROOM_CALLBACK] = None, | ||
| user_may_create_room_with_invites: Optional[ | ||
| USER_MAY_CREATE_ROOM_WITH_INVITES_CALLBACK | ||
| ] = None, | ||
| user_may_create_room_alias: Optional[ | ||
| USER_MAY_CREATE_ROOM_ALIAS_CALLBACK | ||
| ] = None, | ||
|
|
@@ -229,11 +220,6 @@ def register_callbacks( | |
| if user_may_create_room is not None: | ||
| self._user_may_create_room_callbacks.append(user_may_create_room) | ||
|
|
||
| if user_may_create_room_with_invites is not None: | ||
| self._user_may_create_room_with_invites_callbacks.append( | ||
| user_may_create_room_with_invites, | ||
| ) | ||
|
|
||
| if user_may_create_room_alias is not None: | ||
| self._user_may_create_room_alias_callbacks.append( | ||
| user_may_create_room_alias, | ||
|
|
@@ -359,34 +345,6 @@ async def user_may_create_room(self, userid: str) -> bool: | |
|
|
||
| return True | ||
|
|
||
| async def user_may_create_room_with_invites( | ||
| self, | ||
| userid: str, | ||
| invites: List[str], | ||
| threepid_invites: List[Dict[str, str]], | ||
| ) -> bool: | ||
| """Checks if a given user may create a room with invites | ||
|
|
||
| If this method returns false, the creation request will be rejected. | ||
|
|
||
| Args: | ||
| userid: The ID of the user attempting to create a room | ||
| invites: The IDs of the Matrix users to be invited if the room creation is | ||
| allowed. | ||
| threepid_invites: The threepids to be invited if the room creation is allowed, | ||
| as a dict including a "medium" key indicating the threepid's medium (e.g. | ||
| "email") and an "address" key indicating the threepid's address (e.g. | ||
| "[email protected]") | ||
|
|
||
| Returns: | ||
| True if the user may create the room, otherwise False | ||
| """ | ||
| for callback in self._user_may_create_room_with_invites_callbacks: | ||
| if await callback(userid, invites, threepid_invites) is False: | ||
| return False | ||
|
|
||
| return True | ||
|
|
||
| async def user_may_create_room_alias( | ||
| self, userid: str, room_alias: RoomAlias | ||
| ) -> bool: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,7 +18,7 @@ | |
| """Tests REST events for /rooms paths.""" | ||
|
|
||
| import json | ||
| from typing import Dict, Iterable, List, Optional | ||
| from typing import Iterable, List | ||
| from unittest.mock import Mock, call | ||
| from urllib import parse as urlparse | ||
|
|
||
|
|
@@ -35,7 +35,7 @@ | |
| from synapse.handlers.pagination import PurgeStatus | ||
| from synapse.rest import admin | ||
| from synapse.rest.client import account, directory, login, profile, room, sync | ||
| from synapse.types import JsonDict, Requester, RoomAlias, UserID, create_requester | ||
| from synapse.types import JsonDict, RoomAlias, UserID, create_requester | ||
| from synapse.util.stringutils import random_string | ||
|
|
||
| from tests import unittest | ||
|
|
@@ -674,121 +674,6 @@ def test_post_room_invitees_ratelimit(self): | |
| channel = self.make_request("POST", "/createRoom", content) | ||
| self.assertEqual(200, channel.code) | ||
|
|
||
| def test_spamchecker_invites(self): | ||
| """Tests the user_may_create_room_with_invites spam checker callback.""" | ||
|
|
||
| # Mock do_3pid_invite, so we don't fail from failing to send a 3PID invite to an | ||
| # IS. | ||
| async def do_3pid_invite( | ||
| room_id: str, | ||
| inviter: UserID, | ||
| medium: str, | ||
| address: str, | ||
| id_server: str, | ||
| requester: Requester, | ||
| txn_id: Optional[str], | ||
| id_access_token: Optional[str] = None, | ||
| ) -> int: | ||
| return 0 | ||
|
|
||
| do_3pid_invite_mock = Mock(side_effect=do_3pid_invite) | ||
| self.hs.get_room_member_handler().do_3pid_invite = do_3pid_invite_mock | ||
|
|
||
| # Add a mock callback for user_may_create_room_with_invites. Make it allow any | ||
| # room creation request for now. | ||
| return_value = True | ||
|
|
||
| async def user_may_create_room_with_invites( | ||
| user: str, | ||
| invites: List[str], | ||
| threepid_invites: List[Dict[str, str]], | ||
| ) -> bool: | ||
| return return_value | ||
|
|
||
| callback_mock = Mock(side_effect=user_may_create_room_with_invites) | ||
| self.hs.get_spam_checker()._user_may_create_room_with_invites_callbacks.append( | ||
| callback_mock, | ||
| ) | ||
|
|
||
| # The MXIDs we'll try to invite. | ||
| invited_mxids = [ | ||
| "@alice1:red", | ||
| "@alice2:red", | ||
| "@alice3:red", | ||
| "@alice4:red", | ||
| ] | ||
|
|
||
| # The 3PIDs we'll try to invite. | ||
| invited_3pids = [ | ||
| { | ||
| "id_server": "example.com", | ||
| "id_access_token": "sometoken", | ||
| "medium": "email", | ||
| "address": "[email protected]", | ||
| }, | ||
| { | ||
| "id_server": "example.com", | ||
| "id_access_token": "sometoken", | ||
| "medium": "email", | ||
| "address": "[email protected]", | ||
| }, | ||
| { | ||
| "id_server": "example.com", | ||
| "id_access_token": "sometoken", | ||
| "medium": "email", | ||
| "address": "[email protected]", | ||
| }, | ||
| ] | ||
|
|
||
| # Create a room and invite the Matrix users, and check that it succeeded. | ||
| channel = self.make_request( | ||
| "POST", | ||
| "/createRoom", | ||
| json.dumps({"invite": invited_mxids}).encode("utf8"), | ||
| ) | ||
| self.assertEqual(200, channel.code) | ||
|
|
||
| # Check that the callback was called with the right arguments. | ||
| expected_call_args = ((self.user_id, invited_mxids, []),) | ||
| self.assertEquals( | ||
| callback_mock.call_args, | ||
| expected_call_args, | ||
| callback_mock.call_args, | ||
| ) | ||
|
|
||
| # Create a room and invite the 3PIDs, and check that it succeeded. | ||
| channel = self.make_request( | ||
| "POST", | ||
| "/createRoom", | ||
| json.dumps({"invite_3pid": invited_3pids}).encode("utf8"), | ||
| ) | ||
| self.assertEqual(200, channel.code) | ||
|
|
||
| # Check that do_3pid_invite was called the right amount of time | ||
| self.assertEquals(do_3pid_invite_mock.call_count, len(invited_3pids)) | ||
|
|
||
| # Check that the callback was called with the right arguments. | ||
| expected_call_args = ((self.user_id, [], invited_3pids),) | ||
| self.assertEquals( | ||
| callback_mock.call_args, | ||
| expected_call_args, | ||
| callback_mock.call_args, | ||
| ) | ||
|
|
||
| # Now deny any room creation. | ||
| return_value = False | ||
|
|
||
| # Create a room and invite the 3PIDs, and check that it failed. | ||
| channel = self.make_request( | ||
| "POST", | ||
| "/createRoom", | ||
| json.dumps({"invite_3pid": invited_3pids}).encode("utf8"), | ||
| ) | ||
| self.assertEqual(403, channel.code) | ||
|
|
||
| # Check that do_3pid_invite wasn't called this time. | ||
| self.assertEquals(do_3pid_invite_mock.call_count, len(invited_3pids)) | ||
|
|
||
| def test_spam_checker_may_join_room(self): | ||
| """Tests that the user_may_join_room spam checker callback is correctly bypassed | ||
| when creating a new room. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we make the parameters to
register_spam_checker_callbackskeyword only via the*flag?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could, I'd suggest opening a new issue for this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I put up a PR at #11975