docs(quic-interop): add quinn to the default peer set

quinn is now treated as a flawless-required interop target alongside
aioquic, picoquic, and quic-go. Most Rust-based Nostr/MoQ relays our
users run their servers on are built on quinn, so an interop regression
there is a user-visible regression.

Validated by a 3-round flakiness sweep (1 full matrix + 2 audio-critical
subsets) — zero result flakiness across 528 test executions across all
four peers, with two environmental docker-compose stall classes documented
separately.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Vitor Pamplona
2026-05-11 08:15:10 -04:00
parent 2ddf59fc5f
commit 1ff4f98fff
2 changed files with 70 additions and 2 deletions
+14 -1
View File
@@ -10,6 +10,19 @@
# quic/interop/run-matrix.sh -s aioquic -t handshake # one test
# quic/interop/run-matrix.sh -s quic-go -t handshake,chacha20 # different peer
#
# Default peer set when running the full nightly sweep:
# aioquic, picoquic, quic-go, quinn — these are the four reference impls
# we hold to "must be flawless" because the Nostr/MoQ relay ecosystem
# our users actually run their servers on overlaps with all four
# (notably quinn: most Rust-based relays are built on it). Always sweep
# sequentially — run-matrix.sh is not safe to invoke concurrently (the
# runner's docker-compose.yml hardcodes container_name: sim/server/client,
# so parallel invocations collide).
#
# for peer in aioquic picoquic quic-go quinn; do
# quic/interop/run-matrix.sh -s $peer
# done
#
# Env overrides:
# RUNNER_DIR — where to clone / find the runner (default: ../quic-interop-runner)
# LOG_DIR — qlog / pcap output (default: $RUNNER_DIR/logs)
@@ -145,7 +158,7 @@ fi
# sim/server/client`, which Docker enforces globally regardless of
# COMPOSE_PROJECT_NAME. Two simultaneous invocations collide on
# `docker create container "sim"`. Run sequentially:
# for peer in aioquic picoquic quic-go; do
# for peer in aioquic picoquic quic-go quinn; do
# quic/interop/run-matrix.sh -s $peer -t handshake,chacha20,...
# done
#