2014-12-11 10:39:08 -07:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-06 21:26:29 -07:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2014-12-11 10:39:08 -07:00
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
|
|
|
|
"""Tests REST events for /rooms paths."""
|
|
|
|
|
2018-07-09 00:09:20 -06:00
|
|
|
from mock import Mock, NonCallableMock
|
|
|
|
|
2014-12-11 10:39:08 -07:00
|
|
|
# twisted imports
|
|
|
|
from twisted.internet import defer
|
|
|
|
|
2015-01-22 09:10:07 -07:00
|
|
|
import synapse.rest.client.v1.room
|
2015-01-23 04:47:15 -07:00
|
|
|
from synapse.types import UserID
|
2014-12-11 10:39:08 -07:00
|
|
|
|
2018-07-09 00:09:20 -06:00
|
|
|
from ....utils import MockClock, MockHttpResource, setup_test_homeserver
|
2014-12-11 10:39:08 -07:00
|
|
|
from .utils import RestTestCase
|
|
|
|
|
|
|
|
PATH_PREFIX = "/_matrix/client/api/v1"
|
|
|
|
|
|
|
|
|
|
|
|
class RoomTypingTestCase(RestTestCase):
|
|
|
|
""" Tests /rooms/$room_id/typing/$user_id REST API. """
|
|
|
|
user_id = "@sid:red"
|
|
|
|
|
2015-04-15 16:32:11 -06:00
|
|
|
user = UserID.from_string(user_id)
|
|
|
|
|
2014-12-11 10:39:08 -07:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def setUp(self):
|
2015-01-12 11:31:48 -07:00
|
|
|
self.clock = MockClock()
|
|
|
|
|
2014-12-11 10:39:08 -07:00
|
|
|
self.mock_resource = MockHttpResource(prefix=PATH_PREFIX)
|
|
|
|
self.auth_user_id = self.user_id
|
|
|
|
|
2015-02-11 04:37:30 -07:00
|
|
|
hs = yield setup_test_homeserver(
|
2014-12-11 10:39:08 -07:00
|
|
|
"red",
|
2015-01-12 11:31:48 -07:00
|
|
|
clock=self.clock,
|
2014-12-11 10:39:08 -07:00
|
|
|
http_client=None,
|
2018-03-13 07:26:52 -06:00
|
|
|
federation_client=Mock(),
|
2014-12-11 10:39:08 -07:00
|
|
|
ratelimiter=NonCallableMock(spec_set=[
|
|
|
|
"send_message",
|
|
|
|
]),
|
|
|
|
)
|
|
|
|
self.hs = hs
|
|
|
|
|
|
|
|
self.event_source = hs.get_event_sources().sources["typing"]
|
|
|
|
|
|
|
|
self.ratelimiter = hs.get_ratelimiter()
|
|
|
|
self.ratelimiter.send_message.return_value = (True, 0)
|
|
|
|
|
|
|
|
hs.get_handlers().federation_handler = Mock()
|
|
|
|
|
2016-03-07 10:32:36 -07:00
|
|
|
def get_user_by_access_token(token=None, allow_guest=False):
|
2014-12-11 10:39:08 -07:00
|
|
|
return {
|
2015-09-01 05:41:16 -06:00
|
|
|
"user": UserID.from_string(self.auth_user_id),
|
2015-01-28 09:58:23 -07:00
|
|
|
"token_id": 1,
|
2015-11-04 10:29:07 -07:00
|
|
|
"is_guest": False,
|
2014-12-11 10:39:08 -07:00
|
|
|
}
|
|
|
|
|
2018-04-30 13:58:30 -06:00
|
|
|
hs.get_auth().get_user_by_access_token = get_user_by_access_token
|
2014-12-11 10:39:08 -07:00
|
|
|
|
|
|
|
def _insert_client_ip(*args, **kwargs):
|
|
|
|
return defer.succeed(None)
|
|
|
|
hs.get_datastore().insert_client_ip = _insert_client_ip
|
|
|
|
|
2015-01-12 11:31:48 -07:00
|
|
|
def get_room_members(room_id):
|
|
|
|
if room_id == self.room_id:
|
2015-04-15 16:32:11 -06:00
|
|
|
return defer.succeed([self.user])
|
2015-01-12 11:31:48 -07:00
|
|
|
else:
|
|
|
|
return defer.succeed([])
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2016-02-19 08:34:38 -07:00
|
|
|
def fetch_room_distributions_into(
|
|
|
|
room_id, localusers=None, remotedomains=None, ignore_user=None
|
|
|
|
):
|
2015-01-12 11:31:48 -07:00
|
|
|
members = yield get_room_members(room_id)
|
|
|
|
for member in members:
|
|
|
|
if ignore_user is not None and member == ignore_user:
|
|
|
|
continue
|
|
|
|
|
|
|
|
if hs.is_mine(member):
|
|
|
|
if localusers is not None:
|
|
|
|
localusers.add(member)
|
|
|
|
else:
|
|
|
|
if remotedomains is not None:
|
|
|
|
remotedomains.add(member.domain)
|
2018-03-01 03:54:37 -07:00
|
|
|
hs.get_room_member_handler().fetch_room_distributions_into = (
|
2016-02-19 08:34:38 -07:00
|
|
|
fetch_room_distributions_into
|
|
|
|
)
|
2015-01-12 11:31:48 -07:00
|
|
|
|
2015-01-22 09:10:07 -07:00
|
|
|
synapse.rest.client.v1.room.register_servlets(hs, self.mock_resource)
|
2014-12-11 10:39:08 -07:00
|
|
|
|
|
|
|
self.room_id = yield self.create_room_as(self.user_id)
|
|
|
|
# Need another user to make notifications actually work
|
|
|
|
yield self.join(self.room_id, user="@jim:red")
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_set_typing(self):
|
2016-02-19 08:34:38 -07:00
|
|
|
(code, _) = yield self.mock_resource.trigger(
|
|
|
|
"PUT", "/rooms/%s/typing/%s" % (self.room_id, self.user_id),
|
2014-12-11 10:39:08 -07:00
|
|
|
'{"typing": true, "timeout": 30000}'
|
|
|
|
)
|
|
|
|
self.assertEquals(200, code)
|
|
|
|
|
|
|
|
self.assertEquals(self.event_source.get_current_key(), 1)
|
2015-11-05 07:32:26 -07:00
|
|
|
events = yield self.event_source.get_new_events(
|
|
|
|
from_key=0,
|
|
|
|
room_ids=[self.room_id],
|
|
|
|
)
|
2016-02-19 08:34:38 -07:00
|
|
|
self.assertEquals(events[0], [{
|
|
|
|
"type": "m.typing",
|
|
|
|
"room_id": self.room_id,
|
|
|
|
"content": {
|
|
|
|
"user_ids": [self.user_id],
|
|
|
|
}
|
|
|
|
}])
|
2014-12-11 10:39:08 -07:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_set_not_typing(self):
|
2016-02-19 08:34:38 -07:00
|
|
|
(code, _) = yield self.mock_resource.trigger(
|
|
|
|
"PUT", "/rooms/%s/typing/%s" % (self.room_id, self.user_id),
|
2014-12-11 10:39:08 -07:00
|
|
|
'{"typing": false}'
|
|
|
|
)
|
|
|
|
self.assertEquals(200, code)
|
2015-01-12 11:31:48 -07:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_typing_timeout(self):
|
2016-02-19 08:34:38 -07:00
|
|
|
(code, _) = yield self.mock_resource.trigger(
|
|
|
|
"PUT", "/rooms/%s/typing/%s" % (self.room_id, self.user_id),
|
2015-01-12 11:31:48 -07:00
|
|
|
'{"typing": true, "timeout": 30000}'
|
|
|
|
)
|
|
|
|
self.assertEquals(200, code)
|
|
|
|
|
|
|
|
self.assertEquals(self.event_source.get_current_key(), 1)
|
|
|
|
|
2016-09-23 06:56:14 -06:00
|
|
|
self.clock.advance_time(36)
|
2015-01-12 11:31:48 -07:00
|
|
|
|
|
|
|
self.assertEquals(self.event_source.get_current_key(), 2)
|
|
|
|
|
2016-02-19 08:34:38 -07:00
|
|
|
(code, _) = yield self.mock_resource.trigger(
|
|
|
|
"PUT", "/rooms/%s/typing/%s" % (self.room_id, self.user_id),
|
2015-01-12 11:31:48 -07:00
|
|
|
'{"typing": true, "timeout": 30000}'
|
|
|
|
)
|
|
|
|
self.assertEquals(200, code)
|
|
|
|
|
|
|
|
self.assertEquals(self.event_source.get_current_key(), 3)
|