Skip to content

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

Merged
merged 6 commits into from
Apr 4, 2025
Merged

Conversation

ramfox
Copy link
Contributor

@ramfox ramfox commented Mar 31, 2025

Description

Move iroh-net-report back into iroh

Only the follow are made public from the old iroh-net-report (now iroh::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 publishing iroh-net-report to crates.io, and to use the content from iroh-net-report you would need to depend on iroh and import it using iroh::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

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

Copy link

github-actions bot commented Mar 31, 2025

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

Copy link

github-actions bot commented Mar 31, 2025

Netsim report & logs for this PR have been generated and is available at: LOGS
This report will remain available for 3 days.

Last updated for commit: b96cc95

@ramfox ramfox changed the title feat(iroh)!: move iroh-net-report back into iroh feat(iroh): move iroh-net-report back into iroh Mar 31, 2025
@n0bot n0bot bot added this to iroh Mar 31, 2025
@github-project-automation github-project-automation bot moved this to 🏗 In progress in iroh Mar 31, 2025
@ramfox ramfox moved this from 🏗 In progress to 👀 In review in iroh Mar 31, 2025
@ramfox ramfox added this to the 0.35.0 milestone Mar 31, 2025
Copy link
Contributor

@flub flub left a 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;
Copy link
Contributor

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?

Copy link
Contributor

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

Copy link
Contributor Author

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.

@ramfox ramfox force-pushed the ramfox/net-report branch from 0ba6675 to 1551cdd Compare April 3, 2025 18:04
@ramfox ramfox marked this pull request as ready for review April 3, 2025 18:04
@ramfox ramfox added this pull request to the merge queue Apr 4, 2025
Merged via the queue into main with commit d6bc83f Apr 4, 2025
26 checks passed
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in iroh Apr 4, 2025
@ramfox ramfox deleted the ramfox/net-report branch May 14, 2025 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants