Update to latest Complement (#191)

A few changes have landed in Complement, so we need to update.

The breaking changes in the API are:
 * `MustJoinRoom` now takes an array of `ServerName`s rather than an array of
   `string`s. To make it easier to build such an array, I've also changed the type
   of `ClientType.HS` to ServerName.

 * `WithCleanup` now takes a function which receives a parameter.

Author: richvdh

go.mod

@@ -1,28 +1,28 @@
 module github.com/matrix-org/complement-crypto
 
-go 1.23
+go 1.23.0
 
-toolchain go1.23.1
+toolchain go1.23.9
 
 require (
 	github.com/chromedp/cdproto v0.0.0-20250403032234-65de8f5d025b
 	github.com/chromedp/chromedp v0.13.6
 	github.com/docker/docker v28.0.4+incompatible
 	github.com/docker/go-connections v0.5.0
-	github.com/matrix-org/complement v0.0.0-20250508081216-d2e04c995666
+	github.com/matrix-org/complement v0.0.0-20250606075022-5daf877cbabb
+	github.com/matrix-org/gomatrixserverlib v0.0.0-20250119093516-0a1b2bafb5cf
 	github.com/testcontainers/testcontainers-go v0.35.0
 	github.com/tidwall/gjson v1.18.0
 	golang.org/x/exp v0.0.0-20230905200255-921286631fa9
 )
 
 require (
 	dario.cat/mergo v1.0.1 // indirect
+	github.com/AdaLogics/go-fuzz-headers v0.0.0-20230811130428-ced1acdcaa24 // indirect
 	github.com/Azure/go-ansiterm v0.0.0-20230124172434-306776ec8161 // indirect
 	github.com/Microsoft/go-winio v0.6.2 // indirect
-	github.com/Microsoft/hcsshim v0.11.7 // indirect
 	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
 	github.com/chromedp/sysutil v1.1.0 // indirect
-	github.com/containerd/containerd v1.7.22 // indirect
 	github.com/containerd/log v0.1.0 // indirect
 	github.com/containerd/platforms v0.2.1 // indirect
 	github.com/cpuguy83/dockercfg v0.3.2 // indirect
@@ -39,13 +39,11 @@ require (
 	github.com/gobwas/ws v1.4.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/google/uuid v1.6.0 // indirect
-	github.com/josharian/intern v1.0.0 // indirect
 	github.com/klauspost/compress v1.17.10 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
 	github.com/lufia/plan9stats v0.0.0-20240909124753-873cd0166683 // indirect
 	github.com/magiconair/properties v1.8.7 // indirect
-	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/matrix-org/gomatrix v0.0.0-20220926102614-ceba4d9f7530 // indirect
-	github.com/matrix-org/gomatrixserverlib v0.0.0-20250119093516-0a1b2bafb5cf // indirect
 	github.com/matrix-org/util v0.0.0-20221111132719-399730281e66 // indirect
 	github.com/moby/docker-image-spec v1.3.1 // indirect
 	github.com/moby/patternmatcher v0.6.0 // indirect
@@ -59,6 +57,7 @@ require (
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55 // indirect
+	github.com/rogpeppe/go-internal v1.10.0 // indirect
 	github.com/shirou/gopsutil/v3 v3.24.5 // indirect
 	github.com/shoenig/go-m1cpu v0.1.6 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
@@ -71,10 +70,15 @@ require (
 	github.com/yusufpapurcu/wmi v1.2.4 // indirect
 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.55.0 // indirect
 	go.opentelemetry.io/otel v1.30.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.19.0 // indirect
 	go.opentelemetry.io/otel/metric v1.30.0 // indirect
 	go.opentelemetry.io/otel/trace v1.30.0 // indirect
-	golang.org/x/crypto v0.32.0 // indirect
-	golang.org/x/sys v0.29.0 // indirect
-	google.golang.org/grpc v1.64.1 // indirect
+	go.opentelemetry.io/proto/otlp v1.0.0 // indirect
+	golang.org/x/crypto v0.36.0 // indirect
+	golang.org/x/sys v0.31.0 // indirect
+	golang.org/x/time v0.0.0-20220210224613-90d013bbcef8 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20240318140521-94a12d6c2237 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 // indirect
+	google.golang.org/protobuf v1.33.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -2,15 +2,16 @@ package api
 
 import (
 	"fmt"
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"time"
 
 	"github.com/matrix-org/complement/client"
 	"github.com/matrix-org/complement/ct"
 )
 
 type ClientType struct {
-	Lang ClientTypeLang // rust or js
-	HS   string         // hs1 or hs2
+	Lang ClientTypeLang  // rust or js
+	HS   spec.ServerName // hs1 or hs2
 }
 
 // Client represents a generic crypto client.

internal/api/client.go

@@ -9,6 +9,8 @@ import (
 	"github.com/matrix-org/complement-crypto/internal/api"
 	"github.com/matrix-org/complement-crypto/internal/config"
 	"github.com/matrix-org/complement-crypto/internal/deploy"
+
+	complementconfig "github.com/matrix-org/complement/config"
 )
 
 // Instance represents a test instance.
@@ -37,7 +39,7 @@ func (i *Instance) TestMain(m *testing.M, namespace string) {
 	}
 
 	// Defer to complement to run the test suite
-	complement.TestMain(m, namespace, complement.WithCleanup(func() { // always teardown even if panicking
+	complement.TestMain(m, namespace, complement.WithCleanup(func(conf *complementconfig.Complement) { // always teardown even if panicking
 		i.ssMutex.Lock()
 		if i.ssDeployment != nil {
 			i.ssDeployment.Teardown()

internal/cc/instance.go

@@ -56,7 +56,7 @@ type TestContext struct {
 // This User can then be passed to other functions to login on new test devices.
 func (c *TestContext) RegisterNewUser(t *testing.T, clientType api.ClientType, localpartSuffix string) *User {
 	return &User{
-		CSAPI: c.Deployment.Register(t, clientType.HS, helpers.RegistrationOpts{
+		CSAPI: c.Deployment.Register(t, string(clientType.HS), helpers.RegistrationOpts{
 			LocalpartSuffix: localpartSuffix,
 			Password:        "complement-crypto-password",
 		}),
@@ -277,7 +277,7 @@ func (encRoomOptions) RotationPeriodMs(milliseconds int) EncRoomOption {
 
 // MustRegisterNewDevice logs in a new device for this client, else fails the test.
 func (c *TestContext) MustRegisterNewDevice(t *testing.T, user *User, newDeviceID string) *User {
-	newDevice := c.Deployment.Login(t, user.ClientType.HS, user.CSAPI, helpers.LoginOpts{
+	newDevice := c.Deployment.Login(t, string(user.ClientType.HS), user.CSAPI, helpers.LoginOpts{
 		DeviceID: newDeviceID,
 		Password: user.Password, // TODO: remove? not needed as inherited from client?
 	})

internal/cc/test_context.go

@@ -5,6 +5,7 @@ package tests
 
 import (
 	"fmt"
+	complementconfig "github.com/matrix-org/complement/config"
 	"log"
 	"os"
 	"path/filepath"
@@ -74,8 +75,8 @@ func TestMain(m *testing.M) {
 		})
 	}
 	rust.SetupLogs("rust_sdk_logs")
-	js.SetupJSLogs("./logs/js_sdk.log")                                   // rust sdk logs on its own
-	complement.TestMain(m, "clienttests", complement.WithCleanup(func() { // always teardown even if panicking
+	js.SetupJSLogs("./logs/js_sdk.log") // rust sdk logs on its own
+	complement.TestMain(m, "clienttests", complement.WithCleanup(func(conf *complementconfig.Complement) { // always teardown even if panicking
 		ssMutex.Lock()
 		if ssDeployment != nil {
 			ssDeployment.Teardown()

internal/tests/client_test.go

@@ -1,6 +1,7 @@
 package tests
 
 import (
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"strings"
 	"testing"
 	"time"
@@ -70,7 +71,7 @@ func TestDelayedInviteResponse(t *testing.T) {
 				eventID := alice.MustSendMessage(t, roomID, "hello world!")
 
 				// bob joins, ensure he can decrypt the message.
-				tc.Bob.JoinRoom(t, roomID, []string{clientType.HS})
+				tc.Bob.JoinRoom(t, roomID, []spec.ServerName{clientType.HS})
 				bob.WaitUntilEventInRoom(t, roomID, api.CheckEventHasMembership(tc.Bob.UserID, "join")).Waitf(t, 7*time.Second, "did not see own join")
 				bob.MustBackpaginate(t, roomID, 3)
 

tests/delayed_requests_test.go

@@ -1,6 +1,7 @@
 package tests
 
 import (
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"net/http"
 	"sync/atomic"
 	"testing"
@@ -39,7 +40,7 @@ func TestFailedDeviceKeyDownloadRetries(t *testing.T) {
 		}, func() {
 			// And Alice and Bob are in an encrypted room together
 			roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, cc.EncRoomOptions.Invite([]string{tc.Bob.UserID}))
-			tc.Bob.MustJoinRoom(t, roomID, []string{"hs1"})
+			tc.Bob.MustJoinRoom(t, roomID, []spec.ServerName{"hs1"})
 
 			tc.WithAliceAndBobSyncing(t, func(alice, bob api.TestClient) {
 				// When Alice sends a message

tests/device_keys_test.go

@@ -1,6 +1,7 @@
 package tests
 
 import (
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"testing"
 	"time"
 
@@ -30,7 +31,7 @@ func TestNewUserCannotGetKeysForOfflineServer(t *testing.T) {
 		})
 		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, cc.EncRoomOptions.Invite([]string{tc.Bob.UserID}))
 		t.Logf("%s joining room %s", tc.Bob.UserID, roomID)
-		tc.Bob.MustJoinRoom(t, roomID, []string{"hs1"})
+		tc.Bob.MustJoinRoom(t, roomID, []spec.ServerName{"hs1"})
 
 		tc.WithAliceAndBobSyncing(t, func(alice, bob api.TestClient) {
 			// let clients sync device keys
@@ -51,7 +52,7 @@ func TestNewUserCannotGetKeysForOfflineServer(t *testing.T) {
 			tc.WithClientSyncing(t, &cc.ClientCreationRequest{
 				User: tc.Charlie,
 			}, func(charlie api.TestClient) {
-				tc.Charlie.MustJoinRoom(t, roomID, []string{"hs1"})
+				tc.Charlie.MustJoinRoom(t, roomID, []spec.ServerName{"hs1"})
 
 				// let charlie sync device keys... and fail to get bob's keys!
 				time.Sleep(time.Second)
@@ -118,8 +119,8 @@ func TestExistingSessionCannotGetKeysForOfflineServer(t *testing.T) {
 		roomIDbc := tc.CreateNewEncryptedRoom(t, tc.Charlie, cc.EncRoomOptions.Invite([]string{tc.Bob.UserID}))
 		roomIDab := tc.CreateNewEncryptedRoom(t, tc.Alice, cc.EncRoomOptions.Invite([]string{tc.Bob.UserID}))
 		t.Logf("%s joining rooms %s and %s", tc.Bob.UserID, roomIDab, roomIDbc)
-		tc.Bob.MustJoinRoom(t, roomIDab, []string{"hs1"})
-		tc.Bob.MustJoinRoom(t, roomIDbc, []string{"hs1"})
+		tc.Bob.MustJoinRoom(t, roomIDab, []spec.ServerName{"hs1"})
+		tc.Bob.MustJoinRoom(t, roomIDbc, []spec.ServerName{"hs1"})
 
 		tc.WithAliceBobAndCharlieSyncing(t, func(alice, bob, charlie api.TestClient) {
 			// let clients sync device keys
@@ -141,7 +142,7 @@ func TestExistingSessionCannotGetKeysForOfflineServer(t *testing.T) {
 
 			// C now joins the room ab
 			tc.Alice.MustInviteRoom(t, roomIDab, tc.Charlie.UserID)
-			tc.Charlie.MustJoinRoom(t, roomIDab, []string{"hs1"})
+			tc.Charlie.MustJoinRoom(t, roomIDab, []spec.ServerName{"hs1"})
 
 			// let charlie sync device keys...
 			time.Sleep(time.Second)

tests/federation_connectivity_test.go

@@ -2,6 +2,7 @@ package tests
 
 import (
 	"fmt"
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"testing"
 	"time"
 
@@ -30,7 +31,7 @@ func TestAliceBobEncryptionWorks(t *testing.T) {
 			cc.EncRoomOptions.PresetTrustedPrivateChat(),
 			cc.EncRoomOptions.Invite([]string{tc.Bob.UserID}),
 		)
-		tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
+		tc.Bob.MustJoinRoom(t, roomID, []spec.ServerName{clientTypeA.HS})
 
 		// SDK testing below
 		// -----------------
@@ -87,7 +88,7 @@ func TestCanDecryptMessagesAfterInviteButBeforeJoin(t *testing.T) {
 			alice.MustSendMessage(t, roomID, wantMsgBody)
 
 			// Bob joins the room (via Complement, but it shouldn't matter)
-			tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
+			tc.Bob.MustJoinRoom(t, roomID, []spec.ServerName{clientTypeA.HS})
 
 			isEncrypted, err = bob.IsRoomEncrypted(t, roomID)
 			must.NotError(t, "failed to check if room is encrypted", err)
@@ -131,7 +132,7 @@ func TestBobCanSeeButNotDecryptHistoryInPublicRoom(t *testing.T) {
 			waiter.Waitf(t, 5*time.Second, "alice did not see own message")
 
 			// now bob joins the room
-			tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
+			tc.Bob.MustJoinRoom(t, roomID, []spec.ServerName{clientTypeA.HS})
 			time.Sleep(time.Second) // wait for it to appear on the client else rust crashes if it cannot find the room FIXME
 			waiter = bob.WaitUntilEventInRoom(t, roomID, api.CheckEventHasMembership(bob.UserID(), "join"))
 			waiter.Waitf(t, 5*time.Second, "bob did not see own join")
@@ -159,7 +160,7 @@ func TestOnRejoinBobCanSeeButNotDecryptHistoryInPublicRoom(t *testing.T) {
 		tc := Instance().CreateTestContext(t, clientTypeA, clientTypeB)
 		// shared history visibility
 		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, cc.EncRoomOptions.PresetPublicChat())
-		tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
+		tc.Bob.MustJoinRoom(t, roomID, []spec.ServerName{clientTypeA.HS})
 
 		// SDK testing below
 		// -----------------
@@ -184,7 +185,7 @@ func TestOnRejoinBobCanSeeButNotDecryptHistoryInPublicRoom(t *testing.T) {
 			waiter.Waitf(t, 5*time.Second, "alice did not see own message")
 
 			// now bob rejoins the room, wait until he sees it.
-			tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
+			tc.Bob.MustJoinRoom(t, roomID, []spec.ServerName{clientTypeA.HS})
 			waiter = bob.WaitUntilEventInRoom(t, roomID, api.CheckEventHasMembership(bob.UserID(), "join"))
 			waiter.Waitf(t, 5*time.Second, "bob did not see own join")
 			// this is required for some reason else tests fail
@@ -217,7 +218,7 @@ func TestOnNewDeviceBobCanSeeButNotDecryptHistoryInPublicRoom(t *testing.T) {
 		tc := Instance().CreateTestContext(t, clientTypeA, clientTypeB)
 		// shared history visibility
 		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, cc.EncRoomOptions.PresetPublicChat())
-		tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
+		tc.Bob.MustJoinRoom(t, roomID, []spec.ServerName{clientTypeA.HS})
 
 		// SDK testing below
 		// -----------------
@@ -295,7 +296,7 @@ func TestChangingDeviceAfterInviteReEncrypts(t *testing.T) {
 				User: csapiBob2,
 			}, func(bob2 api.TestClient) {
 				time.Sleep(time.Second) // let device keys propagate
-				tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
+				tc.Bob.MustJoinRoom(t, roomID, []spec.ServerName{clientTypeA.HS})
 
 				time.Sleep(time.Second) // let the client load the events
 				bob2.MustBackpaginate(t, roomID, 5)