feat(relay): propagate errors to Transport::{listen_on,dial}
#4745
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thomaseizinger
commented
Oct 27, 2023
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This was referenced Oct 27, 2023
|
This pull request has merge conflicts. Could you please resolve them @thomaseizinger? 🙏 |
Co-authored-by: Max Inden <mail@max-inden.de>
mxinden
approved these changes
Oct 31, 2023
mergify bot
pushed a commit
that referenced
this pull request
Nov 2, 2023
This PR implements the long-awaited design of disallowing `ConnectionHandler`s to close entire connections. Instead, users should close connections via `ToSwarm::CloseConnection` from a `NetworkBehaviour` or - even better - from the `Swarm` via `close_connection`. A `NetworkBehaviour` also does not have a "full" view onto how a connection is used but at least it can correlate whether it created the connection via the `ConnectionId`. In general, the more modular and friendly approach is to stop "using" a connection if a particular protocol no longer needs it. As a result of the keep-alive algorithm, such a connection is then closed automatically. Depends-on: #4745. Depends-on: #4718. Depends-on: #4749. Related: #3353. Related: #4714. Resolves: #3591. Pull-Request: #4755.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
To make a reservation with a relay, a user calls
Swarm::listen_onwith an address of the relay, suffixed with a/p2pcircuitprotocol. Similarly, to establish a circuit to another peer, a user needs to callSwarm::dialwith such an address. Upon success, theSwarmthen issues aSwarmEvent::NewListenAddrevent in case of a successful reservation or aSwarmEvent::ConnectionEstablishedin case of a successful connect.The story is different for errors. Somewhat counterintuitively, the actual reason of an error during these operations are only reported as
relay::Events without a direct correlation to the user'sSwarm::listen_onorSwarm::dialcalls.With this PR, we send these errors back "into" the
Transportand report them asSwarmEvent::ListenerClosedorSwarmEvent::OutgoingConnectionError. This is conceptually more correct. Additionally, by sending these errors back to the transport, we no longer useConnectionHandlerEvent::Closewhich entirely closes the underlying relay connection. In case the connection is not used for something else, it will be closed by the keep-alive algorithm.Resolves: #4717.
Related: #3591.
Related: #4718.
Notes & open questions
Change checklist