mirror of
https://mau.dev/maunium/synapse.git
synced 2024-08-27 20:52:30 +00:00
![Andrew Morgan](/assets/img/avatar_default.png)
At the moment, if you'd like to share presence between local or remote users, those users must be sharing a room together. This isn't always the most convenient or useful situation though. This PR adds a module to Synapse that will allow deployments to set up extra logic on where presence updates should be routed. The module must implement two methods, `get_users_for_states` and `get_interested_users`. These methods are given presence updates or user IDs and must return information that Synapse will use to grant passing presence updates around. A method is additionally added to `ModuleApi` which allows triggering a set of users to receive the current, online presence information for all users they are considered interested in. This is the equivalent of that user receiving presence information during an initial sync. The goal of this module is to be fairly generic and useful for a variety of applications, with hard requirements being: * Sending state for a specific set or all known users to a defined set of local and remote users. * The ability to trigger an initial sync for specific users, so they receive all current state.
81 lines
2.8 KiB
Python
81 lines
2.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2018 New Vector Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from synapse.api.errors import Codes, ResourceLimitError
|
|
from synapse.api.filtering import DEFAULT_FILTER_COLLECTION
|
|
from synapse.handlers.sync import SyncConfig
|
|
from synapse.types import UserID, create_requester
|
|
|
|
import tests.unittest
|
|
import tests.utils
|
|
|
|
|
|
class SyncTestCase(tests.unittest.HomeserverTestCase):
|
|
""" Tests Sync Handler. """
|
|
|
|
def prepare(self, reactor, clock, hs):
|
|
self.hs = hs
|
|
self.sync_handler = self.hs.get_sync_handler()
|
|
self.store = self.hs.get_datastore()
|
|
|
|
# AuthBlocking reads from the hs' config on initialization. We need to
|
|
# modify its config instead of the hs'
|
|
self.auth_blocking = self.hs.get_auth()._auth_blocking
|
|
|
|
def test_wait_for_sync_for_user_auth_blocking(self):
|
|
user_id1 = "@user1:test"
|
|
user_id2 = "@user2:test"
|
|
sync_config = generate_sync_config(user_id1)
|
|
requester = create_requester(user_id1)
|
|
|
|
self.reactor.advance(100) # So we get not 0 time
|
|
self.auth_blocking._limit_usage_by_mau = True
|
|
self.auth_blocking._max_mau_value = 1
|
|
|
|
# Check that the happy case does not throw errors
|
|
self.get_success(self.store.upsert_monthly_active_user(user_id1))
|
|
self.get_success(
|
|
self.sync_handler.wait_for_sync_for_user(requester, sync_config)
|
|
)
|
|
|
|
# Test that global lock works
|
|
self.auth_blocking._hs_disabled = True
|
|
e = self.get_failure(
|
|
self.sync_handler.wait_for_sync_for_user(requester, sync_config),
|
|
ResourceLimitError,
|
|
)
|
|
self.assertEquals(e.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
|
|
self.auth_blocking._hs_disabled = False
|
|
|
|
sync_config = generate_sync_config(user_id2)
|
|
requester = create_requester(user_id2)
|
|
|
|
e = self.get_failure(
|
|
self.sync_handler.wait_for_sync_for_user(requester, sync_config),
|
|
ResourceLimitError,
|
|
)
|
|
self.assertEquals(e.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
|
|
|
|
|
def generate_sync_config(user_id: str) -> SyncConfig:
|
|
return SyncConfig(
|
|
user=UserID(user_id.split(":")[0][1:], user_id.split(":")[1]),
|
|
filter_collection=DEFAULT_FILTER_COLLECTION,
|
|
is_guest=False,
|
|
request_key="request_key",
|
|
device_id="device_id",
|
|
)
|