From 3caae7913baebc46c88c46253f5c570b41fb851d Mon Sep 17 00:00:00 2001 From: Matthew Hodgson Date: Sun, 13 Sep 2020 00:14:24 +0100 Subject: [PATCH] rename FSAPI's PerformPeek as PerformOutboundPeek --- federationapi/routing/peek.go | 2 +- federationsender/api/api.go | 10 +++++----- federationsender/internal/perform.go | 12 ++++++------ federationsender/inthttp/client.go | 12 ++++++------ go.mod | 2 ++ roomserver/api/output.go | 4 ++-- roomserver/internal/perform/perform_peek.go | 6 +++--- 7 files changed, 25 insertions(+), 23 deletions(-) diff --git a/federationapi/routing/peek.go b/federationapi/routing/peek.go index 6fb3aa7ce..6fd3e8296 100644 --- a/federationapi/routing/peek.go +++ b/federationapi/routing/peek.go @@ -33,7 +33,7 @@ func Peek( roomID, peekID string, remoteVersions []gomatrixserverlib.RoomVersion, ) util.JSONResponse { - // TODO: check if we're just refreshing an existing peek. Somehow. + // TODO: check if we're just refreshing an existing peek by querying the federationsender verReq := api.QueryRoomVersionForRoomRequest{RoomID: roomID} verRes := api.QueryRoomVersionForRoomResponse{} diff --git a/federationsender/api/api.go b/federationsender/api/api.go index 04ac63462..a5f1b1b53 100644 --- a/federationsender/api/api.go +++ b/federationsender/api/api.go @@ -58,10 +58,10 @@ type FederationSenderInternalAPI interface { response *PerformJoinResponse, ) // Handle an instruction to peek a room on a remote server. - PerformPeek( + PerformOutboundPeek( ctx context.Context, - request *PerformPeekRequest, - response *PerformPeekResponse, + request *PerformOutboundPeekRequest, + response *PerformOutboundPeekResponse, ) error // Handle an instruction to make_leave & send_leave with a remote server. PerformLeave( @@ -111,13 +111,13 @@ type PerformJoinResponse struct { LastError *gomatrix.HTTPError } -type PerformPeekRequest struct { +type PerformOutboundPeekRequest struct { RoomID string `json:"room_id"` // The sorted list of servers to try. Servers will be tried sequentially, after de-duplication. ServerNames types.ServerNames `json:"server_names"` } -type PerformPeekResponse struct { +type PerformOutboundPeekResponse struct { LastError *gomatrix.HTTPError } diff --git a/federationsender/internal/perform.go b/federationsender/internal/perform.go index db84caaf3..acaa7c6f4 100644 --- a/federationsender/internal/perform.go +++ b/federationsender/internal/perform.go @@ -208,11 +208,11 @@ func (r *FederationSenderInternalAPI) performJoinUsingServer( return nil } -// PerformPeekRequest implements api.FederationSenderInternalAPI -func (r *FederationSenderInternalAPI) PerformPeek( +// PerformOutboundPeekRequest implements api.FederationSenderInternalAPI +func (r *FederationSenderInternalAPI) PerformOutboundPeek( ctx context.Context, - request *api.PerformPeekRequest, - response *api.PerformPeekResponse, + request *api.PerformOutboundPeekRequest, + response *api.PerformOutboundPeekResponse, ) error { // Look up the supported room versions. var supportedVersions []gomatrixserverlib.RoomVersion @@ -238,7 +238,7 @@ func (r *FederationSenderInternalAPI) PerformPeek( // successfully completes the peek var lastErr error for _, serverName := range request.ServerNames { - if err := r.performPeekUsingServer( + if err := r.performOutboundPeekUsingServer( ctx, request.RoomID, serverName, @@ -279,7 +279,7 @@ func (r *FederationSenderInternalAPI) PerformPeek( return lastErr } -func (r *FederationSenderInternalAPI) performPeekUsingServer( +func (r *FederationSenderInternalAPI) performOutboundPeekUsingServer( ctx context.Context, roomID string, serverName gomatrixserverlib.ServerName, diff --git a/federationsender/inthttp/client.go b/federationsender/inthttp/client.go index 88e9e3d92..0623fd9aa 100644 --- a/federationsender/inthttp/client.go +++ b/federationsender/inthttp/client.go @@ -20,7 +20,7 @@ const ( FederationSenderPerformJoinRequestPath = "/federationsender/performJoinRequest" FederationSenderPerformLeaveRequestPath = "/federationsender/performLeaveRequest" FederationSenderPerformInviteRequestPath = "/federationsender/performInviteRequest" - FederationSenderPerformPeekRequestPath = "/federationsender/performPeekRequest" + FederationSenderPerformOutboundPeekRequestPath = "/federationsender/performOutboundPeekRequest" FederationSenderPerformServersAlivePath = "/federationsender/performServersAlive" FederationSenderPerformBroadcastEDUPath = "/federationsender/performBroadcastEDU" @@ -74,15 +74,15 @@ func (h *httpFederationSenderInternalAPI) PerformInvite( } // Handle starting a peek on a remote server. -func (h *httpFederationSenderInternalAPI) PerformPeek( +func (h *httpFederationSenderInternalAPI) PerformOutboundPeek( ctx context.Context, - request *api.PerformPeekRequest, - response *api.PerformPeekResponse, + request *api.PerformOutboundPeekRequest, + response *api.PerformOutboundPeekResponse, ) error { - span, ctx := opentracing.StartSpanFromContext(ctx, "PerformPeekRequest") + span, ctx := opentracing.StartSpanFromContext(ctx, "PerformOutboundPeekRequest") defer span.Finish() - apiURL := h.federationSenderURL + FederationSenderPerformPeekRequestPath + apiURL := h.federationSenderURL + FederationSenderPerformOutboundPeekRequestPath return httputil.PostJSON(ctx, span, h.httpClient, apiURL, request, response) } diff --git a/go.mod b/go.mod index f1cb3c9be..502e0873d 100644 --- a/go.mod +++ b/go.mod @@ -1,5 +1,7 @@ module github.com/matrix-org/dendrite +replace github.com/matrix-org/gomatrixserverlib => ../gomatrixserverlib + require ( github.com/Shopify/sarama v1.27.0 github.com/codahale/hdrhistogram v0.0.0-20161010025455-3a0bb77429bd // indirect diff --git a/roomserver/api/output.go b/roomserver/api/output.go index ea0c7eefe..fd02df9fc 100644 --- a/roomserver/api/output.go +++ b/roomserver/api/output.go @@ -51,7 +51,7 @@ const ( OutputTypeNewPeek OutputType = "new_peek" // OutputTypeNewInboundPeek indicates that the kafka event is an OutputNewInboundPeek - OutputTypeNewInboundPeek OutputType = "new_remote_peek" + OutputTypeNewInboundPeek OutputType = "new_inbound_peek" ) // An OutputEvent is an entry in the roomserver output kafka log. @@ -70,7 +70,7 @@ type OutputEvent struct { // The content of event with type OutputTypeNewPeek NewPeek *OutputNewPeek `json:"new_peek,omitempty"` // The content of event with type OutputTypeNewInboundPeek - NewInboundPeek *OutputNewInboundPeek `json:"new_remote_peek,omitempty"` + NewInboundPeek *OutputNewInboundPeek `json:"new_inbound_peek,omitempty"` } // An OutputNewRoomEvent is written when the roomserver receives a new event. diff --git a/roomserver/internal/perform/perform_peek.go b/roomserver/internal/perform/perform_peek.go index 8fdb23bf7..94f9284dd 100644 --- a/roomserver/internal/perform/perform_peek.go +++ b/roomserver/internal/perform/perform_peek.go @@ -159,12 +159,12 @@ func (r *Peeker) performPeekRoomByID( req.ServerNames = append(req.ServerNames, domain) // Try peeking by all of the supplied server names. - fedReq := fsAPI.PerformPeekRequest{ + fedReq := fsAPI.PerformOutboundPeekRequest{ RoomID: req.RoomIDOrAlias, // the room ID to try and peek ServerNames: req.ServerNames, // the servers to try peeking via } - fedRes := fsAPI.PerformPeekResponse{} - r.FSAPI.PerformPeek(ctx, &fedReq, &fedRes) + fedRes := fsAPI.PerformOutboundPeekResponse{} + r.FSAPI.PerformOutboundPeek(ctx, &fedReq, &fedRes) if fedRes.LastError != nil { return "", &api.PerformError{ Code: api.PerformErrRemote,