From 15568d4b0bf4eb8de01603176e8b0ef1d458618e Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Wed, 2 Jun 2021 11:07:08 -0400 Subject: [PATCH 1/2] Add tests to ensure that invite-only rooms are not shown unless a user has permission to see them. --- tests/msc2946_test.go | 151 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 150 insertions(+), 1 deletion(-) diff --git a/tests/msc2946_test.go b/tests/msc2946_test.go index fc98cc17..0f7d08e7 100644 --- a/tests/msc2946_test.go +++ b/tests/msc2946_test.go @@ -47,7 +47,7 @@ func eventKey(srcRoomID, dstRoomID, evType string) string { // - Querying the root returns the entire graph // - Setting max_rooms_per_space works correctly // - Setting limit works correctly -// - Rooms are returned correctly along with the custom fields `num_refs` and `room_type`. +// - Rooms are returned correctly along with the custom fields `room_type`. // - Events are returned correctly. // - Redacting links works correctly. func TestClientSpacesSummary(t *testing.T) { @@ -258,6 +258,155 @@ func TestClientSpacesSummary(t *testing.T) { }) } +// Tests that the CS API for MSC2946 correctly handles join rules. Creates a space directory like: +// Root +// | +// _____| +// | | +// R1 SS1 +// |________ +// | | +// R2 R3 +// +// Where: +// - All rooms and spaces are invite-only, except R2 (which is public) +// - The links are just children links. +// +// Tests that: +// - Rooms/spaces the user not invited to should not appear. +func TestClientSpacesSummaryJoinRules(t *testing.T) { + deployment := Deploy(t, b.BlueprintOneToOneRoom) + defer deployment.Destroy(t) + + // create the rooms + alice := deployment.Client(t, "hs1", "@alice:hs1") + root := alice.CreateRoom(t, map[string]interface{}{ + "preset": "public_chat", + "name": "Root", + }) + r1 := alice.CreateRoom(t, map[string]interface{}{ + "preset": "private_chat", + "name": "R1", + }) + ss1 := alice.CreateRoom(t, map[string]interface{}{ + "preset": "private_chat", + "name": "Sub-Space 1", + "creation_content": map[string]interface{}{ + "type": "m.space", + }, + }) + r2 := alice.CreateRoom(t, map[string]interface{}{ + "preset": "public_chat", + "name": "R2", + "initial_state": []map[string]interface{}{ + { + "type": "m.room.history_visibility", + "state_key": "", + "content": map[string]string{ + "history_visibility": "world_readable", + }, + }, + }, + }) + r3 := alice.CreateRoom(t, map[string]interface{}{ + "preset": "private_chat", + "name": "R3", + }) + + // create the links + rootToR1 := eventKey(root, r1, spaceChildEventType) + alice.SendEventSynced(t, root, b.Event{ + Type: spaceChildEventType, + StateKey: &r1, + Content: map[string]interface{}{ + "via": []string{"hs1"}, + }, + }) + rootToSS1 := eventKey(root, ss1, spaceChildEventType) + alice.SendEventSynced(t, root, b.Event{ + Type: spaceChildEventType, + StateKey: &ss1, + Content: map[string]interface{}{ + "via": []string{"hs1"}, + }, + }) + ss1ToR2 := eventKey(ss1, r2, spaceChildEventType) + alice.SendEventSynced(t, ss1, b.Event{ + Type: spaceChildEventType, + StateKey: &r2, + Content: map[string]interface{}{ + "via": []string{"hs1"}, + }, + }) + ss1ToR3 := eventKey(ss1, r3, spaceChildEventType) + alice.SendEventSynced(t, ss1, b.Event{ + Type: spaceChildEventType, + StateKey: &r3, + Content: map[string]interface{}{ + "via": []string{"hs1"}, + }, + }) + + // Querying is done by bob who is not yet in any of the rooms. + bob := deployment.Client(t, "hs1", "@bob:hs1") + bob.JoinRoom(t, root, []string{"hs1"}) + + res := bob.MustDo(t, "GET", []string{"_matrix", "client", "unstable", "org.matrix.msc2946", "rooms", root, "spaces"}, nil) + must.MatchResponse(t, res, match.HTTPResponse{ + JSON: []match.JSON{ + match.JSONCheckOff("rooms", []interface{}{ + root, + }, func(r gjson.Result) interface{} { + return r.Get("room_id").Str + }, nil), + match.JSONCheckOff("events", []interface{}{ + rootToR1, rootToSS1, + }, func(r gjson.Result) interface{} { + return eventKey(r.Get("room_id").Str, r.Get("state_key").Str, r.Get("type").Str) + }, nil), + }, + }) + + // Invite to R1 and R3, querying again should only show R1 (since SS1 is not visible). + alice.InviteRoom(t, r1, bob.UserID) + alice.InviteRoom(t, r3, bob.UserID) + + res = bob.MustDo(t, "GET", []string{"_matrix", "client", "unstable", "org.matrix.msc2946", "rooms", root, "spaces"}, nil) + must.MatchResponse(t, res, match.HTTPResponse{ + JSON: []match.JSON{ + match.JSONCheckOff("rooms", []interface{}{ + root, r1, + }, func(r gjson.Result) interface{} { + return r.Get("room_id").Str + }, nil), + match.JSONCheckOff("events", []interface{}{ + rootToR1, rootToSS1, + }, func(r gjson.Result) interface{} { + return eventKey(r.Get("room_id").Str, r.Get("state_key").Str, r.Get("type").Str) + }, nil), + }, + }) + + // Invite to SS1 and it now appears, as well as the rooms under it. + alice.InviteRoom(t, ss1, bob.UserID) + + res = bob.MustDo(t, "GET", []string{"_matrix", "client", "unstable", "org.matrix.msc2946", "rooms", root, "spaces"}, nil) + must.MatchResponse(t, res, match.HTTPResponse{ + JSON: []match.JSON{ + match.JSONCheckOff("rooms", []interface{}{ + root, r1, ss1, r2, r3, + }, func(r gjson.Result) interface{} { + return r.Get("room_id").Str + }, nil), + match.JSONCheckOff("events", []interface{}{ + rootToR1, rootToSS1, ss1ToR2, ss1ToR3, + }, func(r gjson.Result) interface{} { + return eventKey(r.Get("room_id").Str, r.Get("state_key").Str, r.Get("type").Str) + }, nil), + }, + }) +} + // Tests that MSC2946 works over federation. Creates a space directory like: // ROOT // | From 83bf15d2740e28e56cc06d74035a45b188467195 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Wed, 2 Jun 2021 13:39:09 -0400 Subject: [PATCH 2/2] Fix typo. Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> --- tests/msc2946_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/msc2946_test.go b/tests/msc2946_test.go index 0f7d08e7..d718287a 100644 --- a/tests/msc2946_test.go +++ b/tests/msc2946_test.go @@ -273,7 +273,7 @@ func TestClientSpacesSummary(t *testing.T) { // - The links are just children links. // // Tests that: -// - Rooms/spaces the user not invited to should not appear. +// - Rooms/spaces the user is not invited to should not appear. func TestClientSpacesSummaryJoinRules(t *testing.T) { deployment := Deploy(t, b.BlueprintOneToOneRoom) defer deployment.Destroy(t)