mirror of
https://github.com/element-hq/synapse.git
synced 2026-04-02 21:05:49 +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.
118 lines
4.1 KiB
Python
118 lines
4.1 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright (C) 2025 Element Creations 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>.
|
|
#
|
|
|
|
|
|
from unittest.mock import Mock
|
|
|
|
from twisted.internet.defer import Deferred
|
|
from typing import Any as MemoryReactor # was: MemoryReactor from Twisted
|
|
|
|
from synapse.logging.context import PreserveLoggingContext, make_deferred_yieldable
|
|
from synapse.server import HomeServer
|
|
from synapse.util.background_queue import BackgroundQueue
|
|
from synapse.util.clock import Clock
|
|
|
|
from tests.unittest import HomeserverTestCase, logcontext_clean
|
|
|
|
|
|
class BackgroundQueueTests(HomeserverTestCase):
|
|
def prepare(
|
|
self, reactor: MemoryReactor, clock: Clock, homeserver: HomeServer
|
|
) -> None:
|
|
self._process_item_mock = Mock(spec_set=[])
|
|
|
|
self.queue = BackgroundQueue[int](
|
|
hs=homeserver,
|
|
name="test_queue",
|
|
callback=self._process_item_mock,
|
|
timeout_ms=1000,
|
|
)
|
|
|
|
@logcontext_clean
|
|
def test_simple_call(self) -> None:
|
|
"""Test that items added to the queue are processed."""
|
|
# Register a deferred to be the return value of the callback.
|
|
callback_result_deferred: Deferred[None] = Deferred()
|
|
self._process_item_mock.side_effect = lambda _: make_deferred_yieldable(
|
|
callback_result_deferred
|
|
)
|
|
|
|
# Adding an item should cause the callback to be invoked.
|
|
self.queue.add(1)
|
|
|
|
self._process_item_mock.assert_called_once_with(1)
|
|
self._process_item_mock.reset_mock()
|
|
|
|
# Adding another item should not cause the callback to be invoked again
|
|
# until the previous one has completed.
|
|
self.queue.add(2)
|
|
self._process_item_mock.assert_not_called()
|
|
|
|
# Once the first callback completes, the second item should be
|
|
# processed.
|
|
with PreserveLoggingContext():
|
|
callback_result_deferred.callback(None)
|
|
self._process_item_mock.assert_called_once_with(2)
|
|
|
|
@logcontext_clean
|
|
def test_timeout(self) -> None:
|
|
"""Test that the background process wakes up if its idle, and that it
|
|
times out after being idle."""
|
|
|
|
# Register a deferred to be the return value of the callback.
|
|
callback_result_deferred: Deferred[None] = Deferred()
|
|
self._process_item_mock.side_effect = lambda _: make_deferred_yieldable(
|
|
callback_result_deferred
|
|
)
|
|
|
|
# Adding an item should cause the callback to be invoked.
|
|
self.queue.add(1)
|
|
|
|
self._process_item_mock.assert_called_once_with(1)
|
|
self._process_item_mock.reset_mock()
|
|
|
|
# Let the callback complete.
|
|
with PreserveLoggingContext():
|
|
callback_result_deferred.callback(None)
|
|
|
|
# Advance the clock by less than the timeout, and add another item.
|
|
self.reactor.advance(0.5)
|
|
self.assertIsNotNone(self.queue._wakeup_event)
|
|
self.queue.add(2)
|
|
|
|
# The callback should be invoked again.
|
|
callback_result_deferred = Deferred()
|
|
self._process_item_mock.side_effect = lambda _: make_deferred_yieldable(
|
|
callback_result_deferred
|
|
)
|
|
self._process_item_mock.assert_called_once_with(2)
|
|
self._process_item_mock.reset_mock()
|
|
|
|
# Let the callback complete.
|
|
with PreserveLoggingContext():
|
|
callback_result_deferred.callback(None)
|
|
|
|
# Advance the clock by more than the timeout.
|
|
self.reactor.advance(1.5)
|
|
|
|
# The background process should have exited, we check this by checking
|
|
# the internal wakeup event has been removed.
|
|
self.assertIsNone(self.queue._wakeup_event)
|
|
|
|
# Add another item. This should cause a new background process to be
|
|
# started.
|
|
self.queue.add(3)
|
|
|
|
self._process_item_mock.assert_called_once_with(3)
|