mirror of
https://github.com/element-hq/synapse.git
synced 2025-12-16 00:00:58 -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
135 lines
4.5 KiB
Python
135 lines
4.5 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2014-2021 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.server import HomeServer
|
|
from synapse.storage.database import LoggingTransaction
|
|
from synapse.storage.engines import PostgresEngine
|
|
from synapse.types import UserID
|
|
from synapse.util.clock import Clock
|
|
|
|
from tests import unittest
|
|
|
|
|
|
class ProfileStoreTestCase(unittest.HomeserverTestCase):
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
self.store = hs.get_datastores().main
|
|
|
|
self.u_frank = UserID.from_string("@frank:test")
|
|
|
|
def test_displayname(self) -> None:
|
|
self.get_success(self.store.create_profile(self.u_frank))
|
|
|
|
self.get_success(self.store.set_profile_displayname(self.u_frank, "Frank"))
|
|
|
|
self.assertEqual(
|
|
"Frank",
|
|
(self.get_success(self.store.get_profile_displayname(self.u_frank))),
|
|
)
|
|
|
|
# test set to None
|
|
self.get_success(self.store.set_profile_displayname(self.u_frank, None))
|
|
|
|
self.assertIsNone(
|
|
self.get_success(self.store.get_profile_displayname(self.u_frank))
|
|
)
|
|
|
|
def test_avatar_url(self) -> None:
|
|
self.get_success(self.store.create_profile(self.u_frank))
|
|
|
|
self.get_success(
|
|
self.store.set_profile_avatar_url(self.u_frank, "http://my.site/here")
|
|
)
|
|
|
|
self.assertEqual(
|
|
"http://my.site/here",
|
|
(self.get_success(self.store.get_profile_avatar_url(self.u_frank))),
|
|
)
|
|
|
|
# test set to None
|
|
self.get_success(self.store.set_profile_avatar_url(self.u_frank, None))
|
|
|
|
self.assertIsNone(
|
|
self.get_success(self.store.get_profile_avatar_url(self.u_frank))
|
|
)
|
|
|
|
def test_profiles_bg_migration(self) -> None:
|
|
"""
|
|
Test background job that copies entries from column user_id to full_user_id, adding
|
|
the hostname in the process.
|
|
"""
|
|
updater = self.hs.get_datastores().main.db_pool.updates
|
|
|
|
# drop the constraint so we can insert nulls in full_user_id to populate the test
|
|
if isinstance(self.store.database_engine, PostgresEngine):
|
|
|
|
def f(txn: LoggingTransaction) -> None:
|
|
txn.execute(
|
|
"ALTER TABLE profiles DROP CONSTRAINT full_user_id_not_null"
|
|
)
|
|
|
|
self.get_success(self.store.db_pool.runInteraction("", f))
|
|
|
|
for i in range(70):
|
|
self.get_success(
|
|
self.store.db_pool.simple_insert(
|
|
"profiles",
|
|
{"user_id": f"hello{i:02}"},
|
|
)
|
|
)
|
|
|
|
# re-add the constraint so that when it's validated it actually exists
|
|
if isinstance(self.store.database_engine, PostgresEngine):
|
|
|
|
def f(txn: LoggingTransaction) -> None:
|
|
txn.execute(
|
|
"ALTER TABLE profiles ADD CONSTRAINT full_user_id_not_null CHECK (full_user_id IS NOT NULL) NOT VALID"
|
|
)
|
|
|
|
self.get_success(self.store.db_pool.runInteraction("", f))
|
|
|
|
self.get_success(
|
|
self.store.db_pool.simple_insert(
|
|
"background_updates",
|
|
values={
|
|
"update_name": "populate_full_user_id_profiles",
|
|
"progress_json": "{}",
|
|
},
|
|
)
|
|
)
|
|
|
|
self.get_success(
|
|
updater.run_background_updates(False),
|
|
)
|
|
|
|
expected_values = []
|
|
for i in range(70):
|
|
expected_values.append((f"@hello{i:02}:{self.hs.hostname}",))
|
|
|
|
res = self.get_success(
|
|
self.store.db_pool.execute(
|
|
"", "SELECT full_user_id from profiles ORDER BY full_user_id"
|
|
)
|
|
)
|
|
self.assertEqual(len(res), len(expected_values))
|
|
self.assertEqual(res, expected_values)
|