This repository has been 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
Handle missing data in power levels events during room upgrade. #9395
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 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 @@ | ||
Fix a long-standing bug when upgrading a room: "TypeError: '>' not supported between instances of 'NoneType' and 'int'". |
This file contains 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 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,153 @@ | ||
# -*- coding: utf-8 -*- | ||
# Copyright 2021 The Matrix.org Foundation C.I.C. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
from typing import Optional | ||
|
||
from synapse.config.server import DEFAULT_ROOM_VERSION | ||
from synapse.rest import admin | ||
from synapse.rest.client.v1 import login, room | ||
from synapse.rest.client.v2_alpha import room_upgrade_rest_servlet | ||
|
||
from tests import unittest | ||
from tests.server import FakeChannel | ||
|
||
|
||
class UpgradeRoomTest(unittest.HomeserverTestCase): | ||
servlets = [ | ||
admin.register_servlets, | ||
login.register_servlets, | ||
room.register_servlets, | ||
room_upgrade_rest_servlet.register_servlets, | ||
] | ||
|
||
def prepare(self, reactor, clock, hs): | ||
self.store = hs.get_datastore() | ||
self.handler = hs.get_user_directory_handler() | ||
|
||
self.creator = self.register_user("creator", "pass") | ||
self.creator_token = self.login(self.creator, "pass") | ||
|
||
self.other = self.register_user("user", "pass") | ||
self.other_token = self.login(self.other, "pass") | ||
|
||
self.room_id = self.helper.create_room_as(self.creator, tok=self.creator_token) | ||
self.helper.join(self.room_id, self.other, tok=self.other_token) | ||
|
||
def _upgrade_room(self, token: Optional[str] = None) -> FakeChannel: | ||
# We never want a cached response. | ||
self.reactor.advance(5 * 60 + 1) | ||
|
||
return self.make_request( | ||
"POST", | ||
"/_matrix/client/r0/rooms/%s/upgrade" % self.room_id, | ||
# This will upgrade a room to the same version, but that's fine. | ||
content={"new_version": DEFAULT_ROOM_VERSION}, | ||
access_token=token or self.creator_token, | ||
) | ||
|
||
def test_upgrade(self): | ||
""" | ||
Upgrading a room should work fine. | ||
""" | ||
channel = self._upgrade_room() | ||
self.assertEquals(200, channel.code, channel.result) | ||
self.assertIn("replacement_room", channel.json_body) | ||
|
||
def test_not_in_room(self): | ||
""" | ||
Upgrading a room should work fine. | ||
""" | ||
# THe user isn't in the room. | ||
roomless = self.register_user("roomless", "pass") | ||
roomless_token = self.login(roomless, "pass") | ||
|
||
channel = self._upgrade_room(roomless_token) | ||
self.assertEquals(403, channel.code, channel.result) | ||
|
||
def test_power_levels(self): | ||
""" | ||
Another user can upgrade the room if their power level is increased. | ||
""" | ||
# The other user doesn't have the proper power level. | ||
channel = self._upgrade_room(self.other_token) | ||
self.assertEquals(403, channel.code, channel.result) | ||
|
||
# Increase the power levels so that this user can upgrade. | ||
power_levels = self.helper.get_state( | ||
self.room_id, "m.room.power_levels", tok=self.creator_token, | ||
) | ||
power_levels["users"][self.other] = 100 | ||
self.helper.send_state( | ||
self.room_id, | ||
"m.room.power_levels", | ||
body=power_levels, | ||
tok=self.creator_token, | ||
) | ||
|
||
# The upgrade should succeed! | ||
channel = self._upgrade_room(self.other_token) | ||
self.assertEquals(200, channel.code, channel.result) | ||
|
||
def test_power_levels_user_default(self): | ||
""" | ||
Another user can upgrade the room if the default power level for users is increased. | ||
""" | ||
# The other user doesn't have the proper power level. | ||
channel = self._upgrade_room(self.other_token) | ||
self.assertEquals(403, channel.code, channel.result) | ||
|
||
# Increase the power levels so that this user can upgrade. | ||
power_levels = self.helper.get_state( | ||
self.room_id, "m.room.power_levels", tok=self.creator_token, | ||
) | ||
power_levels["users_default"] = 100 | ||
self.helper.send_state( | ||
self.room_id, | ||
"m.room.power_levels", | ||
body=power_levels, | ||
tok=self.creator_token, | ||
) | ||
|
||
# The upgrade should succeed! | ||
channel = self._upgrade_room(self.other_token) | ||
self.assertEquals(200, channel.code, channel.result) | ||
|
||
def test_power_levels_tombstone(self): | ||
""" | ||
Another user can upgrade the room if they can send the tombstone event. | ||
""" | ||
# The other user doesn't have the proper power level. | ||
channel = self._upgrade_room(self.other_token) | ||
self.assertEquals(403, channel.code, channel.result) | ||
|
||
# Increase the power levels so that this user can upgrade. | ||
power_levels = self.helper.get_state( | ||
self.room_id, "m.room.power_levels", tok=self.creator_token, | ||
) | ||
power_levels["events"]["m.room.tombstone"] = 0 | ||
self.helper.send_state( | ||
self.room_id, | ||
"m.room.power_levels", | ||
body=power_levels, | ||
tok=self.creator_token, | ||
) | ||
|
||
# The upgrade should succeed! | ||
channel = self._upgrade_room(self.other_token) | ||
self.assertEquals(200, channel.code, channel.result) | ||
|
||
power_levels = self.helper.get_state( | ||
self.room_id, "m.room.power_levels", tok=self.creator_token, | ||
) | ||
self.assertNotIn(self.other, power_levels["users"]) |
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.
Heads up we do have room upgrade tests in SyTest already, some of which attempt to test weird power level configurations: matrix-org/sytest#777
But yay for more tests (and understandable if you'd rather not write perl)!
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.
Well, those sytests don't seem to catch this case. I don't know if it makes sense to add these as sytests or unit tests, but I couldn't find any unit tests for room upgrade, which seems bad.
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'll try to add some, but Perl is fighting my at the moment!