165 lines
6.1 KiB
Python
165 lines
6.1 KiB
Python
# Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
#
|
|
# 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 unittest.mock import Mock
|
|
|
|
from synapse.handlers.typing import RoomMember, TypingWriterHandler
|
|
from synapse.replication.tcp.streams import TypingStream
|
|
from synapse.util.caches.stream_change_cache import StreamChangeCache
|
|
|
|
from tests.replication._base import BaseStreamTestCase
|
|
|
|
USER_ID = "@feeling:blue"
|
|
USER_ID_2 = "@da-ba-dee:blue"
|
|
|
|
ROOM_ID = "!bar:blue"
|
|
ROOM_ID_2 = "!foo:blue"
|
|
|
|
|
|
class TypingStreamTestCase(BaseStreamTestCase):
|
|
def _build_replication_data_handler(self) -> Mock:
|
|
self.mock_handler = Mock(wraps=super()._build_replication_data_handler())
|
|
return self.mock_handler
|
|
|
|
def test_typing(self) -> None:
|
|
typing = self.hs.get_typing_handler()
|
|
assert isinstance(typing, TypingWriterHandler)
|
|
|
|
# Create a typing update before we reconnect so that there is a missing
|
|
# update to fetch.
|
|
typing._push_update(member=RoomMember(ROOM_ID, USER_ID), typing=True)
|
|
|
|
self.reconnect()
|
|
|
|
typing._push_update(member=RoomMember(ROOM_ID, USER_ID), typing=True)
|
|
|
|
self.reactor.advance(0)
|
|
|
|
# We should now see an attempt to connect to the master
|
|
request = self.handle_http_replication_attempt()
|
|
self.assert_request_is_get_repl_stream_updates(request, "typing")
|
|
|
|
self.mock_handler.on_rdata.assert_called_once()
|
|
stream_name, _, token, rdata_rows = self.mock_handler.on_rdata.call_args[0]
|
|
self.assertEqual(stream_name, "typing")
|
|
self.assertEqual(1, len(rdata_rows))
|
|
row: TypingStream.TypingStreamRow = rdata_rows[0]
|
|
self.assertEqual(ROOM_ID, row.room_id)
|
|
self.assertEqual([USER_ID], row.user_ids)
|
|
|
|
# Now let's disconnect and insert some data.
|
|
self.disconnect()
|
|
|
|
self.mock_handler.on_rdata.reset_mock()
|
|
|
|
typing._push_update(member=RoomMember(ROOM_ID, USER_ID), typing=False)
|
|
|
|
self.mock_handler.on_rdata.assert_not_called()
|
|
|
|
self.reconnect()
|
|
self.pump(0.1)
|
|
|
|
# We should now see an attempt to connect to the master
|
|
request = self.handle_http_replication_attempt()
|
|
self.assert_request_is_get_repl_stream_updates(request, "typing")
|
|
|
|
# The from token should be the token from the last RDATA we got.
|
|
assert request.args is not None
|
|
self.assertEqual(int(request.args[b"from_token"][0]), token)
|
|
|
|
self.mock_handler.on_rdata.assert_called_once()
|
|
stream_name, _, token, rdata_rows = self.mock_handler.on_rdata.call_args[0]
|
|
self.assertEqual(stream_name, "typing")
|
|
self.assertEqual(1, len(rdata_rows))
|
|
row = rdata_rows[0]
|
|
self.assertEqual(ROOM_ID, row.room_id)
|
|
self.assertEqual([], row.user_ids)
|
|
|
|
def test_reset(self) -> None:
|
|
"""
|
|
Test what happens when a typing stream resets.
|
|
|
|
This is emulated by jumping the stream ahead, then reconnecting (which
|
|
sends the proper position and RDATA).
|
|
"""
|
|
typing = self.hs.get_typing_handler()
|
|
assert isinstance(typing, TypingWriterHandler)
|
|
|
|
# Create a typing update before we reconnect so that there is a missing
|
|
# update to fetch.
|
|
typing._push_update(member=RoomMember(ROOM_ID, USER_ID), typing=True)
|
|
|
|
self.reconnect()
|
|
|
|
typing._push_update(member=RoomMember(ROOM_ID, USER_ID), typing=True)
|
|
|
|
self.reactor.advance(0)
|
|
|
|
# We should now see an attempt to connect to the master
|
|
request = self.handle_http_replication_attempt()
|
|
self.assert_request_is_get_repl_stream_updates(request, "typing")
|
|
|
|
self.mock_handler.on_rdata.assert_called_once()
|
|
stream_name, _, token, rdata_rows = self.mock_handler.on_rdata.call_args[0]
|
|
self.assertEqual(stream_name, "typing")
|
|
self.assertEqual(1, len(rdata_rows))
|
|
row: TypingStream.TypingStreamRow = rdata_rows[0]
|
|
self.assertEqual(ROOM_ID, row.room_id)
|
|
self.assertEqual([USER_ID], row.user_ids)
|
|
|
|
# Push the stream forward a bunch so it can be reset.
|
|
for i in range(100):
|
|
typing._push_update(
|
|
member=RoomMember(ROOM_ID, "@test%s:blue" % i), typing=True
|
|
)
|
|
self.reactor.advance(0)
|
|
|
|
# Disconnect.
|
|
self.disconnect()
|
|
|
|
# Reset the typing handler
|
|
self.hs.get_replication_streams()["typing"].last_token = 0
|
|
self.hs.get_replication_command_handler()._streams["typing"].last_token = 0
|
|
typing._latest_room_serial = 0
|
|
typing._typing_stream_change_cache = StreamChangeCache(
|
|
"TypingStreamChangeCache", typing._latest_room_serial
|
|
)
|
|
typing._reset()
|
|
|
|
# Reconnect.
|
|
self.reconnect()
|
|
self.pump(0.1)
|
|
|
|
# We should now see an attempt to connect to the master
|
|
request = self.handle_http_replication_attempt()
|
|
self.assert_request_is_get_repl_stream_updates(request, "typing")
|
|
|
|
# Reset the test code.
|
|
self.mock_handler.on_rdata.reset_mock()
|
|
self.mock_handler.on_rdata.assert_not_called()
|
|
|
|
# Push additional data.
|
|
typing._push_update(member=RoomMember(ROOM_ID_2, USER_ID_2), typing=False)
|
|
self.reactor.advance(0)
|
|
|
|
self.mock_handler.on_rdata.assert_called_once()
|
|
stream_name, _, token, rdata_rows = self.mock_handler.on_rdata.call_args[0]
|
|
self.assertEqual(stream_name, "typing")
|
|
self.assertEqual(1, len(rdata_rows))
|
|
row = rdata_rows[0]
|
|
self.assertEqual(ROOM_ID_2, row.room_id)
|
|
self.assertEqual([], row.user_ids)
|
|
|
|
# The token should have been reset.
|
|
self.assertEqual(token, 1)
|