fix(dot/sync, dot/rpc): implement HighestBlock (#2195)

ChainSafe · Jan 28, 2022 · f8d8657 · f8d8657
1 parent fada46b
commit f8d8657
Show file tree

Hide file tree

Showing 16 changed files with 546 additions and 93 deletions.
diff --git a/dot/node.go b/dot/node.go
@@ -317,7 +317,18 @@ func NewNode(cfg *Config, ks *keystore.GlobalKeystore) (*Node, error) {
 	// check if rpc service is enabled
 	if enabled := cfg.RPC.isRPCEnabled() || cfg.RPC.isWSEnabled(); enabled {
 		var rpcSrvc *rpc.HTTPServer
-		rpcSrvc, err = createRPCService(cfg, ns, stateSrvc, coreSrvc, networkSrvc, bp, sysSrvc, fg)
+		cRPCParams := rpcServiceSettings{
+			config:        cfg,
+			nodeStorage:   ns,
+			state:         stateSrvc,
+			core:          coreSrvc,
+			network:       networkSrvc,
+			blockProducer: bp,
+			system:        sysSrvc,
+			blockFinality: fg,
+			syncer:        syncer,
+		}
+		rpcSrvc, err = createRPCService(cRPCParams)
 		if err != nil {
 			return nil, fmt.Errorf("failed to create rpc service: %s", err)
 		}

diff --git a/dot/rpc/http.go b/dot/rpc/http.go
@@ -41,6 +41,7 @@ type HTTPServerConfig struct {
 	RPCAPI              modules.RPCAPI
 	SystemAPI           modules.SystemAPI
 	SyncStateAPI        modules.SyncStateAPI
+	SyncAPI             modules.SyncAPI
 	NodeStorage         *runtime.NodeStorage
 	RPC                 bool
 	RPCExternal         bool
@@ -97,7 +98,8 @@ func (h *HTTPServer) RegisterModules(mods []string) {
 		switch mod {
 		case "system":
 			srvc = modules.NewSystemModule(h.serverConfig.NetworkAPI, h.serverConfig.SystemAPI,
-				h.serverConfig.CoreAPI, h.serverConfig.StorageAPI, h.serverConfig.TransactionQueueAPI, h.serverConfig.BlockAPI)
+				h.serverConfig.CoreAPI, h.serverConfig.StorageAPI, h.serverConfig.TransactionQueueAPI,
+				h.serverConfig.BlockAPI, h.serverConfig.SyncAPI)
 		case "author":
 			srvc = modules.NewAuthorModule(h.logger, h.serverConfig.CoreAPI, h.serverConfig.TransactionQueueAPI)
 		case "chain":

diff --git a/dot/rpc/modules/api.go b/dot/rpc/modules/api.go
@@ -67,7 +67,6 @@ type NetworkAPI interface {
 	Stop() error
 	Start() error
 	IsStopped() bool
-	HighestBlock() int64
 	StartingBlock() int64
 	AddReservedPeers(addrs ...string) error
 	RemoveReservedPeers(addrs ...string) error
@@ -153,3 +152,10 @@ type RuntimeStorageAPI interface {
 type SyncStateAPI interface {
 	GenSyncSpec(raw bool) (*genesis.Genesis, error)
 }
+
+//go:generate mockgen -destination=mock_sync_api_test.go -package $GOPACKAGE . SyncAPI
+
+// SyncAPI is the interface to interact with the sync service
+type SyncAPI interface {
+	HighestBlock() int64
+}
diff --git a/dot/rpc/modules/mock_sync_api_test.go b/dot/rpc/modules/mock_sync_api_test.go
diff --git a/dot/rpc/modules/mocks/network_api.go b/dot/rpc/modules/mocks/network_api.go
diff --git a/dot/rpc/modules/system.go b/dot/rpc/modules/system.go
@@ -25,6 +25,7 @@ type SystemModule struct {
 	storageAPI StorageAPI
 	txStateAPI TransactionStateAPI
 	blockAPI   BlockAPI
+	syncAPI    SyncAPI
 }
 
 // EmptyRequest represents an RPC request with no fields
@@ -67,14 +68,16 @@ type SyncStateResponse struct {
 
 // NewSystemModule creates a new API instance
 func NewSystemModule(net NetworkAPI, sys SystemAPI, core CoreAPI,
-	storage StorageAPI, txAPI TransactionStateAPI, blockAPI BlockAPI) *SystemModule {
+	storage StorageAPI, txAPI TransactionStateAPI, blockAPI BlockAPI,
+	syncAPI SyncAPI) *SystemModule {
 	return &SystemModule{
 		networkAPI: net,
 		systemAPI:  sys,
 		coreAPI:    core,
 		storageAPI: storage,
 		txStateAPI: txAPI,
 		blockAPI:   blockAPI,
+		syncAPI:    syncAPI,
 	}
 }
 
@@ -233,7 +236,7 @@ func (sm *SystemModule) SyncState(r *http.Request, req *EmptyRequest, res *SyncS
 
 	*res = SyncStateResponse{
 		CurrentBlock:  uint32(h.Number.Int64()),
-		HighestBlock:  uint32(sm.networkAPI.HighestBlock()),
+		HighestBlock:  uint32(sm.syncAPI.HighestBlock()),
 		StartingBlock: uint32(sm.networkAPI.StartingBlock()),
 	}
 	return nil

diff --git a/dot/rpc/modules/system_integration_test.go b/dot/rpc/modules/system_integration_test.go
@@ -101,7 +101,7 @@ func TestSystemModule_Health(t *testing.T) {
 	networkMock := new(mocks.NetworkAPI)
 	networkMock.On("Health").Return(testHealth)
 
-	sys := NewSystemModule(networkMock, nil, nil, nil, nil, nil)
+	sys := NewSystemModule(networkMock, nil, nil, nil, nil, nil, nil)
 
 	res := &SystemHealthResponse{}
 	err := sys.Health(nil, nil, res)
@@ -112,7 +112,7 @@ func TestSystemModule_Health(t *testing.T) {
 // Test RPC's System.NetworkState() response
 func TestSystemModule_NetworkState(t *testing.T) {
 	net := newNetworkService(t)
-	sys := NewSystemModule(net, nil, nil, nil, nil, nil)
+	sys := NewSystemModule(net, nil, nil, nil, nil, nil, nil)
 
 	res := &SystemNetworkStateResponse{}
 	err := sys.NetworkState(nil, nil, res)
@@ -129,7 +129,7 @@ func TestSystemModule_NetworkState(t *testing.T) {
 func TestSystemModule_Peers(t *testing.T) {
 	net := newNetworkService(t)
 	net.Stop()
-	sys := NewSystemModule(net, nil, nil, nil, nil, nil)
+	sys := NewSystemModule(net, nil, nil, nil, nil, nil, nil)
 
 	res := &SystemPeersResponse{}
 	err := sys.Peers(nil, nil, res)
@@ -142,7 +142,7 @@ func TestSystemModule_Peers(t *testing.T) {
 
 func TestSystemModule_NodeRoles(t *testing.T) {
 	net := newNetworkService(t)
-	sys := NewSystemModule(net, nil, nil, nil, nil, nil)
+	sys := NewSystemModule(net, nil, nil, nil, nil, nil, nil)
 	expected := []interface{}{"Full"}
 
 	var res []interface{}
@@ -174,7 +174,7 @@ func newMockSystemAPI() *mocks.SystemAPI {
 }
 
 func TestSystemModule_Chain(t *testing.T) {
-	sys := NewSystemModule(nil, newMockSystemAPI(), nil, nil, nil, nil)
+	sys := NewSystemModule(nil, newMockSystemAPI(), nil, nil, nil, nil, nil)
 
 	res := new(string)
 	err := sys.Chain(nil, nil, res)
@@ -185,14 +185,14 @@ func TestSystemModule_Chain(t *testing.T) {
 func TestSystemModule_ChainType(t *testing.T) {
 	api := newMockSystemAPI()
 
-	sys := NewSystemModule(nil, api, nil, nil, nil, nil)
+	sys := NewSystemModule(nil, api, nil, nil, nil, nil, nil)
 
 	res := new(string)
 	sys.ChainType(nil, nil, res)
 	require.Equal(t, testGenesisData.ChainType, *res)
 }
 func TestSystemModule_Name(t *testing.T) {
-	sys := NewSystemModule(nil, newMockSystemAPI(), nil, nil, nil, nil)
+	sys := NewSystemModule(nil, newMockSystemAPI(), nil, nil, nil, nil, nil)
 
 	res := new(string)
 	err := sys.Name(nil, nil, res)
@@ -201,7 +201,7 @@ func TestSystemModule_Name(t *testing.T) {
 }
 
 func TestSystemModule_Version(t *testing.T) {
-	sys := NewSystemModule(nil, newMockSystemAPI(), nil, nil, nil, nil)
+	sys := NewSystemModule(nil, newMockSystemAPI(), nil, nil, nil, nil, nil)
 
 	res := new(string)
 	err := sys.Version(nil, nil, res)
@@ -210,7 +210,7 @@ func TestSystemModule_Version(t *testing.T) {
 }
 
 func TestSystemModule_Properties(t *testing.T) {
-	sys := NewSystemModule(nil, newMockSystemAPI(), nil, nil, nil, nil)
+	sys := NewSystemModule(nil, newMockSystemAPI(), nil, nil, nil, nil, nil)
 
 	expected := map[string]interface{}(nil)
 
@@ -340,7 +340,7 @@ func setupSystemModule(t *testing.T) *SystemModule {
 		AnyTimes()
 
 	txQueue := state.NewTransactionState(telemetryMock)
-	return NewSystemModule(net, nil, core, chain.Storage, txQueue, nil)
+	return NewSystemModule(net, nil, core, chain.Storage, txQueue, nil, nil)
 }
 
 func newCoreService(t *testing.T, srvc *state.Service) *core.Service {
@@ -399,12 +399,16 @@ func TestSyncState(t *testing.T) {
 	blockapiMock.On("GetHeader", fakeCommonHash).Return(fakeHeader, nil).Once()
 
 	netapiMock := new(mocks.NetworkAPI)
-	netapiMock.On("HighestBlock").Return(int64(90))
 	netapiMock.On("StartingBlock").Return(int64(10))
 
+	syncapiCtrl := gomock.NewController(t)
+	syncapiMock := NewMockSyncAPI(syncapiCtrl)
+	syncapiMock.EXPECT().HighestBlock().Return(int64(90))
+
 	sysmodule := new(SystemModule)
 	sysmodule.blockAPI = blockapiMock
 	sysmodule.networkAPI = netapiMock
+	sysmodule.syncAPI = syncapiMock
 
 	var res SyncStateResponse
 	err := sysmodule.SyncState(nil, nil, &res)