mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
192 lines
6.6 KiB
Python
192 lines
6.6 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 logging
|
|
from unittest.mock import Mock
|
|
|
|
from twisted.internet import defer
|
|
from twisted.test.proto_helpers import MemoryReactor
|
|
|
|
from synapse.rest import admin
|
|
from synapse.rest.client import login, room
|
|
from synapse.server import HomeServer
|
|
from synapse.util import Clock
|
|
|
|
from tests.replication._base import BaseMultiWorkerStreamTestCase
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class PusherShardTestCase(BaseMultiWorkerStreamTestCase):
|
|
"""Checks pusher sharding works"""
|
|
|
|
servlets = [
|
|
admin.register_servlets_for_client_rest_resource,
|
|
room.register_servlets,
|
|
login.register_servlets,
|
|
]
|
|
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
|
# Register a user who sends a message that we'll get notified about
|
|
self.other_user_id = self.register_user("otheruser", "pass")
|
|
self.other_access_token = self.login("otheruser", "pass")
|
|
|
|
def _create_pusher_and_send_msg(self, localpart: str) -> str:
|
|
# Create a user that will get push notifications
|
|
user_id = self.register_user(localpart, "pass")
|
|
access_token = self.login(localpart, "pass")
|
|
|
|
# Register a pusher
|
|
user_dict = self.get_success(
|
|
self.hs.get_datastores().main.get_user_by_access_token(access_token)
|
|
)
|
|
assert user_dict is not None
|
|
device_id = user_dict.device_id
|
|
|
|
self.get_success(
|
|
self.hs.get_pusherpool().add_or_update_pusher(
|
|
user_id=user_id,
|
|
device_id=device_id,
|
|
kind="http",
|
|
app_id="m.http",
|
|
app_display_name="HTTP Push Notifications",
|
|
device_display_name="pushy push",
|
|
pushkey="a@example.com",
|
|
lang=None,
|
|
data={"url": "https://push.example.com/_matrix/push/v1/notify"},
|
|
)
|
|
)
|
|
|
|
self.pump()
|
|
|
|
# Create a room
|
|
room = self.helper.create_room_as(user_id, tok=access_token)
|
|
|
|
# The other user joins
|
|
self.helper.join(
|
|
room=room, user=self.other_user_id, tok=self.other_access_token
|
|
)
|
|
|
|
# The other user sends some messages
|
|
response = self.helper.send(room, body="Hi!", tok=self.other_access_token)
|
|
event_id = response["event_id"]
|
|
|
|
return event_id
|
|
|
|
def test_send_push_single_worker(self) -> None:
|
|
"""Test that registration works when using a pusher worker."""
|
|
http_client_mock = Mock(spec_set=["post_json_get_json"])
|
|
http_client_mock.post_json_get_json.side_effect = (
|
|
lambda *_, **__: defer.succeed({})
|
|
)
|
|
|
|
self.make_worker_hs(
|
|
"synapse.app.generic_worker",
|
|
{"worker_name": "pusher1", "pusher_instances": ["pusher1"]},
|
|
proxied_blocklisted_http_client=http_client_mock,
|
|
)
|
|
|
|
event_id = self._create_pusher_and_send_msg("user")
|
|
|
|
# Advance time a bit, so the pusher will register something has happened
|
|
self.pump()
|
|
|
|
http_client_mock.post_json_get_json.assert_called_once()
|
|
self.assertEqual(
|
|
http_client_mock.post_json_get_json.call_args[0][0],
|
|
"https://push.example.com/_matrix/push/v1/notify",
|
|
)
|
|
self.assertEqual(
|
|
event_id,
|
|
http_client_mock.post_json_get_json.call_args[0][1]["notification"][
|
|
"event_id"
|
|
],
|
|
)
|
|
|
|
def test_send_push_multiple_workers(self) -> None:
|
|
"""Test that registration works when using sharded pusher workers."""
|
|
http_client_mock1 = Mock(spec_set=["post_json_get_json"])
|
|
http_client_mock1.post_json_get_json.side_effect = (
|
|
lambda *_, **__: defer.succeed({})
|
|
)
|
|
|
|
self.make_worker_hs(
|
|
"synapse.app.generic_worker",
|
|
{
|
|
"worker_name": "pusher1",
|
|
"pusher_instances": ["pusher1", "pusher2"],
|
|
},
|
|
proxied_blocklisted_http_client=http_client_mock1,
|
|
)
|
|
|
|
http_client_mock2 = Mock(spec_set=["post_json_get_json"])
|
|
http_client_mock2.post_json_get_json.side_effect = (
|
|
lambda *_, **__: defer.succeed({})
|
|
)
|
|
|
|
self.make_worker_hs(
|
|
"synapse.app.generic_worker",
|
|
{
|
|
"worker_name": "pusher2",
|
|
"pusher_instances": ["pusher1", "pusher2"],
|
|
},
|
|
proxied_blocklisted_http_client=http_client_mock2,
|
|
)
|
|
|
|
# We choose a user name that we know should go to pusher1.
|
|
event_id = self._create_pusher_and_send_msg("user2")
|
|
|
|
# Advance time a bit, so the pusher will register something has happened
|
|
self.pump()
|
|
|
|
http_client_mock1.post_json_get_json.assert_called_once()
|
|
http_client_mock2.post_json_get_json.assert_not_called()
|
|
self.assertEqual(
|
|
http_client_mock1.post_json_get_json.call_args[0][0],
|
|
"https://push.example.com/_matrix/push/v1/notify",
|
|
)
|
|
self.assertEqual(
|
|
event_id,
|
|
http_client_mock1.post_json_get_json.call_args[0][1]["notification"][
|
|
"event_id"
|
|
],
|
|
)
|
|
|
|
http_client_mock1.post_json_get_json.reset_mock()
|
|
http_client_mock2.post_json_get_json.reset_mock()
|
|
|
|
# Now we choose a user name that we know should go to pusher2.
|
|
event_id = self._create_pusher_and_send_msg("user4")
|
|
|
|
# Advance time a bit, so the pusher will register something has happened
|
|
self.pump()
|
|
|
|
http_client_mock1.post_json_get_json.assert_not_called()
|
|
http_client_mock2.post_json_get_json.assert_called_once()
|
|
self.assertEqual(
|
|
http_client_mock2.post_json_get_json.call_args[0][0],
|
|
"https://push.example.com/_matrix/push/v1/notify",
|
|
)
|
|
self.assertEqual(
|
|
event_id,
|
|
http_client_mock2.post_json_get_json.call_args[0][1]["notification"][
|
|
"event_id"
|
|
],
|
|
)
|