refactor: Improve logging for failed p2p connection (#5379)

* refactor: Improve logging for failed p2p connection
* refactor: Remove self from `NetworkBase::current_peers_addresses`

---------

Signed-off-by: Dmitry Murzin <diralik@yandex.ru>

Author: dima74

crates/iroha_core/src/peers_gossiper.rs

@@ -45,6 +45,8 @@ impl PeersGossiperHandle {
 
 /// Actor which gossips peers addresses.
 pub struct PeersGossiper {
+    /// Id of the current peer
+    peer_id: PeerId,
     /// Peers provided at startup
     initial_peers: BTreeMap<PeerId, SocketAddr>,
     /// Peers received via gossiping from other peers
@@ -68,6 +70,7 @@ pub struct PeersGossiper {
 impl PeersGossiper {
     /// Start actor.
     pub fn start(
+        peer_id: PeerId,
         trusted_peers: TrustedPeers,
         network: IrohaNetwork,
         shutdown_signal: ShutdownSignal,
@@ -78,6 +81,7 @@ impl PeersGossiper {
             .map(|peer| (peer.id, peer.address))
             .collect();
         let gossiper = Self {
+            peer_id,
             initial_peers,
             gossip_peers: BTreeMap::new(),
             current_topology: BTreeSet::new(),
@@ -176,16 +180,17 @@ impl PeersGossiper {
 
         let mut peers = Vec::new();
         for (id, address) in &self.initial_peers {
-            if !online_peers_ids.contains(id) {
-                peers.push((id.clone(), address.clone()));
-            }
+            peers.push((id.clone(), address.clone()));
         }
         for (id, addresses) in &self.gossip_peers {
-            if !online_peers_ids.contains(id) {
-                peers.push((id.clone(), choose_address_majority_rule(addresses)));
-            }
+            peers.push((id.clone(), choose_address_majority_rule(addresses)));
         }
 
+        let peers = peers
+            .into_iter()
+            .filter(|(id, _)| !online_peers_ids.contains(id) && id != &self.peer_id)
+            .collect();
+
         let update = UpdatePeers(peers);
         self.network.update_peers_addresses(update);
     }

crates/iroha_p2p/src/network.rs

@@ -231,6 +231,8 @@ struct NetworkBase<T: Pload, K: Kex, E: Enc> {
     current_conn_id: ConnectionId,
     /// Current topology
     current_topology: HashSet<PeerId>,
+    /// Peers which are not yet connected, but should.
+    ///
     /// Can have two addresses for same `PeerId`.
     /// * One initially provided via config
     /// * Second received from other peers via gossiping

crates/iroha_p2p/src/peer.rs

@@ -1,5 +1,7 @@
 //! Tokio actor Peer
 
+use std::net::SocketAddr;
+
 use bytes::{Buf, BufMut, BytesMut};
 use message::*;
 use parity_scale_codec::{DecodeAll, Encode};
@@ -110,7 +112,7 @@ mod run {
 
     /// Peer task.
     #[allow(clippy::too_many_lines)]
-    #[log(skip_all, fields(conn_id = peer.connection_id(), peer, disambiguator))]
+    #[log(skip_all, fields(connection = &peer.log_description(), conn_id = peer.connection_id(), peer, disambiguator))]
     pub(super) async fn run<T: Pload, K: Kex, E: Enc, P: Entrypoint<K, E>>(
         RunPeerArgs {
             peer,
@@ -145,6 +147,7 @@ mod run {
                         read,
                         write,
                         id: connection_id,
+                        ..
                     },
                 cryptographer,
             } = ready_peer;
@@ -298,18 +301,38 @@ mod run {
     /// Trait for peer stages that might be used as starting point for peer's [`run`] function.
     pub(super) trait Entrypoint<K: Kex, E: Enc>: Handshake<K, E> + Send + 'static {
         fn connection_id(&self) -> ConnectionId;
+
+        /// Debug description, used for logging
+        fn log_description(&self) -> String;
     }
 
     impl<K: Kex, E: Enc> Entrypoint<K, E> for Connecting {
         fn connection_id(&self) -> ConnectionId {
             self.connection_id
         }
+
+        fn log_description(&self) -> String {
+            format!("outgoing to {}", self.peer_addr)
+        }
     }
 
     impl<K: Kex, E: Enc> Entrypoint<K, E> for ConnectedFrom {
         fn connection_id(&self) -> ConnectionId {
             self.connection.id
         }
+
+        fn log_description(&self) -> String {
+            #[allow(clippy::option_if_let_else)]
+            match self.connection.remote_addr {
+                None => "incoming".to_owned(),
+                Some(remote_addr) => {
+                    // In case of incoming connection,
+                    // only host will have some meaningful value.
+                    // Port will have some random value chosen only for this connection.
+                    format!("incoming from {}", remote_addr.ip())
+                }
+            }
+        }
     }
 
     /// Cancellation-safe way to read messages from tcp stream
@@ -859,12 +882,20 @@ pub struct Connection {
     pub read: OwnedReadHalf,
     /// Writing half of `TcpStream`
     pub write: OwnedWriteHalf,
+    /// Remote addr, for logging purpose.
+    pub remote_addr: Option<SocketAddr>,
 }
 
 impl Connection {
     /// Instantiate new connection from `connection_id` and `stream`.
     pub fn new(id: ConnectionId, stream: TcpStream) -> Self {
+        let remote_addr = stream.peer_addr().ok();
         let (read, write) = stream.into_split();
-        Connection { id, read, write }
+        Connection {
+            id,
+            read,
+            write,
+            remote_addr,
+        }
     }
 }

crates/irohad/src/main.rs

@@ -260,6 +260,7 @@ impl Iroha {
         );
 
         let (peers_gossiper, child) = PeersGossiper::start(
+            config.common.peer.id.clone(),
             config.common.trusted_peers.value().clone(),
             network.clone(),
             supervisor.shutdown_signal(),