6 Commits
Author SHA1 Message Date
swaits 58f50d0395 chore: repoint URLs at git.swaits.com and bump for release
CI / check (macos-latest, 1.93.0) (push) Canceled after 0s
CI / check (macos-latest, stable) (push) Canceled after 0s
CI / check (ubuntu-latest, 1.93.0) (push) Canceled after 0s
CI / check (ubuntu-latest, stable) (push) Canceled after 0s
CI / check (windows-latest, 1.93.0) (push) Canceled after 0s
CI / check (windows-latest, stable) (push) Canceled after 0s
CI / cargo deny (push) Canceled after 0s
CI / cargo audit (push) Canceled after 0s
CI / cargo semver-checks (push) Canceled after 0s
CI / coverage (push) Canceled after 0s
CI / examples build (push) Canceled after 0s
CI / stateright BFS N=3 K=2 (push) Canceled after 0s
Rewrites remaining github.com / git.sr.ht references to git.swaits.com,
translating GitHub URL shapes to Gitea's (/blob/<ref>/ -> /src/branch/<ref>/,
/tree/<tag> -> /src/tag/<tag>, /actions/workflows/X -> /actions?workflow=X,
/edit/ -> /_edit/).

Left pointing at GitHub on purpose: pull-request links (PRs were not migrated)
and GitHub-only surfaces Gitea lacks (security advisories, discussions).
2026-08-31 17:58:33 -06:00
swaits c6436c653d chore: point repository at git.swaits.com
CI / check (macos-latest, 1.93.0) (push) Canceled after 0s
CI / check (macos-latest, stable) (push) Canceled after 0s
CI / check (ubuntu-latest, 1.93.0) (push) Canceled after 0s
CI / check (ubuntu-latest, stable) (push) Canceled after 0s
CI / check (windows-latest, 1.93.0) (push) Canceled after 0s
CI / check (windows-latest, stable) (push) Canceled after 0s
CI / cargo deny (push) Canceled after 0s
CI / cargo audit (push) Canceled after 0s
CI / cargo semver-checks (push) Canceled after 0s
CI / coverage (push) Canceled after 0s
CI / examples build (push) Canceled after 0s
CI / stateright BFS N=3 K=2 (push) Canceled after 0s
2026-08-31 17:19:17 -06:00
swaits 871c688b17 style: rustfmt the new builder setter test
CI / check (macos-latest, 1.93.0) (push) Canceled after 0s
CI / check (macos-latest, stable) (push) Canceled after 0s
CI / check (ubuntu-latest, 1.93.0) (push) Canceled after 0s
CI / check (ubuntu-latest, stable) (push) Canceled after 0s
CI / check (windows-latest, 1.93.0) (push) Canceled after 0s
CI / check (windows-latest, stable) (push) Canceled after 0s
CI / cargo deny (push) Canceled after 0s
CI / cargo audit (push) Canceled after 0s
CI / cargo semver-checks (push) Canceled after 0s
CI / coverage (push) Canceled after 0s
CI / examples build (push) Canceled after 0s
CI / stateright BFS N=3 K=2 (push) Canceled after 0s
2026-05-13 10:32:57 -06:00
swaits 312d958a91 ci: close the two missed cargo-mutants in src/builder.rs
Shard 0 of the nightly mutation run reported two MISSED mutants:

  src/builder.rs:178  Builder::failure_retry_period -> Self
  src/builder.rs:210  Builder::dht_backend          -> Self

Both replaced the setter body with `Default::default()`, wiping the
receiver's accumulated state. The existing #[cfg(test)] mod tests has
one of these `<setter>_setter_stores_exact_value` pinning tests for
nearly every other Builder method, but these two were missing:

  - failure_retry_period: no test exercised the setter at all.
  - dht_backend: the method and its callers (build_wait_none_does_not_block
    et al.) are gated `#[cfg(feature = "test-support")]`, but
    cargo-mutants ran with default features only, so neither the method
    nor its tests were ever compiled — the mutation survived trivially.

