protocols/kad: Add try_finish debug logging

libp2p · Jun 16, 2020 · d87141c · d87141c
1 parent e5542e8
commit d87141c
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 7 deletions.
diff --git a/protocols/kad/src/behaviour.rs b/protocols/kad/src/behaviour.rs
@@ -1518,7 +1518,17 @@ where
                                     .filter_map(|PeerRecord{ peer, .. }| peer.as_ref())
                                     .cloned()
                                     .collect::<Vec<_>>();
-                                query.try_finish(peers.iter())
+                                let is_finished = query.try_finish(peers.iter());
+
+                                debug!(
+                                    "GetRecord query with id {:?} reached the quorum {} finished \
+                                     with recent response from peer {}, counting {} successful \
+                                     responses total.",
+                                    user_data,
+                                    if is_finished { "and is" } else { "but is not yet" },
+                                    source,
+                                    peers.len(),
+                                );
                             }
                         } else if quorum.get() == 1 {
                             // It is a "standard" Kademlia query, for which the
@@ -1556,10 +1566,20 @@ where
                     if let QueryInfo::PutRecord {
                         phase: PutRecordPhase::PutRecord { success, .. }, quorum, ..
                     } = &mut query.inner.info {
-                        success.push(source);
+                        success.push(source.clone());
                         if success.len() >= quorum.get() {
                             let peers = success.clone();
-                            query.try_finish(peers.iter())
+                            let is_finished = query.try_finish(peers.iter());
+
+                            debug!(
+                                "PutRecord query with id {:?} reached the quorum {} finished \
+                                 with recent response from peer {}, counting {} successful \
+                                 responses total.",
+                                user_data,
+                                if is_finished { "and is" } else { "but is not yet" },
+                                source,
+                                peers.len(),
+                            );
                         }
                     }
                 }

diff --git a/protocols/kad/src/query.rs b/protocols/kad/src/query.rs
@@ -354,15 +354,17 @@ impl<TInner> Query<TInner> {
     /// A finished query immediately stops yielding new peers to contact and
     /// will be reported by [`QueryPool::poll`] via
     /// [`QueryPoolState::Finished`].
-    pub fn try_finish<'a, I>(&mut self, peers: I)
+    pub fn try_finish<'a, I>(&mut self, peers: I) -> bool
     where
         I: IntoIterator<Item = &'a PeerId>
     {
         match &mut self.peer_iter {
             QueryPeerIter::Closest(iter) => iter.finish(),
-            QueryPeerIter::ClosestDisjoint(iter) => iter.finish_paths(peers),
+            QueryPeerIter::ClosestDisjoint(iter) => return iter.finish_paths(peers),
             QueryPeerIter::Fixed(iter) => iter.finish()
-        }
+        };
+
+        true
     }
 
     /// Finishes the query prematurely.

diff --git a/protocols/kad/src/query/peers/closest/disjoint.rs b/protocols/kad/src/query/peers/closest/disjoint.rs
@@ -278,7 +278,7 @@ impl ClosestDisjointPeersIter {
     /// Finishes all paths containing one of the given peers.
     ///
     /// See [`crate::query::Query::try_finish`] for details.
-    pub fn finish_paths<'a, I>(&mut self, peers: I)
+    pub fn finish_paths<'a, I>(&mut self, peers: I) -> bool
     where
         I: IntoIterator<Item = &'a PeerId>
     {
@@ -287,6 +287,8 @@ impl ClosestDisjointPeersIter {
                 self.iters[*initiated_by].finish();
             }
         }
+
+        self.is_finished()
     }
 
     /// Immediately transitions the iterator to [`PeersIterState::Finished`].