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
166 lines
5.6 KiB
Python
166 lines
5.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 /events paths."""
|
|
|
|
from unittest.mock import Mock
|
|
|
|
from twisted.internet.testing import MemoryReactor
|
|
|
|
import synapse.rest.admin
|
|
from synapse.api.constants import EduTypes
|
|
from synapse.rest.client import events, login, room
|
|
from synapse.server import HomeServer
|
|
from synapse.util.clock import Clock
|
|
|
|
from tests import unittest
|
|
|
|
|
|
class EventStreamPermissionsTestCase(unittest.HomeserverTestCase):
|
|
"""Tests event streaming (GET /events)."""
|
|
|
|
servlets = [
|
|
events.register_servlets,
|
|
room.register_servlets,
|
|
synapse.rest.admin.register_servlets_for_client_rest_resource,
|
|
login.register_servlets,
|
|
]
|
|
|
|
def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
|
|
config = self.default_config()
|
|
config["enable_registration_captcha"] = False
|
|
config["enable_registration"] = True
|
|
config["auto_join_rooms"] = []
|
|
|
|
hs = self.setup_test_homeserver(config=config)
|
|
|
|
hs.get_federation_handler = Mock() # type: ignore[method-assign]
|
|
|
|
return hs
|
|
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
# register an account
|
|
self.user_id = self.register_user("sid1", "pass")
|
|
self.token = self.login(self.user_id, "pass")
|
|
|
|
# register a 2nd account
|
|
self.other_user = self.register_user("other2", "pass")
|
|
self.other_token = self.login(self.other_user, "pass")
|
|
|
|
def test_stream_basic_permissions(self) -> None:
|
|
# invalid token, expect 401
|
|
# note: this is in violation of the original v1 spec, which expected
|
|
# 403. However, since the v1 spec no longer exists and the v1
|
|
# implementation is now part of the r0 implementation, the newer
|
|
# behaviour is used instead to be consistent with the r0 spec.
|
|
# see issue https://github.com/matrix-org/synapse/issues/2602
|
|
channel = self.make_request(
|
|
"GET", "/events?access_token=%s" % ("invalid" + self.token,)
|
|
)
|
|
self.assertEqual(channel.code, 401, msg=channel.result)
|
|
|
|
# valid token, expect content
|
|
channel = self.make_request(
|
|
"GET", "/events?access_token=%s&timeout=0" % (self.token,)
|
|
)
|
|
self.assertEqual(channel.code, 200, msg=channel.result)
|
|
self.assertTrue("chunk" in channel.json_body)
|
|
self.assertTrue("start" in channel.json_body)
|
|
self.assertTrue("end" in channel.json_body)
|
|
|
|
def test_stream_room_permissions(self) -> None:
|
|
room_id = self.helper.create_room_as(self.other_user, tok=self.other_token)
|
|
self.helper.send(room_id, tok=self.other_token)
|
|
|
|
# invited to room (expect no content for room)
|
|
self.helper.invite(
|
|
room_id, src=self.other_user, targ=self.user_id, tok=self.other_token
|
|
)
|
|
|
|
# valid token, expect content
|
|
channel = self.make_request(
|
|
"GET", "/events?access_token=%s&timeout=0" % (self.token,)
|
|
)
|
|
self.assertEqual(channel.code, 200, msg=channel.result)
|
|
|
|
# We may get a presence event for ourselves down
|
|
self.assertEqual(
|
|
0,
|
|
len(
|
|
[
|
|
c
|
|
for c in channel.json_body["chunk"]
|
|
if not (
|
|
c.get("type") == EduTypes.PRESENCE
|
|
and c["content"].get("user_id") == self.user_id
|
|
)
|
|
]
|
|
),
|
|
)
|
|
|
|
# joined room (expect all content for room)
|
|
self.helper.join(room=room_id, user=self.user_id, tok=self.token)
|
|
|
|
# left to room (expect no content for room)
|
|
|
|
def TODO_test_stream_items(self) -> None:
|
|
# new user, no content
|
|
|
|
# join room, expect 1 item (join)
|
|
|
|
# send message, expect 2 items (join,send)
|
|
|
|
# set topic, expect 3 items (join,send,topic)
|
|
|
|
# someone else join room, expect 4 (join,send,topic,join)
|
|
|
|
# someone else send message, expect 5 (join,send.topic,join,send)
|
|
|
|
# someone else set topic, expect 6 (join,send,topic,join,send,topic)
|
|
pass
|
|
|
|
|
|
class GetEventsTestCase(unittest.HomeserverTestCase):
|
|
servlets = [
|
|
events.register_servlets,
|
|
room.register_servlets,
|
|
synapse.rest.admin.register_servlets_for_client_rest_resource,
|
|
login.register_servlets,
|
|
]
|
|
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
# register an account
|
|
self.user_id = self.register_user("sid1", "pass")
|
|
self.token = self.login(self.user_id, "pass")
|
|
|
|
self.room_id = self.helper.create_room_as(self.user_id, tok=self.token)
|
|
|
|
def test_get_event_via_events(self) -> None:
|
|
resp = self.helper.send(self.room_id, tok=self.token)
|
|
event_id = resp["event_id"]
|
|
|
|
channel = self.make_request(
|
|
"GET",
|
|
"/events/" + event_id,
|
|
access_token=self.token,
|
|
)
|
|
self.assertEqual(channel.code, 200, msg=channel.result)
|