mirror of
https://github.com/element-hq/synapse.git
synced 2025-12-28 14:59:12 +00: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
150 lines
5.0 KiB
Python
150 lines
5.0 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]
|
|
#
|
|
#
|
|
from http import HTTPStatus
|
|
from unittest.mock import AsyncMock, Mock
|
|
|
|
from twisted.internet.testing import MemoryReactor
|
|
|
|
from synapse.handlers.presence import PresenceHandler
|
|
from synapse.rest.client import presence
|
|
from synapse.server import HomeServer
|
|
from synapse.types import UserID
|
|
from synapse.util.clock import Clock
|
|
|
|
from tests import unittest
|
|
from tests.unittest import override_config
|
|
|
|
|
|
class PresenceTestCase(unittest.HomeserverTestCase):
|
|
"""Tests presence REST API."""
|
|
|
|
user_id = "@sid:red"
|
|
|
|
user = UserID.from_string(user_id)
|
|
servlets = [presence.register_servlets]
|
|
|
|
def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
|
|
self.presence_handler = Mock(spec=PresenceHandler)
|
|
self.presence_handler.set_state = AsyncMock(return_value=None)
|
|
|
|
hs = self.setup_test_homeserver(
|
|
"red",
|
|
federation_client=Mock(),
|
|
presence_handler=self.presence_handler,
|
|
)
|
|
|
|
return hs
|
|
|
|
def test_put_presence(self) -> None:
|
|
"""
|
|
PUT to the status endpoint with use_presence enabled will call
|
|
set_state on the presence handler.
|
|
"""
|
|
self.hs.config.server.presence_enabled = True
|
|
|
|
body = {"presence": "here", "status_msg": "beep boop"}
|
|
channel = self.make_request(
|
|
"PUT", "/presence/%s/status" % (self.user_id,), body
|
|
)
|
|
|
|
self.assertEqual(channel.code, HTTPStatus.OK)
|
|
self.assertEqual(self.presence_handler.set_state.call_count, 1)
|
|
|
|
@unittest.override_config({"use_presence": False})
|
|
def test_put_presence_disabled(self) -> None:
|
|
"""
|
|
PUT to the status endpoint with presence disabled will NOT call
|
|
set_state on the presence handler.
|
|
"""
|
|
|
|
body = {"presence": "here", "status_msg": "beep boop"}
|
|
channel = self.make_request(
|
|
"PUT", "/presence/%s/status" % (self.user_id,), body
|
|
)
|
|
|
|
self.assertEqual(channel.code, HTTPStatus.OK)
|
|
self.assertEqual(self.presence_handler.set_state.call_count, 0)
|
|
|
|
@unittest.override_config({"presence": {"enabled": "untracked"}})
|
|
def test_put_presence_untracked(self) -> None:
|
|
"""
|
|
PUT to the status endpoint with presence untracked will NOT call
|
|
set_state on the presence handler.
|
|
"""
|
|
|
|
body = {"presence": "here", "status_msg": "beep boop"}
|
|
channel = self.make_request(
|
|
"PUT", "/presence/%s/status" % (self.user_id,), body
|
|
)
|
|
|
|
self.assertEqual(channel.code, HTTPStatus.OK)
|
|
self.assertEqual(self.presence_handler.set_state.call_count, 0)
|
|
|
|
@override_config(
|
|
{"rc_presence": {"per_user": {"per_second": 0.1, "burst_count": 1}}}
|
|
)
|
|
def test_put_presence_over_ratelimit(self) -> None:
|
|
"""
|
|
Multiple PUTs to the status endpoint without sufficient delay will be rate limited.
|
|
"""
|
|
self.hs.config.server.presence_enabled = True
|
|
|
|
body = {"presence": "here", "status_msg": "beep boop"}
|
|
channel = self.make_request(
|
|
"PUT", "/presence/%s/status" % (self.user_id,), body
|
|
)
|
|
|
|
self.assertEqual(channel.code, HTTPStatus.OK)
|
|
|
|
body = {"presence": "here", "status_msg": "beep boop"}
|
|
channel = self.make_request(
|
|
"PUT", "/presence/%s/status" % (self.user_id,), body
|
|
)
|
|
|
|
self.assertEqual(channel.code, HTTPStatus.TOO_MANY_REQUESTS)
|
|
self.assertEqual(self.presence_handler.set_state.call_count, 1)
|
|
|
|
@override_config(
|
|
{"rc_presence": {"per_user": {"per_second": 0.1, "burst_count": 1}}}
|
|
)
|
|
def test_put_presence_within_ratelimit(self) -> None:
|
|
"""
|
|
Multiple PUTs to the status endpoint with sufficient delay should all call set_state.
|
|
"""
|
|
self.hs.config.server.presence_enabled = True
|
|
|
|
body = {"presence": "here", "status_msg": "beep boop"}
|
|
channel = self.make_request(
|
|
"PUT", "/presence/%s/status" % (self.user_id,), body
|
|
)
|
|
|
|
self.assertEqual(channel.code, HTTPStatus.OK)
|
|
|
|
# Advance time a sufficient amount to avoid rate limiting.
|
|
self.reactor.advance(30)
|
|
|
|
body = {"presence": "here", "status_msg": "beep boop"}
|
|
channel = self.make_request(
|
|
"PUT", "/presence/%s/status" % (self.user_id,), body
|
|
)
|
|
|
|
self.assertEqual(channel.code, HTTPStatus.OK)
|
|
self.assertEqual(self.presence_handler.set_state.call_count, 2)
|