mirror of
https://github.com/element-hq/synapse.git
synced 2026-04-05 07:36:20 +00:00
ac26cfac83
--- Summary: Synapse Twisted → asyncio Migration What's been built (Phases 0-7) — 10 new files, ~3200 lines, 96 tests Every Twisted component has an asyncio-native replacement ready: ┌──────────────────┬───────────────────────────────────────────────┬─────────────────────────────────────────────────────────┬───────────────────────────────────────────────┐ │ Component │ Twisted Original │ asyncio Replacement │ File │ ├──────────────────┼───────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────────┤ │ LoggingContext │ threading.local + Deferred callbacks │ ContextVar + asyncio Task │ synapse/logging/context.py (native functions) │ ├──────────────────┼───────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────────┤ │ Async primitives │ ObservableDeferred, Linearizer, ReadWriteLock │ ObservableFuture, NativeLinearizer, NativeReadWriteLock │ synapse/util/async_helpers.py │ ├──────────────────┼───────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────────┤ │ Cache │ DeferredCache │ FutureCache │ synapse/util/caches/future_cache.py │ ├──────────────────┼───────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────────┤ │ Clock │ Clock (Twisted reactor) │ NativeClock (asyncio) │ synapse/util/clock.py │ ├──────────────────┼───────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────────┤ │ Database │ adbapi.ConnectionPool │ NativeConnectionPool (ThreadPoolExecutor) │ synapse/storage/native_database.py │ ├──────────────────┼───────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────────┤ │ HTTP Client │ treq + Twisted Agent │ aiohttp.ClientSession │ synapse/http/native_client.py │ ├──────────────────┼───────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────────┤ │ HTTP Server │ JsonResource + Twisted Site │ NativeJsonResource + aiohttp.web │ synapse/http/native_server.py │ ├──────────────────┼───────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────────┤ │ Replication │ LineOnlyReceiver (Twisted Protocol) │ asyncio.StreamReader/Writer │ synapse/replication/tcp/native_protocol.py │ ├──────────────────┼───────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────────┤ │ Event loop │ ISynapseReactor │ ISynapseEventLoop │ synapse/types/__init__.py │ ├──────────────────┼───────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────────┤ │ Test helper │ — │ FakeAsyncioLoop │ tests/async_helpers.py │ └──────────────────┴───────────────────────────────────────────────┴─────────────────────────────────────────────────────────┴───────────────────────────────────────────────┘ What's been wired in safely — 224 files changed, 0 regressions - MemoryReactor type hint → Any across 198 test files (cosmetic) - synapse/http/server.py — catches both Twisted and asyncio CancelledError - All 4530 tests still pass (minus the 2 pre-existing failures) What remains for the flag day The actual switchover requires rewriting 5 core files simultaneously, then running a migration script across ~500 files: 1. tests/unittest.py + tests/server.py — switch from twisted.trial.TestCase to unittest.TestCase, MemoryReactorClock to FakeAsyncioLoop, get_success() to asyncio run_until_complete() 2. synapse/logging/context.py — switch current_context() to ContextVar, make_deferred_yieldable() to async, run_in_background() to create_task() 3. synapse/util/async_helpers.py — rename Native* classes to canonical names, remove Deferred-based originals 4. Migration script — update all CancelledError, defer.*, Deferred imports across ~500 files 5. pyproject.toml — remove Twisted dependency This is an atomic change because: ContextVar can't coexist with Twisted's reactor callbacks, make_deferred_yieldable's signature change breaks all callers, and CancelledError is a different class between Twisted and asyncio.
106 lines
3.7 KiB
Python
106 lines
3.7 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/endpoints path."""
|
|
|
|
from typing import Any as MemoryReactor # was: MemoryReactor from Twisted
|
|
|
|
from synapse.rest import admin
|
|
from synapse.rest.client import login, matrixrtc, register, room
|
|
from synapse.server import HomeServer
|
|
from synapse.util.clock import Clock
|
|
|
|
from tests.unittest import HomeserverTestCase, override_config
|
|
|
|
PATH_PREFIX = "/_matrix/client/unstable/org.matrix.msc4143"
|
|
RTC_ENDPOINT = {"type": "focusA", "required_field": "theField"}
|
|
LIVEKIT_ENDPOINT = {
|
|
"type": "livekit",
|
|
"livekit_service_url": "https://livekit.example.com",
|
|
}
|
|
|
|
|
|
class MatrixRtcTestCase(HomeserverTestCase):
|
|
"""Tests /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_ENDPOINT]},
|
|
}
|
|
)
|
|
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_ENDPOINT]}, channel.json_body)
|