Move fedclient interface over to gmsl (#3061)

Companion PR: https://github.com/matrix-org/gomatrixserverlib/pull/366

15 files changed, 21 insertions, 61 deletions

diff --git a/federationapi/api/api.go b/federationapi/api/api.go
index 6b09b0cd..0048b4b0 100644
--- a/federationapi/api/api.go
+++ b/federationapi/api/api.go
@@ -105,42 +105,6 @@ type KeyserverFederationAPI interface {
 	QueryKeys(ctx context.Context, origin, s spec.ServerName, keys map[string][]string) (res fclient.RespQueryKeys, err error)
 }
 
-// an interface for gmsl.FederationClient - contains functions called by federationapi only.
-type FederationClient interface {
-	P2PFederationClient
-	gomatrixserverlib.KeyClient
-	SendTransaction(ctx context.Context, t gomatrixserverlib.Transaction) (res fclient.RespSend, err error)
-
-	// Perform operations
-	LookupRoomAlias(ctx context.Context, origin, s spec.ServerName, roomAlias string) (res fclient.RespDirectory, err error)
-	Peek(ctx context.Context, origin, s spec.ServerName, roomID, peekID string, roomVersions []gomatrixserverlib.RoomVersion) (res fclient.RespPeek, err error)
-	MakeJoin(ctx context.Context, origin, s spec.ServerName, roomID, userID string, roomVersions []gomatrixserverlib.RoomVersion) (res fclient.RespMakeJoin, err error)
-	SendJoin(ctx context.Context, origin, s spec.ServerName, event *gomatrixserverlib.Event) (res fclient.RespSendJoin, err error)
-	MakeLeave(ctx context.Context, origin, s spec.ServerName, roomID, userID string) (res fclient.RespMakeLeave, err error)
-	SendLeave(ctx context.Context, origin, s spec.ServerName, event *gomatrixserverlib.Event) (err error)
-	SendInviteV2(ctx context.Context, origin, s spec.ServerName, request fclient.InviteV2Request) (res fclient.RespInviteV2, err error)
-
-	GetEvent(ctx context.Context, origin, s spec.ServerName, eventID string) (res gomatrixserverlib.Transaction, err error)
-
-	GetEventAuth(ctx context.Context, origin, s spec.ServerName, roomVersion gomatrixserverlib.RoomVersion, roomID, eventID string) (res fclient.RespEventAuth, err error)
-	GetUserDevices(ctx context.Context, origin, s spec.ServerName, userID string) (fclient.RespUserDevices, error)
-	ClaimKeys(ctx context.Context, origin, s spec.ServerName, oneTimeKeys map[string]map[string]string) (fclient.RespClaimKeys, error)
-	QueryKeys(ctx context.Context, origin, s spec.ServerName, keys map[string][]string) (fclient.RespQueryKeys, error)
-	Backfill(ctx context.Context, origin, s spec.ServerName, roomID string, limit int, eventIDs []string) (res gomatrixserverlib.Transaction, err error)
-	MSC2836EventRelationships(ctx context.Context, origin, dst spec.ServerName, r fclient.MSC2836EventRelationshipsRequest, roomVersion gomatrixserverlib.RoomVersion) (res fclient.MSC2836EventRelationshipsResponse, err error)
-	MSC2946Spaces(ctx context.Context, origin, dst spec.ServerName, roomID string, suggestedOnly bool) (res fclient.MSC2946SpacesResponse, err error)
-
-	ExchangeThirdPartyInvite(ctx context.Context, origin, s spec.ServerName, builder gomatrixserverlib.EventBuilder) (err error)
-	LookupState(ctx context.Context, origin, s spec.ServerName, roomID string, eventID string, roomVersion gomatrixserverlib.RoomVersion) (res fclient.RespState, err error)
-	LookupStateIDs(ctx context.Context, origin, s spec.ServerName, roomID string, eventID string) (res fclient.RespStateIDs, err error)
-	LookupMissingEvents(ctx context.Context, origin, s spec.ServerName, roomID string, missing fclient.MissingEvents, roomVersion gomatrixserverlib.RoomVersion) (res fclient.RespMissingEvents, err error)
-}
-
-type P2PFederationClient interface {
-	P2PSendTransactionToRelay(ctx context.Context, u spec.UserID, t gomatrixserverlib.Transaction, forwardingServer spec.ServerName) (res fclient.EmptyResp, err error)
-	P2PGetTransactionFromRelay(ctx context.Context, u spec.UserID, prev fclient.RelayEntry, relayServer spec.ServerName) (res fclient.RespGetRelayTransaction, err error)
-}
-
 // FederationClientError is returned from FederationClient methods in the event of a problem.
 type FederationClientError struct {
 	Err         string
diff --git a/federationapi/federationapi.go b/federationapi/federationapi.go
index c64fa550..14448383 100644
--- a/federationapi/federationapi.go
+++ b/federationapi/federationapi.go
@@ -49,7 +49,7 @@ func AddPublicRoutes(
 	dendriteConfig *config.Dendrite,
 	natsInstance *jetstream.NATSInstance,
 	userAPI userapi.FederationUserAPI,
-	federation *fclient.FederationClient,
+	federation fclient.FederationClient,
 	keyRing gomatrixserverlib.JSONVerifier,
 	rsAPI roomserverAPI.FederationRoomserverAPI,
 	fedAPI federationAPI.FederationInternalAPI,
@@ -98,7 +98,7 @@ func NewInternalAPI(
 	dendriteCfg *config.Dendrite,
 	cm sqlutil.Connections,
 	natsInstance *jetstream.NATSInstance,
-	federation api.FederationClient,
+	federation fclient.FederationClient,
 	rsAPI roomserverAPI.FederationRoomserverAPI,
 	caches *caching.Caches,
 	keyRing *gomatrixserverlib.KeyRing,
diff --git a/federationapi/federationapi_keys_test.go b/federationapi/federationapi_keys_test.go
index 50691334..9dda389e 100644
--- a/federationapi/federationapi_keys_test.go
+++ b/federationapi/federationapi_keys_test.go
@@ -29,7 +29,7 @@ type server struct {
 	name      spec.ServerName           // server name
 	validity  time.Duration             // key validity duration from now
 	config    *config.FederationAPI     // skeleton config, from TestMain
-	fedclient *fclient.FederationClient // uses MockRoundTripper
+	fedclient fclient.FederationClient  // uses MockRoundTripper
 	cache     *caching.Caches           // server-specific cache
 	api       api.FederationInternalAPI // server-specific server key API
 }
diff --git a/federationapi/federationapi_test.go b/federationapi/federationapi_test.go
index 70ad2e28..ca144491 100644
--- a/federationapi/federationapi_test.go
+++ b/federationapi/federationapi_test.go
@@ -55,7 +55,7 @@ func (f *fedRoomserverAPI) QueryRoomsForUser(ctx context.Context, req *rsapi.Que
 // TODO: This struct isn't generic, only works for TestFederationAPIJoinThenKeyUpdate
 type fedClient struct {
 	fedClientMutex sync.Mutex
-	api.FederationClient
+	fclient.FederationClient
 	allowJoins []*test.Room
 	keys       map[spec.ServerName]struct {
 		key   ed25519.PrivateKey
diff --git a/federationapi/internal/api.go b/federationapi/internal/api.go
index 529cf777..aa501f63 100644
--- a/federationapi/internal/api.go
+++ b/federationapi/internal/api.go
@@ -17,6 +17,7 @@ import (
 	"github.com/matrix-org/dendrite/setup/config"
 	"github.com/matrix-org/gomatrix"
 	"github.com/matrix-org/gomatrixserverlib"
+	"github.com/matrix-org/gomatrixserverlib/fclient"
 	"github.com/matrix-org/gomatrixserverlib/spec"
 	"github.com/sirupsen/logrus"
 )
@@ -27,7 +28,7 @@ type FederationInternalAPI struct {
 	cfg        *config.FederationAPI
 	statistics *statistics.Statistics
 	rsAPI      roomserverAPI.FederationRoomserverAPI
-	federation api.FederationClient
+	federation fclient.FederationClient
 	keyRing    *gomatrixserverlib.KeyRing
 	queues     *queue.OutgoingQueues
 	joins      sync.Map // joins currently in progress
@@ -36,7 +37,7 @@ type FederationInternalAPI struct {
 func NewFederationInternalAPI(
 	db storage.Database, cfg *config.FederationAPI,
 	rsAPI roomserverAPI.FederationRoomserverAPI,
-	federation api.FederationClient,
+	federation fclient.FederationClient,
 	statistics *statistics.Statistics,
 	caches *caching.Caches,
 	queues *queue.OutgoingQueues,
diff --git a/federationapi/internal/perform.go b/federationapi/internal/perform.go
index c0e0ba14..c73b69d9 100644
--- a/federationapi/internal/perform.go
+++ b/federationapi/internal/perform.go
@@ -773,7 +773,7 @@ func setDefaultRoomVersionFromJoinEvent(
 
 // FederatedAuthProvider is an auth chain provider which fetches events from the server provided
 func federatedAuthProvider(
-	ctx context.Context, federation api.FederationClient,
+	ctx context.Context, federation fclient.FederationClient,
 	keyRing gomatrixserverlib.JSONVerifier, origin, server spec.ServerName,
 ) gomatrixserverlib.AuthChainProvider {
 	// A list of events that we have retried, if they were not included in
diff --git a/federationapi/internal/perform_test.go b/federationapi/internal/perform_test.go
index 4f836242..2f61235a 100644
--- a/federationapi/internal/perform_test.go
+++ b/federationapi/internal/perform_test.go
@@ -30,7 +30,7 @@ import (
 )
 
 type testFedClient struct {
-	api.FederationClient
+	fclient.FederationClient
 	queryKeysCalled bool
 	claimKeysCalled bool
 	shouldFail      bool
diff --git a/federationapi/queue/destinationqueue.go b/federationapi/queue/destinationqueue.go
index c136fe75..c00659ff 100644
--- a/federationapi/queue/destinationqueue.go
+++ b/federationapi/queue/destinationqueue.go
@@ -28,7 +28,6 @@ import (
 	"github.com/sirupsen/logrus"
 	"go.uber.org/atomic"
 
-	fedapi "github.com/matrix-org/dendrite/federationapi/api"
 	"github.com/matrix-org/dendrite/federationapi/statistics"
 	"github.com/matrix-org/dendrite/federationapi/storage"
 	"github.com/matrix-org/dendrite/federationapi/storage/shared/receipt"
@@ -54,7 +53,7 @@ type destinationQueue struct {
 	process            *process.ProcessContext
 	signing            map[spec.ServerName]*fclient.SigningIdentity
 	rsAPI              api.FederationRoomserverAPI
-	client             fedapi.FederationClient         // federation client
+	client             fclient.FederationClient        // federation client
 	origin             spec.ServerName                 // origin of requests
 	destination        spec.ServerName                 // destination of requests
 	running            atomic.Bool                     // is the queue worker running?
diff --git a/federationapi/queue/queue.go b/federationapi/queue/queue.go
index 860446a0..a482e43e 100644
--- a/federationapi/queue/queue.go
+++ b/federationapi/queue/queue.go
@@ -29,7 +29,6 @@ import (
 	log "github.com/sirupsen/logrus"
 	"github.com/tidwall/gjson"
 
-	fedapi "github.com/matrix-org/dendrite/federationapi/api"
 	"github.com/matrix-org/dendrite/federationapi/statistics"
 	"github.com/matrix-org/dendrite/federationapi/storage"
 	"github.com/matrix-org/dendrite/federationapi/storage/shared/receipt"
@@ -45,7 +44,7 @@ type OutgoingQueues struct {
 	disabled    bool
 	rsAPI       api.FederationRoomserverAPI
 	origin      spec.ServerName
-	client      fedapi.FederationClient
+	client      fclient.FederationClient
 	statistics  *statistics.Statistics
 	signing     map[spec.ServerName]*fclient.SigningIdentity
 	queuesMutex sync.Mutex // protects the below
@@ -89,7 +88,7 @@ func NewOutgoingQueues(
 	process *process.ProcessContext,
 	disabled bool,
 	origin spec.ServerName,
-	client fedapi.FederationClient,
+	client fclient.FederationClient,
 	rsAPI api.FederationRoomserverAPI,
 	statistics *statistics.Statistics,
 	signing []*fclient.SigningIdentity,
diff --git a/federationapi/queue/queue_test.go b/federationapi/queue/queue_test.go
index 7e71d69d..f42b56e5 100644
--- a/federationapi/queue/queue_test.go
+++ b/federationapi/queue/queue_test.go
@@ -32,7 +32,6 @@ import (
 	"github.com/matrix-org/gomatrixserverlib"
 	"github.com/stretchr/testify/assert"
 
-	"github.com/matrix-org/dendrite/federationapi/api"
 	"github.com/matrix-org/dendrite/federationapi/statistics"
 	"github.com/matrix-org/dendrite/federationapi/storage"
 	rsapi "github.com/matrix-org/dendrite/roomserver/api"
@@ -75,7 +74,7 @@ func (r *stubFederationRoomServerAPI) QueryServerBannedFromRoom(ctx context.Cont
 }
 
 type stubFederationClient struct {
-	api.FederationClient
+	fclient.FederationClient
 	shouldTxSucceed      bool
 	shouldTxRelaySucceed bool
 	txCount              atomic.Uint32
diff --git a/federationapi/routing/query.go b/federationapi/routing/query.go
index 6b1c371e..61efd73f 100644
--- a/federationapi/routing/query.go
+++ b/federationapi/routing/query.go
@@ -31,7 +31,7 @@ import (
 // RoomAliasToID converts the queried alias into a room ID and returns it
 func RoomAliasToID(
 	httpReq *http.Request,
-	federation federationAPI.FederationClient,
+	federation fclient.FederationClient,
 	cfg *config.FederationAPI,
 	rsAPI roomserverAPI.FederationRoomserverAPI,
 	senderAPI federationAPI.FederationInternalAPI,
diff --git a/federationapi/routing/query_test.go b/federationapi/routing/query_test.go
index 1004fe1e..e7094e19 100644
--- a/federationapi/routing/query_test.go
+++ b/federationapi/routing/query_test.go
@@ -25,7 +25,6 @@ import (
 	"github.com/gorilla/mux"
 	"github.com/matrix-org/dendrite/cmd/dendrite-demo-yggdrasil/signing"
 	fedAPI "github.com/matrix-org/dendrite/federationapi"
-	fedclient "github.com/matrix-org/dendrite/federationapi/api"
 	fedInternal "github.com/matrix-org/dendrite/federationapi/internal"
 	"github.com/matrix-org/dendrite/federationapi/routing"
 	"github.com/matrix-org/dendrite/internal/caching"
@@ -42,7 +41,7 @@ import (
 )
 
 type fakeFedClient struct {
-	fedclient.FederationClient
+	fclient.FederationClient
 }
 
 func (f *fakeFedClient) LookupRoomAlias(ctx context.Context, origin, s spec.ServerName, roomAlias string) (res fclient.RespDirectory, err error) {
diff --git a/federationapi/routing/routing.go b/federationapi/routing/routing.go
index 41af5e7d..c82912c9 100644
--- a/federationapi/routing/routing.go
+++ b/federationapi/routing/routing.go
@@ -61,7 +61,7 @@ func Setup(
 	rsAPI roomserverAPI.FederationRoomserverAPI,
 	fsAPI *fedInternal.FederationInternalAPI,
 	keys gomatrixserverlib.JSONVerifier,
-	federation federationAPI.FederationClient,
+	federation fclient.FederationClient,
 	userAPI userapi.FederationUserAPI,
 	mscCfg *config.MSCs,
 	servers federationAPI.ServersInRoomProvider,
diff --git a/federationapi/routing/send.go b/federationapi/routing/send.go
index deefe5f1..2e674f98 100644
--- a/federationapi/routing/send.go
+++ b/federationapi/routing/send.go
@@ -62,7 +62,7 @@ func Send(
 	rsAPI api.FederationRoomserverAPI,
 	keyAPI userAPI.FederationUserAPI,
 	keys gomatrixserverlib.JSONVerifier,
-	federation federationAPI.FederationClient,
+	federation fclient.FederationClient,
 	mu *internal.MutexByRoom,
 	servers federationAPI.ServersInRoomProvider,
 	producer *producers.SyncAPIProducer,
diff --git a/federationapi/routing/threepid.go b/federationapi/routing/threepid.go
index 31f29fd3..aaee939e 100644
--- a/federationapi/routing/threepid.go
+++ b/federationapi/routing/threepid.go
@@ -23,7 +23,6 @@ import (
 
 	"github.com/matrix-org/dendrite/clientapi/httputil"
 	"github.com/matrix-org/dendrite/clientapi/jsonerror"
-	federationAPI "github.com/matrix-org/dendrite/federationapi/api"
 	"github.com/matrix-org/dendrite/roomserver/api"
 	"github.com/matrix-org/dendrite/setup/config"
 	userapi "github.com/matrix-org/dendrite/userapi/api"
@@ -60,7 +59,7 @@ var (
 func CreateInvitesFrom3PIDInvites(
 	req *http.Request, rsAPI api.FederationRoomserverAPI,
 	cfg *config.FederationAPI,
-	federation federationAPI.FederationClient,
+	federation fclient.FederationClient,
 	userAPI userapi.FederationUserAPI,
 ) util.JSONResponse {
 	var body invites
@@ -120,7 +119,7 @@ func ExchangeThirdPartyInvite(
 	roomID string,
 	rsAPI api.FederationRoomserverAPI,
 	cfg *config.FederationAPI,
-	federation federationAPI.FederationClient,
+	federation fclient.FederationClient,
 ) util.JSONResponse {
 	var builder gomatrixserverlib.EventBuilder
 	if err := json.Unmarshal(request.Content(), &builder); err != nil {
@@ -237,7 +236,7 @@ func ExchangeThirdPartyInvite(
 func createInviteFrom3PIDInvite(
 	ctx context.Context, rsAPI api.FederationRoomserverAPI,
 	cfg *config.FederationAPI,
-	inv invite, federation federationAPI.FederationClient,
+	inv invite, federation fclient.FederationClient,
 	userAPI userapi.FederationUserAPI,
 ) (*gomatrixserverlib.Event, error) {
 	verReq := api.QueryRoomVersionForRoomRequest{RoomID: inv.RoomID}
@@ -364,7 +363,7 @@ func buildMembershipEvent(
 // them responded with an error.
 func sendToRemoteServer(
 	ctx context.Context, inv invite,
-	federation federationAPI.FederationClient, cfg *config.FederationAPI,
+	federation fclient.FederationClient, cfg *config.FederationAPI,
 	builder gomatrixserverlib.EventBuilder,
 ) (err error) {
 	remoteServers := make([]spec.ServerName, 2)