mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2025-05-08 00:45:00 -04:00
Support the stable /hierarchy endpoint from MSC2946 (#11329)
This also makes additional updates where the implementation had drifted from the approved MSC. Unstable endpoints will be removed at a later data.
This commit is contained in:
Patrick Cloke
GitHub
parent
d08ef6f155
commit
a4521ce0a8
11 changed files with 134 additions and 51 deletions
|
|
@ -32,7 +32,7 @@ from synapse.handlers.room_summary import _child_events_comparison_key, _RoomEnt
|
|||
from synapse.rest import admin
|
||||
from synapse.rest.client import login, room
|
||||
from synapse.server import HomeServer
|
||||
from synapse.types import JsonDict, UserID
|
||||
from synapse.types import JsonDict, UserID, create_requester
|
||||
|
||||
from tests import unittest
|
||||
|
||||
|
|
@ -249,7 +249,7 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
self._assert_rooms(result, expected)
|
||||
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space)
|
||||
self.handler.get_room_hierarchy(create_requester(self.user), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
|
|
@ -263,7 +263,9 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
expected = [(self.space, [self.room]), (self.room, ())]
|
||||
self._assert_rooms(result, expected)
|
||||
|
||||
result = self.get_success(self.handler.get_room_hierarchy(user2, self.space))
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(create_requester(user2), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
# If the space is made invite-only, it should no longer be viewable.
|
||||
|
|
@ -274,7 +276,10 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
tok=self.token,
|
||||
)
|
||||
self.get_failure(self.handler.get_space_summary(user2, self.space), AuthError)
|
||||
self.get_failure(self.handler.get_room_hierarchy(user2, self.space), AuthError)
|
||||
self.get_failure(
|
||||
self.handler.get_room_hierarchy(create_requester(user2), self.space),
|
||||
AuthError,
|
||||
)
|
||||
|
||||
# If the space is made world-readable it should return a result.
|
||||
self.helper.send_state(
|
||||
|
|
@ -286,7 +291,9 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
result = self.get_success(self.handler.get_space_summary(user2, self.space))
|
||||
self._assert_rooms(result, expected)
|
||||
|
||||
result = self.get_success(self.handler.get_room_hierarchy(user2, self.space))
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(create_requester(user2), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
# Make it not world-readable again and confirm it results in an error.
|
||||
|
|
@ -297,7 +304,10 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
tok=self.token,
|
||||
)
|
||||
self.get_failure(self.handler.get_space_summary(user2, self.space), AuthError)
|
||||
self.get_failure(self.handler.get_room_hierarchy(user2, self.space), AuthError)
|
||||
self.get_failure(
|
||||
self.handler.get_room_hierarchy(create_requester(user2), self.space),
|
||||
AuthError,
|
||||
)
|
||||
|
||||
# Join the space and results should be returned.
|
||||
self.helper.invite(self.space, targ=user2, tok=self.token)
|
||||
|
|
@ -305,7 +315,9 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
result = self.get_success(self.handler.get_space_summary(user2, self.space))
|
||||
self._assert_rooms(result, expected)
|
||||
|
||||
result = self.get_success(self.handler.get_room_hierarchy(user2, self.space))
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(create_requester(user2), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
# Attempting to view an unknown room returns the same error.
|
||||
|
|
@ -314,7 +326,9 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
AuthError,
|
||||
)
|
||||
self.get_failure(
|
||||
self.handler.get_room_hierarchy(user2, "#not-a-space:" + self.hs.hostname),
|
||||
self.handler.get_room_hierarchy(
|
||||
create_requester(user2), "#not-a-space:" + self.hs.hostname
|
||||
),
|
||||
AuthError,
|
||||
)
|
||||
|
||||
|
|
@ -322,10 +336,10 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
"""In-flight room hierarchy requests are deduplicated."""
|
||||
# Run two `get_room_hierarchy` calls up until they block.
|
||||
deferred1 = ensureDeferred(
|
||||
self.handler.get_room_hierarchy(self.user, self.space)
|
||||
self.handler.get_room_hierarchy(create_requester(self.user), self.space)
|
||||
)
|
||||
deferred2 = ensureDeferred(
|
||||
self.handler.get_room_hierarchy(self.user, self.space)
|
||||
self.handler.get_room_hierarchy(create_requester(self.user), self.space)
|
||||
)
|
||||
|
||||
# Complete the two calls.
|
||||
|
|
@ -340,7 +354,7 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
|
||||
# A subsequent `get_room_hierarchy` call should not reuse the result.
|
||||
result3 = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space)
|
||||
self.handler.get_room_hierarchy(create_requester(self.user), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result3, expected)
|
||||
self.assertIsNot(result1, result3)
|
||||
|
|
@ -359,9 +373,11 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
|
||||
# Run two `get_room_hierarchy` calls for different users up until they block.
|
||||
deferred1 = ensureDeferred(
|
||||
self.handler.get_room_hierarchy(self.user, self.space)
|
||||
self.handler.get_room_hierarchy(create_requester(self.user), self.space)
|
||||
)
|
||||
deferred2 = ensureDeferred(
|
||||
self.handler.get_room_hierarchy(create_requester(user2), self.space)
|
||||
)
|
||||
deferred2 = ensureDeferred(self.handler.get_room_hierarchy(user2, self.space))
|
||||
|
||||
# Complete the two calls.
|
||||
result1 = self.get_success(deferred1)
|
||||
|
|
@ -465,7 +481,9 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
]
|
||||
self._assert_rooms(result, expected)
|
||||
|
||||
result = self.get_success(self.handler.get_room_hierarchy(user2, self.space))
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(create_requester(user2), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
def test_complex_space(self):
|
||||
|
|
@ -507,7 +525,7 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
self._assert_rooms(result, expected)
|
||||
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space)
|
||||
self.handler.get_room_hierarchy(create_requester(self.user), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
|
|
@ -522,7 +540,9 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
room_ids.append(self.room)
|
||||
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space, limit=7)
|
||||
self.handler.get_room_hierarchy(
|
||||
create_requester(self.user), self.space, limit=7
|
||||
)
|
||||
)
|
||||
# The result should have the space and all of the links, plus some of the
|
||||
# rooms and a pagination token.
|
||||
|
|
@ -534,7 +554,10 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
# Check the next page.
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(
|
||||
self.user, self.space, limit=5, from_token=result["next_batch"]
|
||||
create_requester(self.user),
|
||||
self.space,
|
||||
limit=5,
|
||||
from_token=result["next_batch"],
|
||||
)
|
||||
)
|
||||
# The result should have the space and the room in it, along with a link
|
||||
|
|
@ -554,20 +577,22 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
room_ids.append(self.room)
|
||||
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space, limit=7)
|
||||
self.handler.get_room_hierarchy(
|
||||
create_requester(self.user), self.space, limit=7
|
||||
)
|
||||
)
|
||||
self.assertIn("next_batch", result)
|
||||
|
||||
# Changing the room ID, suggested-only, or max-depth causes an error.
|
||||
self.get_failure(
|
||||
self.handler.get_room_hierarchy(
|
||||
self.user, self.room, from_token=result["next_batch"]
|
||||
create_requester(self.user), self.room, from_token=result["next_batch"]
|
||||
),
|
||||
SynapseError,
|
||||
)
|
||||
self.get_failure(
|
||||
self.handler.get_room_hierarchy(
|
||||
self.user,
|
||||
create_requester(self.user),
|
||||
self.space,
|
||||
suggested_only=True,
|
||||
from_token=result["next_batch"],
|
||||
|
|
@ -576,14 +601,19 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
)
|
||||
self.get_failure(
|
||||
self.handler.get_room_hierarchy(
|
||||
self.user, self.space, max_depth=0, from_token=result["next_batch"]
|
||||
create_requester(self.user),
|
||||
self.space,
|
||||
max_depth=0,
|
||||
from_token=result["next_batch"],
|
||||
),
|
||||
SynapseError,
|
||||
)
|
||||
|
||||
# An invalid token is ignored.
|
||||
self.get_failure(
|
||||
self.handler.get_room_hierarchy(self.user, self.space, from_token="foo"),
|
||||
self.handler.get_room_hierarchy(
|
||||
create_requester(self.user), self.space, from_token="foo"
|
||||
),
|
||||
SynapseError,
|
||||
)
|
||||
|
||||
|
|
@ -609,14 +639,18 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
|
||||
# Test just the space itself.
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space, max_depth=0)
|
||||
self.handler.get_room_hierarchy(
|
||||
create_requester(self.user), self.space, max_depth=0
|
||||
)
|
||||
)
|
||||
expected: List[Tuple[str, Iterable[str]]] = [(spaces[0], [rooms[0], spaces[1]])]
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
# A single additional layer.
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space, max_depth=1)
|
||||
self.handler.get_room_hierarchy(
|
||||
create_requester(self.user), self.space, max_depth=1
|
||||
)
|
||||
)
|
||||
expected += [
|
||||
(rooms[0], ()),
|
||||
|
|
@ -626,7 +660,9 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
|
||||
# A few layers.
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space, max_depth=3)
|
||||
self.handler.get_room_hierarchy(
|
||||
create_requester(self.user), self.space, max_depth=3
|
||||
)
|
||||
)
|
||||
expected += [
|
||||
(rooms[1], ()),
|
||||
|
|
@ -657,7 +693,7 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
self._assert_rooms(result, expected)
|
||||
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space)
|
||||
self.handler.get_room_hierarchy(create_requester(self.user), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
|
|
@ -739,7 +775,7 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
new=summarize_remote_room_hierarchy,
|
||||
):
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space)
|
||||
self.handler.get_room_hierarchy(create_requester(self.user), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
|
|
@ -906,7 +942,7 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
new=summarize_remote_room_hierarchy,
|
||||
):
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space)
|
||||
self.handler.get_room_hierarchy(create_requester(self.user), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
|
|
@ -964,7 +1000,7 @@ class SpaceSummaryTestCase(unittest.HomeserverTestCase):
|
|||
new=summarize_remote_room_hierarchy,
|
||||
):
|
||||
result = self.get_success(
|
||||
self.handler.get_room_hierarchy(self.user, self.space)
|
||||
self.handler.get_room_hierarchy(create_requester(self.user), self.space)
|
||||
)
|
||||
self._assert_hierarchy(result, expected)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue