subservers+terminal: let subserver mgr handle REST registrations

Author: ellemouton

subservers/faraday.go

@@ -1,6 +1,9 @@
 package subservers
 
 import (
+	"context"
+
+	restProxy "github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
 	"github.com/lightninglabs/faraday"
 	"github.com/lightninglabs/faraday/frdrpc"
 	"github.com/lightninglabs/faraday/frdrpcserver"
@@ -76,6 +79,19 @@ func (f *faradaySubServer) RegisterGrpcService(service grpc.ServiceRegistrar) {
 	frdrpc.RegisterFaradayServerServer(service, f)
 }
 
+// RegisterRestService registers the sub-server's REST handlers with the given
+// endpoint.
+//
+// NOTE: this is part of the SubServer interface.
+func (f *faradaySubServer) RegisterRestService(ctx context.Context,
+	mux *restProxy.ServeMux, endpoint string,
+	dialOpts []grpc.DialOption) error {
+
+	return frdrpc.RegisterFaradayServerHandlerFromEndpoint(
+		ctx, mux, endpoint, dialOpts,
+	)
+}
+
 // ServerErrChan returns an error channel that should be listened on after
 // starting the sub-server to listen for any runtime errors. It is optional and
 // may be set to nil. This only applies in integrated mode.

subservers/interface.go

@@ -1,6 +1,9 @@
 package subservers
 
 import (
+	"context"
+
+	restProxy "github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightningnetwork/lnd/lnrpc"
 	"github.com/lightningnetwork/lnd/macaroons"
@@ -36,6 +39,11 @@ type SubServer interface {
 	// the given registrar.
 	RegisterGrpcService(grpc.ServiceRegistrar)
 
+	// RegisterRestService registers the sub-server's REST handlers with the
+	// given endpoint.
+	RegisterRestService(context.Context, *restProxy.ServeMux, string,
+		[]grpc.DialOption) error
+
 	// ServerErrChan returns an error channel that should be listened on
 	// after starting the sub-server to listen for any runtime errors. It
 	// is optional and may be set to nil. This only applies in integrated

subservers/loop.go

@@ -1,6 +1,9 @@
 package subservers
 
 import (
+	"context"
+
+	restProxy "github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightninglabs/loop/loopd"
 	"github.com/lightninglabs/loop/looprpc"
@@ -81,6 +84,19 @@ func (l *loopSubServer) RegisterGrpcService(registrar grpc.ServiceRegistrar) {
 	looprpc.RegisterSwapClientServer(registrar, l)
 }
 
+// RegisterRestService registers the sub-server's REST handlers with the given
+// endpoint.
+//
+// NOTE: this is part of the SubServer interface.
+func (l *loopSubServer) RegisterRestService(ctx context.Context,
+	mux *restProxy.ServeMux, endpoint string,
+	dialOpts []grpc.DialOption) error {
+
+	return looprpc.RegisterSwapClientHandlerFromEndpoint(
+		ctx, mux, endpoint, dialOpts,
+	)
+}
+
 // ServerErrChan returns an error channel that should be listened on after
 // starting the sub-server to listen for any runtime errors. It is optional and
 // may be set to nil. This only applies in integrated mode.

subservers/manager.go

@@ -7,6 +7,7 @@ import (
 	"sync"
 	"time"
 
+	restProxy "github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
 	"github.com/lightninglabs/lightning-terminal/perms"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightningnetwork/lnd/lncfg"
@@ -119,6 +120,33 @@ func (s *Manager) RegisterRPCServices(server grpc.ServiceRegistrar) {
 	}
 }
 
+// RegisterRestServices registers all the manager's sub-servers REST handlers
+// with the given endpoint.
+func (s *Manager) RegisterRestServices(ctx context.Context,
+	mux *restProxy.ServeMux, endpoint string,
+	dialOpts []grpc.DialOption) error {
+
+	s.mu.RLock()
+	defer s.mu.RUnlock()
+
+	for _, ss := range s.servers {
+		// In remote mode the "director" of the RPC proxy will act as
+		// a catch-all for any gRPC request that isn't known because we
+		// didn't register any server for it. The director will then
+		// forward the request to the remote service.
+		if ss.Remote() {
+			continue
+		}
+
+		err := ss.RegisterRestService(ctx, mux, endpoint, dialOpts)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
 // GetRemoteConn checks if any of the manager's sub-servers owns the given uri
 // and if so, the remote connection to that sub-server is returned. The bool
 // return value indicates if the uri is managed by one of the sub-servers

subservers/pool.go

@@ -1,6 +1,9 @@
 package subservers
 
 import (
+	"context"
+
+	restProxy "github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightninglabs/pool"
 	"github.com/lightninglabs/pool/poolrpc"
@@ -72,6 +75,19 @@ func (p *poolSubServer) RegisterGrpcService(registrar grpc.ServiceRegistrar) {
 	poolrpc.RegisterTraderServer(registrar, p)
 }
 
+// RegisterRestService registers the sub-server's REST handlers with the given
+// endpoint.
+//
+// NOTE: this is part of the SubServer interface.
+func (p *poolSubServer) RegisterRestService(ctx context.Context,
+	mux *restProxy.ServeMux, endpoint string,
+	dialOpts []grpc.DialOption) error {
+
+	return poolrpc.RegisterTraderHandlerFromEndpoint(
+		ctx, mux, endpoint, dialOpts,
+	)
+}
+
 // ServerErrChan returns an error channel that should be listened on after
 // starting the sub-server to listen for any runtime errors. It is optional and
 // may be set to nil. This only applies in integrated mode.

terminal.go

@@ -19,7 +19,6 @@ import (
 
 	restProxy "github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
 	"github.com/jessevdk/go-flags"
-	"github.com/lightninglabs/faraday/frdrpc"
 	"github.com/lightninglabs/lightning-terminal/accounts"
 	"github.com/lightninglabs/lightning-terminal/autopilotserver"
 	"github.com/lightninglabs/lightning-terminal/firewall"
@@ -33,9 +32,7 @@ import (
 	"github.com/lightninglabs/lightning-terminal/subservers"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightninglabs/loop"
-	"github.com/lightninglabs/loop/looprpc"
 	"github.com/lightninglabs/pool"
-	"github.com/lightninglabs/pool/poolrpc"
 	"github.com/lightningnetwork/lnd"
 	"github.com/lightningnetwork/lnd/build"
 	"github.com/lightningnetwork/lnd/chainreg"
@@ -234,6 +231,10 @@ func (g *LightningTerminal) Run() error {
 	// lnd once it's fully started.
 	g.subServerMgr = subservers.NewManager(g.permsMgr)
 
+	// Register our sub-servers. This must be done before the Rest proxy is
+	// set up so that the correct REST handlers are registered.
+	g.initSubServers()
+
 	// Construct the rpcProxy. It must be initialised before the main web
 	// server is started.
 	g.rpcProxy = newRpcProxy(
@@ -293,10 +294,6 @@ func (g *LightningTerminal) Run() error {
 // up, these are considered non-fatal and will not result in an error being
 // returned.
 func (g *LightningTerminal) start() error {
-	// Create the instances of our subservers now so we can hook them up to
-	// lnd once it's fully started.
-	g.initSubServers()
-
 	var err error
 
 	g.accountService, err = accounts.NewService(
@@ -926,23 +923,7 @@ func (g *LightningTerminal) RegisterRestSubserver(ctx context.Context,
 		return err
 	}
 
-	err = frdrpc.RegisterFaradayServerHandlerFromEndpoint(
-		ctx, mux, endpoint, dialOpts,
-	)
-	if err != nil {
-		return err
-	}
-
-	err = looprpc.RegisterSwapClientHandlerFromEndpoint(
-		ctx, mux, endpoint, dialOpts,
-	)
-	if err != nil {
-		return err
-	}
-
-	return poolrpc.RegisterTraderHandlerFromEndpoint(
-		ctx, mux, endpoint, dialOpts,
-	)
+	return g.subServerMgr.RegisterRestServices(ctx, mux, endpoint, dialOpts)
 }
 
 // ValidateMacaroon extracts the macaroon from the context's gRPC metadata,