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
121 lines
4.2 KiB
Python
121 lines
4.2 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2020 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]
|
|
#
|
|
#
|
|
import logging
|
|
|
|
from twisted.internet.testing import MemoryReactor
|
|
|
|
from synapse.rest.client import register
|
|
from synapse.server import HomeServer
|
|
from synapse.util.clock import Clock
|
|
|
|
from tests.replication._base import BaseMultiWorkerStreamTestCase
|
|
from tests.server import FakeChannel, make_request
|
|
from tests.unittest import override_config
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class WorkerAuthenticationTestCase(BaseMultiWorkerStreamTestCase):
|
|
"""Test the authentication of HTTP calls between workers."""
|
|
|
|
servlets = [register.register_servlets]
|
|
|
|
def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
|
|
config = self.default_config()
|
|
# This isn't a real configuration option but is used to provide the main
|
|
# homeserver and worker homeserver different options.
|
|
main_replication_secret = config.pop("main_replication_secret", None)
|
|
if main_replication_secret:
|
|
config["worker_replication_secret"] = main_replication_secret
|
|
return self.setup_test_homeserver(config=config)
|
|
|
|
def _get_worker_hs_config(self) -> dict:
|
|
config = self.default_config()
|
|
config["worker_app"] = "synapse.app.generic_worker"
|
|
return config
|
|
|
|
def _test_register(self) -> FakeChannel:
|
|
"""Run the actual test:
|
|
|
|
1. Create a worker homeserver.
|
|
2. Start registration by providing a user/password.
|
|
3. Complete registration by providing dummy auth (this hits the main synapse).
|
|
4. Return the final request.
|
|
|
|
"""
|
|
worker_hs = self.make_worker_hs("synapse.app.generic_worker")
|
|
site = self._hs_to_site[worker_hs]
|
|
|
|
channel_1 = make_request(
|
|
self.reactor,
|
|
site,
|
|
"POST",
|
|
"register",
|
|
{"username": "user", "type": "m.login.password", "password": "bar"},
|
|
)
|
|
self.assertEqual(channel_1.code, 401)
|
|
|
|
# Grab the session
|
|
session = channel_1.json_body["session"]
|
|
|
|
# also complete the dummy auth
|
|
return make_request(
|
|
self.reactor,
|
|
site,
|
|
"POST",
|
|
"register",
|
|
{"auth": {"session": session, "type": "m.login.dummy"}},
|
|
)
|
|
|
|
def test_no_auth(self) -> None:
|
|
"""With no authentication the request should finish."""
|
|
channel = self._test_register()
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# We're given a registered user.
|
|
self.assertEqual(channel.json_body["user_id"], "@user:test")
|
|
|
|
@override_config({"main_replication_secret": "my-secret"})
|
|
def test_missing_auth(self) -> None:
|
|
"""If the main process expects a secret that is not provided, an error results."""
|
|
channel = self._test_register()
|
|
self.assertEqual(channel.code, 500)
|
|
|
|
@override_config(
|
|
{
|
|
"main_replication_secret": "my-secret",
|
|
"worker_replication_secret": "wrong-secret",
|
|
}
|
|
)
|
|
def test_unauthorized(self) -> None:
|
|
"""If the main process receives the wrong secret, an error results."""
|
|
channel = self._test_register()
|
|
self.assertEqual(channel.code, 500)
|
|
|
|
@override_config({"worker_replication_secret": "my-secret"})
|
|
def test_authorized(self) -> None:
|
|
"""The request should finish when the worker provides the authentication header."""
|
|
channel = self._test_register()
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# We're given a registered user.
|
|
self.assertEqual(channel.json_body["user_id"], "@user:test")
|