Merge pull request #188 from NodeFactoryIo/mmuftic/additional-logging

Add additional logging

.version

@@ -1 +1 @@
-version=0.5.1
+version=0.5.2

CHANGELOG.md

@@ -1,14 +1,24 @@
 # Changelog
 
 ## [unreleased]((https://github.com/NodeFactoryIo/vedran/tree/HEAD))
-[Full Changelog](https://github.com/NodeFactoryIo/vedran/compare/v0.5.1...HEAD)
+[Full Changelog](https://github.com/NodeFactoryIo/vedran/compare/v0.5.2...HEAD)
 
 ### Added
 
 ### Fix
 
 ### Changed
 
+## [v0.5.2]((https://github.com/NodeFactoryIo/vedran/tree/v0.5.2))
+[Full Changelog](https://github.com/NodeFactoryIo/vedran/compare/v0.5.1...v0.5.2)
+
+### Added
+- Add additional logging [\#188](https://github.com/NodeFactoryIo/vedran/pull/188) ([MakMuftic](https://github.com/MakMuftic))
+
+### Fix
+
+### Changed
+
 ## [v0.5.1]((https://github.com/NodeFactoryIo/vedran/tree/v0.5.1))
 [Full Changelog](https://github.com/NodeFactoryIo/vedran/compare/v0.5.0...v0.5.1)
 

docker-compose.yml

@@ -17,7 +17,7 @@ services:
 
   vedran:
     command: start --auth-secret=test-secret --log-level debug --public-ip vedran --server-port 4000  --private-key ${VEDRAN_LB_PK:-0xe5be9a5092b81bca64be81d212e7f2f9eba183bb7a90954f7b76361f6edb5c0a} --payout-interval 1 --payout-reward ${VEDRAN_LB_REWARD_POOL:-10}
-    image: nodefactory/vedran:v0.5.0
+    image: nodefactory/vedran:latest
     environment:
       - PROM_FEE_STATS_INTERVAL=10s
       - PROM_PAYOUT_STATS_INTERVAL=5s

internal/actions/actions.go

@@ -6,7 +6,7 @@ import (
 )
 
 type Actions interface {
-	PenalizeNode(node models.Node, repositories repositories.Repos)
+	PenalizeNode(node models.Node, repositories repositories.Repos, message string)
 }
 
 type actions struct{}

internal/actions/penalize.go

@@ -11,7 +11,7 @@ const InitialPenalizeIntervalInMins = 1
 
 // PenalizeNode removes provided node from active nodes, sets initial cooldown of 1 minute and schedules check for
 // penalized node by invoking penalize.ScheduleCheckForPenalizedNode
-func (a *actions) PenalizeNode(node models.Node, repositories repositories.Repos) {
+func (a *actions) PenalizeNode(node models.Node, repositories repositories.Repos, message string) {
 	// remove node from active
 	err := repositories.NodeRepo.RemoveNodeFromActive(node.ID)
 	if err != nil {
@@ -27,6 +27,6 @@ func (a *actions) PenalizeNode(node models.Node, repositories repositories.Repos
 		return
 	}
 
-	log.Debugf("Penalized node %s, on cooldown for 1 minute ", node.ID)
+	log.Debugf("Penalized node %s, on cooldown for 1 minute, because %s ", node.ID, message)
 	go penalize.ScheduleCheckForPenalizedNode(node, repositories)
 }

internal/controllers/rpc_test.go

@@ -51,7 +51,7 @@ func TestApiController_RPCHandler(t *testing.T) {
 	recordRepoMock.On("Save", mock.Anything).Return(nil)
 
 	actionsMockObject := new(actionMocks.Actions)
-	actionsMockObject.On("PenalizeNode", mock.Anything, mock.Anything).Return()
+	actionsMockObject.On("PenalizeNode", mock.Anything, mock.Anything, mock.Anything).Return()
 
 	apiController := NewApiController(false, repositories.Repos{
 		NodeRepo:   &nodeRepoMock,
@@ -160,7 +160,7 @@ func TestApiController_BatchRPCHandler(t *testing.T) {
 	recordRepoMock.On("Save", mock.Anything).Return(nil)
 
 	actionsMockObject := new(actionMocks.Actions)
-	actionsMockObject.On("PenalizeNode", mock.Anything, mock.Anything).Return()
+	actionsMockObject.On("PenalizeNode", mock.Anything, mock.Anything, mock.Anything).Return()
 
 	apiController := NewApiController(false, repositories.Repos{
 		NodeRepo:   &nodeRepoMock,
@@ -242,7 +242,7 @@ func TestApiController_RPCHandler_InvalidBody(t *testing.T) {
 	}
 
 	actionsMockObject := new(actionMocks.Actions)
-	actionsMockObject.On("PenalizeNode", mock.Anything, mock.Anything).Return()
+	actionsMockObject.On("PenalizeNode", mock.Anything, mock.Anything, mock.Anything).Return()
 
 	apiController := NewApiController(false, repositories.Repos{}, actionsMockObject)
 

internal/controllers/ws.go

@@ -41,9 +41,9 @@ func (c ApiController) WSHandler(w http.ResponseWriter, r *http.Request) {
 		connectionError := <-connErr
 		connToNode := <-wsConnection
 		if connectionError != nil {
-			log.Errorf("Establishing connection failed because of %v", err)
+			log.Errorf("Establishing connection failed because of %v", connectionError)
 			if connectionError.IsNodeError() {
-				c.actions.PenalizeNode(node, c.repositories)
+				c.actions.PenalizeNode(node, c.repositories, "establishing connection failed")
 			}
 			continue
 		}

internal/controllers/ws_test.go

@@ -80,7 +80,10 @@ func TestApiController_WSHandler(t *testing.T) {
 
 			actionsMockObject := new(actionMocks.Actions)
 			actionsMockObject.On(
-				"PenalizeNode", mock.MatchedBy(func(n models.Node) bool { return n.ID == "1" }), mock.Anything,
+				"PenalizeNode",
+				mock.MatchedBy(func(n models.Node) bool { return n.ID == "1" }),
+				mock.Anything,
+				mock.Anything,
 			).Return()
 
 			apiController := NewApiController(false, repositories.Repos{

internal/record/record.go

@@ -11,7 +11,7 @@ import (
 // FailedRequest should be called when rpc response is invalid to penalize node.
 // It does not return value as it should be called in separate goroutine
 func FailedRequest(node models.Node, repositories repositories.Repos, actions actions.Actions) {
-	actions.PenalizeNode(node, repositories)
+	actions.PenalizeNode(node, repositories, "failed request")
 
 	err := repositories.RecordRepo.Save(&models.Record{
 		NodeId:    node.ID,

internal/record/record_test.go

@@ -40,7 +40,7 @@ func TestFailedRequest(t *testing.T) {
 			recordRepoMock.On("Save", mock.Anything).Once().Return(tt.saveNodeRecordResult)
 
 			actionsMock := aMock.Actions{}
-			actionsMock.On("PenalizeNode", node, mock.Anything).Return()
+			actionsMock.On("PenalizeNode", node, mock.Anything, mock.Anything).Return()
 
 			FailedRequest(node, repositories.Repos{
 				RecordRepo: &recordRepoMock,

internal/schedule/checkactive/schedule.go

@@ -44,7 +44,7 @@ func scheduledTask(repos *repositories.Repos, actions actions.Actions) {
 		}
 
 		if !pingActive {
-			actions.PenalizeNode(node, *repos)
+			actions.PenalizeNode(node, *repos, "inactive ping")
 			continue
 		}
 

internal/schedule/checkactive/schedule_test.go

@@ -286,7 +286,7 @@ func Test_scheduledTask(t *testing.T) {
 			actionsMockObject := new(actionMocks.Actions)
 			if test.penalizedNodes != nil {
 				for _, pNode := range test.penalizedNodes {
-					actionsMockObject.On("PenalizeNode", pNode, mock.Anything).Return().Once()
+					actionsMockObject.On("PenalizeNode", pNode, mock.Anything, mock.Anything).Return().Once()
 				}
 			}