Faster Room Joins: don't leave a stuck room partial state flag if the join fails. (#13403)

This commit is contained in:
reivilibre 2022-08-01 16:45:39 +00:00 committed by GitHub
parent f8e7a9418a
commit e17e5c97e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 140 additions and 15 deletions

1
changelog.d/13403.misc Normal file
View File

@ -0,0 +1 @@
Faster Room Joins: don't leave a stuck room partial state flag if the join fails.

View File

@ -546,9 +546,9 @@ class FederationHandler:
) )
if ret.partial_state: if ret.partial_state:
# TODO(faster_joins): roll this back if we don't manage to start the # Mark the room as having partial state.
# background resync (eg process_remote_join fails) # The background process is responsible for unmarking this flag,
# https://github.com/matrix-org/synapse/issues/12998 # even if the join fails.
await self.store.store_partial_state_room(room_id, ret.servers_in_room) await self.store.store_partial_state_room(room_id, ret.servers_in_room)
try: try:
@ -574,17 +574,21 @@ class FederationHandler:
room_id, room_id,
) )
raise LimitExceededError(msg=e.msg, errcode=e.errcode, retry_after_ms=0) raise LimitExceededError(msg=e.msg, errcode=e.errcode, retry_after_ms=0)
finally:
if ret.partial_state: # Always kick off the background process that asynchronously fetches
# Kick off the process of asynchronously fetching the state for this # state for the room.
# room. # If the join failed, the background process is responsible for
run_as_background_process( # cleaning up — including unmarking the room as a partial state room.
desc="sync_partial_state_room", if ret.partial_state:
func=self._sync_partial_state_room, # Kick off the process of asynchronously fetching the state for this
initial_destination=origin, # room.
other_destinations=ret.servers_in_room, run_as_background_process(
room_id=room_id, desc="sync_partial_state_room",
) func=self._sync_partial_state_room,
initial_destination=origin,
other_destinations=ret.servers_in_room,
room_id=room_id,
)
# We wait here until this instance has seen the events come down # We wait here until this instance has seen the events come down
# replication (if we're using replication) as the below uses caches. # replication (if we're using replication) as the below uses caches.

View File

@ -14,6 +14,7 @@
import logging import logging
from typing import cast from typing import cast
from unittest import TestCase from unittest import TestCase
from unittest.mock import Mock, patch
from twisted.test.proto_helpers import MemoryReactor from twisted.test.proto_helpers import MemoryReactor
@ -22,6 +23,7 @@ from synapse.api.errors import AuthError, Codes, LimitExceededError, SynapseErro
from synapse.api.room_versions import RoomVersions from synapse.api.room_versions import RoomVersions
from synapse.events import EventBase, make_event_from_dict from synapse.events import EventBase, make_event_from_dict
from synapse.federation.federation_base import event_from_pdu_json from synapse.federation.federation_base import event_from_pdu_json
from synapse.federation.federation_client import SendJoinResult
from synapse.logging.context import LoggingContext, run_in_background from synapse.logging.context import LoggingContext, run_in_background
from synapse.rest import admin from synapse.rest import admin
from synapse.rest.client import login, room from synapse.rest.client import login, room
@ -30,7 +32,7 @@ from synapse.util import Clock
from synapse.util.stringutils import random_string from synapse.util.stringutils import random_string
from tests import unittest from tests import unittest
from tests.test_utils import event_injection from tests.test_utils import event_injection, make_awaitable
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@ -456,3 +458,121 @@ class EventFromPduTestCase(TestCase):
}, },
RoomVersions.V6, RoomVersions.V6,
) )
class PartialJoinTestCase(unittest.FederatingHomeserverTestCase):
def test_failed_partial_join_is_clean(self) -> None:
"""
Tests that, when failing to partial-join a room, we don't get stuck with
a partial-state flag on a room.
"""
fed_handler = self.hs.get_federation_handler()
fed_client = fed_handler.federation_client
room_id = "!room:example.com"
membership_event = make_event_from_dict(
{
"room_id": room_id,
"type": "m.room.member",
"sender": "@alice:test",
"state_key": "@alice:test",
"content": {"membership": "join"},
},
RoomVersions.V10,
)
mock_make_membership_event = Mock(
return_value=make_awaitable(
(
"example.com",
membership_event,
RoomVersions.V10,
)
)
)
EVENT_CREATE = make_event_from_dict(
{
"room_id": room_id,
"type": "m.room.create",
"sender": "@kristina:example.com",
"state_key": "",
"depth": 0,
"content": {"creator": "@kristina:example.com", "room_version": "10"},
"auth_events": [],
"origin_server_ts": 1,
},
room_version=RoomVersions.V10,
)
EVENT_CREATOR_MEMBERSHIP = make_event_from_dict(
{
"room_id": room_id,
"type": "m.room.member",
"sender": "@kristina:example.com",
"state_key": "@kristina:example.com",
"content": {"membership": "join"},
"depth": 1,
"prev_events": [EVENT_CREATE.event_id],
"auth_events": [EVENT_CREATE.event_id],
"origin_server_ts": 1,
},
room_version=RoomVersions.V10,
)
EVENT_INVITATION_MEMBERSHIP = make_event_from_dict(
{
"room_id": room_id,
"type": "m.room.member",
"sender": "@kristina:example.com",
"state_key": "@alice:test",
"content": {"membership": "invite"},
"depth": 2,
"prev_events": [EVENT_CREATOR_MEMBERSHIP.event_id],
"auth_events": [
EVENT_CREATE.event_id,
EVENT_CREATOR_MEMBERSHIP.event_id,
],
"origin_server_ts": 1,
},
room_version=RoomVersions.V10,
)
mock_send_join = Mock(
return_value=make_awaitable(
SendJoinResult(
membership_event,
"example.com",
state=[
EVENT_CREATE,
EVENT_CREATOR_MEMBERSHIP,
EVENT_INVITATION_MEMBERSHIP,
],
auth_chain=[
EVENT_CREATE,
EVENT_CREATOR_MEMBERSHIP,
EVENT_INVITATION_MEMBERSHIP,
],
partial_state=True,
servers_in_room=["example.com"],
)
)
)
with patch.object(
fed_client, "make_membership_event", mock_make_membership_event
), patch.object(fed_client, "send_join", mock_send_join):
# Join and check that our join event is rejected
# (The join event is rejected because it doesn't have any signatures)
join_exc = self.get_failure(
fed_handler.do_invite_join(["example.com"], room_id, "@alice:test", {}),
SynapseError,
)
self.assertIn("Join event was rejected", str(join_exc))
store = self.hs.get_datastores().main
# Check that we don't have a left-over partial_state entry.
self.assertFalse(
self.get_success(store.is_partial_state_room(room_id)),
f"Stale partial-stated room flag left over for {room_id} after a"
f" failed do_invite_join!",
)