refactor: add `iroh_net::ConnManager` and use in `iroh_gossip::net` #2315

Frando · 2024-05-21T13:22:42Z

Description

Introduce a ConnManager in iroh_net. Quoting the docs:

A connection manager that ensures that only a single connection between two peers prevails.
You can start to dial peers by calling [ConnManager::dial]. Note that the method only takes a
node id; if you have more addressing info, add it to the endpoint directly with
[Endpoint::add_node_addr] before calling dial;
The [ConnManager] does not accept connections from the endpoint by itself. Instead, you
should run an accept loop yourself, and push connections with a matching ALPN into the manager
with [ConnManager::handle_connection] or [ConnManager::handle_connection_sender].
The [ConnManager] is a [Stream] that yields all connections from both accepting and dialing.
Before accepting incoming connections, the [ConnManager] makes sure that, if we are dialing
the same node, only one of the connections will prevail. In this case, the accepting side
rejects the connection if the peer's node id sorts higher than their own node id.
To make this reliable even if the dials happen exactly at the same time, a single unidirectional
stream is opened, on which a single byte is sent. This additional rountrip ensures that no
double connections can prevail.

Use the ConnManager in iroh_gossip::net and improve connection handling

Breaking Changes

Notes & open questions

Change checklist

Self-review.
Documentation updates if relevant.
Tests if relevant.
All breaking changes documented.

link2xt · 2024-05-21T19:02:25Z

includes functionality to make sure that only a single connection prevails between ourselves and another peer

In plain TCP simultaneous connect from both sides results in a single connection if socket is bound to a port and the other side tries to connect to the same port: https://stackoverflow.com/questions/2231283/tcp-two-sides-trying-to-connect-simultaneously
I have looked a bit into QUIC RFC 9000, seems it cannot do anything similar because of connection IDs.

flub

I'm not yet sure about the ConnManager. I'd be more comfortable if we had some sort of "exprimental" cargo feature or something for it maybe.

flub · 2024-05-23T07:55:07Z

iroh-net/src/test_utils.rs

