Make the federation package public (#686)

Marked with EXPERIMENTAL all over as the API may change without warning.

Author: kegsay

internal/federation/handle.go federation/handle.gointernal/federation/handle.go renamed to federation/handle.go

@@ -15,6 +15,7 @@ import (
 	"github.com/matrix-org/util"
 )
 
+// EXPERIMENTAL
 // MakeJoinRequestsHandler is the http.Handler implementation for the make_join part of
 // HandleMakeSendJoinRequests.
 func MakeJoinRequestsHandler(s *Server, w http.ResponseWriter, req *http.Request) {
@@ -53,6 +54,7 @@ func MakeJoinRequestsHandler(s *Server, w http.ResponseWriter, req *http.Request
 	w.Write(b)
 }
 
+// EXPERIMENTAL
 // MakeRespMakeJoin makes the response for a /make_join request, without verifying any signatures
 // or dealing with HTTP responses itself.
 func MakeRespMakeJoin(s *Server, room *ServerRoom, userID string) (resp fclient.RespMakeJoin, err error) {
@@ -84,6 +86,7 @@ func MakeRespMakeJoin(s *Server, room *ServerRoom, userID string) (resp fclient.
 	return
 }
 
+// EXPERIMENTAL
 // MakeRespMakeKnock makes the response for a /make_knock request, without verifying any signatures
 // or dealing with HTTP responses itself.
 func MakeRespMakeKnock(s *Server, room *ServerRoom, userID string) (resp fclient.RespMakeKnock, err error) {
@@ -115,6 +118,7 @@ func MakeRespMakeKnock(s *Server, room *ServerRoom, userID string) (resp fclient
 	return
 }
 
+// EXPERIMENTAL
 // SendJoinRequestsHandler is the http.Handler implementation for the send_join part of
 // HandleMakeSendJoinRequests.
 //
@@ -212,6 +216,7 @@ func SendJoinRequestsHandler(s *Server, w http.ResponseWriter, req *http.Request
 	w.Write(b)
 }
 
+// EXPERIMENTAL
 // HandleMakeSendJoinRequests is an option which will process make_join and send_join requests for rooms which are present
 // in this server. To add a room to this server, see Server.MustMakeRoom. No checks are done to see whether join requests
 // are allowed or not. If you wish to test that, write your own test.
@@ -240,6 +245,7 @@ func HandlePartialStateMakeSendJoinRequests() func(*Server) {
 	}
 }
 
+// EXPERIMENTAL
 // HandleInviteRequests is an option which makes the server process invite requests.
 //
 // inviteCallback is a callback function that if non-nil will be called and passed the incoming invite event
@@ -289,6 +295,7 @@ func HandleInviteRequests(inviteCallback func(gomatrixserverlib.PDU)) func(*Serv
 	}
 }
 
+// EXPERIMENTAL
 // HandleDirectoryLookups will automatically return room IDs for any aliases present on this server.
 func HandleDirectoryLookups() func(*Server) {
 	return func(s *Server) {
@@ -323,6 +330,7 @@ func HandleDirectoryLookups() func(*Server) {
 	}
 }
 
+// EXPERIMENTAL
 // HandleEventRequests is an option which will process GET /_matrix/federation/v1/event/{eventId} requests universally when requested.
 func HandleEventRequests() func(*Server) {
 	return func(srv *Server) {
@@ -366,6 +374,7 @@ func HandleEventRequests() func(*Server) {
 	}
 }
 
+// EXPERIMENTAL
 // HandleEventAuthRequests is an option which will process GET /_matrix/federation/v1/event_auth/{roomId}/{eventId}
 // requests universally when requested.
 func HandleEventAuthRequests() func(*Server) {
@@ -415,6 +424,7 @@ func HandleEventAuthRequests() func(*Server) {
 	}
 }
 
+// EXPERIMENTAL
 // HandleKeyRequests is an option which will process GET /_matrix/key/v2/server requests universally when requested.
 func HandleKeyRequests() func(*Server) {
 	return func(srv *Server) {
@@ -455,6 +465,7 @@ func HandleKeyRequests() func(*Server) {
 	}
 }
 
+// EXPERIMENTAL
 // HandleMediaRequests is an option which will process /_matrix/media/v1/download/* using the provided map
 // as a way to do so. The key of the map is the media ID to be handled.
 func HandleMediaRequests(mediaIds map[string]func(w http.ResponseWriter)) func(*Server) {
@@ -489,6 +500,7 @@ func HandleMediaRequests(mediaIds map[string]func(w http.ResponseWriter)) func(*
 	}
 }
 
+// EXPERIMENTAL
 // HandleTransactionRequests is an option which will process GET /_matrix/federation/v1/send/{transactionID} requests universally when requested.
 // pduCallback and eduCallback are functions that if non-nil will be called and passed each PDU or EDU event received in the transaction.
 // Callbacks will be fired AFTER the event has been stored onto the respective ServerRoom.

internal/federation/server.go federation/server.gointernal/federation/server.go renamed to federation/server.go

@@ -1,3 +1,5 @@
+// package federation is an EXPERIMENTAL set of functions for creating mock federation servers, for testing over federation.
+// It is marked as EXPERIMENTAL as the API may break without warning.
 package federation
 
 import (
@@ -38,6 +40,7 @@ type FederationDeployment interface {
 	RoundTripper() http.RoundTripper
 }
 
+// EXPERIMENTAL
 // Server represents a federation server
 type Server struct {
 	t *testing.T
@@ -61,6 +64,7 @@ type Server struct {
 	keyRing               *gomatrixserverlib.KeyRing
 }
 
+// EXPERIMENTAL
 // NewServer creates a new federation server with configured options.
 func NewServer(t *testing.T, deployment FederationDeployment, opts ...func(*Server)) *Server {
 	// generate signing key

internal/federation/server_room.go federation/server_room.gointernal/federation/server_room.go renamed to federation/server_room.go

@@ -29,6 +29,7 @@ type Event struct {
 	Redacts string
 }
 
+// EXPERIMENTAL
 // ServerRoom represents a room on this test federation server
 type ServerRoom struct {
 	Version            gomatrixserverlib.RoomVersion

internal/federation/server_test.go federation/server_test.gointernal/federation/server_test.go renamed to federation/server_test.go

@@ -12,7 +12,7 @@ import (
 	"github.com/matrix-org/complement/b"
 	"github.com/matrix-org/complement/client"
 	"github.com/matrix-org/complement/helpers"
-	"github.com/matrix-org/complement/internal/federation"
+	"github.com/matrix-org/complement/federation"
 	"github.com/matrix-org/complement/runtime"
 	"github.com/matrix-org/gomatrixserverlib"
 	"github.com/matrix-org/gomatrixserverlib/fclient"

tests/csapi/sync_test.go

@@ -9,7 +9,7 @@ import (
 	"github.com/matrix-org/complement"
 	"github.com/matrix-org/complement/client"
 	"github.com/matrix-org/complement/helpers"
-	"github.com/matrix-org/complement/internal/federation"
+	"github.com/matrix-org/complement/federation"
 	"github.com/matrix-org/complement/match"
 	"github.com/matrix-org/complement/must"
 	"github.com/matrix-org/gomatrixserverlib/fclient"

tests/direct_messaging_test.go

@@ -8,7 +8,7 @@ import (
 	"github.com/matrix-org/complement"
 	"github.com/matrix-org/complement/b"
 	"github.com/matrix-org/complement/helpers"
-	"github.com/matrix-org/complement/internal/federation"
+	"github.com/matrix-org/complement/federation"
 	"github.com/matrix-org/complement/must"
 	"github.com/matrix-org/gomatrixserverlib/spec"
 

tests/federation_event_auth_test.go

@@ -12,7 +12,7 @@ import (
 
 	"github.com/matrix-org/complement/client"
 	"github.com/matrix-org/complement/helpers"
-	"github.com/matrix-org/complement/internal/federation"
+	"github.com/matrix-org/complement/federation"
 	"github.com/matrix-org/complement/match"
 	"github.com/matrix-org/complement/must"
 )

tests/federation_query_profile_test.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/matrix-org/complement"
 	"github.com/matrix-org/complement/helpers"
-	"github.com/matrix-org/complement/internal/federation"
+	"github.com/matrix-org/complement/federation"
 	"github.com/matrix-org/complement/must"
 	"github.com/matrix-org/complement/runtime"
 	"github.com/matrix-org/gomatrixserverlib"

tests/federation_redaction_test.go

@@ -21,7 +21,7 @@ import (
 	"github.com/matrix-org/complement/b"
 	"github.com/matrix-org/complement/client"
 	"github.com/matrix-org/complement/helpers"
-	"github.com/matrix-org/complement/internal/federation"
+	"github.com/matrix-org/complement/federation"
 	"github.com/matrix-org/complement/must"
 )