From 8e2f08221fc018521ebdccc10fa344dfab86ee6f Mon Sep 17 00:00:00 2001
From: teor <teor@riseup.net>
Date: Mon, 14 Dec 2020 11:00:39 +1000
Subject: [PATCH] Add peer set tracing and unreachable panics (#1468)

Add some extra tracing and panics to double-check our
assumptions about the peer set state machine.
---
 zebra-network/src/peer_set/candidate_set.rs |  8 +++++++-
 zebra-network/src/peer_set/initialize.rs    | 18 ++++++++++++++----
 2 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/zebra-network/src/peer_set/candidate_set.rs b/zebra-network/src/peer_set/candidate_set.rs
index cbd83c105..e0089e24c 100644
--- a/zebra-network/src/peer_set/candidate_set.rs
+++ b/zebra-network/src/peer_set/candidate_set.rs
@@ -106,6 +106,7 @@ where
         // existing peers, but we don't make too many because update may be
         // called while the peer set is already loaded.
         let mut responses = FuturesUnordered::new();
+        trace!("sending GetPeers requests");
         // Yes this loops only once (for now), until we add fanout back.
         for _ in 0..1usize {
             self.peer_service.ready_and().await?;
@@ -115,7 +116,7 @@ where
             if let Ok(Response::Peers(addrs)) = rsp {
                 let addr_len = addrs.len();
                 let prev_len = self.gossiped.len();
-                // Filter new addresses to ensure that gossiped
+                // Filter new addresses to ensure that gossiped addresses are actually new
                 let failed = &self.failed;
                 let peer_set = &self.peer_set;
                 let new_addrs = addrs
@@ -151,6 +152,11 @@ where
         metrics::gauge!("candidate_set.disconnected", self.disconnected.len() as i64);
         metrics::gauge!("candidate_set.gossiped", self.gossiped.len() as i64);
         metrics::gauge!("candidate_set.failed", self.failed.len() as i64);
+        debug!(
+            disconnected_peers = self.disconnected.len(),
+            gossiped_peers = self.gossiped.len(),
+            failed_peers = self.failed.len()
+        );
         let guard = self.peer_set.lock().unwrap();
         self.disconnected
             .drain_oldest()
diff --git a/zebra-network/src/peer_set/initialize.rs b/zebra-network/src/peer_set/initialize.rs
index c03c6fc63..2c286d118 100644
--- a/zebra-network/src/peer_set/initialize.rs
+++ b/zebra-network/src/peer_set/initialize.rs
@@ -314,9 +314,10 @@ where
                 let _ = demand_tx.try_send(());
             }
             Right((Some(Ok(change)), _)) => {
-                // in fact all changes are Insert so this branch is always taken
                 if let Change::Insert(ref addr, _) = change {
                     debug!(candidate.addr = ?addr, "successfully dialed new peer");
+                } else {
+                    unreachable!("unexpected handshake result: all changes should be Insert");
                 }
                 success_tx.send(Ok(change)).await?;
             }
@@ -328,9 +329,18 @@ where
                 // turned into a connection, so add it back:
                 let _ = demand_tx.try_send(());
             }
-            // If we don't match one of these patterns, shutdown.
-            _ => break,
+            // We don't expect to see these patterns during normal operation
+            Left((Left((None, _)), _)) => {
+                unreachable!("demand_rx never fails, because we hold demand_tx");
+            }
+            Left((Right((None, _)), _)) => {
+                unreachable!("crawl_timer never terminates");
+            }
+            Right((None, _)) => {
+                unreachable!(
+                    "handshakes never terminates, because it contains a future that never resolves"
+                );
+            }
         }
     }
-    Ok(())
 }