Merge 5bf61b9 into d3225fe

api/groups/nodeGroup.go

@@ -17,15 +17,16 @@ import (
 )
 
 const (
-	pidQueryParam          = "pid"
-	debugPath              = "/debug"
-	heartbeatStatusPath    = "/heartbeatstatus"
-	metricsPath            = "/metrics"
-	p2pStatusPath          = "/p2pstatus"
-	peerInfoPath           = "/peerinfo"
-	statusPath             = "/status"
-	epochStartDataForEpoch = "/epoch-start/:epoch"
-	bootstrapStatusPath    = "/bootstrapstatus"
+	pidQueryParam             = "pid"
+	debugPath                 = "/debug"
+	heartbeatStatusPath       = "/heartbeatstatus"
+	metricsPath               = "/metrics"
+	p2pStatusPath             = "/p2pstatus"
+	peerInfoPath              = "/peerinfo"
+	statusPath                = "/status"
+	epochStartDataForEpoch    = "/epoch-start/:epoch"
+	bootstrapStatusPath       = "/bootstrapstatus"
+	connectedPeersRatingsPath = "/connected-peers-ratings"
 )
 
 // nodeFacadeHandler defines the methods to be implemented by a facade for node requests
@@ -35,6 +36,7 @@ type nodeFacadeHandler interface {
 	GetQueryHandler(name string) (debug.QueryHandler, error)
 	GetEpochStartDataAPI(epoch uint32) (*common.EpochStartDataAPI, error)
 	GetPeerInfo(pid string) ([]core.QueryP2PPeerInfo, error)
+	GetConnectedPeersRatings() string
 	IsInterfaceNil() bool
 }
 
@@ -102,6 +104,11 @@ func NewNodeGroup(facade nodeFacadeHandler) (*nodeGroup, error) {
 			Method:  http.MethodGet,
 			Handler: ng.bootstrapMetrics,
 		},
+		{
+			Path:    connectedPeersRatingsPath,
+			Method:  http.MethodGet,
+			Handler: ng.connectedPeersRatings,
+		},
 	}
 	ng.endpoints = endpoints
 
@@ -318,6 +325,19 @@ func (ng *nodeGroup) bootstrapMetrics(c *gin.Context) {
 	)
 }
 
+// connectedPeersRatings returns the node's connected peers ratings
+func (ng *nodeGroup) connectedPeersRatings(c *gin.Context) {
+	ratings := ng.getFacade().GetConnectedPeersRatings()
+	c.JSON(
+		http.StatusOK,
+		shared.GenericAPIResponse{
+			Data:  gin.H{"ratings": ratings},
+			Error: "",
+			Code:  shared.ReturnCodeSuccess,
+		},
+	)
+}
+
 func (ng *nodeGroup) getFacade() nodeFacadeHandler {
 	ng.mutFacade.RLock()
 	defer ng.mutFacade.RUnlock()

api/groups/nodeGroup_test.go

@@ -252,6 +252,37 @@ func TestBootstrapStatusMetrics_ShouldWork(t *testing.T) {
 	assert.True(t, valuesFound)
 }
 
+func TestBootstrapGetConnectedPeersRatings_ShouldWork(t *testing.T) {
+	providedRatings := map[string]string{
+		"pid1": "100",
+		"pid2": "-50",
+		"pid3": "-5",
+	}
+	buff, _ := json.Marshal(providedRatings)
+	facade := mock.FacadeStub{
+		GetConnectedPeersRatingsCalled: func() string {
+			return string(buff)
+		},
+	}
+
+	nodeGroup, err := groups.NewNodeGroup(&facade)
+	require.NoError(t, err)
+
+	ws := startWebServer(nodeGroup, "node", getNodeRoutesConfig())
+
+	req, _ := http.NewRequest("GET", "/node/connected-peers-ratings", nil)
+	resp := httptest.NewRecorder()
+	ws.ServeHTTP(resp, req)
+
+	response := &shared.GenericAPIResponse{}
+	loadResponse(resp.Body, response)
+	respMap, ok := response.Data.(map[string]interface{})
+	assert.True(t, ok)
+	ratings, ok := respMap["ratings"].(string)
+	assert.True(t, ok)
+	assert.Equal(t, string(buff), ratings)
+}
+
 func TestStatusMetrics_ShouldDisplayNonP2pMetrics(t *testing.T) {
 	statusMetricsProvider := statusHandler.NewStatusMetrics()
 	key := "test-details-key"
@@ -595,6 +626,7 @@ func getNodeRoutesConfig() config.ApiRoutesConfig {
 					{Name: "/peerinfo", Open: true},
 					{Name: "/epoch-start/:epoch", Open: true},
 					{Name: "/bootstrapstatus", Open: true},
+					{Name: "/connected-peers-ratings", Open: true},
 				},
 			},
 		},

