refactor(iroh-net): Keep connection name, remove connection count #2779
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
These are two cleanups in the relay client: - The `relay::Client` hands out a connection object when asked to connect. This `Conn` was imported with rename to `RelayClient` which was a bit confusing as this was already the relay client. It is now renamed to `RelayConn` which makes a lot more sense. The related builder struct etc are renamed to match. - The `relay::Client` had a counter for the number of connections made to the relay. That seems fun, but was entirely unused. If this is a useful thing to have it should probably be a counter metric instead but let's not add anything that no one is using. Removing this makes a lot of APIs a bit simpler and removes some state tracking.
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2779/docs/iroh/ Last updated: 2024-10-03T17:23:49Z |
2 tasks
divagant-martian
approved these changes
Oct 3, 2024
Your nitpicking is totally right, might as well try and do this more consistent because it does make it more readable. But yeah, I was moving on as I wanted to get to the actual bugfix I was aiming for at the end of this chain of PRs. PTAL |
divagant-martian
approved these changes
Oct 3, 2024
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 3, 2024
## Description The ActiveRelay actor keeps track of which remote nodes are present on the relay connection so that we can optimise relay connections to remote nodes. This does two main optimisations: - There were two sets of these nodes kept, they could easily be unified. - The set is best stored in a BTreeSet since they are simple NodeIds stored in them. - Bonus: rename peer to node to match our naming convention. - Bonus: identify nodes by NodeId since this is a routing key here. ## Breaking Changes Still none if all is well. ## Notes & open questions This targets #2779 as base. ## Change checklist - [x] Self-review. - [x] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. - ~~[ ] Tests if relevant.~~ - ~~[ ] All breaking changes documented.~~ --------- Co-authored-by: Divma <[email protected]>
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
These are two cleanups in the relay client:
The
relay::Clienthands out a connection object when asked toconnect. This
Connwas imported with rename toRelayClientwhich was a bit confusing as this was already the relay client. It
is now left at it's original name which makes a lot more sense. The
related builder struct etc are renamed to match.
The
relay::Clienthad a counter for the number of connections madeto the relay. That seems fun, but was entirely unused. If this is
a useful thing to have it should probably be a counter metric
instead but let's not add anything that no one is using. Removing
this makes a lot of APIs a bit simpler and removes some state
tracking.
Breaking Changes
None hopefully, please let this all be internal APIs.
Notes & open questions
Change checklist
[ ] All breaking changes documented.