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
115 lines
3.6 KiB
Python
115 lines
3.6 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
|
# 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]
|
|
#
|
|
#
|
|
|
|
"""Tests REST events for /rooms paths."""
|
|
|
|
from twisted.internet.testing import MemoryReactor
|
|
|
|
from synapse.api.constants import EduTypes
|
|
from synapse.rest.client import room
|
|
from synapse.server import HomeServer
|
|
from synapse.types import UserID
|
|
from synapse.util.clock import Clock
|
|
|
|
from tests import unittest
|
|
|
|
PATH_PREFIX = "/_matrix/client/api/v1"
|
|
|
|
|
|
class RoomTypingTestCase(unittest.HomeserverTestCase):
|
|
"""Tests /rooms/$room_id/typing/$user_id REST API."""
|
|
|
|
user_id = "@sid:red"
|
|
|
|
user = UserID.from_string(user_id)
|
|
servlets = [room.register_servlets]
|
|
|
|
def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
|
|
hs = self.setup_test_homeserver("red")
|
|
self.event_source = hs.get_event_sources().sources.typing
|
|
return hs
|
|
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
self.room_id = self.helper.create_room_as(self.user_id)
|
|
# Need another user to make notifications actually work
|
|
self.helper.join(self.room_id, user="@jim:red")
|
|
|
|
def test_set_typing(self) -> None:
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/rooms/%s/typing/%s" % (self.room_id, self.user_id),
|
|
b'{"typing": true, "timeout": 30000}',
|
|
)
|
|
self.assertEqual(200, channel.code)
|
|
|
|
self.assertEqual(self.event_source.get_current_key(), 1)
|
|
events = self.get_success(
|
|
self.event_source.get_new_events(
|
|
user=UserID.from_string(self.user_id),
|
|
from_key=0,
|
|
# Limit is unused.
|
|
limit=0,
|
|
room_ids=[self.room_id],
|
|
is_guest=False,
|
|
)
|
|
)
|
|
self.assertEqual(
|
|
events[0],
|
|
[
|
|
{
|
|
"type": EduTypes.TYPING,
|
|
"room_id": self.room_id,
|
|
"content": {"user_ids": [self.user_id]},
|
|
}
|
|
],
|
|
)
|
|
|
|
def test_set_not_typing(self) -> None:
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/rooms/%s/typing/%s" % (self.room_id, self.user_id),
|
|
b'{"typing": false}',
|
|
)
|
|
self.assertEqual(200, channel.code)
|
|
|
|
def test_typing_timeout(self) -> None:
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/rooms/%s/typing/%s" % (self.room_id, self.user_id),
|
|
b'{"typing": true, "timeout": 30000}',
|
|
)
|
|
self.assertEqual(200, channel.code)
|
|
|
|
self.assertEqual(self.event_source.get_current_key(), 1)
|
|
|
|
self.reactor.advance(36)
|
|
|
|
self.assertEqual(self.event_source.get_current_key(), 2)
|
|
|
|
channel = self.make_request(
|
|
"PUT",
|
|
"/rooms/%s/typing/%s" % (self.room_id, self.user_id),
|
|
b'{"typing": true, "timeout": 30000}',
|
|
)
|
|
self.assertEqual(200, channel.code)
|
|
|
|
self.assertEqual(self.event_source.get_current_key(), 3)
|