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
112 lines
3.7 KiB
Python
112 lines
3.7 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# 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 os
|
|
|
|
from twisted.internet.testing import MemoryReactor
|
|
|
|
import synapse.rest.admin
|
|
from synapse.rest.client import login, room, sync
|
|
from synapse.server import HomeServer
|
|
from synapse.util.clock import Clock
|
|
|
|
from tests import unittest
|
|
|
|
|
|
class ConsentNoticesTests(unittest.HomeserverTestCase):
|
|
servlets = [
|
|
sync.register_servlets,
|
|
synapse.rest.admin.register_servlets_for_client_rest_resource,
|
|
login.register_servlets,
|
|
room.register_servlets,
|
|
]
|
|
|
|
def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
|
|
tmpdir = self.mktemp()
|
|
os.mkdir(tmpdir)
|
|
self.consent_notice_message = "consent %(consent_uri)s"
|
|
config = self.default_config()
|
|
config["user_consent"] = {
|
|
"version": "1",
|
|
"template_dir": tmpdir,
|
|
"server_notice_content": {
|
|
"msgtype": "m.text",
|
|
"body": self.consent_notice_message,
|
|
},
|
|
}
|
|
config["public_baseurl"] = "https://example.com/"
|
|
config["form_secret"] = "123abc"
|
|
|
|
config["server_notices"] = {
|
|
"system_mxid_localpart": "notices",
|
|
"system_mxid_display_name": "test display name",
|
|
"system_mxid_avatar_url": None,
|
|
"room_name": "Server Notices",
|
|
}
|
|
|
|
return self.setup_test_homeserver(config=config)
|
|
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
self.user_id = self.register_user("bob", "abc123")
|
|
self.access_token = self.login("bob", "abc123")
|
|
|
|
def test_get_sync_message(self) -> None:
|
|
"""
|
|
When user consent server notices are enabled, a sync will cause a notice
|
|
to fire (in a room which the user is invited to). The notice contains
|
|
the notice URL + an authentication code.
|
|
"""
|
|
# Initial sync, to get the user consent room invite
|
|
channel = self.make_request(
|
|
"GET", "/_matrix/client/r0/sync", access_token=self.access_token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# Get the Room ID to join
|
|
room_id = list(channel.json_body["rooms"]["invite"].keys())[0]
|
|
|
|
# Join the room
|
|
channel = self.make_request(
|
|
"POST",
|
|
"/_matrix/client/r0/rooms/" + room_id + "/join",
|
|
access_token=self.access_token,
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# Sync again, to get the message in the room
|
|
channel = self.make_request(
|
|
"GET", "/_matrix/client/r0/sync", access_token=self.access_token
|
|
)
|
|
self.assertEqual(channel.code, 200)
|
|
|
|
# Get the message
|
|
room = channel.json_body["rooms"]["join"][room_id]
|
|
messages = [
|
|
x for x in room["timeline"]["events"] if x["type"] == "m.room.message"
|
|
]
|
|
|
|
# One message, with the consent URL
|
|
self.assertEqual(len(messages), 1)
|
|
self.assertTrue(
|
|
messages[0]["content"]["body"].startswith(
|
|
"consent https://example.com/_matrix/consent"
|
|
)
|
|
)
|