refactor(sumeragi): log incoming messages at trace level

Signed-off-by: Shanin Roman <shanin1000@yandex.ru>
hyperledger-iroha · Sep 3, 2024 · e63df38 · e63df38
1 parent 91879da
commit e63df38
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 12 deletions.
diff --git a/core/src/sumeragi/main_loop.rs b/core/src/sumeragi/main_loop.rs
@@ -177,21 +177,23 @@ impl Sumeragi {
                 })
                 .ok()?;
 
-            let block_vc_index = match &block_msg {
+            match &block_msg {
                 BlockMessage::BlockCreated(bc) => {
-                    Some(bc.block.header().view_change_index as usize)
+                    if (bc.block.header().view_change_index as usize) < current_view_change_index {
+                        trace!(
+                            ty="BlockCreated",
+                            block=%bc.block.hash(),
+                            "Discarding message due to outdated view change index",
+                        );
+                        // ignore block_message
+                        continue;
+                    }
                 }
                 // Signed and Committed contain no block.
                 // Block sync updates are exempt from early pruning.
                 BlockMessage::BlockSigned(_)
                 | BlockMessage::BlockCommitted(_)
-                | BlockMessage::BlockSyncUpdate(_) => None,
-            };
-            if let Some(block_vc_index) = block_vc_index {
-                if block_vc_index < current_view_change_index {
-                    // ignore block_message
-                    continue;
-                }
+                | BlockMessage::BlockSyncUpdate(_) => {}
             }
             return Some(block_msg);
         }

diff --git a/core/src/sumeragi/mod.rs b/core/src/sumeragi/mod.rs
@@ -45,6 +45,7 @@ pub struct SumeragiHandle {
 impl SumeragiHandle {
     /// Deposit a sumeragi control flow network message.
     pub fn incoming_control_flow_message(&self, msg: ControlFlowMessage) {
+        trace!(ty = "ViewChangeProofChain", "Incoming message");
         if let Err(error) = self.control_message_sender.try_send(msg) {
             self.dropped_messages_metric.inc();
 
@@ -59,7 +60,19 @@ impl SumeragiHandle {
 
     /// Deposit a sumeragi network message.
     pub fn incoming_block_message(&self, msg: impl Into<BlockMessage>) {
-        if let Err(error) = self.message_sender.try_send(msg.into()) {
+        let msg = msg.into();
+        let (ty, block) = match &msg {
+            BlockMessage::BlockCommitted(BlockCommitted { hash, .. }) => ("BlockCommitted", *hash),
+            BlockMessage::BlockCreated(BlockCreated { block }) => ("BlockCreated", block.hash()),
+            BlockMessage::BlockSigned(BlockSigned { hash, .. }) => ("BlockSigned", *hash),
+            BlockMessage::BlockSyncUpdate(BlockSyncUpdate { block }) => {
+                trace!(ty="BlockSyncUpdate", block=%block.hash(), "Incoming message");
+                ("BlockSyncUpdate", block.hash())
+            }
+        };
+        trace!(ty, %block, "Incoming message");
+
+        if let Err(error) = self.message_sender.try_send(msg) {
             self.dropped_messages_metric.inc();
 
             error!(

diff --git a/core/src/sumeragi/view_change.rs b/core/src/sumeragi/view_change.rs
@@ -22,8 +22,9 @@ pub enum Error {
     ViewChangeNotFound,
 }
 
-#[derive(Debug, Clone, Decode, Encode)]
-struct ViewChangeProofPayload {
+/// Payload of view change.
+#[derive(Debug, Clone, Copy, Decode, Encode)]
+pub struct ViewChangeProofPayload {
     /// Hash of the latest committed block.
     latest_block: HashOf<BlockHeader>,
     /// Within a round, what is the index of the view change this proof is trying to prove.