mirror of
https://github.com/element-hq/synapse.git
synced 2026-03-31 19:15:54 +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.
119 lines
4.4 KiB
Python
119 lines
4.4 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
# Copyright (C) 2023 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>.
|
|
#
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
#
|
|
# [This file includes modifications made by New Vector Limited]
|
|
#
|
|
#
|
|
|
|
from typing import Any as MemoryReactor # was: MemoryReactor from Twisted
|
|
|
|
from synapse.api.constants import MAIN_TIMELINE
|
|
from synapse.server import HomeServer
|
|
from synapse.util.clock import Clock
|
|
|
|
from tests import unittest
|
|
|
|
|
|
class RelationsStoreTestCase(unittest.HomeserverTestCase):
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
"""
|
|
Creates a DAG:
|
|
|
|
A <---[m.thread]-- B <--[m.annotation]-- C
|
|
^
|
|
|--[m.reference]-- D <--[m.annotation]-- E
|
|
|
|
F <--[m.annotation]-- G
|
|
|
|
"""
|
|
self._main_store = self.hs.get_datastores().main
|
|
|
|
self._create_relation("A", "B", "m.thread")
|
|
self._create_relation("B", "C", "m.annotation")
|
|
self._create_relation("A", "D", "m.reference")
|
|
self._create_relation("D", "E", "m.annotation")
|
|
self._create_relation("F", "G", "m.annotation")
|
|
|
|
def _create_relation(self, parent_id: str, event_id: str, rel_type: str) -> None:
|
|
self.get_success(
|
|
self._main_store.db_pool.simple_insert(
|
|
table="event_relations",
|
|
values={
|
|
"event_id": event_id,
|
|
"relates_to_id": parent_id,
|
|
"relation_type": rel_type,
|
|
},
|
|
)
|
|
)
|
|
|
|
def test_get_thread_id(self) -> None:
|
|
"""
|
|
Ensure that get_thread_id only searches up the tree for threads.
|
|
"""
|
|
# The thread itself and children of it return the thread.
|
|
thread_id = self.get_success(self._main_store.get_thread_id("B"))
|
|
self.assertEqual("A", thread_id)
|
|
|
|
thread_id = self.get_success(self._main_store.get_thread_id("C"))
|
|
self.assertEqual("A", thread_id)
|
|
|
|
# But the root and events related to the root do not.
|
|
thread_id = self.get_success(self._main_store.get_thread_id("A"))
|
|
self.assertEqual(MAIN_TIMELINE, thread_id)
|
|
|
|
thread_id = self.get_success(self._main_store.get_thread_id("D"))
|
|
self.assertEqual(MAIN_TIMELINE, thread_id)
|
|
|
|
thread_id = self.get_success(self._main_store.get_thread_id("E"))
|
|
self.assertEqual(MAIN_TIMELINE, thread_id)
|
|
|
|
# Events which are not related to a thread at all should return the
|
|
# main timeline.
|
|
thread_id = self.get_success(self._main_store.get_thread_id("F"))
|
|
self.assertEqual(MAIN_TIMELINE, thread_id)
|
|
|
|
thread_id = self.get_success(self._main_store.get_thread_id("G"))
|
|
self.assertEqual(MAIN_TIMELINE, thread_id)
|
|
|
|
def test_get_thread_id_for_receipts(self) -> None:
|
|
"""
|
|
Ensure that get_thread_id_for_receipts searches up and down the tree for a thread.
|
|
"""
|
|
# All of the events are considered related to this thread.
|
|
thread_id = self.get_success(self._main_store.get_thread_id_for_receipts("A"))
|
|
self.assertEqual("A", thread_id)
|
|
|
|
thread_id = self.get_success(self._main_store.get_thread_id_for_receipts("B"))
|
|
self.assertEqual("A", thread_id)
|
|
|
|
thread_id = self.get_success(self._main_store.get_thread_id_for_receipts("C"))
|
|
self.assertEqual("A", thread_id)
|
|
|
|
thread_id = self.get_success(self._main_store.get_thread_id_for_receipts("D"))
|
|
self.assertEqual("A", thread_id)
|
|
|
|
thread_id = self.get_success(self._main_store.get_thread_id_for_receipts("E"))
|
|
self.assertEqual("A", thread_id)
|
|
|
|
# Events which are not related to a thread at all should return the
|
|
# main timeline.
|
|
thread_id = self.get_success(self._main_store.get_thread_id("F"))
|
|
self.assertEqual(MAIN_TIMELINE, thread_id)
|
|
|
|
thread_id = self.get_success(self._main_store.get_thread_id("G"))
|
|
self.assertEqual(MAIN_TIMELINE, thread_id)
|