feat(reflect): multi-relay NAT type detection — Phase 2
Builds on Phase 1's SignalMessage::Reflect to probe N relays in
parallel through transient QUIC connections and classify the
client's NAT type for the future P2P hole-punching path. No wire
protocol changes — Phase 1's Reflect/ReflectResponse pair is
reused unchanged.
New client-side module (crates/wzp-client/src/reflect.rs):
- probe_reflect_addr(relay, timeout_ms): opens a throwaway
quinn::Endpoint (fresh ephemeral source port per probe,
essential for NAT-type detection — sharing one endpoint would
make a symmetric NAT look like a cone NAT), connects to _signal,
sends RegisterPresence with zero identity, consumes the Ack,
sends Reflect, awaits ReflectResponse, cleanly closes.
- detect_nat_type(relays, timeout_ms): parallel probes via
tokio::task::JoinSet (bounded by slowest probe not sum) and
returns a NatDetection with per-probe results + aggregate
classification.
- classify_nat(probes): pure-function classifier split out for
network-free unit tests. Rules:
* 0-1 successful probes → Unknown
* 2+ successes, same ip same port → Cone (P2P viable)
* 2+ successes, same ip diff ports → SymmetricPort (relay)
* 2+ successes, different ips → Multiple (treat as
symmetric)
Tauri command (desktop/src-tauri/src/lib.rs):
- detect_nat_type({ relays: [{ name, address }] }) -> NatDetection
as JSON. Takes the relay list from JS because localStorage
owns the config. Parse-up-front so a malformed entry fails
clean instead of as a probe error. 1500ms per-probe timeout.
UI (desktop/index.html + src/main.ts):
- New "NAT type" row + "Detect NAT" button in the Network
settings section. Renders per-probe status (name, address,
observed addr, latency, or error) plus the colored verdict:
* green Cone — shows consensus addr
* amber SymmetricPort / Multiple — must relay
* gray Unknown — not enough data
Tests:
- 7 unit tests in wzp-client/src/reflect.rs covering every
classifier branch (empty, 1 success, 2 identical, 2 diff ports,
2 diff ips, success+failure mix, pure-failure).
- 3 integration tests in crates/wzp-relay/tests/multi_reflect.rs:
* probe_reflect_addr_happy_path — single mock relay end-to-end
* detect_nat_type_two_loopback_relays_is_cone — two concurrent
relays, asserts both see 127.0.0.1 and classifier returns
Cone or SymmetricPort (accepted because the test harness
uses fresh ephemeral ports per probe which look like
SymmetricPort on single-host loopback)
* detect_nat_type_dead_relay_is_unknown — alive + dead port
mix, asserts the dead probe surfaces an error string and
the aggregator returns Unknown (only 1 success)
Full workspace test goes from 386 → 396 passing.
PRD: .taskmaster/docs/prd_multi_relay_reflect.txt
Tasks: 47-52 all completed
Next up: hole-punching (Phase 3) — use the reflected address in
DirectCallOffer/Answer and CallSetup so peers attempt a direct
QUIC handshake to each other, with relay fallback on timeout.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
228
crates/wzp-relay/tests/multi_reflect.rs
Normal file
228
crates/wzp-relay/tests/multi_reflect.rs
Normal file
@@ -0,0 +1,228 @@
|
||||
//! Phase 2 integration tests for multi-relay NAT reflection
|
||||
//! (PRD: .taskmaster/docs/prd_multi_relay_reflect.txt).
|
||||
//!
|
||||
//! These spin up one or two mock relays that implement the full
|
||||
//! pre-reflect dance — RegisterPresence → RegisterPresenceAck →
|
||||
//! Reflect → ReflectResponse — which is what the transient
|
||||
//! probe helper in `wzp_client::reflect::probe_reflect_addr` does
|
||||
//! against a real relay.
|
||||
//!
|
||||
//! Test matrix:
|
||||
//! 1. `probe_reflect_addr_happy_path`
|
||||
//! — single mock relay, assert the probe helper returns the
|
||||
//! observed addr as 127.0.0.1:<client ephemeral port>
|
||||
//! 2. `detect_nat_type_two_loopback_relays_is_cone`
|
||||
//! — two mock relays, one client; loopback single-host means
|
||||
//! every probe sees the same (127.0.0.1, same_port) so the
|
||||
//! classifier returns `Cone` + a consensus addr
|
||||
//! 3. `detect_nat_type_dead_relay_is_unknown`
|
||||
//! — one alive relay + one dead address; aggregator returns
|
||||
//! `Unknown` with a non-empty `error` field on the failed
|
||||
//! probe
|
||||
|
||||
use std::net::{Ipv4Addr, SocketAddr};
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
use wzp_client::reflect::{detect_nat_type, probe_reflect_addr, NatType};
|
||||
use wzp_proto::{MediaTransport, SignalMessage};
|
||||
use wzp_transport::{create_endpoint, server_config, QuinnTransport};
|
||||
|
||||
/// Minimal mock relay that loops accepting connections, handles
|
||||
/// RegisterPresence + Reflect, and responds correctly. Mirrors the
|
||||
/// two match arms from `wzp-relay/src/main.rs` that matter here.
|
||||
///
|
||||
/// Each accepted connection gets its own inner task so multiple
|
||||
/// simultaneous probes work.
|
||||
async fn spawn_mock_relay() -> (SocketAddr, tokio::task::JoinHandle<()>) {
|
||||
let _ = rustls::crypto::ring::default_provider().install_default();
|
||||
let (sc, _cert_der) = server_config();
|
||||
let bind: SocketAddr = (Ipv4Addr::LOCALHOST, 0).into();
|
||||
let endpoint = create_endpoint(bind, Some(sc)).expect("server endpoint");
|
||||
let listen_addr = endpoint.local_addr().expect("local_addr");
|
||||
|
||||
let handle = tokio::spawn(async move {
|
||||
loop {
|
||||
// Accept the next incoming connection. `wzp_transport::accept`
|
||||
// returns the established `quinn::Connection`.
|
||||
let conn = match wzp_transport::accept(&endpoint).await {
|
||||
Ok(c) => c,
|
||||
Err(_) => break, // endpoint closed
|
||||
};
|
||||
let observed_addr = conn.remote_address();
|
||||
let transport = Arc::new(QuinnTransport::new(conn));
|
||||
|
||||
// Per-connection handler. Keep servicing messages until
|
||||
// the peer closes so one probe connection can do
|
||||
// RegisterPresence → Ack → Reflect → Response without
|
||||
// racing other incoming connections.
|
||||
let t = transport;
|
||||
tokio::spawn(async move {
|
||||
loop {
|
||||
match t.recv_signal().await {
|
||||
Ok(Some(SignalMessage::RegisterPresence { .. })) => {
|
||||
let _ = t
|
||||
.send_signal(&SignalMessage::RegisterPresenceAck {
|
||||
success: true,
|
||||
error: None,
|
||||
})
|
||||
.await;
|
||||
}
|
||||
Ok(Some(SignalMessage::Reflect)) => {
|
||||
let _ = t
|
||||
.send_signal(&SignalMessage::ReflectResponse {
|
||||
observed_addr: observed_addr.to_string(),
|
||||
})
|
||||
.await;
|
||||
}
|
||||
Ok(Some(_other)) => { /* ignore */ }
|
||||
Ok(None) => break,
|
||||
Err(_) => break,
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
(listen_addr, handle)
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// Test 1: probe_reflect_addr against a single mock relay
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn probe_reflect_addr_happy_path() {
|
||||
let (relay_addr, _relay_handle) = spawn_mock_relay().await;
|
||||
|
||||
let (observed, latency_ms) = tokio::time::timeout(
|
||||
Duration::from_secs(3),
|
||||
probe_reflect_addr(relay_addr, 2000),
|
||||
)
|
||||
.await
|
||||
.expect("probe must complete within 3s")
|
||||
.expect("probe must succeed");
|
||||
|
||||
assert_eq!(
|
||||
observed.ip().to_string(),
|
||||
"127.0.0.1",
|
||||
"loopback test should see 127.0.0.1"
|
||||
);
|
||||
assert_ne!(observed.port(), 0, "observed port must be non-zero");
|
||||
// Latency on same host is dominated by the handshake — generously
|
||||
// allow up to 2s (the timeout) rather than picking a tight number
|
||||
// that would be flaky on busy CI runners.
|
||||
assert!(latency_ms < 2000, "latency {latency_ms}ms too high");
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// Test 2: two loopback relays → Cone classification
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
async fn detect_nat_type_two_loopback_relays_is_cone() {
|
||||
let (addr_a, _h_a) = spawn_mock_relay().await;
|
||||
let (addr_b, _h_b) = spawn_mock_relay().await;
|
||||
|
||||
let detection = detect_nat_type(
|
||||
vec![
|
||||
("RelayA".into(), addr_a),
|
||||
("RelayB".into(), addr_b),
|
||||
],
|
||||
2000,
|
||||
)
|
||||
.await;
|
||||
|
||||
assert_eq!(detection.probes.len(), 2);
|
||||
for p in &detection.probes {
|
||||
assert!(p.observed_addr.is_some(), "probe {:?} failed: {:?}", p.relay_name, p.error);
|
||||
}
|
||||
|
||||
// Loopback single-host: every probe sees 127.0.0.1 and, crucially,
|
||||
// uses a different ephemeral source port (since probe_reflect_addr
|
||||
// spins up a fresh quinn::Endpoint per probe). Wait — that makes
|
||||
// this look like Symmetric to the classifier, not Cone!
|
||||
//
|
||||
// The classifier cares about the *observed* addr, which is what
|
||||
// the relay sees as the client's source. Two different client
|
||||
// endpoints on loopback → two different observed ports → the
|
||||
// classifier correctly labels this as SymmetricPort in the test
|
||||
// environment. That's still a valid verification of the
|
||||
// plumbing, just not of the Cone classification.
|
||||
//
|
||||
// Accept either Cone OR SymmetricPort for this test, then
|
||||
// assert the more specific invariant that matters: both probes
|
||||
// returned the same observed IP.
|
||||
let observed_ips: Vec<String> = detection
|
||||
.probes
|
||||
.iter()
|
||||
.map(|p| {
|
||||
p.observed_addr
|
||||
.as_ref()
|
||||
.and_then(|s| s.parse::<SocketAddr>().ok())
|
||||
.map(|a| a.ip().to_string())
|
||||
.unwrap_or_default()
|
||||
})
|
||||
.collect();
|
||||
assert_eq!(observed_ips[0], "127.0.0.1");
|
||||
assert_eq!(observed_ips[1], "127.0.0.1");
|
||||
|
||||
// Either classification is valid on loopback (see long comment
|
||||
// above). Explicitly assert the set so a future refactor that
|
||||
// accidentally returns `Multiple` or `Unknown` fails the test.
|
||||
assert!(
|
||||
matches!(detection.nat_type, NatType::Cone | NatType::SymmetricPort),
|
||||
"expected Cone or SymmetricPort on loopback, got {:?}",
|
||||
detection.nat_type
|
||||
);
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
// Test 3: one alive relay + one dead address → Unknown
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
async fn detect_nat_type_dead_relay_is_unknown() {
|
||||
let (alive_addr, _alive_handle) = spawn_mock_relay().await;
|
||||
|
||||
// Dead relay: a port that nothing is listening on. OS will drop
|
||||
// the packets, the probe should time out within the 600ms budget
|
||||
// we give it. Pick a port unlikely to be in use — port 1 on
|
||||
// loopback works on every OS I care about and fails fast.
|
||||
let dead_addr: SocketAddr = "127.0.0.1:1".parse().unwrap();
|
||||
|
||||
let detection = detect_nat_type(
|
||||
vec![
|
||||
("Alive".into(), alive_addr),
|
||||
("Dead".into(), dead_addr),
|
||||
],
|
||||
600, // tight timeout so the dead probe fails fast
|
||||
)
|
||||
.await;
|
||||
|
||||
assert_eq!(detection.probes.len(), 2);
|
||||
|
||||
// Find the alive and dead probes by name (order of JoinSet
|
||||
// completions is not guaranteed).
|
||||
let alive = detection.probes.iter().find(|p| p.relay_name == "Alive").unwrap();
|
||||
let dead = detection.probes.iter().find(|p| p.relay_name == "Dead").unwrap();
|
||||
|
||||
assert!(
|
||||
alive.observed_addr.is_some(),
|
||||
"alive probe must succeed: {:?}",
|
||||
alive.error
|
||||
);
|
||||
assert!(
|
||||
dead.observed_addr.is_none(),
|
||||
"dead probe must fail, got addr {:?}",
|
||||
dead.observed_addr
|
||||
);
|
||||
assert!(
|
||||
dead.error.is_some(),
|
||||
"dead probe must surface an error string"
|
||||
);
|
||||
|
||||
// With only 1 successful probe, the classifier returns Unknown.
|
||||
assert_eq!(detection.nat_type, NatType::Unknown);
|
||||
assert!(detection.consensus_addr.is_none());
|
||||
}
|
||||
Reference in New Issue
Block a user