fix(gossipsub): gracefully disable handler on stream errors

Previously, we closed the entire connection upon receiving too many upgrade errors. This is unnecessarily aggressive. For example, an upgrade error may be caused by the remote dropping a stream during the initial handshake which is completely isolated from other protocols running on the same connection. Instead of closing the connection, set `KeepAlive::No`. Related: #3591. Resolves: #3690. Pull-Request: #3625.
libp2p · Apr 14, 2023 · 96288b8 · 96288b8
1 parent 058c2d8
commit 96288b8
Show file tree

Hide file tree

Showing 11 changed files with 301 additions and 278 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/protocols/gossipsub/CHANGELOG.md b/protocols/gossipsub/CHANGELOG.md
@@ -2,7 +2,11 @@
 
 - Fix erroneously duplicate message IDs. See [PR 3716].
 
+- Gracefully disable handler on stream errors. Deprecate a few variants of `HandlerError`.
+  See [PR 3625].
+
 [PR 3716]: https://github.com/libp2p/rust-libp2p/pull/3716
+[PR 3625]: https://github.com/libp2p/rust-libp2p/pull/3325
 
 ## 0.44.2
 

diff --git a/protocols/gossipsub/Cargo.toml b/protocols/gossipsub/Cargo.toml
@@ -11,7 +11,8 @@ keywords = ["peer-to-peer", "libp2p", "networking"]
 categories = ["network-programming", "asynchronous"]
 
 [dependencies]
-libp2p-swarm = { version = "0.42.1", path = "../../swarm" }
+either = "1.5"
+libp2p-swarm = { version = "0.42.2", path = "../../swarm" }
 libp2p-core = { version = "0.39.0", path = "../../core" }
 libp2p-identity = { version = "0.1.2", path = "../../identity" }
 bytes = "1.4"
@@ -33,6 +34,7 @@ serde = { version = "1", optional = true, features = ["derive"] }
 thiserror = "1.0"
 wasm-timer = "0.2.5"
 instant = "0.1.11"
+void = "1.0.2"
 # Metrics dependencies
 prometheus-client = "0.19.0"
 

diff --git a/protocols/gossipsub/src/error.rs b/protocols/gossipsub/src/error.rs
@@ -30,16 +30,10 @@ pub type PublishError = crate::error_priv::PublishError;
 )]
 pub type SubscriptionError = crate::error_priv::SubscriptionError;
 
-#[deprecated(
-    since = "0.44.0",
-    note = "Use re-exports that omit `Gossipsub` prefix, i.e. `libp2p::gossipsub::HandlerError"
-)]
+#[deprecated(note = "This error will no longer be emitted")]
 pub type GossipsubHandlerError = crate::error_priv::HandlerError;
 
-#[deprecated(
-    since = "0.44.0",
-    note = "Use `libp2p::gossipsub::HandlerError` instead, as the `error` module will become crate-private in the future."
-)]
+#[deprecated(note = "This error will no longer be emitted")]
 pub type HandlerError = crate::error_priv::HandlerError;
 
 #[deprecated(

diff --git a/protocols/gossipsub/src/error_priv.rs b/protocols/gossipsub/src/error_priv.rs
@@ -134,12 +134,6 @@ impl std::fmt::Display for ValidationError {
 
 impl std::error::Error for ValidationError {}
 
-impl From<std::io::Error> for HandlerError {
-    fn from(error: std::io::Error) -> HandlerError {
-        HandlerError::Codec(quick_protobuf_codec::Error::from(error))
-    }
-}
-
 impl From<std::io::Error> for PublishError {
     fn from(error: std::io::Error) -> PublishError {
         PublishError::TransformFailed(error)