+impl TestEndpointBuilder {
+    /// Starts local relay and discovery servers and returns a builder to create readily configured endpoints.
+    ///
+    /// The local relay, DNS and pkarr servers will shut down once the [`TestEndpointBuilder`] is dropped.


Maybe also make clear these are listening on a random port on localhost only?

flub · 2024-05-23T07:56:07Z

iroh-net/src/test_utils.rs

+    }
+
+    /// Create a new endpoint builder which already has discovery and relays configured.
+    pub fn create_endpoint_builder(&self, secret_key: SecretKey) -> crate::endpoint::Builder {


Simply endpoint_builder() is probably a better name?

flub · 2024-05-23T08:07:33Z

iroh-net/src/conn_manager.rs

+    #[deref]
+    pub conn: Connection,
+    /// The node id of the other peer.
+    pub node_id: NodeId,


You can always get the NodeId from the Connection, so this is storing duplicate information.

flub · 2024-05-23T08:09:43Z

iroh-net/src/conn_manager.rs

+
+/// The error returned from [`ConnManager::poll_next`].
+#[derive(thiserror::Error, Debug)]
+#[error("Connection to node {} direction {:?} failed: {:?}", self.node_id, self.direction, self.reason)]


Should this use the short NodeId? This is done by using the alternate formatting: {:#}. I'm a bit in two minds about it.

flub · 2024-05-23T08:19:11Z

iroh-net/src/conn_manager.rs

+    /// This is a no-op if the a connection to the node is already active or if we are currently
+    /// dialing the node already.
+    ///
+    /// Returns `true` if this is initiates connecting to the node.


Suggested change

/// Returns `true` if this is initiates connecting to the node.

/// Returns `true` if this initiates a new connection attempt.

flub · 2024-05-23T09:18:57Z

iroh-net/src/conn_manager.rs

+    /// the [`ConnManager`]'s execpected ALPN before passing the connection to the sender.
+    ///
+    /// If we are currently dialing the node, the connection will be dropped if the peer's node id
+    /// sorty higher than our node id. Otherwise, the connection will be yielded from the manager


Suggested change

/// sorty higher than our node id. Otherwise, the connection will be yielded from the manager

/// sorts higher than our node id. Otherwise, the connection will be yielded from the manager

flub · 2024-05-23T11:46:33Z

Part of me feels this might belong better in the protocol running on top of the provided quic connection rather than in the endpoint layer itself. And to me iroh-net is about the endpoint layer, not the application on top.

I'm a little sceptical that an application does even need support like this. Could it not keep a map of confirmed connections, i.e. when it received data on a connection. Any time a connection receives data for the first time, whether that connection was dialed or accepted, it can check the map and reset the connection if the NodeId already exists. This is like a very opiniated and specific version of this.

Frando · 2024-05-23T12:06:05Z

Yes, I'm also not too sure anymore. I thought initially that this could be done without opening any streams, which would put it more into endpoint-layer land. Alas, an extra roundtrip, and thus opening streams, is required for consistent deduplication it seems. Which puts it more into application protocol land.

At the same time it is a quite common usecase for p2p protocols, and offering something easy-to-use would be nice. Sounds a bit like iroh-net-utils or so material.

link2xt · 2024-06-04T15:14:17Z

iroh-net/src/conn_manager.rs

+    /// Accept a connection.
+    ///
+    /// This does not check the connection's ALPN, so you should make sure that the ALPN matches
+    /// the [`ConnManager`]'s execpected ALPN before passing the connection to the sender.


Suggested change

/// the [`ConnManager`]'s execpected ALPN before passing the connection to the sender.

/// the [`ConnManager`]'s expected ALPN before passing the connection to the sender.

link2xt · 2024-06-04T15:14:34Z

iroh-net/src/conn_manager.rs

+    /// the [`ConnManager`]'s execpected ALPN before passing the connection to the sender.
+    ///
+    /// If we are currently dialing the node, the connection will be dropped if the peer's node id
+    /// sorty higher than our node id. Otherwise, the connection will be returned.


Suggested change

/// sorty higher than our node id. Otherwise, the connection will be returned.

/// sorts higher than our node id. Otherwise, the connection will be returned.

link2xt · 2024-06-04T15:19:29Z

iroh-net/src/conn_manager.rs

+/// rejects the connection if the peer's node id sorts higher than their own node id.
+///
+/// To make this reliable even if the dials happen exactly at the same time, a single unidirectional
+/// stream is opened, on which a single byte is sent. This additional rountrip ensures that no


Where exactly this sending of a byte happens? Did not find it quickly looking through the changes.

Here:

iroh/iroh-net/src/conn_manager.rs

Line 299 in bfee584

stream.write_all(&[0]).await?;

Frando changed the title ~~Gossip net improvements~~ refactor(iroh-gossip): improve connection handling in net module May 21, 2024

dignifiedquire added this to the v0.17.0 milestone May 22, 2024

Frando force-pushed the gossip-net-improvements branch from ad018a6 to 6229f8a Compare May 22, 2024 23:02

feat: add connection manager and use in iroh-gossip

c8265ee

Frando force-pushed the gossip-net-improvements branch from fda1736 to c8265ee Compare May 22, 2024 23:15

Frando changed the title ~~refactor(iroh-gossip): improve connection handling in net module~~ refactor: add iroh_net::ConnManager and use in iroh_gossip::net May 22, 2024

Frando force-pushed the gossip-net-improvements branch from d1c775a to 3b28b28 Compare May 22, 2024 23:27

improve docs

bd2a0c6

Frando force-pushed the gossip-net-improvements branch 2 times, most recently from 0fcb423 to 240eb7a Compare May 22, 2024 23:32

chore: clippy

f70e519

Frando force-pushed the gossip-net-improvements branch from 240eb7a to f70e519 Compare May 22, 2024 23:33

fixup

95fdddb

Frando force-pushed the gossip-net-improvements branch from c204d78 to 95fdddb Compare May 22, 2024 23:47

Frando marked this pull request as ready for review May 22, 2024 23:57

Frando added 2 commits May 23, 2024 02:08

improve naming

bac4c28

fixup

bfee584

flub reviewed May 23, 2024

View reviewed changes

dignifiedquire removed this from the v0.17.0 milestone May 24, 2024

link2xt reviewed Jun 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: add `iroh_net::ConnManager` and use in `iroh_gossip::net` #2315

refactor: add `iroh_net::ConnManager` and use in `iroh_gossip::net` #2315

Frando commented May 21, 2024 •

edited

link2xt commented May 21, 2024

flub left a comment

flub May 23, 2024

flub May 23, 2024

flub May 23, 2024

flub May 23, 2024

flub May 23, 2024

flub May 23, 2024

flub commented May 23, 2024

Frando commented May 23, 2024 •

edited

link2xt Jun 4, 2024

link2xt Jun 4, 2024

link2xt Jun 4, 2024

Frando Jun 4, 2024 •

edited

	/// Returns `true` if this is initiates connecting to the node.
	/// Returns `true` if this initiates a new connection attempt.

	/// sorty higher than our node id. Otherwise, the connection will be yielded from the manager
	/// sorts higher than our node id. Otherwise, the connection will be yielded from the manager

	/// the [`ConnManager`]'s execpected ALPN before passing the connection to the sender.
	/// the [`ConnManager`]'s expected ALPN before passing the connection to the sender.

refactor: add iroh_net::ConnManager and use in iroh_gossip::net #2315

Are you sure you want to change the base?

refactor: add iroh_net::ConnManager and use in iroh_gossip::net #2315

Conversation

Frando commented May 21, 2024 • edited

Description

Breaking Changes

Notes & open questions

Change checklist

link2xt commented May 21, 2024

flub left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

flub commented May 23, 2024

Frando commented May 23, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Frando Jun 4, 2024 • edited

Choose a reason for hiding this comment

refactor: add `iroh_net::ConnManager` and use in `iroh_gossip::net` #2315

refactor: add `iroh_net::ConnManager` and use in `iroh_gossip::net` #2315

Frando commented May 21, 2024 •

edited

Frando commented May 23, 2024 •

edited

Frando Jun 4, 2024 •

edited