Fixes:
  - Add `failure_retry_period_setter_stores_exact_value` matching the
    pattern of the other setter tests.
  - Add `dht_backend_setter_stores_value` (gated on `test-support`).
  - Set `additional_cargo_args = ["--features", "test-support"]` in
    .cargo/mutants.toml so cfg-gated setters are part of the mutation
    surface.

Verified locally: `cargo mutants --file src/builder.rs` → 17 mutants,
16 caught, 1 unviable, 0 missed.
2026-05-13 10:27:34 -06:00
swaits 2c28dd77b4 ci: fix nightly workflow (4 longstanding failures)
The nightly workflow has failed every run since it was added. Fix the
four distinct issues so it can actually exercise the slow checks:

- cargo-mutants: drop bogus `--in-diff-base ""` flag (never existed in
  cargo-mutants; v27 rejects it).
- fuzz smoke: pin `--target x86_64-unknown-linux-gnu`. Binstall ships a
  musl-static cargo-fuzz binary whose default target inherits its own
  triple, and libfuzzer's sanitizer is incompatible with `crt-static`.
- miri: move multi-module filters after `--`. `cargo test` only accepts
  one TESTNAME positional; libtest accepts multiple substring filters.
- stateright random_large: add `target_state_count(1_000_000)` so the
  simulation actually terminates instead of looping past the 30 min CI
  timeout. The comment already claimed "up to 10⁶ states".

Also refreshes fuzz/Cargo.lock, regenerated by the local verification
build (was stale vs. parent deps).
2026-05-13 09:52:52 -06:00
swaits 2f40c81c3a release 0.2.1: fast recovery from PublishFailing 2026-05-11 16:17:47 -06:00
13 changed files with 847 additions and 469 deletions

No files matched your search

