mirror of
https://mau.dev/maunium/synapse.git
synced 2024-12-30 10:44:01 +01:00
e2a1adbf5d
* Declare new config * Parse new config * Read new config * Don't use trial/our TestCase where it's not needed Before: ``` $ time trial tests/events/test_utils.py > /dev/null real 0m2.277s user 0m2.186s sys 0m0.083s ``` After: ``` $ time trial tests/events/test_utils.py > /dev/null real 0m0.566s user 0m0.508s sys 0m0.056s ``` * Helper to upsert to event fields without exceeding size limits. * Use helper when adding invite/knock state Now that we allow admins to include events in prejoin room state with arbitrary state keys, be a good Matrix citizen and ensure they don't accidentally create an oversized event. * Changelog * Move StateFilter tests should have done this in #14668 * Add extra methods to StateFilter * Use StateFilter * Ensure test file enforces typed defs; alphabetise * Workaround surprising get_current_state_ids * Whoops, fix mypy
611 lines
20 KiB
Python
611 lines
20 KiB
Python
# Copyright 2015, 2016 OpenMarket Ltd
|
|
#
|
|
# 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.
|
|
|
|
import unittest as stdlib_unittest
|
|
|
|
from synapse.api.constants import EventContentFields
|
|
from synapse.api.room_versions import RoomVersions
|
|
from synapse.events import make_event_from_dict
|
|
from synapse.events.utils import (
|
|
SerializeEventConfig,
|
|
copy_and_fixup_power_levels_contents,
|
|
maybe_upsert_event_field,
|
|
prune_event,
|
|
serialize_event,
|
|
)
|
|
from synapse.util.frozenutils import freeze
|
|
|
|
|
|
def MockEvent(**kwargs):
|
|
if "event_id" not in kwargs:
|
|
kwargs["event_id"] = "fake_event_id"
|
|
if "type" not in kwargs:
|
|
kwargs["type"] = "fake_type"
|
|
return make_event_from_dict(kwargs)
|
|
|
|
|
|
class TestMaybeUpsertEventField(stdlib_unittest.TestCase):
|
|
def test_update_okay(self) -> None:
|
|
event = make_event_from_dict({"event_id": "$1234"})
|
|
success = maybe_upsert_event_field(event, event.unsigned, "key", "value")
|
|
self.assertTrue(success)
|
|
self.assertEqual(event.unsigned["key"], "value")
|
|
|
|
def test_update_not_okay(self) -> None:
|
|
event = make_event_from_dict({"event_id": "$1234"})
|
|
LARGE_STRING = "a" * 100_000
|
|
success = maybe_upsert_event_field(event, event.unsigned, "key", LARGE_STRING)
|
|
self.assertFalse(success)
|
|
self.assertNotIn("key", event.unsigned)
|
|
|
|
def test_update_not_okay_leaves_original_value(self) -> None:
|
|
event = make_event_from_dict(
|
|
{"event_id": "$1234", "unsigned": {"key": "value"}}
|
|
)
|
|
LARGE_STRING = "a" * 100_000
|
|
success = maybe_upsert_event_field(event, event.unsigned, "key", LARGE_STRING)
|
|
self.assertFalse(success)
|
|
self.assertEqual(event.unsigned["key"], "value")
|
|
|
|
|
|
class PruneEventTestCase(stdlib_unittest.TestCase):
|
|
def run_test(self, evdict, matchdict, **kwargs):
|
|
"""
|
|
Asserts that a new event constructed with `evdict` will look like
|
|
`matchdict` when it is redacted.
|
|
|
|
Args:
|
|
evdict: The dictionary to build the event from.
|
|
matchdict: The expected resulting dictionary.
|
|
kwargs: Additional keyword arguments used to create the event.
|
|
"""
|
|
self.assertEqual(
|
|
prune_event(make_event_from_dict(evdict, **kwargs)).get_dict(), matchdict
|
|
)
|
|
|
|
def test_minimal(self):
|
|
self.run_test(
|
|
{"type": "A", "event_id": "$test:domain"},
|
|
{
|
|
"type": "A",
|
|
"event_id": "$test:domain",
|
|
"content": {},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
)
|
|
|
|
def test_basic_keys(self):
|
|
"""Ensure that the keys that should be untouched are kept."""
|
|
# Note that some of the values below don't really make sense, but the
|
|
# pruning of events doesn't worry about the values of any fields (with
|
|
# the exception of the content field).
|
|
self.run_test(
|
|
{
|
|
"event_id": "$3:domain",
|
|
"type": "A",
|
|
"room_id": "!1:domain",
|
|
"sender": "@2:domain",
|
|
"state_key": "B",
|
|
"content": {"other_key": "foo"},
|
|
"hashes": "hashes",
|
|
"signatures": {"domain": {"algo:1": "sigs"}},
|
|
"depth": 4,
|
|
"prev_events": "prev_events",
|
|
"prev_state": "prev_state",
|
|
"auth_events": "auth_events",
|
|
"origin": "domain",
|
|
"origin_server_ts": 1234,
|
|
"membership": "join",
|
|
# Also include a key that should be removed.
|
|
"other_key": "foo",
|
|
},
|
|
{
|
|
"event_id": "$3:domain",
|
|
"type": "A",
|
|
"room_id": "!1:domain",
|
|
"sender": "@2:domain",
|
|
"state_key": "B",
|
|
"hashes": "hashes",
|
|
"depth": 4,
|
|
"prev_events": "prev_events",
|
|
"prev_state": "prev_state",
|
|
"auth_events": "auth_events",
|
|
"origin": "domain",
|
|
"origin_server_ts": 1234,
|
|
"membership": "join",
|
|
"content": {},
|
|
"signatures": {"domain": {"algo:1": "sigs"}},
|
|
"unsigned": {},
|
|
},
|
|
)
|
|
|
|
# As of MSC2176 we now redact the membership and prev_states keys.
|
|
self.run_test(
|
|
{"type": "A", "prev_state": "prev_state", "membership": "join"},
|
|
{"type": "A", "content": {}, "signatures": {}, "unsigned": {}},
|
|
room_version=RoomVersions.MSC2176,
|
|
)
|
|
|
|
def test_unsigned(self):
|
|
"""Ensure that unsigned properties get stripped (except age_ts and replaces_state)."""
|
|
self.run_test(
|
|
{
|
|
"type": "B",
|
|
"event_id": "$test:domain",
|
|
"unsigned": {
|
|
"age_ts": 20,
|
|
"replaces_state": "$test2:domain",
|
|
"other_key": "foo",
|
|
},
|
|
},
|
|
{
|
|
"type": "B",
|
|
"event_id": "$test:domain",
|
|
"content": {},
|
|
"signatures": {},
|
|
"unsigned": {"age_ts": 20, "replaces_state": "$test2:domain"},
|
|
},
|
|
)
|
|
|
|
def test_content(self):
|
|
"""The content dictionary should be stripped in most cases."""
|
|
self.run_test(
|
|
{"type": "C", "event_id": "$test:domain", "content": {"things": "here"}},
|
|
{
|
|
"type": "C",
|
|
"event_id": "$test:domain",
|
|
"content": {},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
)
|
|
|
|
# Some events keep a single content key/value.
|
|
EVENT_KEEP_CONTENT_KEYS = [
|
|
("member", "membership", "join"),
|
|
("join_rules", "join_rule", "invite"),
|
|
("history_visibility", "history_visibility", "shared"),
|
|
]
|
|
for event_type, key, value in EVENT_KEEP_CONTENT_KEYS:
|
|
self.run_test(
|
|
{
|
|
"type": "m.room." + event_type,
|
|
"event_id": "$test:domain",
|
|
"content": {key: value, "other_key": "foo"},
|
|
},
|
|
{
|
|
"type": "m.room." + event_type,
|
|
"event_id": "$test:domain",
|
|
"content": {key: value},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
)
|
|
|
|
def test_create(self):
|
|
"""Create events are partially redacted until MSC2176."""
|
|
self.run_test(
|
|
{
|
|
"type": "m.room.create",
|
|
"event_id": "$test:domain",
|
|
"content": {"creator": "@2:domain", "other_key": "foo"},
|
|
},
|
|
{
|
|
"type": "m.room.create",
|
|
"event_id": "$test:domain",
|
|
"content": {"creator": "@2:domain"},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
)
|
|
|
|
# After MSC2176, create events get nothing redacted.
|
|
self.run_test(
|
|
{"type": "m.room.create", "content": {"not_a_real_key": True}},
|
|
{
|
|
"type": "m.room.create",
|
|
"content": {"not_a_real_key": True},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
room_version=RoomVersions.MSC2176,
|
|
)
|
|
|
|
def test_power_levels(self):
|
|
"""Power level events keep a variety of content keys."""
|
|
self.run_test(
|
|
{
|
|
"type": "m.room.power_levels",
|
|
"event_id": "$test:domain",
|
|
"content": {
|
|
"ban": 1,
|
|
"events": {"m.room.name": 100},
|
|
"events_default": 2,
|
|
"invite": 3,
|
|
"kick": 4,
|
|
"redact": 5,
|
|
"state_default": 6,
|
|
"users": {"@admin:domain": 100},
|
|
"users_default": 7,
|
|
"other_key": 8,
|
|
},
|
|
},
|
|
{
|
|
"type": "m.room.power_levels",
|
|
"event_id": "$test:domain",
|
|
"content": {
|
|
"ban": 1,
|
|
"events": {"m.room.name": 100},
|
|
"events_default": 2,
|
|
# Note that invite is not here.
|
|
"kick": 4,
|
|
"redact": 5,
|
|
"state_default": 6,
|
|
"users": {"@admin:domain": 100},
|
|
"users_default": 7,
|
|
},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
)
|
|
|
|
# After MSC2176, power levels events keep the invite key.
|
|
self.run_test(
|
|
{"type": "m.room.power_levels", "content": {"invite": 75}},
|
|
{
|
|
"type": "m.room.power_levels",
|
|
"content": {"invite": 75},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
room_version=RoomVersions.MSC2176,
|
|
)
|
|
|
|
def test_alias_event(self):
|
|
"""Alias events have special behavior up through room version 6."""
|
|
self.run_test(
|
|
{
|
|
"type": "m.room.aliases",
|
|
"event_id": "$test:domain",
|
|
"content": {"aliases": ["test"]},
|
|
},
|
|
{
|
|
"type": "m.room.aliases",
|
|
"event_id": "$test:domain",
|
|
"content": {"aliases": ["test"]},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
)
|
|
|
|
# After MSC2432, alias events have no special behavior.
|
|
self.run_test(
|
|
{"type": "m.room.aliases", "content": {"aliases": ["test"]}},
|
|
{
|
|
"type": "m.room.aliases",
|
|
"content": {},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
room_version=RoomVersions.V6,
|
|
)
|
|
|
|
def test_redacts(self):
|
|
"""Redaction events have no special behaviour until MSC2174/MSC2176."""
|
|
|
|
self.run_test(
|
|
{"type": "m.room.redaction", "content": {"redacts": "$test2:domain"}},
|
|
{
|
|
"type": "m.room.redaction",
|
|
"content": {},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
room_version=RoomVersions.V6,
|
|
)
|
|
|
|
# After MSC2174, redaction events keep the redacts content key.
|
|
self.run_test(
|
|
{"type": "m.room.redaction", "content": {"redacts": "$test2:domain"}},
|
|
{
|
|
"type": "m.room.redaction",
|
|
"content": {"redacts": "$test2:domain"},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
room_version=RoomVersions.MSC2176,
|
|
)
|
|
|
|
def test_join_rules(self):
|
|
"""Join rules events have changed behavior starting with MSC3083."""
|
|
self.run_test(
|
|
{
|
|
"type": "m.room.join_rules",
|
|
"event_id": "$test:domain",
|
|
"content": {
|
|
"join_rule": "invite",
|
|
"allow": [],
|
|
"other_key": "stripped",
|
|
},
|
|
},
|
|
{
|
|
"type": "m.room.join_rules",
|
|
"event_id": "$test:domain",
|
|
"content": {"join_rule": "invite"},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
)
|
|
|
|
# After MSC3083, the allow key is protected from redaction.
|
|
self.run_test(
|
|
{
|
|
"type": "m.room.join_rules",
|
|
"content": {
|
|
"join_rule": "invite",
|
|
"allow": [],
|
|
"other_key": "stripped",
|
|
},
|
|
},
|
|
{
|
|
"type": "m.room.join_rules",
|
|
"content": {
|
|
"join_rule": "invite",
|
|
"allow": [],
|
|
},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
room_version=RoomVersions.V8,
|
|
)
|
|
|
|
def test_member(self):
|
|
"""Member events have changed behavior starting with MSC3375."""
|
|
self.run_test(
|
|
{
|
|
"type": "m.room.member",
|
|
"event_id": "$test:domain",
|
|
"content": {
|
|
"membership": "join",
|
|
EventContentFields.AUTHORISING_USER: "@user:domain",
|
|
"other_key": "stripped",
|
|
},
|
|
},
|
|
{
|
|
"type": "m.room.member",
|
|
"event_id": "$test:domain",
|
|
"content": {"membership": "join"},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
)
|
|
|
|
# After MSC3375, the join_authorised_via_users_server key is protected
|
|
# from redaction.
|
|
self.run_test(
|
|
{
|
|
"type": "m.room.member",
|
|
"content": {
|
|
"membership": "join",
|
|
EventContentFields.AUTHORISING_USER: "@user:domain",
|
|
"other_key": "stripped",
|
|
},
|
|
},
|
|
{
|
|
"type": "m.room.member",
|
|
"content": {
|
|
"membership": "join",
|
|
EventContentFields.AUTHORISING_USER: "@user:domain",
|
|
},
|
|
"signatures": {},
|
|
"unsigned": {},
|
|
},
|
|
room_version=RoomVersions.V9,
|
|
)
|
|
|
|
|
|
class SerializeEventTestCase(stdlib_unittest.TestCase):
|
|
def serialize(self, ev, fields):
|
|
return serialize_event(
|
|
ev, 1479807801915, config=SerializeEventConfig(only_event_fields=fields)
|
|
)
|
|
|
|
def test_event_fields_works_with_keys(self):
|
|
self.assertEqual(
|
|
self.serialize(
|
|
MockEvent(sender="@alice:localhost", room_id="!foo:bar"), ["room_id"]
|
|
),
|
|
{"room_id": "!foo:bar"},
|
|
)
|
|
|
|
def test_event_fields_works_with_nested_keys(self):
|
|
self.assertEqual(
|
|
self.serialize(
|
|
MockEvent(
|
|
sender="@alice:localhost",
|
|
room_id="!foo:bar",
|
|
content={"body": "A message"},
|
|
),
|
|
["content.body"],
|
|
),
|
|
{"content": {"body": "A message"}},
|
|
)
|
|
|
|
def test_event_fields_works_with_dot_keys(self):
|
|
self.assertEqual(
|
|
self.serialize(
|
|
MockEvent(
|
|
sender="@alice:localhost",
|
|
room_id="!foo:bar",
|
|
content={"key.with.dots": {}},
|
|
),
|
|
[r"content.key\.with\.dots"],
|
|
),
|
|
{"content": {"key.with.dots": {}}},
|
|
)
|
|
|
|
def test_event_fields_works_with_nested_dot_keys(self):
|
|
self.assertEqual(
|
|
self.serialize(
|
|
MockEvent(
|
|
sender="@alice:localhost",
|
|
room_id="!foo:bar",
|
|
content={
|
|
"not_me": 1,
|
|
"nested.dot.key": {"leaf.key": 42, "not_me_either": 1},
|
|
},
|
|
),
|
|
[r"content.nested\.dot\.key.leaf\.key"],
|
|
),
|
|
{"content": {"nested.dot.key": {"leaf.key": 42}}},
|
|
)
|
|
|
|
def test_event_fields_nops_with_unknown_keys(self):
|
|
self.assertEqual(
|
|
self.serialize(
|
|
MockEvent(
|
|
sender="@alice:localhost",
|
|
room_id="!foo:bar",
|
|
content={"foo": "bar"},
|
|
),
|
|
["content.foo", "content.notexists"],
|
|
),
|
|
{"content": {"foo": "bar"}},
|
|
)
|
|
|
|
def test_event_fields_nops_with_non_dict_keys(self):
|
|
self.assertEqual(
|
|
self.serialize(
|
|
MockEvent(
|
|
sender="@alice:localhost",
|
|
room_id="!foo:bar",
|
|
content={"foo": ["I", "am", "an", "array"]},
|
|
),
|
|
["content.foo.am"],
|
|
),
|
|
{},
|
|
)
|
|
|
|
def test_event_fields_nops_with_array_keys(self):
|
|
self.assertEqual(
|
|
self.serialize(
|
|
MockEvent(
|
|
sender="@alice:localhost",
|
|
room_id="!foo:bar",
|
|
content={"foo": ["I", "am", "an", "array"]},
|
|
),
|
|
["content.foo.1"],
|
|
),
|
|
{},
|
|
)
|
|
|
|
def test_event_fields_all_fields_if_empty(self):
|
|
self.assertEqual(
|
|
self.serialize(
|
|
MockEvent(
|
|
type="foo",
|
|
event_id="test",
|
|
room_id="!foo:bar",
|
|
content={"foo": "bar"},
|
|
),
|
|
[],
|
|
),
|
|
{
|
|
"type": "foo",
|
|
"event_id": "test",
|
|
"room_id": "!foo:bar",
|
|
"content": {"foo": "bar"},
|
|
"unsigned": {},
|
|
},
|
|
)
|
|
|
|
def test_event_fields_fail_if_fields_not_str(self):
|
|
with self.assertRaises(TypeError):
|
|
self.serialize(
|
|
MockEvent(room_id="!foo:bar", content={"foo": "bar"}), ["room_id", 4]
|
|
)
|
|
|
|
|
|
class CopyPowerLevelsContentTestCase(stdlib_unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self.test_content = {
|
|
"ban": 50,
|
|
"events": {"m.room.name": 100, "m.room.power_levels": 100},
|
|
"events_default": 0,
|
|
"invite": 50,
|
|
"kick": 50,
|
|
"notifications": {"room": 20},
|
|
"redact": 50,
|
|
"state_default": 50,
|
|
"users": {"@example:localhost": 100},
|
|
"users_default": 0,
|
|
}
|
|
|
|
def _test(self, input):
|
|
a = copy_and_fixup_power_levels_contents(input)
|
|
|
|
self.assertEqual(a["ban"], 50)
|
|
self.assertEqual(a["events"]["m.room.name"], 100)
|
|
|
|
# make sure that changing the copy changes the copy and not the orig
|
|
a["ban"] = 10
|
|
a["events"]["m.room.power_levels"] = 20
|
|
|
|
self.assertEqual(input["ban"], 50)
|
|
self.assertEqual(input["events"]["m.room.power_levels"], 100)
|
|
|
|
def test_unfrozen(self):
|
|
self._test(self.test_content)
|
|
|
|
def test_frozen(self):
|
|
input = freeze(self.test_content)
|
|
self._test(input)
|
|
|
|
def test_stringy_integers(self):
|
|
"""String representations of decimal integers are converted to integers."""
|
|
input = {
|
|
"a": "100",
|
|
"b": {
|
|
"foo": 99,
|
|
"bar": "-98",
|
|
},
|
|
"d": "0999",
|
|
}
|
|
output = copy_and_fixup_power_levels_contents(input)
|
|
expected_output = {
|
|
"a": 100,
|
|
"b": {
|
|
"foo": 99,
|
|
"bar": -98,
|
|
},
|
|
"d": 999,
|
|
}
|
|
|
|
self.assertEqual(output, expected_output)
|
|
|
|
def test_strings_that_dont_represent_decimal_integers(self) -> None:
|
|
"""Should raise when given inputs `s` for which `int(s, base=10)` raises."""
|
|
for invalid_string in ["0x123", "123.0", "123.45", "hello", "0b1", "0o777"]:
|
|
with self.assertRaises(TypeError):
|
|
copy_and_fixup_power_levels_contents({"a": invalid_string})
|
|
|
|
def test_invalid_types_raise_type_error(self) -> None:
|
|
with self.assertRaises(TypeError):
|
|
copy_and_fixup_power_levels_contents({"a": ["hello", "grandma"]}) # type: ignore[arg-type]
|
|
copy_and_fixup_power_levels_contents({"a": None}) # type: ignore[arg-type]
|
|
|
|
def test_invalid_nesting_raises_type_error(self) -> None:
|
|
with self.assertRaises(TypeError):
|
|
copy_and_fixup_power_levels_contents({"a": {"b": {"c": 1}}})
|