-
Notifications
You must be signed in to change notification settings - Fork 236
feat(iroh): move iroh-net-report
back into iroh
#3251
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/3251/docs/iroh/ Last updated: 2025-04-03T23:16:45Z |
iroh-net-report
back into iroh
iroh-net-report
back into iroh
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is fine, but I'd like to not expose this as a public API. I can't remember if we discussed a mechanism before so that doctor can still use it, I think we did? I think it was by means of a cargo feature? But I'm not sure.
@@ -249,6 +249,7 @@ pub mod discovery; | |||
pub mod dns; | |||
pub mod endpoint; | |||
pub mod metrics; | |||
pub mod net_report; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It'd be nice to hide this behind a unstable_api
cargo feature (or whatever bikeshed colour you like)? Apparently @dignifiedquire had opinions on something like this in the past though, I don't know if favour or against such constructs. Or maybe keep it entirely internal, as the API for doctor will probably become something else now according to the discussion on discourse?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lets merge this as is, and get the API reduction surface before the next release in as well would be my suggestion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After our planning meeting, we decided I'm going to reduce the API surface to just what is necessary for doctor
and get this merged by Friday.
0ba6675
to
1551cdd
Compare
Description
Move
iroh-net-report
back intoiroh
Only the follow are made public from the old
iroh-net-report
(nowiroh::net_report
):iroh::net_report::Metrics
iroh::net_report::Options
iroh::net_report::Addr
iroh::net_report::Client
iroh::net_report::Report
iroh::net_report::bind_local_stun_addr
iroh::net_report::RelayLatencies
iroh::net_report::QuicConfig
Breaking Changes
Technically not a breaking change to
iroh
since we are "adding" to the API, but we will no longer be publishingiroh-net-report
to crates.io, and to use the content fromiroh-net-report
you would need to depend oniroh
and import it usingiroh::net_report
.This should only effect
iroh-doctor
Notes & open questions
Would be nice to make this private, if we can adjust
iroh-doctor
accordingly.For the next release, I'll make a branch that has the old
iroh-net-report
, adds the deprecation status to the readme/cargo.toml & publishes.Change checklist