Tidy up the userapi interfaces

clientapi/clientapi.go

@@ -38,7 +38,7 @@ func AddPublicRoutes(
 	transactionsCache *transactions.Cache,
 	fsAPI federationAPI.ClientFederationAPI,
 	userAPI userapi.ClientUserAPI,
-	userDirectoryProvider userapi.UserDirectoryProvider,
+	userDirectoryProvider userapi.QuerySearchProfilesAPI,
 	keyAPI keyserverAPI.ClientKeyAPI,
 	extRoomsProvider api.ExtraPublicRoomsProvider,
 ) {

clientapi/routing/routing.go

@@ -53,7 +53,7 @@ func Setup(
 	rsAPI roomserverAPI.ClientRoomserverAPI,
 	asAPI appserviceAPI.AppServiceQueryAPI,
 	userAPI userapi.ClientUserAPI,
-	userDirectoryProvider userapi.UserDirectoryProvider,
+	userDirectoryProvider userapi.QuerySearchProfilesAPI,
 	federation *gomatrixserverlib.FederationClient,
 	syncProducer *producers.SyncAPIProducer,
 	transactionsCache *transactions.Cache,

clientapi/routing/userdirectory.go

@@ -36,7 +36,7 @@ func SearchUserDirectory(
 	device *userapi.Device,
 	userAPI userapi.ClientUserAPI,
 	rsAPI api.ClientRoomserverAPI,
-	provider userapi.UserDirectoryProvider,
+	provider userapi.QuerySearchProfilesAPI,
 	serverName gomatrixserverlib.ServerName,
 	searchString string,
 	limit int,

cmd/dendrite-demo-pinecone/users/users.go

@@ -37,7 +37,7 @@ import (
 type PineconeUserProvider struct {
 	r         *pineconeRouter.Router
 	s         *pineconeSessions.Sessions
-	userAPI   userapi.UserProfileAPI
+	userAPI   userapi.QuerySearchProfilesAPI
 	fedClient *gomatrixserverlib.FederationClient
 }
 
@@ -46,7 +46,7 @@ const PublicURL = "/_matrix/p2p/profiles"
 func NewPineconeUserProvider(
 	r *pineconeRouter.Router,
 	s *pineconeSessions.Sessions,
-	userAPI userapi.UserProfileAPI,
+	userAPI userapi.QuerySearchProfilesAPI,
 	fedClient *gomatrixserverlib.FederationClient,
 ) *PineconeUserProvider {
 	p := &PineconeUserProvider{

federationapi/routing/openid.go

@@ -30,7 +30,7 @@ type openIDUserInfoResponse struct {
 // GetOpenIDUserInfo implements GET /_matrix/federation/v1/openid/userinfo
 func GetOpenIDUserInfo(
 	httpReq *http.Request,
-	userAPI userapi.UserInternalAPI,
+	userAPI userapi.FederationUserAPI,
 ) util.JSONResponse {
 	token := httpReq.URL.Query().Get("access_token")
 	if len(token) == 0 {

federationapi/routing/profile.go

@@ -29,7 +29,7 @@ import (
 // GetProfile implements GET /_matrix/federation/v1/query/profile
 func GetProfile(
 	httpReq *http.Request,
-	userAPI userapi.UserInternalAPI,
+	userAPI userapi.FederationUserAPI,
 	cfg *config.FederationAPI,
 ) util.JSONResponse {
 	userID, field := httpReq.FormValue("user_id"), httpReq.FormValue("field")

federationapi/routing/routing.go

@@ -51,7 +51,7 @@ func Setup(
 	fsAPI federationAPI.FederationInternalAPI,
 	keys gomatrixserverlib.JSONVerifier,
 	federation *gomatrixserverlib.FederationClient,
-	userAPI userapi.UserInternalAPI,
+	userAPI userapi.FederationUserAPI,
 	keyAPI keyserverAPI.KeyInternalAPI,
 	mscCfg *config.MSCs,
 	servers federationAPI.ServersInRoomProvider,

federationapi/routing/threepid.go

@@ -58,7 +58,7 @@ func CreateInvitesFrom3PIDInvites(
 	req *http.Request, rsAPI api.FederationRoomserverAPI,
 	cfg *config.FederationAPI,
 	federation *gomatrixserverlib.FederationClient,
-	userAPI userapi.UserInternalAPI,
+	userAPI userapi.FederationUserAPI,
 ) util.JSONResponse {
 	var body invites
 	if reqErr := httputil.UnmarshalJSONRequest(req, &body); reqErr != nil {
@@ -206,7 +206,7 @@ func createInviteFrom3PIDInvite(
 	ctx context.Context, rsAPI api.FederationRoomserverAPI,
 	cfg *config.FederationAPI,
 	inv invite, federation *gomatrixserverlib.FederationClient,
-	userAPI userapi.UserInternalAPI,
+	userAPI userapi.FederationUserAPI,
 ) (*gomatrixserverlib.Event, error) {
 	verReq := api.QueryRoomVersionForRoomRequest{RoomID: inv.RoomID}
 	verRes := api.QueryRoomVersionForRoomResponse{}

setup/monolith.go

@@ -47,7 +47,7 @@ type Monolith struct {
 
 	// Optional
 	ExtPublicRoomsProvider   api.ExtraPublicRoomsProvider
-	ExtUserDirectoryProvider userapi.UserDirectoryProvider
+	ExtUserDirectoryProvider userapi.QuerySearchProfilesAPI
 }
 
 // AddAllPublicRoutes attaches all public paths to the given router

userapi/api/api.go

@@ -26,34 +26,33 @@ import (
 
 // UserInternalAPI is the internal API for information about users and devices.
 type UserInternalAPI interface {
-	UserProfileAPI
-	QueryAcccessTokenAPI
-
 	AppserviceUserAPI
 	SyncUserAPI
 	ClientUserAPI
 	MediaUserAPI
+	FederationUserAPI
 
-	QueryOpenIDToken(ctx context.Context, req *QueryOpenIDTokenRequest, res *QueryOpenIDTokenResponse) error
-}
-
-type QueryAcccessTokenAPI interface {
-	QueryAccessToken(ctx context.Context, req *QueryAccessTokenRequest, res *QueryAccessTokenResponse) error
-}
-
-type UserLoginAPI interface {
-	QueryAccountByPassword(ctx context.Context, req *QueryAccountByPasswordRequest, res *QueryAccountByPasswordResponse) error
+	QuerySearchProfilesAPI // used by p2p demos
 }
 
+// api functions required by the appservice api
 type AppserviceUserAPI interface {
 	PerformAccountCreation(ctx context.Context, req *PerformAccountCreationRequest, res *PerformAccountCreationResponse) error
 	PerformDeviceCreation(ctx context.Context, req *PerformDeviceCreationRequest, res *PerformDeviceCreationResponse) error
 }
 
+// api functions required by the media api
 type MediaUserAPI interface {
 	QueryAcccessTokenAPI
 }
 
+// api functions required by the federation api
+type FederationUserAPI interface {
+	QueryOpenIDToken(ctx context.Context, req *QueryOpenIDTokenRequest, res *QueryOpenIDTokenResponse) error
+	QueryProfile(ctx context.Context, req *QueryProfileRequest, res *QueryProfileResponse) error
+}
+
+// api functions required by the sync api
 type SyncUserAPI interface {
 	QueryAcccessTokenAPI
 	QueryAccountData(ctx context.Context, req *QueryAccountDataRequest, res *QueryAccountDataResponse) error
@@ -63,6 +62,7 @@ type SyncUserAPI interface {
 	QueryDeviceInfos(ctx context.Context, req *QueryDeviceInfosRequest, res *QueryDeviceInfosResponse) error
 }
 
+// api functions required by the client api
 type ClientUserAPI interface {
 	QueryAcccessTokenAPI
 	LoginTokenInternalAPI
@@ -97,14 +97,18 @@ type ClientUserAPI interface {
 	PerformSaveThreePIDAssociation(ctx context.Context, req *PerformSaveThreePIDAssociationRequest, res *struct{}) error
 }
 
-type UserDirectoryProvider interface {
+// custom api functions required by pinecone / p2p demos
+type QuerySearchProfilesAPI interface {
 	QuerySearchProfiles(ctx context.Context, req *QuerySearchProfilesRequest, res *QuerySearchProfilesResponse) error
 }
 
-// UserProfileAPI provides functions for getting user profiles
-type UserProfileAPI interface {
-	QueryProfile(ctx context.Context, req *QueryProfileRequest, res *QueryProfileResponse) error
-	QuerySearchProfiles(ctx context.Context, req *QuerySearchProfilesRequest, res *QuerySearchProfilesResponse) error
+// common function for creating authenticated endpoints (used in client/media/sync api)
+type QueryAcccessTokenAPI interface {
+	QueryAccessToken(ctx context.Context, req *QueryAccessTokenRequest, res *QueryAccessTokenResponse) error
+}
+
+type UserLoginAPI interface {
+	QueryAccountByPassword(ctx context.Context, req *QueryAccountByPasswordRequest, res *QueryAccountByPasswordResponse) error
 }
 
 type PerformKeyBackupRequest struct {