refactor(iroh,iroh-net)!: prefer remote to connection in api
#2610
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
This migrates Endpoint::connection_info and Endpoint::connection_infos to Endpoint::node_info and Endpoint::node_info_iter. This returns information about nodes in the node map. This has not that much to do with connections. Calling this connections is rather misleading. It documents all types below it properly, deprecating some problematic fields and functions.
|
@dignifiedquire while this doesn't work yet could I get some feedback on using deprecations? Also on the rename itself from |
|
given we haven't used deprecations for the last rounds of api changes, I don't think they are necessary currently |
flub
changed the title
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2610/docs/iroh/ Last updated: 2024-08-17T17:46:11Z |
|
I think this is a great name change: the original name is from when this data was ephemeral. I agree, it makes no sense now. |
ramfox
reviewed
Aug 14, 2024
ramfox
reviewed
Aug 14, 2024
ramfox
reviewed
Aug 14, 2024
ramfox
reviewed
Aug 14, 2024
dignifiedquire
approved these changes
Aug 17, 2024
divagant-martian
changed the title
divagant-martian
changed the title
remote to connection in api
divagant-martian
changed the title
remote to connection in apiremote to connection in api
ramfox
reviewed
Aug 17, 2024
ramfox
reviewed
Aug 17, 2024
ramfox
reviewed
Aug 17, 2024
ramfox
reviewed
Aug 17, 2024
ramfox
reviewed
Aug 17, 2024
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
Moves some functions and types to use
remoteto describe the information we know about a node,instead of connections. This, based on the fact that iroh-net does not itself handle connections,
making the wording misleading at best.
Breaking Changes
iroh
client::node::Client::connection_info->client::node::Client::remote_infoclient::node::Client::connections->client::node::Client::remote_infos_iteriroh-net
endpoint::ConnectionInfo->endpoint::RemoteInfoendpoint::ConnectionInfo::idis removed since it's internal information.endpoint::ConnectionInfo::last_alive_relayis deprecated. Use.relay_url.last_aliveendpoint::Endpoint::connection_info->endpoint::Endpoint::remote_infoendpoint::Endpoint::connection_infos->endpoint::Endpoint::remote_infos_iteriroh-cli (bin)
node connection-info->node remote-infonode connections->node remote-listNotes & open questions
a new
nettop level api. Doing so we should aim as well to move the cli to the more graciousremote <node-id>andremote list. In summary:iroh node remote <node-id>and we wantiroh net remote <remote-id>iroh node remote-listand we wantiroh net remote listIssue add top level
netapi #2639 is created for thisendpoint::ConnectionInfo::last_alive_relay#2640 is created for this.Change checklist
Tests if relevant.