Merge branch 'main' into kegan/lock-create-room

Author: kegsay

.github/workflows/ci.yaml

@@ -42,7 +42,7 @@ jobs:
           - homeserver: Synapse
             repo: element-hq/synapse
             tags: synapse_blacklist
-            packages: ./tests/msc3874 ./tests/msc3902
+            packages: ./tests/msc3874 ./tests/msc3902 ./tests/msc4306
             env: "COMPLEMENT_ENABLE_DIRTY_RUNS=1 COMPLEMENT_SHARE_ENV_PREFIX=PASS_ PASS_SYNAPSE_COMPLEMENT_DATABASE=sqlite"
             timeout: 20m
 

client/client.go

@@ -8,6 +8,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"log"
 	"math/rand"
 	"net/http"
 	"net/http/httputil"
@@ -294,12 +295,12 @@ func (c *CSAPI) GetAllPushRules(t ct.TestLike) gjson.Result {
 	return gjson.ParseBytes(pushRulesBytes)
 }
 
-// GetPushRule queries the contents of a client's push rule by scope, kind and rule ID.
+// MustGetPushRule queries the contents of a client's push rule by scope, kind and rule ID.
 // A parsed gjson result is returned. Fails the test if the query to server returns a non-2xx status code.
 //
 // Example of checking that a global underride rule contains the expected actions:
 //
-//	containsDisplayNameRule := c.GetPushRule(t, "global", "underride", ".m.rule.contains_display_name")
+//	containsDisplayNameRule := c.MustGetPushRule(t, "global", "underride", ".m.rule.contains_display_name")
 //	must.MatchGJSON(
 //	  t,
 //	  containsDisplayNameRule,
@@ -309,14 +310,23 @@ func (c *CSAPI) GetAllPushRules(t ct.TestLike) gjson.Result {
 //	    map[string]interface{}{"set_tweak": "highlight"},
 //	  }),
 //	)
-func (c *CSAPI) GetPushRule(t ct.TestLike, scope string, kind string, ruleID string) gjson.Result {
+func (c *CSAPI) MustGetPushRule(t ct.TestLike, scope string, kind string, ruleID string) gjson.Result {
 	t.Helper()
 
-	res := c.MustDo(t, "GET", []string{"_matrix", "client", "v3", "pushrules", scope, kind, ruleID})
+	res := c.GetPushRule(t, scope, kind, ruleID)
+	mustRespond2xx(t, res)
+
 	pushRuleBytes := ParseJSON(t, res)
 	return gjson.ParseBytes(pushRuleBytes)
 }
 
+// GetPushRule queries the contents of a client's push rule by scope, kind and rule ID.
+func (c *CSAPI) GetPushRule(t ct.TestLike, scope string, kind string, ruleID string) *http.Response {
+	t.Helper()
+
+	return c.Do(t, "GET", []string{"_matrix", "client", "v3", "pushrules", scope, kind, ruleID})
+}
+
 // SetPushRule creates a new push rule on the user, or modifies an existing one.
 // If `before` or `after` parameters are not set to an empty string, their values
 // will be set as the `before` and `after` query parameters respectively on the
@@ -343,6 +353,14 @@ func (c *CSAPI) SetPushRule(t ct.TestLike, scope string, kind string, ruleID str
 	return c.MustDo(t, "PUT", []string{"_matrix", "client", "v3", "pushrules", scope, kind, ruleID}, WithJSONBody(t, body), WithQueries(queryParams))
 }
 
+// MustDisablePushRule disables a push rule on the user.
+// Fails the test if response is non-2xx.
+func (c *CSAPI) MustDisablePushRule(t ct.TestLike, scope string, kind string, ruleID string) {
+	c.MustDo(t, "PUT", []string{"_matrix", "client", "v3", "pushrules", scope, kind, ruleID, "enabled"}, WithJSONBody(t, map[string]interface{}{
+		"enabled": false,
+	}))
+}
+
 // Unsafe_SendEventUnsynced sends `e` into the room. This function is UNSAFE as it does not wait
 // for the event to be fully processed. This can cause flakey tests. Prefer `SendEventSynced`.
 // Returns the event ID of the sent event.
@@ -768,6 +786,19 @@ func (t *loggedRoundTripper) RoundTrip(req *http.Request) (*http.Response, error
 	return res, err
 }
 
+// Extracts a JSON object given a search key
+// Caller must check `result.Exists()` to see whether the object actually exists.
+func GetOptionalJSONFieldObject(t ct.TestLike, body []byte, wantKey string) gjson.Result {
+	t.Helper()
+	res := gjson.GetBytes(body, wantKey)
+	if !res.Exists() {
+		log.Printf("OptionalJSONFieldObject: key '%s' absent from %s", wantKey, string(body))
+	} else if !res.IsObject() {
+		ct.Fatalf(t, "OptionalJSONFieldObject: key '%s' is not an object, body: %s", wantKey, string(body))
+	}
+	return res
+}
+
 // GetJSONFieldStr extracts a value from a byte-encoded JSON body given a search key
 func GetJSONFieldStr(t ct.TestLike, body []byte, wantKey string) string {
 	t.Helper()

tests/csapi/thread_notifications_test.go

@@ -51,6 +51,21 @@ func syncHasThreadedReadReceipt(roomID, userID, eventID, threadID string) client
 	})
 }
 
