refactor: update GMSL (#3058)

Sister PR to https://github.com/matrix-org/gomatrixserverlib/pull/364

Read this commit by commit to avoid going insane.

8 files changed, 53 insertions, 46 deletions

diff --git a/setup/config/config.go b/setup/config/config.go
index 1a25f71e..41396ae3 100644
--- a/setup/config/config.go
+++ b/setup/config/config.go
@@ -26,6 +26,7 @@ import (
 
 	"github.com/matrix-org/dendrite/clientapi/auth/authtypes"
 	"github.com/matrix-org/gomatrixserverlib"
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"github.com/sirupsen/logrus"
 	"golang.org/x/crypto/ed25519"
 	"gopkg.in/yaml.v2"
@@ -239,7 +240,7 @@ func loadConfig(
 
 			key.KeyID = keyID
 			key.PrivateKey = privateKey
-			key.PublicKey = gomatrixserverlib.Base64Bytes(privateKey.Public().(ed25519.PublicKey))
+			key.PublicKey = spec.Base64Bytes(privateKey.Public().(ed25519.PublicKey))
 
 		case key.KeyID == "":
 			return nil, fmt.Errorf("'key_id' must be specified if 'public_key' is specified")
diff --git a/setup/config/config_federationapi.go b/setup/config/config_federationapi.go
index 8c1540b5..a72eee36 100644
--- a/setup/config/config_federationapi.go
+++ b/setup/config/config_federationapi.go
@@ -2,6 +2,7 @@ package config
 
 import (
 	"github.com/matrix-org/gomatrixserverlib"
+	"github.com/matrix-org/gomatrixserverlib/spec"
 )
 
 type FederationAPI struct {
@@ -101,7 +102,7 @@ type KeyPerspectives []KeyPerspective
 
 type KeyPerspective struct {
 	// The server name of the perspective key server
-	ServerName gomatrixserverlib.ServerName `yaml:"server_name"`
+	ServerName spec.ServerName `yaml:"server_name"`
 	// Server keys for the perspective user, used to verify the
 	// keys have been signed by the perspective server
 	Keys []KeyPerspectiveTrustKey `yaml:"keys"`
diff --git a/setup/config/config_global.go b/setup/config/config_global.go
index 0687e9d3..1622bf35 100644
--- a/setup/config/config_global.go
+++ b/setup/config/config_global.go
@@ -9,6 +9,7 @@ import (
 
 	"github.com/matrix-org/gomatrixserverlib"
 	"github.com/matrix-org/gomatrixserverlib/fclient"
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"golang.org/x/crypto/ed25519"
 )
 
@@ -122,7 +123,7 @@ func (c *Global) Verify(configErrs *ConfigErrors) {
 	c.Cache.Verify(configErrs)
 }
 
-func (c *Global) IsLocalServerName(serverName gomatrixserverlib.ServerName) bool {
+func (c *Global) IsLocalServerName(serverName spec.ServerName) bool {
 	if c.ServerName == serverName {
 		return true
 	}
@@ -134,7 +135,7 @@ func (c *Global) IsLocalServerName(serverName gomatrixserverlib.ServerName) bool
 	return false
 }
 
-func (c *Global) SplitLocalID(sigil byte, id string) (string, gomatrixserverlib.ServerName, error) {
+func (c *Global) SplitLocalID(sigil byte, id string) (string, spec.ServerName, error) {
 	u, s, err := gomatrixserverlib.SplitID(sigil, id)
 	if err != nil {
 		return u, s, err
@@ -145,7 +146,7 @@ func (c *Global) SplitLocalID(sigil byte, id string) (string, gomatrixserverlib.
 	return u, s, nil
 }
 
-func (c *Global) VirtualHost(serverName gomatrixserverlib.ServerName) *VirtualHost {
+func (c *Global) VirtualHost(serverName spec.ServerName) *VirtualHost {
 	for _, v := range c.VirtualHosts {
 		if v.ServerName == serverName {
 			return v
@@ -154,7 +155,7 @@ func (c *Global) VirtualHost(serverName gomatrixserverlib.ServerName) *VirtualHo
 	return nil
 }
 
-func (c *Global) VirtualHostForHTTPHost(serverName gomatrixserverlib.ServerName) *VirtualHost {
+func (c *Global) VirtualHostForHTTPHost(serverName spec.ServerName) *VirtualHost {
 	for _, v := range c.VirtualHosts {
 		if v.ServerName == serverName {
 			return v
@@ -168,7 +169,7 @@ func (c *Global) VirtualHostForHTTPHost(serverName gomatrixserverlib.ServerName)
 	return nil
 }
 
-func (c *Global) SigningIdentityFor(serverName gomatrixserverlib.ServerName) (*fclient.SigningIdentity, error) {
+func (c *Global) SigningIdentityFor(serverName spec.ServerName) (*fclient.SigningIdentity, error) {
 	for _, id := range c.SigningIdentities() {
 		if id.ServerName == serverName {
 			return id, nil
@@ -205,7 +206,7 @@ type VirtualHost struct {
 	// Match these HTTP Host headers on the `/key/v2/server` endpoint, this needs
 	// to match all delegated names, likely including the port number too if
 	// the well-known delegation includes that also.
-	MatchHTTPHosts []gomatrixserverlib.ServerName `yaml:"match_http_hosts"`
+	MatchHTTPHosts []spec.ServerName `yaml:"match_http_hosts"`
 
 	// Is registration enabled on this virtual host?
 	AllowRegistration bool `yaml:"allow_registration"`
@@ -236,14 +237,14 @@ type OldVerifyKeys struct {
 	PrivateKey ed25519.PrivateKey `yaml:"-"`
 
 	// The public key, in case only that part is known.
-	PublicKey gomatrixserverlib.Base64Bytes `yaml:"public_key"`
+	PublicKey spec.Base64Bytes `yaml:"public_key"`
 
 	// The key ID of the private key.
 	KeyID gomatrixserverlib.KeyID `yaml:"key_id"`
 
 	// When the private key was designed as "expired", as a UNIX timestamp
 	// in millisecond precision.
-	ExpiredAt gomatrixserverlib.Timestamp `yaml:"expired_at"`
+	ExpiredAt spec.Timestamp `yaml:"expired_at"`
 }
 
 // The configuration to use for Prometheus metrics
diff --git a/setup/config/config_test.go b/setup/config/config_test.go
index a0509aaf..8a65c990 100644
--- a/setup/config/config_test.go
+++ b/setup/config/config_test.go
@@ -19,8 +19,8 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/matrix-org/gomatrixserverlib"
 	"github.com/matrix-org/gomatrixserverlib/fclient"
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"github.com/sirupsen/logrus"
 	"gopkg.in/yaml.v2"
 )
@@ -275,7 +275,7 @@ func Test_SigningIdentityFor(t *testing.T) {
 	tests := []struct {
 		name         string
 		virtualHosts []*VirtualHost
-		serverName   gomatrixserverlib.ServerName
+		serverName   spec.ServerName
 		want         *fclient.SigningIdentity
 		wantErr      bool
 	}{
@@ -285,17 +285,17 @@ func Test_SigningIdentityFor(t *testing.T) {
 		},
 		{
 			name:       "no identity found",
-			serverName: gomatrixserverlib.ServerName("doesnotexist"),
+			serverName: spec.ServerName("doesnotexist"),
 			wantErr:    true,
 		},
 		{
 			name:       "found identity",
-			serverName: gomatrixserverlib.ServerName("main"),
+			serverName: spec.ServerName("main"),
 			want:       &fclient.SigningIdentity{ServerName: "main"},
 		},
 		{
 			name:       "identity found on virtual hosts",
-			serverName: gomatrixserverlib.ServerName("vh2"),
+			serverName: spec.ServerName("vh2"),
 			virtualHosts: []*VirtualHost{
 				{SigningIdentity: fclient.SigningIdentity{ServerName: "vh1"}},
 				{SigningIdentity: fclient.SigningIdentity{ServerName: "vh2"}},
diff --git a/setup/mscs/msc2836/msc2836.go b/setup/mscs/msc2836/msc2836.go
index a12a28b1..8982e6e3 100644
--- a/setup/mscs/msc2836/msc2836.go
+++ b/setup/mscs/msc2836/msc2836.go
@@ -38,6 +38,7 @@ import (
 	userapi "github.com/matrix-org/dendrite/userapi/api"
 	"github.com/matrix-org/gomatrixserverlib"
 	"github.com/matrix-org/gomatrixserverlib/fclient"
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"github.com/matrix-org/util"
 )
 
@@ -134,7 +135,7 @@ func Enable(
 
 	routers.Federation.Handle("/unstable/event_relationships", httputil.MakeExternalAPI(
 		"msc2836_event_relationships", func(req *http.Request) util.JSONResponse {
-			fedReq, errResp := gomatrixserverlib.VerifyHTTPRequest(
+			fedReq, errResp := fclient.VerifyHTTPRequest(
 				req, time.Now(), cfg.Global.ServerName, cfg.Global.IsLocalServerName, keyRing,
 			)
 			if fedReq == nil {
@@ -156,7 +157,7 @@ type reqCtx struct {
 
 	// federated request args
 	isFederatedRequest bool
-	serverName         gomatrixserverlib.ServerName
+	serverName         spec.ServerName
 	fsAPI              fs.FederationInternalAPI
 }
 
@@ -192,7 +193,7 @@ func eventRelationshipHandler(db Database, rsAPI roomserver.RoomserverInternalAP
 }
 
 func federatedEventRelationship(
-	ctx context.Context, fedReq *gomatrixserverlib.FederationRequest, db Database, rsAPI roomserver.RoomserverInternalAPI, fsAPI fs.FederationInternalAPI,
+	ctx context.Context, fedReq *fclient.FederationRequest, db Database, rsAPI roomserver.RoomserverInternalAPI, fsAPI fs.FederationInternalAPI,
 ) util.JSONResponse {
 	relation, err := NewEventRelationshipRequest(bytes.NewBuffer(fedReq.Content()))
 	if err != nil {
@@ -486,7 +487,7 @@ func walkThread(
 }
 
 // MSC2836EventRelationships performs an /event_relationships request to a remote server
-func (rc *reqCtx) MSC2836EventRelationships(eventID string, srv gomatrixserverlib.ServerName, ver gomatrixserverlib.RoomVersion) (*MSC2836EventRelationshipsResponse, error) {
+func (rc *reqCtx) MSC2836EventRelationships(eventID string, srv spec.ServerName, ver gomatrixserverlib.RoomVersion) (*MSC2836EventRelationshipsResponse, error) {
 	res, err := rc.fsAPI.MSC2836EventRelationships(rc.ctx, rc.serverName, srv, fclient.MSC2836EventRelationshipsRequest{
 		EventID:     eventID,
 		DepthFirst:  rc.req.DepthFirst,
@@ -545,7 +546,7 @@ func (rc *reqCtx) authorisedToSeeEvent(event *gomatrixserverlib.HeaderedEvent) b
 	return queryMembershipRes.IsInRoom
 }
 
-func (rc *reqCtx) getServersForEventID(eventID string) []gomatrixserverlib.ServerName {
+func (rc *reqCtx) getServersForEventID(eventID string) []spec.ServerName {
 	if rc.req.RoomID == "" {
 		util.GetLogger(rc.ctx).WithField("event_id", eventID).Error(
 			"getServersForEventID: event exists in unknown room",
@@ -689,7 +690,7 @@ func (rc *reqCtx) addChildMetadata(ev *gomatrixserverlib.HeaderedEvent) {
 	if count == 0 {
 		return
 	}
-	err := ev.SetUnsignedField("children_hash", gomatrixserverlib.Base64Bytes(hash))
+	err := ev.SetUnsignedField("children_hash", spec.Base64Bytes(hash))
 	if err != nil {
 		util.GetLogger(rc.ctx).WithError(err).Warn("Failed to set children_hash")
 	}
diff --git a/setup/mscs/msc2836/msc2836_test.go b/setup/mscs/msc2836/msc2836_test.go
index 3c443148..a06b7211 100644
--- a/setup/mscs/msc2836/msc2836_test.go
+++ b/setup/mscs/msc2836/msc2836_test.go
@@ -18,6 +18,7 @@ import (
 	"github.com/matrix-org/dendrite/setup/process"
 	"github.com/matrix-org/dendrite/syncapi/synctypes"
 	"github.com/matrix-org/gomatrixserverlib"
+	"github.com/matrix-org/gomatrixserverlib/spec"
 
 	"github.com/matrix-org/dendrite/internal/hooks"
 	"github.com/matrix-org/dendrite/internal/httputil"
@@ -596,7 +597,7 @@ func mustCreateEvent(t *testing.T, ev fledglingEvent) (result *gomatrixserverlib
 	}
 	// make sure the origin_server_ts changes so we can test recency
 	time.Sleep(1 * time.Millisecond)
-	signedEvent, err := eb.Build(time.Now(), gomatrixserverlib.ServerName("localhost"), "ed25519:test", key, roomVer)
+	signedEvent, err := eb.Build(time.Now(), spec.ServerName("localhost"), "ed25519:test", key, roomVer)
 	if err != nil {
 		t.Fatalf("mustCreateEvent: failed to sign event: %s", err)
 	}
diff --git a/setup/mscs/msc2836/storage.go b/setup/mscs/msc2836/storage.go
index 1cf7e878..4f348192 100644
--- a/setup/mscs/msc2836/storage.go
+++ b/setup/mscs/msc2836/storage.go
@@ -10,12 +10,13 @@ import (
 	"github.com/matrix-org/dendrite/internal/sqlutil"
 	"github.com/matrix-org/dendrite/setup/config"
 	"github.com/matrix-org/gomatrixserverlib"
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"github.com/matrix-org/util"
 )
 
 type eventInfo struct {
 	EventID        string
-	OriginServerTS gomatrixserverlib.Timestamp
+	OriginServerTS spec.Timestamp
 	RoomID         string
 }
 
@@ -350,8 +351,8 @@ func roomIDAndServers(ev *gomatrixserverlib.HeaderedEvent) (roomID string, serve
 
 func extractChildMetadata(ev *gomatrixserverlib.HeaderedEvent) (count int, hash []byte) {
 	unsigned := struct {
-		Counts map[string]int                `json:"children"`
-		Hash   gomatrixserverlib.Base64Bytes `json:"children_hash"`
+		Counts map[string]int   `json:"children"`
+		Hash   spec.Base64Bytes `json:"children_hash"`
 	}{}
 	if err := json.Unmarshal(ev.Unsigned(), &unsigned); err != nil {
 		// expected if there is no unsigned field at all
diff --git a/setup/mscs/msc2946/msc2946.go b/setup/mscs/msc2946/msc2946.go
index 965af920..80d6c598 100644
--- a/setup/mscs/msc2946/msc2946.go
+++ b/setup/mscs/msc2946/msc2946.go
@@ -37,6 +37,7 @@ import (
 	userapi "github.com/matrix-org/dendrite/userapi/api"
 	"github.com/matrix-org/gomatrixserverlib"
 	"github.com/matrix-org/gomatrixserverlib/fclient"
+	"github.com/matrix-org/gomatrixserverlib/spec"
 	"github.com/matrix-org/util"
 	"github.com/tidwall/gjson"
 )
@@ -64,7 +65,7 @@ func Enable(
 
 	fedAPI := httputil.MakeExternalAPI(
 		"msc2946_fed_spaces", func(req *http.Request) util.JSONResponse {
-			fedReq, errResp := gomatrixserverlib.VerifyHTTPRequest(
+			fedReq, errResp := fclient.VerifyHTTPRequest(
 				req, time.Now(), cfg.Global.ServerName, cfg.Global.IsLocalServerName, keyRing,
 			)
 			if fedReq == nil {
@@ -85,10 +86,10 @@ func Enable(
 }
 
 func federatedSpacesHandler(
-	ctx context.Context, fedReq *gomatrixserverlib.FederationRequest, roomID string,
+	ctx context.Context, fedReq *fclient.FederationRequest, roomID string,
 	cache caching.SpaceSummaryRoomsCache,
 	rsAPI roomserver.RoomserverInternalAPI, fsAPI fs.FederationInternalAPI,
-	thisServer gomatrixserverlib.ServerName,
+	thisServer spec.ServerName,
 ) util.JSONResponse {
 	u, err := url.Parse(fedReq.RequestURI())
 	if err != nil {
@@ -122,7 +123,7 @@ func spacesHandler(
 	rsAPI roomserver.RoomserverInternalAPI,
 	fsAPI fs.FederationInternalAPI,
 	cache caching.SpaceSummaryRoomsCache,
-	thisServer gomatrixserverlib.ServerName,
+	thisServer spec.ServerName,
 ) func(*http.Request, *userapi.Device) util.JSONResponse {
 	// declared outside the returned handler so it persists between calls
 	// TODO: clear based on... time?
@@ -162,8 +163,8 @@ type paginationInfo struct {
 type walker struct {
 	rootRoomID      string
 	caller          *userapi.Device
-	serverName      gomatrixserverlib.ServerName
-	thisServer      gomatrixserverlib.ServerName
+	serverName      spec.ServerName
+	thisServer      spec.ServerName
 	rsAPI           roomserver.RoomserverInternalAPI
 	fsAPI           fs.FederationInternalAPI
 	ctx             context.Context
@@ -269,7 +270,7 @@ func (w *walker) walk() util.JSONResponse {
 
 		// if this room is not a space room, skip.
 		var roomType string
-		create := w.stateEvent(rv.roomID, gomatrixserverlib.MRoomCreate, "")
+		create := w.stateEvent(rv.roomID, spec.MRoomCreate, "")
 		if create != nil {
 			// escape the `.`s so gjson doesn't think it's nested
 			roomType = gjson.GetBytes(create.Content(), strings.ReplaceAll(ConstCreateEventContentKey, ".", `\.`)).Str
@@ -434,7 +435,7 @@ func (w *walker) federatedRoomInfo(roomID string, vias []string) *fclient.MSC294
 		if serverName == string(w.thisServer) {
 			continue
 		}
-		res, err := w.fsAPI.MSC2946Spaces(ctx, w.thisServer, gomatrixserverlib.ServerName(serverName), roomID, w.suggestedOnly)
+		res, err := w.fsAPI.MSC2946Spaces(ctx, w.thisServer, spec.ServerName(serverName), roomID, w.suggestedOnly)
 		if err != nil {
 			util.GetLogger(w.ctx).WithError(err).Warnf("failed to call MSC2946Spaces on server %s", serverName)
 			continue
@@ -484,11 +485,11 @@ func (w *walker) authorised(roomID, parentRoomID string) (authed, isJoinedOrInvi
 func (w *walker) authorisedServer(roomID string) bool {
 	// Check history visibility / join rules first
 	hisVisTuple := gomatrixserverlib.StateKeyTuple{
-		EventType: gomatrixserverlib.MRoomHistoryVisibility,
+		EventType: spec.MRoomHistoryVisibility,
 		StateKey:  "",
 	}
 	joinRuleTuple := gomatrixserverlib.StateKeyTuple{
-		EventType: gomatrixserverlib.MRoomJoinRules,
+		EventType: spec.MRoomJoinRules,
 		StateKey:  "",
 	}
 	var queryRoomRes roomserver.QueryCurrentStateResponse
@@ -522,11 +523,11 @@ func (w *walker) authorisedServer(roomID string) bool {
 			return false
 		}
 
-		if rule == gomatrixserverlib.Public || rule == gomatrixserverlib.Knock {
+		if rule == spec.Public || rule == spec.Knock {
 			return true
 		}
 
-		if rule == gomatrixserverlib.Restricted {
+		if rule == spec.Restricted {
 			allowJoinedToRoomIDs = append(allowJoinedToRoomIDs, w.restrictedJoinRuleAllowedRooms(joinRuleEv, "m.room_membership")...)
 		}
 	}
@@ -556,15 +557,15 @@ func (w *walker) authorisedServer(roomID string) bool {
 // Failing that, if the room has a restricted join rule and belongs to the space parent listed, it will return true.
 func (w *walker) authorisedUser(roomID, parentRoomID string) (authed bool, isJoinedOrInvited bool) {
 	hisVisTuple := gomatrixserverlib.StateKeyTuple{
-		EventType: gomatrixserverlib.MRoomHistoryVisibility,
+		EventType: spec.MRoomHistoryVisibility,
 		StateKey:  "",
 	}
 	joinRuleTuple := gomatrixserverlib.StateKeyTuple{
-		EventType: gomatrixserverlib.MRoomJoinRules,
+		EventType: spec.MRoomJoinRules,
 		StateKey:  "",
 	}
 	roomMemberTuple := gomatrixserverlib.StateKeyTuple{
-		EventType: gomatrixserverlib.MRoomMember,
+		EventType: spec.MRoomMember,
 		StateKey:  w.caller.UserID,
 	}
 	var queryRes roomserver.QueryCurrentStateResponse
@@ -581,7 +582,7 @@ func (w *walker) authorisedUser(roomID, parentRoomID string) (authed bool, isJoi
 	memberEv := queryRes.StateEvents[roomMemberTuple]
 	if memberEv != nil {
 		membership, _ := memberEv.Membership()
-		if membership == gomatrixserverlib.Join || membership == gomatrixserverlib.Invite {
+		if membership == spec.Join || membership == spec.Invite {
 			return true, true
 		}
 	}
@@ -598,9 +599,9 @@ func (w *walker) authorisedUser(roomID, parentRoomID string) (authed bool, isJoi
 		rule, ruleErr := joinRuleEv.JoinRule()
 		if ruleErr != nil {
 			util.GetLogger(w.ctx).WithError(ruleErr).WithField("parent_room_id", parentRoomID).Warn("failed to get join rule")
-		} else if rule == gomatrixserverlib.Public || rule == gomatrixserverlib.Knock {
+		} else if rule == spec.Public || rule == spec.Knock {
 			allowed = true
-		} else if rule == gomatrixserverlib.Restricted {
+		} else if rule == spec.Restricted {
 			allowedRoomIDs := w.restrictedJoinRuleAllowedRooms(joinRuleEv, "m.room_membership")
 			// check parent is in the allowed set
 			for _, a := range allowedRoomIDs {
@@ -625,7 +626,7 @@ func (w *walker) authorisedUser(roomID, parentRoomID string) (authed bool, isJoi
 				memberEv = queryRes2.StateEvents[roomMemberTuple]
 				if memberEv != nil {
 					membership, _ := memberEv.Membership()
-					if membership == gomatrixserverlib.Join {
+					if membership == spec.Join {
 						return true, false
 					}
 				}
@@ -637,7 +638,7 @@ func (w *walker) authorisedUser(roomID, parentRoomID string) (authed bool, isJoi
 
 func (w *walker) restrictedJoinRuleAllowedRooms(joinRuleEv *gomatrixserverlib.HeaderedEvent, allowType string) (allows []string) {
 	rule, _ := joinRuleEv.JoinRule()
-	if rule != gomatrixserverlib.Restricted {
+	if rule != spec.Restricted {
 		return nil
 	}
 	var jrContent gomatrixserverlib.JoinRuleContent
@@ -656,7 +657,7 @@ func (w *walker) restrictedJoinRuleAllowedRooms(joinRuleEv *gomatrixserverlib.He
 // references returns all child references pointing to or from this room.
 func (w *walker) childReferences(roomID string) ([]fclient.MSC2946StrippedEvent, error) {
 	createTuple := gomatrixserverlib.StateKeyTuple{
-		EventType: gomatrixserverlib.MRoomCreate,
+		EventType: spec.MRoomCreate,
 		StateKey:  "",
 	}
 	var res roomserver.QueryCurrentStateResponse