Refactor/fix state sync logs

app/pocket/doc/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.5] - 2023-02-15
+
+- Removed unnecessary server mode enabling call via EnableServerMode() function
+
 ## [0.0.0.4] - 2023-02-07
 
 - Added GITHUB_WIKI tags where it was missing

app/pocket/main.go

@@ -31,7 +31,6 @@ func main() {
 	if err != nil {
 		logger.Global.Fatal().Err(err).Msg("Failed to create pocket node")
 	}
-	pocketNode.GetBus().GetConsensusModule().EnableServerMode()
 
 	if err = pocketNode.Start(); err != nil {
 		logger.Global.Fatal().Err(err).Msg("Failed to start pocket node")

consensus/debugging.go

@@ -123,8 +123,8 @@ func (m *consensusModule) sendGetBlockStateSyncMessage(_ *messaging.DebugMessage
 
 	for _, val := range validators {
 		valAddress := cryptoPocket.AddressFromString(val.GetAddress())
-		if err := m.stateSync.SendStateSyncMessage(stateSyncGetBlockMessage, valAddress, requestHeight); err != nil {
-			m.logger.Debug().Msgf(typesCons.SendingStateSyncMessage(valAddress, requestHeight), err)
+		if err := m.stateSync.SendStateSyncMessage(stateSyncGetBlockMessage, typesCons.StateSyncGetBlockRequest, valAddress, requestHeight); err != nil {
+			m.logger.Error().Err(err).Msg("failed to send get block request state sync message")
 		}
 	}
 }
@@ -150,8 +150,8 @@ func (m *consensusModule) sendGetMetadataStateSyncMessage(_ *messaging.DebugMess
 
 	for _, val := range validators {
 		valAddress := cryptoPocket.AddressFromString(val.GetAddress())
-		if err := m.stateSync.SendStateSyncMessage(stateSyncMetaDataReqMessage, valAddress, requestHeight); err != nil {
-			m.logger.Debug().Msgf(typesCons.SendingStateSyncMessage(valAddress, requestHeight), err)
+		if err := m.stateSync.SendStateSyncMessage(stateSyncMetaDataReqMessage, typesCons.StateSyncGetMetadataRequest, valAddress, requestHeight); err != nil {
+			m.logger.Error().Err(err).Msg("failed to send get metadata request state sync message")
 		}
 	}
 

consensus/doc/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.29] - 2023-02-15
+
+- Updated log messages in the state sync submodule with consistent style and add height information
+- Added state sync message types to the types package
+
 ## [0.0.0.28] - 2023-02-14
 
 - Add a few `nolint` comments to fix the code on main

consensus/state_sync/helpers.go

@@ -6,12 +6,12 @@ import (
 	"google.golang.org/protobuf/types/known/anypb"
 )
 
-func (m *stateSync) SendStateSyncMessage(stateSyncMsg *typesCons.StateSyncMessage, peerId cryptoPocket.Address, blockHeight uint64) error {
+func (m *stateSync) SendStateSyncMessage(stateSyncMsg *typesCons.StateSyncMessage, msgType string, peerId cryptoPocket.Address, blockHeight uint64) error {
 	anyMsg, err := anypb.New(stateSyncMsg)
 	if err != nil {
 		return err
 	}
-	m.logger.Info().Uint64("height", blockHeight).Msg(typesCons.SendingStateSyncMessage(peerId, blockHeight))
+	m.logger.Info().Uint64("height", blockHeight).Msg(typesCons.SendingStateSyncMessage(peerId, msgType, blockHeight))
 	return m.sendToPeer(anyMsg, peerId)
 }
 

consensus/state_sync/module.go

@@ -36,7 +36,7 @@ type StateSyncModule interface {
 	IsServerModEnabled() bool
 	EnableServerMode()
 
-	SendStateSyncMessage(*typesCons.StateSyncMessage, cryptoPocket.Address, uint64) error
+	SendStateSyncMessage(*typesCons.StateSyncMessage, string, cryptoPocket.Address, uint64) error
 }
 
 var (
@@ -70,6 +70,7 @@ func (*stateSync) Create(bus modules.Bus) (modules.Module, error) {
 	}
 
 	// when node is starting, it is in sync mode, as it might need to bootstrap to the latest state
+	// TODO: consider setting this thorugh event sent by state machine for consistency
 	m.currentMode = Sync
 	m.serverMode = false
 
@@ -117,13 +118,24 @@ func (m *stateSync) EnableServerMode() {
 // TODO(#352): Implement this function
 // Placeholder function
 func (m *stateSync) HandleGetBlockResponse(blockRes *typesCons.GetBlockResponse) error {
-	m.logger.Debug().Msgf("Received get block response: %s", blockRes.Block.String())
+	consensusMod := m.GetBus().GetConsensusModule()
+	serverNodePeerId := consensusMod.GetNodeAddress()
+	clientPeerId := blockRes.PeerAddress
+
+	m.logger.Info().Msgf("%s received get block response from: %s, for height %d. Received block's header is: %s,  \n", serverNodePeerId, clientPeerId, blockRes.Block.BlockHeader.Height, blockRes.Block.BlockHeader)
+
 	return nil
 }
 
 // TODO(#352): Implement the business to handle these correctly
 // Placeholder function
 func (m *stateSync) HandleStateSyncMetadataResponse(metaDataRes *typesCons.StateSyncMetadataResponse) error {
-	m.logger.Debug().Msgf("Received get metadata response: %s", metaDataRes.String())
+	consensusMod := m.GetBus().GetConsensusModule()
+	serverNodePeerId := consensusMod.GetNodeAddress()
+	clientPeerId := metaDataRes.PeerAddress
+	currentHeight := consensusMod.CurrentHeight()
+
+	m.logger.Info().Msgf("%s received get metadata response from: %s, current height is %d. Received metadata is: %s \n", serverNodePeerId, clientPeerId, currentHeight, metaDataRes)
+
 	return nil
 }

consensus/state_sync/server.go

@@ -22,13 +22,15 @@ type StateSyncServerModule interface {
 
 func (m *stateSync) HandleStateSyncMetadataRequest(metadataReq *typesCons.StateSyncMetadataRequest) error {
 	consensusMod := m.GetBus().GetConsensusModule()
-	serverNodePeerId := m.GetBus().GetConsensusModule().GetNodeAddress()
-
+	serverNodePeerId := consensusMod.GetNodeAddress()
+	currentHeight := consensusMod.CurrentHeight()
 	clientPeerAddress := metadataReq.PeerAddress
-	m.logger.Info().Msgf("%s received state sync metadata request from: %s", serverNodePeerId, clientPeerAddress)
 
-	// last finalized block
-	persistenceContext, err := m.GetBus().GetPersistenceModule().NewReadContext(int64(consensusMod.CurrentHeight()) - 1)
+	m.logger.Info().Msgf("%s received state sync metadata request from: %s, at height: %d \n", serverNodePeerId, clientPeerAddress, currentHeight)
+
+	// current height is the height of the block that is being processed, so we need to subtract 1 for the last finalized block
+	lastPersistedBlockHeight := currentHeight - 1
+	persistenceContext, err := m.GetBus().GetPersistenceModule().NewReadContext(int64(lastPersistedBlockHeight))
 	if err != nil {
 		return nil
 	}
@@ -54,20 +56,21 @@ func (m *stateSync) HandleStateSyncMetadataRequest(metadataReq *typesCons.StateS
 		},
 	}
 
-	return m.SendStateSyncMessage(&stateSyncMessage, cryptoPocket.AddressFromString(clientPeerAddress), m.bus.GetConsensusModule().CurrentHeight())
+	return m.SendStateSyncMessage(&stateSyncMessage, typesCons.StateSyncGetMetadataRequest, cryptoPocket.AddressFromString(clientPeerAddress), m.bus.GetConsensusModule().CurrentHeight())
 }
 
 func (m *stateSync) HandleGetBlockRequest(blockReq *typesCons.GetBlockRequest) error {
 	consensusMod := m.GetBus().GetConsensusModule()
 	serverNodePeerAddress := consensusMod.GetNodeAddress()
-
 	clientPeerAddress := blockReq.PeerAddress
-	m.logger.Info().Msgf("%s received state sync Get Block Req from: %s", serverNodePeerAddress, clientPeerAddress)
+	currentHeight := consensusMod.CurrentHeight()
 
-	currentHeight := m.GetBus().GetConsensusModule().CurrentHeight()
+	m.logger.Info().Msgf("%s received state sync get block request from: %s, at height: %d \n", serverNodePeerAddress, clientPeerAddress, currentHeight)
 
-	if currentHeight < blockReq.Height {
-		return fmt.Errorf("requested block height: %d is higher than node's block height: %d", blockReq.Height, consensusMod.CurrentHeight())
+	// current height is the height of the block that is being processed, so we need to subtract 1 for the last finalized block
+	lastPersistedBlockHeight := currentHeight - 1
+	if lastPersistedBlockHeight < blockReq.Height {
+		return fmt.Errorf("requested block height: %d is higher than current persisted block height: %d", blockReq.Height, lastPersistedBlockHeight)
 	}
 
 	// get block from the persistence module
@@ -85,7 +88,7 @@ func (m *stateSync) HandleGetBlockRequest(blockReq *typesCons.GetBlockRequest) e
 		},
 	}
 
-	return m.SendStateSyncMessage(&stateSyncMessage, cryptoPocket.AddressFromString(clientPeerAddress), blockReq.Height)
+	return m.SendStateSyncMessage(&stateSyncMessage, typesCons.StateSyncGetBlockRequest, cryptoPocket.AddressFromString(clientPeerAddress), blockReq.Height)
 }
 
 // Get a block from persistence module given block height

consensus/types/errors.go

@@ -83,8 +83,8 @@ func SendingMessage(msg *HotstuffMessage, nodeId NodeId) string {
 	return fmt.Sprintf("✉️ Sending message ✉️ to %d at (height, step, round) (%d, %d, %d)", nodeId, msg.Height, msg.Step, msg.Round)
 }
 
-func SendingStateSyncMessage(nodeId cryptoPocket.Address, height uint64) string {
-	return fmt.Sprintf("🔄 Sending State sync message ✉️ to node %s at height: (%d)  🔄", nodeId, height)
+func SendingStateSyncMessage(nodeId cryptoPocket.Address, msgType string, height uint64) string {
+	return fmt.Sprintf("🔄 Sending %s state sync message ✉️ to node %s at height: (%d)  🔄", msgType, nodeId, height)
 }
 
 func BroadcastingMessage(msg *HotstuffMessage) string {

consensus/types/types.go

@@ -5,6 +5,13 @@ import (
 	coreTypes "github.com/pokt-network/pocket/shared/core/types"
 )
 
+const (
+	StateSyncGetBlockRequest     = "get block request"
+	StateSyncGetMetadataRequest  = "get metadata request"
+	StateSyncGetBlockResponse    = "get block response"
+	StateSyncGetMetadataResponse = "get metadata response"
+)
+
 type NodeId uint64
 
 type (