+// Disables push rules that are introduced in MSC4306 (if present),
+// because they interfere with the normal semantics of notifications in threads.
+func disableMsc4306PushRules(t *testing.T, user *client.CSAPI) {
+	rules := []string{".io.element.msc4306.rule.subscribed_thread", ".io.element.msc4306.rule.unsubscribed_thread"}
+	for _, rule := range rules {
+		res := user.GetPushRule(t, "global", "postcontent", rule)
+		if res.StatusCode == 404 {
+			// No push rule to disable
+			continue
+		}
+
+		user.MustDisablePushRule(t, "global", "postcontent", rule)
+	}
+}
+
 // Test behavior of threaded receipts and notifications.
 //
 // 1. Send a series of messages, some of which are in threads.
@@ -79,7 +94,9 @@ func TestThreadedReceipts(t *testing.T) {
 
 	// Create a room with alice and bob.
 	alice := deployment.Register(t, "hs1", helpers.RegistrationOpts{})
+	disableMsc4306PushRules(t, alice)
 	bob := deployment.Register(t, "hs1", helpers.RegistrationOpts{})
+	disableMsc4306PushRules(t, bob)
 
 	roomID := alice.MustCreateRoom(t, map[string]interface{}{"preset": "public_chat"})
 	bob.MustJoinRoom(t, roomID, nil)
@@ -312,7 +329,9 @@ func TestThreadReceiptsInSyncMSC4102(t *testing.T) {
 
 	// Create a room with alice and bob.
 	alice := deployment.Register(t, "hs1", helpers.RegistrationOpts{})
+	disableMsc4306PushRules(t, alice)
 	bob := deployment.Register(t, "hs2", helpers.RegistrationOpts{})
+	disableMsc4306PushRules(t, bob)
 	roomID := alice.MustCreateRoom(t, map[string]interface{}{"preset": "public_chat"})
 	bob.MustJoinRoom(t, roomID, []spec.ServerName{
 		deployment.GetFullyQualifiedHomeserverName(t, "hs1"),

tests/federation_acl_test.go

@@ -59,7 +59,9 @@ func TestACLs(t *testing.T) {
 		Content: map[string]interface{}{
 			"allow":             []string{"*"},
 			"allow_ip_literals": true,
-			"deny":              []string{"hs2"},
+			"deny": []string{
+				string(deployment.GetFullyQualifiedHomeserverName(t, "hs2")),
+			},
 		},
 	})
 	// wait for the ACL to show up on hs2
@@ -111,7 +113,9 @@ func TestACLs(t *testing.T) {
 		content := user.MustGetStateEventContent(t, roomID, "m.room.server_acl", "")
 		must.MatchGJSON(t, content,
 			match.JSONKeyEqual("allow", []string{"*"}),
-			match.JSONKeyEqual("deny", []string{"hs2"}),
+			match.JSONKeyEqual("deny", []string{
+				string(deployment.GetFullyQualifiedHomeserverName(t, "hs2")),
+			}),
 			match.JSONKeyEqual("allow_ip_literals", true),
 		)
 	}

tests/federation_rooms_invite_test.go

@@ -12,6 +12,7 @@ import (
 	"github.com/matrix-org/gomatrixserverlib/spec"
 	"github.com/tidwall/gjson"
 
+	"github.com/matrix-org/complement/b"
 	"github.com/matrix-org/complement/client"
 	"github.com/matrix-org/complement/helpers"
 	"github.com/matrix-org/complement/match"
@@ -23,6 +24,7 @@ func TestFederationRoomsInvite(t *testing.T) {
 	defer deployment.Destroy(t)
 
 	alice := deployment.Register(t, "hs1", helpers.RegistrationOpts{LocalpartSuffix: "alice"})
+	alice2 := deployment.Register(t, "hs1", helpers.RegistrationOpts{LocalpartSuffix: "alice2"})
 	bob := deployment.Register(t, "hs2", helpers.RegistrationOpts{LocalpartSuffix: "bob"})
 	bob2 := deployment.Register(t, "hs2", helpers.RegistrationOpts{LocalpartSuffix: "bob2"})
 
@@ -149,6 +151,73 @@ func TestFederationRoomsInvite(t *testing.T) {
 			alice.MustSyncUntil(t, client.SyncReq{Filter: includeLeaveSyncFilter}, client.SyncLeftFrom(bob2.UserID, roomID))
 		})
 
+		t.Run("Inviter user can rescind invite over federation", func(t *testing.T) {
+			t.Parallel()
+			roomID := alice.MustCreateRoom(t, map[string]interface{}{
+				"preset": "private_chat",
+				"invite": []string{bob.UserID},
+			})
+			bob.MustSyncUntil(t, client.SyncReq{}, client.SyncInvitedTo(bob.UserID, roomID))
+			alice.MustDo(t, "POST", []string{"_matrix", "client", "v3", "rooms", roomID, "kick"},
+				client.WithJSONBody(t, map[string]interface{}{
+					"user_id": bob.UserID,
+					"reason":  "testing",
+				}),
+			)
+
+			bob.MustSyncUntil(t, client.SyncReq{Filter: includeLeaveSyncFilter}, client.SyncLeftFrom(bob.UserID, roomID))
+		})
+
+		t.Run("Non-invitee user cannot rescind invite over federation", func(t *testing.T) {
+			t.Parallel()
+
+			// First create a room that Bob is in. This is so that later we can
+			// send a message to test that Bob doesn't see the rescission.
+			roomID1 := alice.MustCreateRoom(t, map[string]interface{}{
+				"preset": "private_chat",
+				"invite": []string{bob.UserID},
+			})
+			since := bob.MustSyncUntil(t, client.SyncReq{}, client.SyncInvitedTo(bob.UserID, roomID1))
+			bob.MustJoinRoom(t, roomID1, []spec.ServerName{})
+
+			// Second room which Alice and Alice2 join, Alice2 invites Bob and
+			// then Alice kicks him.
+			roomID2 := alice.MustCreateRoom(t, map[string]interface{}{
+				"preset": "private_chat",
+				"invite": []string{alice2.UserID},
+			})
+			alice2.MustSyncUntil(t, client.SyncReq{}, client.SyncInvitedTo(alice2.UserID, roomID2))
+			alice2.MustJoinRoom(t, roomID2, []spec.ServerName{})
+
+			alice2.MustInviteRoom(t, roomID2, bob.UserID)
+			bob.MustSyncUntil(t, client.SyncReq{}, client.SyncInvitedTo(bob.UserID, roomID2))
+
+			// Alice, not the original inviter, kicks bob. This does not result
+			// in bob seeing the rescission.
+			alice.MustDo(t, "POST", []string{"_matrix", "client", "v3", "rooms", roomID2, "kick"},
+				client.WithJSONBody(t, map[string]interface{}{
+					"user_id": bob.UserID,
+					"reason":  "testing",
+				}),
+			)
+
+			// Check bob *doesn't* see the rescission. We do this by sending a
+			// message in room1 and checking that once Bob receives that message
+			// he still hasn't seen the leave.
+			eventID := alice.SendEventSynced(t, roomID1, b.Event{
+				Type: "m.room.message",
+				Content: map[string]interface{}{
+					"body":    "1",
+					"msgtype": "m.text",
+				},
+				Sender: alice.UserID,
+			})
+			bob.MustSyncUntil(t, client.SyncReq{Since: since}, client.SyncTimelineHasEventID(roomID1, eventID))
+
+			// Check bob is still invited by doing an initial sync
+			bob.MustSyncUntil(t, client.SyncReq{}, client.SyncInvitedTo(bob.UserID, roomID2))
+		})
+
 		t.Run("Invited user has 'is_direct' flag in prev_content after joining", func(t *testing.T) {
 			roomID := alice.MustCreateRoom(t, map[string]interface{}{
 				"preset": "private_chat",

tests/msc3930/msc3930_test.go

@@ -39,7 +39,7 @@ func TestPollsLocalPushRules(t *testing.T) {
 		// Request each of the push rule IDs defined by MSC3930 and verify their structure.
 
 		// This push rule silences all poll responses.
-		pollResponseRule := alice.GetPushRule(t, "global", "override", pollResponseRuleID)
+		pollResponseRule := alice.MustGetPushRule(t, "global", "override", pollResponseRuleID)
 		must.MatchGJSON(
 			t,
 			pollResponseRule,
@@ -55,7 +55,7 @@ func TestPollsLocalPushRules(t *testing.T) {
 		)
 
 		// This push rule creates a sound and notifies the user when a poll is started in a one-to-one room.
-		pollStartOneToOneRule := alice.GetPushRule(t, "global", "underride", pollStartOneToOneRuleID)
+		pollStartOneToOneRule := alice.MustGetPushRule(t, "global", "underride", pollStartOneToOneRuleID)
 		must.MatchGJSON(
 			t,
 			pollStartOneToOneRule,
@@ -78,7 +78,7 @@ func TestPollsLocalPushRules(t *testing.T) {
 		)
 
 		// This push rule creates a sound and notifies the user when a poll is ended in a one-to-one room.
-		pollEndOneToOneRule := alice.GetPushRule(t, "global", "underride", pollEndOneToOneRuleID)
+		pollEndOneToOneRule := alice.MustGetPushRule(t, "global", "underride", pollEndOneToOneRuleID)
 		must.MatchGJSON(
 			t,
 			pollEndOneToOneRule,
@@ -101,7 +101,7 @@ func TestPollsLocalPushRules(t *testing.T) {
 		)
 
 		// This push rule notifies the user when a poll is started in any room.
-		pollStartRule := alice.GetPushRule(t, "global", "underride", pollStartRuleID)
+		pollStartRule := alice.MustGetPushRule(t, "global", "underride", pollStartRuleID)
 		must.MatchGJSON(
 			t,
 			pollStartRule,
@@ -118,7 +118,7 @@ func TestPollsLocalPushRules(t *testing.T) {
 		)
 
 		// This push rule notifies the user when a poll is ended in any room.
-		pollEndRule := alice.GetPushRule(t, "global", "underride", pollEndRuleID)
+		pollEndRule := alice.MustGetPushRule(t, "global", "underride", pollEndRuleID)
 		must.MatchGJSON(
 			t,
 			pollEndRule,

tests/msc4306/main_test.go

@@ -0,0 +1,11 @@
+package tests
+
+import (
+	"testing"
+
+	"github.com/matrix-org/complement"
+)
+
+func TestMain(m *testing.M) {
+	complement.TestMain(m, "msc4306")
+}