mirror of
https://github.com/element-hq/synapse.git
synced 2025-12-17 00:01:18 -05:00
5a9ca1e3d9
Introduce `Clock.call_when_running(...)` to wrap startup code in a logcontext, ensuring we can identify which server generated the logs. Background: > Ideally, nothing from the Synapse homeserver would be logged against the `sentinel` > logcontext as we want to know which server the logs came from. In practice, this is not > always the case yet especially outside of request handling. > > Global things outside of Synapse (e.g. Twisted reactor code) should run in the > `sentinel` logcontext. It's only when it calls into application code that a logcontext > gets activated. This means the reactor should be started in the `sentinel` logcontext, > and any time an awaitable yields control back to the reactor, it should reset the > logcontext to be the `sentinel` logcontext. This is important to avoid leaking the > current logcontext to the reactor (which would then get picked up and associated with > the next thing the reactor does). > > *-- `docs/log_contexts.md` Also adds a lint to prefer `Clock.call_when_running(...)` over `reactor.callWhenRunning(...)` Part of https://github.com/element-hq/synapse/issues/18905
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 twisted.internet.testing import MemoryReactor
|
|
|
|
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)
|