mirror of
https://github.com/element-hq/synapse.git
synced 2026-11-12 09:58:24 +00:00
Johannes Marbach
25492acda3
This stabilizes the implementation of https://github.com/matrix-org/matrix-spec-proposals/pull/4143 which includes the following: - Stable `/rtc/transports` as per https://github.com/matrix-org/matrix-spec-proposals/pull/4143 and https://github.com/matrix-org/matrix-spec-proposals/pull/4195. The unstable endpoint is retained for backwards compatibility. - Adding `m.rtc.slot` events to the state events retained during room upgrades. ### Pull Request Checklist <!-- Please read https://element-hq.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request --> * [x] Pull request is based on the develop branch * [x] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. * [x] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
320 lines
12 KiB
Python
320 lines
12 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright (C) 2025 New Vector, Ltd
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# See the GNU Affero General Public License for more details:
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
#
|
|
# [This file includes modifications made by New Vector Limited]
|
|
#
|
|
#
|
|
|
|
"""Tests REST events for /rtc/transports and RTC config parsing and /versions setup."""
|
|
|
|
import unittest as stdlib_unittest
|
|
|
|
from pydantic import ValidationError
|
|
|
|
from twisted.internet.testing import MemoryReactor
|
|
|
|
from synapse.config.matrixrtc import TransportConfigModel
|
|
from synapse.rest import admin
|
|
from synapse.rest.client import login, matrixrtc, register, room, versions
|
|
from synapse.server import HomeServer
|
|
from synapse.util.clock import Clock
|
|
|
|
from tests import unittest
|
|
from tests.unittest import HomeserverTestCase, override_config
|
|
|
|
PATH_PREFIX = "/_matrix/client/unstable/org.matrix.msc4143"
|
|
STABLE_PATH = "/_matrix/client/v1/rtc/transports"
|
|
RTC_ENDPOINT = {"type": "focusA", "required_field": "theField"}
|
|
LIVEKIT_TRANSPORT = {
|
|
"type": "livekit",
|
|
"url": "wss://livekit.example.com",
|
|
}
|
|
BACKWARDS_COMPATIBLE_LIVEKIT_TRANSPORT = {
|
|
"type": "livekit",
|
|
"url": "wss://livekit.example.com",
|
|
"livekit_service_url": "https://livekit.example.com",
|
|
}
|
|
LEGACY_LIVEKIT_TRANSPORT = {
|
|
"type": "livekit",
|
|
"livekit_service_url": "https://livekit.example.com",
|
|
}
|
|
STABLE_LIVEKIT_TRANSPORT = {
|
|
"type": "m.livekit",
|
|
"url": "wss://livekit.example.com",
|
|
}
|
|
|
|
|
|
class MatrixRtcTestCase(HomeserverTestCase):
|
|
"""Tests the unstable /rtc/transports Client-Server REST API."""
|
|
|
|
servlets = [
|
|
admin.register_servlets,
|
|
room.register_servlets,
|
|
login.register_servlets,
|
|
register.register_servlets,
|
|
matrixrtc.register_servlets,
|
|
]
|
|
|
|
def prepare(
|
|
self, reactor: MemoryReactor, clock: Clock, homeserver: HomeServer
|
|
) -> None:
|
|
self.register_user("alice", "password")
|
|
self._alice_tok = self.login("alice", "password")
|
|
|
|
def test_matrixrtc_endpoint_not_enabled(self) -> None:
|
|
channel = self.make_request(
|
|
"GET", f"{PATH_PREFIX}/rtc/transports", access_token=self._alice_tok
|
|
)
|
|
self.assertEqual(404, channel.code, channel.json_body)
|
|
self.assertEqual(
|
|
"M_UNRECOGNIZED", channel.json_body["errcode"], channel.json_body
|
|
)
|
|
|
|
@override_config({"experimental_features": {"msc4143_enabled": True}})
|
|
def test_matrixrtc_endpoint_requires_authentication(self) -> None:
|
|
channel = self.make_request("GET", f"{PATH_PREFIX}/rtc/transports")
|
|
self.assertEqual(401, channel.code, channel.json_body)
|
|
|
|
@override_config(
|
|
{
|
|
"experimental_features": {"msc4143_enabled": True},
|
|
"matrix_rtc": {"transports": [RTC_ENDPOINT]},
|
|
}
|
|
)
|
|
def test_matrixrtc_endpoint_contains_expected_transport(self) -> None:
|
|
channel = self.make_request(
|
|
"GET", f"{PATH_PREFIX}/rtc/transports", access_token=self._alice_tok
|
|
)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assert_dict({"rtc_transports": [RTC_ENDPOINT]}, channel.json_body)
|
|
|
|
@override_config(
|
|
{
|
|
"experimental_features": {"msc4143_enabled": True},
|
|
"matrix_rtc": {"transports": []},
|
|
}
|
|
)
|
|
def test_matrixrtc_endpoint_no_transports_configured(self) -> None:
|
|
channel = self.make_request(
|
|
"GET", f"{PATH_PREFIX}/rtc/transports", access_token=self._alice_tok
|
|
)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assert_dict({}, channel.json_body)
|
|
|
|
@override_config(
|
|
{
|
|
"experimental_features": {"msc4143_enabled": True},
|
|
"matrix_rtc": {"transports": [LIVEKIT_TRANSPORT]},
|
|
}
|
|
)
|
|
def test_matrixrtc_endpoint_livekit_transport(self) -> None:
|
|
channel = self.make_request(
|
|
"GET", f"{PATH_PREFIX}/rtc/transports", access_token=self._alice_tok
|
|
)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assert_dict({"rtc_transports": [LIVEKIT_TRANSPORT]}, channel.json_body)
|
|
|
|
@override_config(
|
|
{
|
|
"experimental_features": {"msc4143_enabled": True},
|
|
"matrix_rtc": {"transports": [BACKWARDS_COMPATIBLE_LIVEKIT_TRANSPORT]},
|
|
}
|
|
)
|
|
def test_matrixrtc_endpoint_backwards_compatible_livekit_transport(self) -> None:
|
|
channel = self.make_request(
|
|
"GET", f"{PATH_PREFIX}/rtc/transports", access_token=self._alice_tok
|
|
)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assert_dict(
|
|
{"rtc_transports": [BACKWARDS_COMPATIBLE_LIVEKIT_TRANSPORT]},
|
|
channel.json_body,
|
|
)
|
|
|
|
@override_config(
|
|
{
|
|
"experimental_features": {"msc4143_enabled": True},
|
|
"matrix_rtc": {"transports": [LEGACY_LIVEKIT_TRANSPORT]},
|
|
}
|
|
)
|
|
def test_matrixrtc_endpoint_legacy_livekit_transport(self) -> None:
|
|
channel = self.make_request(
|
|
"GET", f"{PATH_PREFIX}/rtc/transports", access_token=self._alice_tok
|
|
)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assert_dict(
|
|
{"rtc_transports": [LEGACY_LIVEKIT_TRANSPORT]}, channel.json_body
|
|
)
|
|
|
|
|
|
class StableMatrixRtcTestCase(HomeserverTestCase):
|
|
"""Tests the stable /rtc/transports Client-Server REST API."""
|
|
|
|
servlets = [
|
|
admin.register_servlets,
|
|
room.register_servlets,
|
|
login.register_servlets,
|
|
register.register_servlets,
|
|
matrixrtc.register_servlets,
|
|
]
|
|
|
|
def prepare(
|
|
self, reactor: MemoryReactor, clock: Clock, homeserver: HomeServer
|
|
) -> None:
|
|
self.register_user("alice", "password")
|
|
self._alice_tok = self.login("alice", "password")
|
|
|
|
def test_matrixrtc_endpoint_enabled_by_default(self) -> None:
|
|
channel = self.make_request("GET", STABLE_PATH, access_token=self._alice_tok)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assertEqual({"transports": []}, channel.json_body)
|
|
|
|
def test_matrixrtc_endpoint_requires_authentication(self) -> None:
|
|
channel = self.make_request("GET", STABLE_PATH)
|
|
self.assertEqual(401, channel.code, channel.json_body)
|
|
|
|
@override_config({"allow_guest_access": True})
|
|
def test_matrixrtc_endpoint_allows_guests(self) -> None:
|
|
channel = self.make_request("POST", "/register?kind=guest", {})
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
guest_tok = channel.json_body["access_token"]
|
|
|
|
channel = self.make_request("GET", STABLE_PATH, access_token=guest_tok)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
|
|
@override_config({"matrix_rtc": {"transports": [RTC_ENDPOINT]}})
|
|
def test_matrixrtc_endpoint_contains_expected_transport(self) -> None:
|
|
channel = self.make_request("GET", STABLE_PATH, access_token=self._alice_tok)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assertEqual({"transports": [RTC_ENDPOINT]}, channel.json_body)
|
|
|
|
@override_config({"matrix_rtc": {"transports": [STABLE_LIVEKIT_TRANSPORT]}})
|
|
def test_matrixrtc_endpoint_stable_livekit_transport(self) -> None:
|
|
channel = self.make_request("GET", STABLE_PATH, access_token=self._alice_tok)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assertEqual({"transports": [STABLE_LIVEKIT_TRANSPORT]}, channel.json_body)
|
|
|
|
@override_config(
|
|
{"matrix_rtc": {"transports": [BACKWARDS_COMPATIBLE_LIVEKIT_TRANSPORT]}}
|
|
)
|
|
def test_matrixrtc_endpoint_unstable_livekit_transport(self) -> None:
|
|
channel = self.make_request("GET", STABLE_PATH, access_token=self._alice_tok)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assertEqual(
|
|
{"transports": [BACKWARDS_COMPATIBLE_LIVEKIT_TRANSPORT]},
|
|
channel.json_body,
|
|
)
|
|
|
|
@override_config(
|
|
{
|
|
"experimental_features": {"msc4143_enabled": True},
|
|
"matrix_rtc": {
|
|
"transports": [
|
|
STABLE_LIVEKIT_TRANSPORT,
|
|
BACKWARDS_COMPATIBLE_LIVEKIT_TRANSPORT,
|
|
RTC_ENDPOINT,
|
|
]
|
|
},
|
|
}
|
|
)
|
|
def test_matrixrtc_stable_and_unstable_endpoints_coexist(self) -> None:
|
|
"""Both endpoints return all configured transports."""
|
|
transports = [
|
|
STABLE_LIVEKIT_TRANSPORT,
|
|
BACKWARDS_COMPATIBLE_LIVEKIT_TRANSPORT,
|
|
RTC_ENDPOINT,
|
|
]
|
|
|
|
channel = self.make_request("GET", STABLE_PATH, access_token=self._alice_tok)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assertEqual({"transports": transports}, channel.json_body)
|
|
|
|
channel = self.make_request(
|
|
"GET", f"{PATH_PREFIX}/rtc/transports", access_token=self._alice_tok
|
|
)
|
|
self.assertEqual(200, channel.code, channel.json_body)
|
|
self.assertEqual({"rtc_transports": transports}, channel.json_body)
|
|
|
|
|
|
class MatrixRtcVersionsTestCase(HomeserverTestCase):
|
|
"""Tests that org.matrix.msc4143 is correctly advertised in /versions."""
|
|
|
|
servlets = [versions.register_servlets]
|
|
|
|
def tearDown(self) -> None:
|
|
# MemoryReactor doesn't trigger the shutdown phases, and we want the
|
|
# Tokio thread pool to be stopped
|
|
# XXX: This logic should probably get moved somewhere else
|
|
shutdown_triggers = self.reactor.triggers.get("shutdown", {})
|
|
for phase in ["before", "during", "after"]:
|
|
triggers = shutdown_triggers.get(phase, [])
|
|
for callbable, args, kwargs in triggers:
|
|
callbable(*args, **kwargs)
|
|
|
|
def test_msc4143_false_by_default(self) -> None:
|
|
channel = self.make_request("GET", "/_matrix/client/versions")
|
|
self.assertEqual(channel.code, 200, channel.result)
|
|
self.assertFalse(channel.json_body["unstable_features"]["org.matrix.msc4143"])
|
|
|
|
@unittest.override_config({"experimental_features": {"msc4143_enabled": True}})
|
|
def test_msc4143_true_if_enabled(self) -> None:
|
|
channel = self.make_request("GET", "/_matrix/client/versions")
|
|
self.assertEqual(channel.code, 200, channel.result)
|
|
self.assertTrue(channel.json_body["unstable_features"]["org.matrix.msc4143"])
|
|
|
|
def test_msc4143_stable_true_by_default(self) -> None:
|
|
channel = self.make_request("GET", "/_matrix/client/versions")
|
|
self.assertEqual(channel.code, 200, channel.result)
|
|
self.assertTrue(
|
|
channel.json_body["unstable_features"]["org.matrix.msc4143.stable"]
|
|
)
|
|
|
|
|
|
class TransportConfigModelTestCase(stdlib_unittest.TestCase):
|
|
"""Tests validation of the `TransportConfigModel` pydantic model."""
|
|
|
|
def test_livekit_transport_requires_url_or_livekit_service_url(self) -> None:
|
|
with self.assertRaises(ValidationError):
|
|
TransportConfigModel(type="livekit")
|
|
|
|
def test_livekit_transport_with_only_url(self) -> None:
|
|
TransportConfigModel(type="livekit", url="wss://livekit.example.com")
|
|
|
|
def test_livekit_transport_with_only_livekit_service_url(self) -> None:
|
|
TransportConfigModel(
|
|
type="livekit", livekit_service_url="https://livekit.example.com"
|
|
)
|
|
|
|
def test_invalid_field_type(self) -> None:
|
|
with self.assertRaises(ValidationError):
|
|
TransportConfigModel(type="livekit", url=1234) # type: ignore[arg-type]
|
|
|
|
def test_stable_livekit_transport_requires_url(self) -> None:
|
|
with self.assertRaises(ValidationError):
|
|
TransportConfigModel(type="m.livekit")
|
|
|
|
def test_stable_livekit_transport_with_url(self) -> None:
|
|
TransportConfigModel(type="m.livekit", url="wss://livekit.example.com")
|
|
|
|
def test_stable_livekit_transport_with_livekit_service_url(self) -> None:
|
|
TransportConfigModel(
|
|
type="m.livekit",
|
|
url="wss://livekit.example.com",
|
|
livekit_service_url="https://livekit.example.com",
|
|
)
|
|
|
|
def test_stable_livekit_transport_with_only_livekit_service_url(self) -> None:
|
|
with self.assertRaises(ValidationError):
|
|
TransportConfigModel(
|
|
type="m.livekit", livekit_service_url="https://livekit.example.com"
|
|
)
|