feat(nodebuilder/node): Implement Module (#1313)

Resolves #977

Author: renaynay

Makefile

@@ -151,6 +151,6 @@ pb-gen:
 ## openrpc-gen: Generate OpenRPC spec for Celestia-Node's RPC api
 openrpc-gen:
 	@echo "--> Generating OpenRPC spec"
-	@go run ./cmd/docgen fraud header state share das p2p
+	@go run ./cmd/docgen fraud header state share das p2p node
 .PHONY: openrpc-gen
 

api/rpc/client/client.go

@@ -8,27 +8,20 @@ import (
 	"github.com/celestiaorg/celestia-node/nodebuilder/das"
 	"github.com/celestiaorg/celestia-node/nodebuilder/fraud"
 	"github.com/celestiaorg/celestia-node/nodebuilder/header"
+	"github.com/celestiaorg/celestia-node/nodebuilder/node"
 	"github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 	"github.com/celestiaorg/celestia-node/nodebuilder/share"
 	"github.com/celestiaorg/celestia-node/nodebuilder/state"
 )
 
-type API interface {
-	fraud.Module
-	header.Module
-	state.Module
-	share.Module
-	das.Module
-	p2p.Module
-}
-
 type Client struct {
 	Fraud  fraud.API
 	Header header.API
 	State  state.API
 	Share  share.API
 	DAS    das.API
 	P2P    p2p.API
+	Node   node.API
 
 	closer multiClientCloser
 }
@@ -68,6 +61,7 @@ func NewClient(ctx context.Context, addr string) (*Client, error) {
 		"fraud":  &client.Fraud.Internal,
 		"das":    &client.DAS.Internal,
 		"p2p":    &client.P2P.Internal,
+		"node":   &client.Node.Internal,
 	}
 	for name, module := range modules {
 		closer, err := jsonrpc.NewClient(ctx, addr, name, module, nil)

api/rpc_test.go

@@ -15,12 +15,19 @@ import (
 	"github.com/celestiaorg/celestia-node/api/rpc"
 	"github.com/celestiaorg/celestia-node/api/rpc/client"
 	"github.com/celestiaorg/celestia-node/nodebuilder"
+	"github.com/celestiaorg/celestia-node/nodebuilder/das"
 	dasMock "github.com/celestiaorg/celestia-node/nodebuilder/das/mocks"
+	"github.com/celestiaorg/celestia-node/nodebuilder/fraud"
 	fraudMock "github.com/celestiaorg/celestia-node/nodebuilder/fraud/mocks"
+	"github.com/celestiaorg/celestia-node/nodebuilder/header"
 	headerMock "github.com/celestiaorg/celestia-node/nodebuilder/header/mocks"
 	"github.com/celestiaorg/celestia-node/nodebuilder/node"
+	nodeMock "github.com/celestiaorg/celestia-node/nodebuilder/node/mocks"
+	"github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 	p2pMock "github.com/celestiaorg/celestia-node/nodebuilder/p2p/mocks"
+	"github.com/celestiaorg/celestia-node/nodebuilder/share"
 	shareMock "github.com/celestiaorg/celestia-node/nodebuilder/share/mocks"
+	statemod "github.com/celestiaorg/celestia-node/nodebuilder/state"
 	stateMock "github.com/celestiaorg/celestia-node/nodebuilder/state/mocks"
 	"github.com/celestiaorg/celestia-node/state"
 )
@@ -58,33 +65,67 @@ func TestRPCCallsUnderlyingNode(t *testing.T) {
 	require.Equal(t, expectedBalance, balance)
 }
 
+// api contains all modules that are made available as the node's
+// public API surface (except for the `node` module as the node
+// module contains a method `Info` that is also contained in the
+// p2p module).
+type api interface {
+	fraud.Module
+	header.Module
+	statemod.Module
+	share.Module
+	das.Module
+	p2p.Module
+}
+
 func TestModulesImplementFullAPI(t *testing.T) {
-	api := reflect.TypeOf(new(client.API)).Elem()
+	api := reflect.TypeOf(new(api)).Elem()
+	nodeapi := reflect.TypeOf(new(node.Module)).Elem() // TODO @renaynay: explain
 	client := reflect.TypeOf(new(client.Client)).Elem()
 	for i := 0; i < client.NumField(); i++ {
 		module := client.Field(i)
-		// the "closers" field is not an actual module
-		if module.Name == "closer" {
+		switch module.Name {
+		case "closer":
+			// the "closers" field is not an actual module
 			continue
-		}
-		internal, ok := module.Type.FieldByName("Internal")
-		require.True(t, ok, "module %s's API does not have an Internal field", module.Name)
-		for j := 0; j < internal.Type.NumField(); j++ {
-			impl := internal.Type.Field(j)
-			method, _ := api.MethodByName(impl.Name)
-			require.Equal(t, method.Type, impl.Type, "method %s does not match", impl.Name)
+		case "Node":
+			// node module contains a duplicate method to the p2p module
+			// and must be tested separately.
+			internal, ok := module.Type.FieldByName("Internal")
+			require.True(t, ok, "module %s's API does not have an Internal field", module.Name)
+			for j := 0; j < internal.Type.NumField(); j++ {
+				impl := internal.Type.Field(j)
+				method, _ := nodeapi.MethodByName(impl.Name)
+				require.Equal(t, method.Type, impl.Type, "method %s does not match", impl.Name)
+			}
+		default:
+			internal, ok := module.Type.FieldByName("Internal")
+			require.True(t, ok, "module %s's API does not have an Internal field", module.Name)
+			for j := 0; j < internal.Type.NumField(); j++ {
+				impl := internal.Type.Field(j)
+				method, _ := api.MethodByName(impl.Name)
+				require.Equal(t, method.Type, impl.Type, "method %s does not match", impl.Name)
+			}
 		}
 	}
 }
 
 func TestAllReturnValuesAreMarshalable(t *testing.T) {
-	ra := reflect.TypeOf(new(client.API)).Elem()
+	ra := reflect.TypeOf(new(api)).Elem()
 	for i := 0; i < ra.NumMethod(); i++ {
 		m := ra.Method(i)
 		for j := 0; j < m.Type.NumOut(); j++ {
 			implementsMarshaler(t, m.Type.Out(j))
 		}
 	}
+	// NOTE: see comment above api interface definition.
+	na := reflect.TypeOf(new(node.Module)).Elem()
+	for i := 0; i < na.NumMethod(); i++ {
+		m := na.Method(i)
+		for j := 0; j < m.Type.NumOut(); j++ {
+			implementsMarshaler(t, m.Type.Out(j))
+		}
+	}
 }
 
 func implementsMarshaler(t *testing.T, typ reflect.Type) {
@@ -145,6 +186,7 @@ func setupNodeWithModifiedRPC(t *testing.T) (*nodebuilder.Node, *mockAPI) {
 		headerMock.NewMockModule(ctrl),
 		dasMock.NewMockModule(ctrl),
 		p2pMock.NewMockModule(ctrl),
+		nodeMock.NewMockModule(ctrl),
 	}
 
 	// given the behavior of fx.Invoke, this invoke will be called last as it is added at the root
@@ -156,6 +198,7 @@ func setupNodeWithModifiedRPC(t *testing.T) (*nodebuilder.Node, *mockAPI) {
 		srv.RegisterService("header", mockAPI.Header)
 		srv.RegisterService("das", mockAPI.Das)
 		srv.RegisterService("p2p", mockAPI.P2P)
+		srv.RegisterService("node", mockAPI.Node)
 	})
 	nd := nodebuilder.TestNode(t, node.Full, invokeRPC)
 	// start node
@@ -175,4 +218,5 @@ type mockAPI struct {
 	Header *headerMock.MockModule
 	Das    *dasMock.MockModule
 	P2P    *p2pMock.MockModule
+	Node   *nodeMock.MockModule
 }

docs/adr/adr-009-public-api.md

@@ -203,13 +203,16 @@ SyncHead(ctx context.Context) (*header.ExtendedHeader, error)
 ```go
 
   type NodeModule interface {
-    // Type returns the node type.
-    Type() node.Type
-    // Version returns information about the current binary build.
-    Version() string
-   
+    // Info returns administrative information about the node.
+    Info(context.Context) (Info, error)
+ 
     // LogLevelSet sets the given component log level to the given level.
     LogLevelSet(ctx context.Context, name, level string) error
+
+    // AuthVerify returns the permissions assigned to the given token.
+    AuthVerify(ctx context.Context, token string) ([]auth.Permission, error)
+    // AuthNew signs and returns a new token with the given permissions.
+    AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error)
   }
 
 ```

nodebuilder/default_services.go

@@ -4,6 +4,7 @@ import (
 	"github.com/celestiaorg/celestia-node/nodebuilder/das"
 	"github.com/celestiaorg/celestia-node/nodebuilder/fraud"
 	"github.com/celestiaorg/celestia-node/nodebuilder/header"
+	"github.com/celestiaorg/celestia-node/nodebuilder/node"
 	"github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 	"github.com/celestiaorg/celestia-node/nodebuilder/share"
 	"github.com/celestiaorg/celestia-node/nodebuilder/state"
@@ -18,4 +19,5 @@ var PackageToAPI = map[string]interface{}{
 	"header": &header.API{},
 	"daser":  &das.API{},
 	"p2p":    &p2p.API{},
+	"node":   &node.API{},
 }

nodebuilder/module.go

@@ -41,6 +41,7 @@ func ConstructModule(tp node.Type, network p2p.Network, cfg *Config, store Store
 		core.ConstructModule(tp, &cfg.Core),
 		das.ConstructModule(tp, &cfg.DASer),
 		fraud.ConstructModule(tp),
+		node.ConstructModule(tp),
 	)
 
 	return fx.Module(

nodebuilder/node/admin.go

@@ -0,0 +1,45 @@
+package node
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/filecoin-project/go-jsonrpc/auth"
+	logging "github.com/ipfs/go-log/v2"
+)
+
+type module struct {
+	tp Type
+}
+
+func newModule(tp Type) Module {
+	return &module{
+		tp: tp,
+	}
+}
+
+// Info contains information related to the administrative
+// node.
+type Info struct {
+	Type       Type   `json:"type"`
+	APIVersion string `json:"api_version"`
+}
+
+func (m *module) Info(context.Context) (Info, error) {
+	return Info{
+		Type: m.tp,
+		// TODO @renaynay @distractedm1nd: Implement versioning in API and way to extract that into this struct
+	}, nil
+}
+
+func (m *module) LogLevelSet(_ context.Context, name, level string) error {
+	return logging.SetLogLevel(name, level)
+}
+
+func (m *module) AuthVerify(ctx context.Context, token string) ([]auth.Permission, error) {
+	return []auth.Permission{}, fmt.Errorf("not implemented")
+}
+
+func (m *module) AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error) {
+	return nil, fmt.Errorf("not implemented")
+}

nodebuilder/node/mocks/api.go

@@ -0,0 +1,14 @@
+package node
+
+import (
+	"go.uber.org/fx"
+)
+
+func ConstructModule(tp Type) fx.Option {
+	return fx.Module(
+		"node",
+		fx.Provide(func() Module {
+			return newModule(tp)
+		}),
+	)
+}