Add ProtocolsHandler::InboundOpenInfo. (#1714)

* Add `ProtocolsHandler::InboundOpenInfo`. * Update swarm/src/protocols_handler/multi.rs Co-authored-by: Roman Borschel <[email protected]> * Update CHANGELOGs and versions. Co-authored-by: Roman Borschel <[email protected]>
libp2p · Aug 23, 2020 · 0b05b21 · 0b05b21
1 parent 740a2e0
commit 0b05b21
Show file tree

Hide file tree

Showing 32 changed files with 337 additions and 204 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,13 @@
 - [`parity-multiaddr` CHANGELOG](misc/multiaddr/CHANGELOG.md)
 - [`libp2p-core-derive` CHANGELOG](misc/core-derive/CHANGELOG.md)
 
+# Version 0.25.0 [unreleased]
+
+- The `ProtocolsHandler` in `libp2p-swarm` has a new associated type
+  `InboundOpenInfo` ([PR 1714]).
+
+[PR 1714]: https://github.com/libp2p/rust-libp2p/pull/1714
+
 # Version 0.24.0 [2020-08-18]
 
 - Update `libp2p-core`, `libp2p-gossipsub`, `libp2p-kad`, `libp2p-mdns`,

diff --git a/Cargo.toml b/Cargo.toml
@@ -2,7 +2,7 @@
 name = "libp2p"
 edition = "2018"
 description = "Peer-to-peer networking library"
-version = "0.24.0"
+version = "0.25.0"
 authors = ["Parity Technologies <[email protected]>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"
@@ -65,18 +65,18 @@ futures = "0.3.1"
 lazy_static = "1.2"
 libp2p-core = { version = "0.21.0", path = "core" }
 libp2p-core-derive = { version = "0.20.2", path = "misc/core-derive" }
-libp2p-floodsub = { version = "0.21.0", path = "protocols/floodsub", optional = true }
-libp2p-gossipsub = { version = "0.21.0", path = "./protocols/gossipsub", optional = true }
-libp2p-identify = { version = "0.21.0", path = "protocols/identify", optional = true }
-libp2p-kad = { version = "0.22.0", path = "protocols/kad", optional = true }
+libp2p-floodsub = { version = "0.22.0", path = "protocols/floodsub", optional = true }
+libp2p-gossipsub = { version = "0.22.0", path = "./protocols/gossipsub", optional = true }
+libp2p-identify = { version = "0.22.0", path = "protocols/identify", optional = true }
+libp2p-kad = { version = "0.23.0", path = "protocols/kad", optional = true }
 libp2p-mplex = { version = "0.21.0", path = "muxers/mplex", optional = true }
 libp2p-noise = { version = "0.23.0", path = "protocols/noise", optional = true }
-libp2p-ping = { version = "0.21.0", path = "protocols/ping", optional = true }
+libp2p-ping = { version = "0.22.0", path = "protocols/ping", optional = true }
 libp2p-plaintext = { version = "0.21.0", path = "protocols/plaintext", optional = true }
 libp2p-pnet = { version = "0.19.1", path = "protocols/pnet", optional = true }
-libp2p-request-response = { version = "0.2.0", path = "protocols/request-response", optional = true }
+libp2p-request-response = { version = "0.3.0", path = "protocols/request-response", optional = true }
 libp2p-secio = { version = "0.21.0", path = "protocols/secio", default-features = false, optional = true }
-libp2p-swarm = { version = "0.21.0", path = "swarm" }
+libp2p-swarm = { version = "0.22.0", path = "swarm" }
 libp2p-uds = { version = "0.21.0", path = "transports/uds", optional = true }
 libp2p-wasm-ext = { version = "0.21.0", path = "transports/wasm-ext", optional = true }
 libp2p-yamux = { version = "0.21.0", path = "muxers/yamux", optional = true }
@@ -90,7 +90,7 @@ wasm-timer = "0.2.4"
 [target.'cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))'.dependencies]
 libp2p-deflate = { version = "0.21.0", path = "protocols/deflate", optional = true }
 libp2p-dns = { version = "0.21.0", path = "transports/dns", optional = true }
-libp2p-mdns = { version = "0.21.0", path = "protocols/mdns", optional = true }
+libp2p-mdns = { version = "0.22.0", path = "protocols/mdns", optional = true }
 libp2p-tcp = { version = "0.21.0", path = "transports/tcp", optional = true }
 libp2p-websocket = { version = "0.22.0", path = "transports/websocket", optional = true }
 

diff --git a/protocols/floodsub/CHANGELOG.md b/protocols/floodsub/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 0.22.0 [unreleased]
+
+- Update `libp2p-swarm`.
+
 # 0.21.0 [2020-08-18]
 
 - Bump `libp2p-core` and `libp2p-swarm` dependency.

diff --git a/protocols/floodsub/Cargo.toml b/protocols/floodsub/Cargo.toml
@@ -2,7 +2,7 @@
 name = "libp2p-floodsub"
 edition = "2018"
 description = "Floodsub protocol for libp2p"
-version = "0.21.0"
+version = "0.22.0"
 authors = ["Parity Technologies <[email protected]>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"
@@ -14,7 +14,7 @@ cuckoofilter = "0.3.2"
 fnv = "1.0"
 futures = "0.3.1"
 libp2p-core = { version = "0.21.0", path = "../../core" }
-libp2p-swarm = { version = "0.21.0", path = "../../swarm" }
+libp2p-swarm = { version = "0.22.0", path = "../../swarm" }
 prost = "0.6.1"
 rand = "0.7"
 smallvec = "1.0"

diff --git a/protocols/gossipsub/CHANGELOG.md b/protocols/gossipsub/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 0.22.0 [unreleased]
+
+- Update `libp2p-swarm`.
+
 # 0.21.0 [2020-08-18]
 
 - Add public API to list topics and peers. [PR 1677](https://github.com/libp2p/rust-libp2p/pull/1677).

diff --git a/protocols/gossipsub/Cargo.toml b/protocols/gossipsub/Cargo.toml
@@ -2,15 +2,15 @@
 name = "libp2p-gossipsub"
 edition = "2018"
 description = "Gossipsub protocol for libp2p"
-version = "0.21.0"
+version = "0.22.0"
 authors = ["Age Manning <[email protected]>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"
 keywords = ["peer-to-peer", "libp2p", "networking"]
 categories = ["network-programming", "asynchronous"]
 
 [dependencies]
-libp2p-swarm = { version = "0.21.0", path = "../../swarm" }
+libp2p-swarm = { version = "0.22.0", path = "../../swarm" }
 libp2p-core = { version = "0.21.0", path = "../../core" }
 bytes = "0.5.4"
 byteorder = "1.3.2"

diff --git a/protocols/gossipsub/src/handler.rs b/protocols/gossipsub/src/handler.rs
@@ -40,7 +40,7 @@ use std::{
 /// Protocol Handler that manages a single long-lived substream with a peer.
 pub struct GossipsubHandler {
     /// Upgrade configuration for the gossipsub protocol.
-    listen_protocol: SubstreamProtocol<ProtocolConfig>,
+    listen_protocol: SubstreamProtocol<ProtocolConfig, ()>,
 
     /// The single long-lived outbound substream.
     outbound_substream: Option<OutboundSubstreamState>,
@@ -95,7 +95,7 @@ impl GossipsubHandler {
                 protocol_id,
                 max_transmit_size,
                 validation_mode,
-            )),
+            ), ()),
             inbound_substream: None,
             outbound_substream: None,
             outbound_substream_establishing: false,
@@ -112,14 +112,16 @@ impl ProtocolsHandler for GossipsubHandler {
     type InboundProtocol = ProtocolConfig;
     type OutboundProtocol = ProtocolConfig;
     type OutboundOpenInfo = GossipsubRpc;
+    type InboundOpenInfo = ();
 
-    fn listen_protocol(&self) -> SubstreamProtocol<Self::InboundProtocol> {
+    fn listen_protocol(&self) -> SubstreamProtocol<Self::InboundProtocol, Self::InboundOpenInfo> {
         self.listen_protocol.clone()
     }
 
     fn inject_fully_negotiated_inbound(
         &mut self,
         substream: <Self::InboundProtocol as InboundUpgrade<NegotiatedSubstream>>::Output,
+        _info: Self::InboundOpenInfo
     ) {
         // new inbound substream. Replace the current one, if it exists.
         trace!("New inbound substream request");
@@ -184,8 +186,7 @@ impl ProtocolsHandler for GossipsubHandler {
             self.send_queue.shrink_to_fit();
             self.outbound_substream_establishing = true;
             return Poll::Ready(ProtocolsHandlerEvent::OutboundSubstreamRequest {
-                protocol: self.listen_protocol.clone(),
-                info: message,
+                protocol: self.listen_protocol.clone().map_info(|()| message)
             });
         }
 

diff --git a/protocols/identify/CHANGELOG.md b/protocols/identify/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 0.22.0 [unreleased]
+
+- Update `libp2p-swarm`.
+
 # 0.21.0 [2020-08-18]
 
 - Bump `libp2p-core` and `libp2p-swarm` dependencies.

diff --git a/protocols/identify/Cargo.toml b/protocols/identify/Cargo.toml
@@ -2,7 +2,7 @@
 name = "libp2p-identify"
 edition = "2018"
 description = "Nodes identifcation protocol for libp2p"
-version = "0.21.0"
+version = "0.22.0"
 authors = ["Parity Technologies <[email protected]>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"
@@ -12,7 +12,7 @@ categories = ["network-programming", "asynchronous"]
 [dependencies]
 futures = "0.3.1"
 libp2p-core = { version = "0.21.0", path = "../../core" }
-libp2p-swarm = { version = "0.21.0", path = "../../swarm" }
+libp2p-swarm = { version = "0.22.0", path = "../../swarm" }
 log = "0.4.1"
 prost = "0.6.1"
 smallvec = "1.0"

diff --git a/protocols/identify/src/handler.rs b/protocols/identify/src/handler.rs
@@ -93,14 +93,16 @@ impl ProtocolsHandler for IdentifyHandler {
     type InboundProtocol = IdentifyProtocolConfig;
     type OutboundProtocol = IdentifyProtocolConfig;
     type OutboundOpenInfo = ();
+    type InboundOpenInfo = ();
 
-    fn listen_protocol(&self) -> SubstreamProtocol<Self::InboundProtocol> {
-        SubstreamProtocol::new(self.config.clone())
+    fn listen_protocol(&self) -> SubstreamProtocol<Self::InboundProtocol, Self::InboundOpenInfo> {
+        SubstreamProtocol::new(self.config.clone(), ())
     }
 
     fn inject_fully_negotiated_inbound(
         &mut self,
-        protocol: <Self::InboundProtocol as InboundUpgrade<NegotiatedSubstream>>::Output
+        protocol: <Self::InboundProtocol as InboundUpgrade<NegotiatedSubstream>>::Output,
+        _info: Self::InboundOpenInfo
     ) {
         self.events.push(IdentifyHandlerEvent::Identify(protocol))
     }
@@ -152,8 +154,7 @@ impl ProtocolsHandler for IdentifyHandler {
             Poll::Ready(Ok(())) => {
                 self.next_id.reset(DELAY_TO_NEXT_ID);
                 let ev = ProtocolsHandlerEvent::OutboundSubstreamRequest {
-                    protocol: SubstreamProtocol::new(self.config.clone()),
-                    info: (),
+                    protocol: SubstreamProtocol::new(self.config.clone(), ())
                 };
                 Poll::Ready(ev)
             }

diff --git a/protocols/kad/CHANGELOG.md b/protocols/kad/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 0.23.0 [unreleased]
+
+- Update `libp2p-swarm`.
+
 # 0.22.1 [2020-08-19]
 
 - Explicitly convert from u8 to usize in `BucketIndex::range` to prevent type

diff --git a/protocols/kad/Cargo.toml b/protocols/kad/Cargo.toml
@@ -2,7 +2,7 @@
 name = "libp2p-kad"
 edition = "2018"
 description = "Kademlia protocol for libp2p"
-version = "0.22.1"
+version = "0.23.0"
 authors = ["Parity Technologies <[email protected]>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"
@@ -18,7 +18,7 @@ futures_codec = "0.4"
 futures = "0.3.1"
 log = "0.4"
 libp2p-core = { version = "0.21.0", path = "../../core" }
-libp2p-swarm = { version = "0.21.0", path = "../../swarm" }
+libp2p-swarm = { version = "0.22.0", path = "../../swarm" }
 multihash = "0.11.0"
 prost = "0.6.1"
 rand = "0.7.2"

diff --git a/protocols/kad/src/handler.rs b/protocols/kad/src/handler.rs
@@ -261,7 +261,6 @@ impl error::Error for KademliaHandlerQueryErr {
 }
 
 impl From<ProtocolsHandlerUpgrErr<io::Error>> for KademliaHandlerQueryErr {
-    #[inline]
     fn from(err: ProtocolsHandlerUpgrErr<io::Error>) -> Self {
         KademliaHandlerQueryErr::Upgrade(err)
     }
@@ -409,13 +408,13 @@ where
     type OutboundProtocol = KademliaProtocolConfig;
     // Message of the request to send to the remote, and user data if we expect an answer.
     type OutboundOpenInfo = (KadRequestMsg, Option<TUserData>);
+    type InboundOpenInfo = ();
 
-    #[inline]
-    fn listen_protocol(&self) -> SubstreamProtocol<Self::InboundProtocol> {
+    fn listen_protocol(&self) -> SubstreamProtocol<Self::InboundProtocol, Self::InboundOpenInfo> {
         if self.config.allow_listening {
-            SubstreamProtocol::new(self.config.protocol_config.clone()).map_upgrade(upgrade::EitherUpgrade::A)
+            SubstreamProtocol::new(self.config.protocol_config.clone(), ()).map_upgrade(upgrade::EitherUpgrade::A)
         } else {
-            SubstreamProtocol::new(upgrade::EitherUpgrade::B(upgrade::DeniedUpgrade))
+            SubstreamProtocol::new(upgrade::EitherUpgrade::B(upgrade::DeniedUpgrade), ())
         }
     }
 
@@ -431,6 +430,7 @@ where
     fn inject_fully_negotiated_inbound(
         &mut self,
         protocol: <Self::InboundProtocol as InboundUpgrade<NegotiatedSubstream>>::Output,
+        (): Self::InboundOpenInfo
     ) {
         // If `self.allow_listening` is false, then we produced a `DeniedUpgrade` and `protocol`
         // is a `Void`.
@@ -591,7 +591,6 @@ where
         }
     }
 
-    #[inline]
     fn inject_dial_upgrade_error(
         &mut self,
         (_, user_data): Self::OutboundOpenInfo,
@@ -605,7 +604,6 @@ where
         }
     }
 
-    #[inline]
     fn connection_keep_alive(&self) -> KeepAlive {
         self.keep_alive
     }
@@ -696,8 +694,7 @@ fn advance_substream<TUserData>(
     match state {
         SubstreamState::OutPendingOpen(msg, user_data) => {
             let ev = ProtocolsHandlerEvent::OutboundSubstreamRequest {
-                protocol: SubstreamProtocol::new(upgrade),
-                info: (msg, user_data),
+                protocol: SubstreamProtocol::new(upgrade, (msg, user_data))
             };
             (None, Some(ev), false)
         }

diff --git a/protocols/mdns/CHANGELOG.md b/protocols/mdns/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 0.22.0 [unreleased]
+
+- Update `libp2p-swarm`.
+
 # 0.21.0 [2020-08-18]
 
 - Bump `libp2p-core` and `libp2p-swarm` dependencies.

diff --git a/protocols/mdns/Cargo.toml b/protocols/mdns/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "libp2p-mdns"
 edition = "2018"
-version = "0.21.0"
+version = "0.22.0"
 description = "Implementation of the libp2p mDNS discovery method"
 authors = ["Parity Technologies <[email protected]>"]
 license = "MIT"
@@ -17,7 +17,7 @@ either = "1.5.3"
 futures = "0.3.1"
 lazy_static = "1.2"
 libp2p-core = { version = "0.21.0", path = "../../core" }
-libp2p-swarm = { version = "0.21.0", path = "../../swarm" }
+libp2p-swarm = { version = "0.22.0", path = "../../swarm" }
 log = "0.4"
 net2 = "0.2"
 rand = "0.7"

diff --git a/protocols/ping/CHANGELOG.md b/protocols/ping/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 0.22.0 [unreleased]
+
+- Update `libp2p-swarm`.
+
 # 0.21.0 [2020-08-18]
 
 - Refactor the ping protocol for conformity by (re)using

diff --git a/protocols/ping/Cargo.toml b/protocols/ping/Cargo.toml
@@ -2,7 +2,7 @@
 name = "libp2p-ping"
 edition = "2018"
 description = "Ping protocol for libp2p"
-version = "0.21.0"
+version = "0.22.0"
 authors = ["Parity Technologies <[email protected]>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"
@@ -12,7 +12,7 @@ categories = ["network-programming", "asynchronous"]
 [dependencies]
 futures = "0.3.1"
 libp2p-core = { version = "0.21.0", path = "../../core" }
-libp2p-swarm = { version = "0.21.0", path = "../../swarm" }
+libp2p-swarm = { version = "0.22.0", path = "../../swarm" }
 log = "0.4.1"
 rand = "0.7.2"
 void = "1.0"

diff --git a/protocols/ping/src/handler.rs b/protocols/ping/src/handler.rs
@@ -207,12 +207,13 @@ impl ProtocolsHandler for PingHandler {
     type InboundProtocol = protocol::Ping;
     type OutboundProtocol = protocol::Ping;
     type OutboundOpenInfo = ();
+    type InboundOpenInfo = ();
 
-    fn listen_protocol(&self) -> SubstreamProtocol<protocol::Ping> {
-        SubstreamProtocol::new(protocol::Ping)
+    fn listen_protocol(&self) -> SubstreamProtocol<protocol::Ping, ()> {
+        SubstreamProtocol::new(protocol::Ping, ())
     }
 
-    fn inject_fully_negotiated_inbound(&mut self, stream: NegotiatedSubstream) {
+    fn inject_fully_negotiated_inbound(&mut self, stream: NegotiatedSubstream, (): ()) {
         self.inbound = Some(protocol::recv_ping(stream).boxed());
     }
 
@@ -329,11 +330,10 @@ impl ProtocolsHandler for PingHandler {
                 }
                 None => {
                     self.outbound = Some(PingState::OpenStream);
-                    let protocol = SubstreamProtocol::new(protocol::Ping)
+                    let protocol = SubstreamProtocol::new(protocol::Ping, ())
                         .with_timeout(self.config.timeout);
                     return Poll::Ready(ProtocolsHandlerEvent::OutboundSubstreamRequest {
-                        protocol,
-                        info: (),
+                        protocol
                     })
                 }
             }

diff --git a/protocols/request-response/CHANGELOG.md b/protocols/request-response/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 0.3.0 [unreleased]
+
+- Update `libp2p-swarm`.
+
 # 0.2.0 [2020-08-18]
 
 - Fixed connection keep-alive, permitting connections to close due