+6
View File
@@ -7,6 +7,12 @@ test_tool = "nextest"
# Async tests + crypto work takes longer under mutation load.
timeout_multiplier = 3.0
# Enable `test-support` so cfg-gated setters (e.g. Builder::dht_backend) and
# the integration tests that exercise them are part of the mutation surface.
# Without this, dht_backend mutations always "survive" trivially because the
# method isn't compiled in.
additional_cargo_args = ["--features", "test-support"]
# Skip paths that either can't be meaningfully mutated or are covered by
# other tools:
# - sim_impl.rs: simulator is exercised via the simulator example, not
+11 -5
View File
@@ -25,9 +25,11 @@ jobs:
- name: miri on keys/wire/crypto/merge
env:
MIRIFLAGS: -Zmiri-disable-isolation
# Quoted because YAML plain scalars can't contain `: ` sequences
# without being misparsed as mapping entries.
run: "cargo +nightly miri test --lib keys:: wire:: crypto:: merge::"
# `cargo test` takes a single TESTNAME positional, so multi-module
# filters must be passed to the test binary after `--`. Quoted because
# YAML plain scalars can't contain `: ` sequences without being
# misparsed as mapping entries.
run: "cargo +nightly miri test --lib -- keys:: wire:: crypto:: merge::"
mutants:
name: cargo-mutants
@@ -43,7 +45,7 @@ jobs:
- uses: taiki-e/install-action@v2
with:
tool: cargo-mutants,cargo-nextest
- run: cargo mutants --shard ${{ matrix.shard }}/4 --in-diff-base ""
- run: cargo mutants --shard ${{ matrix.shard }}/4
fuzz-smoke:
name: fuzz smoke (60s / target)
@@ -63,7 +65,11 @@ jobs:
- uses: taiki-e/install-action@v2
with:
tool: cargo-fuzz
- run: cd fuzz && cargo +nightly fuzz run ${{ matrix.target }} -- -max_total_time=60
# `--target` is explicit because the binstall'd `cargo-fuzz` binary is a
# statically-linked musl build, and `cargo fuzz`'s default target is the
# triple it was compiled for. The libfuzzer sanitizer is incompatible
# with the static-crt musl target, so force the glibc triple.
- run: cd fuzz && cargo +nightly fuzz run --target x86_64-unknown-linux-gnu ${{ matrix.target }} -- -max_total_time=60
kani:
name: kani
+31 -3
View File
@@ -6,6 +6,34 @@ format is based on [Keep a Changelog], and this project adheres to
## [Unreleased]
## [0.2.1] — 2026-05-11
### Changed
- **Fast recovery from `DhtStatus::PublishFailing`.** The write loop
previously slept the full `write_period` (default 5 min) between
every iteration and still applied the `1/(n+1)` probability gate,
so a node stuck in `PublishFailing` could wait many minutes — even
half an hour with a populated active view — before retrying. The
loop now checks `dht_status` before sleeping: while failing, it
uses the new `failure_retry_period` (default 15 s) and bypasses
the gate, so every tick attempts a write until one succeeds. On
success the steady-state cadence and gate are restored.
### Added
- `Builder::failure_retry_period(Duration)` — override the recovery
cadence (additive, non-breaking). Public constant
`DEFAULT_FAILURE_RETRY_PERIOD = 15 s`.
### Rationale
The probability gate exists to keep N healthy publishers from
storming the DHT with redundant writes — but once *our* publish has
failed, redundancy is irrelevant; we need to land *one* successful
write. Skipping the gate while failing turns the recovery time into
a function of `failure_retry_period`, not of `(n + 1) × write_period`.
## [0.2.0] — 2026-05-11
### Changed
@@ -107,6 +135,6 @@ peer addresses required.
[Keep a Changelog]: https://keepachangelog.com/en/1.1.0/
[Semantic Versioning]: https://semver.org/spec/v2.0.0.html
[protocol]: https://github.com/swaits/iroh-gossip-rendezvous/blob/main/PROTOCOL.md
[Unreleased]: https://github.com/swaits/iroh-gossip-rendezvous/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/swaits/iroh-gossip-rendezvous/releases/tag/v0.1.0
[protocol]: https://git.swaits.com/swaits/iroh-gossip-rendezvous/src/branch/main/PROTOCOL.md
[Unreleased]: https://git.swaits.com/swaits/iroh-gossip-rendezvous/compare/v0.1.0...main
[0.1.0]: https://git.swaits.com/swaits/iroh-gossip-rendezvous/releases/tag/v0.1.0
+1 -1
View File
@@ -6,7 +6,7 @@ Bug reports, feature requests, and pull requests welcome.
```sh
# Clone the repo.
git clone https://github.com/swaits/iroh-gossip-rendezvous
git clone https://git.swaits.com/swaits/iroh-gossip-rendezvous
cd iroh-gossip-rendezvous
# Install the dev toolchain. Most tools are lightweight; Kani is the
Generated
+1 -1
View File
@@ -1963,7 +1963,7 @@ dependencies = [
[[package]]
name = "iroh-gossip-rendezvous"
version = "0.2.0"
version = "0.2.1"
dependencies = [
"anyhow",
"arbitrary",
+3 -3
View File
@@ -1,13 +1,13 @@
[package]
name = "iroh-gossip-rendezvous"
version = "0.2.0"
version = "0.2.2"
edition = "2024"
rust-version = "1.93.0"
authors = ["Stephen Waits <steve@waits.net>"]
license = "MIT"
description = "Passphrase-based rendezvous for iroh-gossip swarms via Mainline DHT"
repository = "https://github.com/swaits/iroh-gossip-rendezvous"
homepage = "https://github.com/swaits/iroh-gossip-rendezvous"
repository = "https://git.swaits.com/swaits/iroh-gossip-rendezvous"
homepage = "https://git.swaits.com/swaits/iroh-gossip-rendezvous"
keywords = ["iroh", "gossip", "dht", "mainline", "rendezvous"]
categories = ["network-programming"]
readme = "README.md"
+1 -1
View File
@@ -8,7 +8,7 @@
> modelled in `tests/stateright_model.rs` for bounded safety + liveness
> checks.
>
> Authoritative copy: <https://github.com/swaits/iroh-gossip-rendezvous/blob/main/PROTOCOL.md>.
> Authoritative copy: <https://git.swaits.com/swaits/iroh-gossip-rendezvous/src/branch/main/PROTOCOL.md>.
>
> [`iroh-gossip-rendezvous`]: https://docs.rs/iroh-gossip-rendezvous
+1 -1
View File
@@ -2,7 +2,7 @@
[![crates.io](https://img.shields.io/crates/v/iroh-gossip-rendezvous.svg)](https://crates.io/crates/iroh-gossip-rendezvous)
[![docs.rs](https://img.shields.io/docsrs/iroh-gossip-rendezvous)](https://docs.rs/iroh-gossip-rendezvous)
[![CI](https://github.com/swaits/iroh-gossip-rendezvous/workflows/CI/badge.svg)](https://github.com/swaits/iroh-gossip-rendezvous/actions)
[![CI](https://git.swaits.com/swaits/iroh-gossip-rendezvous/actions/workflows/ci.yml/badge.svg)](https://git.swaits.com/swaits/iroh-gossip-rendezvous/actions)
[![MSRV](https://img.shields.io/badge/MSRV-1.93.0-blue)](#msrv)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+604 -444
View File
File diff suppressed because it is too large. Load diff
+48
View File
@@ -33,6 +33,12 @@ pub const DEFAULT_EPOCH_WRITES: u64 = 64;
pub const DEFAULT_WRITE_PERIOD: Duration = Duration::from_secs(300);
/// T_h — mean heal-loop period.
pub const DEFAULT_HEAL_PERIOD: Duration = Duration::from_secs(30);
/// T_f — write-loop period while `DhtStatus::PublishFailing`. Used in
/// place of `T_w` until a publish succeeds; the probability gate is also
/// skipped during recovery so every tick attempts a write. Bounds the
/// recovery latency from a transient DHT failure to roughly this period
/// (± jitter) regardless of neighbor count.
pub const DEFAULT_FAILURE_RETRY_PERIOD: Duration = Duration::from_secs(15);
/// σ — jitter factor (± fraction of the period).
pub const DEFAULT_JITTER: f32 = 0.5;
@@ -49,6 +55,7 @@ pub struct Builder {
epoch_size: u64,
write_period: Duration,
heal_period: Duration,
failure_retry_period: Duration,
jitter: f32,
wait_for_first_neighbor: Option<Duration>,
/// Test-only: inject a custom DhtSlots backend (e.g., InMemoryDht).
@@ -71,6 +78,7 @@ impl Default for Builder {
epoch_size: DEFAULT_EPOCH_WRITES,
write_period: DEFAULT_WRITE_PERIOD,
heal_period: DEFAULT_HEAL_PERIOD,
failure_retry_period: DEFAULT_FAILURE_RETRY_PERIOD,
jitter: DEFAULT_JITTER,
wait_for_first_neighbor: None,
#[cfg(feature = "test-support")]
@@ -156,6 +164,21 @@ impl Builder {
self
}
/// Override `T_f` — the write-loop period used while
/// [`DhtStatus::PublishFailing`](crate::state::DhtStatus::PublishFailing).
/// Default 15 seconds.
///
/// While failing, the probability gate `1/(n+1)` is bypassed and a
/// write is attempted every tick. Returning to
/// [`DhtStatus::Ready`](crate::state::DhtStatus::Ready) on a
/// successful publish restores the steady-state `write_period`
/// cadence and re-engages the gate.
#[must_use]
pub fn failure_retry_period(mut self, period: Duration) -> Self {
self.failure_retry_period = period;
self
}
/// Override `σ`. Default 0.5 (± 50%).
#[must_use]
pub fn jitter(mut self, sigma: f32) -> Self {
@@ -257,6 +280,7 @@ impl Builder {
epoch_size: self.epoch_size,
write_period: self.write_period,
heal_period: self.heal_period,
failure_retry_period: self.failure_retry_period,
jitter: self.jitter,
};
@@ -446,6 +470,30 @@ mod tests {
assert_eq!(Builder::default().heal_period(d).heal_period, d);
}
#[test]
fn failure_retry_period_setter_stores_exact_value() {
let d = Duration::from_millis(42);
assert_eq!(
Builder::default()
.failure_retry_period(d)
.failure_retry_period,
d
);
}
#[test]
#[cfg(feature = "test-support")]
fn dht_backend_setter_stores_value() {
use std::sync::Arc;
use crate::sim::InMemoryDht;
let dht = Arc::new(InMemoryDht::new());
let before = Builder::default();
let after = Builder::default().dht_backend(dht);
assert!(before.dht_backend.is_none());
assert!(after.dht_backend.is_some());
}
#[test]
fn jitter_setter_stores_exact_value() {
let b = Builder::default().jitter(0.25);
+1 -1
View File
@@ -74,7 +74,7 @@ pub use state::{DhtStatus, RendezvousState};
/// here so callers (and the `tests/spec_drift.rs` consistency check) can
/// reference them without poking at private modules.
///
/// [`PROTOCOL.md`]: https://github.com/swaits/iroh-gossip-rendezvous/blob/main/PROTOCOL.md
/// [`PROTOCOL.md`]: https://git.swaits.com/swaits/iroh-gossip-rendezvous/src/branch/main/PROTOCOL.md
pub mod defaults {
pub use crate::builder::{
DEFAULT_EPOCH_WRITES, DEFAULT_HEAL_PERIOD, DEFAULT_JITTER, DEFAULT_MAX_AGE,
+138 -9
View File
@@ -48,6 +48,12 @@ pub(crate) struct ProtocolConfig {
pub epoch_size: u64,
pub write_period: Duration,
pub heal_period: Duration,
/// Sleep between write-loop ticks while `dht_status == PublishFailing`.
/// Used in place of `write_period` to recover from a failed publish
/// faster than the steady-state cadence allows. The probability gate
/// is also skipped while failing — every tick attempts a write until
/// one succeeds.
pub failure_retry_period: Duration,
pub jitter: f32,
}
@@ -376,19 +382,39 @@ pub(crate) fn spawn_loops(
first_iter = false;
true
} else {
let sleep = jittered(state.config.write_period, state.config.jitter);
// While the last publish is failing, retry on the
// shorter `failure_retry_period` cadence and bypass
// the `1/(n+1)` probability gate — the gate exists
// to avoid swarm-wide write storms when N is large
// and the DHT is healthy, but once *our* publish
// has failed we should retry unconditionally until
// it succeeds.
let failing = matches!(
state.observable.lock().map(|s| s.dht_status),
Ok(DhtStatus::PublishFailing)
);
let period = if failing {
state.config.failure_retry_period
} else {
state.config.write_period
};
let sleep = jittered(period, state.config.jitter);
tokio::select! {
() = tokio::time::sleep(sleep) => {}
() = cancel.cancelled() => break,
}
// Write with probability 1/(n+1). Scope the (non-Send)
// ThreadRng so it doesn't live across the await.
let n = gossip.neighbors().len();
let r = {
let mut rng = rand::rng();
rng.random::<f32>()
};
should_fire_write(r, n)
if failing {
true
} else {
// Scope the (non-Send) ThreadRng so it doesn't
// live across the await.
let n = gossip.neighbors().len();
let r = {
let mut rng = rand::rng();
rng.random::<f32>()
};
should_fire_write(r, n)
}
};
if should_write {
write_once(&state, dht.as_ref(), gossip.as_ref()).await;
@@ -472,6 +498,61 @@ mod tests {
}
}
/// Fault-injecting `DhtSlots`. Fails the first `fail_writes` write calls
/// (counting attempts, not slots), then delegates to an inner
/// [`InMemoryDht`]. Reads always delegate.
struct FaultyDht {
inner: InMemoryDht,
remaining_failures: Mutex<usize>,
write_attempts: Arc<std::sync::atomic::AtomicUsize>,
}
impl FaultyDht {
fn new(fail_writes: usize) -> (Self, Arc<std::sync::atomic::AtomicUsize>) {
let attempts = Arc::new(std::sync::atomic::AtomicUsize::new(0));
(
Self {
inner: InMemoryDht::new(),
remaining_failures: Mutex::new(fail_writes),
write_attempts: attempts.clone(),
},
attempts,
)
}
}
#[async_trait]
impl DhtSlots for FaultyDht {
async fn read(
&self,
slot: crate::dht::SlotKey,
) -> Result<Option<crate::dht::SlotRecord>, crate::dht::DhtError> {
self.inner.read(slot).await
}
async fn write(
&self,
slot: crate::dht::SlotKey,
record: crate::dht::SlotRecord,
) -> Result<(), crate::dht::DhtError> {
self.write_attempts
.fetch_add(1, std::sync::atomic::Ordering::SeqCst);
let should_fail = {
let mut r = self.remaining_failures.lock().unwrap();
if *r > 0 {
*r -= 1;
true
} else {
false
}
};
if should_fail {
return Err(crate::dht::DhtError::Transport("injected".into()));
}
self.inner.write(slot, record).await
}
}
fn test_config(self_id: [u8; 32], shards: usize) -> ProtocolConfig {
ProtocolConfig {
self_id,
@@ -482,6 +563,7 @@ mod tests {
epoch_size: 64,
write_period: Duration::from_secs(1),
heal_period: Duration::from_secs(1),
failure_retry_period: Duration::from_millis(50),
jitter: 0.5,
}
}
@@ -567,6 +649,53 @@ mod tests {
}
}
#[tokio::test]
async fn write_loop_recovers_from_publish_failing_on_short_period() {
// Loop should retry on `failure_retry_period` (not `write_period`)
// and bypass the `1/(n+1)` gate while `DhtStatus::PublishFailing`.
// Setup: write_period=10s, failure_retry_period=30ms, dht fails
// first 3 writes then succeeds. Within a few hundred ms we should
// see ≥4 attempts (3 fails + 1 success) and status == Ready.
let self_id = [42u8; 32];
let mut config = test_config(self_id, 3);
config.write_period = Duration::from_secs(10);
config.heal_period = Duration::from_secs(10);
config.failure_retry_period = Duration::from_millis(30);
// No jitter so the test is deterministic.
config.jitter = 0.0;
let state = Arc::new(test_state(config));
let (faulty, attempts) = FaultyDht::new(3);
let dht: Arc<dyn DhtSlots> = Arc::new(faulty);
let (gossip_view, _joined) = MockGossip::new(vec![]);
let gossip: Arc<dyn GossipView> = Arc::new(gossip_view);
let cancel = CancellationToken::new();
let mut tasks = spawn_loops(state.clone(), dht.clone(), gossip.clone(), cancel.clone());
// 4 × 30ms = 120ms minimum. Give 500ms — comfortably above the
// retry budget, comfortably below `write_period`. If the loop
// were waiting on `write_period` (10s) we'd see only 1 attempt.
tokio::time::sleep(Duration::from_millis(500)).await;
let made = attempts.load(std::sync::atomic::Ordering::SeqCst);
let status = state.observable.lock().unwrap().dht_status;
cancel.cancel();
while tasks.join_next().await.is_some() {}
assert!(
made >= 4,
"expected ≥4 write attempts (3 fails + 1 success) within 500ms; got {made}"
);
assert_eq!(
status,
DhtStatus::Ready,
"status should flip to Ready after the 4th write succeeded"
);
}
#[tokio::test]
async fn seq_is_monotonic_across_writes() {
let self_id = [1u8; 32];
+1
View File
@@ -278,6 +278,7 @@ fn random_large() {
.checker()
.threads(num_cpus())
.target_max_depth(50)
.target_state_count(1_000_000)
.spawn_simulation(0, stateright::UniformChooser)
.join()
.assert_properties();