Matrix/synapse
Matrix/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse synced 2024-07-04 16:53:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

check for room state before deciding on action

Browse source
This commit is contained in:
Neil Johnson 2018-08-16 14:53:35 +01:00
parent 25d2b5d55f
commit a675f9c556
3 changed files with 67 additions and 96 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
synapse/server_notices/consent_server_notices.py
View file

@ -22,7 +22,6 @@ from synapse.api.errors import SynapseError
from synapse.api.urls import ConsentURIBuilder from synapse.api.urls import ConsentURIBuilder
from synapse.config import ConfigError from synapse.config import ConfigError
from synapse.types import get_localpart_from_id from synapse.types import get_localpart_from_id
from synapse.api.constants import EventTypes
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)

110
synapse/server_notices/resource_limits_server_notices.py
View file

@ -16,8 +16,8 @@ import logging
from twisted.internet import defer from twisted.internet import defer
from synapse.api.errors import AuthError, SynapseError
from synapse.api.constants import EventTypes from synapse.api.constants import EventTypes
from synapse.api.errors import AuthError, SynapseError
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@ -35,10 +35,10 @@ class ResourceLimitsServerNotices(object):
self._store = hs.get_datastore() self._store = hs.get_datastore()
self.auth = hs.get_auth() self.auth = hs.get_auth()
self._server_notice_content = hs.config.user_consent_server_notice_content self._server_notice_content = hs.config.user_consent_server_notice_content
self._admin_uri = hs.config.admin_uri
self._limit_usage_by_mau = hs.config.limit_usage_by_mau self._limit_usage_by_mau = hs.config.limit_usage_by_mau
self._hs_disabled = hs.config.hs_disabled self._hs_disabled = hs.config.hs_disabled
self._notified_of_blocking = set()
self._resouce_limited = False self._resouce_limited = False
self._message_handler = hs.get_message_handler() self._message_handler = hs.get_message_handler()
self._state = hs.get_state_handler() self._state = hs.get_state_handler()
@ -58,83 +58,45 @@ class ResourceLimitsServerNotices(object):
return return
if self._limit_usage_by_mau is True: if self._limit_usage_by_mau is True:
room_id = yield self._server_notices_manager.get_notice_room_for_user(user_id)
# Alternate impl - currently inlcuded because I'm not sure I am on
# the right track and want to share WIP
# logger.info("GET STATE EVENTS")
# currently_blocked = False
# events = []
# try:
# events = yield self._message_handler.get_state_events(user_id, room_id, types=[(EventTypes.Pinned, None)])
# except AuthError as e:
# # The user has yet to join the server notices room
# pass
#
# pinned_event_refs = []
# for e in events:
# logger.info('events %s' % e)
# logger.info(type(e))
# for key, event_ids in e['content'].items():
# logger.info('Key Event %s %s' % (key, event_ids))
# if key == 'pinned':
# pinned_event_refs = event_ids
#
# logger.info('pinned_event_refs %s' % pinned_event_refs)
#
# events = yield self._store.get_events(pinned_event_refs)
# logger.info(events)
# for event_id, event in events.items():
# logger.info("event_id, event event.type %s %s %s" % (event_id, event, event.type))
# if event.type == 'm.server_notice.usage_limit_reached':
# currently_blocked = True
#
# logger.info('Currently Blocked is %r' % currently_blocked)
#for e in events:
# logger.info(e)
currently_blocked = False
logger.info("GET CURRENT STATE")
pinned_state_event = yield self._state.get_current_state(room_id, event_type=EventTypes.Pinned)
logger.info(events)
logger.info(events.get('content'))
referenced_events = []
if pinned_state_event is not None:
content = pinned_state_event.get('content')
if content is not None:
referenced_events = content.get('pinned')
events = yield self._store.get_events(referenced_events)
logger.info(events)
for event_id, event in events.items():
logger.info("event_id, event event.type %s %s %s" % (event_id, event, event.type))
if event.type == 'm.server_notice.usage_limit_reached':
currently_blocked = True
logger.info("currently_blocked is %r" % currently_blocked)
#event = yield self._store.get_event(events.event_id)
#logger.info(event)
#logger.info("GET CURRENT STATE IDs")
#events = yield self._state.get_current_state_ids(room_id)
#for k,v in events.items():
# logger.info('%s %s' % (k,v))
timestamp = yield self._store.user_last_seen_monthly_active(user_id) timestamp = yield self._store.user_last_seen_monthly_active(user_id)
if timestamp is None: if timestamp is None:
# This user will be blocked from receiving the notice anyway. # This user will be blocked from receiving the notice anyway.
# In practice, not sure we can ever get here # In practice, not sure we can ever get here
return return
room_id = yield self._server_notices_manager.get_notice_room_for_user(user_id)
currently_blocked = False
logger.info("GET CURRENT STATE")
pinned_state_event = None
try:
pinned_state_event = yield self._state.get_current_state(
room_id, event_type=EventTypes.Pinned
)
except AuthError as e:
# The user has yet to join the server notices room
pass
referenced_events = []
if pinned_state_event is not None:
referenced_events = pinned_state_event.content.get('pinned')
events = yield self._store.get_events(referenced_events)
logger.info(events)
for event_id, event in events.items():
logger.info("event_id, event event.type %s %s %s" % (
event_id, event, event.type)
)
if event.type == EventTypes.ServerNoticeLimitReached:
currently_blocked = True
logger.info("currently_blocked is %r" % currently_blocked)
try: try:
# Normally should always pass in user_id if you have it, but in # Normally should always pass in user_id if you have it, but in
# this case are checking what would happen to other users if they # this case are checking what would happen to other users if they
# were to arrive. # were to arrive.
yield self.auth.check_auth_blocking() yield self.auth.check_auth_blocking()
self._resouce_limited = False
# Need to start removing notices # Need to start removing notices
# if user_id in self._notified_of_blocking: # if user_id in self._notified_of_blocking:
if currently_blocked: if currently_blocked:
@ -142,7 +104,7 @@ class ResourceLimitsServerNotices(object):
# send state event here # send state event here
# How do I do this? if drop the id, how to refer to it? # How do I do this? if drop the id, how to refer to it?
content = { content = {
"pinned":[] "pinned": []
} }
yield self._server_notices_manager.send_notice( yield self._server_notices_manager.send_notice(
user_id, content, EventTypes.Pinned, '', user_id, content, EventTypes.Pinned, '',
@ -152,13 +114,11 @@ class ResourceLimitsServerNotices(object):
except AuthError as e: except AuthError as e:
# Need to start notifying of blocking # Need to start notifying of blocking
try: try:
self._resouce_limited = True
#if user_id not in self._notified_of_blocking:
if not currently_blocked: if not currently_blocked:
# TODO use admin email contained in error once PR lands # TODO use admin email contained in error once PR lands
content = { content = {
'body': e.msg, 'body': e.msg,
'admin_email': 'stunt@adminemail.com', 'admin_uri': self._admin_uri,
} }
event = yield self._server_notices_manager.send_notice( event = yield self._server_notices_manager.send_notice(
user_id, content, EventTypes.ServerNoticeLimitReached user_id, content, EventTypes.ServerNoticeLimitReached
@ -167,7 +127,7 @@ class ResourceLimitsServerNotices(object):
# send server notices state event here # send server notices state event here
# TODO Over writing pinned events # TODO Over writing pinned events
content = { content = {
"pinned":[ "pinned": [
event.event_id, event.event_id,
] ]
} }
@ -177,4 +137,4 @@ class ResourceLimitsServerNotices(object):
) )
except SynapseError as e: except SynapseError as e:
logger.error("Error sending server notice about resource limits: %s", e) logger.error("Error sending resource limits server notice: %s", e)

52
tests/server_notices/test_resource_limits_server_notices.py
View file

@ -2,6 +2,7 @@ from mock import Mock
from twisted.internet import defer from twisted.internet import defer
from synapse.api.constants import EventTypes
from synapse.api.errors import AuthError from synapse.api.errors import AuthError
from synapse.handlers.auth import AuthHandler from synapse.handlers.auth import AuthHandler
from synapse.server_notices.resource_limits_server_notices import ( from synapse.server_notices.resource_limits_server_notices import (
@ -20,7 +21,7 @@ class AuthHandlers(object):
class TestResourceLimitsServerNotices(unittest.TestCase): class TestResourceLimitsServerNotices(unittest.TestCase):
@defer.inlineCallbacks @defer.inlineCallbacks
def setUp(self): def setUp(self):
self.hs = yield setup_test_homeserver(handlers=None) self.hs = yield setup_test_homeserver(self.addCleanup, handlers=None)
self.hs.handlers = AuthHandlers(self.hs) self.hs.handlers = AuthHandlers(self.hs)
self.auth_handler = self.hs.handlers.auth_handler self.auth_handler = self.hs.handlers.auth_handler
self.server_notices_sender = self.hs.get_server_notices_sender() self.server_notices_sender = self.hs.get_server_notices_sender()
@ -37,10 +38,23 @@ class TestResourceLimitsServerNotices(unittest.TestCase):
) )
self._send_notice = self._rlsn._server_notices_manager.send_notice self._send_notice = self._rlsn._server_notices_manager.send_notice
self._rlsn._server_notices_manager.send_notice = Mock() self._rlsn._server_notices_manager.send_notice = Mock()
self._rlsn._state.get_current_state = Mock(return_value=defer.succeed(None))
self._rlsn._store.get_events = Mock(return_value=defer.succeed({}))
self._send_notice = self._rlsn._server_notices_manager.send_notice self._send_notice = self._rlsn._server_notices_manager.send_notice
self._rlsn._limit_usage_by_mau = True self._rlsn._limit_usage_by_mau = True
self.user_id = "user_id" self.user_id = "@user_id:test"
self.server_notices_mxid = "@server:test"
self.server_notices_mxid_display_name = None
self.server_notices_mxid_avatar_url = None
self.server_notices_room_name = "Server Notices"
self._rlsn._server_notices_manager.get_notice_room_for_user = Mock(
returnValue=""
)
self.hs.config.admin_uri = "mailto:user@test.com"
@defer.inlineCallbacks @defer.inlineCallbacks
def test_maybe_send_server_notice_to_user_flag_off(self): def test_maybe_send_server_notice_to_user_flag_off(self):
@ -48,13 +62,13 @@ class TestResourceLimitsServerNotices(unittest.TestCase):
# test hs disabled case # test hs disabled case
self._hs_disabled = True self._hs_disabled = True
yield self._rlsn.maybe_send_server_notice_to_user("user_id") yield self._rlsn.maybe_send_server_notice_to_user(self.user_id)
self._send_notice.assert_not_called() self._send_notice.assert_not_called()
# Test when mau limiting disabled # Test when mau limiting disabled
self._hs_disabled = False self._hs_disabled = False
self._rlsn._limit_usage_by_mau = False self._rlsn._limit_usage_by_mau = False
yield self._rlsn.maybe_send_server_notice_to_user("user_id") yield self._rlsn.maybe_send_server_notice_to_user(self.user_id)
self._send_notice.assert_not_called() self._send_notice.assert_not_called()
@ -62,40 +76,40 @@ class TestResourceLimitsServerNotices(unittest.TestCase):
def test_maybe_send_server_notice_to_user_remove_blocked_notice(self): def test_maybe_send_server_notice_to_user_remove_blocked_notice(self):
"""Test when user has blocked notice, but should have it removed""" """Test when user has blocked notice, but should have it removed"""
self._rlsn._notified_of_blocking.add(self.user_id)
self._rlsn.auth.check_auth_blocking = Mock() self._rlsn.auth.check_auth_blocking = Mock()
mock_event = Mock(type=EventTypes.ServerNoticeLimitReached)
self._rlsn._store.get_events = Mock(return_value=defer.succeed(
{"123": mock_event}
))
yield self._rlsn.maybe_send_server_notice_to_user(self.user_id) yield self._rlsn.maybe_send_server_notice_to_user(self.user_id)
# "remove warning" obviously aweful, but test will start failing when code # Would be better to check the content, but once == remove blocking event
# actually sends a real event, and then it can be updated self._send_notice.assert_called_once()
self._send_notice.assert_called_once_with(self.user_id, "remove warning")
self.assertFalse(self.user_id in self._rlsn._notified_of_blocking)
@defer.inlineCallbacks @defer.inlineCallbacks
def test_maybe_send_server_notice_to_user_remove_blocked_notice_noop(self): def test_maybe_send_server_notice_to_user_remove_blocked_notice_noop(self):
"""Test when user has blocked notice, but notice ought to be there (NOOP)""" """Test when user has blocked notice, but notice ought to be there (NOOP)"""
self._rlsn._notified_of_blocking.add(self.user_id)
self._rlsn.auth.check_auth_blocking = Mock( self._rlsn.auth.check_auth_blocking = Mock(
side_effect=AuthError(403, 'foo') side_effect=AuthError(403, 'foo')
) )
yield self._rlsn.maybe_send_server_notice_to_user("user_id") mock_event = Mock(type=EventTypes.ServerNoticeLimitReached)
self._rlsn._store.get_events = Mock(return_value=defer.succeed(
{"123": mock_event}
))
yield self._rlsn.maybe_send_server_notice_to_user(self.user_id)
self._send_notice.assert_not_called() self._send_notice.assert_not_called()
self.assertTrue(self.user_id in self._rlsn._notified_of_blocking)
@defer.inlineCallbacks @defer.inlineCallbacks
def test_maybe_send_server_notice_to_user_add_blocked_notice(self): def test_maybe_send_server_notice_to_user_add_blocked_notice(self):
"""Test when user does not have blocked notice, but should have one""" """Test when user does not have blocked notice, but should have one"""
self._rlsn.auth.check_auth_blocking = Mock(side_effect=AuthError(403, 'foo')) self._rlsn.auth.check_auth_blocking = Mock(side_effect=AuthError(403, 'foo'))
yield self._rlsn.maybe_send_server_notice_to_user("user_id") yield self._rlsn.maybe_send_server_notice_to_user(self.user_id)
# "add warning" obviously awful, but test will start failing when code # Would be better to check contents, but 2 calls == set blocking event
# actually sends a real event, and then it can be updated self.assertTrue(self._send_notice.call_count == 2)
self._send_notice.assert_called_once_with(self.user_id, "add warning")
self.assertTrue(self.user_id in self._rlsn._notified_of_blocking)
@defer.inlineCallbacks @defer.inlineCallbacks
def test_maybe_send_server_notice_to_user_add_blocked_notice_noop(self): def test_maybe_send_server_notice_to_user_add_blocked_notice_noop(self):
@ -106,7 +120,6 @@ class TestResourceLimitsServerNotices(unittest.TestCase):
yield self._rlsn.maybe_send_server_notice_to_user(self.user_id) yield self._rlsn.maybe_send_server_notice_to_user(self.user_id)
self._send_notice.assert_not_called() self._send_notice.assert_not_called()
self.assertFalse(self.user_id in self._rlsn._notified_of_blocking)
@defer.inlineCallbacks @defer.inlineCallbacks
def test_maybe_send_server_notice_to_user_not_in_mau_cohort(self): def test_maybe_send_server_notice_to_user_not_in_mau_cohort(self):
@ -122,4 +135,3 @@ class TestResourceLimitsServerNotices(unittest.TestCase):
yield self._rlsn.maybe_send_server_notice_to_user(self.user_id) yield self._rlsn.maybe_send_server_notice_to_user(self.user_id)
self._send_notice.assert_not_called() self._send_notice.assert_not_called()
self.assertFalse(self.user_id in self._rlsn._notified_of_blocking)