api/mock/facadeStub.go

@@ -42,6 +42,7 @@ type FacadeStub struct {
 	GetQueryHandlerCalled                       func(name string) (debug.QueryHandler, error)
 	GetValueForKeyCalled                        func(address string, key string, options api.AccountQueryOptions) (string, api.BlockInfo, error)
 	GetPeerInfoCalled                           func(pid string) ([]core.QueryP2PPeerInfo, error)
+	GetConnectedPeersRatingsCalled              func() string
 	GetEpochStartDataAPICalled                  func(epoch uint32) (*common.EpochStartDataAPI, error)
 	GetThrottlerForEndpointCalled               func(endpoint string) (core.Throttler, bool)
 	GetUsernameCalled                           func(address string, options api.AccountQueryOptions) (string, api.BlockInfo, error)
@@ -371,6 +372,11 @@ func (f *FacadeStub) GetPeerInfo(pid string) ([]core.QueryP2PPeerInfo, error) {
 	return f.GetPeerInfoCalled(pid)
 }
 
+// GetConnectedPeersRatings -
+func (f *FacadeStub) GetConnectedPeersRatings() string {
+	return f.GetConnectedPeersRatingsCalled()
+}
+
 // GetEpochStartDataAPI -
 func (f *FacadeStub) GetEpochStartDataAPI(epoch uint32) (*common.EpochStartDataAPI, error) {
 	return f.GetEpochStartDataAPICalled(epoch)

api/shared/interface.go

@@ -98,6 +98,7 @@ type FacadeHandler interface {
 	GetQueryHandler(name string) (debug.QueryHandler, error)
 	GetEpochStartDataAPI(epoch uint32) (*common.EpochStartDataAPI, error)
 	GetPeerInfo(pid string) ([]core.QueryP2PPeerInfo, error)
+	GetConnectedPeersRatings() string
 	GetProof(rootHash string, address string) (*common.GetProofResponse, error)
 	GetProofDataTrie(rootHash string, address string, key string) (*common.GetProofResponse, *common.GetProofResponse, error)
 	GetProofCurrentRootHash(address string) (*common.GetProofResponse, error)

cmd/node/config/api.toml

@@ -35,7 +35,10 @@
         { Name = "/epoch-start/:epoch", Open = true },
 
         # /node/bootstrapstatus will return all metrics available during bootstrap
-        { Name = "/bootstrapstatus", Open = true }
+        { Name = "/bootstrapstatus", Open = true },
+
+        # /node/connected-peers-ratings will return the peers' ratings
+        { Name = "/connected-peers-ratings", Open = true }
     ]
 
 [APIPackages.address]

cmd/node/config/config.toml

@@ -487,9 +487,6 @@
 [PeersRatingConfig]
     TopRatedCacheCapacity           = 5000
     BadRatedCacheCapacity           = 5000
-    TimeWaitingForReconnectionInSec = 300 # 5 min
-    TimeBetweenMetricsUpdateInSec   = 60  # 1 min
-    TimeBetweenCachersSweepInSec    = 60  # 1 min
 
 [PoolsCleanersConfig]
     MaxRoundsToKeepUnprocessedMiniBlocks = 300   # max number of rounds unprocessed miniblocks are kept in pool

common/constants.go

@@ -3,8 +3,6 @@ package common
 import (
 	"math"
 	"time"
-
-	"github.com/multiversx/mx-chain-go/p2p"
 )
 
 // PeerType represents the type of a peer
@@ -654,9 +652,6 @@ const MetricP2PUnknownPeers = "erd_p2p_unknown_shard_peers"
 // MetricP2PNumConnectedPeersClassification is the metric for monitoring the number of connected peers split on the connection type
 const MetricP2PNumConnectedPeersClassification = "erd_p2p_num_connected_peers_classification"
 
-// MetricP2PPeersRating is the metric that outputs the peers ratings
-const MetricP2PPeersRating = p2p.MetricP2PPeersRating
-
 // MetricAreVMQueriesReady will hold the string representation of the boolean that indicated if the node is ready
 // to process VM queries
 const MetricAreVMQueriesReady = "erd_are_vm_queries_ready"

config/config.go

@@ -220,11 +220,8 @@ type Config struct {
 
 // PeersRatingConfig will hold settings related to peers rating
 type PeersRatingConfig struct {
-	TopRatedCacheCapacity           int
-	BadRatedCacheCapacity           int
-	TimeWaitingForReconnectionInSec int64
-	TimeBetweenMetricsUpdateInSec   int64
-	TimeBetweenCachersSweepInSec    int64
+	TopRatedCacheCapacity int
+	BadRatedCacheCapacity int
 }
 
 // LogsConfig will hold settings related to the logging sub-system

dataRetriever/interface.go

@@ -340,11 +340,9 @@ type PreferredPeersHolderHandler interface {
 
 // PeersRatingHandler represent an entity able to handle peers ratings
 type PeersRatingHandler interface {
-	AddPeers(pids []core.PeerID)
 	IncreaseRating(pid core.PeerID)
 	DecreaseRating(pid core.PeerID)
 	GetTopRatedPeersFromList(peers []core.PeerID, minNumOfPeersExpected int) []core.PeerID
-	Close() error
 	IsInterfaceNil() bool
 }
 

epochStart/bootstrap/disabled/disabledPeersRatingHandler.go

@@ -10,10 +10,6 @@ func NewDisabledPeersRatingHandler() *disabledPeersRatingHandler {
 	return &disabledPeersRatingHandler{}
 }
 
-// AddPeers does nothing as it is disabled
-func (dprs *disabledPeersRatingHandler) AddPeers(_ []core.PeerID) {
-}
-
 // IncreaseRating does nothing as it is disabled
 func (dprs *disabledPeersRatingHandler) IncreaseRating(_ core.PeerID) {
 }
@@ -27,11 +23,6 @@ func (dprs *disabledPeersRatingHandler) GetTopRatedPeersFromList(peers []core.Pe
 	return peers
 }
 
-// Close returns the nil as it is disabled
-func (dprs *disabledPeersRatingHandler) Close() error {
-	return nil
-}
-
 // IsInterfaceNil returns true if there is no value under the interface
 func (dprs *disabledPeersRatingHandler) IsInterfaceNil() bool {
 	return dprs == nil

errors/errors.go

@@ -547,3 +547,6 @@ var ErrNilGenesisNodesSetupHandler = errors.New("nil genesis nodes setup handler
 
 // ErrNilPeersRatingHandler signals that a nil peers rating handler implementation has been provided
 var ErrNilPeersRatingHandler = errors.New("nil peers rating handler")
+
+// ErrNilPeersRatingMonitor signals that a nil peers rating monitor implementation has been provided
+var ErrNilPeersRatingMonitor = errors.New("nil peers rating monitor")

facade/initial/initialNodeFacade.go

@@ -253,6 +253,11 @@ func (inf *initialNodeFacade) GetPeerInfo(_ string) ([]core.QueryP2PPeerInfo, er
 	return nil, errNodeStarting
 }
 
+// GetConnectedPeersRatings returns empty string
+func (inf *initialNodeFacade) GetConnectedPeersRatings() string {
+	return ""
+}
+
 // GetEpochStartDataAPI returns nil and error
 func (inf *initialNodeFacade) GetEpochStartDataAPI(_ uint32) (*common.EpochStartDataAPI, error) {
 	return nil, errNodeStarting

facade/interface.go

@@ -91,6 +91,7 @@ type NodeHandler interface {
 
 	GetQueryHandler(name string) (debug.QueryHandler, error)
 	GetPeerInfo(pid string) ([]core.QueryP2PPeerInfo, error)
+	GetConnectedPeersRatings() string
 
 	GetEpochStartDataAPI(epoch uint32) (*common.EpochStartDataAPI, error)
 

facade/mock/nodeStub.go

@@ -37,6 +37,7 @@ type NodeStub struct {
 	GetQueryHandlerCalled                          func(name string) (debug.QueryHandler, error)
 	GetValueForKeyCalled                           func(address string, key string, options api.AccountQueryOptions) (string, api.BlockInfo, error)
 	GetPeerInfoCalled                              func(pid string) ([]core.QueryP2PPeerInfo, error)
+	GetConnectedPeersRatingsCalled                 func() string
 	GetEpochStartDataAPICalled                     func(epoch uint32) (*common.EpochStartDataAPI, error)
 	GetUsernameCalled                              func(address string, options api.AccountQueryOptions) (string, api.BlockInfo, error)
 	GetCodeHashCalled                              func(address string, options api.AccountQueryOptions) ([]byte, api.BlockInfo, error)
@@ -204,6 +205,15 @@ func (ns *NodeStub) GetPeerInfo(pid string) ([]core.QueryP2PPeerInfo, error) {
 	return make([]core.QueryP2PPeerInfo, 0), nil
 }
 
+// GetConnectedPeersRatings -
+func (ns *NodeStub) GetConnectedPeersRatings() string {
+	if ns.GetConnectedPeersRatingsCalled != nil {
+		return ns.GetConnectedPeersRatingsCalled()
+	}
+
+	return ""
+}
+
 // GetEpochStartDataAPI -
 func (ns *NodeStub) GetEpochStartDataAPI(epoch uint32) (*common.EpochStartDataAPI, error) {
 	if ns.GetEpochStartDataAPICalled != nil {

facade/nodeFacade.go

@@ -479,6 +479,11 @@ func (nf *nodeFacade) GetPeerInfo(pid string) ([]core.QueryP2PPeerInfo, error) {
 	return nf.node.GetPeerInfo(pid)
 }
 
+// GetConnectedPeersRatings returns the connected peers ratings
+func (nf *nodeFacade) GetConnectedPeersRatings() string {
+	return nf.node.GetConnectedPeersRatings()
+}
+
 // GetThrottlerForEndpoint returns the throttler for a given endpoint if found
 func (nf *nodeFacade) GetThrottlerForEndpoint(endpoint string) (core.Throttler, bool) {
 	if !nf.wsAntifloodConfig.WebServerAntifloodEnabled {

factory/interface.go

@@ -243,6 +243,7 @@ type NetworkComponentsHolder interface {
 	PeerHonestyHandler() PeerHonestyHandler
 	PreferredPeersHolderHandler() PreferredPeersHolderHandler
 	PeersRatingHandler() p2p.PeersRatingHandler
+	PeersRatingMonitor() p2p.PeersRatingMonitor
 	IsInterfaceNil() bool
 }
 

factory/mock/networkComponentsMock.go

@@ -14,6 +14,7 @@ type NetworkComponentsMock struct {
 	PeerBlackList           process.PeerBlackListCacher
 	PreferredPeersHolder    factory.PreferredPeersHolderHandler
 	PeersRatingHandlerField p2p.PeersRatingHandler
+	PeersRatingMonitorField p2p.PeersRatingMonitor
 }
 
 // PubKeyCacher -
@@ -71,6 +72,11 @@ func (ncm *NetworkComponentsMock) PeersRatingHandler() p2p.PeersRatingHandler {
 	return ncm.PeersRatingHandlerField
 }
 
+// PeersRatingMonitor -
+func (ncm *NetworkComponentsMock) PeersRatingMonitor() p2p.PeersRatingMonitor {
+	return ncm.PeersRatingMonitorField
+}
+
 // IsInterfaceNil -
 func (ncm *NetworkComponentsMock) IsInterfaceNil() bool {
 	return ncm == nil

factory/network/networkComponents.go

@@ -68,6 +68,7 @@ type networkComponents struct {
 	peerHonestyHandler     consensus.PeerHonestyHandler
 	peersHolder            factory.PreferredPeersHolderHandler
 	peersRatingHandler     p2p.PeersRatingHandler
+	peersRatingMonitor     p2p.PeersRatingMonitor
 	closeFunc              context.CancelFunc
 }
 
@@ -123,12 +124,8 @@ func (ncf *networkComponentsFactory) Create() (*networkComponents, error) {
 		return nil, err
 	}
 	argsPeersRatingHandler := p2pFactory.ArgPeersRatingHandler{
-		TopRatedCache:              topRatedCache,
-		BadRatedCache:              badRatedCache,
-		AppStatusHandler:           ncf.statusHandler,
-		TimeWaitingForReconnection: time.Duration(peersRatingCfg.TimeWaitingForReconnectionInSec) * time.Second,
-		TimeBetweenMetricsUpdate:   time.Duration(peersRatingCfg.TimeBetweenMetricsUpdateInSec) * time.Second,
-		TimeBetweenCachersSweep:    time.Duration(peersRatingCfg.TimeBetweenCachersSweepInSec) * time.Second,
+		TopRatedCache: topRatedCache,
+		BadRatedCache: badRatedCache,
 	}
 	peersRatingHandler, err := p2pFactory.NewPeersRatingHandler(argsPeersRatingHandler)
 	if err != nil {
@@ -160,6 +157,16 @@ func (ncf *networkComponentsFactory) Create() (*networkComponents, error) {
 		}
 	}()
 
+	argsPeersRatingMonitor := p2pFactory.ArgPeersRatingMonitor{
+		TopRatedCache:       topRatedCache,
+		BadRatedCache:       badRatedCache,
+		ConnectionsProvider: netMessenger,
+	}
+	peersRatingMonitor, err := p2pFactory.NewPeersRatingMonitor(argsPeersRatingMonitor)
+	if err != nil {
+		return nil, err
+	}
+
 	var antiFloodComponents *antifloodFactory.AntiFloodComponents
 	antiFloodComponents, err = antifloodFactory.NewP2PAntiFloodComponents(ctx, ncf.mainConfig, ncf.statusHandler, netMessenger.ID())
 	if err != nil {
@@ -227,6 +234,7 @@ func (ncf *networkComponentsFactory) Create() (*networkComponents, error) {
 		peerHonestyHandler:     peerHonestyHandler,
 		peersHolder:            ph,
 		peersRatingHandler:     peersRatingHandler,
+		peersRatingMonitor:     peersRatingMonitor,
 		closeFunc:              cancelFunc,
 	}, nil
 }
@@ -261,9 +269,6 @@ func (nc *networkComponents) Close() error {
 	if !check.IfNil(nc.peerHonestyHandler) {
 		log.LogIfError(nc.peerHonestyHandler.Close())
 	}
-	if !check.IfNil(nc.peersRatingHandler) {
-		log.LogIfError(nc.peersRatingHandler.Close())
-	}
 
 	if nc.netMessenger != nil {
 		log.Debug("calling close on the network messenger instance...")