feat(iroh): move iroh-net-report back into iroh (#3251)

## 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
<!-- Remove any that are not relevant. -->
- [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.
- [x] Tests if relevant.
- [x] All breaking changes documented.

---------

Co-authored-by: “ramfox” <“[email protected]”>

Author: ramfox

.github/workflows/ci.yml

@@ -180,9 +180,6 @@ jobs:
       - name: wasm32 build (iroh-relay)
         run: cargo build --target wasm32-unknown-unknown -p iroh-relay --no-default-features
 
-      - name: wasm32 build (iroh-net-report)
-        run: cargo build --target wasm32-unknown-unknown -p iroh-net-report --no-default-features
-
       - name: wasm32 build (iroh)
         run: cargo build --target wasm32-unknown-unknown -p iroh --no-default-features
 
@@ -192,10 +189,6 @@ jobs:
         run: |
           ! wasm-tools print --skeleton target/wasm32-unknown-unknown/debug/iroh_relay.wasm | grep 'import "env"'
 
-      - name: Ensure no 'import "env"' in iroh-net-report Wasm
-        run: |
-          ! wasm-tools print --skeleton target/wasm32-unknown-unknown/debug/iroh_net_report.wasm | grep 'import "env"'
-
       - name: Ensure no 'import "env"' in iroh Wasm
         run: |
           ! wasm-tools print --skeleton target/wasm32-unknown-unknown/debug/iroh.wasm | grep 'import "env"'

.github/workflows/tests.yaml

@@ -23,7 +23,7 @@ env:
   RUSTFLAGS: -Dwarnings
   RUSTDOCFLAGS: -Dwarnings
   SCCACHE_CACHE_SIZE: "10G"
-  CRATES_LIST: "iroh,iroh-bench,iroh-dns-server,iroh-relay,iroh-net-report"
+  CRATES_LIST: "iroh,iroh-bench,iroh-dns-server,iroh-relay"
   IROH_FORCE_STAGING_RELAYS: "1"
 
 jobs:

Cargo.lock

@@ -5,7 +5,6 @@ members = [
   "iroh",
   "iroh/bench",
   "iroh-relay",
-  "iroh-net-report",
 ]
 resolver = "2"
 

Cargo.toml

@@ -56,6 +56,7 @@ rand = "0.8"
 rcgen = "0.13"
 reqwest = { version = "0.12", default-features = false, features = [
     "rustls-tls",
+    "stream",
 ] }
 ring = "0.17"
 rustls = { version = "0.23", default-features = false, features = ["ring"] }
@@ -78,7 +79,6 @@ webpki = { package = "rustls-webpki", version = "0.102" }
 webpki-roots = "0.26"
 x509-parser = "0.16"
 z32 = "1.0.3"
-net-report = { package = "iroh-net-report", path = "../iroh-net-report", version = "0.34", default-features = false }
 
 # metrics
 iroh-metrics = { version = "0.32", default-features = false }
@@ -116,6 +116,7 @@ tokio = { version = "1", features = [
     "signal",
     "process",
 ] }
+surge-ping = "0.8.0"
 
 # wasm-in-browser dependencies
 [target.'cfg(all(target_family = "wasm", target_os = "unknown"))'.dependencies]
@@ -160,7 +161,7 @@ cfg_aliases = { version = "0.2" }
 
 [features]
 default = ["metrics"]
-metrics = ["iroh-metrics/metrics", "iroh-relay/metrics", "net-report/metrics", "portmapper/metrics"]
+metrics = ["iroh-metrics/metrics", "iroh-relay/metrics", "portmapper/metrics"]
 test-utils = ["iroh-relay/test-utils", "iroh-relay/server", "dep:axum"]
 discovery-local-network = ["dep:swarm-discovery"]
 discovery-pkarr-dht = ["pkarr/dht"]

iroh-net-report/Cargo.toml

@@ -249,6 +249,7 @@ pub mod discovery;
 pub mod dns;
 pub mod endpoint;
 pub mod metrics;
+pub mod net_report;
 pub mod protocol;
 pub mod watchable;
 

iroh-net-report/LICENSE-BSD3

@@ -42,9 +42,6 @@ use n0_future::{
     time::{self, Duration, Instant},
     FutureExt, StreamExt,
 };
-use net_report::IpMappedAddresses;
-#[cfg(not(wasm_browser))]
-use net_report::{IpMappedAddr, QuicConfig};
 use netwatch::{interfaces, netmon};
 #[cfg(not(wasm_browser))]
 use netwatch::{ip::LocalAddresses, UdpSocket};
@@ -71,11 +68,14 @@ use self::{
 use crate::dns::DnsResolver;
 #[cfg(any(test, feature = "test-utils"))]
 use crate::endpoint::PathSelection;
+#[cfg(not(wasm_browser))]
+use crate::net_report::{IpMappedAddr, QuicConfig};
 use crate::{
     defaults::timeouts::NET_REPORT_TIMEOUT,
     disco::{self, CallMeMaybe, SendAddr},
     discovery::{Discovery, DiscoveryItem, DiscoverySubscribers, NodeData, UserData},
     key::{public_ed_box, secret_ed_box, DecryptionError, SharedSecret},
+    net_report::{self, IpMappedAddresses},
     watchable::{Watchable, Watcher},
 };
 

iroh-net-report/README.md

@@ -1,8 +1,7 @@
 //! Co-locating all of the iroh metrics structs
 #[cfg(feature = "test-utils")]
 pub use iroh_relay::server::Metrics as RelayMetrics;
-pub use net_report::Metrics as NetReportMetrics;
 #[cfg(not(wasm_browser))]
 pub use portmapper::Metrics as PortmapMetrics;
 
-pub use crate::magicsock::Metrics as MagicsockMetrics;
+pub use crate::{magicsock::Metrics as MagicsockMetrics, net_report::Metrics as NetReportMetrics};