Compare commits
15 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 48de882f70 | |||
| ce3811f8ec | |||
| fd6ffecdf5 | |||
| 5b7939cbd8 | |||
| 0077ea8b4d | |||
| 3e24b7840c | |||
| bf9ead329a | |||
| f270ed8f86 | |||
| 881d5afacd | |||
| 74cdb177e9 | |||
| fa17ea0ca5 | |||
| bbecae5e0d | |||
| 4fb521f54e | |||
| 4e2be3cc9a | |||
| 27978c3782 |
25
CHANGELOG.md
25
CHANGELOG.md
@@ -1,8 +1,31 @@
|
||||
<!-- file: CHANGELOG.md -->
|
||||
<!-- version: 18 -->
|
||||
<!-- version: 20 -->
|
||||
|
||||
# Changelog
|
||||
|
||||
## 0.3.4 — 2026-09-21
|
||||
|
||||
- publication stable de la première baseline realtime, avec `game-realtime-transport-lib` comme contrat binaire transport-neutral et `game-realtime-websocket-lib` comme backend Tokio/tokio-tungstenite ;
|
||||
- client `ws://`, listener serveur, split send/receive, close propre, limites message/frame/write-buffer, deadlines connect/send/close et erreurs transport-neutral validés sans runtime ni task backend privé ;
|
||||
- robustesse validée par tests loopback et négatifs : payloads hors limite, Text interdit, peer drop abrupt, handshake silencieux borné et mappings capacité/backpressure ;
|
||||
- smoke runtime `game-realtime-websocket-smoke: PASS` validé hors harness de test sur localhost avec port éphémère, échange binaire bidirectionnel et fermeture propre ;
|
||||
- `0.3.4-beta.1` a validé le workspace complet avec 53 tests et l'arbre inverse a confirmé que seul le launcher de smoke dépend du backend WebSocket ; `0.3.4-rc.1` a ensuite repassé audits, check/Clippy, 18 tests realtime ciblés, smoke et frontière de dépendances sans défaut ;
|
||||
- documentation durable des deux crates realtime livrée et prompt `0.3.5` préparé pour évaluer WebTransport/QUIC sur la même frontière avec WebSocket comme baseline/fallback ;
|
||||
- aucun TLS direct, wire codec final, protocole session, synchronisation gameplay, simulation authoritative ou serveur Uroburas n'est introduit dans `0.3.4`.
|
||||
|
||||
Les détails des phases `alpha`, `beta`, `rc` et du correctif `alpha.3.fix.1` restent dans `deltas/0.3.4/` et `history/0.3.4/`.
|
||||
|
||||
## 0.3.4-rc.1 — 2026-09-21
|
||||
|
||||
- gel fonctionnel de la baseline realtime : `game-realtime-transport-lib` porte le contrat binaire transport-neutral et `game-realtime-websocket-lib` son backend Tokio/tokio-tungstenite, sans dépendance transport dans les moteurs ou le gameplay ;
|
||||
- client `ws://`, listener serveur, split send/receive, close propre, erreurs transport-neutral, limites de message/frame/write-buffer et deadlines connect/send/close validés sans runtime ni task backend privé ;
|
||||
- robustesse validée sur localhost : round-trip binaire, payload hors limite, Text interdit, peer drop abrupt, handshake silencieux borné, mappings capacité/backpressure et smoke runtime public `game-realtime-websocket-smoke: PASS` ;
|
||||
- `0.3.4-beta.1` validée avec audits propres, `cargo check`, Clippy strict et `cargo test --workspace --all-targets --all-features` : 53 tests réussis, puis smoke runtime séparé et arbre inverse confirmant que seul le launcher de smoke dépend du backend WebSocket ;
|
||||
- consolidation de la documentation durable des deux crates realtime et préparation du prompt `0.3.5` pour évaluer WebTransport/QUIC sur la même frontière, avec WebSocket conservé comme fallback de référence ;
|
||||
- aucun TLS direct, protocole de session, synchronisation gameplay, simulation authoritative ou serveur Uroburas n'est introduit dans `0.3.4`.
|
||||
|
||||
La RC n'ouvre aucun nouveau scope. Seuls les correctifs nécessaires à la publication selon `VER-RC-*` peuvent produire `0.3.4-rc.1.fix.N`.
|
||||
|
||||
## 0.3.3 — 2026-09-21
|
||||
|
||||
- publication stable du pipeline Android SDL3 natif multi-ABI possédé par Gradle/Cargo, sans orchestrateur Python de build ni `src/main/jniLibs` généré dans les sources ;
|
||||
|
||||
14
Cargo.toml
14
Cargo.toml
@@ -1,5 +1,5 @@
|
||||
# file: Cargo.toml
|
||||
# version: 85
|
||||
# version: 100
|
||||
|
||||
[workspace]
|
||||
resolver = "3"
|
||||
@@ -9,10 +9,14 @@ members = [
|
||||
"crates/engines/engine-v1-sdl",
|
||||
"crates/games/game-reflex-poc",
|
||||
"crates/games/game-snake-poc",
|
||||
"crates/apps/game-realtime-websocket-smoke",
|
||||
"crates/apps/game-reflex-poc-desktop",
|
||||
"crates/apps/game-snake-poc-desktop",
|
||||
"crates/common/game-assets-lib",
|
||||
"crates/common/game-logging-lib",
|
||||
"crates/common/game-realtime-transport-lib",
|
||||
"crates/common/game-realtime-websocket-lib",
|
||||
"crates/common/game-realtime-webtransport-lib",
|
||||
"crates/apps/game-android-entrypoint",
|
||||
"crates/apps/game-reflex-poc-tauri",
|
||||
"crates/apps/game-reflex-poc-wasm",
|
||||
@@ -21,7 +25,7 @@ members = [
|
||||
]
|
||||
|
||||
[workspace.package]
|
||||
version = "0.3.3"
|
||||
version = "0.3.5-alpha.4.fix.1"
|
||||
edition = "2024"
|
||||
license = "MIT"
|
||||
repository = "https://git.sasedev.com/Sasedev/games"
|
||||
@@ -29,6 +33,8 @@ authors = ["Sasedev <games@sasedev.com>"]
|
||||
publish = false
|
||||
|
||||
[workspace.dependencies]
|
||||
futures-util = { version = "0.3.34", default-features = false }
|
||||
rcgen = { version = "0.14.10", default-features = false }
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
sdl3 = "^0.20"
|
||||
tracing = "0.1.44"
|
||||
@@ -38,7 +44,11 @@ tracing-subscriber = "0.3.23"
|
||||
tauri = "2"
|
||||
tauri-build = "2"
|
||||
tauri-plugin-tracing = "^0.3"
|
||||
tokio = "1.53.1"
|
||||
tokio-tungstenite = { version = "0.30.0", default-features = false }
|
||||
url = "2.5.8"
|
||||
wasm-bindgen = "0.2"
|
||||
web-transport-quinn = { version = "0.12.1", default-features = false }
|
||||
|
||||
[workspace.lints.rust]
|
||||
missing_docs = "warn"
|
||||
|
||||
10
README.md
10
README.md
@@ -1,5 +1,5 @@
|
||||
<!-- file: README.md -->
|
||||
<!-- version: 53 -->
|
||||
<!-- version: 68 -->
|
||||
|
||||
# games.sasedev
|
||||
|
||||
@@ -25,11 +25,11 @@ Workspace expérimental puis productif pour des jeux multiplateformes principale
|
||||
|
||||
## Baseline
|
||||
|
||||
Version stable de référence : `0.3.3`.
|
||||
Version stable de référence : `0.3.4`.
|
||||
|
||||
Prochaine version planifiée : `0.3.4-alpha.1`. `0.3.2` reste différée.
|
||||
Version active : `0.3.5-alpha.4.fix.1`. `0.3.2` reste différée.
|
||||
|
||||
La stable `0.3.3` livre la voie Android SDL3 native multi-ABI : build Gradle/Cargo sans orchestrateur Python, APK Debug universal et AAB Release pour `arm64-v8a`, `armeabi-v7a`, `x86_64` et `x86`, `minSdk 21` réellement fumé et compatibilité pages mémoire 16 KB validée sur les ABI 64 bits. `0.3.4-alpha.1` ouvrira la prochaine session avec la migration de nomenclature puis le cadrage de l'API de transport realtime/WebSocket.
|
||||
La stable `0.3.4` livre la première baseline realtime : contrat binaire transport-neutral, backend WebSocket Tokio/tokio-tungstenite, limites et deadlines, tests loopback/robustesse, smoke runtime localhost public et frontières de dépendances empêchant moteurs et gameplay de dépendre d'un backend concret. `0.3.5-alpha.4.fix.1` consolide le backend WebTransport natif avec limite de message configurable, deadlines connexion/stream/send, mapping d'erreurs, reset/abort/drop explicites et parseur de framing incrémental résistant à l'annulation ; le fix ferme uniquement le lint strict `implicit-return` révélé par la gate de `alpha.4` sans changer le comportement runtime. Navigateur/WASM, smoke public, fallback et datagrams restent réservés aux tranches suivantes.
|
||||
|
||||
Les deux premiers jeux sont des POC structurels : `game-reflex-poc` et `game-snake-poc`. Ils existent d'abord pour valider les frontières du workspace, le moteur, les assets et le packaging multiplateforme.
|
||||
|
||||
@@ -45,4 +45,4 @@ Les deux premiers jeux sont des POC structurels : `game-reflex-poc` et `game-sna
|
||||
|
||||
## Diagnostics et tests
|
||||
|
||||
Les socles transverses `crates/common/game-assets-lib` et `crates/common/game-logging-lib` fournissent respectivement la résolution logique des assets et le tracing commun. Les tests unitaires résident hors `src/` sous `unit_tests/`; les tests d’intégration/environnement résident sous `tests/`.
|
||||
Les socles transverses `crates/common/game-assets-lib` et `crates/common/game-logging-lib` fournissent respectivement la résolution logique des assets et le tracing commun. Le realtime est séparé entre `game-realtime-transport-lib`, contrat binaire transport-neutral, `game-realtime-websocket-lib`, backend Tokio/tokio-tungstenite, et `game-realtime-webtransport-lib`, backend WebTransport/QUIC candidat dont le chemin natif couvre désormais TLS/pinning, établissement de session et stream fiable principal adapté au contrat commun. Leurs responsabilités sont documentées dans leurs README/USAGE locaux lorsqu'un guide d'usage est justifié. `game-realtime-websocket-smoke` fournit la preuve runtime localhost hors harness de test ; le smoke WebTransport public est planifié après la tranche de robustesse. Les tests unitaires résident hors `src/` sous `unit_tests/`; les tests d’intégration/environnement résident sous `tests/`.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: ROADMAP.md -->
|
||||
<!-- version: 26 -->
|
||||
<!-- version: 27 -->
|
||||
|
||||
# Roadmap
|
||||
|
||||
@@ -49,7 +49,7 @@ Le détail historique des prereleases `0.1.0-*` reste dans `deltas/0.1.0/` et `h
|
||||
- (x) `0.3.1` — Snake Tauri Android livré comme POC de référence réutilisant la baseline Web/WASM ; la production Android reste orientée SDL3 natif.
|
||||
- (d) `0.3.2` — Tauri Desktop + Snake est différé tant qu’une solution de monétisation desktop/WebView, notamment vidéo récompensée, n’est pas démontrée techniquement et contractuellement ; ne pas créer cette distribution seulement pour réutiliser le host Web.
|
||||
- (x) `0.3.3` — Android SDL3 natif multi-ABI livré avec Cargo/Gradle natifs, APK universal pour tests, AAB comme cible de distribution, `minSdk 21` fumé et compatibilité 16 KB 64 bits validée, sans script Python de build.
|
||||
- ( ) `0.3.4` — API de transport realtime + WebSocket/tokio-tungstenite baseline, sans serveur Uroburas Mode 3.
|
||||
- (x) `0.3.4` — API de transport realtime + WebSocket/tokio-tungstenite baseline livrée, sans serveur Uroburas Mode 3.
|
||||
- ( ) `0.3.5` — POC WebTransport/QUIC sur le même protocole, avec comparaison mesurée et fallback WebSocket.
|
||||
- ( ) `0.3.6` — consolidation des POC plateforme/réseau et préparation de la baseline `0.4.x`.
|
||||
|
||||
|
||||
4
RULES.md
4
RULES.md
@@ -1,5 +1,5 @@
|
||||
<!-- file: RULES.md -->
|
||||
<!-- version: 5 -->
|
||||
<!-- version: 6 -->
|
||||
|
||||
# Index normatif games.sasedev
|
||||
|
||||
@@ -17,7 +17,7 @@ Les règles détaillées sont maintenues sous `docs/rules/` et sont cumulatives
|
||||
6. [`docs/rules/VERSION_WORKFLOW.md`](docs/rules/VERSION_WORKFLOW.md) — SemVer, niveaux de maturité, fixes, deltas et livraisons ;
|
||||
7. [`docs/rules/RULES_COMMANDS.md`](docs/rules/RULES_COMMANDS.md) — politique d’exécution des commandes Cargo, audits, runners, Android, Web et Git ;
|
||||
8. [`docs/rules/RULES_VALIDATION_MATRIX.md`](docs/rules/RULES_VALIDATION_MATRIX.md) — matrice évolutive des commandes, dépendances de validation et politiques de nettoyage ;
|
||||
9. [`docs/rules/RULES_SESSION_PLANNING.md`](docs/rules/RULES_SESSION_PLANNING.md) — cadrage `pre.1`, dimensionnement des sessions et cycle de transmission ;
|
||||
9. [`docs/rules/RULES_SESSION_PLANNING.md`](docs/rules/RULES_SESSION_PLANNING.md) — cadrage `alpha.1`, dimensionnement des sessions et cycle de transmission ;
|
||||
10. [`docs/rules/PROMPT_STRUCTURE.md`](docs/rules/PROMPT_STRUCTURE.md) — structure minimale des prompts de reprise et rappels de workflow obligatoires ;
|
||||
11. [`docs/rules/RULES_SERVER_HOSTING.md`](docs/rules/RULES_SERVER_HOSTING.md) — contraintes durables de portabilité et préférence d'auto-hébergement.
|
||||
|
||||
|
||||
21
crates/apps/game-realtime-websocket-smoke/Cargo.toml
Normal file
21
crates/apps/game-realtime-websocket-smoke/Cargo.toml
Normal file
@@ -0,0 +1,21 @@
|
||||
# file: crates/apps/game-realtime-websocket-smoke/Cargo.toml
|
||||
# version: 1
|
||||
|
||||
[package]
|
||||
name = "game-realtime-websocket-smoke"
|
||||
version.workspace = true
|
||||
edition.workspace = true
|
||||
license.workspace = true
|
||||
repository.workspace = true
|
||||
authors.workspace = true
|
||||
publish.workspace = true
|
||||
|
||||
[dependencies]
|
||||
game-logging-lib = { path = "../../common/game-logging-lib" }
|
||||
game-realtime-transport-lib = { path = "../../common/game-realtime-transport-lib" }
|
||||
game-realtime-websocket-lib = { path = "../../common/game-realtime-websocket-lib" }
|
||||
tokio = { workspace = true, features = ["macros", "rt", "time"] }
|
||||
tracing.workspace = true
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
108
crates/apps/game-realtime-websocket-smoke/src/main.rs
Normal file
108
crates/apps/game-realtime-websocket-smoke/src/main.rs
Normal file
@@ -0,0 +1,108 @@
|
||||
// file: crates/apps/game-realtime-websocket-smoke/src/main.rs
|
||||
// version: 1
|
||||
|
||||
#![warn(missing_docs)]
|
||||
#![deny(unreachable_pub)]
|
||||
#![forbid(unsafe_code)]
|
||||
|
||||
//! Executable localhost smoke for the public games.sasedev WebSocket realtime transport path.
|
||||
|
||||
use game_realtime_transport_lib::RealtimeConnection; // rust-rules: trait-import
|
||||
use game_realtime_transport_lib::RealtimeReceiver; // rust-rules: trait-import
|
||||
use game_realtime_transport_lib::RealtimeSender; // rust-rules: trait-import
|
||||
|
||||
const CLIENT_PAYLOAD: &[u8] = b"games.sasedev-client-smoke";
|
||||
const SERVER_PAYLOAD: &[u8] = b"games.sasedev-server-smoke";
|
||||
const SMOKE_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(5);
|
||||
const TRACING_TARGET: &str = "games::realtime::websocket::smoke";
|
||||
|
||||
#[tokio::main(flavor = "current_thread")]
|
||||
async fn main() -> std::process::ExitCode {
|
||||
let _logging_guard = match game_logging_lib::init_console_tracing() {
|
||||
std::result::Result::Ok(guard) => guard,
|
||||
std::result::Result::Err(error) => {
|
||||
eprintln!("failed to initialize realtime WebSocket smoke tracing: {error}");
|
||||
return std::process::ExitCode::FAILURE;
|
||||
},
|
||||
};
|
||||
tracing::info!(target: TRACING_TARGET, "realtime WebSocket smoke started");
|
||||
let result = tokio::time::timeout(SMOKE_TIMEOUT, run_smoke()).await;
|
||||
return match result {
|
||||
std::result::Result::Ok(std::result::Result::Ok(())) => {
|
||||
tracing::info!(target: TRACING_TARGET, "realtime WebSocket smoke passed");
|
||||
println!("game-realtime-websocket-smoke: PASS");
|
||||
std::process::ExitCode::SUCCESS
|
||||
},
|
||||
std::result::Result::Ok(std::result::Result::Err(error)) => {
|
||||
tracing::error!(target: TRACING_TARGET, detail = error.as_str(), "realtime WebSocket smoke failed");
|
||||
eprintln!("game-realtime-websocket-smoke: FAIL: {error}");
|
||||
std::process::ExitCode::FAILURE
|
||||
},
|
||||
std::result::Result::Err(_) => {
|
||||
tracing::error!(target: TRACING_TARGET, timeout_ms = SMOKE_TIMEOUT.as_millis(), "realtime WebSocket smoke timed out");
|
||||
eprintln!("game-realtime-websocket-smoke: FAIL: smoke timed out");
|
||||
std::process::ExitCode::FAILURE
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
async fn run_smoke() -> std::result::Result<(), String> {
|
||||
let bind_address = std::net::SocketAddr::from(([127, 0, 0, 1], 0));
|
||||
let listener = match game_realtime_websocket_lib::WebSocketListener::bind(bind_address).await {
|
||||
std::result::Result::Ok(value) => value,
|
||||
std::result::Result::Err(error) => return std::result::Result::Err(format!("listener bind failed: {error}")),
|
||||
};
|
||||
let endpoint = format!("ws://{}/", listener.local_addr());
|
||||
tracing::info!(target: TRACING_TARGET, endpoint = endpoint.as_str(), "loopback endpoint bound");
|
||||
let (server_result, client_result) = tokio::join!(listener.accept(), game_realtime_websocket_lib::connect(endpoint.as_str()));
|
||||
let server_connection = match server_result {
|
||||
std::result::Result::Ok(value) => value,
|
||||
std::result::Result::Err(error) => return std::result::Result::Err(format!("server accept failed: {error}")),
|
||||
};
|
||||
let client_connection = match client_result {
|
||||
std::result::Result::Ok(value) => value,
|
||||
std::result::Result::Err(error) => return std::result::Result::Err(format!("client connect failed: {error}")),
|
||||
};
|
||||
let (mut server_sender, mut server_receiver) = server_connection.split();
|
||||
let (mut client_sender, mut client_receiver) = client_connection.split();
|
||||
let client_message = game_realtime_transport_lib::TransportMessage::new(CLIENT_PAYLOAD.to_vec());
|
||||
if let std::result::Result::Err(error) = client_sender.send(client_message).await {
|
||||
return std::result::Result::Err(format!("client send failed: {error}"));
|
||||
}
|
||||
let server_received = match server_receiver.receive().await {
|
||||
std::result::Result::Ok(value) => value,
|
||||
std::result::Result::Err(error) => return std::result::Result::Err(format!("server receive failed: {error}")),
|
||||
};
|
||||
if !receive_matches(server_received, CLIENT_PAYLOAD) {
|
||||
return std::result::Result::Err(String::from("server did not receive the expected client payload"));
|
||||
}
|
||||
let server_message = game_realtime_transport_lib::TransportMessage::new(SERVER_PAYLOAD.to_vec());
|
||||
if let std::result::Result::Err(error) = server_sender.send(server_message).await {
|
||||
return std::result::Result::Err(format!("server send failed: {error}"));
|
||||
}
|
||||
let client_received = match client_receiver.receive().await {
|
||||
std::result::Result::Ok(value) => value,
|
||||
std::result::Result::Err(error) => return std::result::Result::Err(format!("client receive failed: {error}")),
|
||||
};
|
||||
if !receive_matches(client_received, SERVER_PAYLOAD) {
|
||||
return std::result::Result::Err(String::from("client did not receive the expected server payload"));
|
||||
}
|
||||
if let std::result::Result::Err(error) = client_sender.close().await {
|
||||
return std::result::Result::Err(format!("client close failed: {error}"));
|
||||
}
|
||||
let server_close = match server_receiver.receive().await {
|
||||
std::result::Result::Ok(value) => value,
|
||||
std::result::Result::Err(error) => return std::result::Result::Err(format!("server close observation failed: {error}")),
|
||||
};
|
||||
if server_close != game_realtime_transport_lib::TransportReceive::Closed {
|
||||
return std::result::Result::Err(String::from("server did not observe the client close handshake"));
|
||||
}
|
||||
return std::result::Result::Ok(());
|
||||
}
|
||||
|
||||
fn receive_matches(receive: game_realtime_transport_lib::TransportReceive, expected: &[u8]) -> bool {
|
||||
return match receive {
|
||||
game_realtime_transport_lib::TransportReceive::Message(message) => message.as_bytes() == expected,
|
||||
game_realtime_transport_lib::TransportReceive::Closed => false,
|
||||
};
|
||||
}
|
||||
14
crates/common/game-realtime-transport-lib/Cargo.toml
Normal file
14
crates/common/game-realtime-transport-lib/Cargo.toml
Normal file
@@ -0,0 +1,14 @@
|
||||
# file: crates/common/game-realtime-transport-lib/Cargo.toml
|
||||
# version: 1
|
||||
|
||||
[package]
|
||||
name = "game-realtime-transport-lib"
|
||||
version.workspace = true
|
||||
edition.workspace = true
|
||||
license.workspace = true
|
||||
repository.workspace = true
|
||||
authors.workspace = true
|
||||
publish.workspace = true
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
42
crates/common/game-realtime-transport-lib/README.md
Normal file
42
crates/common/game-realtime-transport-lib/README.md
Normal file
@@ -0,0 +1,42 @@
|
||||
<!-- file: crates/common/game-realtime-transport-lib/README.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# game-realtime-transport-lib
|
||||
|
||||
Contrat realtime transport-neutral de `games.sasedev`. La crate définit uniquement la forme minimale d'une connexion établie, de ses moitiés d'envoi/réception, des payloads binaires opaques et des erreurs stables visibles par les couches supérieures.
|
||||
|
||||
## Responsabilité
|
||||
|
||||
La crate possède :
|
||||
|
||||
- `TransportMessage`, buffer binaire possédé ;
|
||||
- `TransportReceive`, qui distingue message reçu et fermeture distante propre ;
|
||||
- `RealtimeConnection`, `RealtimeSender` et `RealtimeReceiver` ;
|
||||
- `TransportError` et `TransportErrorKind` comme catégories backend-neutral.
|
||||
|
||||
Elle ne possède pas :
|
||||
|
||||
- l'établissement d'une connexion réseau ;
|
||||
- Tokio ou un autre runtime ;
|
||||
- WebSocket, WebTransport, QUIC, HTTP ou TLS ;
|
||||
- un codec wire ;
|
||||
- une session joueur/room ;
|
||||
- la synchronisation gameplay ou la simulation authoritative.
|
||||
|
||||
## Contrat async
|
||||
|
||||
`RealtimeConnection::split()` consomme une connexion établie et retourne des moitiés d'envoi et de réception indépendantes. Les opérations async sont exposées par des futures associées GAT plutôt que par `async-trait` ou `Box<dyn Future>`.
|
||||
|
||||
Le contrat n'impose volontairement aucune borne `Send` aux futures. Un backend natif peut fournir des futures `Send`, tandis qu'un futur backend navigateur/WASM ne doit pas être exclu par une contrainte de threading qui ne relève pas de l'abstraction transport.
|
||||
|
||||
## Sémantique
|
||||
|
||||
Les payloads sont toujours binaires et opaques. Une couche supérieure pourra ultérieurement leur appliquer un codec wire ou un protocole de session sans modifier cette crate.
|
||||
|
||||
Une fermeture distante propre est représentée par `TransportReceive::Closed`. Elle n'est pas convertie en erreur I/O générique. Les erreurs utilisent une catégorie stable (`Timeout`, `MessageTooLarge`, `Backpressure`, `Protocol`, etc.) et un détail de diagnostic, sans exposer le type d'erreur du backend concret.
|
||||
|
||||
## Dépendances et sens d'ownership
|
||||
|
||||
Cette crate ne dépend d'aucun backend realtime. Les implémentations concrètes dépendent d'elle, jamais l'inverse.
|
||||
|
||||
Le premier backend de référence est `game-realtime-websocket-lib`. Le POC WebTransport/QUIC prévu ensuite doit d'abord challenger cette même frontière avant toute généralisation supplémentaire.
|
||||
42
crates/common/game-realtime-transport-lib/src/connection.rs
Normal file
42
crates/common/game-realtime-transport-lib/src/connection.rs
Normal file
@@ -0,0 +1,42 @@
|
||||
// file: crates/common/game-realtime-transport-lib/src/connection.rs
|
||||
// version: 1
|
||||
|
||||
/// Established realtime connection that owns independent send and receive halves.
|
||||
pub trait RealtimeConnection {
|
||||
/// Send half produced when this connection is split.
|
||||
type Sender: crate::RealtimeSender;
|
||||
/// Receive half produced when this connection is split.
|
||||
type Receiver: crate::RealtimeReceiver;
|
||||
|
||||
/// Consumes the connection and returns independent send and receive halves.
|
||||
fn split(self) -> (Self::Sender, Self::Receiver);
|
||||
}
|
||||
|
||||
/// Send half of an established realtime connection.
|
||||
pub trait RealtimeSender {
|
||||
/// Future returned by [`RealtimeSender::send`].
|
||||
type SendFuture<'a>: core::future::Future<Output = Result<(), crate::TransportError>>
|
||||
where
|
||||
Self: 'a;
|
||||
/// Future returned by [`RealtimeSender::close`].
|
||||
type CloseFuture<'a>: core::future::Future<Output = Result<(), crate::TransportError>>
|
||||
where
|
||||
Self: 'a;
|
||||
|
||||
/// Sends one owned opaque binary message, respecting backend backpressure.
|
||||
fn send(&mut self, message: crate::TransportMessage) -> Self::SendFuture<'_>;
|
||||
|
||||
/// Initiates a clean local transport-level close.
|
||||
fn close(&mut self) -> Self::CloseFuture<'_>;
|
||||
}
|
||||
|
||||
/// Receive half of an established realtime connection.
|
||||
pub trait RealtimeReceiver {
|
||||
/// Future returned by [`RealtimeReceiver::receive`].
|
||||
type ReceiveFuture<'a>: core::future::Future<Output = Result<crate::TransportReceive, crate::TransportError>>
|
||||
where
|
||||
Self: 'a;
|
||||
|
||||
/// Receives one binary message or observes a clean remote close.
|
||||
fn receive(&mut self) -> Self::ReceiveFuture<'_>;
|
||||
}
|
||||
82
crates/common/game-realtime-transport-lib/src/error.rs
Normal file
82
crates/common/game-realtime-transport-lib/src/error.rs
Normal file
@@ -0,0 +1,82 @@
|
||||
// file: crates/common/game-realtime-transport-lib/src/error.rs
|
||||
// version: 1
|
||||
|
||||
/// Stable transport-neutral category for a realtime operation failure.
|
||||
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
||||
pub enum TransportErrorKind {
|
||||
/// An endpoint or transport configuration is invalid.
|
||||
InvalidConfiguration,
|
||||
/// A client connection could not be established.
|
||||
Connect,
|
||||
/// A server endpoint could not be bound.
|
||||
Bind,
|
||||
/// A server could not accept an incoming connection.
|
||||
Accept,
|
||||
/// An operation exceeded its configured deadline.
|
||||
Timeout,
|
||||
/// A payload exceeds the configured transport bound.
|
||||
MessageTooLarge,
|
||||
/// The transport cannot currently accept more outbound data within its configured bounds.
|
||||
Backpressure,
|
||||
/// The requested operation requires a connection that is already closed.
|
||||
Closed,
|
||||
/// An underlying I/O operation failed.
|
||||
Io,
|
||||
/// The backend reported a protocol-level or transport-specific failure.
|
||||
Protocol,
|
||||
/// The operation was explicitly aborted or cancelled when that distinction is observable.
|
||||
Aborted,
|
||||
}
|
||||
|
||||
impl core::fmt::Display for TransportErrorKind {
|
||||
fn fmt(&self, formatter: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
|
||||
return match self {
|
||||
crate::TransportErrorKind::InvalidConfiguration => formatter.write_str("invalid configuration"),
|
||||
crate::TransportErrorKind::Connect => formatter.write_str("connect failure"),
|
||||
crate::TransportErrorKind::Bind => formatter.write_str("bind failure"),
|
||||
crate::TransportErrorKind::Accept => formatter.write_str("accept failure"),
|
||||
crate::TransportErrorKind::Timeout => formatter.write_str("operation timed out"),
|
||||
crate::TransportErrorKind::MessageTooLarge => formatter.write_str("message too large"),
|
||||
crate::TransportErrorKind::Backpressure => formatter.write_str("transport backpressure"),
|
||||
crate::TransportErrorKind::Closed => formatter.write_str("connection closed"),
|
||||
crate::TransportErrorKind::Io => formatter.write_str("I/O failure"),
|
||||
crate::TransportErrorKind::Protocol => formatter.write_str("protocol failure"),
|
||||
crate::TransportErrorKind::Aborted => formatter.write_str("operation aborted"),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/// Transport-neutral operation failure with a stable category and diagnostic detail.
|
||||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
pub struct TransportError {
|
||||
detail: String,
|
||||
kind: crate::TransportErrorKind,
|
||||
}
|
||||
|
||||
impl TransportError {
|
||||
/// Creates a transport failure from a stable category and backend-neutral diagnostic detail.
|
||||
#[must_use]
|
||||
pub fn new(kind: crate::TransportErrorKind, detail: impl Into<String>) -> Self {
|
||||
return Self { detail: detail.into(), kind };
|
||||
}
|
||||
|
||||
/// Borrows the diagnostic detail associated with the failure.
|
||||
#[must_use]
|
||||
pub fn detail(&self) -> &str {
|
||||
return self.detail.as_str();
|
||||
}
|
||||
|
||||
/// Returns the stable transport-neutral failure category.
|
||||
#[must_use]
|
||||
pub fn kind(&self) -> crate::TransportErrorKind {
|
||||
return self.kind;
|
||||
}
|
||||
}
|
||||
|
||||
impl core::fmt::Display for TransportError {
|
||||
fn fmt(&self, formatter: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
|
||||
return write!(formatter, "{}: {}", self.kind, self.detail);
|
||||
}
|
||||
}
|
||||
|
||||
impl std::error::Error for TransportError {}
|
||||
31
crates/common/game-realtime-transport-lib/src/lib.rs
Normal file
31
crates/common/game-realtime-transport-lib/src/lib.rs
Normal file
@@ -0,0 +1,31 @@
|
||||
// file: crates/common/game-realtime-transport-lib/src/lib.rs
|
||||
// version: 1
|
||||
|
||||
#![warn(missing_docs)]
|
||||
#![deny(unreachable_pub)]
|
||||
#![forbid(unsafe_code)]
|
||||
|
||||
//! Transport-neutral realtime connection contracts for games.sasedev.
|
||||
|
||||
mod connection;
|
||||
mod error;
|
||||
mod message;
|
||||
|
||||
/// Re-export of an established realtime connection that can be split into independent halves.
|
||||
pub use self::connection::RealtimeConnection;
|
||||
/// Re-export of the receive half of an established realtime connection.
|
||||
pub use self::connection::RealtimeReceiver;
|
||||
/// Re-export of the send half of an established realtime connection.
|
||||
pub use self::connection::RealtimeSender;
|
||||
/// Re-export of a transport-neutral operation failure.
|
||||
pub use self::error::TransportError;
|
||||
/// Re-export of transport-neutral error categories.
|
||||
pub use self::error::TransportErrorKind;
|
||||
/// Re-export of an owned opaque binary transport message.
|
||||
pub use self::message::TransportMessage;
|
||||
/// Re-export of the result of one receive operation.
|
||||
pub use self::message::TransportReceive;
|
||||
|
||||
#[cfg(test)]
|
||||
#[path = "../unit_tests/contract.rs"]
|
||||
mod tests;
|
||||
49
crates/common/game-realtime-transport-lib/src/message.rs
Normal file
49
crates/common/game-realtime-transport-lib/src/message.rs
Normal file
@@ -0,0 +1,49 @@
|
||||
// file: crates/common/game-realtime-transport-lib/src/message.rs
|
||||
// version: 1
|
||||
|
||||
/// Owned opaque binary payload carried by a realtime transport.
|
||||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
pub struct TransportMessage {
|
||||
bytes: Vec<u8>,
|
||||
}
|
||||
|
||||
impl TransportMessage {
|
||||
/// Creates a transport message from owned bytes.
|
||||
#[must_use]
|
||||
pub fn new(bytes: Vec<u8>) -> Self {
|
||||
return Self { bytes };
|
||||
}
|
||||
|
||||
/// Borrows the opaque payload bytes.
|
||||
#[must_use]
|
||||
pub fn as_bytes(&self) -> &[u8] {
|
||||
return self.bytes.as_slice();
|
||||
}
|
||||
|
||||
/// Consumes the message and returns its owned payload bytes.
|
||||
#[must_use]
|
||||
pub fn into_bytes(self) -> Vec<u8> {
|
||||
return self.bytes;
|
||||
}
|
||||
|
||||
/// Returns whether the payload is empty.
|
||||
#[must_use]
|
||||
pub fn is_empty(&self) -> bool {
|
||||
return self.bytes.is_empty();
|
||||
}
|
||||
|
||||
/// Returns the payload length in bytes.
|
||||
#[must_use]
|
||||
pub fn len(&self) -> usize {
|
||||
return self.bytes.len();
|
||||
}
|
||||
}
|
||||
|
||||
/// Outcome of one successful transport receive operation.
|
||||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
pub enum TransportReceive {
|
||||
/// One opaque binary message was received.
|
||||
Message(crate::TransportMessage),
|
||||
/// The remote peer completed a clean transport-level close.
|
||||
Closed,
|
||||
}
|
||||
131
crates/common/game-realtime-transport-lib/unit_tests/contract.rs
Normal file
131
crates/common/game-realtime-transport-lib/unit_tests/contract.rs
Normal file
@@ -0,0 +1,131 @@
|
||||
// file: crates/common/game-realtime-transport-lib/unit_tests/contract.rs
|
||||
// version: 1
|
||||
|
||||
#[derive(Debug, Eq, PartialEq)]
|
||||
struct TestSender {
|
||||
closed: bool,
|
||||
sent_bytes: usize,
|
||||
}
|
||||
|
||||
impl crate::RealtimeSender for TestSender {
|
||||
type SendFuture<'a>
|
||||
= std::future::Ready<Result<(), crate::TransportError>>
|
||||
where
|
||||
Self: 'a;
|
||||
type CloseFuture<'a>
|
||||
= std::future::Ready<Result<(), crate::TransportError>>
|
||||
where
|
||||
Self: 'a;
|
||||
|
||||
fn send(&mut self, message: crate::TransportMessage) -> Self::SendFuture<'_> {
|
||||
self.sent_bytes = self.sent_bytes.saturating_add(message.len());
|
||||
return std::future::ready(Ok(()));
|
||||
}
|
||||
|
||||
fn close(&mut self) -> Self::CloseFuture<'_> {
|
||||
self.closed = true;
|
||||
return std::future::ready(Ok(()));
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Eq, PartialEq)]
|
||||
struct TestReceiver;
|
||||
|
||||
impl crate::RealtimeReceiver for TestReceiver {
|
||||
type ReceiveFuture<'a>
|
||||
= std::future::Ready<Result<crate::TransportReceive, crate::TransportError>>
|
||||
where
|
||||
Self: 'a;
|
||||
|
||||
fn receive(&mut self) -> Self::ReceiveFuture<'_> {
|
||||
return std::future::ready(Ok(crate::TransportReceive::Closed));
|
||||
}
|
||||
}
|
||||
|
||||
struct TestConnection;
|
||||
|
||||
impl crate::RealtimeConnection for TestConnection {
|
||||
type Sender = TestSender;
|
||||
type Receiver = TestReceiver;
|
||||
|
||||
fn split(self) -> (Self::Sender, Self::Receiver) {
|
||||
return (TestSender { closed: false, sent_bytes: 0 }, TestReceiver);
|
||||
}
|
||||
}
|
||||
|
||||
fn poll_ready<T>(future: impl core::future::Future<Output = T>) -> T {
|
||||
let mut future = std::pin::pin!(future);
|
||||
let waker = std::task::Waker::noop();
|
||||
let mut context = std::task::Context::from_waker(waker);
|
||||
return match core::future::Future::poll(future.as_mut(), &mut context) {
|
||||
std::task::Poll::Ready(value) => value,
|
||||
std::task::Poll::Pending => unreachable!("test future unexpectedly remained pending"),
|
||||
};
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn message_preserves_owned_binary_payload() {
|
||||
let message = crate::TransportMessage::new(vec![0, 1, 2, 255]);
|
||||
assert_eq!(message.as_bytes(), &[0, 1, 2, 255]);
|
||||
assert_eq!(message.len(), 4);
|
||||
assert!(!message.is_empty());
|
||||
assert_eq!(message.into_bytes(), vec![0, 1, 2, 255]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn empty_message_remains_a_valid_transport_payload() {
|
||||
let message = crate::TransportMessage::new(Vec::new());
|
||||
assert!(message.is_empty());
|
||||
assert_eq!(message.len(), 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn clean_remote_close_is_distinct_from_transport_error() {
|
||||
let mut receiver = TestReceiver;
|
||||
let received = poll_ready(crate::RealtimeReceiver::receive(&mut receiver));
|
||||
assert_eq!(received, Ok(crate::TransportReceive::Closed));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn connection_split_produces_independent_contract_halves() {
|
||||
let (mut sender, mut receiver) = crate::RealtimeConnection::split(TestConnection);
|
||||
assert_eq!(poll_ready(crate::RealtimeSender::send(&mut sender, crate::TransportMessage::new(vec![1, 2, 3]))), Ok(()));
|
||||
assert_eq!(sender.sent_bytes, 3);
|
||||
assert_eq!(poll_ready(crate::RealtimeReceiver::receive(&mut receiver)), Ok(crate::TransportReceive::Closed));
|
||||
assert_eq!(poll_ready(crate::RealtimeSender::close(&mut sender)), Ok(()));
|
||||
assert!(sender.closed);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn message_receive_variant_preserves_payload() {
|
||||
let received = crate::TransportReceive::Message(crate::TransportMessage::new(vec![4, 5, 6]));
|
||||
assert_eq!(received, crate::TransportReceive::Message(crate::TransportMessage::new(vec![4, 5, 6])));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn transport_error_preserves_stable_kind_and_diagnostic_detail() {
|
||||
let error = crate::TransportError::new(crate::TransportErrorKind::Timeout, "send deadline exceeded");
|
||||
assert_eq!(error.kind(), crate::TransportErrorKind::Timeout);
|
||||
assert_eq!(error.detail(), "send deadline exceeded");
|
||||
assert_eq!(error.to_string(), "operation timed out: send deadline exceeded");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn transport_error_kinds_have_stable_human_readable_labels() {
|
||||
let cases = [
|
||||
(crate::TransportErrorKind::InvalidConfiguration, "invalid configuration"),
|
||||
(crate::TransportErrorKind::Connect, "connect failure"),
|
||||
(crate::TransportErrorKind::Bind, "bind failure"),
|
||||
(crate::TransportErrorKind::Accept, "accept failure"),
|
||||
(crate::TransportErrorKind::Timeout, "operation timed out"),
|
||||
(crate::TransportErrorKind::MessageTooLarge, "message too large"),
|
||||
(crate::TransportErrorKind::Backpressure, "transport backpressure"),
|
||||
(crate::TransportErrorKind::Closed, "connection closed"),
|
||||
(crate::TransportErrorKind::Io, "I/O failure"),
|
||||
(crate::TransportErrorKind::Protocol, "protocol failure"),
|
||||
(crate::TransportErrorKind::Aborted, "operation aborted"),
|
||||
];
|
||||
for (kind, expected) in cases {
|
||||
assert_eq!(kind.to_string(), expected);
|
||||
}
|
||||
}
|
||||
24
crates/common/game-realtime-websocket-lib/Cargo.toml
Normal file
24
crates/common/game-realtime-websocket-lib/Cargo.toml
Normal file
@@ -0,0 +1,24 @@
|
||||
# file: crates/common/game-realtime-websocket-lib/Cargo.toml
|
||||
# version: 3
|
||||
|
||||
[package]
|
||||
name = "game-realtime-websocket-lib"
|
||||
version.workspace = true
|
||||
edition.workspace = true
|
||||
license.workspace = true
|
||||
repository.workspace = true
|
||||
authors.workspace = true
|
||||
publish.workspace = true
|
||||
|
||||
[dependencies]
|
||||
futures-util = { workspace = true, features = ["sink", "std"] }
|
||||
game-realtime-transport-lib = { path = "../game-realtime-transport-lib" }
|
||||
tokio = { workspace = true, features = ["net", "time"] }
|
||||
tokio-tungstenite = { workspace = true, features = ["connect", "handshake"] }
|
||||
tracing.workspace = true
|
||||
|
||||
[dev-dependencies]
|
||||
tokio = { workspace = true, features = ["macros", "rt", "time"] }
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
49
crates/common/game-realtime-websocket-lib/README.md
Normal file
49
crates/common/game-realtime-websocket-lib/README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
<!-- file: crates/common/game-realtime-websocket-lib/README.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# game-realtime-websocket-lib
|
||||
|
||||
Backend WebSocket de référence pour le contrat `game-realtime-transport-lib`, fondé sur Tokio et `tokio-tungstenite`.
|
||||
|
||||
## Responsabilité
|
||||
|
||||
La crate possède :
|
||||
|
||||
- connexion client `ws://` ;
|
||||
- listener serveur TCP + upgrade WebSocket ;
|
||||
- types concrets `WebSocketConnection`, `WebSocketSender` et `WebSocketReceiver` ;
|
||||
- mapping WebSocket vers le contrat binaire transport-neutral ;
|
||||
- limites de message/frame/write-buffer ;
|
||||
- deadlines connect/handshake, send et close ;
|
||||
- tracing du domaine `games::realtime::websocket` ;
|
||||
- mapping des erreurs Tungstenite vers `TransportErrorKind`.
|
||||
|
||||
Elle ne possède pas le runtime Tokio : le consommateur crée et exécute son runtime. La crate ne lance ni runtime global, ni thread runtime privé, ni task backend détachée pour une connexion de base.
|
||||
|
||||
## Frontières
|
||||
|
||||
Le backend transporte des octets opaques. Il ne connaît ni joueur, ni room, ni tick, ni snapshot, ni codec wire, ni protocole de session.
|
||||
|
||||
Les messages Text ne font pas partie du contrat et sont rejetés comme erreur de protocole. Ping/Pong reste un détail WebSocket. Une fermeture distante propre devient `TransportReceive::Closed`.
|
||||
|
||||
La baseline active utilise `ws://`. Aucune feature TLS de `tokio-tungstenite` n'est activée ; une politique `wss://` directe n'est pas introduite tant qu'un besoin produit et une stratégie de certificats ne sont pas démontrés.
|
||||
|
||||
## Configuration
|
||||
|
||||
`WebSocketConfig::default()` fournit des bornes produit explicites :
|
||||
|
||||
```text
|
||||
message maximum 1 MiB
|
||||
frame maximum 1 MiB
|
||||
write buffer target 64 KiB
|
||||
write buffer maximum 2 MiB
|
||||
connect/handshake 10 s
|
||||
send 5 s
|
||||
close 2 s
|
||||
```
|
||||
|
||||
Les builders `with_*` permettent d'adapter ces limites avant `connect_with_config` ou `WebSocketListener::bind_with_config`. `validate()` refuse les configurations incohérentes avant l'établissement réseau.
|
||||
|
||||
## Utilisation
|
||||
|
||||
Voir [`USAGE.md`](USAGE.md) pour les points d'entrée client/serveur, la configuration et le smoke de référence.
|
||||
78
crates/common/game-realtime-websocket-lib/USAGE.md
Normal file
78
crates/common/game-realtime-websocket-lib/USAGE.md
Normal file
@@ -0,0 +1,78 @@
|
||||
<!-- file: crates/common/game-realtime-websocket-lib/USAGE.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Utilisation — backend realtime WebSocket
|
||||
|
||||
## Préconditions
|
||||
|
||||
Le consommateur possède le runtime Tokio. `game-realtime-websocket-lib` utilise Tokio pour les sockets et deadlines mais ne crée jamais son propre runtime.
|
||||
|
||||
Le contrat transport-neutral est fourni par `game-realtime-transport-lib`. Pour appeler `split`, `send`, `receive` et `close`, importer les traits correspondants dans le module consommateur selon les règles Rust du dépôt.
|
||||
|
||||
## Client
|
||||
|
||||
Le point d'entrée simple est :
|
||||
|
||||
```text
|
||||
game_realtime_websocket_lib::connect("ws://host:port/path")
|
||||
```
|
||||
|
||||
La fonction retourne une `WebSocketConnection`. La connexion est ensuite consommée par `RealtimeConnection::split()` pour obtenir un sender et un receiver indépendants.
|
||||
|
||||
Pour une configuration spécifique, construire `WebSocketConfig`, valider ses invariants puis utiliser :
|
||||
|
||||
```text
|
||||
game_realtime_websocket_lib::connect_with_config(endpoint, config)
|
||||
```
|
||||
|
||||
## Serveur
|
||||
|
||||
Créer d'abord une adresse `SocketAddr`, puis binder :
|
||||
|
||||
```text
|
||||
WebSocketListener::bind(address)
|
||||
```
|
||||
|
||||
ou :
|
||||
|
||||
```text
|
||||
WebSocketListener::bind_with_config(address, config)
|
||||
```
|
||||
|
||||
`local_addr()` permet de connaître l'adresse réellement allouée, notamment après bind sur `127.0.0.1:0`. `accept().await` attend ensuite un peer TCP et effectue l'upgrade WebSocket dans la deadline configurée.
|
||||
|
||||
## Émission et réception
|
||||
|
||||
Un message applicatif est encapsulé dans `TransportMessage::new(Vec<u8>)`. Le sender refuse localement un payload dépassant les bornes configurées avant écriture.
|
||||
|
||||
`receive()` retourne :
|
||||
|
||||
- `TransportReceive::Message` pour un payload binaire ;
|
||||
- `TransportReceive::Closed` pour une fermeture distante propre ;
|
||||
- `TransportError` pour une erreur réseau/protocole, un timeout ou une limite dépassée.
|
||||
|
||||
Une frame Text reçue est une erreur de protocole : elle n'est jamais convertie en bytes métier.
|
||||
|
||||
## Fermeture
|
||||
|
||||
`RealtimeSender::close()` initie un close WebSocket propre et applique la deadline de fermeture configurée. Une task/future annulée n'est pas assimilée à un close handshake réussi.
|
||||
|
||||
## Smoke local
|
||||
|
||||
Le launcher de validation public utilise uniquement les API exposées par les deux crates realtime :
|
||||
|
||||
```bash
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
```
|
||||
|
||||
Il bind `127.0.0.1:0`, connecte un client réel, échange un payload binaire dans les deux sens, initie un close propre et doit terminer avec :
|
||||
|
||||
```text
|
||||
game-realtime-websocket-smoke: PASS
|
||||
```
|
||||
|
||||
Le smoke ne dépend ni d'Internet, ni d'un port fixe, ni d'un serveur externe.
|
||||
|
||||
## Limites intentionnelles
|
||||
|
||||
Cette crate n'est pas un protocole multijoueur. Authentification, versionnement wire, session joueur/room, heartbeat métier, resynchronisation, snapshots/deltas et simulation authoritative appartiennent aux couches supérieures et restent hors de son contrat.
|
||||
167
crates/common/game-realtime-websocket-lib/src/config.rs
Normal file
167
crates/common/game-realtime-websocket-lib/src/config.rs
Normal file
@@ -0,0 +1,167 @@
|
||||
// file: crates/common/game-realtime-websocket-lib/src/config.rs
|
||||
// version: 1
|
||||
|
||||
const DEFAULT_CLOSE_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(2);
|
||||
const DEFAULT_CONNECT_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(10);
|
||||
const DEFAULT_MAX_FRAME_SIZE: usize = 1024 * 1024;
|
||||
const DEFAULT_MAX_MESSAGE_SIZE: usize = 1024 * 1024;
|
||||
const DEFAULT_MAX_WRITE_BUFFER_SIZE: usize = 2 * 1024 * 1024;
|
||||
const DEFAULT_SEND_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(5);
|
||||
const DEFAULT_WRITE_BUFFER_SIZE: usize = 64 * 1024;
|
||||
|
||||
/// Product-facing limits and operation deadlines for one WebSocket connection.
|
||||
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
||||
pub struct WebSocketConfig {
|
||||
max_message_size: usize,
|
||||
max_frame_size: usize,
|
||||
write_buffer_size: usize,
|
||||
max_write_buffer_size: usize,
|
||||
connect_timeout: std::time::Duration,
|
||||
send_timeout: std::time::Duration,
|
||||
close_timeout: std::time::Duration,
|
||||
}
|
||||
|
||||
impl Default for WebSocketConfig {
|
||||
fn default() -> Self {
|
||||
return Self {
|
||||
max_message_size: DEFAULT_MAX_MESSAGE_SIZE,
|
||||
max_frame_size: DEFAULT_MAX_FRAME_SIZE,
|
||||
write_buffer_size: DEFAULT_WRITE_BUFFER_SIZE,
|
||||
max_write_buffer_size: DEFAULT_MAX_WRITE_BUFFER_SIZE,
|
||||
connect_timeout: DEFAULT_CONNECT_TIMEOUT,
|
||||
send_timeout: DEFAULT_SEND_TIMEOUT,
|
||||
close_timeout: DEFAULT_CLOSE_TIMEOUT,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
impl WebSocketConfig {
|
||||
/// Returns a copy with a different maximum binary message size.
|
||||
#[must_use]
|
||||
pub fn with_max_message_size(mut self, value: usize) -> Self {
|
||||
self.max_message_size = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns a copy with a different maximum WebSocket frame payload size.
|
||||
#[must_use]
|
||||
pub fn with_max_frame_size(mut self, value: usize) -> Self {
|
||||
self.max_frame_size = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns a copy with a different Tungstenite write-buffer target.
|
||||
#[must_use]
|
||||
pub fn with_write_buffer_size(mut self, value: usize) -> Self {
|
||||
self.write_buffer_size = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns a copy with a different hard maximum for the Tungstenite write buffer.
|
||||
#[must_use]
|
||||
pub fn with_max_write_buffer_size(mut self, value: usize) -> Self {
|
||||
self.max_write_buffer_size = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns a copy with a different connection or handshake deadline.
|
||||
#[must_use]
|
||||
pub fn with_connect_timeout(mut self, value: std::time::Duration) -> Self {
|
||||
self.connect_timeout = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns a copy with a different deadline for one send operation.
|
||||
#[must_use]
|
||||
pub fn with_send_timeout(mut self, value: std::time::Duration) -> Self {
|
||||
self.send_timeout = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns a copy with a different deadline for a clean local close operation.
|
||||
#[must_use]
|
||||
pub fn with_close_timeout(mut self, value: std::time::Duration) -> Self {
|
||||
self.close_timeout = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns the configured maximum binary message size.
|
||||
#[must_use]
|
||||
pub fn max_message_size(&self) -> usize {
|
||||
return self.max_message_size;
|
||||
}
|
||||
|
||||
/// Returns the configured maximum WebSocket frame payload size.
|
||||
#[must_use]
|
||||
pub fn max_frame_size(&self) -> usize {
|
||||
return self.max_frame_size;
|
||||
}
|
||||
|
||||
/// Returns the configured Tungstenite write-buffer target.
|
||||
#[must_use]
|
||||
pub fn write_buffer_size(&self) -> usize {
|
||||
return self.write_buffer_size;
|
||||
}
|
||||
|
||||
/// Returns the configured hard maximum for the Tungstenite write buffer.
|
||||
#[must_use]
|
||||
pub fn max_write_buffer_size(&self) -> usize {
|
||||
return self.max_write_buffer_size;
|
||||
}
|
||||
|
||||
/// Returns the configured connection or handshake deadline.
|
||||
#[must_use]
|
||||
pub fn connect_timeout(&self) -> std::time::Duration {
|
||||
return self.connect_timeout;
|
||||
}
|
||||
|
||||
/// Returns the configured deadline for one send operation.
|
||||
#[must_use]
|
||||
pub fn send_timeout(&self) -> std::time::Duration {
|
||||
return self.send_timeout;
|
||||
}
|
||||
|
||||
/// Returns the configured deadline for a clean local close operation.
|
||||
#[must_use]
|
||||
pub fn close_timeout(&self) -> std::time::Duration {
|
||||
return self.close_timeout;
|
||||
}
|
||||
|
||||
/// Validates all invariants required before creating a WebSocket endpoint or connection.
|
||||
pub fn validate(&self) -> Result<(), game_realtime_transport_lib::TransportError> {
|
||||
if self.max_message_size == 0 {
|
||||
return Err(invalid_configuration("max_message_size must be greater than zero"));
|
||||
}
|
||||
if self.max_frame_size == 0 {
|
||||
return Err(invalid_configuration("max_frame_size must be greater than zero"));
|
||||
}
|
||||
if self.max_frame_size > self.max_message_size {
|
||||
return Err(invalid_configuration("max_frame_size must not exceed max_message_size"));
|
||||
}
|
||||
let minimum_max_write_buffer_size = match self.write_buffer_size.checked_add(self.max_message_size) {
|
||||
Some(value) => value,
|
||||
None => return Err(invalid_configuration("write_buffer_size + max_message_size overflows usize")),
|
||||
};
|
||||
if self.max_write_buffer_size < minimum_max_write_buffer_size {
|
||||
return Err(invalid_configuration("max_write_buffer_size must fit write_buffer_size plus one maximum-sized message"));
|
||||
}
|
||||
if self.connect_timeout.is_zero() {
|
||||
return Err(invalid_configuration("connect_timeout must be greater than zero"));
|
||||
}
|
||||
if self.send_timeout.is_zero() {
|
||||
return Err(invalid_configuration("send_timeout must be greater than zero"));
|
||||
}
|
||||
if self.close_timeout.is_zero() {
|
||||
return Err(invalid_configuration("close_timeout must be greater than zero"));
|
||||
}
|
||||
return Ok(());
|
||||
}
|
||||
}
|
||||
|
||||
fn invalid_configuration(detail: &str) -> game_realtime_transport_lib::TransportError {
|
||||
return game_realtime_transport_lib::TransportError::new(game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration, detail);
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
#[path = "../unit_tests/config.rs"]
|
||||
mod tests;
|
||||
26
crates/common/game-realtime-websocket-lib/src/lib.rs
Normal file
26
crates/common/game-realtime-websocket-lib/src/lib.rs
Normal file
@@ -0,0 +1,26 @@
|
||||
// file: crates/common/game-realtime-websocket-lib/src/lib.rs
|
||||
// version: 2
|
||||
|
||||
#![warn(missing_docs)]
|
||||
#![deny(unreachable_pub)]
|
||||
#![forbid(unsafe_code)]
|
||||
|
||||
//! Tokio/tokio-tungstenite WebSocket backend for the games.sasedev realtime transport contract.
|
||||
|
||||
mod config;
|
||||
mod websocket;
|
||||
|
||||
/// Re-export of product-facing WebSocket limits and operation deadlines.
|
||||
pub use self::config::WebSocketConfig;
|
||||
/// Re-export of an established WebSocket transport connection.
|
||||
pub use self::websocket::WebSocketConnection;
|
||||
/// Re-export of a bound WebSocket server listener.
|
||||
pub use self::websocket::WebSocketListener;
|
||||
/// Re-export of the receive half of an established WebSocket connection.
|
||||
pub use self::websocket::WebSocketReceiver;
|
||||
/// Re-export of the send half of an established WebSocket connection.
|
||||
pub use self::websocket::WebSocketSender;
|
||||
/// Re-export of the WebSocket client connection constructor using baseline defaults.
|
||||
pub use self::websocket::connect;
|
||||
/// Re-export of the configurable WebSocket client connection constructor.
|
||||
pub use self::websocket::connect_with_config;
|
||||
411
crates/common/game-realtime-websocket-lib/src/websocket.rs
Normal file
411
crates/common/game-realtime-websocket-lib/src/websocket.rs
Normal file
@@ -0,0 +1,411 @@
|
||||
// file: crates/common/game-realtime-websocket-lib/src/websocket.rs
|
||||
// version: 2
|
||||
|
||||
use futures_util::SinkExt; // rust-rules: trait-import
|
||||
use futures_util::StreamExt; // rust-rules: trait-import
|
||||
|
||||
const TRACING_TARGET: &str = "games::realtime::websocket";
|
||||
|
||||
type ClientStream = tokio_tungstenite::WebSocketStream<tokio_tungstenite::MaybeTlsStream<tokio::net::TcpStream>>;
|
||||
type ServerStream = tokio_tungstenite::WebSocketStream<tokio::net::TcpStream>;
|
||||
type ClientSink = futures_util::stream::SplitSink<ClientStream, tokio_tungstenite::tungstenite::Message>;
|
||||
type ServerSink = futures_util::stream::SplitSink<ServerStream, tokio_tungstenite::tungstenite::Message>;
|
||||
type ClientReceiver = futures_util::stream::SplitStream<ClientStream>;
|
||||
type ServerReceiver = futures_util::stream::SplitStream<ServerStream>;
|
||||
|
||||
enum WebSocketStreamKind {
|
||||
Client(ClientStream),
|
||||
Server(ServerStream),
|
||||
}
|
||||
|
||||
enum WebSocketSinkKind {
|
||||
Client(ClientSink),
|
||||
Server(ServerSink),
|
||||
}
|
||||
|
||||
enum WebSocketReceiverKind {
|
||||
Client(ClientReceiver),
|
||||
Server(ServerReceiver),
|
||||
}
|
||||
|
||||
/// Established WebSocket connection implementing the transport-neutral realtime contract.
|
||||
pub struct WebSocketConnection {
|
||||
inner: WebSocketStreamKind,
|
||||
config: crate::WebSocketConfig,
|
||||
}
|
||||
|
||||
impl WebSocketConnection {
|
||||
fn from_client(stream: ClientStream, config: crate::WebSocketConfig) -> Self {
|
||||
return Self { inner: WebSocketStreamKind::Client(stream), config };
|
||||
}
|
||||
|
||||
fn from_server(stream: ServerStream, config: crate::WebSocketConfig) -> Self {
|
||||
return Self { inner: WebSocketStreamKind::Server(stream), config };
|
||||
}
|
||||
}
|
||||
|
||||
impl game_realtime_transport_lib::RealtimeConnection for WebSocketConnection {
|
||||
type Sender = crate::WebSocketSender;
|
||||
type Receiver = crate::WebSocketReceiver;
|
||||
|
||||
fn split(self) -> (Self::Sender, Self::Receiver) {
|
||||
let max_frame_size = self.config.max_frame_size();
|
||||
let max_message_size = self.config.max_message_size();
|
||||
let send_timeout = self.config.send_timeout();
|
||||
let close_timeout = self.config.close_timeout();
|
||||
return match self.inner {
|
||||
WebSocketStreamKind::Client(stream) => {
|
||||
let (sender, receiver) = stream.split();
|
||||
(
|
||||
crate::WebSocketSender {
|
||||
inner: WebSocketSinkKind::Client(sender),
|
||||
max_frame_size,
|
||||
max_message_size,
|
||||
send_timeout,
|
||||
close_timeout,
|
||||
send_timed_out: false,
|
||||
},
|
||||
crate::WebSocketReceiver { inner: WebSocketReceiverKind::Client(receiver) },
|
||||
)
|
||||
},
|
||||
WebSocketStreamKind::Server(stream) => {
|
||||
let (sender, receiver) = stream.split();
|
||||
(
|
||||
crate::WebSocketSender {
|
||||
inner: WebSocketSinkKind::Server(sender),
|
||||
max_frame_size,
|
||||
max_message_size,
|
||||
send_timeout,
|
||||
close_timeout,
|
||||
send_timed_out: false,
|
||||
},
|
||||
crate::WebSocketReceiver { inner: WebSocketReceiverKind::Server(receiver) },
|
||||
)
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/// Send half of an established WebSocket transport connection.
|
||||
pub struct WebSocketSender {
|
||||
inner: WebSocketSinkKind,
|
||||
max_frame_size: usize,
|
||||
max_message_size: usize,
|
||||
send_timeout: std::time::Duration,
|
||||
close_timeout: std::time::Duration,
|
||||
send_timed_out: bool,
|
||||
}
|
||||
|
||||
impl game_realtime_transport_lib::RealtimeSender for WebSocketSender {
|
||||
type SendFuture<'a>
|
||||
= futures_util::future::LocalBoxFuture<'a, Result<(), game_realtime_transport_lib::TransportError>>
|
||||
where
|
||||
Self: 'a;
|
||||
type CloseFuture<'a>
|
||||
= futures_util::future::LocalBoxFuture<'a, Result<(), game_realtime_transport_lib::TransportError>>
|
||||
where
|
||||
Self: 'a;
|
||||
|
||||
fn send(&mut self, message: game_realtime_transport_lib::TransportMessage) -> Self::SendFuture<'_> {
|
||||
return Box::pin(async move {
|
||||
if self.send_timed_out {
|
||||
return Err(game_realtime_transport_lib::TransportError::new(
|
||||
game_realtime_transport_lib::TransportErrorKind::Aborted,
|
||||
"sender is unavailable after a previous send timeout",
|
||||
));
|
||||
}
|
||||
let payload_len = message.len();
|
||||
if payload_len > self.max_message_size || payload_len > self.max_frame_size {
|
||||
let error = game_realtime_transport_lib::TransportError::new(
|
||||
game_realtime_transport_lib::TransportErrorKind::MessageTooLarge,
|
||||
format!("binary payload size {payload_len} exceeds configured message/frame maxima {}/{}", self.max_message_size, self.max_frame_size),
|
||||
);
|
||||
tracing::warn!(
|
||||
target: TRACING_TARGET,
|
||||
payload_len = payload_len,
|
||||
max_message_size = self.max_message_size,
|
||||
max_frame_size = self.max_frame_size,
|
||||
"outbound WebSocket payload rejected"
|
||||
);
|
||||
return Err(error);
|
||||
}
|
||||
let websocket_message = tokio_tungstenite::tungstenite::Message::Binary(message.into_bytes().into());
|
||||
let send_timeout = self.send_timeout;
|
||||
let send = async {
|
||||
return match &mut self.inner {
|
||||
WebSocketSinkKind::Client(sender) => sender.send(websocket_message).await,
|
||||
WebSocketSinkKind::Server(sender) => sender.send(websocket_message).await,
|
||||
};
|
||||
};
|
||||
let result = tokio::time::timeout(send_timeout, send).await;
|
||||
return match result {
|
||||
Ok(Ok(())) => {
|
||||
tracing::trace!(target: TRACING_TARGET, payload_len = payload_len, "binary WebSocket payload sent");
|
||||
Ok(())
|
||||
},
|
||||
Ok(Err(error)) => {
|
||||
let mapped = map_stream_error(error);
|
||||
tracing::warn!(target: TRACING_TARGET, kind = %mapped.kind(), detail = mapped.detail(), "WebSocket send failed");
|
||||
Err(mapped)
|
||||
},
|
||||
Err(_) => {
|
||||
self.send_timed_out = true;
|
||||
let error = timeout_error("WebSocket send", send_timeout);
|
||||
tracing::warn!(target: TRACING_TARGET, timeout_ms = duration_millis(send_timeout), "WebSocket send timed out");
|
||||
Err(error)
|
||||
},
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
fn close(&mut self) -> Self::CloseFuture<'_> {
|
||||
return Box::pin(async move {
|
||||
let close_timeout = self.close_timeout;
|
||||
let close = async {
|
||||
return match &mut self.inner {
|
||||
WebSocketSinkKind::Client(sender) => sender.close().await,
|
||||
WebSocketSinkKind::Server(sender) => sender.close().await,
|
||||
};
|
||||
};
|
||||
let result = tokio::time::timeout(close_timeout, close).await;
|
||||
return match result {
|
||||
Ok(Ok(())) => {
|
||||
tracing::debug!(target: TRACING_TARGET, "local WebSocket close initiated");
|
||||
Ok(())
|
||||
},
|
||||
Ok(Err(error)) => {
|
||||
let mapped = map_stream_error(error);
|
||||
tracing::warn!(target: TRACING_TARGET, kind = %mapped.kind(), detail = mapped.detail(), "WebSocket close failed");
|
||||
Err(mapped)
|
||||
},
|
||||
Err(_) => {
|
||||
let error = timeout_error("WebSocket close", close_timeout);
|
||||
tracing::warn!(target: TRACING_TARGET, timeout_ms = duration_millis(close_timeout), "WebSocket close timed out");
|
||||
Err(error)
|
||||
},
|
||||
};
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/// Receive half of an established WebSocket transport connection.
|
||||
pub struct WebSocketReceiver {
|
||||
inner: WebSocketReceiverKind,
|
||||
}
|
||||
|
||||
impl game_realtime_transport_lib::RealtimeReceiver for WebSocketReceiver {
|
||||
type ReceiveFuture<'a>
|
||||
= futures_util::future::LocalBoxFuture<'a, Result<game_realtime_transport_lib::TransportReceive, game_realtime_transport_lib::TransportError>>
|
||||
where
|
||||
Self: 'a;
|
||||
|
||||
fn receive(&mut self) -> Self::ReceiveFuture<'_> {
|
||||
return Box::pin(async move {
|
||||
loop {
|
||||
let next_message = match &mut self.inner {
|
||||
WebSocketReceiverKind::Client(receiver) => receiver.next().await,
|
||||
WebSocketReceiverKind::Server(receiver) => receiver.next().await,
|
||||
};
|
||||
match next_message {
|
||||
Some(Ok(tokio_tungstenite::tungstenite::Message::Binary(bytes))) => {
|
||||
tracing::trace!(target: TRACING_TARGET, payload_len = bytes.len(), "binary WebSocket payload received");
|
||||
return Ok(game_realtime_transport_lib::TransportReceive::Message(game_realtime_transport_lib::TransportMessage::new(bytes.to_vec())));
|
||||
},
|
||||
Some(Ok(tokio_tungstenite::tungstenite::Message::Close(_))) => {
|
||||
tracing::debug!(target: TRACING_TARGET, "remote WebSocket close observed");
|
||||
return Ok(game_realtime_transport_lib::TransportReceive::Closed);
|
||||
},
|
||||
Some(Ok(tokio_tungstenite::tungstenite::Message::Ping(_))) | Some(Ok(tokio_tungstenite::tungstenite::Message::Pong(_))) => {},
|
||||
Some(Ok(tokio_tungstenite::tungstenite::Message::Text(_))) => {
|
||||
let error = game_realtime_transport_lib::TransportError::new(
|
||||
game_realtime_transport_lib::TransportErrorKind::Protocol,
|
||||
"text WebSocket messages are not part of the binary transport contract",
|
||||
);
|
||||
tracing::warn!(target: TRACING_TARGET, kind = %error.kind(), "unsupported WebSocket text message received");
|
||||
return Err(error);
|
||||
},
|
||||
Some(Ok(tokio_tungstenite::tungstenite::Message::Frame(_))) => {
|
||||
let error = game_realtime_transport_lib::TransportError::new(
|
||||
game_realtime_transport_lib::TransportErrorKind::Protocol,
|
||||
"unexpected raw WebSocket frame surfaced by the backend",
|
||||
);
|
||||
tracing::warn!(target: TRACING_TARGET, kind = %error.kind(), "unexpected raw WebSocket frame received");
|
||||
return Err(error);
|
||||
},
|
||||
Some(Err(error)) => {
|
||||
let mapped = map_stream_error(error);
|
||||
tracing::warn!(target: TRACING_TARGET, kind = %mapped.kind(), detail = mapped.detail(), "WebSocket receive failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
None => {
|
||||
tracing::debug!(target: TRACING_TARGET, "WebSocket stream ended");
|
||||
return Ok(game_realtime_transport_lib::TransportReceive::Closed);
|
||||
},
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/// Bound TCP listener that upgrades accepted peers to WebSocket connections.
|
||||
pub struct WebSocketListener {
|
||||
listener: tokio::net::TcpListener,
|
||||
local_addr: std::net::SocketAddr,
|
||||
config: crate::WebSocketConfig,
|
||||
}
|
||||
|
||||
impl WebSocketListener {
|
||||
/// Binds a WebSocket listener with the baseline configuration.
|
||||
pub async fn bind(address: std::net::SocketAddr) -> Result<Self, game_realtime_transport_lib::TransportError> {
|
||||
return Self::bind_with_config(address, crate::WebSocketConfig::default()).await;
|
||||
}
|
||||
|
||||
/// Binds a WebSocket listener with explicit product-facing limits and deadlines.
|
||||
pub async fn bind_with_config(address: std::net::SocketAddr, config: crate::WebSocketConfig) -> Result<Self, game_realtime_transport_lib::TransportError> {
|
||||
if let Err(error) = config.validate() {
|
||||
return Err(error);
|
||||
}
|
||||
let listener = match tokio::net::TcpListener::bind(address).await {
|
||||
Ok(value) => value,
|
||||
Err(error) => {
|
||||
let mapped = game_realtime_transport_lib::TransportError::new(game_realtime_transport_lib::TransportErrorKind::Bind, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, address = %address, detail = mapped.detail(), "WebSocket listener bind failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
};
|
||||
let local_addr = match listener.local_addr() {
|
||||
Ok(value) => value,
|
||||
Err(error) => {
|
||||
let mapped = game_realtime_transport_lib::TransportError::new(game_realtime_transport_lib::TransportErrorKind::Bind, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, detail = mapped.detail(), "bound WebSocket listener address lookup failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
};
|
||||
tracing::info!(target: TRACING_TARGET, address = %local_addr, "WebSocket listener bound");
|
||||
return Ok(Self { listener, local_addr, config });
|
||||
}
|
||||
|
||||
/// Returns the concrete local socket address, including an ephemeral port selected by the OS.
|
||||
#[must_use]
|
||||
pub fn local_addr(&self) -> std::net::SocketAddr {
|
||||
return self.local_addr;
|
||||
}
|
||||
|
||||
/// Accepts one TCP peer and completes a bounded server-side WebSocket handshake.
|
||||
pub async fn accept(&self) -> Result<crate::WebSocketConnection, game_realtime_transport_lib::TransportError> {
|
||||
let (stream, peer_addr) = match self.listener.accept().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => {
|
||||
let mapped = game_realtime_transport_lib::TransportError::new(game_realtime_transport_lib::TransportErrorKind::Accept, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, detail = mapped.detail(), "WebSocket TCP accept failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
};
|
||||
let handshake = tokio_tungstenite::accept_async_with_config(stream, Some(tungstenite_config(&self.config)));
|
||||
let result = tokio::time::timeout(self.config.connect_timeout(), handshake).await;
|
||||
let websocket = match result {
|
||||
Ok(Ok(value)) => value,
|
||||
Ok(Err(error)) => {
|
||||
let mapped = game_realtime_transport_lib::TransportError::new(game_realtime_transport_lib::TransportErrorKind::Accept, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, peer = %peer_addr, detail = mapped.detail(), "WebSocket server handshake failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
Err(_) => {
|
||||
let error = timeout_error("WebSocket server handshake", self.config.connect_timeout());
|
||||
tracing::warn!(target: TRACING_TARGET, peer = %peer_addr, timeout_ms = duration_millis(self.config.connect_timeout()), "WebSocket server handshake timed out");
|
||||
return Err(error);
|
||||
},
|
||||
};
|
||||
tracing::info!(target: TRACING_TARGET, peer = %peer_addr, "WebSocket peer accepted");
|
||||
return Ok(crate::WebSocketConnection::from_server(websocket, self.config));
|
||||
}
|
||||
}
|
||||
|
||||
/// Connects a client to one plain `ws://` endpoint with the baseline configuration.
|
||||
pub async fn connect(endpoint: &str) -> Result<crate::WebSocketConnection, game_realtime_transport_lib::TransportError> {
|
||||
return crate::connect_with_config(endpoint, crate::WebSocketConfig::default()).await;
|
||||
}
|
||||
|
||||
/// Connects a client to one plain `ws://` endpoint with explicit limits and deadlines.
|
||||
pub async fn connect_with_config(
|
||||
endpoint: &str,
|
||||
config: crate::WebSocketConfig,
|
||||
) -> Result<crate::WebSocketConnection, game_realtime_transport_lib::TransportError> {
|
||||
if !endpoint.starts_with("ws://") {
|
||||
return Err(game_realtime_transport_lib::TransportError::new(
|
||||
game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration,
|
||||
"the baseline WebSocket backend accepts only ws:// endpoints",
|
||||
));
|
||||
}
|
||||
if let Err(error) = config.validate() {
|
||||
return Err(error);
|
||||
}
|
||||
tracing::debug!(target: TRACING_TARGET, endpoint = endpoint, "connecting WebSocket client");
|
||||
let handshake = tokio_tungstenite::connect_async_with_config(endpoint, Some(tungstenite_config(&config)), false);
|
||||
let result = tokio::time::timeout(config.connect_timeout(), handshake).await;
|
||||
let (stream, _) = match result {
|
||||
Ok(Ok(value)) => value,
|
||||
Ok(Err(error)) => {
|
||||
let mapped = map_connect_error(error);
|
||||
tracing::warn!(
|
||||
target: TRACING_TARGET,
|
||||
endpoint = endpoint,
|
||||
kind = %mapped.kind(),
|
||||
detail = mapped.detail(),
|
||||
"WebSocket client connect failed"
|
||||
);
|
||||
return Err(mapped);
|
||||
},
|
||||
Err(_) => {
|
||||
let error = timeout_error("WebSocket client connect", config.connect_timeout());
|
||||
tracing::warn!(target: TRACING_TARGET, endpoint = endpoint, timeout_ms = duration_millis(config.connect_timeout()), "WebSocket client connect timed out");
|
||||
return Err(error);
|
||||
},
|
||||
};
|
||||
tracing::info!(target: TRACING_TARGET, endpoint = endpoint, "WebSocket client connected");
|
||||
return Ok(crate::WebSocketConnection::from_client(stream, config));
|
||||
}
|
||||
|
||||
fn tungstenite_config(config: &crate::WebSocketConfig) -> tokio_tungstenite::tungstenite::protocol::WebSocketConfig {
|
||||
return tokio_tungstenite::tungstenite::protocol::WebSocketConfig::default()
|
||||
.write_buffer_size(config.write_buffer_size())
|
||||
.max_write_buffer_size(config.max_write_buffer_size())
|
||||
.max_message_size(Some(config.max_message_size()))
|
||||
.max_frame_size(Some(config.max_frame_size()));
|
||||
}
|
||||
|
||||
fn timeout_error(operation: &str, timeout: std::time::Duration) -> game_realtime_transport_lib::TransportError {
|
||||
return game_realtime_transport_lib::TransportError::new(
|
||||
game_realtime_transport_lib::TransportErrorKind::Timeout,
|
||||
format!("{operation} exceeded configured deadline of {} ms", duration_millis(timeout)),
|
||||
);
|
||||
}
|
||||
|
||||
fn duration_millis(duration: std::time::Duration) -> u128 {
|
||||
return duration.as_millis();
|
||||
}
|
||||
|
||||
fn map_connect_error(error: tokio_tungstenite::tungstenite::Error) -> game_realtime_transport_lib::TransportError {
|
||||
let kind = match &error {
|
||||
tokio_tungstenite::tungstenite::Error::Url(_) => game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration,
|
||||
_ => game_realtime_transport_lib::TransportErrorKind::Connect,
|
||||
};
|
||||
return game_realtime_transport_lib::TransportError::new(kind, error.to_string());
|
||||
}
|
||||
|
||||
fn map_stream_error(error: tokio_tungstenite::tungstenite::Error) -> game_realtime_transport_lib::TransportError {
|
||||
let kind = match &error {
|
||||
tokio_tungstenite::tungstenite::Error::ConnectionClosed | tokio_tungstenite::tungstenite::Error::AlreadyClosed => {
|
||||
game_realtime_transport_lib::TransportErrorKind::Closed
|
||||
},
|
||||
tokio_tungstenite::tungstenite::Error::Io(_) => game_realtime_transport_lib::TransportErrorKind::Io,
|
||||
tokio_tungstenite::tungstenite::Error::Capacity(_) => game_realtime_transport_lib::TransportErrorKind::MessageTooLarge,
|
||||
tokio_tungstenite::tungstenite::Error::WriteBufferFull(_) => game_realtime_transport_lib::TransportErrorKind::Backpressure,
|
||||
_ => game_realtime_transport_lib::TransportErrorKind::Protocol,
|
||||
};
|
||||
return game_realtime_transport_lib::TransportError::new(kind, error.to_string());
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
#[path = "../unit_tests/websocket.rs"]
|
||||
mod tests;
|
||||
62
crates/common/game-realtime-websocket-lib/tests/loopback.rs
Normal file
62
crates/common/game-realtime-websocket-lib/tests/loopback.rs
Normal file
@@ -0,0 +1,62 @@
|
||||
// file: crates/common/game-realtime-websocket-lib/tests/loopback.rs
|
||||
// version: 1
|
||||
|
||||
//! Deterministic localhost proof for the Tokio/tokio-tungstenite backend.
|
||||
|
||||
use game_realtime_transport_lib::RealtimeConnection; // rust-rules: trait-import
|
||||
use game_realtime_transport_lib::RealtimeReceiver; // rust-rules: trait-import
|
||||
use game_realtime_transport_lib::RealtimeSender; // rust-rules: trait-import
|
||||
|
||||
const TEST_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(3);
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn binary_round_trip_and_clean_close_work_on_loopback() {
|
||||
let bind_address = std::net::SocketAddr::from(([127, 0, 0, 1], 0));
|
||||
let listener = match game_realtime_websocket_lib::WebSocketListener::bind(bind_address).await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("loopback listener bind failed: {error}"),
|
||||
};
|
||||
let endpoint = format!("ws://{}/", listener.local_addr());
|
||||
let pair = tokio::time::timeout(TEST_TIMEOUT, async {
|
||||
return tokio::join!(listener.accept(), game_realtime_websocket_lib::connect(endpoint.as_str()));
|
||||
})
|
||||
.await;
|
||||
let (server_connection, client_connection) = match pair {
|
||||
Ok((Ok(server), Ok(client))) => (server, client),
|
||||
Ok((_server, _client)) => panic!("loopback connection establishment failed"),
|
||||
Err(_) => panic!("loopback connection establishment timed out"),
|
||||
};
|
||||
let (mut server_sender, mut server_receiver) = server_connection.split();
|
||||
let (mut client_sender, mut client_receiver) = client_connection.split();
|
||||
let client_payload = game_realtime_transport_lib::TransportMessage::new(vec![0, 1, 2, 3, 255]);
|
||||
let client_send = tokio::time::timeout(TEST_TIMEOUT, client_sender.send(client_payload)).await;
|
||||
assert!(matches!(client_send, Ok(Ok(()))));
|
||||
let server_receive = tokio::time::timeout(TEST_TIMEOUT, server_receiver.receive()).await;
|
||||
match server_receive {
|
||||
Ok(Ok(received)) => assert_eq!(
|
||||
received,
|
||||
game_realtime_transport_lib::TransportReceive::Message(game_realtime_transport_lib::TransportMessage::new(vec![0, 1, 2, 3, 255]))
|
||||
),
|
||||
Ok(Err(error)) => panic!("server receive failed: {error}"),
|
||||
Err(_) => panic!("server receive timed out"),
|
||||
}
|
||||
let server_payload = game_realtime_transport_lib::TransportMessage::new(vec![9, 8, 7, 6]);
|
||||
let server_send = tokio::time::timeout(TEST_TIMEOUT, server_sender.send(server_payload)).await;
|
||||
assert!(matches!(server_send, Ok(Ok(()))));
|
||||
let client_receive = tokio::time::timeout(TEST_TIMEOUT, client_receiver.receive()).await;
|
||||
match client_receive {
|
||||
Ok(Ok(received)) => {
|
||||
assert_eq!(received, game_realtime_transport_lib::TransportReceive::Message(game_realtime_transport_lib::TransportMessage::new(vec![9, 8, 7, 6])))
|
||||
},
|
||||
Ok(Err(error)) => panic!("client receive failed: {error}"),
|
||||
Err(_) => panic!("client receive timed out"),
|
||||
}
|
||||
let client_close = tokio::time::timeout(TEST_TIMEOUT, client_sender.close()).await;
|
||||
assert!(matches!(client_close, Ok(Ok(()))));
|
||||
let server_close_observation = tokio::time::timeout(TEST_TIMEOUT, server_receiver.receive()).await;
|
||||
match server_close_observation {
|
||||
Ok(Ok(received)) => assert_eq!(received, game_realtime_transport_lib::TransportReceive::Closed),
|
||||
Ok(Err(error)) => panic!("server close observation failed: {error}"),
|
||||
Err(_) => panic!("server close observation timed out"),
|
||||
};
|
||||
}
|
||||
134
crates/common/game-realtime-websocket-lib/tests/robustness.rs
Normal file
134
crates/common/game-realtime-websocket-lib/tests/robustness.rs
Normal file
@@ -0,0 +1,134 @@
|
||||
// file: crates/common/game-realtime-websocket-lib/tests/robustness.rs
|
||||
// version: 1
|
||||
|
||||
//! Negative and bounded lifecycle tests for the WebSocket transport backend.
|
||||
|
||||
use futures_util::SinkExt; // rust-rules: trait-import
|
||||
use game_realtime_transport_lib::RealtimeConnection; // rust-rules: trait-import
|
||||
use game_realtime_transport_lib::RealtimeReceiver; // rust-rules: trait-import
|
||||
use game_realtime_transport_lib::RealtimeSender; // rust-rules: trait-import
|
||||
|
||||
const SMALL_MESSAGE_LIMIT: usize = 32;
|
||||
const TEST_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(3);
|
||||
|
||||
type RawClient = tokio_tungstenite::WebSocketStream<tokio_tungstenite::MaybeTlsStream<tokio::net::TcpStream>>;
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn outbound_payload_over_the_configured_limit_is_rejected_before_write() {
|
||||
let config = small_message_config();
|
||||
let (server_connection, client_connection) = establish_backend_pair(config).await;
|
||||
let (_server_sender, _server_receiver) = server_connection.split();
|
||||
let (mut client_sender, _client_receiver) = client_connection.split();
|
||||
let oversized = game_realtime_transport_lib::TransportMessage::new(vec![7; SMALL_MESSAGE_LIMIT + 1]);
|
||||
let result = client_sender.send(oversized).await;
|
||||
match result {
|
||||
Ok(()) => panic!("oversized outbound payload was accepted"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::MessageTooLarge),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn inbound_payload_over_the_configured_limit_is_rejected_by_tungstenite() {
|
||||
let config = small_message_config();
|
||||
let (server_connection, mut raw_client) = establish_backend_server_with_raw_client(config).await;
|
||||
let (_server_sender, mut server_receiver) = server_connection.split();
|
||||
let send = raw_client.send(tokio_tungstenite::tungstenite::Message::binary(vec![3; SMALL_MESSAGE_LIMIT + 1])).await;
|
||||
assert!(send.is_ok());
|
||||
let receive = tokio::time::timeout(TEST_TIMEOUT, server_receiver.receive()).await;
|
||||
match receive {
|
||||
Ok(Ok(value)) => panic!("oversized inbound payload produced a successful receive: {value:?}"),
|
||||
Ok(Err(error)) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::MessageTooLarge),
|
||||
Err(_) => panic!("oversized inbound payload did not complete within the test timeout"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn text_message_is_rejected_by_the_binary_transport_contract() {
|
||||
let (server_connection, mut raw_client) = establish_backend_server_with_raw_client(game_realtime_websocket_lib::WebSocketConfig::default()).await;
|
||||
let (_server_sender, mut server_receiver) = server_connection.split();
|
||||
let send = raw_client.send(tokio_tungstenite::tungstenite::Message::text("text is outside the transport contract")).await;
|
||||
assert!(send.is_ok());
|
||||
let receive = tokio::time::timeout(TEST_TIMEOUT, server_receiver.receive()).await;
|
||||
match receive {
|
||||
Ok(Ok(value)) => panic!("text message produced a successful receive: {value:?}"),
|
||||
Ok(Err(error)) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::Protocol),
|
||||
Err(_) => panic!("text-message rejection did not complete within the test timeout"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn peer_drop_without_close_handshake_is_reported_as_protocol_failure() {
|
||||
let (server_connection, raw_client) = establish_backend_server_with_raw_client(game_realtime_websocket_lib::WebSocketConfig::default()).await;
|
||||
let (_server_sender, mut server_receiver) = server_connection.split();
|
||||
drop(raw_client);
|
||||
let receive = tokio::time::timeout(TEST_TIMEOUT, server_receiver.receive()).await;
|
||||
match receive {
|
||||
Ok(Ok(value)) => panic!("abrupt peer drop was reported as a successful receive: {value:?}"),
|
||||
Ok(Err(error)) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::Protocol),
|
||||
Err(_) => panic!("abrupt peer drop was not observed within the test timeout"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn silent_tcp_peer_hits_the_server_handshake_deadline() {
|
||||
let config = game_realtime_websocket_lib::WebSocketConfig::default().with_connect_timeout(std::time::Duration::from_millis(50));
|
||||
let bind_address = std::net::SocketAddr::from(([127, 0, 0, 1], 0));
|
||||
let listener = match game_realtime_websocket_lib::WebSocketListener::bind_with_config(bind_address, config).await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("bounded listener bind failed: {error}"),
|
||||
};
|
||||
let _silent_peer = match tokio::net::TcpStream::connect(listener.local_addr()).await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("silent TCP peer connection failed: {error}"),
|
||||
};
|
||||
let accept = tokio::time::timeout(TEST_TIMEOUT, listener.accept()).await;
|
||||
match accept {
|
||||
Ok(Ok(_connection)) => panic!("silent TCP peer unexpectedly completed a WebSocket handshake"),
|
||||
Ok(Err(error)) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::Timeout),
|
||||
Err(_) => panic!("server handshake timeout did not fire within the outer test timeout"),
|
||||
}
|
||||
}
|
||||
|
||||
fn small_message_config() -> game_realtime_websocket_lib::WebSocketConfig {
|
||||
return game_realtime_websocket_lib::WebSocketConfig::default().with_max_message_size(SMALL_MESSAGE_LIMIT).with_max_frame_size(SMALL_MESSAGE_LIMIT);
|
||||
}
|
||||
|
||||
async fn establish_backend_pair(
|
||||
config: game_realtime_websocket_lib::WebSocketConfig,
|
||||
) -> (game_realtime_websocket_lib::WebSocketConnection, game_realtime_websocket_lib::WebSocketConnection) {
|
||||
let bind_address = std::net::SocketAddr::from(([127, 0, 0, 1], 0));
|
||||
let listener = match game_realtime_websocket_lib::WebSocketListener::bind_with_config(bind_address, config).await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("loopback listener bind failed: {error}"),
|
||||
};
|
||||
let endpoint = format!("ws://{}/", listener.local_addr());
|
||||
let pair = tokio::time::timeout(TEST_TIMEOUT, async {
|
||||
return tokio::join!(listener.accept(), game_realtime_websocket_lib::connect_with_config(endpoint.as_str(), config));
|
||||
})
|
||||
.await;
|
||||
return match pair {
|
||||
Ok((Ok(server), Ok(client))) => (server, client),
|
||||
Ok((_server, _client)) => panic!("loopback connection establishment failed"),
|
||||
Err(_) => panic!("loopback connection establishment timed out"),
|
||||
};
|
||||
}
|
||||
|
||||
async fn establish_backend_server_with_raw_client(
|
||||
config: game_realtime_websocket_lib::WebSocketConfig,
|
||||
) -> (game_realtime_websocket_lib::WebSocketConnection, RawClient) {
|
||||
let bind_address = std::net::SocketAddr::from(([127, 0, 0, 1], 0));
|
||||
let listener = match game_realtime_websocket_lib::WebSocketListener::bind_with_config(bind_address, config).await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("loopback listener bind failed: {error}"),
|
||||
};
|
||||
let endpoint = format!("ws://{}/", listener.local_addr());
|
||||
let pair = tokio::time::timeout(TEST_TIMEOUT, async {
|
||||
return tokio::join!(listener.accept(), tokio_tungstenite::connect_async(endpoint.as_str()));
|
||||
})
|
||||
.await;
|
||||
return match pair {
|
||||
Ok((Ok(server), Ok((client, _response)))) => (server, client),
|
||||
Ok((_server, _client)) => panic!("raw-client loopback connection establishment failed"),
|
||||
Err(_) => panic!("raw-client loopback connection establishment timed out"),
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
// file: crates/common/game-realtime-websocket-lib/unit_tests/config.rs
|
||||
// version: 1
|
||||
|
||||
#[test]
|
||||
fn default_configuration_matches_the_product_baseline() {
|
||||
let config = crate::WebSocketConfig::default();
|
||||
assert_eq!(config.max_message_size(), 1024 * 1024);
|
||||
assert_eq!(config.max_frame_size(), 1024 * 1024);
|
||||
assert_eq!(config.write_buffer_size(), 64 * 1024);
|
||||
assert_eq!(config.max_write_buffer_size(), 2 * 1024 * 1024);
|
||||
assert_eq!(config.connect_timeout(), std::time::Duration::from_secs(10));
|
||||
assert_eq!(config.send_timeout(), std::time::Duration::from_secs(5));
|
||||
assert_eq!(config.close_timeout(), std::time::Duration::from_secs(2));
|
||||
assert!(config.validate().is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn invalid_message_and_write_buffer_bounds_are_rejected() {
|
||||
let zero_message = crate::WebSocketConfig::default().with_max_message_size(0);
|
||||
assert_invalid_configuration(zero_message);
|
||||
let oversized_frame = crate::WebSocketConfig::default().with_max_frame_size(2 * 1024 * 1024);
|
||||
assert_invalid_configuration(oversized_frame);
|
||||
let insufficient_write_buffer = crate::WebSocketConfig::default().with_max_write_buffer_size(1024 * 1024);
|
||||
assert_invalid_configuration(insufficient_write_buffer);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn zero_operation_deadlines_are_rejected() {
|
||||
assert_invalid_configuration(crate::WebSocketConfig::default().with_connect_timeout(std::time::Duration::ZERO));
|
||||
assert_invalid_configuration(crate::WebSocketConfig::default().with_send_timeout(std::time::Duration::ZERO));
|
||||
assert_invalid_configuration(crate::WebSocketConfig::default().with_close_timeout(std::time::Duration::ZERO));
|
||||
}
|
||||
|
||||
fn assert_invalid_configuration(config: crate::WebSocketConfig) {
|
||||
let result = config.validate();
|
||||
match result {
|
||||
Ok(()) => panic!("invalid WebSocket configuration was accepted"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration),
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
// file: crates/common/game-realtime-websocket-lib/unit_tests/websocket.rs
|
||||
// version: 1
|
||||
|
||||
#[test]
|
||||
fn tungstenite_backpressure_maps_to_transport_backpressure() {
|
||||
let message = tokio_tungstenite::tungstenite::Message::Binary(vec![1, 2, 3].into());
|
||||
let backend_error = tokio_tungstenite::tungstenite::Error::WriteBufferFull(Box::new(message));
|
||||
let mapped = super::map_stream_error(backend_error);
|
||||
assert_eq!(mapped.kind(), game_realtime_transport_lib::TransportErrorKind::Backpressure);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tungstenite_capacity_maps_to_message_too_large() {
|
||||
let capacity = tokio_tungstenite::tungstenite::error::CapacityError::MessageTooLong { size: 65, max_size: 64 };
|
||||
let backend_error = tokio_tungstenite::tungstenite::Error::Capacity(capacity);
|
||||
let mapped = super::map_stream_error(backend_error);
|
||||
assert_eq!(mapped.kind(), game_realtime_transport_lib::TransportErrorKind::MessageTooLarge);
|
||||
}
|
||||
25
crates/common/game-realtime-webtransport-lib/Cargo.toml
Normal file
25
crates/common/game-realtime-webtransport-lib/Cargo.toml
Normal file
@@ -0,0 +1,25 @@
|
||||
# file: crates/common/game-realtime-webtransport-lib/Cargo.toml
|
||||
# version: 2
|
||||
|
||||
[package]
|
||||
name = "game-realtime-webtransport-lib"
|
||||
version.workspace = true
|
||||
edition.workspace = true
|
||||
license.workspace = true
|
||||
repository.workspace = true
|
||||
authors.workspace = true
|
||||
publish.workspace = true
|
||||
|
||||
[dependencies]
|
||||
game-realtime-transport-lib = { path = "../game-realtime-transport-lib" }
|
||||
rcgen = { workspace = true, features = ["ring"] }
|
||||
tokio = { workspace = true, features = ["time"] }
|
||||
tracing.workspace = true
|
||||
url.workspace = true
|
||||
web-transport-quinn = { workspace = true, features = ["ring"] }
|
||||
|
||||
[dev-dependencies]
|
||||
tokio = { workspace = true, features = ["macros", "rt", "time"] }
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
110
crates/common/game-realtime-webtransport-lib/README.md
Normal file
110
crates/common/game-realtime-webtransport-lib/README.md
Normal file
@@ -0,0 +1,110 @@
|
||||
<!-- file: crates/common/game-realtime-webtransport-lib/README.md -->
|
||||
<!-- version: 3 -->
|
||||
|
||||
# game-realtime-webtransport-lib
|
||||
|
||||
Backend WebTransport/QUIC candidat pour le realtime de `games.sasedev`.
|
||||
|
||||
## Responsabilité
|
||||
|
||||
La crate possède le transport WebTransport concret sans introduire de sémantique gameplay, room, joueur, tick ou snapshot. Son chemin natif repose sur `web-transport-quinn` et conserve les erreurs publiques dans `game-realtime-transport-lib`.
|
||||
|
||||
La frontière native disponible couvre désormais :
|
||||
|
||||
- configuration client HTTPS avec pin SHA-256 exact ;
|
||||
- identité serveur X.509 DER + clé privée PKCS#8 DER injectables ;
|
||||
- génération locale d'une identité self-signed ECDSA P-256 à validité courte pour `localhost`, IPv4 loopback et IPv6 loopback ;
|
||||
- bind UDP/QUIC sur adresse explicite ou port éphémère ;
|
||||
- établissement HTTP/3 WebTransport client/server natif ;
|
||||
- sélection d'un unique stream bidirectionnel fiable comme chemin realtime principal ;
|
||||
- framing privé `u32` big-endian + payload binaire ;
|
||||
- limite de message configurable, 1 MiB par défaut, vérifiée avant allocation côté réception et avant écriture côté émission ;
|
||||
- deadlines configurables pour la connexion, l'ouverture/accept du stream primaire et un envoi complet ;
|
||||
- adaptation `RealtimeConnection` / `RealtimeSender` / `RealtimeReceiver` ;
|
||||
- FIN propre via `RealtimeSender::close()` ;
|
||||
- reset/STOP_SENDING backend-spécifiques via `WebTransportSender::abort(...)` et `WebTransportReceiver::abort(...)` ;
|
||||
- cancellation/drop terminale : un sender abandonné est reset plutôt que transformé implicitement en FIN ;
|
||||
- parseur de framing réception incrémental conservant son état si une future `receive()` est annulée ;
|
||||
- mapping stable des erreurs reset/close/session/protocole vers `TransportErrorKind` ;
|
||||
- tracing sous `games::realtime::webtransport`.
|
||||
|
||||
## TLS de développement
|
||||
|
||||
`WebTransportServerIdentity::generate_loopback()` crée une identité en mémoire. La clé privée n'est ni écrite ni versionnée. Le certificat est valide sept jours, avec une petite marge de clock skew, et son SHA-256 est exposé à travers `WebTransportCertificateHash` afin que le client puisse utiliser le pinning fourni par `web-transport-quinn`.
|
||||
|
||||
Une identité préexistante peut être injectée en DER avec `WebTransportServerIdentity::from_pkcs8_der(...)`. La compatibilité certificat/clé est alors vérifiée par le builder TLS au bind du serveur.
|
||||
|
||||
Aucune option de désactivation globale de la vérification TLS n'est exposée.
|
||||
|
||||
## Stream fiable principal
|
||||
|
||||
Une session WebTransport établie n'est pas encore le contrat realtime lui-même. Le client appelle `WebTransportSession::open_primary_connection()` ; le serveur appelle `WebTransportSession::accept_primary_connection()`.
|
||||
|
||||
Le chemin logique devient ensuite :
|
||||
|
||||
```text
|
||||
one WebTransport session
|
||||
-> one primary bidirectional reliable stream
|
||||
-> u32 big-endian payload length
|
||||
-> payload bytes
|
||||
```
|
||||
|
||||
`open_primary_connection()` écrit déjà l'en-tête de stream WebTransport requis par HTTP/3 avant de retourner. Le pair peut donc terminer `accept_primary_connection()` avant l'envoi de la première frame applicative ; aucun préambule propre à games.sasedev n'est nécessaire.
|
||||
|
||||
`RealtimeConnection::split()` conserve la session WebTransport dans les deux moitiés afin que la session ne soit pas fermée au moment où l'objet connexion est consommé.
|
||||
|
||||
## Limites et deadlines
|
||||
|
||||
`WebTransportConfig::default()` conserve la baseline de 1 MiB par message. La limite peut être réduite ou augmentée tant qu'elle reste strictement positive et représentable dans le champ de longueur `u32` du framing.
|
||||
|
||||
Les deadlines configurables couvrent :
|
||||
|
||||
- connexion client et réponse finale à une requête WebTransport déjà surfacée côté serveur ;
|
||||
- ouverture ou accept du stream bidirectionnel principal ;
|
||||
- écriture complète header + payload d'une frame.
|
||||
|
||||
L'attente d'un nouveau pair sur le listener reste volontairement non bornée : un serveur inactif ne doit pas produire périodiquement une erreur uniquement parce qu'aucun client ne se présente.
|
||||
|
||||
QUIC applique sa propre flow-control. Le backend n'ajoute pas une seconde file applicative : si un envoi reste bloqué par flow-control/réseau au-delà de `send_timeout`, l'opération retourne `TransportErrorKind::Timeout` et le stream est reset afin qu'une frame partiellement transmise ne puisse pas être suivie d'une nouvelle frame invalide.
|
||||
|
||||
## Lifecycle, abort et cancellation
|
||||
|
||||
`RealtimeSender::close()` reste la fermeture propre de la direction d'émission et produit un FIN. À l'inverse :
|
||||
|
||||
- `WebTransportSender::abort(code)` envoie un `RESET_STREAM` WebTransport ;
|
||||
- `WebTransportReceiver::abort(code)` envoie un `STOP_SENDING` WebTransport ;
|
||||
- dropper un `WebTransportSender` encore actif provoque un reset explicite ;
|
||||
- dropper un `WebTransportReceiver` encore actif provoque un stop explicite ;
|
||||
- annuler une future `send()` en cours provoque également un reset via une garde de cancellation.
|
||||
|
||||
Une erreur terminale de lecture/écriture rend la moitié concernée indisponible pour une réutilisation silencieuse.
|
||||
|
||||
La réception n'utilise plus une lecture exacte monolithique. Le header et le payload sont lus progressivement avec l'API de lecture cancel-safe de Quinn ; `header_read`/`payload_read` restent dans le receiver. Une future `receive()` annulée peut donc être relancée sans perdre les octets déjà consommés ni décaler le framing.
|
||||
|
||||
## Mapping d'erreurs
|
||||
|
||||
Le backend distingue notamment :
|
||||
|
||||
- payload hors limite -> `MessageTooLarge` ;
|
||||
- reset/STOP_SENDING valide -> `Aborted` ;
|
||||
- stream déjà fermé -> `Closed` ;
|
||||
- fermeture de session WebTransport explicite -> `Closed` ;
|
||||
- erreur de session/connexion non classée comme fermeture propre -> `Io` ;
|
||||
- reset/stop invalide ou framing tronqué -> `Protocol` ;
|
||||
- deadline dépassée -> `Timeout`.
|
||||
|
||||
Une longueur entrante hors limite ou un framing tronqué provoque aussi l'arrêt de la direction de réception afin d'éviter de poursuivre sur un flux désynchronisé.
|
||||
|
||||
## Frontières actuelles
|
||||
|
||||
La crate ne possède toujours pas :
|
||||
|
||||
- d'API datagram transport-neutral ;
|
||||
- de chemin navigateur/WASM ;
|
||||
- de smoke executable public WebTransport ;
|
||||
- de fallback WebSocket ;
|
||||
- de benchmark WebSocket/WebTransport.
|
||||
|
||||
Ces responsabilités restent réservées aux tranches suivantes du plan `0.3.5`.
|
||||
|
||||
Le chemin natif s'exécute sous un runtime Tokio fourni par le consommateur ; la crate ne crée ni runtime ni thread privé. Le chemin navigateur/WASM est distinct : aucun `cfg` WASM ni dépendance navigateur n'est requis par le backend natif actuel.
|
||||
130
crates/common/game-realtime-webtransport-lib/USAGE.md
Normal file
130
crates/common/game-realtime-webtransport-lib/USAGE.md
Normal file
@@ -0,0 +1,130 @@
|
||||
<!-- file: crates/common/game-realtime-webtransport-lib/USAGE.md -->
|
||||
<!-- version: 2 -->
|
||||
|
||||
# Utilisation de game-realtime-webtransport-lib
|
||||
|
||||
Ce guide décrit le chemin natif fiable exposé par `game-realtime-webtransport-lib`. Il ne décrit ni gameplay, ni protocole wire métier, ni datagrams.
|
||||
|
||||
## Configuration transport
|
||||
|
||||
`WebTransportConfig` porte les limites et deadlines du chemin fiable. La configuration par défaut garde une limite de 1 MiB par message et des deadlines bornées pour connexion, stream primaire et send.
|
||||
|
||||
Exemple de configuration plus stricte :
|
||||
|
||||
```rust
|
||||
let transport = game_realtime_webtransport_lib::WebTransportConfig::default()
|
||||
.with_max_message_size(256 * 1024)
|
||||
.with_connect_timeout(std::time::Duration::from_secs(5))
|
||||
.with_primary_stream_timeout(std::time::Duration::from_secs(2))
|
||||
.with_send_timeout(std::time::Duration::from_secs(2));
|
||||
```
|
||||
|
||||
La validation effective se fait lors du bind serveur ou de la connexion client. Une limite nulle, une limite non représentable en `u32` ou une deadline nulle est rejetée comme `InvalidConfiguration`.
|
||||
|
||||
## Serveur natif
|
||||
|
||||
Créer d'abord l'identité TLS et le listener :
|
||||
|
||||
```rust
|
||||
let identity = match game_realtime_webtransport_lib::WebTransportServerIdentity::generate_loopback() {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
let config = game_realtime_webtransport_lib::WebTransportServerConfig::new(
|
||||
std::net::SocketAddr::from(([127, 0, 0, 1], 4433)),
|
||||
identity,
|
||||
)
|
||||
.with_transport_config(transport);
|
||||
let mut listener = match game_realtime_webtransport_lib::WebTransportListener::bind(config) {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
let session = match listener.accept().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
let connection = match session.accept_primary_connection().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
```
|
||||
|
||||
L'attente du prochain client dans `listener.accept()` n'a pas de timeout périodique. Une fois une requête WebTransport surfacée, sa réponse finale utilise la deadline de connexion configurée.
|
||||
|
||||
`open_primary_connection()` écrit l'en-tête WebTransport requis pour identifier le stream avant de retourner. Le serveur peut donc attendre `accept_primary_connection()` puis commencer les échanges applicatifs ; aucune frame artificielle n'est nécessaire pour rendre le stream visible.
|
||||
|
||||
## Client natif
|
||||
|
||||
Le client doit connaître le SHA-256 exact du certificat serveur :
|
||||
|
||||
```rust
|
||||
let config = match game_realtime_webtransport_lib::WebTransportClientConfig::new(
|
||||
"https://127.0.0.1:4433/game",
|
||||
certificate_hash,
|
||||
) {
|
||||
Ok(value) => value.with_transport_config(transport),
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
let session = match game_realtime_webtransport_lib::connect(&config).await {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
let connection = match session.open_primary_connection().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
```
|
||||
|
||||
Le pinning est obligatoire dans cette API native ; il n'existe pas de variante qui désactive globalement la vérification TLS.
|
||||
|
||||
## Contrat realtime
|
||||
|
||||
Une fois le stream primaire sélectionné, utiliser les traits de `game-realtime-transport-lib` pour le chemin fiable normal :
|
||||
|
||||
```rust
|
||||
let (mut sender, mut receiver) = game_realtime_transport_lib::RealtimeConnection::split(connection);
|
||||
|
||||
let message = game_realtime_transport_lib::TransportMessage::new(vec![1, 2, 3, 4]);
|
||||
if let Err(error) = game_realtime_transport_lib::RealtimeSender::send(&mut sender, message).await {
|
||||
return Err(error);
|
||||
}
|
||||
|
||||
let received = match game_realtime_transport_lib::RealtimeReceiver::receive(&mut receiver).await {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
|
||||
if let Err(error) = game_realtime_transport_lib::RealtimeSender::close(&mut sender).await {
|
||||
return Err(error);
|
||||
}
|
||||
```
|
||||
|
||||
Le backend encode chaque `TransportMessage` sous la forme `u32` big-endian + payload. Le consommateur ne doit pas reproduire ce framing lui-même.
|
||||
|
||||
La flow-control QUIC est respectée naturellement par l'écriture asynchrone. Un send qui dépasse sa deadline est considéré terminal : le stream est reset et le même sender ne doit pas être réutilisé.
|
||||
|
||||
## Fermeture et abort
|
||||
|
||||
`RealtimeSender::close()` termine proprement la direction d'émission du stream primaire. Le pair observe ensuite `TransportReceive::Closed` lorsqu'il atteint le FIN après les messages déjà écrits.
|
||||
|
||||
Pour abandonner explicitement une direction WebTransport :
|
||||
|
||||
```rust
|
||||
if let Err(error) = sender.abort(42) {
|
||||
return Err(error);
|
||||
}
|
||||
```
|
||||
|
||||
ou côté réception :
|
||||
|
||||
```rust
|
||||
if let Err(error) = receiver.abort(43) {
|
||||
return Err(error);
|
||||
}
|
||||
```
|
||||
|
||||
Ces deux méthodes sont backend-spécifiques : elles ne sont pas ajoutées au contrat commun car WebSocket n'expose pas la même primitive QUIC de reset/stop.
|
||||
|
||||
Dropper un sender actif ou annuler une future `send()` en cours provoque un reset explicite. Dropper un receiver actif provoque un stop explicite. Cela évite qu'une cancellation d'écriture partielle soit interprétée comme une fermeture propre ou qu'une frame suivante reprenne au mauvais offset.
|
||||
|
||||
Une future `receive()` peut en revanche être annulée puis relancée : le backend conserve l'état partiel du header/payload et reprend le framing à l'octet correct.
|
||||
109
crates/common/game-realtime-webtransport-lib/src/config.rs
Normal file
109
crates/common/game-realtime-webtransport-lib/src/config.rs
Normal file
@@ -0,0 +1,109 @@
|
||||
// file: crates/common/game-realtime-webtransport-lib/src/config.rs
|
||||
// version: 1
|
||||
|
||||
const DEFAULT_CONNECT_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(10);
|
||||
const DEFAULT_MAX_MESSAGE_SIZE: usize = 1024 * 1024;
|
||||
const DEFAULT_PRIMARY_STREAM_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(5);
|
||||
const DEFAULT_SEND_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(5);
|
||||
|
||||
/// Product-facing limits and operation deadlines for the native WebTransport reliable path.
|
||||
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
||||
pub struct WebTransportConfig {
|
||||
connect_timeout: std::time::Duration,
|
||||
max_message_size: usize,
|
||||
primary_stream_timeout: std::time::Duration,
|
||||
send_timeout: std::time::Duration,
|
||||
}
|
||||
|
||||
impl Default for WebTransportConfig {
|
||||
fn default() -> Self {
|
||||
return Self {
|
||||
connect_timeout: DEFAULT_CONNECT_TIMEOUT,
|
||||
max_message_size: DEFAULT_MAX_MESSAGE_SIZE,
|
||||
primary_stream_timeout: DEFAULT_PRIMARY_STREAM_TIMEOUT,
|
||||
send_timeout: DEFAULT_SEND_TIMEOUT,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
impl WebTransportConfig {
|
||||
/// Returns a copy with a different client/session handshake deadline.
|
||||
#[must_use]
|
||||
pub fn with_connect_timeout(mut self, value: std::time::Duration) -> Self {
|
||||
self.connect_timeout = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns a copy with a different maximum framed binary message size.
|
||||
#[must_use]
|
||||
pub fn with_max_message_size(mut self, value: usize) -> Self {
|
||||
self.max_message_size = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns a copy with a different deadline for opening or accepting the primary stream.
|
||||
#[must_use]
|
||||
pub fn with_primary_stream_timeout(mut self, value: std::time::Duration) -> Self {
|
||||
self.primary_stream_timeout = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns a copy with a different deadline for one complete framed send operation.
|
||||
#[must_use]
|
||||
pub fn with_send_timeout(mut self, value: std::time::Duration) -> Self {
|
||||
self.send_timeout = value;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns the configured client/session handshake deadline.
|
||||
#[must_use]
|
||||
pub fn connect_timeout(&self) -> std::time::Duration {
|
||||
return self.connect_timeout;
|
||||
}
|
||||
|
||||
/// Returns the maximum framed binary message size.
|
||||
#[must_use]
|
||||
pub fn max_message_size(&self) -> usize {
|
||||
return self.max_message_size;
|
||||
}
|
||||
|
||||
/// Returns the deadline for opening or accepting the primary stream.
|
||||
#[must_use]
|
||||
pub fn primary_stream_timeout(&self) -> std::time::Duration {
|
||||
return self.primary_stream_timeout;
|
||||
}
|
||||
|
||||
/// Returns the deadline for one complete framed send operation.
|
||||
#[must_use]
|
||||
pub fn send_timeout(&self) -> std::time::Duration {
|
||||
return self.send_timeout;
|
||||
}
|
||||
|
||||
/// Validates all limits and deadlines required by the reliable WebTransport path.
|
||||
pub fn validate(&self) -> Result<(), game_realtime_transport_lib::TransportError> {
|
||||
if self.max_message_size == 0 {
|
||||
return Err(invalid_configuration("max_message_size must be greater than zero"));
|
||||
}
|
||||
if u32::try_from(self.max_message_size).is_err() {
|
||||
return Err(invalid_configuration("max_message_size must fit the u32 framing length field"));
|
||||
}
|
||||
if self.connect_timeout.is_zero() {
|
||||
return Err(invalid_configuration("connect_timeout must be greater than zero"));
|
||||
}
|
||||
if self.primary_stream_timeout.is_zero() {
|
||||
return Err(invalid_configuration("primary_stream_timeout must be greater than zero"));
|
||||
}
|
||||
if self.send_timeout.is_zero() {
|
||||
return Err(invalid_configuration("send_timeout must be greater than zero"));
|
||||
}
|
||||
return Ok(());
|
||||
}
|
||||
}
|
||||
|
||||
fn invalid_configuration(detail: &str) -> game_realtime_transport_lib::TransportError {
|
||||
return game_realtime_transport_lib::TransportError::new(game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration, detail);
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
#[path = "../unit_tests/config.rs"]
|
||||
mod tests;
|
||||
34
crates/common/game-realtime-webtransport-lib/src/lib.rs
Normal file
34
crates/common/game-realtime-webtransport-lib/src/lib.rs
Normal file
@@ -0,0 +1,34 @@
|
||||
// file: crates/common/game-realtime-webtransport-lib/src/lib.rs
|
||||
// version: 3
|
||||
|
||||
#![warn(missing_docs)]
|
||||
#![deny(unreachable_pub)]
|
||||
#![forbid(unsafe_code)]
|
||||
|
||||
//! Native WebTransport/QUIC backend candidate for the transport-neutral realtime contract.
|
||||
|
||||
mod config;
|
||||
mod webtransport;
|
||||
|
||||
/// Re-export of product-facing limits and operation deadlines for the reliable WebTransport path.
|
||||
pub use self::config::WebTransportConfig;
|
||||
/// Re-export of the pinned SHA-256 certificate fingerprint used by the native client.
|
||||
pub use self::webtransport::WebTransportCertificateHash;
|
||||
/// Re-export of native WebTransport client configuration.
|
||||
pub use self::webtransport::WebTransportClientConfig;
|
||||
/// Re-export of an established WebTransport connection adapted to the transport-neutral realtime contract.
|
||||
pub use self::webtransport::WebTransportConnection;
|
||||
/// Re-export of the bound native WebTransport listener.
|
||||
pub use self::webtransport::WebTransportListener;
|
||||
/// Re-export of the receive half of the primary reliable WebTransport stream.
|
||||
pub use self::webtransport::WebTransportReceiver;
|
||||
/// Re-export of the send half of the primary reliable WebTransport stream.
|
||||
pub use self::webtransport::WebTransportSender;
|
||||
/// Re-export of native WebTransport server configuration.
|
||||
pub use self::webtransport::WebTransportServerConfig;
|
||||
/// Re-export of native WebTransport server TLS identity material.
|
||||
pub use self::webtransport::WebTransportServerIdentity;
|
||||
/// Re-export of an established native WebTransport session.
|
||||
pub use self::webtransport::WebTransportSession;
|
||||
/// Re-export of the native WebTransport client establishment function.
|
||||
pub use self::webtransport::connect;
|
||||
802
crates/common/game-realtime-webtransport-lib/src/webtransport.rs
Normal file
802
crates/common/game-realtime-webtransport-lib/src/webtransport.rs
Normal file
@@ -0,0 +1,802 @@
|
||||
// file: crates/common/game-realtime-webtransport-lib/src/webtransport.rs
|
||||
// version: 4
|
||||
|
||||
const CERTIFICATE_HASH_SIZE: usize = 32;
|
||||
const LOCAL_CERTIFICATE_CLOCK_SKEW: std::time::Duration = std::time::Duration::from_secs(60);
|
||||
const LOCAL_CERTIFICATE_VALIDITY: std::time::Duration = std::time::Duration::from_secs(7 * 24 * 60 * 60);
|
||||
const PRIMARY_FRAME_HEADER_SIZE: usize = 4;
|
||||
const TRACING_TARGET: &str = "games::realtime::webtransport";
|
||||
|
||||
/// SHA-256 fingerprint of one certificate accepted by the native WebTransport client.
|
||||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
pub struct WebTransportCertificateHash {
|
||||
bytes: [u8; CERTIFICATE_HASH_SIZE],
|
||||
}
|
||||
|
||||
impl WebTransportCertificateHash {
|
||||
/// Creates a fingerprint from an already-computed SHA-256 digest.
|
||||
#[must_use]
|
||||
pub fn from_sha256(bytes: [u8; CERTIFICATE_HASH_SIZE]) -> Self {
|
||||
return Self { bytes };
|
||||
}
|
||||
|
||||
/// Returns the exact 32-byte SHA-256 digest.
|
||||
#[must_use]
|
||||
pub fn as_bytes(&self) -> &[u8; CERTIFICATE_HASH_SIZE] {
|
||||
return &self.bytes;
|
||||
}
|
||||
}
|
||||
|
||||
/// Self-contained certificate/private-key identity used by a native WebTransport server.
|
||||
pub struct WebTransportServerIdentity {
|
||||
certificate_der: Vec<u8>,
|
||||
private_key_pkcs8_der: Vec<u8>,
|
||||
certificate_hash: WebTransportCertificateHash,
|
||||
}
|
||||
|
||||
impl WebTransportServerIdentity {
|
||||
/// Generates a short-lived self-signed ECDSA P-256 identity for localhost and loopback addresses.
|
||||
pub fn generate_loopback() -> Result<Self, game_realtime_transport_lib::TransportError> {
|
||||
let now = std::time::SystemTime::now();
|
||||
let not_before = match now.checked_sub(LOCAL_CERTIFICATE_CLOCK_SKEW) {
|
||||
Some(value) => value,
|
||||
None => return Err(invalid_configuration("failed to compute local certificate not-before time")),
|
||||
};
|
||||
let not_after = match now.checked_add(LOCAL_CERTIFICATE_VALIDITY) {
|
||||
Some(value) => value,
|
||||
None => return Err(invalid_configuration("failed to compute local certificate not-after time")),
|
||||
};
|
||||
let subject_alt_names = vec!["localhost".to_owned(), "127.0.0.1".to_owned(), "::1".to_owned()];
|
||||
let mut params = match rcgen::CertificateParams::new(subject_alt_names) {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(invalid_configuration(error.to_string())),
|
||||
};
|
||||
params.not_before = not_before.into();
|
||||
params.not_after = not_after.into();
|
||||
let key_pair = match rcgen::KeyPair::generate_for(&rcgen::PKCS_ECDSA_P256_SHA256) {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(invalid_configuration(error.to_string())),
|
||||
};
|
||||
let certificate = match params.self_signed(&key_pair) {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(invalid_configuration(error.to_string())),
|
||||
};
|
||||
let certificate_der = certificate.der().to_vec();
|
||||
let private_key_pkcs8_der = key_pair.serialize_der();
|
||||
return Self::from_pkcs8_der(certificate_der, private_key_pkcs8_der);
|
||||
}
|
||||
|
||||
/// Builds an identity from an X.509 certificate DER blob and its PKCS#8 private key DER blob.
|
||||
///
|
||||
/// Certificate/key compatibility is validated by the native TLS server builder when the listener is bound.
|
||||
pub fn from_pkcs8_der(certificate_der: Vec<u8>, private_key_pkcs8_der: Vec<u8>) -> Result<Self, game_realtime_transport_lib::TransportError> {
|
||||
if certificate_der.is_empty() {
|
||||
return Err(invalid_configuration("certificate DER must not be empty"));
|
||||
}
|
||||
if private_key_pkcs8_der.is_empty() {
|
||||
return Err(invalid_configuration("PKCS#8 private-key DER must not be empty"));
|
||||
}
|
||||
let certificate_hash = match certificate_hash(certificate_der.as_slice()) {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
return Ok(Self { certificate_der, private_key_pkcs8_der, certificate_hash });
|
||||
}
|
||||
|
||||
/// Returns the SHA-256 certificate fingerprint used for native hash pinning.
|
||||
#[must_use]
|
||||
pub fn certificate_hash(&self) -> &WebTransportCertificateHash {
|
||||
return &self.certificate_hash;
|
||||
}
|
||||
}
|
||||
|
||||
/// Native WebTransport client endpoint, certificate pin and reliable-path configuration.
|
||||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
pub struct WebTransportClientConfig {
|
||||
endpoint: url::Url,
|
||||
certificate_hash: WebTransportCertificateHash,
|
||||
transport: crate::WebTransportConfig,
|
||||
}
|
||||
|
||||
impl WebTransportClientConfig {
|
||||
/// Parses and validates a secure WebTransport endpoint with one pinned SHA-256 certificate fingerprint.
|
||||
pub fn new(endpoint: &str, certificate_hash: WebTransportCertificateHash) -> Result<Self, game_realtime_transport_lib::TransportError> {
|
||||
let parsed = match url::Url::parse(endpoint) {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(invalid_configuration(error.to_string())),
|
||||
};
|
||||
if parsed.scheme() != "https" {
|
||||
return Err(invalid_configuration("WebTransport endpoint scheme must be https"));
|
||||
}
|
||||
if parsed.host().is_none() {
|
||||
return Err(invalid_configuration("WebTransport endpoint must contain a host"));
|
||||
}
|
||||
return Ok(Self { endpoint: parsed, certificate_hash, transport: crate::WebTransportConfig::default() });
|
||||
}
|
||||
|
||||
/// Returns a copy with explicit reliable-path limits and deadlines.
|
||||
#[must_use]
|
||||
pub fn with_transport_config(mut self, transport: crate::WebTransportConfig) -> Self {
|
||||
self.transport = transport;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns the validated WebTransport endpoint URL.
|
||||
#[must_use]
|
||||
pub fn endpoint(&self) -> &str {
|
||||
return self.endpoint.as_str();
|
||||
}
|
||||
|
||||
/// Returns the pinned SHA-256 server-certificate fingerprint.
|
||||
#[must_use]
|
||||
pub fn certificate_hash(&self) -> &WebTransportCertificateHash {
|
||||
return &self.certificate_hash;
|
||||
}
|
||||
|
||||
/// Returns the reliable-path limits and deadlines.
|
||||
#[must_use]
|
||||
pub fn transport_config(&self) -> crate::WebTransportConfig {
|
||||
return self.transport;
|
||||
}
|
||||
}
|
||||
|
||||
/// Native WebTransport server bind address, TLS identity and reliable-path configuration.
|
||||
pub struct WebTransportServerConfig {
|
||||
bind_address: std::net::SocketAddr,
|
||||
identity: WebTransportServerIdentity,
|
||||
transport: crate::WebTransportConfig,
|
||||
}
|
||||
|
||||
impl WebTransportServerConfig {
|
||||
/// Creates native server configuration for the requested bind address and TLS identity.
|
||||
#[must_use]
|
||||
pub fn new(bind_address: std::net::SocketAddr, identity: WebTransportServerIdentity) -> Self {
|
||||
return Self { bind_address, identity, transport: crate::WebTransportConfig::default() };
|
||||
}
|
||||
|
||||
/// Returns a copy with explicit reliable-path limits and deadlines.
|
||||
#[must_use]
|
||||
pub fn with_transport_config(mut self, transport: crate::WebTransportConfig) -> Self {
|
||||
self.transport = transport;
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Returns the requested UDP bind address.
|
||||
#[must_use]
|
||||
pub fn bind_address(&self) -> std::net::SocketAddr {
|
||||
return self.bind_address;
|
||||
}
|
||||
|
||||
/// Returns the server certificate fingerprint that clients must pin for this identity.
|
||||
#[must_use]
|
||||
pub fn certificate_hash(&self) -> &WebTransportCertificateHash {
|
||||
return self.identity.certificate_hash();
|
||||
}
|
||||
|
||||
/// Returns the reliable-path limits and deadlines.
|
||||
#[must_use]
|
||||
pub fn transport_config(&self) -> crate::WebTransportConfig {
|
||||
return self.transport;
|
||||
}
|
||||
}
|
||||
|
||||
/// Established native WebTransport session before or while the single primary application stream is selected.
|
||||
pub struct WebTransportSession {
|
||||
inner: web_transport_quinn::Session,
|
||||
transport: crate::WebTransportConfig,
|
||||
}
|
||||
|
||||
impl WebTransportSession {
|
||||
fn new(inner: web_transport_quinn::Session, transport: crate::WebTransportConfig) -> Self {
|
||||
return Self { inner, transport };
|
||||
}
|
||||
|
||||
/// Accepts the peer-created primary bidirectional stream and adapts it to the transport-neutral realtime contract.
|
||||
///
|
||||
/// The native WebTransport wrapper writes the required stream/session header while opening the stream, so the peer can
|
||||
/// accept it before the first application frame is sent.
|
||||
pub async fn accept_primary_connection(self) -> Result<WebTransportConnection, game_realtime_transport_lib::TransportError> {
|
||||
let timeout = self.transport.primary_stream_timeout();
|
||||
let accepted = tokio::time::timeout(timeout, self.inner.accept_bi()).await;
|
||||
let (sender, receiver) = match accepted {
|
||||
Ok(Ok(value)) => value,
|
||||
Ok(Err(error)) => {
|
||||
let mapped = transport_error(game_realtime_transport_lib::TransportErrorKind::Protocol, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, detail = mapped.detail(), "WebTransport primary bidirectional stream accept failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
Err(_) => {
|
||||
let mapped = timeout_error("WebTransport primary bidirectional stream accept", timeout);
|
||||
tracing::warn!(target: TRACING_TARGET, timeout_ms = duration_millis(timeout), "WebTransport primary bidirectional stream accept timed out");
|
||||
return Err(mapped);
|
||||
},
|
||||
};
|
||||
tracing::debug!(target: TRACING_TARGET, peer = %self.inner.remote_address(), "WebTransport primary bidirectional stream accepted");
|
||||
return Ok(WebTransportConnection::new(self.inner, sender, receiver, self.transport));
|
||||
}
|
||||
|
||||
/// Opens the single primary bidirectional stream and adapts it to the transport-neutral realtime contract.
|
||||
pub async fn open_primary_connection(self) -> Result<WebTransportConnection, game_realtime_transport_lib::TransportError> {
|
||||
let timeout = self.transport.primary_stream_timeout();
|
||||
let opened = tokio::time::timeout(timeout, self.inner.open_bi()).await;
|
||||
let (sender, receiver) = match opened {
|
||||
Ok(Ok(value)) => value,
|
||||
Ok(Err(error)) => {
|
||||
let mapped = transport_error(game_realtime_transport_lib::TransportErrorKind::Protocol, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, detail = mapped.detail(), "WebTransport primary bidirectional stream open failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
Err(_) => {
|
||||
let mapped = timeout_error("WebTransport primary bidirectional stream open", timeout);
|
||||
tracing::warn!(target: TRACING_TARGET, timeout_ms = duration_millis(timeout), "WebTransport primary bidirectional stream open timed out");
|
||||
return Err(mapped);
|
||||
},
|
||||
};
|
||||
tracing::debug!(target: TRACING_TARGET, peer = %self.inner.remote_address(), "WebTransport primary bidirectional stream opened");
|
||||
return Ok(WebTransportConnection::new(self.inner, sender, receiver, self.transport));
|
||||
}
|
||||
|
||||
/// Returns the remote UDP socket address backing the established QUIC connection.
|
||||
#[must_use]
|
||||
pub fn remote_addr(&self) -> std::net::SocketAddr {
|
||||
return self.inner.remote_address();
|
||||
}
|
||||
|
||||
/// Returns the HTTP/3 CONNECT URL used to establish this session when available.
|
||||
#[must_use]
|
||||
pub fn request_url(&self) -> Option<&str> {
|
||||
return match self.inner.request() {
|
||||
Some(request) => Some(request.url.as_str()),
|
||||
None => None,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/// Established WebTransport realtime connection carried by one primary reliable bidirectional stream.
|
||||
pub struct WebTransportConnection {
|
||||
receiver: web_transport_quinn::RecvStream,
|
||||
sender: web_transport_quinn::SendStream,
|
||||
session: web_transport_quinn::Session,
|
||||
transport: crate::WebTransportConfig,
|
||||
}
|
||||
|
||||
impl WebTransportConnection {
|
||||
fn new(
|
||||
session: web_transport_quinn::Session,
|
||||
sender: web_transport_quinn::SendStream,
|
||||
receiver: web_transport_quinn::RecvStream,
|
||||
transport: crate::WebTransportConfig,
|
||||
) -> Self {
|
||||
return Self { receiver, sender, session, transport };
|
||||
}
|
||||
}
|
||||
|
||||
impl game_realtime_transport_lib::RealtimeConnection for WebTransportConnection {
|
||||
type Receiver = crate::WebTransportReceiver;
|
||||
type Sender = crate::WebTransportSender;
|
||||
|
||||
fn split(self) -> (Self::Sender, Self::Receiver) {
|
||||
let receiver_session = self.session.clone();
|
||||
return (
|
||||
crate::WebTransportSender {
|
||||
inner: self.sender,
|
||||
_session: self.session,
|
||||
max_message_size: self.transport.max_message_size(),
|
||||
send_timeout: self.transport.send_timeout(),
|
||||
terminal: false,
|
||||
},
|
||||
crate::WebTransportReceiver {
|
||||
inner: self.receiver,
|
||||
_session: receiver_session,
|
||||
max_message_size: self.transport.max_message_size(),
|
||||
header: [0_u8; PRIMARY_FRAME_HEADER_SIZE],
|
||||
header_read: 0,
|
||||
payload: Vec::new(),
|
||||
payload_read: 0,
|
||||
clean_closed: false,
|
||||
terminal: false,
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/// Receive half of the primary reliable WebTransport stream.
|
||||
pub struct WebTransportReceiver {
|
||||
inner: web_transport_quinn::RecvStream,
|
||||
_session: web_transport_quinn::Session,
|
||||
max_message_size: usize,
|
||||
header: [u8; PRIMARY_FRAME_HEADER_SIZE],
|
||||
header_read: usize,
|
||||
payload: Vec<u8>,
|
||||
payload_read: usize,
|
||||
clean_closed: bool,
|
||||
terminal: bool,
|
||||
}
|
||||
|
||||
impl WebTransportReceiver {
|
||||
/// Abruptly stops the reliable receive direction with one WebTransport application error code.
|
||||
pub fn abort(&mut self, code: u32) -> Result<(), game_realtime_transport_lib::TransportError> {
|
||||
if self.clean_closed || self.terminal {
|
||||
return Err(transport_error(game_realtime_transport_lib::TransportErrorKind::Closed, "WebTransport receiver is already terminal"));
|
||||
}
|
||||
return match self.inner.stop(code) {
|
||||
Ok(()) => {
|
||||
self.terminal = true;
|
||||
tracing::debug!(target: TRACING_TARGET, code = code, "WebTransport primary receive stream aborted");
|
||||
Ok(())
|
||||
},
|
||||
Err(error) => {
|
||||
self.terminal = true;
|
||||
let mapped = transport_error(game_realtime_transport_lib::TransportErrorKind::Closed, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, code = code, detail = mapped.detail(), "WebTransport primary receive stream abort failed");
|
||||
Err(mapped)
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
async fn receive_frame(&mut self) -> Result<game_realtime_transport_lib::TransportReceive, game_realtime_transport_lib::TransportError> {
|
||||
if self.clean_closed {
|
||||
return Ok(game_realtime_transport_lib::TransportReceive::Closed);
|
||||
}
|
||||
if self.terminal {
|
||||
return Err(transport_error(
|
||||
game_realtime_transport_lib::TransportErrorKind::Aborted,
|
||||
"WebTransport receiver is unavailable after a terminal stream failure or abort",
|
||||
));
|
||||
}
|
||||
loop {
|
||||
if self.header_read < PRIMARY_FRAME_HEADER_SIZE {
|
||||
let read = self.inner.read(&mut self.header[self.header_read..]).await;
|
||||
match read {
|
||||
Ok(Some(0)) => return self.fail_protocol("WebTransport primary stream returned an empty read in the middle of a frame header"),
|
||||
Ok(Some(value)) => {
|
||||
self.header_read += value;
|
||||
continue;
|
||||
},
|
||||
Ok(None) => {
|
||||
if self.header_read == 0 {
|
||||
self.clean_closed = true;
|
||||
tracing::debug!(target: TRACING_TARGET, "remote WebTransport primary stream closed cleanly");
|
||||
return Ok(game_realtime_transport_lib::TransportReceive::Closed);
|
||||
}
|
||||
return self.fail_protocol("WebTransport primary stream closed in the middle of a frame header");
|
||||
},
|
||||
Err(error) => return self.fail_read(error),
|
||||
}
|
||||
}
|
||||
if self.payload.is_empty() && self.payload_read == 0 {
|
||||
let payload_len = u32::from_be_bytes(self.header) as usize;
|
||||
if payload_len > self.max_message_size {
|
||||
let error = message_too_large(payload_len, self.max_message_size);
|
||||
self.stop_after_failure(FRAME_TOO_LARGE_ERROR_CODE);
|
||||
return Err(error);
|
||||
}
|
||||
if payload_len == 0 {
|
||||
self.reset_frame_state();
|
||||
tracing::trace!(target: TRACING_TARGET, payload_len = 0, "framed WebTransport payload received");
|
||||
return Ok(game_realtime_transport_lib::TransportReceive::Message(game_realtime_transport_lib::TransportMessage::new(Vec::new())));
|
||||
}
|
||||
self.payload = vec![0_u8; payload_len];
|
||||
}
|
||||
if self.payload_read < self.payload.len() {
|
||||
let read = self.inner.read(&mut self.payload[self.payload_read..]).await;
|
||||
match read {
|
||||
Ok(Some(0)) => return self.fail_protocol("WebTransport primary stream returned an empty read in the middle of a frame payload"),
|
||||
Ok(Some(value)) => {
|
||||
self.payload_read += value;
|
||||
if self.payload_read < self.payload.len() {
|
||||
continue;
|
||||
}
|
||||
},
|
||||
Ok(None) => return self.fail_protocol("WebTransport primary stream closed in the middle of a frame payload"),
|
||||
Err(error) => return self.fail_read(error),
|
||||
}
|
||||
}
|
||||
let payload = core::mem::take(&mut self.payload);
|
||||
self.reset_frame_state();
|
||||
tracing::trace!(target: TRACING_TARGET, payload_len = payload.len(), "framed WebTransport payload received");
|
||||
return Ok(game_realtime_transport_lib::TransportReceive::Message(game_realtime_transport_lib::TransportMessage::new(payload)));
|
||||
}
|
||||
}
|
||||
|
||||
fn fail_protocol(&mut self, detail: &str) -> Result<game_realtime_transport_lib::TransportReceive, game_realtime_transport_lib::TransportError> {
|
||||
let error = protocol_error(detail);
|
||||
self.stop_after_failure(FRAME_PROTOCOL_ERROR_CODE);
|
||||
return Err(error);
|
||||
}
|
||||
|
||||
fn fail_read(
|
||||
&mut self,
|
||||
error: web_transport_quinn::ReadError,
|
||||
) -> Result<game_realtime_transport_lib::TransportReceive, game_realtime_transport_lib::TransportError> {
|
||||
self.terminal = true;
|
||||
let mapped = map_read_error(error);
|
||||
tracing::warn!(target: TRACING_TARGET, kind = %mapped.kind(), detail = mapped.detail(), "WebTransport primary stream receive failed");
|
||||
return Err(mapped);
|
||||
}
|
||||
|
||||
fn reset_frame_state(&mut self) {
|
||||
self.header = [0_u8; PRIMARY_FRAME_HEADER_SIZE];
|
||||
self.header_read = 0;
|
||||
self.payload.clear();
|
||||
self.payload_read = 0;
|
||||
}
|
||||
|
||||
fn stop_after_failure(&mut self, code: u32) {
|
||||
let _ = self.inner.stop(code);
|
||||
self.terminal = true;
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for WebTransportReceiver {
|
||||
fn drop(&mut self) {
|
||||
if !self.clean_closed && !self.terminal {
|
||||
let _ = self.inner.stop(STREAM_CANCELLED_ERROR_CODE);
|
||||
self.terminal = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl game_realtime_transport_lib::RealtimeReceiver for WebTransportReceiver {
|
||||
type ReceiveFuture<'a>
|
||||
= std::pin::Pin<
|
||||
Box<dyn core::future::Future<Output = Result<game_realtime_transport_lib::TransportReceive, game_realtime_transport_lib::TransportError>> + 'a>,
|
||||
>
|
||||
where
|
||||
Self: 'a;
|
||||
|
||||
fn receive(&mut self) -> Self::ReceiveFuture<'_> {
|
||||
return Box::pin(async move { return self.receive_frame().await });
|
||||
}
|
||||
}
|
||||
|
||||
/// Send half of the primary reliable WebTransport stream.
|
||||
pub struct WebTransportSender {
|
||||
inner: web_transport_quinn::SendStream,
|
||||
_session: web_transport_quinn::Session,
|
||||
max_message_size: usize,
|
||||
send_timeout: std::time::Duration,
|
||||
terminal: bool,
|
||||
}
|
||||
|
||||
impl WebTransportSender {
|
||||
/// Abruptly resets the reliable send direction with one WebTransport application error code.
|
||||
pub fn abort(&mut self, code: u32) -> Result<(), game_realtime_transport_lib::TransportError> {
|
||||
if self.terminal {
|
||||
return Err(transport_error(game_realtime_transport_lib::TransportErrorKind::Closed, "WebTransport sender is already terminal"));
|
||||
}
|
||||
self.terminal = true;
|
||||
return match self.inner.reset(code) {
|
||||
Ok(()) => {
|
||||
tracing::debug!(target: TRACING_TARGET, code = code, "WebTransport primary send stream aborted");
|
||||
Ok(())
|
||||
},
|
||||
Err(error) => {
|
||||
let mapped = transport_error(game_realtime_transport_lib::TransportErrorKind::Closed, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, code = code, detail = mapped.detail(), "WebTransport primary send stream abort failed");
|
||||
Err(mapped)
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for WebTransportSender {
|
||||
fn drop(&mut self) {
|
||||
if !self.terminal {
|
||||
let _ = self.inner.reset(STREAM_CANCELLED_ERROR_CODE);
|
||||
self.terminal = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl game_realtime_transport_lib::RealtimeSender for WebTransportSender {
|
||||
type CloseFuture<'a>
|
||||
= std::pin::Pin<Box<dyn core::future::Future<Output = Result<(), game_realtime_transport_lib::TransportError>> + 'a>>
|
||||
where
|
||||
Self: 'a;
|
||||
type SendFuture<'a>
|
||||
= std::pin::Pin<Box<dyn core::future::Future<Output = Result<(), game_realtime_transport_lib::TransportError>> + 'a>>
|
||||
where
|
||||
Self: 'a;
|
||||
|
||||
fn close(&mut self) -> Self::CloseFuture<'_> {
|
||||
return Box::pin(async move {
|
||||
if self.terminal {
|
||||
return Err(transport_error(game_realtime_transport_lib::TransportErrorKind::Closed, "WebTransport sender is already terminal"));
|
||||
}
|
||||
self.terminal = true;
|
||||
return match self.inner.finish() {
|
||||
Ok(()) => {
|
||||
tracing::debug!(target: TRACING_TARGET, "local WebTransport primary stream close initiated");
|
||||
Ok(())
|
||||
},
|
||||
Err(error) => {
|
||||
let mapped = transport_error(game_realtime_transport_lib::TransportErrorKind::Closed, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, detail = mapped.detail(), "WebTransport primary stream close failed");
|
||||
Err(mapped)
|
||||
},
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
fn send(&mut self, message: game_realtime_transport_lib::TransportMessage) -> Self::SendFuture<'_> {
|
||||
return Box::pin(async move {
|
||||
if self.terminal {
|
||||
return Err(transport_error(
|
||||
game_realtime_transport_lib::TransportErrorKind::Aborted,
|
||||
"WebTransport sender is unavailable after close, abort, cancellation or terminal send failure",
|
||||
));
|
||||
}
|
||||
let payload_len = message.len();
|
||||
let frame_header = match frame_header(payload_len, self.max_message_size) {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
let send_timeout = self.send_timeout;
|
||||
let mut guard = SendOperationGuard::new(&mut self.inner, &mut self.terminal);
|
||||
let operation = guard.write_frame(&frame_header, message.as_bytes());
|
||||
let result = tokio::time::timeout(send_timeout, operation).await;
|
||||
return match result {
|
||||
Ok(Ok(())) => {
|
||||
guard.complete();
|
||||
tracing::trace!(target: TRACING_TARGET, payload_len = payload_len, "framed WebTransport payload sent");
|
||||
Ok(())
|
||||
},
|
||||
Ok(Err(error)) => {
|
||||
guard.abort(SEND_FAILURE_ERROR_CODE);
|
||||
let mapped = map_write_error(error);
|
||||
tracing::warn!(target: TRACING_TARGET, payload_len = payload_len, kind = %mapped.kind(), detail = mapped.detail(), "WebTransport framed send failed");
|
||||
Err(mapped)
|
||||
},
|
||||
Err(_) => {
|
||||
guard.abort(SEND_TIMEOUT_ERROR_CODE);
|
||||
let mapped = timeout_error("WebTransport framed send", send_timeout);
|
||||
tracing::warn!(target: TRACING_TARGET, payload_len = payload_len, timeout_ms = duration_millis(send_timeout), "WebTransport framed send timed out under flow control/backpressure");
|
||||
Err(mapped)
|
||||
},
|
||||
};
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
struct SendOperationGuard<'a> {
|
||||
stream: &'a mut web_transport_quinn::SendStream,
|
||||
terminal: &'a mut bool,
|
||||
armed: bool,
|
||||
}
|
||||
|
||||
impl<'a> SendOperationGuard<'a> {
|
||||
fn new(stream: &'a mut web_transport_quinn::SendStream, terminal: &'a mut bool) -> Self {
|
||||
return Self { stream, terminal, armed: true };
|
||||
}
|
||||
|
||||
async fn write_frame(&mut self, header: &[u8; PRIMARY_FRAME_HEADER_SIZE], payload: &[u8]) -> Result<(), web_transport_quinn::WriteError> {
|
||||
if let Err(error) = self.stream.write_all(header).await {
|
||||
return Err(error);
|
||||
}
|
||||
if let Err(error) = self.stream.write_all(payload).await {
|
||||
return Err(error);
|
||||
}
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
fn abort(&mut self, code: u32) {
|
||||
if self.armed {
|
||||
let _ = self.stream.reset(code);
|
||||
*self.terminal = true;
|
||||
self.armed = false;
|
||||
}
|
||||
}
|
||||
|
||||
fn complete(&mut self) {
|
||||
self.armed = false;
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for SendOperationGuard<'_> {
|
||||
fn drop(&mut self) {
|
||||
if self.armed {
|
||||
let _ = self.stream.reset(STREAM_CANCELLED_ERROR_CODE);
|
||||
*self.terminal = true;
|
||||
self.armed = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Bound native WebTransport server endpoint that accepts HTTP/3 WebTransport sessions.
|
||||
pub struct WebTransportListener {
|
||||
server: web_transport_quinn::Server,
|
||||
local_addr: std::net::SocketAddr,
|
||||
transport: crate::WebTransportConfig,
|
||||
}
|
||||
|
||||
impl WebTransportListener {
|
||||
/// Binds a native WebTransport server using TLS 1.3 and the configured certificate identity.
|
||||
pub fn bind(config: WebTransportServerConfig) -> Result<Self, game_realtime_transport_lib::TransportError> {
|
||||
if let Err(error) = config.transport.validate() {
|
||||
return Err(error);
|
||||
}
|
||||
let transport = config.transport;
|
||||
let certificate = web_transport_quinn::quinn::rustls::pki_types::CertificateDer::from(config.identity.certificate_der);
|
||||
let private_key = web_transport_quinn::quinn::rustls::pki_types::PrivatePkcs8KeyDer::from(config.identity.private_key_pkcs8_der);
|
||||
let private_key = web_transport_quinn::quinn::rustls::pki_types::PrivateKeyDer::Pkcs8(private_key);
|
||||
let server = match web_transport_quinn::ServerBuilder::new().with_addr(config.bind_address).with_certificate(vec![certificate], private_key) {
|
||||
Ok(value) => value,
|
||||
Err(error) => {
|
||||
let mapped = transport_error(game_realtime_transport_lib::TransportErrorKind::Bind, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, address = %config.bind_address, detail = mapped.detail(), "WebTransport listener bind failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
};
|
||||
let local_addr = match server.local_addr() {
|
||||
Ok(value) => value,
|
||||
Err(error) => {
|
||||
let mapped = transport_error(game_realtime_transport_lib::TransportErrorKind::Bind, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, detail = mapped.detail(), "bound WebTransport listener address lookup failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
};
|
||||
tracing::info!(target: TRACING_TARGET, address = %local_addr, "WebTransport listener bound");
|
||||
return Ok(Self { server, local_addr, transport });
|
||||
}
|
||||
|
||||
/// Returns the concrete UDP socket address, including an ephemeral port selected by the OS.
|
||||
#[must_use]
|
||||
pub fn local_addr(&self) -> std::net::SocketAddr {
|
||||
return self.local_addr;
|
||||
}
|
||||
|
||||
/// Accepts one native WebTransport CONNECT request and returns the established session.
|
||||
///
|
||||
/// Waiting for the next peer remains intentionally unbounded. Once a WebTransport request is surfaced, the final server
|
||||
/// response is bounded by the configured connection deadline.
|
||||
pub async fn accept(&mut self) -> Result<WebTransportSession, game_realtime_transport_lib::TransportError> {
|
||||
let request = match self.server.accept().await {
|
||||
Some(value) => value,
|
||||
None => {
|
||||
let error = transport_error(game_realtime_transport_lib::TransportErrorKind::Accept, "WebTransport server stopped accepting sessions");
|
||||
tracing::warn!(target: TRACING_TARGET, detail = error.detail(), "WebTransport accept ended");
|
||||
return Err(error);
|
||||
},
|
||||
};
|
||||
let peer = request.conn().remote_address();
|
||||
let timeout = self.transport.connect_timeout();
|
||||
let accepted = tokio::time::timeout(timeout, request.ok()).await;
|
||||
let session = match accepted {
|
||||
Ok(Ok(value)) => value,
|
||||
Ok(Err(error)) => {
|
||||
let mapped = transport_error(game_realtime_transport_lib::TransportErrorKind::Accept, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, peer = %peer, detail = mapped.detail(), "WebTransport server handshake failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
Err(_) => {
|
||||
let mapped = timeout_error("WebTransport server handshake response", timeout);
|
||||
tracing::warn!(target: TRACING_TARGET, peer = %peer, timeout_ms = duration_millis(timeout), "WebTransport server handshake response timed out");
|
||||
return Err(mapped);
|
||||
},
|
||||
};
|
||||
tracing::info!(target: TRACING_TARGET, peer = %peer, "WebTransport peer accepted");
|
||||
return Ok(WebTransportSession::new(session, self.transport));
|
||||
}
|
||||
}
|
||||
|
||||
/// Establishes one native WebTransport session using an exact SHA-256 certificate pin.
|
||||
pub async fn connect(config: &WebTransportClientConfig) -> Result<WebTransportSession, game_realtime_transport_lib::TransportError> {
|
||||
if let Err(error) = config.transport.validate() {
|
||||
return Err(error);
|
||||
}
|
||||
let client = match web_transport_quinn::ClientBuilder::new().with_server_certificate_hashes(vec![config.certificate_hash.as_bytes().to_vec()]) {
|
||||
Ok(value) => value,
|
||||
Err(error) => return Err(invalid_configuration(error.to_string())),
|
||||
};
|
||||
let timeout = config.transport.connect_timeout();
|
||||
let connected = tokio::time::timeout(timeout, client.connect(config.endpoint.clone())).await;
|
||||
let session = match connected {
|
||||
Ok(Ok(value)) => value,
|
||||
Ok(Err(error)) => {
|
||||
let mapped = transport_error(game_realtime_transport_lib::TransportErrorKind::Connect, error.to_string());
|
||||
tracing::warn!(target: TRACING_TARGET, endpoint = config.endpoint.as_str(), detail = mapped.detail(), "WebTransport client connection failed");
|
||||
return Err(mapped);
|
||||
},
|
||||
Err(_) => {
|
||||
let mapped = timeout_error("WebTransport client connect", timeout);
|
||||
tracing::warn!(target: TRACING_TARGET, endpoint = config.endpoint.as_str(), timeout_ms = duration_millis(timeout), "WebTransport client connection timed out");
|
||||
return Err(mapped);
|
||||
},
|
||||
};
|
||||
tracing::info!(target: TRACING_TARGET, endpoint = config.endpoint.as_str(), peer = %session.remote_address(), "WebTransport client connected");
|
||||
return Ok(WebTransportSession::new(session, config.transport));
|
||||
}
|
||||
|
||||
const FRAME_PROTOCOL_ERROR_CODE: u32 = 0x10;
|
||||
const FRAME_TOO_LARGE_ERROR_CODE: u32 = 0x11;
|
||||
const SEND_FAILURE_ERROR_CODE: u32 = 0x12;
|
||||
const SEND_TIMEOUT_ERROR_CODE: u32 = 0x13;
|
||||
const STREAM_CANCELLED_ERROR_CODE: u32 = 0x14;
|
||||
|
||||
fn certificate_hash(certificate_der: &[u8]) -> Result<WebTransportCertificateHash, game_realtime_transport_lib::TransportError> {
|
||||
let certificate = web_transport_quinn::quinn::rustls::pki_types::CertificateDer::from(certificate_der.to_vec());
|
||||
let provider = web_transport_quinn::crypto::default_provider();
|
||||
let digest = web_transport_quinn::crypto::sha256(&provider, &certificate);
|
||||
let digest_bytes = digest.as_ref();
|
||||
if digest_bytes.len() != CERTIFICATE_HASH_SIZE {
|
||||
return Err(invalid_configuration("WebTransport certificate SHA-256 digest has an unexpected length"));
|
||||
}
|
||||
let mut bytes = [0_u8; CERTIFICATE_HASH_SIZE];
|
||||
bytes.copy_from_slice(digest_bytes);
|
||||
return Ok(WebTransportCertificateHash::from_sha256(bytes));
|
||||
}
|
||||
|
||||
fn frame_header(payload_len: usize, max_message_size: usize) -> Result<[u8; PRIMARY_FRAME_HEADER_SIZE], game_realtime_transport_lib::TransportError> {
|
||||
if payload_len > max_message_size {
|
||||
return Err(message_too_large(payload_len, max_message_size));
|
||||
}
|
||||
let payload_len = match u32::try_from(payload_len) {
|
||||
Ok(value) => value,
|
||||
Err(_) => return Err(message_too_large(payload_len, max_message_size)),
|
||||
};
|
||||
return Ok(payload_len.to_be_bytes());
|
||||
}
|
||||
|
||||
fn invalid_configuration(detail: impl Into<String>) -> game_realtime_transport_lib::TransportError {
|
||||
return transport_error(game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration, detail);
|
||||
}
|
||||
|
||||
fn map_read_error(error: web_transport_quinn::ReadError) -> game_realtime_transport_lib::TransportError {
|
||||
let kind = match &error {
|
||||
web_transport_quinn::ReadError::Reset(_) => game_realtime_transport_lib::TransportErrorKind::Aborted,
|
||||
web_transport_quinn::ReadError::ClosedStream => game_realtime_transport_lib::TransportErrorKind::Closed,
|
||||
web_transport_quinn::ReadError::SessionError(session) => map_session_error_kind(session),
|
||||
web_transport_quinn::ReadError::InvalidReset(_) | web_transport_quinn::ReadError::IllegalOrderedRead => {
|
||||
game_realtime_transport_lib::TransportErrorKind::Protocol
|
||||
},
|
||||
};
|
||||
return transport_error(kind, error.to_string());
|
||||
}
|
||||
|
||||
fn map_session_error_kind(error: &web_transport_quinn::SessionError) -> game_realtime_transport_lib::TransportErrorKind {
|
||||
if matches!(error, web_transport_quinn::SessionError::WebTransportError(web_transport_quinn::WebTransportError::Closed(_, _))) {
|
||||
return game_realtime_transport_lib::TransportErrorKind::Closed;
|
||||
}
|
||||
return game_realtime_transport_lib::TransportErrorKind::Io;
|
||||
}
|
||||
|
||||
fn map_write_error(error: web_transport_quinn::WriteError) -> game_realtime_transport_lib::TransportError {
|
||||
let kind = match &error {
|
||||
web_transport_quinn::WriteError::Stopped(_) => game_realtime_transport_lib::TransportErrorKind::Aborted,
|
||||
web_transport_quinn::WriteError::ClosedStream => game_realtime_transport_lib::TransportErrorKind::Closed,
|
||||
web_transport_quinn::WriteError::SessionError(session) => map_session_error_kind(session),
|
||||
web_transport_quinn::WriteError::InvalidStopped(_) => game_realtime_transport_lib::TransportErrorKind::Protocol,
|
||||
};
|
||||
return transport_error(kind, error.to_string());
|
||||
}
|
||||
|
||||
fn message_too_large(payload_len: usize, max_message_size: usize) -> game_realtime_transport_lib::TransportError {
|
||||
return transport_error(
|
||||
game_realtime_transport_lib::TransportErrorKind::MessageTooLarge,
|
||||
format!("WebTransport primary frame payload size {payload_len} exceeds configured maximum {max_message_size} bytes"),
|
||||
);
|
||||
}
|
||||
|
||||
fn protocol_error(detail: impl Into<String>) -> game_realtime_transport_lib::TransportError {
|
||||
return transport_error(game_realtime_transport_lib::TransportErrorKind::Protocol, detail);
|
||||
}
|
||||
|
||||
fn timeout_error(operation: &str, timeout: std::time::Duration) -> game_realtime_transport_lib::TransportError {
|
||||
return transport_error(
|
||||
game_realtime_transport_lib::TransportErrorKind::Timeout,
|
||||
format!("{operation} exceeded configured deadline of {} ms", duration_millis(timeout)),
|
||||
);
|
||||
}
|
||||
|
||||
fn duration_millis(duration: std::time::Duration) -> u128 {
|
||||
return duration.as_millis();
|
||||
}
|
||||
|
||||
fn transport_error(kind: game_realtime_transport_lib::TransportErrorKind, detail: impl Into<String>) -> game_realtime_transport_lib::TransportError {
|
||||
return game_realtime_transport_lib::TransportError::new(kind, detail);
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
#[path = "../unit_tests/webtransport.rs"]
|
||||
mod tests;
|
||||
@@ -0,0 +1,77 @@
|
||||
// file: crates/common/game-realtime-webtransport-lib/tests/establishment.rs
|
||||
// version: 2
|
||||
|
||||
//! Deterministic native loopback proof for WebTransport session establishment and SHA-256 pinning.
|
||||
|
||||
const TEST_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(5);
|
||||
|
||||
fn normalized_socket_addr(value: std::net::SocketAddr) -> std::net::SocketAddr {
|
||||
match value {
|
||||
std::net::SocketAddr::V4(_) => return value,
|
||||
std::net::SocketAddr::V6(ipv6) => match ipv6.ip().to_ipv4_mapped() {
|
||||
Some(ipv4) => return std::net::SocketAddr::new(std::net::IpAddr::V4(ipv4), ipv6.port()),
|
||||
None => return std::net::SocketAddr::V6(ipv6),
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn pinned_client_and_server_establish_a_loopback_session() {
|
||||
let identity = match game_realtime_webtransport_lib::WebTransportServerIdentity::generate_loopback() {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("loopback identity generation failed: {error}"),
|
||||
};
|
||||
let certificate_hash = identity.certificate_hash().clone();
|
||||
let server_config = game_realtime_webtransport_lib::WebTransportServerConfig::new(std::net::SocketAddr::from(([127, 0, 0, 1], 0)), identity);
|
||||
let mut listener = match game_realtime_webtransport_lib::WebTransportListener::bind(server_config) {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("WebTransport listener bind failed: {error}"),
|
||||
};
|
||||
let endpoint = format!("https://{}/establishment", listener.local_addr());
|
||||
let client_config = match game_realtime_webtransport_lib::WebTransportClientConfig::new(endpoint.as_str(), certificate_hash) {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("WebTransport client configuration failed: {error}"),
|
||||
};
|
||||
let pair = tokio::time::timeout(TEST_TIMEOUT, async {
|
||||
return tokio::join!(listener.accept(), game_realtime_webtransport_lib::connect(&client_config));
|
||||
})
|
||||
.await;
|
||||
let (server_session, client_session) = match pair {
|
||||
Ok((Ok(server), Ok(client))) => (server, client),
|
||||
Ok((Err(error), _)) => panic!("WebTransport server establishment failed: {error}"),
|
||||
Ok((_, Err(error))) => panic!("WebTransport client establishment failed: {error}"),
|
||||
Err(_) => panic!("WebTransport loopback establishment timed out"),
|
||||
};
|
||||
assert_eq!(client_session.request_url(), Some(endpoint.as_str()));
|
||||
assert_eq!(server_session.request_url(), Some(endpoint.as_str()));
|
||||
assert_eq!(normalized_socket_addr(client_session.remote_addr()), normalized_socket_addr(listener.local_addr()));
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn incorrect_certificate_pin_rejects_establishment() {
|
||||
let identity = match game_realtime_webtransport_lib::WebTransportServerIdentity::generate_loopback() {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("loopback identity generation failed: {error}"),
|
||||
};
|
||||
let server_config = game_realtime_webtransport_lib::WebTransportServerConfig::new(std::net::SocketAddr::from(([127, 0, 0, 1], 0)), identity);
|
||||
let mut listener = match game_realtime_webtransport_lib::WebTransportListener::bind(server_config) {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("WebTransport listener bind failed: {error}"),
|
||||
};
|
||||
let endpoint = format!("https://{}/wrong-pin", listener.local_addr());
|
||||
let wrong_hash = game_realtime_webtransport_lib::WebTransportCertificateHash::from_sha256([0_u8; 32]);
|
||||
let client_config = match game_realtime_webtransport_lib::WebTransportClientConfig::new(endpoint.as_str(), wrong_hash) {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("WebTransport client configuration failed: {error}"),
|
||||
};
|
||||
let (server_result, client_result) = tokio::join!(
|
||||
tokio::time::timeout(TEST_TIMEOUT, listener.accept()),
|
||||
tokio::time::timeout(TEST_TIMEOUT, game_realtime_webtransport_lib::connect(&client_config)),
|
||||
);
|
||||
match client_result {
|
||||
Ok(Ok(_)) => panic!("WebTransport establishment unexpectedly accepted an incorrect certificate pin"),
|
||||
Ok(Err(error)) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::Connect),
|
||||
Err(_) => panic!("incorrect-pin connection attempt timed out"),
|
||||
}
|
||||
assert!(matches!(server_result, Err(_) | Ok(Err(_))));
|
||||
}
|
||||
@@ -0,0 +1,89 @@
|
||||
// file: crates/common/game-realtime-webtransport-lib/tests/realtime_connection.rs
|
||||
// version: 1
|
||||
|
||||
//! Deterministic loopback proof for the primary reliable WebTransport stream and transport-neutral framing contract.
|
||||
|
||||
const TEST_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(5);
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn primary_stream_round_trip_is_binary_ordered_and_closes_cleanly() {
|
||||
let identity = match game_realtime_webtransport_lib::WebTransportServerIdentity::generate_loopback() {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("loopback identity generation failed: {error}"),
|
||||
};
|
||||
let certificate_hash = identity.certificate_hash().clone();
|
||||
let server_config = game_realtime_webtransport_lib::WebTransportServerConfig::new(std::net::SocketAddr::from(([127, 0, 0, 1], 0)), identity);
|
||||
let mut listener = match game_realtime_webtransport_lib::WebTransportListener::bind(server_config) {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("WebTransport listener bind failed: {error}"),
|
||||
};
|
||||
let endpoint = format!("https://{}/realtime", listener.local_addr());
|
||||
let client_config = match game_realtime_webtransport_lib::WebTransportClientConfig::new(endpoint.as_str(), certificate_hash) {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("WebTransport client configuration failed: {error}"),
|
||||
};
|
||||
let sessions = tokio::time::timeout(TEST_TIMEOUT, async {
|
||||
return tokio::join!(listener.accept(), game_realtime_webtransport_lib::connect(&client_config));
|
||||
})
|
||||
.await;
|
||||
let (server_session, client_session) = match sessions {
|
||||
Ok((Ok(server), Ok(client))) => (server, client),
|
||||
Ok((Err(error), _)) => panic!("WebTransport server establishment failed: {error}"),
|
||||
Ok((_, Err(error))) => panic!("WebTransport client establishment failed: {error}"),
|
||||
Err(_) => panic!("WebTransport loopback establishment timed out"),
|
||||
};
|
||||
let client_connection = match client_session.open_primary_connection().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("client primary stream open failed: {error}"),
|
||||
};
|
||||
let (mut client_sender, mut client_receiver) = game_realtime_transport_lib::RealtimeConnection::split(client_connection);
|
||||
let server_connection = match tokio::time::timeout(TEST_TIMEOUT, server_session.accept_primary_connection()).await {
|
||||
Ok(Ok(connection)) => connection,
|
||||
Ok(Err(error)) => panic!("server primary stream accept failed: {error}"),
|
||||
Err(_) => panic!("server primary stream accept timed out"),
|
||||
};
|
||||
let (mut server_sender, mut server_receiver) = game_realtime_transport_lib::RealtimeConnection::split(server_connection);
|
||||
let first_payload = Vec::new();
|
||||
send_payload(&mut client_sender, first_payload.clone(), "client first send").await;
|
||||
assert_received_payload(&mut server_receiver, first_payload.clone(), "server first receive").await;
|
||||
send_payload(&mut server_sender, first_payload.clone(), "server first echo").await;
|
||||
assert_received_payload(&mut client_receiver, first_payload, "client first echo receive").await;
|
||||
let remaining_payloads = [vec![0x00, 0x7f, 0x80, 0xff], b"third-message".to_vec()];
|
||||
for payload in remaining_payloads {
|
||||
send_payload(&mut client_sender, payload.clone(), "client ordered send").await;
|
||||
assert_received_payload(&mut server_receiver, payload.clone(), "server ordered receive").await;
|
||||
send_payload(&mut server_sender, payload.clone(), "server ordered echo").await;
|
||||
assert_received_payload(&mut client_receiver, payload, "client ordered echo receive").await;
|
||||
}
|
||||
if let Err(error) = game_realtime_transport_lib::RealtimeSender::close(&mut client_sender).await {
|
||||
panic!("client sender close failed: {error}");
|
||||
}
|
||||
assert_closed(&mut server_receiver, "server remote close").await;
|
||||
if let Err(error) = game_realtime_transport_lib::RealtimeSender::close(&mut server_sender).await {
|
||||
panic!("server sender close failed: {error}");
|
||||
}
|
||||
assert_closed(&mut client_receiver, "client remote close").await;
|
||||
}
|
||||
|
||||
async fn assert_closed(receiver: &mut game_realtime_webtransport_lib::WebTransportReceiver, label: &str) {
|
||||
let received = match game_realtime_transport_lib::RealtimeReceiver::receive(receiver).await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("{label} failed: {error}"),
|
||||
};
|
||||
assert_eq!(received, game_realtime_transport_lib::TransportReceive::Closed);
|
||||
}
|
||||
|
||||
async fn assert_received_payload(receiver: &mut game_realtime_webtransport_lib::WebTransportReceiver, payload: Vec<u8>, label: &str) {
|
||||
let received = match game_realtime_transport_lib::RealtimeReceiver::receive(receiver).await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("{label} failed: {error}"),
|
||||
};
|
||||
assert_eq!(received, game_realtime_transport_lib::TransportReceive::Message(game_realtime_transport_lib::TransportMessage::new(payload)));
|
||||
}
|
||||
|
||||
async fn send_payload(sender: &mut game_realtime_webtransport_lib::WebTransportSender, payload: Vec<u8>, label: &str) {
|
||||
let message = game_realtime_transport_lib::TransportMessage::new(payload);
|
||||
if let Err(error) = game_realtime_transport_lib::RealtimeSender::send(sender, message).await {
|
||||
panic!("{label} failed: {error}");
|
||||
}
|
||||
}
|
||||
146
crates/common/game-realtime-webtransport-lib/tests/robustness.rs
Normal file
146
crates/common/game-realtime-webtransport-lib/tests/robustness.rs
Normal file
@@ -0,0 +1,146 @@
|
||||
// file: crates/common/game-realtime-webtransport-lib/tests/robustness.rs
|
||||
// version: 2
|
||||
|
||||
//! Negative and bounded lifecycle tests for the native reliable WebTransport backend.
|
||||
|
||||
const SHORT_OPERATION_TIMEOUT: std::time::Duration = std::time::Duration::from_millis(50);
|
||||
const SMALL_MESSAGE_LIMIT: usize = 32;
|
||||
const TEST_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(3);
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn outbound_payload_over_the_configured_limit_is_rejected_before_write() {
|
||||
let config = game_realtime_webtransport_lib::WebTransportConfig::default().with_max_message_size(SMALL_MESSAGE_LIMIT);
|
||||
let (_server_connection, client_connection) = establish_backend_pair(config, config).await;
|
||||
let (mut client_sender, _client_receiver) = game_realtime_transport_lib::RealtimeConnection::split(client_connection);
|
||||
let oversized = game_realtime_transport_lib::TransportMessage::new(vec![7; SMALL_MESSAGE_LIMIT + 1]);
|
||||
let result = game_realtime_transport_lib::RealtimeSender::send(&mut client_sender, oversized).await;
|
||||
match result {
|
||||
Ok(()) => panic!("oversized outbound WebTransport payload was accepted"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::MessageTooLarge),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn inbound_payload_over_the_configured_limit_is_rejected_before_allocation() {
|
||||
let server_config = game_realtime_webtransport_lib::WebTransportConfig::default().with_max_message_size(SMALL_MESSAGE_LIMIT);
|
||||
let client_config = game_realtime_webtransport_lib::WebTransportConfig::default().with_max_message_size(SMALL_MESSAGE_LIMIT + 1);
|
||||
let (server_connection, client_connection) = establish_backend_pair(server_config, client_config).await;
|
||||
let (_server_sender, mut server_receiver) = game_realtime_transport_lib::RealtimeConnection::split(server_connection);
|
||||
let (mut client_sender, _client_receiver) = game_realtime_transport_lib::RealtimeConnection::split(client_connection);
|
||||
let payload = game_realtime_transport_lib::TransportMessage::new(vec![3; SMALL_MESSAGE_LIMIT + 1]);
|
||||
if let Err(error) = game_realtime_transport_lib::RealtimeSender::send(&mut client_sender, payload).await {
|
||||
panic!("client failed to send payload allowed by its local bound: {error}");
|
||||
}
|
||||
let receive = tokio::time::timeout(TEST_TIMEOUT, game_realtime_transport_lib::RealtimeReceiver::receive(&mut server_receiver)).await;
|
||||
match receive {
|
||||
Ok(Ok(value)) => panic!("oversized inbound WebTransport payload produced a successful receive: {value:?}"),
|
||||
Ok(Err(error)) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::MessageTooLarge),
|
||||
Err(_) => panic!("oversized inbound WebTransport payload did not complete within the test timeout"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn explicit_sender_abort_is_observed_as_aborted_receive() {
|
||||
let config = game_realtime_webtransport_lib::WebTransportConfig::default();
|
||||
let (server_connection, client_connection) = establish_backend_pair(config, config).await;
|
||||
let (_server_sender, mut server_receiver) = game_realtime_transport_lib::RealtimeConnection::split(server_connection);
|
||||
let (mut client_sender, _client_receiver) = game_realtime_transport_lib::RealtimeConnection::split(client_connection);
|
||||
if let Err(error) = client_sender.abort(0x41) {
|
||||
panic!("client sender abort failed: {error}");
|
||||
}
|
||||
let receive = tokio::time::timeout(TEST_TIMEOUT, game_realtime_transport_lib::RealtimeReceiver::receive(&mut server_receiver)).await;
|
||||
match receive {
|
||||
Ok(Ok(value)) => panic!("reset WebTransport stream produced a successful receive: {value:?}"),
|
||||
Ok(Err(error)) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::Aborted),
|
||||
Err(_) => panic!("peer reset was not observed within the test timeout"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn explicit_receiver_abort_makes_the_local_receive_half_terminal() {
|
||||
let config = game_realtime_webtransport_lib::WebTransportConfig::default();
|
||||
let (server_connection, _client_connection) = establish_backend_pair(config, config).await;
|
||||
let (_server_sender, mut server_receiver) = game_realtime_transport_lib::RealtimeConnection::split(server_connection);
|
||||
if let Err(error) = server_receiver.abort(0x42) {
|
||||
panic!("server receiver abort failed: {error}");
|
||||
}
|
||||
let result = game_realtime_transport_lib::RealtimeReceiver::receive(&mut server_receiver).await;
|
||||
match result {
|
||||
Ok(value) => panic!("aborted WebTransport receiver produced a successful receive: {value:?}"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::Aborted),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn dropping_sender_without_close_resets_the_stream_instead_of_synthesizing_fin() {
|
||||
let config = game_realtime_webtransport_lib::WebTransportConfig::default();
|
||||
let (server_connection, client_connection) = establish_backend_pair(config, config).await;
|
||||
let (_server_sender, mut server_receiver) = game_realtime_transport_lib::RealtimeConnection::split(server_connection);
|
||||
let (client_sender, _client_receiver) = game_realtime_transport_lib::RealtimeConnection::split(client_connection);
|
||||
drop(client_sender);
|
||||
let receive = tokio::time::timeout(TEST_TIMEOUT, game_realtime_transport_lib::RealtimeReceiver::receive(&mut server_receiver)).await;
|
||||
match receive {
|
||||
Ok(Ok(value)) => panic!("dropped WebTransport sender produced a clean receive result: {value:?}"),
|
||||
Ok(Err(error)) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::Aborted),
|
||||
Err(_) => panic!("sender drop reset was not observed within the test timeout"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn primary_stream_accept_honors_the_configured_deadline() {
|
||||
let config = game_realtime_webtransport_lib::WebTransportConfig::default().with_primary_stream_timeout(SHORT_OPERATION_TIMEOUT);
|
||||
let (server_session, _client_session) = establish_sessions(config, config).await;
|
||||
let result = server_session.accept_primary_connection().await;
|
||||
match result {
|
||||
Ok(_) => panic!("primary stream accept unexpectedly succeeded without a peer-created stream"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::Timeout),
|
||||
}
|
||||
}
|
||||
|
||||
async fn establish_backend_pair(
|
||||
server_transport: game_realtime_webtransport_lib::WebTransportConfig,
|
||||
client_transport: game_realtime_webtransport_lib::WebTransportConfig,
|
||||
) -> (game_realtime_webtransport_lib::WebTransportConnection, game_realtime_webtransport_lib::WebTransportConnection) {
|
||||
let (server_session, client_session) = establish_sessions(server_transport, client_transport).await;
|
||||
let client_connection = match client_session.open_primary_connection().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("client primary stream open failed: {error}"),
|
||||
};
|
||||
let server_connection = match server_session.accept_primary_connection().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("server primary stream accept failed: {error}"),
|
||||
};
|
||||
return (server_connection, client_connection);
|
||||
}
|
||||
|
||||
async fn establish_sessions(
|
||||
server_transport: game_realtime_webtransport_lib::WebTransportConfig,
|
||||
client_transport: game_realtime_webtransport_lib::WebTransportConfig,
|
||||
) -> (game_realtime_webtransport_lib::WebTransportSession, game_realtime_webtransport_lib::WebTransportSession) {
|
||||
let identity = match game_realtime_webtransport_lib::WebTransportServerIdentity::generate_loopback() {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("loopback identity generation failed: {error}"),
|
||||
};
|
||||
let certificate_hash = identity.certificate_hash().clone();
|
||||
let server_config = game_realtime_webtransport_lib::WebTransportServerConfig::new(std::net::SocketAddr::from(([127, 0, 0, 1], 0)), identity)
|
||||
.with_transport_config(server_transport);
|
||||
let mut listener = match game_realtime_webtransport_lib::WebTransportListener::bind(server_config) {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("WebTransport listener bind failed: {error}"),
|
||||
};
|
||||
let endpoint = format!("https://{}/robustness", listener.local_addr());
|
||||
let client_config = match game_realtime_webtransport_lib::WebTransportClientConfig::new(endpoint.as_str(), certificate_hash) {
|
||||
Ok(value) => value.with_transport_config(client_transport),
|
||||
Err(error) => panic!("WebTransport client configuration failed: {error}"),
|
||||
};
|
||||
let sessions = tokio::time::timeout(TEST_TIMEOUT, async {
|
||||
return tokio::join!(listener.accept(), game_realtime_webtransport_lib::connect(&client_config));
|
||||
})
|
||||
.await;
|
||||
return match sessions {
|
||||
Ok((Ok(server), Ok(client))) => (server, client),
|
||||
Ok((Err(error), _)) => panic!("WebTransport server establishment failed: {error}"),
|
||||
Ok((_, Err(error))) => panic!("WebTransport client establishment failed: {error}"),
|
||||
Err(_) => panic!("WebTransport loopback establishment timed out"),
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
// file: crates/common/game-realtime-webtransport-lib/unit_tests/config.rs
|
||||
// version: 1
|
||||
|
||||
#[test]
|
||||
fn defaults_are_valid_and_preserve_the_one_mib_baseline() {
|
||||
let config = super::WebTransportConfig::default();
|
||||
assert!(config.validate().is_ok());
|
||||
assert_eq!(config.max_message_size(), 1024 * 1024);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn zero_limits_and_deadlines_are_rejected() {
|
||||
let cases = [
|
||||
super::WebTransportConfig::default().with_max_message_size(0),
|
||||
super::WebTransportConfig::default().with_connect_timeout(std::time::Duration::ZERO),
|
||||
super::WebTransportConfig::default().with_primary_stream_timeout(std::time::Duration::ZERO),
|
||||
super::WebTransportConfig::default().with_send_timeout(std::time::Duration::ZERO),
|
||||
];
|
||||
for config in cases {
|
||||
let result = config.validate();
|
||||
match result {
|
||||
Ok(()) => panic!("invalid WebTransport configuration unexpectedly accepted"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration),
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,194 @@
|
||||
// file: crates/common/game-realtime-webtransport-lib/unit_tests/webtransport.rs
|
||||
// version: 4
|
||||
|
||||
const TEST_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(3);
|
||||
|
||||
#[test]
|
||||
fn certificate_hash_preserves_exact_sha256_bytes() {
|
||||
let bytes = [7_u8; super::CERTIFICATE_HASH_SIZE];
|
||||
let hash = super::WebTransportCertificateHash::from_sha256(bytes);
|
||||
assert_eq!(hash.as_bytes(), &bytes);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn client_config_accepts_https_and_rejects_non_secure_schemes() {
|
||||
let hash = super::WebTransportCertificateHash::from_sha256([1_u8; super::CERTIFICATE_HASH_SIZE]);
|
||||
let secure = super::WebTransportClientConfig::new("https://127.0.0.1:4433/game", hash.clone());
|
||||
assert!(secure.is_ok());
|
||||
let insecure_http = super::WebTransportClientConfig::new("http://127.0.0.1:4433/game", hash.clone());
|
||||
match insecure_http {
|
||||
Ok(_) => panic!("HTTP endpoint unexpectedly accepted"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration),
|
||||
}
|
||||
let websocket = super::WebTransportClientConfig::new("ws://127.0.0.1:4433/game", hash);
|
||||
match websocket {
|
||||
Ok(_) => panic!("WebSocket endpoint unexpectedly accepted"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn frame_header_is_big_endian_and_configured_payload_bound_is_enforced() {
|
||||
let header = match super::frame_header(0x00_01_02_03, 1024 * 1024) {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("valid frame header rejected: {error}"),
|
||||
};
|
||||
assert_eq!(header, [0x00, 0x01, 0x02, 0x03]);
|
||||
let oversized = super::frame_header(33, 32);
|
||||
match oversized {
|
||||
Ok(_) => panic!("oversized WebTransport frame unexpectedly accepted"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::MessageTooLarge),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn stream_error_mapping_distinguishes_abort_close_and_protocol_failures() {
|
||||
let stopped = super::map_write_error(web_transport_quinn::WriteError::Stopped(7));
|
||||
assert_eq!(stopped.kind(), game_realtime_transport_lib::TransportErrorKind::Aborted);
|
||||
let reset = super::map_read_error(web_transport_quinn::ReadError::Reset(8));
|
||||
assert_eq!(reset.kind(), game_realtime_transport_lib::TransportErrorKind::Aborted);
|
||||
let closed = super::map_read_error(web_transport_quinn::ReadError::SessionError(web_transport_quinn::SessionError::WebTransportError(
|
||||
web_transport_quinn::WebTransportError::Closed(9, "done".to_owned()),
|
||||
)));
|
||||
assert_eq!(closed.kind(), game_realtime_transport_lib::TransportErrorKind::Closed);
|
||||
let protocol = super::map_read_error(web_transport_quinn::ReadError::IllegalOrderedRead);
|
||||
assert_eq!(protocol.kind(), game_realtime_transport_lib::TransportErrorKind::Protocol);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn generated_loopback_identity_has_sha256_fingerprint() {
|
||||
let identity = match super::WebTransportServerIdentity::generate_loopback() {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("loopback identity generation failed: {error}"),
|
||||
};
|
||||
assert_eq!(identity.certificate_hash().as_bytes().len(), super::CERTIFICATE_HASH_SIZE);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn injected_identity_rejects_empty_certificate_or_key() {
|
||||
let missing_certificate = super::WebTransportServerIdentity::from_pkcs8_der(Vec::new(), vec![1]);
|
||||
match missing_certificate {
|
||||
Ok(_) => panic!("empty certificate unexpectedly accepted"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration),
|
||||
}
|
||||
let missing_key = super::WebTransportServerIdentity::from_pkcs8_der(vec![1], Vec::new());
|
||||
match missing_key {
|
||||
Ok(_) => panic!("empty private key unexpectedly accepted"),
|
||||
Err(error) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::InvalidConfiguration),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn cancelled_receive_preserves_partial_frame_state() {
|
||||
let (server_session, client_session) = establish_private_sessions().await;
|
||||
let (mut raw_sender, _raw_receiver) = match client_session.inner.open_bi().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("raw client stream open failed: {error}"),
|
||||
};
|
||||
let (server_sender, server_receiver) = match server_session.inner.accept_bi().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("raw server stream accept failed: {error}"),
|
||||
};
|
||||
let server_connection = super::WebTransportConnection::new(server_session.inner, server_sender, server_receiver, server_session.transport);
|
||||
let (_server_sender, mut server_receiver) = game_realtime_transport_lib::RealtimeConnection::split(server_connection);
|
||||
if let Err(error) = raw_sender.write_all(&[0x00, 0x00]).await {
|
||||
panic!("partial frame header write failed: {error}");
|
||||
}
|
||||
tokio::time::sleep(std::time::Duration::from_millis(20)).await;
|
||||
let first_receive =
|
||||
tokio::time::timeout(std::time::Duration::from_millis(100), game_realtime_transport_lib::RealtimeReceiver::receive(&mut server_receiver)).await;
|
||||
assert!(first_receive.is_err());
|
||||
assert_eq!(server_receiver.header_read, 2);
|
||||
if let Err(error) = raw_sender.write_all(&[0x00, 0x03, 0x10, 0x20, 0x30]).await {
|
||||
panic!("remaining frame write failed: {error}");
|
||||
}
|
||||
let second_receive = tokio::time::timeout(TEST_TIMEOUT, game_realtime_transport_lib::RealtimeReceiver::receive(&mut server_receiver)).await;
|
||||
match second_receive {
|
||||
Ok(Ok(game_realtime_transport_lib::TransportReceive::Message(message))) => assert_eq!(message.as_bytes(), &[0x10, 0x20, 0x30]),
|
||||
Ok(Ok(value)) => panic!("resumed receive returned unexpected result: {value:?}"),
|
||||
Ok(Err(error)) => panic!("resumed receive failed: {error}"),
|
||||
Err(_) => panic!("resumed receive timed out"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn truncated_frame_payload_is_a_protocol_failure() {
|
||||
let (server_session, client_session) = establish_private_sessions().await;
|
||||
let (mut raw_sender, _raw_receiver) = match client_session.inner.open_bi().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("raw client stream open failed: {error}"),
|
||||
};
|
||||
let (server_sender, server_receiver) = match server_session.inner.accept_bi().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("raw server stream accept failed: {error}"),
|
||||
};
|
||||
let server_connection = super::WebTransportConnection::new(server_session.inner, server_sender, server_receiver, server_session.transport);
|
||||
let (_server_sender, mut server_receiver) = game_realtime_transport_lib::RealtimeConnection::split(server_connection);
|
||||
if let Err(error) = raw_sender.write_all(&[0x00, 0x00, 0x00, 0x03, 0x10]).await {
|
||||
panic!("truncated frame payload write failed: {error}");
|
||||
}
|
||||
if let Err(error) = raw_sender.finish() {
|
||||
panic!("raw client stream finish failed: {error}");
|
||||
}
|
||||
let receive = tokio::time::timeout(TEST_TIMEOUT, game_realtime_transport_lib::RealtimeReceiver::receive(&mut server_receiver)).await;
|
||||
match receive {
|
||||
Ok(Ok(value)) => panic!("truncated frame payload produced a successful receive: {value:?}"),
|
||||
Ok(Err(error)) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::Protocol),
|
||||
Err(_) => panic!("truncated frame payload was not rejected within the test timeout"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn truncated_frame_header_is_a_protocol_failure() {
|
||||
let (server_session, client_session) = establish_private_sessions().await;
|
||||
let (mut raw_sender, _raw_receiver) = match client_session.inner.open_bi().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("raw client stream open failed: {error}"),
|
||||
};
|
||||
let (server_sender, server_receiver) = match server_session.inner.accept_bi().await {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("raw server stream accept failed: {error}"),
|
||||
};
|
||||
let server_connection = super::WebTransportConnection::new(server_session.inner, server_sender, server_receiver, server_session.transport);
|
||||
let (_server_sender, mut server_receiver) = game_realtime_transport_lib::RealtimeConnection::split(server_connection);
|
||||
if let Err(error) = raw_sender.write_all(&[0x00, 0x00]).await {
|
||||
panic!("partial frame header write failed: {error}");
|
||||
}
|
||||
if let Err(error) = raw_sender.finish() {
|
||||
panic!("raw client stream finish failed: {error}");
|
||||
}
|
||||
let receive = tokio::time::timeout(TEST_TIMEOUT, game_realtime_transport_lib::RealtimeReceiver::receive(&mut server_receiver)).await;
|
||||
match receive {
|
||||
Ok(Ok(value)) => panic!("truncated frame header produced a successful receive: {value:?}"),
|
||||
Ok(Err(error)) => assert_eq!(error.kind(), game_realtime_transport_lib::TransportErrorKind::Protocol),
|
||||
Err(_) => panic!("truncated frame header was not rejected within the test timeout"),
|
||||
}
|
||||
}
|
||||
|
||||
async fn establish_private_sessions() -> (super::WebTransportSession, super::WebTransportSession) {
|
||||
let identity = match super::WebTransportServerIdentity::generate_loopback() {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("loopback identity generation failed: {error}"),
|
||||
};
|
||||
let certificate_hash = identity.certificate_hash().clone();
|
||||
let server_config = super::WebTransportServerConfig::new(std::net::SocketAddr::from(([127, 0, 0, 1], 0)), identity);
|
||||
let mut listener = match super::WebTransportListener::bind(server_config) {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("WebTransport listener bind failed: {error}"),
|
||||
};
|
||||
let endpoint = format!("https://{}/private-test", listener.local_addr());
|
||||
let client_config = match super::WebTransportClientConfig::new(endpoint.as_str(), certificate_hash) {
|
||||
Ok(value) => value,
|
||||
Err(error) => panic!("WebTransport client configuration failed: {error}"),
|
||||
};
|
||||
let pair = tokio::time::timeout(TEST_TIMEOUT, async {
|
||||
return tokio::join!(listener.accept(), super::connect(&client_config));
|
||||
})
|
||||
.await;
|
||||
return match pair {
|
||||
Ok((Ok(server), Ok(client))) => (server, client),
|
||||
Ok((Err(error), _)) => panic!("WebTransport server establishment failed: {error}"),
|
||||
Ok((_, Err(error))) => panic!("WebTransport client establishment failed: {error}"),
|
||||
Err(_) => panic!("WebTransport private loopback establishment timed out"),
|
||||
};
|
||||
}
|
||||
246
deltas/0.3.4/alpha.1.md
Normal file
246
deltas/0.3.4/alpha.1.md
Normal file
@@ -0,0 +1,246 @@
|
||||
<!-- file: deltas/0.3.4/alpha.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.4-alpha.1
|
||||
|
||||
## Base
|
||||
|
||||
Base autoritaire : archive fournie `games-v0.3.3.zip`, téléchargée depuis le lien ZIP du tag Gitea `v0.3.3`.
|
||||
|
||||
La version workspace de la base est `0.3.3`. L'archive taggée est utilisée telle quelle conformément à `CMD-GIT-003` et `CMD-GIT-004`; aucun fichier local absent du ZIP n'est inventé ou réinjecté.
|
||||
|
||||
`0.3.2` reste différée conformément à la roadmap.
|
||||
|
||||
## Objet
|
||||
|
||||
Ouvrir `0.3.4` par le nouveau gate obligatoire `alpha.1` : migrer la nomenclature prospective de version, auditer complètement la stable et les règles, réévaluer les études réseau, vérifier les dépendances amont envisagées, décider l'ownership physique du transport realtime, fermer le contrat minimal WebSocket et créer le plan vivant jusqu'à stable.
|
||||
|
||||
Cette tranche n'ajoute volontairement aucune crate réseau, aucune dépendance Tokio/WebSocket et aucun comportement runtime. L'implémentation commence seulement après validation de ce cadrage.
|
||||
|
||||
## Migration de nomenclature
|
||||
|
||||
À partir de `0.3.4`, les nouvelles prereleases suivent exclusivement :
|
||||
|
||||
```text
|
||||
X.Y.Z-alpha.N
|
||||
X.Y.Z-alpha.N.fix.M
|
||||
X.Y.Z-beta.N
|
||||
X.Y.Z-beta.N.fix.M
|
||||
X.Y.Z-rc.N
|
||||
X.Y.Z-rc.N.fix.M
|
||||
X.Y.Z
|
||||
```
|
||||
|
||||
`alpha.1` remplace le rôle historique de `0-pre.1`.
|
||||
|
||||
La migration réconcilie les règles prospectives et les README/index actifs concernés. Les anciens deltas, historiques, prompts et entrées de changelog restent inchangés avec leurs identifiants `0-pre`, `1-alpha`, `2-beta` et `3-rc`.
|
||||
|
||||
L'audit workspace sépare désormais explicitement :
|
||||
|
||||
- la convention courante, exigée pour le workspace et les versions explicites des crates ;
|
||||
- la convention historique, acceptée uniquement pour les répertoires de versions déjà livrés avant `0.3.4`.
|
||||
|
||||
Ainsi un nouveau jalon `0.3.4-0-pre.*` est refusé sans casser la lecture de l'historique existant.
|
||||
|
||||
## Version
|
||||
|
||||
La version workspace passe de :
|
||||
|
||||
```text
|
||||
0.3.3
|
||||
```
|
||||
|
||||
à :
|
||||
|
||||
```text
|
||||
0.3.4-alpha.1
|
||||
```
|
||||
|
||||
Aucune version npm/Tauri/Android n'est synchronisée : cette tranche ne change aucun produit packagé.
|
||||
|
||||
## Audit de l'archive
|
||||
|
||||
Avant modification, l'environnement de génération a obtenu :
|
||||
|
||||
```text
|
||||
unzip -t : no errors
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 242 file(s))
|
||||
Distribution layout audit: clean (49 required path(s), 8 forbidden path(s) absent)
|
||||
```
|
||||
|
||||
L'inventaire indépendant du ZIP confirme :
|
||||
|
||||
```text
|
||||
400 fichiers
|
||||
246 fichiers Markdown
|
||||
55 fichiers Rust
|
||||
15 Cargo.toml, dont le manifest racine
|
||||
14 membres workspace
|
||||
workspace.package.version = 0.3.3
|
||||
0 symlink
|
||||
0 erreur de chemin/archive détectée
|
||||
```
|
||||
|
||||
Aucune arborescence générée `target/`, `node_modules/`, `gen/android/` ou `build/` n'est livrée dans l'archive.
|
||||
|
||||
Le log utilisateur fourni à l'ouverture de session confirme également sur son checkout `0.3.3` : format Cargo propre, audits propres, `cargo check --workspace` et Clippy workspace strict réussis. Son audit Markdown annonce `258` fichiers, soit davantage que le ZIP taggé fourni. Cette différence n'est pas masquée : le delta est construit exclusivement depuis l'archive autoritaire reçue.
|
||||
|
||||
## Audit des règles
|
||||
|
||||
La lecture intégrale demandée par `prompts/005-V0_3_4_START_PROMPT.md` confirme notamment :
|
||||
|
||||
- `alpha.1` porte le cadrage, le sizing, les risques, les validations et le plan avant développement lourd ;
|
||||
- les archives taggées peuvent être utilisées sans `.git` et constituent la baseline de travail déclarée ;
|
||||
- les historiques validés sont immuables ;
|
||||
- le transport doit rester séparé du wire codec, de la session, de la synchronisation et de la simulation authoritative ;
|
||||
- aucune dépendance réseau concrète ne doit remonter dans le gameplay ;
|
||||
- les builds, tests et smokes finaux sont attestés côté utilisateur ;
|
||||
- une modification Cargo impose format/check/Clippy workspace côté utilisateur ;
|
||||
- `CHANGELOG.md` reste silencieux avant RC et `ROADMAP.md` reste macroscopique.
|
||||
|
||||
La recherche prospective a trouvé des références à l'ancienne nomenclature au-delà des six fichiers minimum du prompt. `RULES_VALIDATION_MATRIX.md`, `docs/plans/000-README.md`, `history/000-README.md` et le `README.md` racine sont donc également réconciliés lorsqu'ils décrivent le workflow courant. Les références historiques restent intactes.
|
||||
|
||||
Aucune contradiction bloquante n'est trouvée entre le prompt, les règles, la roadmap, les études réseau et la baseline `v0.3.3`.
|
||||
|
||||
## Vérification des dépendances envisagées
|
||||
|
||||
État amont vérifié le 2026-09-21 pour préparer les tranches d'implémentation :
|
||||
|
||||
```text
|
||||
Tokio 1.53.1
|
||||
futures-util 0.3.34
|
||||
tokio-tungstenite 0.30.0
|
||||
tungstenite 0.30.0
|
||||
```
|
||||
|
||||
Constats retenus :
|
||||
|
||||
- Tokio `1.53.1` annonce un MSRV `1.71` ;
|
||||
- `tokio-tungstenite 0.30.0` et `tungstenite 0.30.0` annoncent un MSRV `1.85` ;
|
||||
- `tokio-tungstenite` fournit `connect`/`handshake` par défaut mais pas de backend TLS obligatoire ;
|
||||
- les features `native-tls` et `rustls-*` restent optionnelles ;
|
||||
- Tungstenite expose déjà des limites configurables de message, frame et write buffer.
|
||||
|
||||
Aucune de ces dépendances n'est ajoutée dans `alpha.1`. Le plan les introduira uniquement dans la crate backend qui les consomme.
|
||||
|
||||
## Ownership et contrat retenus
|
||||
|
||||
Le plan `docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md` retient deux frontières physiques :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-transport-lib
|
||||
crates/common/game-realtime-websocket-lib
|
||||
```
|
||||
|
||||
`game-realtime-transport-lib` portera uniquement le contrat transport-neutral : payload binaire opaque, send/receive/close, fermeture distante, erreurs transport-neutral et split concurrent. Elle ne dépendra ni de Tokio ni de Tungstenite.
|
||||
|
||||
`game-realtime-websocket-lib` portera l'établissement client/server, Tokio, `tokio-tungstenite`, le mapping des frames, les limites, timeouts, close handshake, tracing et tests loopback localhost.
|
||||
|
||||
Décisions structurantes :
|
||||
|
||||
- runtime Tokio possédé par l'application/service/test consommateur, jamais créé globalement par le backend ;
|
||||
- aucune tâche backend détachée nécessaire au chemin de base ;
|
||||
- aucun codec métier dans `0.3.4` : le transport véhicule des octets opaques ;
|
||||
- aucune abstraction générique `Connector`/`Provider`/runtime avant besoin démontré ;
|
||||
- baseline locale en `ws://`, sans choix TLS prématuré ;
|
||||
- aucune file interne non bornée ;
|
||||
- tests loopback sur `127.0.0.1:0`, sans Internet ni port fixe ;
|
||||
- aucune dépendance `tokio-tungstenite` dans `crates/games/` ou `crates/engines/`.
|
||||
|
||||
Les limites et timeouts candidats, le modèle d'erreur, le lifecycle, le tracing et la matrice de tests sont détaillés dans le plan actif. Les signatures Rust exactes restent volontairement à fermer dans `alpha.2`, après validation de ce cadrage.
|
||||
|
||||
## Forecast révisé
|
||||
|
||||
Le plan actif retient :
|
||||
|
||||
```text
|
||||
0.3.4-alpha.1 gouvernance + audit + ownership + contrat
|
||||
0.3.4-alpha.2 API game-realtime-transport-lib
|
||||
0.3.4-alpha.3 backend game-realtime-websocket-lib + loopback
|
||||
0.3.4-alpha.4 robustesse + limites + lifecycle + consolidation
|
||||
0.3.4-alpha.5 uniquement si un demo/consolidation autonome est réellement utile
|
||||
0.3.4-beta.1 validation large
|
||||
0.3.4-rc.1 candidate gelée + publication documentaire
|
||||
0.3.4 promotion mécanique stable
|
||||
```
|
||||
|
||||
Le scope reste compatible avec une seule version/session tant qu'il ne dérive pas vers le wire codec, la session multijoueur, TLS/PKI produit ou WebTransport/QUIC.
|
||||
|
||||
## Fichiers
|
||||
|
||||
Ajoutés :
|
||||
|
||||
```text
|
||||
deltas/0.3.4/alpha.1.md
|
||||
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
|
||||
```
|
||||
|
||||
Modifiés :
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
RULES.md
|
||||
docs/000-README.md
|
||||
docs/plans/000-README.md
|
||||
docs/rules/PROMPT_STRUCTURE.md
|
||||
docs/rules/RULES_DOCUMENTATION.md
|
||||
docs/rules/RULES_SESSION_PLANNING.md
|
||||
docs/rules/RULES_VALIDATION_MATRIX.md
|
||||
docs/rules/VERSION_WORKFLOW.md
|
||||
history/000-README.md
|
||||
scripts/audit_project_workspace_rules.py
|
||||
```
|
||||
|
||||
`ROADMAP.md`, `CHANGELOG.md`, les anciens prompts, anciens deltas et anciens historiques restent inchangés.
|
||||
|
||||
## Validations exécutées dans l'environnement de génération
|
||||
|
||||
Après constitution de l'état livré, le générateur a exécuté uniquement les audits statiques autorisés :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 244 file(s))
|
||||
Distribution layout audit: clean (49 required path(s), 8 forbidden path(s) absent)
|
||||
```
|
||||
|
||||
Le contrôle ciblé de politique de version a également obtenu :
|
||||
|
||||
```text
|
||||
history/0.3.4/0-pre.1.md -> DOC-010, rejet attendu
|
||||
history/0.3.4/alpha.1.md -> accepté
|
||||
targeted version-policy probe: clean
|
||||
```
|
||||
|
||||
L'historique antérieur à `0.3.4` reste accepté par l'audit workspace normal.
|
||||
|
||||
Aucun `cargo check`, Clippy, test ou smoke post-delta n'est attribué au générateur.
|
||||
|
||||
## Validation utilisateur demandée
|
||||
|
||||
Le manifest Cargo et l'audit Python changent. Depuis la racine :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
```
|
||||
|
||||
Aucun test workspace complet n'est demandé dans `alpha.1` : aucun code Rust, aucune dépendance réseau et aucun comportement runtime ne changent.
|
||||
|
||||
## Suite après validation
|
||||
|
||||
Si cette gate est propre, `alpha.2` crée `history/0.3.4/alpha.1.md` avec les sorties réellement obtenues, puis introduit `game-realtime-transport-lib` sans Tokio/Tungstenite.
|
||||
|
||||
Une erreur de migration, d'audit, de plan ou de versionnement produit d'abord `0.3.4-alpha.1.fix.N`.
|
||||
133
deltas/0.3.4/alpha.2.md
Normal file
133
deltas/0.3.4/alpha.2.md
Normal file
@@ -0,0 +1,133 @@
|
||||
<!-- file: deltas/0.3.4/alpha.2.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.4-alpha.2
|
||||
|
||||
## Base
|
||||
|
||||
Base : `0.3.4-alpha.1` validée par l'utilisateur le 2026-09-21.
|
||||
|
||||
Cette tranche matérialise uniquement la frontière transport-neutral prévue par le plan `0.3.4`. Elle n'ajoute encore ni Tokio, ni Tungstenite, ni socket, ni protocole de session/gameplay.
|
||||
|
||||
## Historique fermé
|
||||
|
||||
Ajout de :
|
||||
|
||||
```text
|
||||
history/0.3.4/alpha.1.md
|
||||
```
|
||||
|
||||
L'entrée enregistre les gates effectivement fournies par l'utilisateur pour `alpha.1`, notamment le rebuild complet après `cargo clean`, les audits propres, `cargo check --workspace` et Clippy workspace strict.
|
||||
|
||||
## Nouvelle crate `game-realtime-transport-lib`
|
||||
|
||||
Ajout de :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-transport-lib/Cargo.toml
|
||||
crates/common/game-realtime-transport-lib/src/lib.rs
|
||||
crates/common/game-realtime-transport-lib/src/connection.rs
|
||||
crates/common/game-realtime-transport-lib/src/error.rs
|
||||
crates/common/game-realtime-transport-lib/src/message.rs
|
||||
crates/common/game-realtime-transport-lib/unit_tests/contract.rs
|
||||
```
|
||||
|
||||
La crate appartient à `crates/common/` car le contrat realtime est indépendant d'une génération de moteur et d'un backend réseau concret.
|
||||
|
||||
Elle ne possède aucune dépendance tierce.
|
||||
|
||||
## Contrat public
|
||||
|
||||
Le payload transport est `TransportMessage`, un buffer binaire possédé sans sémantique gameplay ni codec.
|
||||
|
||||
`TransportReceive` distingue explicitement :
|
||||
|
||||
```text
|
||||
Message(TransportMessage)
|
||||
Closed
|
||||
```
|
||||
|
||||
Une fermeture distante propre n'est donc pas confondue avec une erreur I/O.
|
||||
|
||||
Les contrats sont :
|
||||
|
||||
```text
|
||||
RealtimeConnection
|
||||
RealtimeSender
|
||||
RealtimeReceiver
|
||||
```
|
||||
|
||||
`RealtimeConnection::split()` produit les deux moitiés indépendantes. Les opérations `send`, `close` et `receive` restent async sans imposer un runtime particulier.
|
||||
|
||||
L'implémentation du contrat utilise des futures associées GAT. Cette forme évite une allocation `Box<dyn Future>`, conserve le dispatch statique et n'impose pas de borne `Send` au niveau transport-neutral. Un backend natif reste libre de fournir des futures `Send`; un backend navigateur/WASM futur n'est pas exclu artificiellement.
|
||||
|
||||
## Erreurs
|
||||
|
||||
`TransportError` conserve une catégorie stable `TransportErrorKind` et un détail diagnostic backend-neutral.
|
||||
|
||||
Les catégories de baseline sont :
|
||||
|
||||
```text
|
||||
InvalidConfiguration
|
||||
Connect
|
||||
Bind
|
||||
Accept
|
||||
Timeout
|
||||
MessageTooLarge
|
||||
Backpressure
|
||||
Closed
|
||||
Io
|
||||
Protocol
|
||||
Aborted
|
||||
```
|
||||
|
||||
Les futurs types d'erreur Tungstenite ne sont pas exposés par cette crate.
|
||||
|
||||
## Tests
|
||||
|
||||
Les tests unitaires couvrent :
|
||||
|
||||
- conservation du payload binaire possédé, y compris le payload vide ;
|
||||
- distinction message/fermeture propre ;
|
||||
- split sender/receiver ;
|
||||
- futures associées de send/receive/close avec une implémentation test sans runtime ;
|
||||
- catégorie, détail et libellés des erreurs.
|
||||
|
||||
Aucun test réseau n'existe dans cette tranche puisqu'aucun backend réseau n'existe encore.
|
||||
|
||||
## Documentation locale
|
||||
|
||||
Aucun `README.md` ni `USAGE.md` local n'est ajouté pendant `alpha.2`. La crate est volontairement petite, son contrat est documenté par rustdoc et le plan central couvre encore ses frontières ; créer un guide local maintenant dupliquerait ces sources sans valeur durable supplémentaire. Ce choix sera réévalué pendant la consolidation finale conformément à `DOC-CRATE-001`.
|
||||
|
||||
## Fichiers existants modifiés
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
|
||||
```
|
||||
|
||||
`Cargo.toml` ajoute le membre workspace et passe la version technique à `0.3.4-alpha.2`.
|
||||
|
||||
Le README racine annonce la candidate active. Le plan enregistre la validation de `alpha.1` et ferme le choix des futures associées GAT pour le contrat commun.
|
||||
|
||||
`ROADMAP.md` et `CHANGELOG.md` ne changent pas : le scope macroscopique de `0.3.4` est inchangé et une alpha n'ajoute normalement pas d'entrée de changelog.
|
||||
|
||||
## Validation attendue
|
||||
|
||||
Appliquer d'abord le formatage canonique, puis exécuter :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
```
|
||||
|
||||
Aucune gate Android, Web/Tauri ou réseau n'est requise : cette tranche n'affecte ni leurs contrats ni un backend socket.
|
||||
87
deltas/0.3.4/alpha.3.fix.1.md
Normal file
87
deltas/0.3.4/alpha.3.fix.1.md
Normal file
@@ -0,0 +1,87 @@
|
||||
<!-- file: deltas/0.3.4/alpha.3.fix.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.4-alpha.3.fix.1
|
||||
|
||||
## Cause
|
||||
|
||||
La gate utilisateur de `0.3.4-alpha.3` s'est arrêtée avant compilation lors du chargement des manifests Cargo :
|
||||
|
||||
```text
|
||||
error inheriting `futures-util` from workspace root manifest's `workspace.dependencies.futures-util`
|
||||
|
||||
Caused by:
|
||||
`default-features = false` cannot override workspace's `default-features`
|
||||
```
|
||||
|
||||
Le même défaut était présent sur `tokio-tungstenite` mais n'était pas encore affiché parce que Cargo s'arrêtait sur la première dépendance invalide.
|
||||
|
||||
`alpha.3` n'est donc pas historisée comme validée et aucune tranche `alpha.4` n'est ouverte avant fermeture de ce défaut.
|
||||
|
||||
## Correction
|
||||
|
||||
Le workspace passe à :
|
||||
|
||||
```text
|
||||
0.3.4-alpha.3.fix.1
|
||||
```
|
||||
|
||||
Les deux dépendances concernées portent désormais la désactivation de leurs features par défaut directement dans `[workspace.dependencies]` :
|
||||
|
||||
```toml
|
||||
futures-util = { version = "0.3.34", default-features = false }
|
||||
tokio-tungstenite = { version = "0.30.0", default-features = false }
|
||||
```
|
||||
|
||||
La crate `game-realtime-websocket-lib` hérite ensuite de ces réglages et ajoute uniquement les features dont elle a besoin :
|
||||
|
||||
```toml
|
||||
futures-util = { workspace = true, features = ["sink", "std"] }
|
||||
tokio-tungstenite = { workspace = true, features = ["connect", "handshake"] }
|
||||
```
|
||||
|
||||
Les features Tokio restent inchangées. Aucun TLS n'est ajouté et aucun code Rust/API/comportement transport n'est modifié.
|
||||
|
||||
## Pourquoi ce placement
|
||||
|
||||
Cargo autorise une crate membre à enrichir les `features` d'une dépendance héritée du workspace, mais pas à remplacer localement la valeur `default-features` définie par l'héritage. La politique `default-features = false` doit donc être possédée par la déclaration workspace lorsqu'elle est commune à l'utilisation héritée.
|
||||
|
||||
Ce fix corrige les deux dépendances concernées immédiatement afin d'éviter qu'une seconde erreur identique apparaisse après correction de `futures-util` seulement.
|
||||
|
||||
## Fichiers modifiés
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
crates/common/game-realtime-websocket-lib/Cargo.toml
|
||||
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
|
||||
```
|
||||
|
||||
Nouveau fichier :
|
||||
|
||||
```text
|
||||
deltas/0.3.4/alpha.3.fix.1.md
|
||||
```
|
||||
|
||||
Aucun fichier `history/0.3.4/alpha.3.md` n'est créé : une entrée `history/` n'existe qu'après validation réussie du jalon qu'elle décrit.
|
||||
|
||||
## Validation attendue
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-websocket-lib --all-targets --all-features
|
||||
|
||||
cargo tree -p game-realtime-websocket-lib --edges normal
|
||||
```
|
||||
|
||||
La validation recommence depuis le début de la gate, car `alpha.3` n'a jamais atteint une compilation Cargo valide.
|
||||
144
deltas/0.3.4/alpha.3.md
Normal file
144
deltas/0.3.4/alpha.3.md
Normal file
@@ -0,0 +1,144 @@
|
||||
<!-- file: deltas/0.3.4/alpha.3.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.4-alpha.3
|
||||
|
||||
## Mission
|
||||
|
||||
Introduire le premier backend concret de la frontière realtime validée en `alpha.2` : WebSocket async natif avec Tokio + `tokio-tungstenite`, sans TLS, sans protocole session/gameplay et sans dépendance backend dans les moteurs ou jeux.
|
||||
|
||||
## Historique fermé
|
||||
|
||||
`history/0.3.4/alpha.2.md` enregistre la validation utilisateur : audits propres, workspace/Clippy strict propres et `7` tests sur `game-realtime-transport-lib` passés.
|
||||
|
||||
Aucun `alpha.2.fix.N` n'est requis.
|
||||
|
||||
## Version et dépendances
|
||||
|
||||
Le workspace passe à :
|
||||
|
||||
```text
|
||||
0.3.4-alpha.3
|
||||
```
|
||||
|
||||
Dépendances tierces centralisées au workspace :
|
||||
|
||||
```text
|
||||
futures-util 0.3.34
|
||||
tokio 1.53.1
|
||||
tokio-tungstenite 0.30.0
|
||||
```
|
||||
|
||||
`game-realtime-websocket-lib` active uniquement les features dont elle a besoin :
|
||||
|
||||
```text
|
||||
futures-util: default-features=false, sink, std
|
||||
tokio: net
|
||||
tokio-tungstenite: default-features=false, connect, handshake
|
||||
```
|
||||
|
||||
Le harness de test ajoute localement les features Tokio `macros`, `rt` et `time`. Aucune feature TLS n'est activée.
|
||||
|
||||
## Nouvelle crate WebSocket
|
||||
|
||||
Ajout :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-websocket-lib/Cargo.toml
|
||||
crates/common/game-realtime-websocket-lib/src/lib.rs
|
||||
crates/common/game-realtime-websocket-lib/src/websocket.rs
|
||||
crates/common/game-realtime-websocket-lib/tests/loopback.rs
|
||||
```
|
||||
|
||||
La crate implémente le contrat `game-realtime-transport-lib` sans en modifier l'API.
|
||||
|
||||
### Client
|
||||
|
||||
`connect(&str)` établit une connexion WebSocket cliente à partir d'un endpoint `ws://`. Un endpoint hors baseline, notamment `wss://`, est rejeté comme `InvalidConfiguration` au lieu d'activer implicitement un backend TLS.
|
||||
|
||||
### Serveur
|
||||
|
||||
`WebSocketListener::bind(SocketAddr)` bind un `tokio::net::TcpListener`; `127.0.0.1:0` permet au système de choisir un port de test éphémère. `accept()` accepte le TCP puis effectue le handshake WebSocket serveur.
|
||||
|
||||
### Connexion
|
||||
|
||||
Client et serveur retournent le même `WebSocketConnection` public. Les représentations `tokio_tungstenite::WebSocketStream<...>` restent privées.
|
||||
|
||||
`RealtimeConnection::split()` produit `WebSocketSender` et `WebSocketReceiver`. Les futures concrètes sont boxées uniquement dans ce backend afin d'implémenter les associated futures GAT du contrat. Les représentations WebSocket/Tungstenite restent privées ; l'alias public `LocalBoxFuture` de `futures-util` sert uniquement de représentation concrète des associated futures du backend.
|
||||
|
||||
### Mapping WebSocket
|
||||
|
||||
```text
|
||||
Binary -> TransportReceive::Message
|
||||
Close -> TransportReceive::Closed
|
||||
Ping / Pong -> détail de contrôle backend, non remonté au gameplay
|
||||
Text -> TransportErrorKind::Protocol
|
||||
Frame -> TransportErrorKind::Protocol
|
||||
WriteBufferFull -> TransportErrorKind::Backpressure
|
||||
Capacity -> TransportErrorKind::MessageTooLarge
|
||||
I/O -> TransportErrorKind::Io
|
||||
closed/already -> TransportErrorKind::Closed
|
||||
```
|
||||
|
||||
Les erreurs de connect/bind/accept restent catégorisées au niveau de l'opération qui échoue et aucun `tungstenite::Error` ne fuit dans l'API publique.
|
||||
|
||||
## Tracing
|
||||
|
||||
Le target backend est :
|
||||
|
||||
```text
|
||||
games::realtime::websocket
|
||||
```
|
||||
|
||||
Les événements couvrent connect, bind, accept, send, receive, close et erreurs. Le contenu brut des payloads n'est jamais loggué ; seule leur longueur peut apparaître au niveau trace.
|
||||
|
||||
La crate ne configure aucun subscriber global.
|
||||
|
||||
## Preuve loopback
|
||||
|
||||
Le test d'intégration public :
|
||||
|
||||
```text
|
||||
binary_round_trip_and_clean_close_work_on_loopback
|
||||
```
|
||||
|
||||
utilise `127.0.0.1:0`, établit client et serveur sans Internet ni port fixe, puis vérifie :
|
||||
|
||||
- payload binaire client vers serveur ;
|
||||
- payload binaire serveur vers client ;
|
||||
- fermeture locale cliente observée comme fermeture distante propre côté serveur.
|
||||
|
||||
Une borne de trois secondes entoure les étapes asynchrones uniquement pour rendre le test déterministe en cas de régression ; elle ne constitue pas encore le timeout de transport produit, réservé à `alpha.4`.
|
||||
|
||||
## Documentation locale
|
||||
|
||||
Aucun `README.md` ou `USAGE.md` local n'est ajouté pour cette nouvelle crate pendant `alpha.3`. Le contrat reste petit, la rustdoc décrit l'API et le plan central porte les décisions d'architecture. Cette décision sera réévaluée pendant la consolidation finale conformément à `DOC-CRATE-*`.
|
||||
|
||||
## Fichiers existants modifiés
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
|
||||
```
|
||||
|
||||
`ROADMAP.md` et `CHANGELOG.md` restent inchangés : le scope macro de `0.3.4` n'a pas changé et une alpha n'ajoute pas encore de changelog de release.
|
||||
|
||||
## Validation attendue
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-websocket-lib --all-targets --all-features
|
||||
cargo tree -p game-realtime-websocket-lib --edges normal
|
||||
```
|
||||
|
||||
`cargo test --workspace --all-targets --all-features` reste réservé à la beta conformément au plan.
|
||||
157
deltas/0.3.4/alpha.4.md
Normal file
157
deltas/0.3.4/alpha.4.md
Normal file
@@ -0,0 +1,157 @@
|
||||
<!-- file: deltas/0.3.4/alpha.4.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.4-alpha.4
|
||||
|
||||
## Base
|
||||
|
||||
Base directe : `0.3.4-alpha.3.fix.1`, validée par l'utilisateur le 2026-09-21.
|
||||
|
||||
Cette tranche n'élargit pas le contrat transport-neutral et n'introduit ni session gameplay, ni wire codec, ni TLS. Elle ferme les limites, deadlines et principaux cas négatifs du backend WebSocket avant la validation large.
|
||||
|
||||
## Historique du jalon précédent
|
||||
|
||||
Ajout de :
|
||||
|
||||
```text
|
||||
history/0.3.4/alpha.3.fix.1.md
|
||||
```
|
||||
|
||||
L'historique enregistre la gate utilisateur réellement fournie : audits propres, workspace/Clippy propres, sept tests transport, loopback WebSocket propre et graphe normal sans pile TLS.
|
||||
|
||||
## Configuration WebSocket produit
|
||||
|
||||
Ajout de `WebSocketConfig`, réexportée au crate-root de `game-realtime-websocket-lib`.
|
||||
|
||||
Valeurs par défaut :
|
||||
|
||||
```text
|
||||
max message size 1 MiB
|
||||
max frame size 1 MiB
|
||||
write buffer target 64 KiB
|
||||
max write buffer 2 MiB
|
||||
connect/handshake 10 s
|
||||
send 5 s
|
||||
close 2 s
|
||||
receive idle timeout aucun
|
||||
```
|
||||
|
||||
La configuration peut être ajustée par builders `with_*` puis validée. Les invariants refusent notamment :
|
||||
|
||||
- message/frame de taille nulle ;
|
||||
- frame maximale supérieure au message maximal ;
|
||||
- write buffer maximal incapable de contenir le target plus un message maximal ;
|
||||
- overflow de ce calcul ;
|
||||
- deadline connect/send/close nulle.
|
||||
|
||||
Les wrappers `connect()` et `WebSocketListener::bind()` restent disponibles avec la configuration par défaut. Les nouveaux chemins configurables sont :
|
||||
|
||||
```text
|
||||
connect_with_config(endpoint, config)
|
||||
WebSocketListener::bind_with_config(address, config)
|
||||
```
|
||||
|
||||
## Limites et backpressure
|
||||
|
||||
Les limites message/frame/write-buffer sont transmises à `tungstenite::protocol::WebSocketConfig` aussi bien côté client que côté serveur.
|
||||
|
||||
Le send vérifie également `max_message_size` et `max_frame_size` avant l'écriture afin que le dépassement sortant soit déterministe et remonte `TransportErrorKind::MessageTooLarge` sans dépendre d'un comportement réseau.
|
||||
|
||||
`max_write_buffer_size` est borné à `2 MiB` par défaut. `tungstenite::Error::WriteBufferFull` continue d'être mappé vers `TransportErrorKind::Backpressure` et ce mapping dispose désormais d'un test unitaire dédié. Aucun test loopback ne fabrique une saturation artificielle : le write buffer Tungstenite ne grossit au-delà de son target que lors d'échecs d'écriture sous-jacents, ce qui rendrait ce scénario réseau local non déterministe.
|
||||
|
||||
## Timeouts et lifecycle
|
||||
|
||||
La feature Tokio `time` devient une dépendance de production uniquement pour `game-realtime-websocket-lib`.
|
||||
|
||||
Les deadlines sont appliquées ainsi :
|
||||
|
||||
- connexion client complète : `connect_timeout` ;
|
||||
- handshake serveur après accept TCP : `connect_timeout` ;
|
||||
- émission d'un message : `send_timeout` ;
|
||||
- fermeture locale du sink : `close_timeout`.
|
||||
|
||||
L'attente d'un nouveau peer sur `TcpListener::accept()` n'est volontairement pas bornée par la configuration d'une connexion. `receive()` ne reçoit aucun idle timeout : heartbeat et inactivité appartiennent aux futures couches session/synchronisation.
|
||||
|
||||
Si un send expire, la moitié émission mémorise cet état et refuse un nouvel envoi avec `TransportErrorKind::Aborted`. Le send interrompu peut avoir progressé partiellement ; il ne doit donc jamais être rejoué implicitement comme s'il n'avait rien produit. Une fermeture explicite reste néanmoins tentable avec sa propre deadline.
|
||||
|
||||
Le backend continue de ne créer aucun runtime, thread ou task détachée.
|
||||
|
||||
## Tests ajoutés
|
||||
|
||||
Tests unitaires de configuration :
|
||||
|
||||
- defaults produit exacts ;
|
||||
- limites message/frame/write-buffer invalides ;
|
||||
- deadlines nulles invalides.
|
||||
|
||||
Tests unitaires de mapping backend :
|
||||
|
||||
- `WriteBufferFull -> Backpressure` ;
|
||||
- `Capacity -> MessageTooLarge`.
|
||||
|
||||
Nouveau `tests/robustness.rs` :
|
||||
|
||||
1. payload sortant hors limite rejeté avant écriture ;
|
||||
2. payload entrant hors limite rejeté par Tungstenite ;
|
||||
3. frame Text rejetée par le contrat binaire ;
|
||||
4. peer drop sans close handshake remonté comme erreur de protocole ;
|
||||
5. peer TCP silencieux borné par le timeout de handshake serveur.
|
||||
|
||||
Tous les scénarios réseau utilisent uniquement `127.0.0.1:0` et une borne externe de test de trois secondes.
|
||||
|
||||
## Documentation
|
||||
|
||||
Le plan actif `docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md` est mis à jour avec :
|
||||
|
||||
- validation effective de `alpha.3.fix.1` ;
|
||||
- configuration et deadlines retenues ;
|
||||
- raison de l'absence d'idle timeout transport ;
|
||||
- stratégie backpressure testable sans test réseau flaky ;
|
||||
- orientation vers beta ou courte consolidation selon le résultat réel de cette gate.
|
||||
|
||||
`CHANGELOG.md` et `ROADMAP.md` restent inchangés : la version est encore en alpha et le scope macroscopique `0.3.4` ne change pas.
|
||||
|
||||
## Fichiers
|
||||
|
||||
Modifiés :
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
crates/common/game-realtime-websocket-lib/Cargo.toml
|
||||
crates/common/game-realtime-websocket-lib/src/lib.rs
|
||||
crates/common/game-realtime-websocket-lib/src/websocket.rs
|
||||
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
|
||||
```
|
||||
|
||||
Ajoutés :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-websocket-lib/src/config.rs
|
||||
crates/common/game-realtime-websocket-lib/unit_tests/config.rs
|
||||
crates/common/game-realtime-websocket-lib/unit_tests/websocket.rs
|
||||
crates/common/game-realtime-websocket-lib/tests/robustness.rs
|
||||
history/0.3.4/alpha.3.fix.1.md
|
||||
deltas/0.3.4/alpha.4.md
|
||||
```
|
||||
|
||||
## Validation attendue
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-websocket-lib --all-targets --all-features
|
||||
|
||||
cargo tree -p game-realtime-websocket-lib --edges normal
|
||||
```
|
||||
|
||||
La validation utilisateur reste autoritaire pour la compilation, Clippy et les tests runtime. Les audits statiques exécutables dans l'environnement de génération doivent être propres avant livraison du delta.
|
||||
127
deltas/0.3.4/alpha.5.md
Normal file
127
deltas/0.3.4/alpha.5.md
Normal file
@@ -0,0 +1,127 @@
|
||||
<!-- file: deltas/0.3.4/alpha.5.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.4-alpha.5
|
||||
|
||||
## Base
|
||||
|
||||
Base directe : `0.3.4-alpha.4`, validée par l'utilisateur le 2026-09-21.
|
||||
|
||||
La gate `alpha.4` est entièrement propre, mais la revue post-validation a identifié une omission de processus : les preuves runtime réseau restent sous le harness de test Cargo. Cette tranche ajoute le smoke réellement exécutable avant toute promotion en beta.
|
||||
|
||||
## Historique du jalon précédent
|
||||
|
||||
Ajout de :
|
||||
|
||||
```text
|
||||
history/0.3.4/alpha.4.md
|
||||
```
|
||||
|
||||
L'historique enregistre les audits propres, check/Clippy propres, sept tests transport, onze tests WebSocket/robustesse et le graphe de dépendances sans TLS fournis par l'utilisateur.
|
||||
|
||||
## Launcher de smoke runtime
|
||||
|
||||
Ajout de la crate binaire :
|
||||
|
||||
```text
|
||||
crates/apps/game-realtime-websocket-smoke
|
||||
```
|
||||
|
||||
Ce launcher n'introduit aucune logique session/gameplay et n'ajoute aucune dépendance tierce nouvelle. Il consomme uniquement :
|
||||
|
||||
- `game-realtime-websocket-lib` ;
|
||||
- `game-realtime-transport-lib` ;
|
||||
- le logging commun ;
|
||||
- Tokio pour posséder le runtime du processus de smoke.
|
||||
|
||||
Le backend reste donc conforme à la décision d'ownership : `game-realtime-websocket-lib` ne crée toujours ni runtime ni thread privé.
|
||||
|
||||
## Scénario fumé
|
||||
|
||||
La commande :
|
||||
|
||||
```bash
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
```
|
||||
|
||||
exécute hors harness `#[test]` le scénario suivant :
|
||||
|
||||
1. initialise le tracing applicatif commun ;
|
||||
2. bind un listener WebSocket sur `127.0.0.1:0` ;
|
||||
3. construit l'endpoint `ws://` à partir du port réellement alloué ;
|
||||
4. accepte un serveur et connecte un client via les API publiques ;
|
||||
5. envoie un payload binaire client → serveur et vérifie son contenu ;
|
||||
6. envoie un payload binaire serveur → client et vérifie son contenu ;
|
||||
7. initie un close propre côté client ;
|
||||
8. vérifie que le serveur observe `TransportReceive::Closed` ;
|
||||
9. affiche `game-realtime-websocket-smoke: PASS` et sort avec le code zéro.
|
||||
|
||||
Une deadline globale de cinq secondes empêche le smoke de rester bloqué en cas de régression. Toute erreur de bind/connect/send/receive/close, payload inattendu ou timeout produit un code de sortie non nul.
|
||||
|
||||
Le smoke ne dépend ni d'Internet, ni d'un service externe, ni d'un port fixe.
|
||||
|
||||
## Documentation locale
|
||||
|
||||
`DOC-CRATE-*` est réévalué pour le nouveau launcher. Aucun `README.md` ou `USAGE.md` local n'est ajouté : le binaire n'a aucune configuration, aucun argument et un unique workflow opérateur (`cargo run -p game-realtime-websocket-smoke`), entièrement documenté par le plan actif et le présent delta.
|
||||
|
||||
## Plan et version
|
||||
|
||||
L'audit de distribution exige désormais aussi la présence du manifeste du launcher de smoke afin que cette preuve runtime ne puisse pas disparaître silencieusement d'une archive future.
|
||||
|
||||
Le workspace passe à :
|
||||
|
||||
```text
|
||||
0.3.4-alpha.5
|
||||
```
|
||||
|
||||
Le plan `0.3.4` est corrigé pour distinguer explicitement les tests automatisés du smoke runtime et rendre ce dernier obligatoire avant l'entrée en beta.
|
||||
|
||||
`CHANGELOG.md` et `ROADMAP.md` restent inchangés : aucun scope macro ou jalon RC/stable n'est modifié.
|
||||
|
||||
## Fichiers
|
||||
|
||||
Modifiés :
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
|
||||
scripts/audit_distribution_layout.py
|
||||
```
|
||||
|
||||
Ajoutés :
|
||||
|
||||
```text
|
||||
crates/apps/game-realtime-websocket-smoke/Cargo.toml
|
||||
crates/apps/game-realtime-websocket-smoke/src/main.rs
|
||||
history/0.3.4/alpha.4.md
|
||||
deltas/0.3.4/alpha.5.md
|
||||
```
|
||||
|
||||
## Validation attendue
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-websocket-lib --all-targets --all-features
|
||||
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
cargo tree -p game-realtime-websocket-smoke --edges normal
|
||||
```
|
||||
|
||||
La validation attendue du smoke est explicitement :
|
||||
|
||||
```text
|
||||
game-realtime-websocket-smoke: PASS
|
||||
```
|
||||
|
||||
avec code de sortie zéro. La compilation, les tests et le smoke restent exécutés côté utilisateur conformément à `CMD-BUILD-005`.
|
||||
106
deltas/0.3.4/beta.1.md
Normal file
106
deltas/0.3.4/beta.1.md
Normal file
@@ -0,0 +1,106 @@
|
||||
<!-- file: deltas/0.3.4/beta.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.4-beta.1
|
||||
|
||||
## Objectif
|
||||
|
||||
Entrer en beta après fermeture de la phase alpha : contrat transport-neutral, backend WebSocket, robustesse, tests localhost et smoke runtime public sont tous validés.
|
||||
|
||||
Cette tranche n'ajoute aucune fonctionnalité. Elle synchronise la version technique, historise `alpha.5` et ouvre la validation large prévue avant la consolidation de publication.
|
||||
|
||||
## Baseline acceptée
|
||||
|
||||
`0.3.4-alpha.5` est validée par l'utilisateur le 2026-09-21.
|
||||
|
||||
La baseline acceptée comprend :
|
||||
|
||||
- audits Rust/workspace, Markdown et distribution propres ;
|
||||
- `cargo check --workspace` et Clippy workspace strict propres ;
|
||||
- sept tests du contrat transport-neutral ;
|
||||
- cinq tests unitaires WebSocket ;
|
||||
- un test loopback WebSocket ;
|
||||
- cinq tests de robustesse WebSocket ;
|
||||
- smoke runtime hors harness `#[test]` avec bind `127.0.0.1:0`, échange binaire bidirectionnel, close propre et sortie `game-realtime-websocket-smoke: PASS` ;
|
||||
- graphe normal du launcher conforme aux frontières prévues.
|
||||
|
||||
`history/0.3.4/alpha.5.md` consigne le détail.
|
||||
|
||||
## Changements
|
||||
|
||||
- passage de `workspace.package.version` à `0.3.4-beta.1` ;
|
||||
- ajout de l'historique validé `alpha.5` ;
|
||||
- promotion du plan actif vers la phase beta ;
|
||||
- précision de la gate beta : test workspace complet, smoke runtime séparé et arbres de dépendances direct/inverse ;
|
||||
- aucune modification de code réseau, contrat transport, gameplay, moteur, SDL, Android, Tauri, WASM, asset ou dépendance tierce.
|
||||
|
||||
`CHANGELOG.md` et `ROADMAP.md` restent inchangés : la consolidation publiée et le gel de publication sont réservés aux tranches suivantes.
|
||||
|
||||
## Fichiers
|
||||
|
||||
Modifiés :
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
|
||||
```
|
||||
|
||||
Ajoutés :
|
||||
|
||||
```text
|
||||
history/0.3.4/alpha.5.md
|
||||
deltas/0.3.4/beta.1.md
|
||||
```
|
||||
|
||||
## Validation beta — statique et workspace
|
||||
|
||||
Depuis la racine :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
cargo test --workspace --all-targets --all-features
|
||||
```
|
||||
|
||||
La suite workspace complète est volontairement exécutée ici : `beta.1` constitue la première gate transverse de `0.3.4`.
|
||||
|
||||
## Smoke beta
|
||||
|
||||
Le smoke runtime reste une gate distincte du test workspace :
|
||||
|
||||
```bash
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
```
|
||||
|
||||
Résultat attendu :
|
||||
|
||||
```text
|
||||
game-realtime-websocket-smoke: PASS
|
||||
```
|
||||
|
||||
avec code de sortie zéro.
|
||||
|
||||
## Frontières et dépendances
|
||||
|
||||
Revalider le graphe direct du backend puis ses consommateurs workspace :
|
||||
|
||||
```bash
|
||||
cargo tree -p game-realtime-websocket-lib --edges normal
|
||||
cargo tree -i game-realtime-websocket-lib --workspace --edges normal
|
||||
```
|
||||
|
||||
L'arbre inverse ne doit révéler aucune dépendance depuis `crates/games/` ni `crates/engines/`. Le launcher de smoke est un consommateur attendu.
|
||||
|
||||
## Transition
|
||||
|
||||
Si la gate workspace, le smoke et les graphes sont propres, aucune beta supplémentaire n'est créée par cérémonie. La tranche suivante doit effectuer la consolidation finale exigée par `VER-PHASE-010` : documentation durable, `CHANGELOG.md`, `ROADMAP.md`, prompt de la version/session suivante et préparation du gel RC.
|
||||
|
||||
Toute régression imputable au projet produit d'abord `0.3.4-beta.1.fix.N`. Une capacité fonctionnelle manquante réouvre une alpha.
|
||||
151
deltas/0.3.4/rc.1.md
Normal file
151
deltas/0.3.4/rc.1.md
Normal file
@@ -0,0 +1,151 @@
|
||||
<!-- file: deltas/0.3.4/rc.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.4-rc.1
|
||||
|
||||
## Base requise
|
||||
|
||||
`0.3.4-beta.1`, validée par l'utilisateur le 2026-09-21.
|
||||
|
||||
## Objectif
|
||||
|
||||
Créer la candidate de publication `0.3.4` après validation large de la baseline realtime, sans rouvrir le comportement réseau.
|
||||
|
||||
Cette tranche ferme `VER-PHASE-010` : historique beta, documentation durable, changelog, prompt de la version suivante et gel RC.
|
||||
|
||||
## Gel fonctionnel
|
||||
|
||||
`0.3.4-rc.1` n'ajoute :
|
||||
|
||||
- aucun transport ;
|
||||
- aucune API réseau ;
|
||||
- aucune dépendance tierce ;
|
||||
- aucun TLS ;
|
||||
- aucun wire codec ;
|
||||
- aucun protocole session/joueur/room ;
|
||||
- aucune synchronisation gameplay ;
|
||||
- aucune simulation authoritative ;
|
||||
- aucun changement moteur, jeu, SDL, Android, Tauri ou WASM.
|
||||
|
||||
Les seules modifications techniques sont la promotion de `workspace.package.version` vers `0.3.4-rc.1`. Le code Rust realtime validé en beta reste inchangé.
|
||||
|
||||
Tout défaut de publication fermé relève de `0.3.4-rc.1.fix.N` selon `VER-RC-*`. Une réouverture fonctionnelle invalide la RC.
|
||||
|
||||
## Validation beta acquise
|
||||
|
||||
`history/0.3.4/beta.1.md` consigne la gate réelle :
|
||||
|
||||
- audits Rust/workspace, Markdown et distribution propres ;
|
||||
- `cargo check --workspace` propre ;
|
||||
- Clippy workspace strict propre ;
|
||||
- `cargo test --workspace --all-targets --all-features` : 53 tests réussis, 0 échec ;
|
||||
- smoke runtime `game-realtime-websocket-smoke: PASS` ;
|
||||
- backend sur Tokio `1.53.1`, tokio-tungstenite/Tungstenite `0.30.0`, sans pile TLS ;
|
||||
- arbre inverse limité à `game-realtime-websocket-smoke`, sans dépendance backend dans `crates/games/` ou `crates/engines/`.
|
||||
|
||||
Aucune beta supplémentaire n'est créée uniquement par cérémonie.
|
||||
|
||||
## Consolidation documentaire
|
||||
|
||||
La revue `DOC-CRATE-*` conclut :
|
||||
|
||||
- `game-realtime-transport-lib` reçoit un `README.md` durable décrivant son contrat, ses frontières et le sens des dépendances ; son API est assez petite pour ne pas justifier un `USAGE.md` séparé ;
|
||||
- `game-realtime-websocket-lib` reçoit un `README.md` durable et un `USAGE.md`, car configuration, client/listener, limites, deadlines et smoke constituent un workflow de consommation non trivial ;
|
||||
- `game-realtime-websocket-smoke` reste sans document local supplémentaire : la commande Cargo unique, le plan et le delta couvrent entièrement son rôle.
|
||||
|
||||
Les documents locaux ne contiennent aucun journal de prerelease.
|
||||
|
||||
## Changelog et roadmap
|
||||
|
||||
`CHANGELOG.md` reçoit l'entrée `0.3.4-rc.1` avec le scope réellement validé.
|
||||
|
||||
`ROADMAP.md` est relue mais reste inchangée : `0.3.4` ne devient `(x)` qu'après validation de la RC et promotion stable. `0.3.5` reste le POC WebTransport/QUIC prévu ensuite.
|
||||
|
||||
## Prompt suivant
|
||||
|
||||
Ajout de :
|
||||
|
||||
```text
|
||||
prompts/006-V0_3_5_START_PROMPT.md
|
||||
```
|
||||
|
||||
Le prompt part de la future stable/taggée `v0.3.4`, rappelle que la RC/stable doit être terminée si nécessaire, et cadre `0.3.5-alpha.1` autour de :
|
||||
|
||||
- recherche actuelle des stacks WebTransport/QUIC ;
|
||||
- challenge du contrat transport-neutral livré par `0.3.4` ;
|
||||
- plateformes navigateur/native/Android réellement testables ;
|
||||
- exigences TLS/certificats/HTTP3/UDP ;
|
||||
- fallback WebSocket au niveau d'ownership approprié ;
|
||||
- comparaison mesurée sans présumer que WebTransport doit être retenu ;
|
||||
- maintien hors scope des couches session/synchronisation/simulation.
|
||||
|
||||
Le prompt ne présente aucune validation future de la RC ou de la stable comme acquise.
|
||||
|
||||
## Fichiers
|
||||
|
||||
Modifiés :
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
CHANGELOG.md
|
||||
docs/000-README.md
|
||||
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
|
||||
```
|
||||
|
||||
Ajoutés :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-transport-lib/README.md
|
||||
crates/common/game-realtime-websocket-lib/README.md
|
||||
crates/common/game-realtime-websocket-lib/USAGE.md
|
||||
history/0.3.4/beta.1.md
|
||||
prompts/006-V0_3_5_START_PROMPT.md
|
||||
deltas/0.3.4/rc.1.md
|
||||
```
|
||||
|
||||
## Validation RC
|
||||
|
||||
Depuis la racine :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-websocket-lib --all-targets --all-features
|
||||
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
cargo tree -i game-realtime-websocket-lib --workspace --edges normal
|
||||
```
|
||||
|
||||
Le test workspace complet n'est pas répété par cérémonie : aucun Rust, dépendance ou contrat transverse n'a changé depuis la gate beta qui l'a déjà validé. Il redevient obligatoire si un fix RC touche ces éléments.
|
||||
|
||||
Le smoke doit afficher :
|
||||
|
||||
```text
|
||||
game-realtime-websocket-smoke: PASS
|
||||
```
|
||||
|
||||
L'arbre inverse doit continuer à montrer uniquement le launcher de smoke comme consommateur du backend WebSocket.
|
||||
|
||||
## Après validation
|
||||
|
||||
Si la RC est propre, la promotion vers `0.3.4` est mécanique :
|
||||
|
||||
- `workspace.package.version = 0.3.4` ;
|
||||
- ajout de `history/0.3.4/rc.1.md` ;
|
||||
- entrée stable dans `CHANGELOG.md` ;
|
||||
- `ROADMAP.md` passe `0.3.4` en `(x)` ;
|
||||
- clôture du plan `004` et de son index ;
|
||||
- ajustement mécanique de `prompts/006-V0_3_5_START_PROMPT.md` si une référence devient certaine ;
|
||||
- `deltas/0.3.4/rel.001.md`.
|
||||
|
||||
Aucun nouveau comportement ne doit apparaître dans cette promotion.
|
||||
64
deltas/0.3.4/rel.001.md
Normal file
64
deltas/0.3.4/rel.001.md
Normal file
@@ -0,0 +1,64 @@
|
||||
<!-- file: deltas/0.3.4/rel.001.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.4 — release stable
|
||||
|
||||
## Base
|
||||
|
||||
Base validée : `0.3.4-rc.1`.
|
||||
|
||||
## Objet
|
||||
|
||||
Promouvoir mécaniquement la candidate validée vers `0.3.4` sans introduire de nouveau comportement.
|
||||
|
||||
## Changements
|
||||
|
||||
La release stable :
|
||||
|
||||
- passe `workspace.package.version` de `0.3.4-rc.1` à `0.3.4` ;
|
||||
- positionne `README.md` sur `0.3.4` comme stable de référence et `0.3.5-alpha.1` comme prochaine version planifiée ;
|
||||
- marque `0.3.4` terminée dans `ROADMAP.md` ;
|
||||
- ajoute l'entrée stable `0.3.4` dans `CHANGELOG.md` ;
|
||||
- enregistre la validation effective de la RC dans `history/0.3.4/rc.1.md` ;
|
||||
- clôt `docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md` et ses deux entrées d'index ;
|
||||
- ajuste mécaniquement `prompts/006-V0_3_5_START_PROMPT.md` afin qu'il parte explicitement de la stable taggée `v0.3.4` et des validations réellement acquises.
|
||||
|
||||
## Frontière de release
|
||||
|
||||
Aucun fichier Rust, test Rust, manifeste de crate realtime, dépendance tierce, frontend, Android, gameplay, moteur, comportement WebSocket, limite, timeout ou contrat transport n'est modifié après la RC.
|
||||
|
||||
La stable conserve notamment :
|
||||
|
||||
- `game-realtime-transport-lib` transport-neutral ;
|
||||
- `game-realtime-websocket-lib` comme backend WebSocket de référence ;
|
||||
- `game-realtime-websocket-smoke` comme preuve runtime localhost ;
|
||||
- l'absence de dépendance du backend dans `crates/games/` et `crates/engines/` ;
|
||||
- WebTransport/QUIC, TLS produit, wire/session, synchronisation et simulation authoritative hors scope de `0.3.4`.
|
||||
|
||||
## Validation proportionnelle
|
||||
|
||||
La gate RC complète a déjà été validée sur un état fonctionnellement identique : audits propres, check/Clippy, 18 tests realtime ciblés, smoke runtime `PASS` et arbre inverse conforme. `beta.1` avait en outre validé `cargo test --workspace --all-targets --all-features` avec 53 tests réussis.
|
||||
|
||||
La promotion stable demande uniquement les contrôles proportionnels aux changements de version et de documentation :
|
||||
|
||||
```bash
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
```
|
||||
|
||||
Clippy strict, suites de tests et smoke runtime ne sont pas répétés par cérémonie puisque la promotion stable ne modifie aucun code ni comportement. Tout échec de la gate ci-dessus doit néanmoins être corrigé avant publication.
|
||||
|
||||
## Publication
|
||||
|
||||
Après validation de ce delta :
|
||||
|
||||
- commit de release ;
|
||||
- tag stable unique `v0.3.4` ;
|
||||
- archive ZIP du tag utilisée comme baseline autoritaire de la session suivante ;
|
||||
- démarrage de `0.3.5` uniquement depuis `v0.3.4` avec `prompts/006-V0_3_5_START_PROMPT.md` ;
|
||||
- première tranche suivante : `0.3.5-alpha.1`, audit/recherche WebTransport/QUIC et création du plan `docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md`.
|
||||
296
deltas/0.3.5/alpha.1.md
Normal file
296
deltas/0.3.5/alpha.1.md
Normal file
@@ -0,0 +1,296 @@
|
||||
<!-- file: deltas/0.3.5/alpha.1.md -->
|
||||
<!-- version: 2 -->
|
||||
|
||||
# Delta 0.3.5-alpha.1
|
||||
|
||||
## Base
|
||||
|
||||
Base autoritaire : archive fournie `games-v0.3.4.zip`, annoncée comme téléchargement ZIP du tag Gitea `v0.3.4`.
|
||||
|
||||
La version workspace de la base est :
|
||||
|
||||
```text
|
||||
0.3.4
|
||||
```
|
||||
|
||||
L'archive taggée est utilisée telle quelle conformément à `CMD-GIT-003` et `CMD-GIT-004`. L'absence de `.git` est normale et aucun fichier local absent du ZIP n'est inventé.
|
||||
|
||||
## Objet
|
||||
|
||||
Ouvrir `0.3.5` par le gate obligatoire `alpha.1` : auditer la stable, relire les preuves `0.3.4`, rechercher l'écosystème WebTransport/QUIC actuel, sélectionner la stack POC primaire, challenger le contrat commun, fermer la stratégie TLS/fallback, ajouter les smoke tests nécessaires et redécouper la version afin que chaque delta reste normalement dans la cible 15 à 30 minutes.
|
||||
|
||||
Cette tranche n'ajoute aucune crate WebTransport, aucune dépendance QUIC/Rustls et aucun comportement runtime.
|
||||
|
||||
## Version
|
||||
|
||||
La version workspace passe de :
|
||||
|
||||
```text
|
||||
0.3.4
|
||||
```
|
||||
|
||||
à :
|
||||
|
||||
```text
|
||||
0.3.5-alpha.1
|
||||
```
|
||||
|
||||
Conformément à `VER-DOCFIX-002`, une prerelease non-fix synchronise sa version technique même si le contenu de cette tranche est principalement documentaire.
|
||||
|
||||
Aucune version npm/Tauri/Android n'est modifiée : aucun package de ces plateformes n'est touché.
|
||||
|
||||
## Audit de l'archive
|
||||
|
||||
Avant modification, l'environnement de génération a obtenu :
|
||||
|
||||
```text
|
||||
unzip -t : no errors
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 263 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
```
|
||||
|
||||
Inventaire indépendant :
|
||||
|
||||
```text
|
||||
437 fichiers dans le ZIP
|
||||
267 fichiers Markdown extraits
|
||||
68 fichiers Rust
|
||||
18 Cargo.toml, dont le manifest racine
|
||||
17 membres workspace
|
||||
workspace.package.version = 0.3.4
|
||||
0 symlink
|
||||
0 chemin absolu/traversal
|
||||
0 target/, node_modules/, build/ ou gen/android/ généré
|
||||
```
|
||||
|
||||
Le log utilisateur fourni à l'ouverture de session confirme également :
|
||||
|
||||
```text
|
||||
cargo fmt --all -- --check : clean
|
||||
audits Rust/Markdown/distribution : clean
|
||||
cargo check --workspace : clean
|
||||
```
|
||||
|
||||
Son audit Markdown annonce `279` fichiers contre `263` dans le scan de l'archive fournie. Le delta reste construit exclusivement depuis le ZIP autoritaire reçu et enregistre cet écart sans l'extrapoler.
|
||||
|
||||
## Audit des règles et du workflow
|
||||
|
||||
La lecture du prompt `006`, de `RULES.md`, des règles détaillées, des documents réseau/plateforme et des preuves `0.3.4` confirme :
|
||||
|
||||
- `alpha.1` doit produire le plan actif avant développement lourd ;
|
||||
- un delta vise environ 15 à 30 minutes de travail effectif ;
|
||||
- une tranche clairement trop lourde doit être scindée avant exécution ;
|
||||
- le full test workspace doit être rare et explicitement planifié ;
|
||||
- une tranche de consolidation doit apparaître avant la candidate finale ;
|
||||
- les builds/tests/smokes de validation sont attestés côté utilisateur ;
|
||||
- les audits statiques peuvent être exécutés dans l'environnement de génération ;
|
||||
- `history/` n'est créé qu'après validation réelle d'un jalon ;
|
||||
- `CHANGELOG.md` reste normalement silencieux avant la phase de consolidation/RC ;
|
||||
- `ROADMAP.md` reste macroscopique et n'a pas besoin de changer pour ce cadrage.
|
||||
|
||||
Le forecast initial du prompt est fonctionnellement correct mais trop agrégé sur trois risques : backend natif, browser/TLS et fallback/mesures. Le plan actif les sépare et ajoute `beta.2` comme consolidation explicite pré-RC.
|
||||
|
||||
## Recherche WebTransport/QUIC actuelle
|
||||
|
||||
État vérifié au 2026-09-21 :
|
||||
|
||||
```text
|
||||
web-transport 0.12.0
|
||||
web-transport-quinn 0.12.1
|
||||
web-transport-wasm 0.6.0
|
||||
wtransport 0.7.2
|
||||
```
|
||||
|
||||
Constats structurants :
|
||||
|
||||
- `web-transport` fournit une façade native + WASM, avec Quinn côté natif et API navigateur côté WASM ;
|
||||
- la documentation amont traite explicitement la différence `Send`/`!Send` entre natif et WASM, cohérente avec la frontière `0.3.4` ;
|
||||
- le build WASM nécessite actuellement `--cfg=web_sys_unstable_apis` ;
|
||||
- `wtransport` reste un candidat natif robuste et documenté, notamment pour certificats/hash W3C, mais ne fournit pas la même façade Rust WASM ;
|
||||
- MDN classe WebTransport « Baseline 2026 » depuis mars 2026 sur navigateurs récents et impose un contexte sécurisé ;
|
||||
- WebTransport/HTTP3 reste `draft-ietf-webtrans-http3-16`, Internet-Draft en WG Last Call, donc pas encore un RFC final.
|
||||
|
||||
L'étude détaillée est ajoutée dans :
|
||||
|
||||
```text
|
||||
docs/studies/026-V0_3_5_WEBTRANSPORT_QUIC_STACK_AUDIT.md
|
||||
```
|
||||
|
||||
## Stack primaire retenue
|
||||
|
||||
Le POC commence avec la famille :
|
||||
|
||||
```text
|
||||
web-transport 0.12.x
|
||||
```
|
||||
|
||||
`wtransport 0.7.x` reste le candidat de repli si une exigence concrète échoue.
|
||||
|
||||
Aucune dépendance n'est ajoutée dans `alpha.1`; la résolution Cargo exacte et le choix des features crypto sont fermés dans `alpha.2` avec `cargo tree`.
|
||||
|
||||
## Contrat transport et framing
|
||||
|
||||
Le contrat `game-realtime-transport-lib` reste inchangé.
|
||||
|
||||
Pour préserver sa sémantique fiable/ordonnée/message-oriented, le backend WebTransport utilisera un stream bidirectionnel principal et un framing privé :
|
||||
|
||||
```text
|
||||
u32 big-endian length + payload bytes
|
||||
```
|
||||
|
||||
La taille est bornée avant allocation/écriture. Ce framing n'est pas un wire codec métier et ne contient aucun joueur, room, tick ou version de protocole gameplay.
|
||||
|
||||
Les datagrams restent hors du contrat commun parce qu'ils sont non fiables/non ordonnés. Ils seront challengés séparément sans créer une capability commune prématurée.
|
||||
|
||||
## TLS et navigateur
|
||||
|
||||
Le POC retient une stratégie de développement compatible avec les contraintes W3C :
|
||||
|
||||
- certificat self-signed court ;
|
||||
- ECDSA P-256 ;
|
||||
- validité inférieure à deux semaines ;
|
||||
- hash SHA-256 épinglé côté client ;
|
||||
- aucune clé privée durable dans le dépôt ;
|
||||
- aucune désactivation permanente de validation TLS.
|
||||
|
||||
Le smoke navigateur est désormais une preuve explicitement planifiée et distincte du simple build WASM.
|
||||
|
||||
## Fallback
|
||||
|
||||
Le fallback WebSocket est possédé par la composition/application du POC :
|
||||
|
||||
```text
|
||||
attempt WebTransport
|
||||
success -> WebTransport
|
||||
classified unavailable/establishment failure -> WebSocket
|
||||
```
|
||||
|
||||
Le plan exige une branche WebTransport forcée, une branche fallback forcée et une erreur non-fallback visible. Aucun `TransportManager` ou registry n'est créé dans ce cadrage.
|
||||
|
||||
## Forecast révisé
|
||||
|
||||
Le plan actif retient désormais :
|
||||
|
||||
```text
|
||||
0.3.5-alpha.1 audit + recherche + design + plan
|
||||
0.3.5-alpha.2 crate/dépendances + établissement natif/TLS pinning
|
||||
0.3.5-alpha.3 stream fiable + framing + contrat commun
|
||||
0.3.5-alpha.4 robustesse/lifecycle/limites/timeouts
|
||||
0.3.5-alpha.5 smoke WebTransport natif + graphe
|
||||
0.3.5-alpha.6 chemin Rust WASM compilable
|
||||
0.3.5-alpha.7 smoke navigateur + TLS local réel
|
||||
0.3.5-alpha.8 fallback WebSocket au niveau composition
|
||||
0.3.5-alpha.9 datagram POC conditionnel et isolé
|
||||
0.3.5-alpha.10 mesures WebSocket vs WebTransport
|
||||
0.3.5-beta.1 validation large + full workspace + smokes
|
||||
0.3.5-beta.2 consolidation durable + conclusion + prompt 0.3.6
|
||||
0.3.5-rc.1 candidate gelée + gates de publication
|
||||
0.3.5 promotion stable mécanique
|
||||
```
|
||||
|
||||
Les numéros restent souples : une tranche peut être fusionnée si elle devient micro-scopique ou scindée avant exécution si elle dépasse clairement 30 minutes.
|
||||
|
||||
Le point important est que `alpha.6` et `alpha.7` sont séparées : compiler le client Rust WASM et faire fonctionner un navigateur avec certificat/UDP/serveur sont deux risques différents. De même, la consolidation n'est plus reportée dans la RC.
|
||||
|
||||
## Full tests et smoke tests planifiés
|
||||
|
||||
`cargo test --workspace --all-targets --all-features` est explicitement réservé à :
|
||||
|
||||
```text
|
||||
0.3.5-beta.1
|
||||
0.3.5-rc.1
|
||||
```
|
||||
|
||||
sauf changement transverse inattendu imposant une gate supplémentaire.
|
||||
|
||||
Smokes prévus :
|
||||
|
||||
```text
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
cargo run -p game-realtime-webtransport-smoke
|
||||
browser/WASM WebTransport smoke (workflow fixé en alpha.7)
|
||||
fallback branch smoke/proof (intégré à un launcher existant si possible)
|
||||
```
|
||||
|
||||
Le benchmark reste un outil borné, pas une infrastructure permanente disproportionnée.
|
||||
|
||||
## Fichiers
|
||||
|
||||
Ajoutés :
|
||||
|
||||
```text
|
||||
deltas/0.3.5/alpha.1.md
|
||||
docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md
|
||||
docs/studies/026-V0_3_5_WEBTRANSPORT_QUIC_STACK_AUDIT.md
|
||||
```
|
||||
|
||||
Modifiés :
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
docs/000-README.md
|
||||
docs/plans/000-README.md
|
||||
docs/studies/000-README.md
|
||||
```
|
||||
|
||||
Inchangés volontairement :
|
||||
|
||||
```text
|
||||
ROADMAP.md
|
||||
CHANGELOG.md
|
||||
prompts/006-V0_3_5_START_PROMPT.md
|
||||
crates/**
|
||||
Android/**
|
||||
Web/**
|
||||
```
|
||||
|
||||
## Validations exécutées dans l'environnement de génération
|
||||
|
||||
Après constitution de l'état livré, le générateur a exécuté uniquement les audits statiques autorisés :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 266 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
alpha.1 targeted consistency: clean
|
||||
```
|
||||
|
||||
Le contrôle ciblé confirme en particulier `workspace.package.version = 0.3.5-alpha.1`, la présence du plan/étude/delta, l'absence volontaire de `history/0.3.5/alpha.1.md` avant validation et l'absence d'entrée `0.3.5-alpha.1` dans `CHANGELOG.md`.
|
||||
|
||||
Aucun `cargo check`, Clippy, test, benchmark ou smoke post-delta n'est attribué au générateur.
|
||||
|
||||
## Validation utilisateur demandée
|
||||
|
||||
`Cargo.toml` change uniquement pour la version workspace et les fichiers Markdown changent. Aucune dépendance ni source Rust n'est encore ajoutée.
|
||||
|
||||
Depuis la racine :
|
||||
|
||||
```bash
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
```
|
||||
|
||||
Clippy et tests ne sont pas requis par cérémonie dans `alpha.1` car aucun code Rust, feature ou dépendance fonctionnelle n'est modifié. Le log d'ouverture a déjà confirmé `cargo check --workspace` propre sur la stable `0.3.4`; la commande ci-dessus valide la synchronisation de version du nouvel état.
|
||||
|
||||
## Suite après validation
|
||||
|
||||
Si cette gate est propre, `alpha.2` :
|
||||
|
||||
- crée `history/0.3.5/alpha.1.md` à partir de la sortie réelle ;
|
||||
- ajoute `game-realtime-webtransport-lib` ;
|
||||
- introduit la stack primaire avec features minimales ;
|
||||
- ferme la configuration TLS/hash et l'établissement natif ;
|
||||
- ne cherche pas encore à absorber framing, robustesse, browser smoke et fallback dans la même tranche.
|
||||
|
||||
Un échec du cadrage, des audits ou de la synchronisation de version produit d'abord `0.3.5-alpha.1.fix.N`.
|
||||
91
deltas/0.3.5/alpha.2.fix.1.md
Normal file
91
deltas/0.3.5/alpha.2.fix.1.md
Normal file
@@ -0,0 +1,91 @@
|
||||
<!-- file: deltas/0.3.5/alpha.2.fix.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.5-alpha.2.fix.1
|
||||
|
||||
## Base requise
|
||||
|
||||
`0.3.5-alpha.2`, candidate dont la gate utilisateur du 2026-09-21 a atteint les tests d’intégration WebTransport après fmt, audits, check workspace et Clippy propres.
|
||||
|
||||
## Cause
|
||||
|
||||
Le test positif d’établissement ouvre correctement la session WebTransport mais échoue sur l’assertion d’adresse distante :
|
||||
|
||||
```text
|
||||
left: [::ffff:127.0.0.1]:54430
|
||||
right: 127.0.0.1:54430
|
||||
```
|
||||
|
||||
Quinn expose ici l’adresse IPv4 loopback sous forme IPv4-mapped IPv6. Les deux valeurs désignent la même IP et le même port ; l’assertion brute sur `SocketAddr` confond donc différence de représentation et défaut de transport.
|
||||
|
||||
La même gate confirme parallèlement que :
|
||||
|
||||
- les quatre tests unitaires WebTransport passent ;
|
||||
- le test de mauvais pin passe ;
|
||||
- la compilation workspace et Clippy sont propres ;
|
||||
- les audits Rust/workspace, Markdown et distribution sont propres.
|
||||
|
||||
`alpha.2` n’est pas historisée comme validée : le test d’intégration positif reste rouge jusqu’à ce correctif.
|
||||
|
||||
## Correction
|
||||
|
||||
La version technique passe à :
|
||||
|
||||
```text
|
||||
0.3.5-alpha.2.fix.1
|
||||
```
|
||||
|
||||
`tests/establishment.rs` normalise uniquement les `SocketAddr` observées avant comparaison :
|
||||
|
||||
- une adresse IPv4 reste inchangée ;
|
||||
- une IPv6 IPv4-mapped est ramenée à son IPv4 canonique avec le même port ;
|
||||
- une IPv6 native reste inchangée.
|
||||
|
||||
L’assertion continue donc de détecter un port différent, une IPv4 différente ou une IPv6 réellement différente. Elle cesse seulement de considérer `127.0.0.1` et `::ffff:127.0.0.1` comme deux endpoints distincts.
|
||||
|
||||
Aucun code de production WebTransport, certificat, pinning, configuration Quinn, mapping d’erreur ou API publique n’est modifié.
|
||||
|
||||
## Fichiers modifiés
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
crates/common/game-realtime-webtransport-lib/tests/establishment.rs
|
||||
docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md
|
||||
```
|
||||
|
||||
Nouveau fichier :
|
||||
|
||||
```text
|
||||
deltas/0.3.5/alpha.2.fix.1.md
|
||||
```
|
||||
|
||||
Aucun fichier `history/0.3.5/alpha.2.md` n’est créé avant une gate entièrement verte.
|
||||
|
||||
## Plan
|
||||
|
||||
Le forecast fonctionnel ne change pas. Après validation de ce fix, `0.3.5-alpha.3` reste la tranche dédiée au stream bidirectionnel principal, au framing borné `u32 big-endian + payload` et à l’adaptation `RealtimeConnection`.
|
||||
|
||||
## Validation attendue
|
||||
|
||||
Le correctif touche un test Rust et la version Cargo ; la gate repart depuis le début :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
|
||||
cargo test -p game-realtime-webtransport-lib --all-targets --all-features
|
||||
```
|
||||
|
||||
Aucun `cargo tree` supplémentaire n’est requis : le graphe de dépendances n’a pas changé et la gate `alpha.2` l’a déjà produit.
|
||||
|
||||
## Après validation
|
||||
|
||||
Créer `history/0.3.5/alpha.2.fix.1.md` à partir des résultats réellement fournis, puis ouvrir directement `0.3.5-alpha.3`.
|
||||
203
deltas/0.3.5/alpha.2.md
Normal file
203
deltas/0.3.5/alpha.2.md
Normal file
@@ -0,0 +1,203 @@
|
||||
<!-- file: deltas/0.3.5/alpha.2.md -->
|
||||
<!-- version: 2 -->
|
||||
|
||||
# Delta 0.3.5-alpha.2
|
||||
|
||||
## Base
|
||||
|
||||
Base : `0.3.5-alpha.1` validée par l'utilisateur le 2026-09-21.
|
||||
|
||||
Cette tranche reste limitée à la fondation WebTransport native prévue par le plan : dépendances minimales, identité TLS, pin SHA-256, bind QUIC/HTTP3 et établissement d'une session client/server. Elle ne contient encore ni stream applicatif principal, ni framing `u32 + payload`, ni adaptation `RealtimeConnection`, ni datagram, ni fallback.
|
||||
|
||||
## Historique fermé
|
||||
|
||||
Ajout de :
|
||||
|
||||
```text
|
||||
history/0.3.5/alpha.1.md
|
||||
```
|
||||
|
||||
L'entrée enregistre exactement la gate utilisateur reçue : fmt check, trois audits propres et `cargo check --workspace` propre sur `0.3.5-alpha.1`. Le plan révisé a été explicitement accepté avant le passage à cette tranche.
|
||||
|
||||
## Version
|
||||
|
||||
La version workspace passe de :
|
||||
|
||||
```text
|
||||
0.3.5-alpha.1
|
||||
```
|
||||
|
||||
à :
|
||||
|
||||
```text
|
||||
0.3.5-alpha.2
|
||||
```
|
||||
|
||||
Aucune version Android, npm ou Tauri indépendante n'est modifiée.
|
||||
|
||||
## Nouvelle crate WebTransport
|
||||
|
||||
Ajout de :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-webtransport-lib/Cargo.toml
|
||||
crates/common/game-realtime-webtransport-lib/README.md
|
||||
crates/common/game-realtime-webtransport-lib/src/lib.rs
|
||||
crates/common/game-realtime-webtransport-lib/src/webtransport.rs
|
||||
crates/common/game-realtime-webtransport-lib/unit_tests/webtransport.rs
|
||||
crates/common/game-realtime-webtransport-lib/tests/establishment.rs
|
||||
```
|
||||
|
||||
La crate est placée sous `crates/common/` au même niveau que le contrat transport-neutral et le backend WebSocket. Elle ne contient aucune sémantique de jeu.
|
||||
|
||||
## Dépendances et features
|
||||
|
||||
Les contraintes nouvelles sont centralisées dans `[workspace.dependencies]` :
|
||||
|
||||
```text
|
||||
rcgen = 0.14.10, default-features = false
|
||||
url = 2.5.8
|
||||
web-transport-quinn = 0.12.1, default-features = false
|
||||
```
|
||||
|
||||
La crate consommatrice active localement uniquement `ring` sur `rcgen` et `web-transport-quinn`.
|
||||
|
||||
`web-transport-quinn` est utilisé directement dans cette tranche native. La façade multiplateforme `web-transport` reste différée jusqu'au chemin WASM, afin de ne pas introduire une dépendance sans consommateur réel.
|
||||
|
||||
Le backend crypto par défaut `aws-lc-rs` de `web-transport-quinn` est donc désactivé. `ring` devient le provider unique du POC natif initial.
|
||||
|
||||
## Identité TLS et pinning
|
||||
|
||||
`WebTransportServerIdentity` accepte deux chemins :
|
||||
|
||||
```text
|
||||
generate_loopback()
|
||||
from_pkcs8_der(certificate_der, private_key_pkcs8_der)
|
||||
```
|
||||
|
||||
La génération loopback produit en mémoire :
|
||||
|
||||
- une clé ECDSA P-256 ;
|
||||
- un certificat self-signed avec SHA-256 ;
|
||||
- les SAN `localhost`, `127.0.0.1` et `::1` ;
|
||||
- une validité de sept jours avec 60 secondes de marge avant l'heure courante ;
|
||||
- aucun PEM ni fichier de clé versionné.
|
||||
|
||||
`WebTransportCertificateHash` porte exactement les 32 octets SHA-256 du certificat. Le client configure `ClientBuilder::with_server_certificate_hashes(...)` ; aucune option de TLS permissif n'est exposée.
|
||||
|
||||
L'injection DER ne prétend pas parser ou certifier la cohérence clé/certificat avant le bind : le builder TLS natif reste l'autorité qui rejette une paire incompatible.
|
||||
|
||||
## Configuration et établissement natif
|
||||
|
||||
`WebTransportClientConfig` impose un endpoint `https://` valide et un hash épinglé.
|
||||
|
||||
`WebTransportServerConfig` possède l'adresse UDP et l'identité TLS.
|
||||
|
||||
`WebTransportListener::bind(...)` :
|
||||
|
||||
- construit le serveur Quinn/WebTransport ;
|
||||
- supporte le port `0` pour une allocation éphémère ;
|
||||
- expose l'adresse effectivement bindée ;
|
||||
- mappe les erreurs vers `TransportErrorKind::Bind`.
|
||||
|
||||
`WebTransportListener::accept(...)` accepte le CONNECT HTTP/3 et retourne une `WebTransportSession`.
|
||||
|
||||
`connect(...)` construit un client pinned et retourne également une `WebTransportSession`. Les erreurs d'établissement client sont mappées vers `Connect`; les erreurs serveur vers `Accept`.
|
||||
|
||||
La session expose uniquement des diagnostics d'établissement (`remote_addr`, URL CONNECT). Le stream fiable applicatif appartient explicitement à `alpha.3`.
|
||||
|
||||
## Tests ajoutés
|
||||
|
||||
Les tests unitaires couvrent :
|
||||
|
||||
- conservation exacte d'un SHA-256 de 32 octets ;
|
||||
- acceptation d'un endpoint HTTPS ;
|
||||
- rejet HTTP/WebSocket ;
|
||||
- rejet d'une identité injectée sans certificat ou sans clé ;
|
||||
- génération d'une identité loopback avec fingerprint SHA-256.
|
||||
|
||||
Le test d'intégration `establishment.rs` couvre :
|
||||
|
||||
- bind sur `127.0.0.1:0` ;
|
||||
- génération d'identité éphémère ;
|
||||
- pin SHA-256 transmis au client ;
|
||||
- établissement client/server concurrent borné par timeout ;
|
||||
- URL CONNECT observée des deux côtés ;
|
||||
- rejet d'un mauvais pin côté client.
|
||||
|
||||
Il ne transmet volontairement aucun payload : ce serait anticiper `alpha.3`.
|
||||
|
||||
## Tracing
|
||||
|
||||
Le nouveau backend utilise :
|
||||
|
||||
```text
|
||||
games::realtime::webtransport
|
||||
```
|
||||
|
||||
pour bind, connexion, accept et diagnostics d'échec d'établissement.
|
||||
|
||||
## Documentation et plan
|
||||
|
||||
`README.md` racine annonce `0.3.5-alpha.2` et la nouvelle frontière native.
|
||||
|
||||
Le README local documente la responsabilité de la crate, le TLS de développement et les frontières encore exclues.
|
||||
|
||||
Le plan `005` est réconcilié avec les choix réellement fermés : dépendances natives directes, provider `ring`, identité sept jours et absence volontaire de façade `web-transport` avant le chemin WASM.
|
||||
|
||||
`ROADMAP.md` et `CHANGELOG.md` restent inchangés : le scope macro de `0.3.5` ne change pas et cette alpha n'est pas un jalon de changelog.
|
||||
|
||||
## Validation exécutée dans l'environnement de génération
|
||||
|
||||
L'environnement de génération ne possède pas de toolchain Rust. Il ne doit donc attribuer aucun `cargo fmt`, `cargo check`, Clippy, test ou `cargo tree` à cette livraison.
|
||||
|
||||
Les audits Python et contrôles statiques sont exécutés après constitution du delta. Sur la reconstruction locale issue du ZIP taggé `v0.3.4` puis du delta `alpha.1`, ils donnent :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 269 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
TOML/workspace consistency: clean
|
||||
```
|
||||
|
||||
Le compteur de fichiers Markdown de cette reconstruction n'est pas utilisé comme référence pour le checkout utilisateur : la gate `alpha.1` de l'utilisateur comptait déjà davantage de fichiers (`282`) que la reconstruction autoritaire ZIP + delta. Seul le statut clean est comparé. Ces contrôles restent distincts de la gate Cargo utilisateur.
|
||||
|
||||
## Validation utilisateur demandée
|
||||
|
||||
Cette tranche modifie Rust et le graphe de dépendances ; la gate ciblée est donc :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
|
||||
cargo test -p game-realtime-webtransport-lib --all-targets --all-features
|
||||
|
||||
cargo tree -p game-realtime-webtransport-lib --edges normal
|
||||
cargo tree -p game-realtime-webtransport-lib --edges features
|
||||
cargo tree -i web-transport-quinn --workspace --edges normal
|
||||
```
|
||||
|
||||
Le full `cargo test --workspace --all-targets --all-features` reste réservé au jalon large `beta.1` conformément au plan.
|
||||
|
||||
Aucun smoke executable n'est requis dans `alpha.2` : le test d'intégration prouve l'établissement natif sous harness, tandis que le smoke WebTransport public reste la responsabilité explicite de `alpha.5` après le framing fiable et la robustesse.
|
||||
|
||||
## Suite après validation
|
||||
|
||||
Si la gate est propre, `0.3.5-alpha.3` peut :
|
||||
|
||||
- ouvrir/ accepter le stream bidirectionnel principal ;
|
||||
- ajouter le framing privé borné `u32 big-endian + payload` ;
|
||||
- implémenter `RealtimeConnection`, sender et receiver ;
|
||||
- prouver le round-trip binaire ordonné et plusieurs messages ;
|
||||
- conserver datagrams, robustesse avancée et smoke public hors de cette tranche.
|
||||
|
||||
Un défaut fermé de cette tranche produit d'abord `0.3.5-alpha.2.fix.N` au lieu d'ouvrir `alpha.3`.
|
||||
184
deltas/0.3.5/alpha.3.md
Normal file
184
deltas/0.3.5/alpha.3.md
Normal file
@@ -0,0 +1,184 @@
|
||||
<!-- file: deltas/0.3.5/alpha.3.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.5-alpha.3
|
||||
|
||||
## Base requise
|
||||
|
||||
`0.3.5-alpha.2.fix.1`, validée par l'utilisateur le 2026-09-21 avec fmt, audits, check workspace, Clippy strict et les six tests de `game-realtime-webtransport-lib` entièrement verts.
|
||||
|
||||
La validation réellement fournie est conservée dans `history/0.3.5/alpha.2.fix.1.md`.
|
||||
|
||||
## Objectif
|
||||
|
||||
Fermer la première adaptation fiable WebTransport vers `game-realtime-transport-lib` sans introduire encore la robustesse/lifecycle avancés, le navigateur/WASM, les datagrams ou le smoke public.
|
||||
|
||||
La version passe à :
|
||||
|
||||
```text
|
||||
0.3.5-alpha.3
|
||||
```
|
||||
|
||||
## Stream primaire
|
||||
|
||||
Une `WebTransportSession` peut désormais être consommée de deux façons :
|
||||
|
||||
```text
|
||||
client -> open_primary_connection()
|
||||
server -> accept_primary_connection()
|
||||
```
|
||||
|
||||
Chaque chemin sélectionne exactement un stream bidirectionnel fiable et retourne `WebTransportConnection`.
|
||||
|
||||
Le backend `web-transport-quinn` écrit lui-même l'en-tête WebTransport nécessaire pendant `open_bi()`. Le serveur peut donc accepter le stream avant toute frame applicative. Aucun préambule games.sasedev supplémentaire n'est ajouté : après l'en-tête protocolaire géré par la dépendance, le premier octet applicatif appartient directement au framing prévu.
|
||||
|
||||
## Framing fiable privé
|
||||
|
||||
Le framing du stream primaire est :
|
||||
|
||||
```text
|
||||
u32 big-endian payload length
|
||||
payload bytes
|
||||
```
|
||||
|
||||
Il reste privé à `game-realtime-webtransport-lib` et n'est pas un wire codec gameplay.
|
||||
|
||||
La borne POC actuelle est de 1 MiB par message. Elle est vérifiée :
|
||||
|
||||
- avant écriture côté sender ;
|
||||
- immédiatement après décodage des quatre octets de longueur et avant toute allocation côté receiver.
|
||||
|
||||
Une longueur hors limite produit `TransportErrorKind::MessageTooLarge`.
|
||||
|
||||
La limite n'est pas encore exposée comme configuration produit. `alpha.4` possède cette décision avec les autres limites et deadlines.
|
||||
|
||||
## Contrat commun
|
||||
|
||||
`WebTransportConnection` implémente `RealtimeConnection` et produit :
|
||||
|
||||
```text
|
||||
WebTransportSender
|
||||
WebTransportReceiver
|
||||
```
|
||||
|
||||
Les deux moitiés conservent chacune une référence à la session WebTransport. Le `split()` ne ferme donc pas accidentellement la session au moment où l'objet connexion est consommé.
|
||||
|
||||
`WebTransportSender::send(...)` écrit le header puis le payload sur le stream fiable et respecte la backpressure naturelle de QUIC pendant les écritures asynchrones.
|
||||
|
||||
`WebTransportReceiver::receive(...)` reconstruit exactement un `TransportMessage`, y compris les payloads vides et binaires non UTF-8.
|
||||
|
||||
`RealtimeSender::close()` termine proprement la direction locale du stream primaire. Lorsque le pair a consommé les messages précédents puis atteint le FIN, `RealtimeReceiver::receive()` retourne `TransportReceive::Closed`.
|
||||
|
||||
La fermeture complète de session, reset, abort, cancellation, deadlines et mapping fin des erreurs restent hors de cette tranche.
|
||||
|
||||
## API et documentation
|
||||
|
||||
`src/lib.rs` réexporte les nouveaux types publics conformément aux règles du workspace.
|
||||
|
||||
Le README local est réconcilié avec le stream primaire et ses frontières. Un `USAGE.md` durable est ajouté car l'ordre session -> stream primaire -> `RealtimeConnection` et la contrainte d'accept serveur nécessitent désormais un guide d'utilisation distinct du delta.
|
||||
|
||||
Le plan `005` enregistre les décisions réellement matérialisées sans modifier le forecast de `alpha.4+`.
|
||||
|
||||
`ROADMAP.md` et `CHANGELOG.md` restent inchangés : cette alpha ne modifie ni la mission macro de `0.3.5` ni une livraison stable.
|
||||
|
||||
## Tests
|
||||
|
||||
Le test unitaire du backend ajoute la preuve que :
|
||||
|
||||
- la longueur est encodée en `u32` big-endian ;
|
||||
- la borne de frame refuse une taille supérieure à 1 MiB avec `MessageTooLarge`.
|
||||
|
||||
Le nouveau test d'intégration `tests/realtime_connection.rs` prouve en loopback :
|
||||
|
||||
- ouverture du stream primaire côté client ;
|
||||
- ouverture cliente puis accept du stream primaire côté serveur avant la première frame applicative ;
|
||||
- adaptation `RealtimeConnection` ;
|
||||
- payload vide ;
|
||||
- payload binaire non UTF-8 ;
|
||||
- ordre de plusieurs messages ;
|
||||
- echo bidirectionnel ;
|
||||
- FIN client observé comme `TransportReceive::Closed` côté serveur ;
|
||||
- FIN serveur observé comme `TransportReceive::Closed` côté client.
|
||||
|
||||
Les sessions restent vivantes pendant toute la preuve afin que le test ne confonde pas FIN du stream logique et drop de session.
|
||||
|
||||
## Fichiers modifiés
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
crates/common/game-realtime-webtransport-lib/README.md
|
||||
crates/common/game-realtime-webtransport-lib/src/lib.rs
|
||||
crates/common/game-realtime-webtransport-lib/src/webtransport.rs
|
||||
crates/common/game-realtime-webtransport-lib/unit_tests/webtransport.rs
|
||||
docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md
|
||||
```
|
||||
|
||||
Nouveaux fichiers :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-webtransport-lib/USAGE.md
|
||||
crates/common/game-realtime-webtransport-lib/tests/realtime_connection.rs
|
||||
history/0.3.5/alpha.2.fix.1.md
|
||||
deltas/0.3.5/alpha.3.md
|
||||
```
|
||||
|
||||
Aucune dépendance Cargo n'est ajoutée ou modifiée dans cette tranche.
|
||||
|
||||
## Validation exécutée dans l'environnement de génération
|
||||
|
||||
L'environnement de génération ne possède pas de toolchain Rust. Aucun `cargo fmt`, `cargo check`, Clippy ou test n'est donc attribué à cette livraison.
|
||||
|
||||
Les audits statiques disponibles ont été exécutés sur le candidat final :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 273 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
```
|
||||
|
||||
Le compteur de fichiers Markdown correspond à la reconstruction de travail issue de l'archive taggée et des deltas fournis. Il n'est pas utilisé comme invariant contre le checkout utilisateur, qui contient davantage de fichiers suivis localement.
|
||||
|
||||
## Validation utilisateur demandée
|
||||
|
||||
Cette tranche modifie le backend Rust et ajoute un test d'intégration. La gate ciblée est :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-webtransport-lib --all-targets --all-features
|
||||
|
||||
cargo tree -i game-realtime-webtransport-lib --workspace --edges normal
|
||||
```
|
||||
|
||||
Le contrat commun est retesté parce que `alpha.3` en devient un nouvel implémenteur, même si sa crate n'est pas modifiée.
|
||||
|
||||
Le `cargo tree` inverse vérifie qu'aucune crate moteur ou gameplay n'a acquis de dépendance vers le backend concret. Les arbres complets `web-transport-quinn` de `alpha.2` ne sont pas répétés puisque le graphe de dépendances n'a pas changé.
|
||||
|
||||
Aucun smoke executable n'est encore attendu : le smoke natif public reste `alpha.5`, après la tranche de robustesse `alpha.4`.
|
||||
|
||||
## Suite après validation
|
||||
|
||||
Si la gate est propre, ouvrir `0.3.5-alpha.4` pour :
|
||||
|
||||
- limites configurables si justifiées ;
|
||||
- deadlines ;
|
||||
- backpressure/erreurs observables ;
|
||||
- close/reset/abort ;
|
||||
- cancellation/drop ;
|
||||
- cas négatifs de framing ;
|
||||
- mapping d'erreurs détaillé ;
|
||||
- tests de robustesse ciblés.
|
||||
|
||||
Un défaut fermé de cette tranche produit d'abord `0.3.5-alpha.3.fix.N` au lieu d'ouvrir `alpha.4`.
|
||||
96
deltas/0.3.5/alpha.4.fix.1.md
Normal file
96
deltas/0.3.5/alpha.4.fix.1.md
Normal file
@@ -0,0 +1,96 @@
|
||||
<!-- file: deltas/0.3.5/alpha.4.fix.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.5-alpha.4.fix.1
|
||||
|
||||
## Base requise
|
||||
|
||||
`0.3.5-alpha.4`, candidate dont la gate utilisateur du 2026-09-21 a passé fmt, audits, `cargo check`, les sept tests du contrat realtime commun et l'ensemble des vingt tests WebTransport, mais a échoué sur Clippy strict.
|
||||
|
||||
`alpha.4` n'est pas historisée comme validée : `cargo clippy --workspace --all-targets --all-features -- -D warnings` reste rouge jusqu'à ce correctif.
|
||||
|
||||
## Cause
|
||||
|
||||
Clippy signale une unique violation `clippy::implicit-return` dans l'implémentation de `RealtimeReceiver::receive()` :
|
||||
|
||||
```text
|
||||
error: missing `return` statement
|
||||
--> crates/common/game-realtime-webtransport-lib/src/webtransport.rs:449:38
|
||||
|
||||
return Box::pin(async move { self.receive_frame().await });
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
```
|
||||
|
||||
Le `return` externe est déjà explicite, mais la closure `async move` contient encore une expression terminale implicite, interdite par les règles Clippy strictes du workspace.
|
||||
|
||||
Les mêmes résultats fournis par l'utilisateur confirment parallèlement que :
|
||||
|
||||
- les audits Rust/workspace, Markdown et distribution sont propres ;
|
||||
- `cargo check --workspace` est propre ;
|
||||
- les sept tests de `game-realtime-transport-lib` passent ;
|
||||
- les onze tests unitaires, deux tests d'établissement, un test de round-trip et six tests de robustesse de `game-realtime-webtransport-lib` passent ;
|
||||
- le graphe direct/inverse du backend WebTransport reste celui attendu.
|
||||
|
||||
Le défaut est donc purement un écart de style/lint ; aucun défaut fonctionnel WebTransport n'est observé dans cette gate.
|
||||
|
||||
## Correction
|
||||
|
||||
La version technique passe à :
|
||||
|
||||
```text
|
||||
0.3.5-alpha.4.fix.1
|
||||
```
|
||||
|
||||
La future retournée par `RealtimeReceiver::receive()` explicite aussi son `return` interne :
|
||||
|
||||
```rust
|
||||
return Box::pin(async move { return self.receive_frame().await });
|
||||
```
|
||||
|
||||
Aucun comportement runtime, état du parseur incrémental, framing, deadline, mapping d'erreur, lifecycle, API publique ou dépendance n'est modifié.
|
||||
|
||||
## Fichiers modifiés
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
crates/common/game-realtime-webtransport-lib/src/webtransport.rs
|
||||
docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md
|
||||
```
|
||||
|
||||
Nouveau fichier :
|
||||
|
||||
```text
|
||||
deltas/0.3.5/alpha.4.fix.1.md
|
||||
```
|
||||
|
||||
Aucun fichier `history/0.3.5/alpha.4.md` n'est créé avant une gate entièrement verte du correctif.
|
||||
|
||||
## Plan
|
||||
|
||||
Le forecast fonctionnel ne change pas. Après validation de ce fix, `0.3.5-alpha.5` reste strictement la tranche du smoke WebTransport natif hors harness.
|
||||
|
||||
## Validation attendue
|
||||
|
||||
Le correctif touche du code Rust et la version workspace ; la gate repart depuis le début :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-webtransport-lib --all-targets --all-features
|
||||
```
|
||||
|
||||
Aucun `cargo tree` supplémentaire n'est requis : ce fix ne change ni dépendance, ni feature, ni frontière de crate, et le tree de `alpha.4` a déjà été produit.
|
||||
|
||||
## Après validation
|
||||
|
||||
Créer `history/0.3.5/alpha.4.fix.1.md` à partir des résultats réellement fournis, puis ouvrir directement `0.3.5-alpha.5`.
|
||||
208
deltas/0.3.5/alpha.4.md
Normal file
208
deltas/0.3.5/alpha.4.md
Normal file
@@ -0,0 +1,208 @@
|
||||
<!-- file: deltas/0.3.5/alpha.4.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.3.5-alpha.4
|
||||
|
||||
## Base requise
|
||||
|
||||
`0.3.5-alpha.3`, validée par l'utilisateur le 2026-09-21 avec fmt, audits, check workspace, Clippy strict, les sept tests du contrat realtime commun et les huit tests WebTransport entièrement verts.
|
||||
|
||||
La validation réellement fournie est conservée dans `history/0.3.5/alpha.3.md`.
|
||||
|
||||
## Objectif
|
||||
|
||||
Fermer la robustesse du chemin fiable WebTransport natif avant de créer le smoke runtime public. Cette tranche porte limites/deadlines, lifecycle, cancellation et cas négatifs de framing, sans introduire encore WASM, datagrams, fallback ou benchmark.
|
||||
|
||||
La version passe à :
|
||||
|
||||
```text
|
||||
0.3.5-alpha.4
|
||||
```
|
||||
|
||||
## Configuration et limites
|
||||
|
||||
Nouveau `WebTransportConfig` partagé par les configs client/server, avec defaults POC explicites :
|
||||
|
||||
```text
|
||||
max_message_size = 1 MiB
|
||||
connect_timeout = 10 s
|
||||
primary_stream_timeout = 5 s
|
||||
send_timeout = 5 s
|
||||
```
|
||||
|
||||
La configuration est immutable par builders copiés et validée avant bind/connect. Sont refusés :
|
||||
|
||||
- `max_message_size == 0` ;
|
||||
- une borne qui ne tient pas dans le champ de longueur `u32` sur les plateformes où cela peut arriver ;
|
||||
- une deadline nulle.
|
||||
|
||||
La borne n'est plus une constante cachée : sender et receiver utilisent chacun la configuration transport associée à leur session. Le receiver contrôle toujours la longueur avant allocation.
|
||||
|
||||
## Deadlines et backpressure
|
||||
|
||||
Le client borne la tentative d'établissement complète par `connect_timeout`.
|
||||
|
||||
Le listener conserve une attente non bornée du prochain pair, comportement normal d'un serveur idle. Une fois la requête WebTransport CONNECT matérialisée, la réponse serveur est bornée par `connect_timeout`.
|
||||
|
||||
Ouverture et accept du stream bidirectionnel primaire sont bornés par `primary_stream_timeout`.
|
||||
|
||||
Un send complet — header puis payload — est borné par `send_timeout`. La backpressure reste celle du flow-control QUIC : aucune queue applicative artificielle n'est introduite. Si le flow-control empêche l'envoi de terminer dans la deadline, le résultat observable est `TransportErrorKind::Timeout`.
|
||||
|
||||
`receive()` n'impose volontairement aucun timeout d'idle. L'absence de message n'est pas une erreur transport ; la future peut être bornée/annulée par l'appelant.
|
||||
|
||||
## Cancellation sûre du receive
|
||||
|
||||
Le receiver n'utilise plus une lecture monolithique header/payload. Il garde un état incrémental :
|
||||
|
||||
```text
|
||||
header bytes read
|
||||
payload allocation after validated length
|
||||
payload bytes read
|
||||
```
|
||||
|
||||
La primitive de lecture amont utilisée est cancel-safe. Si une future `receive()` est abandonnée après une partie de la frame, l'état acquis reste dans `WebTransportReceiver` et l'appel suivant reprend au bon octet.
|
||||
|
||||
Cela permet de combiner un wait externe borné avec le contrat `RealtimeReceiver` sans perdre de bytes ni désynchroniser le framing.
|
||||
|
||||
## Close, reset, abort et drop
|
||||
|
||||
Le FIN propre reste `RealtimeSender::close()`.
|
||||
|
||||
Le backend concret expose en complément :
|
||||
|
||||
```text
|
||||
WebTransportSender::abort(code)
|
||||
WebTransportReceiver::abort(code)
|
||||
```
|
||||
|
||||
Le premier reset la direction d'envoi ; le second stoppe la direction de réception.
|
||||
|
||||
Un sender ou receiver encore actif au moment de son drop est aborté explicitement au lieu de laisser le backend transformer implicitement le drop en FIN propre.
|
||||
|
||||
Un `send()` annulé en cours d'écriture est terminal : un guard reset le stream, car une frame dont seulement le header ou une partie du payload a été écrit ne peut pas être reprise sans ambiguïté. Une cancellation de `receive()` reste au contraire reprenable grâce au parseur incrémental.
|
||||
|
||||
## Framing négatif et mapping d'erreurs
|
||||
|
||||
Les nouvelles branches explicites sont :
|
||||
|
||||
- longueur entrante supérieure à `max_message_size` -> `MessageTooLarge`, avant allocation, puis stop de la direction ;
|
||||
- EOF à frontière de frame -> `TransportReceive::Closed` ;
|
||||
- EOF au milieu du header ou du payload -> `Protocol` ;
|
||||
- reset/STOP distant -> `Aborted` ;
|
||||
- stream/session fermé proprement -> `Closed` ;
|
||||
- état de stream invalide rapporté par le backend -> `Protocol` ;
|
||||
- deadline dépassée -> `Timeout` ;
|
||||
- autre erreur de session -> `Io`.
|
||||
|
||||
Les types d'erreurs Quinn/WebTransport restent privés à la crate backend.
|
||||
|
||||
## Tests
|
||||
|
||||
Les tests unitaires ajoutent :
|
||||
|
||||
- validation des defaults et configurations invalides ;
|
||||
- mapping reset/STOP, close et erreur protocolaire ;
|
||||
- cancellation d'un `receive()` après deux octets de header puis reprise exacte ;
|
||||
- header ou payload tronqué par FIN -> `Protocol`.
|
||||
|
||||
Le nouveau `tests/robustness.rs` prouve en loopback :
|
||||
|
||||
- rejet outbound d'un message supérieur à la borne avant écriture ;
|
||||
- rejet inbound d'une longueur supérieure à la borne avant allocation ;
|
||||
- reset explicite sender observé comme `Aborted` par le pair ;
|
||||
- abort explicite receiver rendant immédiatement sa moitié locale terminale ;
|
||||
- drop sender sans `close()` observé comme `Aborted`, pas comme FIN propre ;
|
||||
- deadline d'accept du stream primaire lorsque le pair n'en ouvre aucun.
|
||||
|
||||
Aucun test de saturation artificielle n'est ajouté : provoquer de façon déterministe le flow-control QUIC sans s'appuyer sur des internals amont élargirait inutilement la tranche. Le mécanisme est borné par `send_timeout` et sera aussi exercé indirectement par les smokes/mesures ultérieurs.
|
||||
|
||||
## API et documentation
|
||||
|
||||
`src/lib.rs` réexporte `WebTransportConfig` conformément aux règles d'exports du workspace.
|
||||
|
||||
`README.md` et `USAGE.md` de la crate documentent les limites, le scope exact des deadlines, les différences FIN/abort/drop et les garanties de cancellation.
|
||||
|
||||
Le plan `005` est réconcilié avec les décisions réellement matérialisées. `ROADMAP.md` et `CHANGELOG.md` restent inchangés : la mission macro de `0.3.5` n'est pas modifiée par cette alpha.
|
||||
|
||||
## Dépendances
|
||||
|
||||
Aucune nouvelle crate n'est introduite.
|
||||
|
||||
`tokio`, déjà présent dans le workspace et déjà utilisé comme dev-dependency de la crate, devient aussi une dépendance runtime locale avec la feature `time`, car le backend porte désormais ses deadlines opérationnelles.
|
||||
|
||||
## Fichiers modifiés
|
||||
|
||||
```text
|
||||
Cargo.toml
|
||||
README.md
|
||||
crates/common/game-realtime-webtransport-lib/Cargo.toml
|
||||
crates/common/game-realtime-webtransport-lib/README.md
|
||||
crates/common/game-realtime-webtransport-lib/USAGE.md
|
||||
crates/common/game-realtime-webtransport-lib/src/lib.rs
|
||||
crates/common/game-realtime-webtransport-lib/src/webtransport.rs
|
||||
crates/common/game-realtime-webtransport-lib/unit_tests/webtransport.rs
|
||||
docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md
|
||||
```
|
||||
|
||||
Nouveaux fichiers :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-webtransport-lib/src/config.rs
|
||||
crates/common/game-realtime-webtransport-lib/tests/robustness.rs
|
||||
crates/common/game-realtime-webtransport-lib/unit_tests/config.rs
|
||||
history/0.3.5/alpha.3.md
|
||||
deltas/0.3.5/alpha.4.md
|
||||
```
|
||||
|
||||
## Validation exécutée dans l'environnement de génération
|
||||
|
||||
L'environnement de génération ne possède pas de toolchain Rust. Aucun `cargo fmt`, `cargo check`, Clippy ou test n'est donc attribué à cette livraison.
|
||||
|
||||
Les audits statiques disponibles ont été exécutés sur le candidat final :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 275 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
Targeted alpha.4 consistency audit: clean
|
||||
```
|
||||
|
||||
Le compteur Markdown correspond à la reconstruction de travail issue du ZIP taggé et des deltas appliqués ; il n'est pas utilisé comme invariant contre le checkout utilisateur.
|
||||
|
||||
Le ZIP delta a ensuite été appliqué sur une copie propre de `0.3.5-alpha.3`. L'overlay reproduit exactement le candidat `alpha.4`, contient 14 fichiers utiles et repasse les mêmes audits Rust/workspace, Markdown et distribution, ainsi que le contrôle ciblé de version/cohérence. `unzip -t` ne signale aucune erreur.
|
||||
|
||||
## Validation utilisateur demandée
|
||||
|
||||
Cette tranche modifie le backend runtime et son graphe local de features Tokio. La gate ciblée est :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-webtransport-lib --all-targets --all-features
|
||||
|
||||
cargo tree -p game-realtime-webtransport-lib --edges normal
|
||||
cargo tree -i game-realtime-webtransport-lib --workspace --edges normal
|
||||
```
|
||||
|
||||
Le contrat commun est retesté pour garantir que les nouvelles catégories de lifecycle du backend restent compatibles avec son API transport-neutral.
|
||||
|
||||
Le tree direct vérifie le passage de Tokio en dépendance runtime locale ; le tree inverse conserve la preuve qu'aucune crate engine/gameplay n'a acquis le backend concret.
|
||||
|
||||
Aucun smoke executable n'est attendu dans cette tranche. Le smoke natif hors harness reste strictement réservé à `alpha.5` afin de respecter la taille d'un delta.
|
||||
|
||||
## Suite après validation
|
||||
|
||||
Si la gate est propre, ouvrir `0.3.5-alpha.5` pour créer/finaliser `game-realtime-webtransport-smoke`, effectuer un round-trip localhost hors `#[test]`, produire un `PASS` déterministe et contrôler le graphe runtime.
|
||||
|
||||
Un défaut fermé de cette tranche produit d'abord `0.3.5-alpha.4.fix.N` au lieu d'ouvrir `alpha.5`.
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/000-README.md -->
|
||||
<!-- version: 31 -->
|
||||
<!-- version: 35 -->
|
||||
|
||||
# Documentation games.sasedev
|
||||
|
||||
@@ -11,13 +11,16 @@
|
||||
|
||||
- [`ideas/000-README.md`](ideas/000-README.md) — rôle des idées non engagées et règles de maturation.
|
||||
- [`studies/000-README.md`](studies/000-README.md) — rôle des études comparatives non normatives.
|
||||
- [`studies/026-V0_3_5_WEBTRANSPORT_QUIC_STACK_AUDIT.md`](studies/026-V0_3_5_WEBTRANSPORT_QUIC_STACK_AUDIT.md) — audit `0.3.5` des stacks WebTransport/QUIC, du contrat transport, de TLS et des plateformes.
|
||||
|
||||
## Plans
|
||||
|
||||
- [`plans/000-README.md`](plans/000-README.md) — plans vivants des versions ; le plan actif porte notamment le découpage prévisionnel souple des prereleases.
|
||||
- [`plans/001-V0_3_0_WEB_SNAKE_POC_PLAN.md`](plans/001-V0_3_0_WEB_SNAKE_POC_PLAN.md) — plan clôturé de `0.3.0`, premier POC Snake Web direct.
|
||||
- [`plans/002-V0_3_1_TAURI_ANDROID_SNAKE_PLAN.md`](plans/002-V0_3_1_TAURI_ANDROID_SNAKE_PLAN.md) — plan clôturé de `0.3.1`, second host Snake Tauri Android.
|
||||
- [`plans/003-V0_3_3_ANDROID_NATIVE_MULTI_ABI_PLAN.md`](plans/003-V0_3_3_ANDROID_NATIVE_MULTI_ABI_PLAN.md) — plan actif de `0.3.3`, pipeline Android SDL3 natif Gradle/Cargo multi-ABI.
|
||||
- [`plans/003-V0_3_3_ANDROID_NATIVE_MULTI_ABI_PLAN.md`](plans/003-V0_3_3_ANDROID_NATIVE_MULTI_ABI_PLAN.md) — plan clôturé de `0.3.3`, pipeline Android SDL3 natif Gradle/Cargo multi-ABI.
|
||||
- [`plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md`](plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md) — plan clôturé de `0.3.4`, API de transport realtime et baseline WebSocket Tokio/tokio-tungstenite.
|
||||
- [`plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md`](plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md) — plan actif de `0.3.5`, POC WebTransport/QUIC, navigateur, fallback WebSocket et mesures comparatives.
|
||||
|
||||
## Architecture
|
||||
|
||||
@@ -81,6 +84,9 @@ Voir [`../RULES.md`](../RULES.md), notamment [`rules/RULES_DOCUMENTATION.md`](ru
|
||||
- [`development/008-WASM_TAURI_POC.md`](development/008-WASM_TAURI_POC.md) — baseline historique Reflex Tauri/WebAssembly et génération WASM associée.
|
||||
- [`development/009-SNAKE_WEB_WASM_BUILD.md`](development/009-SNAKE_WEB_WASM_BUILD.md) — build Cargo + `wasm-bindgen` natif de l'adapter Snake pour le navigateur direct.
|
||||
- [`development/010-SNAKE_WEB_FRONTEND.md`](development/010-SNAKE_WEB_FRONTEND.md) — host Web direct Snake sous Vite/TypeScript, shell Bootstrap 5, Canvas, lifecycle, assets, provenance et contrôles clavier/tactiles.
|
||||
- [`../crates/common/game-realtime-transport-lib/README.md`](../crates/common/game-realtime-transport-lib/README.md) — contrat realtime transport-neutral, payload binaire, split et erreurs stables.
|
||||
- [`../crates/common/game-realtime-websocket-lib/README.md`](../crates/common/game-realtime-websocket-lib/README.md) — backend WebSocket Tokio/tokio-tungstenite, frontières et configuration produit.
|
||||
- [`../crates/common/game-realtime-websocket-lib/USAGE.md`](../crates/common/game-realtime-websocket-lib/USAGE.md) — connexion client, listener serveur, limites, deadlines et smoke localhost.
|
||||
|
||||
## Historique validé
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!-- file: docs/plans/000-README.md -->
|
||||
<!-- version: 4 -->
|
||||
<!-- version: 7 -->
|
||||
|
||||
# Plans de versions games.sasedev
|
||||
|
||||
Ce répertoire contient les plans vivants des versions concrètes.
|
||||
|
||||
Un plan est créé ou révisé pendant `0-pre.1`. Il conserve le scope, les décisions utiles, les validations et surtout le découpage prévisionnel souple des tranches jusqu'à la release. Il peut évoluer lorsque les audits ou validations imposent de scinder, fusionner, reporter ou corriger une tranche.
|
||||
Un plan est créé ou révisé pendant `alpha.1`. Il conserve le scope, les décisions utiles, les validations et surtout le découpage prévisionnel souple des tranches jusqu'à la release. Il peut évoluer lorsque les audits ou validations imposent de scinder, fusionner, reporter ou corriger une tranche.
|
||||
|
||||
Le `ROADMAP.md` reste la trajectoire macroscopique du projet ; les deltas décrivent ce qui a réellement été livré. Le plan se situe entre les deux et sert au suivi de la version en cours.
|
||||
|
||||
@@ -14,3 +14,5 @@ Le `ROADMAP.md` reste la trajectoire macroscopique du projet ; les deltas décri
|
||||
- [`001-V0_3_0_WEB_SNAKE_POC_PLAN.md`](001-V0_3_0_WEB_SNAKE_POC_PLAN.md) — plan clôturé de `0.3.0`, baseline Snake et premier POC Web direct.
|
||||
- [`002-V0_3_1_TAURI_ANDROID_SNAKE_PLAN.md`](002-V0_3_1_TAURI_ANDROID_SNAKE_PLAN.md) — plan clôturé de `0.3.1`, second host Snake Tauri Android.
|
||||
- [`003-V0_3_3_ANDROID_NATIVE_MULTI_ABI_PLAN.md`](003-V0_3_3_ANDROID_NATIVE_MULTI_ABI_PLAN.md) — plan clôturé de `0.3.3`, pipeline Android SDL3 natif Gradle/Cargo multi-ABI.
|
||||
- [`004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md`](004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md) — plan clôturé de `0.3.4`, API de transport realtime et baseline WebSocket Tokio/tokio-tungstenite.
|
||||
- [`005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md`](005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md) — plan actif de `0.3.5`, POC WebTransport/QUIC, navigateur, fallback WebSocket et comparaison mesurée.
|
||||
|
||||
611
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
Normal file
611
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
Normal file
@@ -0,0 +1,611 @@
|
||||
<!-- file: docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md -->
|
||||
<!-- version: 9 -->
|
||||
|
||||
# Plan 0.3.4 — transport realtime et baseline WebSocket
|
||||
|
||||
## Statut
|
||||
|
||||
Plan clôturé avec la publication stable `0.3.4` le 2026-09-21. Il a été créé pendant `0.3.4-alpha.1` à partir de l'archive taggée `v0.3.3` et reste désormais une référence historique.
|
||||
|
||||
Les tranches `alpha.1`, `alpha.2`, `alpha.3.fix.1`, `alpha.4`, `alpha.5`, `beta.1` et `rc.1` ont été validées le 2026-09-21. `alpha.3` avait été rejetée avant compilation à cause d'un héritage Cargo invalide de `default-features`; son fix a ensuite validé le backend WebSocket, le round-trip localhost et le graphe sans TLS. `alpha.4` a fermé les limites, timeouts, cas négatifs et lifecycle, `alpha.5` a fourni le smoke runtime hors harness de test, puis `beta.1` a validé le workspace complet avec 53 tests et les frontières de dépendances. `rc.1` a repassé les gates de publication ciblées, 18 tests realtime, le smoke `PASS` et l'arbre inverse sans défaut. La stable est une promotion mécanique de cette RC gelée.
|
||||
|
||||
## Mission
|
||||
|
||||
`0.3.4` doit introduire une frontière de transport realtime async et une première implémentation WebSocket fondée sur Tokio + `tokio-tungstenite`, sans implémenter le protocole de session, la synchronisation gameplay ni la simulation authoritative.
|
||||
|
||||
La frontière reste :
|
||||
|
||||
```text
|
||||
transport
|
||||
↓
|
||||
wire codec
|
||||
↓
|
||||
session protocol
|
||||
↓
|
||||
synchronization
|
||||
↓
|
||||
authoritative simulation
|
||||
```
|
||||
|
||||
Le transport de `0.3.4` transporte des octets opaques. Il ne connaît ni joueur, ni room, ni tick, ni snapshot, ni delta métier.
|
||||
|
||||
## Baseline auditée
|
||||
|
||||
L'archive fournie comme téléchargement du tag `v0.3.3` est traitée comme autoritaire conformément à `CMD-GIT-003` et `CMD-GIT-004`.
|
||||
|
||||
L'audit local de l'archive confirme :
|
||||
|
||||
- archive ZIP intègre, sans chemin traversant ni symlink ;
|
||||
- `400` fichiers, `14` membres Cargo et `55` fichiers Rust ;
|
||||
- `workspace.package.version = 0.3.3` avant migration ;
|
||||
- audits Rust/workspace, Markdown et distribution propres sur l'archive ;
|
||||
- aucune arborescence générée `target/`, `node_modules/`, `gen/android` ou `build/` livrée ;
|
||||
- gameplay et moteurs sans dépendance réseau realtime ;
|
||||
- baseline Android `0.3.3` conservée et hors scope de cette version.
|
||||
|
||||
Le log utilisateur fourni à l'ouverture de session confirme également `cargo fmt`, `cargo check --workspace` et Clippy workspace strict sur son checkout `0.3.3`. Son audit Markdown annonce davantage de fichiers que l'archive taggée fournie ; la présente version reste néanmoins construite exclusivement depuis l'archive autoritaire reçue et n'invente aucun fichier absent de celle-ci.
|
||||
|
||||
## Migration de gouvernance
|
||||
|
||||
À partir de `0.3.4`, les seules formes de prerelease nouvelles sont :
|
||||
|
||||
```text
|
||||
X.Y.Z-alpha.N
|
||||
X.Y.Z-alpha.N.fix.M
|
||||
X.Y.Z-beta.N
|
||||
X.Y.Z-beta.N.fix.M
|
||||
X.Y.Z-rc.N
|
||||
X.Y.Z-rc.N.fix.M
|
||||
```
|
||||
|
||||
`alpha.1` remplace l'ancien rôle de cadrage `0-pre.1`.
|
||||
|
||||
Les anciens labels `0-pre`, `1-alpha`, `2-beta` et `3-rc` restent valides uniquement comme preuves historiques déjà livrées. Les audits distinguent donc la convention courante de la compatibilité historique et n'autorisent plus l'ancien schéma pour un nouveau workspace ou un nouvel historique `0.3.4+`.
|
||||
|
||||
## Dépendances vérifiées au 2026-09-21
|
||||
|
||||
Versions amont retenues et introduites par `alpha.3` :
|
||||
|
||||
```text
|
||||
Tokio 1.53.1
|
||||
futures-util 0.3.34
|
||||
tokio-tungstenite 0.30.0
|
||||
tungstenite 0.30.0, via réexport tokio-tungstenite
|
||||
```
|
||||
|
||||
Contraintes utiles :
|
||||
|
||||
- Tokio `1.53.1` annonce un MSRV `1.71` ;
|
||||
- `tokio-tungstenite 0.30.0` et `tungstenite 0.30.0` annoncent un MSRV `1.85` ;
|
||||
- `tokio-tungstenite` dépend déjà de Tokio `1.x` et de Tungstenite `0.30.0` ;
|
||||
- ses features par défaut couvrent `connect` et `handshake`, sans TLS ;
|
||||
- `native-tls` et les variantes `rustls-*` sont optionnelles ;
|
||||
- Tungstenite expose déjà des limites de message/frame et de write buffer configurables.
|
||||
|
||||
`alpha.3.fix.1` centralise désormais aussi `default-features = false` sous `[workspace.dependencies]`, car Cargo interdit à une dépendance membre héritée de remplacer cette option. `game-realtime-websocket-lib` ajoute seulement les features locales `sink + std` pour `futures-util` et `connect + handshake` pour `tokio-tungstenite`; aucune feature TLS n'est activée. La gate utilisateur du fix confirme Rust `1.94.1`, Tokio `1.53.1`, tokio-tungstenite/Tungstenite `0.30.0` et un graphe normal sans pile TLS. `alpha.4` ajoute uniquement la feature Tokio `time` au backend afin d'appliquer les deadlines produit.
|
||||
|
||||
## Ownership physique retenu
|
||||
|
||||
### `game-realtime-transport-lib`
|
||||
|
||||
Créer sous :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-transport-lib
|
||||
```
|
||||
|
||||
Responsabilités :
|
||||
|
||||
- contrat transport-neutral ;
|
||||
- payload binaire opaque ;
|
||||
- distinction send/receive/close ;
|
||||
- fermeture distante explicite ;
|
||||
- catégories d'erreur transport-neutral ;
|
||||
- contrat de split permettant lecture et écriture concurrentes ;
|
||||
- aucune dépendance à Tokio, Tungstenite, HTTP, TLS, SDL, Tauri, WASM, moteur ou gameplay.
|
||||
|
||||
Cette crate est une capability technique commune indépendante d'une génération de moteur. Elle n'est pas placée dans `engine-v1-*`.
|
||||
|
||||
### `game-realtime-websocket-lib`
|
||||
|
||||
Créer sous :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-websocket-lib
|
||||
```
|
||||
|
||||
Responsabilités :
|
||||
|
||||
- implémentation WebSocket du contrat transport ;
|
||||
- `tokio-tungstenite` et Tokio réseau/temps ;
|
||||
- connexion client WebSocket ;
|
||||
- bind/accept serveur local ;
|
||||
- mapping des frames WebSocket vers le contrat binaire ;
|
||||
- close handshake, erreurs, timeouts, limites et tracing spécifiques au backend ;
|
||||
- tests loopback localhost.
|
||||
|
||||
Le backend dépend de `game-realtime-transport-lib`. L'inverse est interdit.
|
||||
|
||||
### Dépendances interdites
|
||||
|
||||
Aucune crate sous :
|
||||
|
||||
```text
|
||||
crates/games/
|
||||
crates/engines/
|
||||
```
|
||||
|
||||
doit dépendre de `tokio-tungstenite` ou du backend WebSocket pendant `0.3.4`.
|
||||
|
||||
Aucun contrat gameplay n'est déplacé vers les crates transport pour fabriquer artificiellement un consommateur.
|
||||
|
||||
## Contrat transport minimal
|
||||
|
||||
Le contrat public doit rester suffisamment petit pour être implémentable par WebSocket puis confronté au POC WebTransport de `0.3.5`.
|
||||
|
||||
### Payload
|
||||
|
||||
Le message transport est un buffer binaire possédé, conceptuellement `Vec<u8>`.
|
||||
|
||||
Décisions :
|
||||
|
||||
- aucune variante texte dans l'API transport-neutral ;
|
||||
- aucun JSON, Serde, Protobuf ou codec gameplay dans `0.3.4` ;
|
||||
- Ping/Pong WebSocket reste un détail du backend ;
|
||||
- une frame Text reçue par le backend n'est pas promue en message métier et doit produire un comportement explicite, testé et tracé ;
|
||||
- le futur wire codec consommera/produira ces octets au-dessus du transport.
|
||||
|
||||
### Connexion et split
|
||||
|
||||
Le contrat doit permettre conceptuellement :
|
||||
|
||||
```text
|
||||
connection.split() -> sender + receiver
|
||||
sender.send(bytes) -> async Result
|
||||
sender.close() -> async Result
|
||||
receiver.receive() -> async Result<Message | Closed>
|
||||
```
|
||||
|
||||
`alpha.2` retient une API statiquement dispatchée fondée sur des associated types : `RealtimeConnection` produit un `Sender` et un `Receiver`, puis les opérations async exposent des futures associées GAT (`SendFuture`, `CloseFuture`, `ReceiveFuture`). Le contrat commun n'utilise ni `async-trait`, ni `Box<dyn Future>`, ni runtime concret.
|
||||
|
||||
Aucune borne `Send` n'est imposée aux futures par le contrat transport-neutral : un backend natif peut naturellement fournir des futures `Send`, tandis qu'un futur backend navigateur/WASM ne doit pas être rendu impossible par une contrainte de threading qui ne relève pas du transport abstrait.
|
||||
|
||||
Le contrat doit supporter lecture et écriture concurrentes après split. Il n'expose pas de runtime Tokio et ne crée aucun executor.
|
||||
|
||||
### Fermeture
|
||||
|
||||
La fermeture distante n'est pas une erreur I/O générique. `receive()` doit pouvoir distinguer au minimum :
|
||||
|
||||
- message binaire reçu ;
|
||||
- fermeture distante propre ;
|
||||
- erreur de transport.
|
||||
|
||||
La fermeture locale est explicite via `close()`.
|
||||
|
||||
Une cancellation de task/future n'est pas assimilée à une fermeture WebSocket propre. Abandonner le propriétaire de la connexion doit néanmoins libérer les ressources sans tâche backend détachée.
|
||||
|
||||
### Erreurs
|
||||
|
||||
Le contrat transport-neutral doit représenter au minimum les catégories suivantes sans exposer les types d'erreur de Tungstenite :
|
||||
|
||||
```text
|
||||
invalid endpoint/configuration
|
||||
connect/bind/accept failure
|
||||
timeout
|
||||
message too large
|
||||
backpressure/write buffer full
|
||||
connection closed
|
||||
I/O failure
|
||||
protocol/backend failure
|
||||
cancelled/operation aborted lorsque cette distinction est réellement observable
|
||||
```
|
||||
|
||||
Les détails backend peuvent être conservés pour `Display`/source/tracing sans faire remonter `tungstenite::Error` dans l'API commune.
|
||||
|
||||
## Ownership Tokio/runtime
|
||||
|
||||
Le runtime est possédé par l'application, le service ou le test consommateur.
|
||||
|
||||
`game-realtime-websocket-lib` :
|
||||
|
||||
- utilise les primitives Tokio nécessaires ;
|
||||
- ne crée pas de runtime global ;
|
||||
- ne lance pas de thread runtime privé ;
|
||||
- évite les tâches détachées pour la connexion de base ;
|
||||
- ne propage aucune dépendance Tokio dans le gameplay.
|
||||
|
||||
Les tests peuvent utiliser `#[tokio::test]` comme harness de validation, sans transformer la macro en contrat public.
|
||||
|
||||
## Client et serveur
|
||||
|
||||
La séparation retenue est asymétrique et minimale :
|
||||
|
||||
- le contrat commun modélise une connexion déjà établie et ses deux moitiés ;
|
||||
- le backend WebSocket possède les constructeurs concrets client/server ;
|
||||
- aucun trait générique `Connector`, `Listener`, `Server`, `Provider` ou `Runtime` n'est créé dans `alpha.2` sans besoin démontré ;
|
||||
- le client peut exposer une connexion à partir d'un endpoint WebSocket ;
|
||||
- le serveur peut binder une adresse socket puis accepter une connexion ;
|
||||
- le futur backend WebTransport pourra proposer ses propres étapes d'établissement tout en produisant une connexion compatible lorsque cela reste pertinent.
|
||||
|
||||
Cette décision évite de forcer aujourd'hui WebSocket et QUIC à partager artificiellement des opérations d'établissement différentes.
|
||||
|
||||
## TLS
|
||||
|
||||
La baseline `0.3.4` est d'abord un POC transport local reproductible en `ws://`.
|
||||
|
||||
Aucune feature TLS de `tokio-tungstenite` n'est activée par défaut dans la première implémentation. `wss://` pourra être ajouté si un consommateur direct ou la stratégie de terminaison TLS le justifie réellement.
|
||||
|
||||
Cette décision :
|
||||
|
||||
- réduit les dépendances initiales ;
|
||||
- évite de choisir prématurément `native-tls` contre `rustls` ;
|
||||
- n'interdit pas une terminaison TLS future en reverse proxy ;
|
||||
- ne présente pas le WebSocket local de test comme configuration de production Internet.
|
||||
|
||||
## Timeouts et backpressure
|
||||
|
||||
### Principes
|
||||
|
||||
- aucune file interne non bornée ;
|
||||
- `send()` attend la capacité du sink au lieu d'accumuler des messages arbitrairement ;
|
||||
- les limites Tungstenite sont configurées explicitement et ne restent pas implicitement aux maxima amont ;
|
||||
- l'absence de message reçu n'est pas un timeout de transport automatique : heartbeat/idle/session timeout appartient à la couche supérieure ;
|
||||
- connect, send et fermeture propre disposent de bornes configurables afin qu'une opération locale ne reste pas bloquée indéfiniment.
|
||||
|
||||
### Valeurs de baseline proposées
|
||||
|
||||
Valeurs initiales, configurables et non assimilées à un protocole gameplay final :
|
||||
|
||||
```text
|
||||
max message size 1 MiB
|
||||
max frame size 1 MiB
|
||||
write buffer target 64 KiB
|
||||
max write buffer 2 MiB
|
||||
connect timeout 10 s
|
||||
send timeout 5 s
|
||||
close timeout 2 s
|
||||
receive idle timeout aucun au niveau transport
|
||||
```
|
||||
|
||||
Le choix `2 MiB` pour le write buffer maximum laisse au moins la place au buffer cible plus un message maximal. Les tests négatifs doivent vérifier le comportement limite plutôt que supposer que ces constantes resteront éternellement inchangées.
|
||||
|
||||
## Tracing
|
||||
|
||||
Domaines proposés :
|
||||
|
||||
```text
|
||||
games::realtime::transport
|
||||
games::realtime::websocket
|
||||
```
|
||||
|
||||
Le tracing doit couvrir au minimum connexion, accept, fermeture, timeout, rejet de message hors limite et erreurs backend.
|
||||
|
||||
Ne pas logguer par défaut le contenu brut des payloads de transport.
|
||||
|
||||
Les futurs domaines session/sync/simulation utilisent des targets distinctes.
|
||||
|
||||
## Décisions matérialisées dans `alpha.3`
|
||||
|
||||
Le backend concret reste sous `crates/common/game-realtime-websocket-lib` et dépend uniquement du contrat commun plus des briques réseau/tracing nécessaires.
|
||||
|
||||
L'API publique expose :
|
||||
|
||||
```text
|
||||
connect(endpoint)
|
||||
WebSocketListener::bind(address)
|
||||
WebSocketListener::accept()
|
||||
WebSocketConnection
|
||||
WebSocketSender
|
||||
WebSocketReceiver
|
||||
```
|
||||
|
||||
Les types `WebSocketStream`, `SplitSink`, `SplitStream`, `MaybeTlsStream` et `tungstenite::Error` restent privés. Client et serveur produisent le même `WebSocketConnection` public grâce à une représentation interne à deux variantes ; le contrat commun reste donc la seule frontière partagée par les consommateurs.
|
||||
|
||||
`connect()` accepte volontairement uniquement `ws://` dans cette baseline. Le TLS direct reste différé. Les frames binaires deviennent `TransportMessage`; Close devient `TransportReceive::Closed`; Ping/Pong sont traités comme contrôle backend ; Text et raw Frame sont explicitement rejetés comme erreurs de protocole. Les tests négatifs exhaustifs correspondants restent planifiés pour `alpha.4`.
|
||||
|
||||
Le backend ne crée aucun runtime, thread ni task détachée. Le harness d'intégration utilise un runtime Tokio de test courant, un bind `127.0.0.1:0` et une borne temporelle uniquement pour empêcher un test loopback défectueux de rester suspendu.
|
||||
|
||||
Aucun `README.md`/`USAGE.md` local n'est ajouté pendant `alpha.3` : la crate reste petite, son API publique est documentée par rustdoc et le présent plan porte encore les décisions durables. Ce choix sera réévalué pendant la consolidation finale conformément à `DOC-CRATE-*`.
|
||||
|
||||
## Décisions matérialisées dans `alpha.4`
|
||||
|
||||
`game-realtime-websocket-lib` expose désormais `WebSocketConfig` et les variantes configurables `connect_with_config()` et `WebSocketListener::bind_with_config()`. Les wrappers historiques `connect()` et `bind()` conservent des valeurs de baseline explicites :
|
||||
|
||||
```text
|
||||
max message size 1 MiB
|
||||
max frame size 1 MiB
|
||||
write buffer target 64 KiB
|
||||
max write buffer 2 MiB
|
||||
connect/handshake 10 s
|
||||
send 5 s
|
||||
close 2 s
|
||||
receive idle timeout aucun
|
||||
```
|
||||
|
||||
La configuration refuse une limite nulle, une frame plus grande que le message, un write buffer maximum incapable de contenir le target plus un message maximal et une deadline nulle. Les limites Tungstenite sont transmises aux handshakes client et serveur ; les tailles message/frame sortantes sont également vérifiées avant l'appel au sink afin que le rejet soit déterministe.
|
||||
|
||||
`connect_timeout` borne la connexion client et la phase de handshake serveur après accept TCP. Le listener reste volontairement capable d'attendre indéfiniment un nouveau peer : ce temps d'attente appartient au service consommateur, pas à une connexion déjà en établissement. `send_timeout` et `close_timeout` bornent leurs opérations respectives. Après expiration d'un `send`, la moitié émission refuse un nouvel envoi avec `Aborted`, car l'appel interrompu peut avoir progressé partiellement et ne doit pas être rejoué implicitement.
|
||||
|
||||
Aucun idle timeout n'est ajouté à `receive()`. Heartbeat, inactivité joueur et politique de session restent au-dessus du transport.
|
||||
|
||||
Les tests négatifs `alpha.4` couvrent :
|
||||
|
||||
- rejet sortant d'un payload hors limite avant écriture ;
|
||||
- rejet entrant d'un message/frame hors limite par Tungstenite ;
|
||||
- rejet d'une frame Text par le contrat binaire ;
|
||||
- drop TCP/WebSocket sans close handshake, attendu comme erreur de protocole ;
|
||||
- timeout de handshake serveur avec un peer TCP silencieux ;
|
||||
- mapping déterministe de `WriteBufferFull` vers `Backpressure` et de `Capacity` vers `MessageTooLarge`.
|
||||
|
||||
Un test réseau artificiel de saturation `WriteBufferFull` n'est pas retenu : Tungstenite documente que son write buffer ne dépasse le target que lorsque les écritures sous-jacentes échouent, ce qui rendrait une saturation loopback normale non représentative et potentiellement flaky. La borne finie est néanmoins configurée, le mapping backend est testé unitairement et le timeout d'émission borne l'attente du sink.
|
||||
|
||||
## Tests retenus
|
||||
|
||||
### Contrat commun
|
||||
|
||||
Tests unitaires ciblés :
|
||||
|
||||
- types d'erreur et affichage ;
|
||||
- invariants de configuration réellement portés par la crate commune ;
|
||||
- aucune dépendance au backend concret.
|
||||
|
||||
### Backend WebSocket
|
||||
|
||||
Tests d'intégration localhost déterministes avec `127.0.0.1:0` :
|
||||
|
||||
1. bind serveur sur port éphémère ;
|
||||
2. connexion client ;
|
||||
3. client → serveur : payload binaire ;
|
||||
4. serveur → client : réponse binaire ;
|
||||
5. fermeture propre initiée d'un côté et observée de l'autre ;
|
||||
6. dépassement de taille rejeté ;
|
||||
7. comportement explicite sur frame Text ;
|
||||
8. connexion interrompue/peer drop ;
|
||||
9. timeout d'opération retenu ;
|
||||
10. backpressure/write-buffer error provoquée par un test borné si elle est reproductible sans test flaky.
|
||||
|
||||
Les tests ne dépendent ni d'Internet, ni d'un serveur externe, ni d'un port fixe.
|
||||
|
||||
Un petit launcher de smoke n'était pas prévu par défaut tant que les tests publics semblaient suffire. La revue après validation de `alpha.4` a distingué correctement test automatisé et smoke runtime : `alpha.5` ajoute donc `game-realtime-websocket-smoke` sous `crates/apps/`. Ce binaire reste un harness de validation, pas un produit ni un protocole applicatif.
|
||||
|
||||
## Gates par jalon
|
||||
|
||||
### `alpha.1`
|
||||
|
||||
Changements : gouvernance, audit Python, version workspace, plan et delta.
|
||||
|
||||
Gate utilisateur :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
```
|
||||
|
||||
Aucun test runtime réseau n'est requis avant l'existence du code réseau.
|
||||
|
||||
### `alpha.2`
|
||||
|
||||
Ajouter `game-realtime-transport-lib`, ses tests ciblés et sa documentation publique.
|
||||
|
||||
Gate minimale supplémentaire :
|
||||
|
||||
```bash
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
```
|
||||
|
||||
### `alpha.3`
|
||||
|
||||
Ajouter `game-realtime-websocket-lib`, les dépendances backend et le loopback principal.
|
||||
|
||||
Gates ciblées :
|
||||
|
||||
```bash
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-websocket-lib --all-targets --all-features
|
||||
cargo tree -p game-realtime-websocket-lib --edges normal
|
||||
```
|
||||
|
||||
### `alpha.4`
|
||||
|
||||
Fermer robustesse, limites, timeouts, close/cancellation et cas négatifs. Réexécuter les tests des deux crates. Un demo n'est ajouté que si une preuve manque réellement.
|
||||
|
||||
Gates ciblées :
|
||||
|
||||
```bash
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-websocket-lib --all-targets --all-features
|
||||
cargo tree -p game-realtime-websocket-lib --edges normal
|
||||
```
|
||||
|
||||
Le test backend doit maintenant couvrir le loopback positif, les invariants de configuration, les mappings de capacité/backpressure et les cinq scénarios négatifs déterministes de `robustness.rs`.
|
||||
|
||||
### `alpha.5`
|
||||
|
||||
Ajouter le smoke runtime public avant promotion de maturité.
|
||||
|
||||
Gates ciblées :
|
||||
|
||||
```bash
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-websocket-lib --all-targets --all-features
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
cargo tree -p game-realtime-websocket-smoke --edges normal
|
||||
```
|
||||
|
||||
Le smoke doit binder `127.0.0.1:0`, connecter un client via l'API publique, échanger un payload binaire dans chaque sens, effectuer un close propre, afficher `game-realtime-websocket-smoke: PASS` et sortir avec le code zéro. Il ne dépend ni d'Internet, ni d'un port fixe, ni d'un harness `#[test]`.
|
||||
|
||||
### Beta
|
||||
|
||||
La beta est le jalon large retenu pour :
|
||||
|
||||
```bash
|
||||
cargo test --workspace --all-targets --all-features
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
cargo tree -p game-realtime-websocket-lib --edges normal
|
||||
cargo tree -i game-realtime-websocket-lib --workspace --edges normal
|
||||
```
|
||||
|
||||
Elle revalide également audits, format/check et Clippy. Le test workspace couvre les suites transport/WebSocket et leurs loopbacks ; le smoke reste exécuté séparément car un binaire runtime n'est pas remplacé par le harness `#[test]`. L'arbre inverse doit confirmer qu'aucune crate sous `crates/games/` ou `crates/engines/` ne dépend du backend WebSocket.
|
||||
|
||||
`0.3.4-beta.1` a satisfait cette gate le 2026-09-21 : 53 tests workspace réussis, smoke runtime `PASS`, graphe backend sans TLS et arbre inverse limité à `game-realtime-websocket-smoke`. Aucun fix beta n'est requis.
|
||||
|
||||
### RC
|
||||
|
||||
La RC gèle le comportement et rejoue les gates de publication utiles. Comme aucun Rust, dépendance tierce ou contrat transport n'a changé depuis la beta, le test workspace complet n'est pas répété par cérémonie. La gate RC retenue est :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
cargo test -p game-realtime-websocket-lib --all-targets --all-features
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
cargo tree -i game-realtime-websocket-lib --workspace --edges normal
|
||||
```
|
||||
|
||||
Le smoke doit encore afficher `game-realtime-websocket-smoke: PASS`. Tout défaut de publication fermé produit `rc.1.fix.N`; toute réouverture fonctionnelle abandonne la RC conformément à `VER-RC-004`.
|
||||
|
||||
## Forecast révisé
|
||||
|
||||
### `0.3.4-alpha.1` — gouvernance, audit et contrat
|
||||
|
||||
- migrer les règles prospectives ;
|
||||
- adapter l'audit de version sans casser l'historique ;
|
||||
- synchroniser la version workspace ;
|
||||
- vérifier dépendances et contraintes amont ;
|
||||
- décider ownership, contrat, erreurs, lifecycle, limites et tests ;
|
||||
- créer le présent plan.
|
||||
|
||||
Aucune dépendance réseau n'est ajoutée.
|
||||
|
||||
### `0.3.4-alpha.2` — API transport-neutral
|
||||
|
||||
- créer `game-realtime-transport-lib` ;
|
||||
- implémenter message, receive/close, erreurs et split ;
|
||||
- conserver l'API sans Tokio/Tungstenite ;
|
||||
- retenir des futures associées GAT afin de préserver le dispatch statique sans box ni contrainte `Send` imposée au contrat ;
|
||||
- tests unitaires ciblés ;
|
||||
- README/USAGE uniquement si une valeur durable est démontrée par `DOC-CRATE-*`.
|
||||
|
||||
### `0.3.4-alpha.3` — backend WebSocket et loopback
|
||||
|
||||
- créer `game-realtime-websocket-lib` ;
|
||||
- ajouter Tokio, `tokio-tungstenite` et `futures-util` avec features minimales ;
|
||||
- client connect + serveur bind/accept ;
|
||||
- mapping binaire, tracing, close ;
|
||||
- round-trip localhost déterministe.
|
||||
|
||||
### `0.3.4-alpha.4` — robustesse et consolidation technique
|
||||
|
||||
- `WebSocketConfig` avec limites et deadlines explicites ;
|
||||
- application symétrique de la configuration aux handshakes client/serveur ;
|
||||
- timeout connect/handshake, send et close, sans idle timeout transport ;
|
||||
- fermeture distante propre conservée et abrupt drop distingué ;
|
||||
- cas Text non supporté ;
|
||||
- message/frame hors limite ;
|
||||
- write buffer maximum borné et mapping `Backpressure` testé sans fabriquer un test réseau flaky ;
|
||||
- lifecycle sans runtime/task backend privé ;
|
||||
- documentation API/backend et audit du graphe.
|
||||
|
||||
La gate `alpha.4` est propre, mais elle ne constitue pas à elle seule un smoke runtime : tous ses scénarios restent exécutés sous le harness de test Cargo.
|
||||
|
||||
### `0.3.4-alpha.5` — smoke runtime end-to-end
|
||||
|
||||
- créer `game-realtime-websocket-smoke` comme launcher minimal sous `crates/apps/` ;
|
||||
- utiliser uniquement les API publiques `game-realtime-websocket-lib` et `game-realtime-transport-lib` ;
|
||||
- binder un listener loopback sur port éphémère et connecter un client réel ;
|
||||
- vérifier client → serveur puis serveur → client ;
|
||||
- initier et observer un close propre ;
|
||||
- borner le smoke global et retourner un code de sortie non nul au moindre défaut ;
|
||||
- ne créer ni protocole session/gameplay, ni serveur externe, ni port fixe.
|
||||
|
||||
`DOC-CRATE-*` est réévalué pour ce launcher : le workflow se résume à une commande Cargo unique et le plan central décrit entièrement sa responsabilité, donc aucun `README.md`/`USAGE.md` local n'est ajouté.
|
||||
|
||||
### `0.3.4-beta.1` — validation large
|
||||
|
||||
- aucun nouveau scope ;
|
||||
- test workspace complet planifié ;
|
||||
- tests loopback/negatifs ;
|
||||
- dépendances et frontières vérifiées ;
|
||||
- confirmation qu'aucun gameplay/engine ne dépend du backend WebSocket.
|
||||
|
||||
Un défaut fermé produit `beta.1.fix.N`. Une capacité manquante réouvre une alpha.
|
||||
|
||||
### `0.3.4-rc.1` — candidate gelée
|
||||
|
||||
- scope fonctionnel gelé après validation complète de `beta.1` ;
|
||||
- entrée RC dans `CHANGELOG.md` ;
|
||||
- `ROADMAP.md` relue mais conservée non cochée jusqu'à la stable ;
|
||||
- historique `beta.1` ;
|
||||
- README durable de `game-realtime-transport-lib` ;
|
||||
- README + USAGE durables de `game-realtime-websocket-lib` ;
|
||||
- prompt `0.3.5` préparant le POC WebTransport/QUIC sur la même frontière, sans prétendre qu'un backend ou une stack QUIC est déjà validé ;
|
||||
- aucune abstraction nouvelle ni modification du comportement réseau sans défaut de release.
|
||||
|
||||
### `0.3.4` — stable
|
||||
|
||||
Promotion mécanique réalisée : version `0.3.4`, historique RC, changelog stable, roadmap clôturée, plan clôturé, delta `rel.001` et prompt `0.3.5` ajusté sur la stable effectivement publiée.
|
||||
|
||||
## Consolidation documentaire RC
|
||||
|
||||
La revue `DOC-CRATE-*` conclut :
|
||||
|
||||
- `game-realtime-transport-lib` est une capability durable et réutilisable : un `README.md` local documente responsabilité, frontière, sémantique et sens des dépendances ; son API publique reste suffisamment petite pour ne pas justifier un `USAGE.md` séparé ;
|
||||
- `game-realtime-websocket-lib` est un backend durable avec configuration, client, listener et lifecycle opératoire : il reçoit un `README.md` et un `USAGE.md` ;
|
||||
- `game-realtime-websocket-smoke` reste un launcher de validation minimal : le plan et la commande Cargo couvrent entièrement son usage, donc aucun document local supplémentaire n'est créé.
|
||||
|
||||
Cette documentation est durable et ne contient pas de journal de prerelease. Les détails de validation restent dans `deltas/`, `history/` et `CHANGELOG.md`.
|
||||
|
||||
## Sizing
|
||||
|
||||
Le scope reste compatible avec une seule version/session : deux petites crates techniques, un seul backend concret et des tests locaux. Le POC WebTransport/QUIC, la session multijoueur et la simulation authoritative sont explicitement exclus.
|
||||
|
||||
Un split vers une autre version est requis si l'une des conditions suivantes apparaît :
|
||||
|
||||
- besoin d'un vrai wire codec partagé pour prouver le transport ;
|
||||
- nécessité de concevoir le protocole session/joueur/room ;
|
||||
- TLS direct nécessitant une politique de certificats/PKI produit ;
|
||||
- abstraction commune WebSocket/QUIC exigeant déjà des concepts spécifiques à QUIC ;
|
||||
- demo/app devenant un produit autonome plutôt qu'un harness de preuve.
|
||||
|
||||
## Hors scope confirmé
|
||||
|
||||
- Uroburas Mode 3 ;
|
||||
- matchmaking ;
|
||||
- auth complète ;
|
||||
- snapshots/deltas métier ;
|
||||
- prediction/reconciliation ;
|
||||
- rollback ;
|
||||
- persistence gameplay ;
|
||||
- Redis/NATS/Kafka ;
|
||||
- scaling/sharding/regions ;
|
||||
- WebTransport/QUIC productif ;
|
||||
- Actix Web dans le data plane realtime ;
|
||||
- modification du pipeline Android `0.3.3` sans régression causée par `0.3.4`.
|
||||
|
||||
## Critères d'entrée en beta
|
||||
|
||||
`0.3.4` peut entrer en beta lorsque :
|
||||
|
||||
- l'API commune ne dépend ni de Tokio ni de WebSocket ;
|
||||
- le backend WebSocket implémente le contrat public sans fuite de types Tungstenite ;
|
||||
- client et serveur round-tripent des payloads binaires sur localhost ;
|
||||
- close local/distant est observable ;
|
||||
- limites et timeouts retenus sont testés ;
|
||||
- aucun queueing non borné ni runtime privé n'est introduit ;
|
||||
- les targets tracing transport/WebSocket sont distinctes des futurs domaines session/sync/simulation ;
|
||||
- aucune crate gameplay ou engine ne dépend de `tokio-tungstenite` ;
|
||||
- les audits et tests ciblés sont propres ;
|
||||
- le smoke `cargo run -p game-realtime-websocket-smoke` passe réellement côté utilisateur hors harness de test ;
|
||||
- la documentation décrit ce qui est réellement implémenté et ce qui reste reporté.
|
||||
633
docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md
Normal file
633
docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md
Normal file
@@ -0,0 +1,633 @@
|
||||
<!-- file: docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md -->
|
||||
<!-- version: 6 -->
|
||||
|
||||
# Plan 0.3.5 — POC WebTransport/QUIC et fallback WebSocket
|
||||
|
||||
## Statut
|
||||
|
||||
Plan actif créé pendant `0.3.5-alpha.1` à partir de l'archive taggée `v0.3.4`, puis réconcilié pour l'implémentation native de `0.3.5-alpha.2`, son correctif de validation `0.3.5-alpha.2.fix.1`, le chemin fiable validé de `0.3.5-alpha.3`, la robustesse candidate de `0.3.5-alpha.4` et son correctif de gate `0.3.5-alpha.4.fix.1`.
|
||||
|
||||
Le cadrage détaillé et la comparaison des stacks actuelles sont conservés dans `docs/studies/026-V0_3_5_WEBTRANSPORT_QUIC_STACK_AUDIT.md`. Le présent document porte les décisions opérationnelles, le scope, les gates et le forecast vivant de la version.
|
||||
|
||||
## Mission
|
||||
|
||||
`0.3.5` doit déterminer par des preuves reproductibles si WebTransport/QUIC mérite de devenir un second backend realtime aux côtés de WebSocket.
|
||||
|
||||
La version doit :
|
||||
|
||||
- conserver `game-realtime-transport-lib` comme frontière transport-neutral tant qu'aucun besoin commun ne justifie son évolution ;
|
||||
- implémenter un chemin WebTransport fiable compatible avec `TransportMessage` ;
|
||||
- prouver client/server natifs en loopback ;
|
||||
- prouver un chemin navigateur/WASM réel si la stack retenue reste viable ;
|
||||
- prouver le traitement des certificats de développement sans désactivation permanente de TLS ;
|
||||
- exercer le fallback WebSocket au niveau composition ;
|
||||
- comparer WebSocket et WebTransport avec des mesures locales bornées ;
|
||||
- challenger séparément les datagrams sans les forcer dans le contrat fiable ;
|
||||
- conclure `retained`, `deferred` ou `rejected` pour la trajectoire produit.
|
||||
|
||||
La frontière reste :
|
||||
|
||||
```text
|
||||
transport
|
||||
↓
|
||||
wire codec
|
||||
↓
|
||||
session protocol
|
||||
↓
|
||||
synchronization
|
||||
↓
|
||||
authoritative simulation
|
||||
```
|
||||
|
||||
Aucune couche supérieure n'est introduite dans `0.3.5`.
|
||||
|
||||
## Décisions acquises en alpha.1
|
||||
|
||||
### Stack POC primaire
|
||||
|
||||
Famille retenue :
|
||||
|
||||
```text
|
||||
web-transport 0.12.x
|
||||
native -> web-transport-quinn 0.12.x
|
||||
wasm32 -> web-transport-wasm 0.6.x
|
||||
```
|
||||
|
||||
La version exacte résolue par Cargo sera enregistrée dans le delta qui introduit les dépendances. Les contraintes restent centralisées sous `[workspace.dependencies]` conformément à `RUST-DEP-001` et les features sont choisies localement par la crate consommatrice.
|
||||
|
||||
`wtransport 0.7.x` reste le candidat de repli prioritaire si une exigence concrète bloque la famille primaire. Quinn/H3 brut n'est pas le premier choix.
|
||||
|
||||
### Fermeture de dépendances en alpha.2
|
||||
|
||||
La première tranche native utilise directement :
|
||||
|
||||
```text
|
||||
web-transport-quinn 0.12.1, default-features = false, feature ring
|
||||
rcgen 0.14.10, default-features = false, feature ring
|
||||
url 2.5.8
|
||||
```
|
||||
|
||||
La façade `web-transport` n'est pas ajoutée avant le chemin WASM : `alpha.2` ne possède qu'un backend natif et n'a pas besoin d'une abstraction multiplateforme encore inutilisée. `ring` est choisi explicitement et seul pour éviter le backend crypto par défaut `aws-lc-rs` de `web-transport-quinn` et garder le graphe POC plus petit et déterministe.
|
||||
|
||||
L'identité locale générée est ECDSA P-256/SHA-256, contient les SAN `localhost`, `127.0.0.1` et `::1`, vit sept jours avec une petite marge de clock skew et reste uniquement en mémoire. Une identité X.509 DER + PKCS#8 DER peut aussi être injectée. Le client accepte uniquement le hash SHA-256 explicitement configuré ; aucune API de désactivation de validation TLS n'est exposée.
|
||||
|
||||
`alpha.2` retourne une session WebTransport établie mais n'ouvre encore aucun stream applicatif et n'implémente pas `RealtimeConnection`. Cette séparation ferme la preuve QUIC/TLS avant le framing de `alpha.3`.
|
||||
|
||||
La gate de `alpha.2` a confirmé compilation, Clippy, configuration TLS/pinning et rejet d’un mauvais pin, mais le test positif comparait strictement `127.0.0.1:port` à sa représentation IPv4-mapped IPv6 `[::ffff:127.0.0.1]:port` remontée par Quinn. `alpha.2.fix.1` normalise uniquement cette représentation dans le test d’intégration ; aucun contrat, comportement transport ou scope de `alpha.3` n’est modifié.
|
||||
|
||||
### Fermeture du chemin fiable en alpha.3
|
||||
|
||||
`alpha.3` conserve `game-realtime-transport-lib` inchangé et adapte le backend concret à ses traits. Une `WebTransportSession` devient une `WebTransportConnection` après sélection d'un unique stream bidirectionnel primaire : le client l'ouvre, le serveur l'accepte. Le `split()` conserve une copie de la session dans chaque moitié afin que la session QUIC/WebTransport ne soit pas fermée au moment où l'objet connexion est consommé.
|
||||
|
||||
Le framing privé est exactement :
|
||||
|
||||
```text
|
||||
u32 big-endian payload length
|
||||
payload bytes
|
||||
```
|
||||
|
||||
La borne POC est fixée à 1 MiB par message dans cette tranche. Elle est vérifiée avant écriture et, surtout, avant allocation côté réception. Cette limite reste interne : `alpha.4` décide sa configuration produit avec deadlines, backpressure, reset/abort/cancellation et mapping d'erreurs détaillé.
|
||||
|
||||
Le FIN du stream primaire constitue la fermeture logique de base de `alpha.3` et produit `TransportReceive::Closed` après consommation des messages déjà écrits. La fermeture de session complète et les scénarios de lifecycle avancés restent explicitement réservés à `alpha.4`.
|
||||
|
||||
`web-transport-quinn` écrit l'en-tête WebTransport du stream durant `open_bi()` avant de rendre le stream au code appelant. L'accept serveur peut donc terminer avant la première frame applicative ; le framing games.sasedev commence directement au premier octet applicatif et n'ajoute aucun préambule de visibilité.
|
||||
|
||||
La gate utilisateur de `alpha.3` a ensuite confirmé fmt, audits, check workspace, Clippy strict, les sept tests du contrat commun, les sept tests unitaires/établissement WebTransport déjà présents et le round-trip primaire dédié. Le graphe inverse confirme aussi que `game-realtime-webtransport-lib` reste un backend feuille et ne remonte pas dans engine/gameplay.
|
||||
|
||||
### Fermeture robustesse et lifecycle en alpha.4
|
||||
|
||||
`alpha.4` remplace la borne interne figée par `WebTransportConfig`, partagé par les configs client/server. Les valeurs par défaut restent volontairement conservatrices pour le POC : 1 MiB par message, 10 s pour la connexion/fin de réponse CONNECT, 5 s pour l'ouverture ou l'accept du stream primaire et 5 s pour un envoi complet. Les valeurs nulles ou une taille incompatible avec le champ de longueur `u32` sont rejetées avant démarrage.
|
||||
|
||||
La notion de deadline est volontairement opérationnelle et non un timeout d'inactivité global :
|
||||
|
||||
- le client borne l'établissement de session ;
|
||||
- côté serveur, l'attente du prochain pair reste non bornée comme un listener normal, puis la réponse WebTransport après matérialisation de la requête CONNECT est bornée ;
|
||||
- ouverture/accept du stream primaire sont bornés ;
|
||||
- un envoi header + payload est borné, de sorte qu'un blocage durable sous flow-control/backpressure devient un `TransportErrorKind::Timeout` visible ;
|
||||
- `receive()` n'a pas de timeout d'idle implicite : l'absence de message n'est pas une panne de transport et l'appelant peut annuler sa future sans perdre l'état du framing.
|
||||
|
||||
Le receiver utilise donc un parseur incrémental persistant fondé sur la lecture cancel-safe du backend. Une future `receive()` abandonnée après une partie du header ou du payload peut être relancée et reprend au bon octet. EOF au milieu d'une frame devient `Protocol`, tandis qu'un EOF à frontière de frame reste `TransportReceive::Closed`. Une longueur supérieure à la borne est refusée avant allocation puis la direction de réception est stoppée.
|
||||
|
||||
Le lifecycle distingue désormais explicitement FIN propre et abandon :
|
||||
|
||||
- `RealtimeSender::close()` émet le FIN propre ;
|
||||
- `WebTransportSender::abort(code)` reset la direction d'envoi ;
|
||||
- `WebTransportReceiver::abort(code)` stoppe la direction de réception ;
|
||||
- drop d'un sender/receiver encore actif provoque reset/stop au lieu de synthétiser une fermeture propre ;
|
||||
- cancellation d'un `send()` en cours arme un guard terminal qui reset le stream, car une frame partiellement écrite ne peut pas être reprise sans ambiguïté ;
|
||||
- cancellation d'un `receive()` reste non terminale grâce au parseur incrémental.
|
||||
|
||||
Les erreurs amont restent confinées au backend : reset/STOP observables -> `Aborted`, FIN/stream/session fermé proprement -> `Closed`, framing/état de stream invalide -> `Protocol`, dépassement -> `MessageTooLarge`, deadline -> `Timeout`, et autres erreurs de session -> `Io`. Aucun type Quinn/WebTransport n'entre dans `game-realtime-transport-lib`.
|
||||
|
||||
Aucune file applicative n'est ajoutée pour fabriquer artificiellement `Backpressure` : la pression est celle du flow-control QUIC. Lorsqu'elle empêche un envoi de terminer dans sa deadline, l'erreur observable est `Timeout`. Un test synthétique de saturation n'est pas imposé tant qu'il ne peut pas être rendu déterministe sans dépendre d'internals amont.
|
||||
|
||||
### Ownership physique
|
||||
|
||||
Nouveau backend durable candidat :
|
||||
|
||||
```text
|
||||
crates/common/game-realtime-webtransport-lib
|
||||
```
|
||||
|
||||
Responsabilités :
|
||||
|
||||
- établissement WebTransport natif et, si viable, client WASM ;
|
||||
- adaptation du chemin fiable vers `game-realtime-transport-lib` ;
|
||||
- framing binaire privé du stream principal ;
|
||||
- TLS/certificat/hash nécessaires au transport ;
|
||||
- limites, timeouts, close/reset/cancellation et mapping d'erreurs ;
|
||||
- tracing `games::realtime::webtransport` ;
|
||||
- tests natifs déterministes ;
|
||||
- aucune notion joueur/room/tick/snapshot.
|
||||
|
||||
Launchers techniques candidats :
|
||||
|
||||
```text
|
||||
crates/apps/game-realtime-webtransport-smoke
|
||||
crates/apps/game-realtime-transport-benchmark
|
||||
```
|
||||
|
||||
Un launcher séparé de fallback n'est créé que si le smoke WebTransport ou le benchmark ne peut pas porter proprement cette preuve. Ne pas créer plusieurs exécutables uniquement pour refléter chaque alpha.
|
||||
|
||||
Pour le navigateur, le frontend technique exact est décidé au moment de `alpha.7` après validation du chemin WASM. S'il faut un host Vite direct, il doit rester explicitement technique et ne pas contaminer `Web/game-snake-poc` ou le gameplay Snake.
|
||||
|
||||
### Contrat commun
|
||||
|
||||
`game-realtime-transport-lib` reste inchangé dans le plan initial.
|
||||
|
||||
Le chemin fiable utilise :
|
||||
|
||||
```text
|
||||
one WebTransport session
|
||||
-> one primary bidirectional reliable stream
|
||||
-> u32 big-endian length
|
||||
-> payload bytes
|
||||
```
|
||||
|
||||
Le framing est privé au backend, borné avant allocation et distinct du futur wire codec.
|
||||
|
||||
Le client ouvre le stream principal ; le serveur l'accepte avant de retourner une connexion utilisable. Le split commun mappe ensuite write/read du stream principal vers `RealtimeSender`/`RealtimeReceiver`.
|
||||
|
||||
Toute modification du contrat commun requiert un besoin impossible à satisfaire proprement par WebSocket et WebTransport autrement ; elle n'est pas autorisée pour harmoniser les noms d'API.
|
||||
|
||||
### Datagrams
|
||||
|
||||
Les datagrams restent hors `RealtimeConnection` parce qu'ils sont non fiables et non ordonnés.
|
||||
|
||||
Le POC les exerce uniquement comme capacité backend-spécifique/mesure. Aucune API commune durable n'est créée sans second consommateur réel.
|
||||
|
||||
### TLS de développement
|
||||
|
||||
Le POC privilégie :
|
||||
|
||||
- certificat self-signed X.509v3 court ;
|
||||
- ECDSA P-256 ;
|
||||
- validité totale inférieure à deux semaines ;
|
||||
- pin SHA-256 côté client natif et navigateur ;
|
||||
- aucune clé privée durable versionnée ;
|
||||
- aucune désactivation globale de validation TLS.
|
||||
|
||||
Le mode PKI publique, ACME et reverse proxy HTTP/3 restent hors scope de `0.3.5`.
|
||||
|
||||
### Fallback
|
||||
|
||||
Le fallback vit au niveau composition/application :
|
||||
|
||||
```text
|
||||
WebTransport attempt
|
||||
-> success: WebTransport
|
||||
-> classified unavailable/establishment failure: WebSocket
|
||||
```
|
||||
|
||||
Le test doit pouvoir forcer les deux branches.
|
||||
|
||||
Pas de `TransportManager`, registry de plugins ou sélection dynamique générique dans `game-realtime-transport-lib`.
|
||||
|
||||
## Plateformes et preuves
|
||||
|
||||
### Linux natif — obligatoire
|
||||
|
||||
- compilation backend ;
|
||||
- client/server loopback sur adresse/port éphémère ;
|
||||
- round-trip binaire ;
|
||||
- limites/timeouts/close/reset ;
|
||||
- smoke runtime hors `#[test]` ;
|
||||
- mesures locales WebSocket vs WebTransport.
|
||||
|
||||
### WASM/navigateur — obligatoire si la stack primaire reste viable
|
||||
|
||||
Deux gates distinctes :
|
||||
|
||||
1. build/check réel `wasm32-unknown-unknown` du chemin WebTransport Rust ;
|
||||
2. smoke runtime dans un navigateur récent vers le serveur Rust local.
|
||||
|
||||
Le cfg `web_sys_unstable_apis` doit être ciblé sur WASM uniquement.
|
||||
|
||||
### Android — trajectoire, pas intégration produit
|
||||
|
||||
- vérifier la compatibilité des dépendances et, si raisonnable, compiler le backend pour au moins `aarch64-linux-android` ;
|
||||
- ne modifier ni Java, ni Gradle, ni JNI sans besoin concret découvert ;
|
||||
- ne pas rejouer APK/AAB quatre ABI si aucun chemin Android produit n'est touché.
|
||||
|
||||
### Apple — documentation uniquement
|
||||
|
||||
macOS/iOS restent non validés sans environnement Apple. La version documente la dépendance supposée mais n'attribue aucun smoke.
|
||||
|
||||
## Métriques
|
||||
|
||||
Mesures obligatoires si les deux transports fonctionnent :
|
||||
|
||||
```text
|
||||
establishment latency
|
||||
RTT: small payload
|
||||
throughput: bounded medium payload
|
||||
several messages in flight
|
||||
```
|
||||
|
||||
Jeu d'essai candidat :
|
||||
|
||||
```text
|
||||
32 B
|
||||
256 B
|
||||
1 KiB
|
||||
16 KiB
|
||||
```
|
||||
|
||||
La taille exacte peut évoluer selon les limites observées, mais reste identique entre transports.
|
||||
|
||||
Les résultats doivent inclure au minimum nombre d'itérations et une statistique robuste simple, par exemple médiane et p95. Aucun benchmark loopback ne conclut à lui seul sur Internet/mobile.
|
||||
|
||||
CPU/mémoire sont optionnels si la mesure n'est pas stable/reproductible dans la session.
|
||||
|
||||
## Smoke tests prévus
|
||||
|
||||
### Smoke WebSocket hérité
|
||||
|
||||
```bash
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
```
|
||||
|
||||
Reste le témoin de fallback et doit être rejoué aux jalons larges où le fallback est concerné.
|
||||
|
||||
### Smoke WebTransport natif
|
||||
|
||||
Cible prévue :
|
||||
|
||||
```bash
|
||||
cargo run -p game-realtime-webtransport-smoke
|
||||
```
|
||||
|
||||
Il doit :
|
||||
|
||||
- générer/charger uniquement l'identité de développement nécessaire ;
|
||||
- binder localement sans port fixe ;
|
||||
- établir un client WebTransport ;
|
||||
- échanger au moins un payload dans chaque sens ;
|
||||
- fermer proprement ;
|
||||
- afficher un résultat `PASS` déterministe ;
|
||||
- ne dépendre ni d'Internet ni d'un secret versionné.
|
||||
|
||||
### Smoke navigateur
|
||||
|
||||
Le smoke navigateur doit prouver réellement :
|
||||
|
||||
- chargement du client WASM retenu ;
|
||||
- création WebTransport vers le serveur Rust ;
|
||||
- hash certificat transmis explicitement ;
|
||||
- round-trip binaire ;
|
||||
- close propre ;
|
||||
- absence de fallback silencieux vers WebSocket pendant la preuve WebTransport.
|
||||
|
||||
Le workflow exact est fixé dans `alpha.7` après la preuve de compilation WASM.
|
||||
|
||||
### Smoke fallback
|
||||
|
||||
La preuve de fallback doit couvrir :
|
||||
|
||||
- WebTransport disponible -> chemin WebTransport ;
|
||||
- WebTransport volontairement indisponible/endpoint invalide -> WebSocket ;
|
||||
- erreur non classée comme fallback -> erreur visible, pas masquée.
|
||||
|
||||
Cette preuve peut être intégrée à un launcher technique existant si cela garde le code plus petit et plus clair.
|
||||
|
||||
## Tests automatisés prévus
|
||||
|
||||
### Backend natif
|
||||
|
||||
Au minimum :
|
||||
|
||||
- configuration valide/invalide ;
|
||||
- établissement loopback ;
|
||||
- payload vide si le contrat l'autorise ;
|
||||
- payload binaire normal ;
|
||||
- plusieurs messages ordonnés ;
|
||||
- taille maximale et dépassement ;
|
||||
- longueur de frame malformée/overflow impossible ;
|
||||
- timeout d'établissement ;
|
||||
- timeout send/receive lorsque reproductible ;
|
||||
- fermeture locale ;
|
||||
- fermeture distante ;
|
||||
- reset/abort du stream principal ;
|
||||
- drop/cancellation sans task détachée ;
|
||||
- mapping des erreurs sans fuite des types amont dans le contrat commun.
|
||||
|
||||
### WASM
|
||||
|
||||
Les tests unitaires qui n'exigent pas de navigateur restent ciblés. L'interop navigateur est un smoke runtime distinct et ne doit pas être simulée par un test natif.
|
||||
|
||||
### Fallback
|
||||
|
||||
Tester la classification et la décision de composition sans créer une abstraction runtime générique.
|
||||
|
||||
## Graphe de dépendances attendu
|
||||
|
||||
```text
|
||||
game-realtime-transport-lib
|
||||
↑
|
||||
├── game-realtime-websocket-lib
|
||||
└── game-realtime-webtransport-lib
|
||||
```
|
||||
|
||||
Aucune crate sous :
|
||||
|
||||
```text
|
||||
crates/engines/
|
||||
crates/games/
|
||||
```
|
||||
|
||||
doit dépendre de `web-transport`, Quinn, Rustls ou d'un backend concret.
|
||||
|
||||
Les launchers techniques peuvent dépendre des backends nécessaires à leur preuve.
|
||||
|
||||
## Hors scope
|
||||
|
||||
- wire codec définitif ;
|
||||
- session joueur/room ;
|
||||
- matchmaking/auth ;
|
||||
- snapshots/deltas gameplay ;
|
||||
- prediction/reconciliation/rollback ;
|
||||
- simulation authoritative ;
|
||||
- Uroburas Mode 3 ;
|
||||
- persistence gameplay ;
|
||||
- cluster/sharding/regions ;
|
||||
- Redis/NATS/Kafka ;
|
||||
- PKI/ACME produit ;
|
||||
- reverse proxy HTTP/3 définitif ;
|
||||
- CDN/edge ;
|
||||
- framework générique multi-transport ;
|
||||
- réécriture Actix Web ;
|
||||
- modification du gameplay pour sélectionner un transport.
|
||||
|
||||
## Risques et critères de replanification
|
||||
|
||||
La version est replanifiée avant exécution lorsqu'une tranche dépasse clairement 30 minutes de scope attendu.
|
||||
|
||||
Déclencheurs explicites :
|
||||
|
||||
- compilation de la stack primaire impossible avec les règles Rust du dépôt ;
|
||||
- besoin d'un fork amont ;
|
||||
- browser smoke exigeant une infrastructure externe ou PKI disproportionnée ;
|
||||
- dépendance crypto rendant Android ou Linux non praticable ;
|
||||
- évolution du contrat commun requise ;
|
||||
- framing fiable beaucoup plus complexe que prévu ;
|
||||
- fallback nécessitant une abstraction partagée nouvelle ;
|
||||
- benchmark devenant un sous-projet de performance.
|
||||
|
||||
Dans ces cas, le delta courant reste fermé sur sa preuve et le plan est révisé avant la tranche suivante.
|
||||
|
||||
## Forecast révisé
|
||||
|
||||
Chaque tranche vise environ 15 à 30 minutes de travail effectif et une preuve indépendante. Les numéros restent prévisionnels conformément à `SESSION-007`.
|
||||
|
||||
### `0.3.5-alpha.1` — cadrage, audit et plan
|
||||
|
||||
- audit archive/règles/historique `0.3.4` ;
|
||||
- recherche stacks WebTransport/QUIC ;
|
||||
- choix primaire + fallback technique ;
|
||||
- décision contrat/framing/datagram ;
|
||||
- matrice TLS/plateforme ;
|
||||
- smoke/tests/metrics ;
|
||||
- plan vivant.
|
||||
|
||||
Aucun backend ni dépendance WebTransport ajouté.
|
||||
|
||||
### `0.3.5-alpha.2` — crate backend, dépendances et établissement natif
|
||||
|
||||
- créer `game-realtime-webtransport-lib` ;
|
||||
- ajouter uniquement les dépendances/features nécessaires ;
|
||||
- config native client/server ;
|
||||
- génération ou injection d'identité de test ;
|
||||
- hash pinning ;
|
||||
- établir une session native client/server ;
|
||||
- tests d'établissement/configuration ;
|
||||
- README initial de responsabilité/frontières.
|
||||
|
||||
Pas encore d'implémentation complète `RealtimeConnection` si cela rend la tranche trop lourde.
|
||||
|
||||
### `0.3.5-alpha.3` — stream fiable et contrat commun
|
||||
|
||||
Tranche validée avec :
|
||||
|
||||
- stream bidirectionnel principal ;
|
||||
- framing `u32 + payload` borné avant allocation ;
|
||||
- borne POC interne de 1 MiB ;
|
||||
- `RealtimeConnection`, sender et receiver ;
|
||||
- round-trip ordonné multi-message, y compris payload vide et octets non UTF-8 ;
|
||||
- fermeture distante de base par FIN du stream primaire ;
|
||||
- tests loopback ciblés ;
|
||||
- `USAGE.md` pour la séquence session -> stream primaire -> contrat commun.
|
||||
|
||||
La gate utilisateur du 2026-09-21 est conservée dans `history/0.3.5/alpha.3.md`.
|
||||
|
||||
### `0.3.5-alpha.4` — robustesse et lifecycle
|
||||
|
||||
Tranche candidate matérialisée avec :
|
||||
|
||||
- `WebTransportConfig` et borne de message configurable, validée avant démarrage ;
|
||||
- deadlines de connexion/réponse CONNECT, stream primaire et send ;
|
||||
- flow-control QUIC conservé comme backpressure naturelle, avec timeout observable si un send reste bloqué ;
|
||||
- FIN propre distinct des reset/stop explicites ;
|
||||
- drop actif -> abort au lieu de FIN synthétique ;
|
||||
- cancellation d'un send partiel -> reset terminal ;
|
||||
- receive incrémental cancel-safe et reprenable ;
|
||||
- EOF au milieu d'une frame et framing invalide -> `Protocol` ;
|
||||
- dépassement entrant refusé avant allocation ;
|
||||
- mapping backend -> `Timeout`, `MessageTooLarge`, `Closed`, `Protocol`, `Aborted` ou `Io` ;
|
||||
- tests ciblés sur limites, reset/drop, deadline du stream, cancellation de receive et frame tronquée.
|
||||
|
||||
Un timeout d'idle de `receive()` n'est volontairement pas imposé au contrat : l'appelant peut borner/annuler l'attente sans corrompre l'état du frame parser. Un test artificiel de saturation/backpressure n'est pas ajouté tant qu'il n'est pas déterministe.
|
||||
|
||||
La gate utilisateur de `alpha.4` a confirmé fmt, audits, `cargo check`, tous les tests du contrat commun et les vingt tests WebTransport, mais Clippy strict a détecté un unique `clippy::implicit-return` dans la future retournée par `RealtimeReceiver::receive()`. `alpha.4.fix.1` explicite ce `return` sans changement sémantique, d'API, de framing, de lifecycle ou de dépendance. La gate complète du fix reste requise avant d'ouvrir `alpha.5`.
|
||||
|
||||
### `0.3.5-alpha.5` — smoke natif hors harness
|
||||
|
||||
- créer ou finaliser `game-realtime-webtransport-smoke` ;
|
||||
- round-trip réel localhost ;
|
||||
- certificat/hash de développement reproductible ;
|
||||
- `PASS` déterministe ;
|
||||
- contrôle du graphe de dépendances.
|
||||
|
||||
Cette tranche reste distincte pour ne pas mélanger robustesse de bibliothèque et preuve runtime publique.
|
||||
|
||||
### `0.3.5-alpha.6` — chemin WASM compilable
|
||||
|
||||
- activer `web_sys_unstable_apis` uniquement pour `wasm32-unknown-unknown` ;
|
||||
- implémenter/adapter le client WASM ;
|
||||
- prouver le build/check WASM ciblé ;
|
||||
- ne pas modifier Snake ou Reflex ;
|
||||
- documenter les différences native/WASM réellement rencontrées.
|
||||
|
||||
Si la famille `web-transport` échoue ici, évaluer `wtransport` serveur + API navigateur directe avant de conclure.
|
||||
|
||||
### `0.3.5-alpha.7` — interop navigateur et TLS local
|
||||
|
||||
- host technique minimal si nécessaire ;
|
||||
- navigateur récent -> serveur Rust WebTransport ;
|
||||
- hash certificat W3C ;
|
||||
- round-trip binaire ;
|
||||
- close propre ;
|
||||
- smoke documenté et reproductible ;
|
||||
- aucune désactivation permanente de TLS.
|
||||
|
||||
Cette tranche est volontairement séparée de `alpha.6` car certificat, serveur local et browser tooling constituent un risque opérationnel distinct.
|
||||
|
||||
### `0.3.5-alpha.8` — fallback WebSocket au niveau composition
|
||||
|
||||
- tentative WebTransport ;
|
||||
- fallback WebSocket uniquement sur erreurs classifiées ;
|
||||
- branche WebTransport forcée ;
|
||||
- branche fallback forcée ;
|
||||
- erreur non-fallback visible ;
|
||||
- aucun couplage gameplay ;
|
||||
- pas de registry/framework générique.
|
||||
|
||||
### `0.3.5-alpha.9` — datagram POC isolé
|
||||
|
||||
Uniquement si le backend fiable et le navigateur sont suffisamment stables :
|
||||
|
||||
- émission/réception datagram ;
|
||||
- pertes/ordre non garantis documentés ;
|
||||
- preuve locale bornée ;
|
||||
- aucune modification du contrat commun ;
|
||||
- décision explicite : utile pour future capability ou simple constat.
|
||||
|
||||
Si la valeur est déjà claire sans API supplémentaire, cette tranche peut être fusionnée avec la mesure ou supprimée.
|
||||
|
||||
### `0.3.5-alpha.10` — mesures comparatives bornées
|
||||
|
||||
- launcher/outil minimal de mesure ;
|
||||
- WebSocket vs WebTransport fiable ;
|
||||
- établissement, RTT, throughput, messages en vol ;
|
||||
- datagram seulement s'il existe réellement ;
|
||||
- résultats et limites de méthode documentés ;
|
||||
- conclusion technique provisoire `retain/defer/reject`.
|
||||
|
||||
### `0.3.5-beta.1` — validation large
|
||||
|
||||
Jalon rare de full workspace :
|
||||
|
||||
```bash
|
||||
cargo test --workspace --all-targets --all-features
|
||||
```
|
||||
|
||||
Plus :
|
||||
|
||||
- fmt/check/Clippy/audits ;
|
||||
- tests ciblés realtime ;
|
||||
- smoke WebSocket ;
|
||||
- smoke WebTransport natif ;
|
||||
- smoke navigateur si retenu ;
|
||||
- preuve fallback ;
|
||||
- `cargo tree` direct/inverse des deux backends ;
|
||||
- vérification qu'aucun gameplay/engine ne dépend d'un backend concret.
|
||||
|
||||
Toute capacité fonctionnelle majeure manquante réouvre une alpha ; un défaut fermé produit `beta.1.fix.N`.
|
||||
|
||||
### `0.3.5-beta.2` — consolidation pré-RC
|
||||
|
||||
Tranche explicitement réservée par `SESSION-009` / `VER-PHASE-010` :
|
||||
|
||||
- réconcilier README/USAGE et docs durables ;
|
||||
- figer la conclusion WebTransport ;
|
||||
- documenter plateformes réellement validées/non validées ;
|
||||
- mettre à jour `CHANGELOG.md` si la transition vers RC est préparée ;
|
||||
- réconcilier `ROADMAP.md` seulement si le statut macro change ;
|
||||
- écrire le prompt `0.3.6` ;
|
||||
- enregistrer l'historique `beta.1` après validation ;
|
||||
- aucune nouvelle fonctionnalité majeure.
|
||||
|
||||
### `0.3.5-rc.1` — candidate gelée
|
||||
|
||||
- aucun comportement volontaire nouveau ;
|
||||
- full workspace conformément à `CMD-RC-002` ;
|
||||
- gates realtime de publication ;
|
||||
- smokes retenus ;
|
||||
- graphe de dépendances ;
|
||||
- vérification du prompt `0.3.6` ;
|
||||
- corrections uniquement selon `VER-RC-*`.
|
||||
|
||||
### `0.3.5` — stable
|
||||
|
||||
Promotion mécanique autant que possible :
|
||||
|
||||
- version stable ;
|
||||
- historique RC ;
|
||||
- changelog stable ;
|
||||
- clôture du plan ;
|
||||
- roadmap si nécessaire ;
|
||||
- delta final ;
|
||||
- ajustement mécanique du prompt `0.3.6`.
|
||||
|
||||
## Gates Cargo planifiées
|
||||
|
||||
### Tranches Rust ordinaires
|
||||
|
||||
Dès qu'un fichier Rust/Cargo change :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
```
|
||||
|
||||
Puis tests ciblés des crates touchées/consommateurs affectés.
|
||||
|
||||
### Full workspace
|
||||
|
||||
`cargo test --workspace --all-targets --all-features` est réservé explicitement à :
|
||||
|
||||
- `beta.1` ;
|
||||
- `rc.1` ;
|
||||
- éventuellement une tranche plus tôt uniquement si un changement transverse rend les tests ciblés insuffisants.
|
||||
|
||||
Il n'est pas répété à chaque alpha.
|
||||
|
||||
### Cargo tree
|
||||
|
||||
À exécuter :
|
||||
|
||||
- après introduction/changement de dépendances WebTransport ;
|
||||
- à `alpha.5` pour prouver la frontière ;
|
||||
- à `beta.1` et `rc.1` pour les graphes de publication.
|
||||
|
||||
## Nettoyage Cargo
|
||||
|
||||
Aucun `cargo clean` n'est requis dans `alpha.1`.
|
||||
|
||||
Le plan réserve un nettoyage complet au plus tard avant la validation RC si l'accumulation du target-dir ou un doute de reproductibilité le justifie. Un nettoyage ciblé reste préférable pendant les alphas.
|
||||
|
||||
## Critère de réussite de 0.3.5
|
||||
|
||||
La version est réussie si elle fournit une conclusion reproductible parmi :
|
||||
|
||||
```text
|
||||
retained -> second backend utile, conserver pour 0.4.x
|
||||
deferred -> viable mais bénéfice/portabilité/infrastructure insuffisants aujourd'hui
|
||||
rejected -> coût ou incompatibilité disproportionnés pour la trajectoire actuelle
|
||||
```
|
||||
|
||||
Aucune conclusion n'est imposée à l'avance.
|
||||
|
||||
Même en cas de report/rejet, la baseline WebSocket `0.3.4` reste fonctionnelle et le POC ne doit pas laisser une abstraction commune artificiellement déformée.
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/rules/PROMPT_STRUCTURE.md -->
|
||||
<!-- version: 3 -->
|
||||
<!-- version: 4 -->
|
||||
|
||||
# Structure des prompts de reprise
|
||||
|
||||
@@ -15,7 +15,7 @@ Le prompt rappelle les invariants qui évitent les erreurs de workflow et renvoi
|
||||
- **PROMPT-STR-002** — Le prompt fournit un ordre de lecture court des sources de vérité : `RULES.md`, `ROADMAP.md`, `CHANGELOG.md`, `docs/000-README.md`, règles directement pertinentes, plan/historique de la version précédente et documents d'architecture concernés.
|
||||
- **PROMPT-STR-003** — Le prompt distingue explicitement l'état déjà validé hérité de la baseline des validations qui devront être exécutées dans la nouvelle version.
|
||||
- **PROMPT-STR-004** — Le prompt décrit la mission, le résultat attendu, le scope inclus, le hors-périmètre et les invariants architecturaux gelés.
|
||||
- **PROMPT-STR-005** — Le prompt rappelle que `0-pre.1` est le gate de cadrage : audit, requirements, sizing, risques, validations prévues et création/révision du plan sous `docs/plans/` avant développement lourd.
|
||||
- **PROMPT-STR-005** — Le prompt rappelle que `alpha.1` est le gate de cadrage : audit, requirements, sizing, risques, validations prévues et création/révision du plan sous `docs/plans/` avant développement lourd.
|
||||
- **PROMPT-STR-006** — Le prompt contient un forecast souple jusqu'à la stable. Il réserve les responsabilités de développement, validation large, consolidation documentaire, préparation de publication/RC et release mécanique sans rendre les numéros immuables.
|
||||
- **PROMPT-STR-007** — Le prompt rappelle où se trouve la définition des commandes : `docs/rules/RULES_COMMANDS.md` pour la politique d'exécution et `docs/rules/RULES_VALIDATION_MATRIX.md` pour les IDs, dépendances et déclencheurs. Il ne recopie que les commandes indispensables à la reprise ou au premier gate.
|
||||
- **PROMPT-STR-008** — Le prompt rappelle la séparation utilisateur/générateur : les audits statiques peuvent être exécutés par le générateur, mais les builds, tests et smokes finaux restent côté utilisateur conformément à `CMD-BUILD-005` et ne sont jamais déclarés réussis sans sortie réelle.
|
||||
@@ -30,7 +30,7 @@ Le prompt rappelle les invariants qui évitent les erreurs de workflow et renvoi
|
||||
|
||||
- **PROMPT-STR-010** — Le prompt rappelle que `deltas/` décrit la livraison candidate et ses validations attendues, alors que `history/` enregistre uniquement le résultat d'un jalon effectivement accepté.
|
||||
- **PROMPT-STR-011** — Le prompt rappelle qu'une entrée `history/<X.Y.Z>/<jalon>.md` est créée par le delta suivant ou le fix suivant après validation, jamais avant la validation qu'elle décrit.
|
||||
- **PROMPT-STR-012** — Le prompt rappelle que `CHANGELOG.md` n'est normalement mis à jour qu'à partir de la RC puis à la stable ; les détails `pre`/`beta` restent dans `deltas/` et `history/`.
|
||||
- **PROMPT-STR-012** — Le prompt rappelle que `CHANGELOG.md` n'est normalement mis à jour qu'à partir de la RC puis à la stable ; les détails `alpha`/`beta` restent dans `deltas/` et `history/`.
|
||||
- **PROMPT-STR-013** — Le prompt rappelle que `ROADMAP.md` reste macroscopique et n'est modifié que lorsque le scope, son ordre ou son statut évolue réellement ; le plan de version porte le découpage fin.
|
||||
- **PROMPT-STR-014** — Le prompt rappelle que la documentation propre à une fonctionnalité évolue avec la tranche qui l'introduit ; la consolidation finale réconcilie l'ensemble mais ne sert pas à repousser toute documentation à la fin.
|
||||
- **PROMPT-STR-015** — Le prompt mentionne explicitement la politique `README.md`/`USAGE.md` lorsque la version crée ou finalise une crate, une application ou un package : appliquer `DOC-CRATE-*` et décider dans le plan quels fichiers ont une valeur durable réelle.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/rules/RULES_DOCUMENTATION.md -->
|
||||
<!-- version: 8 -->
|
||||
<!-- version: 9 -->
|
||||
|
||||
# Règles de documentation
|
||||
|
||||
@@ -74,7 +74,7 @@
|
||||
## CHANGELOG
|
||||
|
||||
- **DOC-CHG-001** — `CHANGELOG.md` est une synthèse de publication, pas un journal de développement.
|
||||
- **DOC-CHG-002** — Les `pre.*`, `alpha.*`, `beta.*` et leurs `.fix.*` ne créent normalement aucune entrée de changelog.
|
||||
- **DOC-CHG-002** — Les `alpha.*`, `beta.*` et leurs `.fix.*` ne créent normalement aucune entrée de changelog.
|
||||
- **DOC-CHG-003** — Le changelog est mis à jour à partir des jalons `rc.*` et pour chaque release stable.
|
||||
- **DOC-CHG-004** — Une entrée RC résume l'état candidat à publication ; l'entrée stable résume le résultat effectivement publié.
|
||||
- **DOC-CHG-005** — Les détails intermédiaires de construction, corrections et validations restent dans `deltas/` et `history/`.
|
||||
@@ -92,7 +92,7 @@
|
||||
|
||||
- **DOC-VAL-001** — Une gate Markdown ou un audit syntaxique valide la forme des documents, jamais leur exactitude fonctionnelle, leur exhaustivité ni leur acceptation.
|
||||
- **DOC-VAL-002** — Une prerelease principalement documentaire reste candidate tant que son contenu n'a pas été relu et accepté humainement.
|
||||
- **DOC-VAL-003** — Une version de conception peut utiliser plusieurs `pre.N` successives uniquement pour permettre revue, correction, complément et maturation documentaire.
|
||||
- **DOC-VAL-003** — Une version de conception peut utiliser plusieurs `alpha.N` successives uniquement pour permettre revue, correction, complément et maturation documentaire.
|
||||
- **DOC-VAL-004** — Cargo, Gradle, packaging et smoke tests ne sont requis pour une prerelease documentaire que si le delta modifie du code, une configuration de build/runtime ou un contrat susceptible de les affecter.
|
||||
- **DOC-VAL-005** — Le document de delta énumère les validations applicables ; l'absence volontaire d'une gate technique doit découler du scope réel, pas d'un raccourci.
|
||||
- **DOC-VAL-006** — Une version documentaire n'est promue en `rc` ou stable qu'après validation explicite de son contenu, même si tous les audits automatisés sont propres.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/rules/RULES_SESSION_PLANNING.md -->
|
||||
<!-- version: 5 -->
|
||||
<!-- version: 6 -->
|
||||
|
||||
# Règles de cadrage des versions, sessions et prompts
|
||||
|
||||
@@ -7,26 +7,26 @@
|
||||
|
||||
Ces règles imposent un découpage suffisamment petit pour qu'une version puisse être développée complètement dans une seule session et reprise sans ambiguïté.
|
||||
|
||||
## `pre.1` — cadrage obligatoire
|
||||
## `alpha.1` — cadrage obligatoire
|
||||
|
||||
- **SESSION-001** — Toute nouvelle version commence par une `0-pre.1` de cadrage.
|
||||
- **SESSION-001** — Toute nouvelle version commence par une `alpha.1` de cadrage.
|
||||
- **SESSION-002** — Cette tranche couvre au minimum l'audit de la base, le brainstorming/recherche de requirements, le sizing, les dépendances, les validations prévues et le découpage prévisionnel.
|
||||
- **SESSION-003** — Une première implémentation peut être incluse dans `0-pre.1` uniquement si elle est petite, cohérente et n'empêche pas le cadrage d'être terminé.
|
||||
- **SESSION-003** — Une première implémentation peut être incluse dans `alpha.1` uniquement si elle est petite, cohérente et n'empêche pas le cadrage d'être terminé.
|
||||
- **SESSION-004** — Si le sizing montre que l'objectif global ne peut raisonnablement pas être terminé dans la session, il est scindé en plusieurs versions avant le développement lourd.
|
||||
- **SESSION-005** — `0-pre.1` crée ou révise obligatoirement le plan de la version sous `docs/plans/`. Ce plan est un livrable du cadrage, pas une note optionnelle.
|
||||
- **SESSION-005** — `alpha.1` crée ou révise obligatoirement le plan de la version sous `docs/plans/`. Ce plan est un livrable du cadrage, pas une note optionnelle.
|
||||
- **SESSION-006** — Le plan de version contient au minimum l'objectif et le scope, les décisions acquises, les dépendances/risques utiles, les validations attendues, les hors-périmètre et une prévision souple des tranches jusqu'à la release stable.
|
||||
- **SESSION-007** — La prévision du plan n'est pas un calendrier figé : une tranche peut être scindée, fusionnée, déplacée ou complétée par un fix lorsque les résultats réels le justifient. Le plan actif est alors réconcilié et le delta explique le changement.
|
||||
- **SESSION-008** — `ROADMAP.md` reste macroscopique, le plan porte le découpage prévisionnel fin de la version et les deltas enregistrent ce qui a réellement été livré.
|
||||
- **SESSION-009** — Le forecast créé en `0-pre.1` rend explicitement visible une tranche de consolidation avant la candidate finale ; cette tranche couvre au minimum la réconciliation de la documentation durable, `CHANGELOG.md`, `ROADMAP.md`, l'historique applicable et le prompt de la version/session suivante, même si son numéro exact reste prévisionnel.
|
||||
- **SESSION-009** — Le forecast créé en `alpha.1` rend explicitement visible une tranche de consolidation avant la candidate finale ; cette tranche couvre au minimum la réconciliation de la documentation durable, `CHANGELOG.md`, `ROADMAP.md`, l'historique applicable et le prompt de la version/session suivante, même si son numéro exact reste prévisionnel.
|
||||
|
||||
## Taille des tranches
|
||||
|
||||
- **SESSION-010** — Une tranche `pre.N`, `alpha.N`, `beta.N`, `rc.N` ou `fix.N` vise normalement un delta correspondant à environ 15 à 30 minutes de travail effectif.
|
||||
- **SESSION-010** — Une tranche `alpha.N`, `beta.N`, `rc.N` ou `fix.N` vise normalement un delta correspondant à environ 15 à 30 minutes de travail effectif.
|
||||
- **SESSION-011** — Une tranche clairement plus lourde est scindée avant exécution.
|
||||
- **SESSION-012** — Plusieurs micro-tranches sans valeur de validation indépendante peuvent être regroupées.
|
||||
- **SESSION-013** — Le découpage suit des unités fonctionnelles complètes et validables ; une fonctionnalité ne doit pas être volontairement coupée au milieu uniquement pour respecter un numéro de prerelease.
|
||||
- **SESSION-014** — Chaque tranche livre son delta et ses validations proportionnelles avant la tranche suivante.
|
||||
- **SESSION-015** — Le plan créé en `0-pre.1` identifie explicitement le ou les rares jalons où `cargo test --workspace --all-targets --all-features` apporte une valeur globale (initial si nécessaire, préfinal/final ou changement transverse). Les autres tranches privilégient les tests `cargo test -p ...` ciblés.
|
||||
- **SESSION-015** — Le plan créé en `alpha.1` identifie explicitement le ou les rares jalons où `cargo test --workspace --all-targets --all-features` apporte une valeur globale (initial si nécessaire, préfinal/final ou changement transverse). Les autres tranches privilégient les tests `cargo test -p ...` ciblés.
|
||||
|
||||
## Une version par session
|
||||
|
||||
@@ -49,7 +49,7 @@ Ces règles imposent un découpage suffisamment petit pour qu'une version puisse
|
||||
- **PROMPT-005** — Le prompt rappelle les invariants essentiels mais renvoie aux RULES pour les détails normatifs au lieu de les recopier intégralement.
|
||||
- **PROMPT-006** — Le prompt contient suffisamment de contexte pour reprendre la version sans dépendre de la mémoire conversationnelle ni relire toute l'histoire du dépôt.
|
||||
- **PROMPT-007** — Le prompt précise la condition de fin de session et les livrables attendus.
|
||||
- **PROMPT-008** — Si `pre.1` invalide le sizing prévu par le prompt, le nouveau découpage est documenté immédiatement avant le développement lourd.
|
||||
- **PROMPT-008** — Si `alpha.1` invalide le sizing prévu par le prompt, le nouveau découpage est documenté immédiatement avant le développement lourd.
|
||||
- **PROMPT-009** — Tout nouveau prompt de version applique `docs/rules/PROMPT_STRUCTURE.md`; le présent document fixe le cycle de session tandis que `PROMPT_STRUCTURE.md` fixe le contenu opératoire à rappeler.
|
||||
|
||||
## Relation avec VERSION_WORKFLOW
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/rules/RULES_VALIDATION_MATRIX.md -->
|
||||
<!-- version: 6 -->
|
||||
<!-- version: 7 -->
|
||||
|
||||
# Matrice normative des commandes et validations
|
||||
|
||||
@@ -15,30 +15,30 @@ Les commandes ciblées restent la norme pendant l'implémentation ; les gates wo
|
||||
|
||||
| ID | Commande / action | Dépend de | Déclencheur principal | Phase minimale typique |
|
||||
|-----------|------------------------------------------------------------------------------------|---------------------------------|----------------------------------------------------|------------------------|
|
||||
| `CMD-001` | `cargo fmt --all` | — | Rust ou dépendance Cargo modifiée | `pre` |
|
||||
| `CMD-002` | `cargo fmt --all -- --check` | `CMD-001` | Rust ou dépendance Cargo modifiée | `pre` |
|
||||
| `CMD-010` | `python3 scripts/audit_rust_workspace_rules.py` | — | Rust/Cargo/workspace/règles Rust concernés | `pre` |
|
||||
| `CMD-011` | `python3 scripts/audit_markdown_tables.py ...` | — | Markdown concerné | `pre` |
|
||||
| `CMD-012` | `python3 scripts/audit_distribution_layout.py` | — | layout/build/distribution concerné | `pre` |
|
||||
| `CMD-020` | `cargo check -p <crate>` | audits applicables | diagnostic ciblé facultatif | `pre` |
|
||||
| `CMD-021` | `cargo test -p <crate> --all-targets --all-features` | `CMD-023`, `CMD-024` | comportement/API crate | `pre` |
|
||||
| `CMD-022` | tests ciblés des crates consommatrices impactées | `CMD-021` | API publique/contrat partagé modifié | `pre` |
|
||||
| `CMD-023` | `cargo check --workspace` | `CMD-002`, audits applicables | Rust ou dépendance Cargo modifiée | `pre` |
|
||||
| `CMD-024` | `cargo clippy --workspace --all-targets --all-features -- -D warnings` | `CMD-023` | Rust ou dépendance Cargo modifiée | `pre` |
|
||||
| `CMD-001` | `cargo fmt --all` | — | Rust ou dépendance Cargo modifiée | `alpha` |
|
||||
| `CMD-002` | `cargo fmt --all -- --check` | `CMD-001` | Rust ou dépendance Cargo modifiée | `alpha` |
|
||||
| `CMD-010` | `python3 scripts/audit_rust_workspace_rules.py` | — | Rust/Cargo/workspace/règles Rust concernés | `alpha` |
|
||||
| `CMD-011` | `python3 scripts/audit_markdown_tables.py ...` | — | Markdown concerné | `alpha` |
|
||||
| `CMD-012` | `python3 scripts/audit_distribution_layout.py` | — | layout/build/distribution concerné | `alpha` |
|
||||
| `CMD-020` | `cargo check -p <crate>` | audits applicables | diagnostic ciblé facultatif | `alpha` |
|
||||
| `CMD-021` | `cargo test -p <crate> --all-targets --all-features` | `CMD-023`, `CMD-024` | comportement/API crate | `alpha` |
|
||||
| `CMD-022` | tests ciblés des crates consommatrices impactées | `CMD-021` | API publique/contrat partagé modifié | `alpha` |
|
||||
| `CMD-023` | `cargo check --workspace` | `CMD-002`, audits applicables | Rust ou dépendance Cargo modifiée | `alpha` |
|
||||
| `CMD-024` | `cargo clippy --workspace --all-targets --all-features -- -D warnings` | `CMD-023` | Rust ou dépendance Cargo modifiée | `alpha` |
|
||||
| `CMD-025` | `cargo test --workspace --all-targets --all-features` | `CMD-024` | gate rare planifiée / portée transverse incertaine | selon plan |
|
||||
| `CMD-026` | `cargo tree -p <crate> --edges normal` ou variante ciblée | — | dépendances/features modifiées ou diagnostic | selon portée |
|
||||
| `CMD-030` | build Desktop `--release` ciblé | gates Rust applicables | runner/distribution Desktop touché | beta |
|
||||
| `CMD-031` | smoke Desktop release | `CMD-030` | runtime Desktop touché | beta |
|
||||
| `CMD-040` | `(cd <tauri-app> && cargo tauri dev)` | gates Rust/frontend applicables | smoke interactif Tauri Desktop | `pre`/beta |
|
||||
| `CMD-040` | `(cd <tauri-app> && cargo tauri dev)` | gates Rust/frontend applicables | smoke interactif Tauri Desktop | alpha/beta |
|
||||
| `CMD-041` | `(cd <tauri-app> && cargo tauri build)` | gates Rust/frontend applicables | packaging Tauri Desktop final/prefinal | beta/RC |
|
||||
| `CMD-042` | build Rust `wasm32-unknown-unknown` + `wasm-bindgen --target web` | gates Rust de l'adapter | adapter WASM/Web direct touché | `pre` |
|
||||
| `CMD-043` | `(cd Web/<game> && npm install && npm run build)` | `CMD-042` si frontend avec WASM | frontend Web direct touché | `pre` |
|
||||
| `CMD-044` | smoke navigateur du host Web direct | `CMD-043` | Canvas/input/responsive Web touchés | `pre`/beta |
|
||||
| `CMD-045` | `(cd <tauri-app> && cargo tauri android init)` | environnement Android/Tauri | initialisation unique de la cible Tauri Android | `pre` |
|
||||
| `CMD-046` | `(cd <tauri-app> && cargo tauri android dev)` | gates Rust/frontend applicables | smoke interactif Tauri Android | `pre`/beta |
|
||||
| `CMD-042` | build Rust `wasm32-unknown-unknown` + `wasm-bindgen --target web` | gates Rust de l'adapter | adapter WASM/Web direct touché | `alpha` |
|
||||
| `CMD-043` | `(cd Web/<game> && npm install && npm run build)` | `CMD-042` si frontend avec WASM | frontend Web direct touché | `alpha` |
|
||||
| `CMD-044` | smoke navigateur du host Web direct | `CMD-043` | Canvas/input/responsive Web touchés | alpha/beta |
|
||||
| `CMD-045` | `(cd <tauri-app> && cargo tauri android init)` | environnement Android/Tauri | initialisation unique de la cible Tauri Android | `alpha` |
|
||||
| `CMD-046` | `(cd <tauri-app> && cargo tauri android dev)` | gates Rust/frontend applicables | smoke interactif Tauri Android | alpha/beta |
|
||||
| `CMD-047` | `(cd <tauri-app> && cargo tauri android build)` | gates Rust/frontend applicables | packaging Tauri Android final/prefinal | beta/RC |
|
||||
| `CMD-050` | build Rust Android ABI ciblé | gates Rust applicables | Android/JNI/backend natif touché | pre/beta |
|
||||
| `CMD-051` | `(cd Android && gradle :<app>:assembleDebug)` | `CMD-050` si Rust natif change | Android/app/manifest/Java touché | pre/beta |
|
||||
| `CMD-050` | build Rust Android ABI ciblé | gates Rust applicables | Android/JNI/backend natif touché | alpha/beta |
|
||||
| `CMD-051` | `(cd Android && gradle :<app>:assembleDebug)` | `CMD-050` si Rust natif change | Android/app/manifest/Java touché | alpha/beta |
|
||||
| `CMD-052` | install + smoke AVD | `CMD-051` | Android concerné | beta |
|
||||
| `CMD-053` | install + smoke appareil réel | `CMD-051` | Android concerné | beta/RC |
|
||||
| `CMD-060` | `cargo clean --dry-run --verbose` | — | contrôle disque / préparation nettoyage | maintenance |
|
||||
|
||||
@@ -1,32 +1,31 @@
|
||||
<!-- file: docs/rules/VERSION_WORKFLOW.md -->
|
||||
<!-- version: 6 -->
|
||||
<!-- version: 7 -->
|
||||
|
||||
# Versionnement, maturité et livraisons
|
||||
|
||||
## SemVer canonique
|
||||
|
||||
Le projet utilise SemVer et les labels de maturité normalisés suivants :
|
||||
À partir de `0.3.4`, le projet utilise SemVer et les labels de maturité normalisés suivants :
|
||||
|
||||
```text
|
||||
X.Y.Z-0-pre.N
|
||||
X.Y.Z-0-pre.N.fix.M
|
||||
X.Y.Z-1-alpha.N
|
||||
X.Y.Z-1-alpha.N.fix.M
|
||||
X.Y.Z-2-beta.N
|
||||
X.Y.Z-2-beta.N.fix.M
|
||||
X.Y.Z-3-rc.N
|
||||
X.Y.Z-3-rc.N.fix.M
|
||||
X.Y.Z-alpha.N
|
||||
X.Y.Z-alpha.N.fix.M
|
||||
X.Y.Z-beta.N
|
||||
X.Y.Z-beta.N.fix.M
|
||||
X.Y.Z-rc.N
|
||||
X.Y.Z-rc.N.fix.M
|
||||
X.Y.Z
|
||||
```
|
||||
|
||||
`N` et `M` sont des entiers positifs sans zéro initial.
|
||||
|
||||
Les anciens labels `0-pre.N`, `1-alpha.N`, `2-beta.N` et `3-rc.N` appartiennent uniquement aux jalons livrés avant cette migration. Les fichiers historiques concernés restent immuables et leurs identifiants ne sont jamais normalisés rétroactivement.
|
||||
|
||||
## Sens des niveaux
|
||||
|
||||
- `0-pre.N` : construction initiale, architecture et fonctionnalités encore très mouvantes ;
|
||||
- `1-alpha.N` : périmètre fonctionnel principal établi mais encore incomplet ou instable ;
|
||||
- `2-beta.N` : fonctionnalités attendues largement présentes, priorité à la stabilisation et aux tests ;
|
||||
- `3-rc.N` : candidat de publication, aucune évolution non indispensable ;
|
||||
- `alpha.N` : construction, architecture et fonctionnalités encore susceptibles d'évoluer ; `alpha.1` porte obligatoirement le cadrage de la version ;
|
||||
- `beta.N` : fonctionnalités attendues largement présentes, priorité à la stabilisation et aux tests ;
|
||||
- `rc.N` : candidat de publication, aucune évolution non indispensable ;
|
||||
- `X.Y.Z` : version stable.
|
||||
|
||||
## Correctifs
|
||||
@@ -34,13 +33,13 @@ X.Y.Z
|
||||
Un suffixe `.fix.M` corrige la prerelease immédiatement précédente sans changer son objectif fonctionnel. Exemple :
|
||||
|
||||
```text
|
||||
0.1.0-0-pre.4
|
||||
0.1.0-0-pre.4.fix.1
|
||||
0.1.0-0-pre.4.fix.2
|
||||
0.1.0-0-pre.5
|
||||
0.3.4-alpha.2
|
||||
0.3.4-alpha.2.fix.1
|
||||
0.3.4-alpha.2.fix.2
|
||||
0.3.4-alpha.3
|
||||
```
|
||||
|
||||
Après une version stable, un correctif produit normalement un nouveau patch SemVer, par exemple `0.1.1`, et non `0.1.0.fix.1`.
|
||||
Après une version stable, un correctif produit normalement un nouveau patch SemVer, par exemple `0.3.5`, et non `0.3.4.fix.1`.
|
||||
|
||||
## Version workspace et versions autonomes
|
||||
|
||||
@@ -64,19 +63,21 @@ Les documents sont rangés sous :
|
||||
deltas/X.Y.Z/<prerelease-or-rel>.md
|
||||
```
|
||||
|
||||
Exemples :
|
||||
Exemples canoniques pour les nouvelles versions :
|
||||
|
||||
```text
|
||||
deltas/0.1.0/0-pre.1.md
|
||||
deltas/0.1.0/0-pre.1.fix.1.md
|
||||
deltas/0.1.0/1-alpha.1.md
|
||||
deltas/0.1.0/3-rc.2.md
|
||||
deltas/0.1.0/rel.md
|
||||
deltas/0.3.4/alpha.1.md
|
||||
deltas/0.3.4/alpha.1.fix.1.md
|
||||
deltas/0.3.4/beta.1.md
|
||||
deltas/0.3.4/rc.1.md
|
||||
deltas/0.3.4/rel.001.md
|
||||
```
|
||||
|
||||
Les anciens chemins déjà livrés, par exemple `deltas/0.3.3/0-pre.1.md` ou `deltas/0.3.3/3-rc.1.md`, restent des preuves historiques valides et immuables.
|
||||
|
||||
## Versions principalement documentaires
|
||||
|
||||
Une version de conception suit le même SemVer que les autres versions et peut utiliser plusieurs `0-pre.N` pour permettre une revue humaine progressive.
|
||||
Une version de conception suit le même SemVer que les autres versions et peut utiliser plusieurs `alpha.N` pour permettre une revue humaine progressive.
|
||||
|
||||
Les audits Markdown et de règles valident la cohérence mécanique mais ne valent jamais acceptation du fond documentaire. Une prerelease documentaire reste candidate jusqu'à revue explicite de son contenu.
|
||||
|
||||
@@ -93,7 +94,7 @@ La promotion `rc` puis stable d'une version de conception exige une validation h
|
||||
|
||||
- **VER-RC-001** — Une RC est fonctionnellement gelée. Les nouvelles fonctionnalités, nouvelles capabilities, refactors architecturaux non indispensables et changements volontaires de comportement sont interdits.
|
||||
- **VER-RC-002** — Les modifications de code restent autorisées en RC lorsqu'elles corrigent un bug, un test erroné, un défaut de packaging, un problème de sécurité, une incompatibilité de release ou un défaut strictement nécessaire à la publication.
|
||||
- **VER-RC-003** — Un correctif conforme à `VER-RC-002` produit `3-rc.N.fix.M` et n'impose pas un retour automatique en beta.
|
||||
- **VER-RC-003** — Un correctif conforme à `VER-RC-002` produit `rc.N.fix.M` et n'impose pas un retour automatique en beta.
|
||||
- **VER-RC-004** — Si le périmètre fonctionnel est rouvert pendant une RC, la candidate est abandonnée et le développement revient à une phase adaptée, normalement beta, avant une nouvelle RC.
|
||||
|
||||
## Prompt de la version suivante
|
||||
@@ -106,7 +107,7 @@ La promotion `rc` puis stable d'une version de conception exige une validation h
|
||||
## Correctifs strictement documentaires
|
||||
|
||||
- **VER-DOCFIX-001** — Un `.fix.N` limité à la documentation, aux prompts, aux deltas, à `history/` ou aux règles non consommées par le build/runtime ne modifie aucune version technique : ni `workspace.package.version`/`Cargo.toml`, ni `package.json`, ni Gradle/Android, ni `tauri.conf.json`, ni autre métadonnée de version consommée par un build ou une distribution. L'identité du correctif est portée uniquement par le delta et son archive.
|
||||
- **VER-DOCFIX-002** — Une prerelease non-fix (`pre.N`, `alpha.N`, `beta.N`, `rc.N`) synchronise sa version technique selon le workflow de phase même lorsque son contenu est principalement documentaire.
|
||||
- **VER-DOCFIX-002** — Une prerelease non-fix (`alpha.N`, `beta.N`, `rc.N`) synchronise sa version technique selon le workflow de phase même lorsque son contenu est principalement documentaire.
|
||||
- **VER-DOCFIX-003** — Dès qu'un correctif touche du code, une configuration exécutable, un manifeste consommé par le build/runtime ou un artefact distribué, la version technique suit l'identifiant `.fix.N`.
|
||||
|
||||
## Phases de développement
|
||||
@@ -118,11 +119,11 @@ PLAN → IMPLEMENT → INTEGRATE → VALIDATE → CANDIDATE → RELEASE
|
||||
```
|
||||
|
||||
- **VER-PHASE-001** — Ces phases structurent le travail mais n'imposent pas une prerelease distincte pour chacune.
|
||||
- **VER-PHASE-002** — `0-pre.1` est obligatoirement la tranche de cadrage de la version : audit de la base, brainstorming/recherche de requirements, sizing, planification, dépendances, validations attendues et création/révision du plan actif sous `docs/plans/` avec son découpage prévisionnel souple.
|
||||
- **VER-PHASE-003** — `0-pre.1` peut aussi contenir une première implémentation strictement bornée si le cadrage montre qu'elle tient naturellement dans la même tranche, mais le cadrage ne doit jamais être sauté.
|
||||
- **VER-PHASE-002** — `alpha.1` est obligatoirement la tranche de cadrage de la version : audit de la base, brainstorming/recherche de requirements, sizing, planification, dépendances, validations attendues et création/révision du plan actif sous `docs/plans/` avec son découpage prévisionnel souple.
|
||||
- **VER-PHASE-003** — `alpha.1` peut aussi contenir une première implémentation strictement bornée si le cadrage montre qu'elle tient naturellement dans la même tranche, mais le cadrage ne doit jamais être sauté.
|
||||
- **VER-PHASE-004** — Une version doit être dimensionnée pour que l'ensemble de son développement puisse être terminé dans une seule session de travail. Si ce n'est pas réaliste, son objectif est découpé en plusieurs versions/sessions avant le développement lourd.
|
||||
- **VER-PHASE-005** — Le plan établi en `0-pre.1` est vivant : il peut regrouper, scinder, reporter ou reclasser des tranches lorsque l'information réelle le justifie, sans réécrire les deltas déjà livrés. Il reste la référence de suivi prévisionnel de la version jusqu'à sa clôture.
|
||||
- **VER-PHASE-006** — Une tranche `pre.N`, `alpha.N`, `beta.N`, `rc.N` ou leur fix vise normalement un delta réalisable en environ 15 à 30 minutes. Une tranche sensiblement plus lourde est découpée avant exécution ; une tranche trop petite peut être regroupée avec une tranche adjacente cohérente.
|
||||
- **VER-PHASE-005** — Le plan établi en `alpha.1` est vivant : il peut regrouper, scinder, reporter ou reclasser des tranches lorsque l'information réelle le justifie, sans réécrire les deltas déjà livrés. Il reste la référence de suivi prévisionnel de la version jusqu'à sa clôture.
|
||||
- **VER-PHASE-006** — Une tranche `alpha.N`, `beta.N`, `rc.N` ou leur fix vise normalement un delta réalisable en environ 15 à 30 minutes. Une tranche sensiblement plus lourde est découpée avant exécution ; une tranche trop petite peut être regroupée avec une tranche adjacente cohérente.
|
||||
- **VER-PHASE-007** — Le découpage privilégie des unités fonctionnelles complètes et validables, pas des coupures arbitraires au milieu d'une fonctionnalité.
|
||||
- **VER-PHASE-008** — Chaque tranche ferme son propre scope, produit son delta et ses validations proportionnelles avant l'ouverture de la tranche suivante.
|
||||
- **VER-PHASE-009** — Alpha, beta et RC sont utilisées proportionnellement au risque et à la maturité ; elles ne sont pas créées uniquement pour satisfaire une séquence cérémonielle.
|
||||
@@ -133,7 +134,7 @@ PLAN → IMPLEMENT → INTEGRATE → VALIDATE → CANDIDATE → RELEASE
|
||||
|
||||
- **VER-TAURI-001** — Pour une app Tauri Rust du workspace, la version produit canonique est la version Cargo.
|
||||
- **VER-TAURI-002** — `tauri.conf.json` omet `version` lorsque Tauri peut hériter de la version `Cargo.toml`.
|
||||
- **VER-TAURI-003** — La `version` de `package.json` décrit le package frontend local et n'est pas synchronisée à chaque `pre.N` ou `.fix.N`.
|
||||
- **VER-TAURI-003** — La `version` de `package.json` décrit le package frontend local et n'est pas synchronisée à chaque prerelease ou `.fix.N`.
|
||||
- **VER-TAURI-004** — Tant que le frontend n'est pas publié comme package npm, sa version est mise à jour uniquement aux jalons significatifs retenus par le projet, au minimum lorsque cela est nécessaire pour alpha, beta, RC ou stable.
|
||||
|
||||
## Corrections des deltas déjà livrés
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/studies/000-README.md -->
|
||||
<!-- version: 11 -->
|
||||
<!-- version: 12 -->
|
||||
|
||||
# Études
|
||||
|
||||
@@ -65,3 +65,7 @@ Ces documents étudient les POC à réaliser ; ils ne lancent encore aucune impl
|
||||
## Étude de cadrage 0.3.3
|
||||
|
||||
- [`025-V0_3_3_ANDROID_NATIVE_MULTI_ABI_AUDIT.md`](025-V0_3_3_ANDROID_NATIVE_MULTI_ABI_AUDIT.md) — audit de la baseline `0.3.1`, toolchain Android native actuelle, choix ABI/API, packaging APK/AAB et contraintes 16 KB.
|
||||
|
||||
## Étude de cadrage 0.3.5
|
||||
|
||||
- [`026-V0_3_5_WEBTRANSPORT_QUIC_STACK_AUDIT.md`](026-V0_3_5_WEBTRANSPORT_QUIC_STACK_AUDIT.md) — audit de la stable `0.3.4`, comparaison des stacks WebTransport/QUIC actuelles, compatibilité du contrat realtime, TLS, navigateurs et sizing de `0.3.5`.
|
||||
|
||||
300
docs/studies/026-V0_3_5_WEBTRANSPORT_QUIC_STACK_AUDIT.md
Normal file
300
docs/studies/026-V0_3_5_WEBTRANSPORT_QUIC_STACK_AUDIT.md
Normal file
@@ -0,0 +1,300 @@
|
||||
<!-- file: docs/studies/026-V0_3_5_WEBTRANSPORT_QUIC_STACK_AUDIT.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Audit WebTransport/QUIC pour 0.3.5
|
||||
|
||||
## Statut et objet
|
||||
|
||||
Cette étude cadre `0.3.5-alpha.1` à partir de l'archive taggée `v0.3.4`. Elle reste non normative : les décisions opérationnelles retenues pour la version sont portées par `docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md`.
|
||||
|
||||
L'objectif est de déterminer, sur l'état réel de l'écosystème au 2026-09-21, quelle pile WebTransport/QUIC mérite un POC, comment elle se confronte au contrat `game-realtime-transport-lib` livré en `0.3.4`, quelles preuves navigateur/TLS sont réalistes et où doit vivre le fallback WebSocket.
|
||||
|
||||
## Base auditée
|
||||
|
||||
L'archive fournie est annoncée comme le téléchargement ZIP du tag Gitea `v0.3.4` et déclare :
|
||||
|
||||
```text
|
||||
workspace.package.version = 0.3.4
|
||||
17 membres workspace
|
||||
```
|
||||
|
||||
Avant modification, les contrôles statiques exécutables dans l'environnement de génération donnent :
|
||||
|
||||
```text
|
||||
unzip -t : no errors
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 263 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
```
|
||||
|
||||
L'inventaire indépendant confirme :
|
||||
|
||||
```text
|
||||
437 fichiers dans le ZIP
|
||||
267 fichiers Markdown extraits
|
||||
68 fichiers Rust
|
||||
18 Cargo.toml, dont le manifest racine
|
||||
17 membres workspace
|
||||
0 symlink
|
||||
0 chemin absolu ou traversal détecté
|
||||
0 target/, node_modules/, build/ ou gen/android/ généré
|
||||
```
|
||||
|
||||
La sortie utilisateur fournie à l'ouverture de session confirme également `cargo fmt --all -- --check`, les trois audits et `cargo check --workspace` propres sur son checkout `0.3.4`. Son audit Markdown annonce `279` fichiers contre `263` dans le périmètre scanné du ZIP fourni. La baseline taggée reçue reste l'autorité de génération conformément à `CMD-GIT-003` et `CMD-GIT-004`; l'écart est enregistré sans inventer les fichiers locaux absents de l'archive.
|
||||
|
||||
## État hérité de 0.3.4
|
||||
|
||||
Les preuves de `history/0.3.4/` et `deltas/0.3.4/rel.001.md` confirment :
|
||||
|
||||
- `game-realtime-transport-lib` sans Tokio, WebSocket, QUIC, HTTP ni TLS ;
|
||||
- `TransportMessage` binaire opaque et contrat message-oriented ;
|
||||
- split `RealtimeConnection -> Sender + Receiver` ;
|
||||
- fermeture distante propre distincte d'une erreur ;
|
||||
- erreurs transport-neutral ;
|
||||
- backend `game-realtime-websocket-lib` Tokio/tokio-tungstenite ;
|
||||
- tests loopback et robustesse ;
|
||||
- smoke runtime `game-realtime-websocket-smoke` hors harness `#[test]` ;
|
||||
- `beta.1` validée avec 53 tests workspace ;
|
||||
- `rc.1` validée avec 18 tests realtime ciblés, smoke `PASS` et arbre inverse où seul le launcher de smoke consomme le backend WebSocket.
|
||||
|
||||
Cette frontière constitue la baseline de comparaison. `0.3.5` n'a pas besoin de la redessiner avant d'avoir une preuve WebTransport concrète.
|
||||
|
||||
## État du protocole au 2026-09-21
|
||||
|
||||
WebTransport côté navigateur est désormais classé « Baseline 2026 » par MDN : l'API fonctionne sur les versions récentes des principaux navigateurs depuis mars 2026, avec la réserve habituelle sur les versions anciennes et certaines sous-capacités. L'API exige un contexte sécurisé et expose streams bidirectionnels/unidirectionnels fiables ainsi que datagrams non fiables.
|
||||
|
||||
Sources :
|
||||
|
||||
- <https://developer.mozilla.org/en-US/docs/Web/API/WebTransport_API>
|
||||
- <https://developer.mozilla.org/en-US/docs/Web/API/WebTransport>
|
||||
|
||||
Le binding WebTransport over HTTP/3 n'est cependant pas encore un RFC final. `draft-ietf-webtrans-http3-16`, daté du 2026-07-06, est toujours un Internet-Draft en WG Last Call avec statut visé Proposed Standard.
|
||||
|
||||
Source : <https://datatracker.ietf.org/doc/draft-ietf-webtrans-http3/>
|
||||
|
||||
Conséquence pour le POC : l'interopérabilité navigateur est suffisamment réelle pour être testée, mais la version ne doit pas présenter le protocole ni une crate comme une dépendance produit définitivement stabilisée.
|
||||
|
||||
## Candidats Rust actuels
|
||||
|
||||
### Famille `web-transport`
|
||||
|
||||
État observé :
|
||||
|
||||
```text
|
||||
web-transport 0.12.0 (2026-08-20)
|
||||
web-transport-quinn 0.12.1 (2026-08-20)
|
||||
web-transport-wasm 0.6.0 (2026-08)
|
||||
```
|
||||
|
||||
`web-transport` fournit une API générique qui sélectionne :
|
||||
|
||||
```text
|
||||
native -> web-transport-quinn
|
||||
wasm32 -> web-transport-wasm
|
||||
```
|
||||
|
||||
La crate native s'appuie sur Quinn, Rustls, Tokio et expose streams + datagrams. La crate WASM enveloppe l'API WebTransport du navigateur. Le projet amont est sous licence `MIT OR Apache-2.0`.
|
||||
|
||||
Sources :
|
||||
|
||||
- <https://docs.rs/crate/web-transport/latest>
|
||||
- <https://docs.rs/crate/web-transport-quinn/latest>
|
||||
- <https://docs.rs/crate/web-transport-wasm/latest>
|
||||
- <https://github.com/moq-dev/web-transport>
|
||||
|
||||
Point particulièrement pertinent pour `games.sasedev` : la documentation `web-transport` explique explicitement le problème `Send` entre natif et WASM et contourne ce problème par sélection de l'implémentation selon la cible. Cela rejoint la décision prise en `0.3.4` de ne pas imposer `Send` aux futures du contrat transport-neutral.
|
||||
|
||||
La voie WASM impose actuellement :
|
||||
|
||||
```text
|
||||
--cfg=web_sys_unstable_apis
|
||||
```
|
||||
|
||||
car les bindings WebTransport de `web-sys` restent derrière ce cfg. Ce flag doit être fourni par le build final et ne peut pas être activé par une dépendance. Une éventuelle modification `.cargo/config.toml` devra donc être ciblée sur `wasm32-unknown-unknown`, pas appliquée globalement au workspace.
|
||||
|
||||
### `wtransport`
|
||||
|
||||
État observé :
|
||||
|
||||
```text
|
||||
wtransport 0.7.2 (2026-08-11)
|
||||
```
|
||||
|
||||
La crate fournit une implémentation WebTransport/HTTP3 pure Rust, client et serveur natifs, fondée notamment sur Quinn, Rustls et Tokio. Sa documentation est plus riche et elle fournit des helpers explicites pour certificat self-signed, hash SHA-256 et contraintes W3C. La branche `0.7.x` annonce un MSRV au moins Rust 1.88 dans la metadata consultée de `0.7.1`; la compilation exacte de `0.7.2` reste à prouver sur le toolchain du projet.
|
||||
|
||||
Sources :
|
||||
|
||||
- <https://docs.rs/crate/wtransport/latest>
|
||||
- <https://docs.rs/wtransport/latest/wtransport/>
|
||||
|
||||
Sa limite pour ce projet est l'absence d'une façade Rust WASM équivalente : l'intégration navigateur documentée utilise directement l'API JavaScript `WebTransport`. Cela reste viable pour un serveur Rust, mais apporte moins de valeur au POC si l'objectif est aussi de challenger le contrat Rust commun sur `wasm32`.
|
||||
|
||||
### Quinn / H3 de plus bas niveau
|
||||
|
||||
Quinn est la base QUIC commune à plusieurs stacks, mais l'utiliser directement imposerait de réimplémenter le binding WebTransport/HTTP3, la négociation et les détails de session déjà possédés par les crates spécialisées.
|
||||
|
||||
Cette voie reste un recours si les wrappers retenus bloquent une exigence essentielle ; elle n'est pas retenue comme premier POC, conformément au principe d'éviter une infrastructure disproportionnée.
|
||||
|
||||
## Choix de POC retenu
|
||||
|
||||
La famille `web-transport` est retenue en premier pour `0.3.5`, avec :
|
||||
|
||||
```text
|
||||
game-realtime-webtransport-lib
|
||||
-> web-transport
|
||||
-> native: web-transport-quinn
|
||||
-> wasm32: web-transport-wasm
|
||||
```
|
||||
|
||||
Raisons :
|
||||
|
||||
- façade native + WASM déjà pensée par l'amont ;
|
||||
- alignement direct avec la contrainte `!Send` possible du contrat `0.3.4` ;
|
||||
- serveur natif et client natif/WASM disponibles dans la même famille ;
|
||||
- streams et datagrams disponibles pour le POC ;
|
||||
- Quinn/Rustls/Tokio restent contenus dans le backend concret ;
|
||||
- licence compatible avec le dépôt ;
|
||||
- activité amont récente en août 2026.
|
||||
|
||||
`wtransport` reste le candidat de repli technique prioritaire si `web-transport` échoue sur une exigence concrète de `alpha.2` à `alpha.4`, notamment configuration TLS, lifecycle ou interop navigateur. Un échec d'implémentation ne justifie pas de basculer silencieusement : le plan et le delta doivent enregistrer la raison.
|
||||
|
||||
## Compatibilité avec le contrat 0.3.4
|
||||
|
||||
### Chemin fiable
|
||||
|
||||
Le contrat commun est message-oriented alors qu'un stream QUIC/WebTransport est un flux d'octets fiable, ordonné et flow-controlled. La différence de sémantique est réelle mais ne nécessite pas de modifier `RealtimeConnection`.
|
||||
|
||||
Le POC retiendra un stream bidirectionnel principal par connexion logique :
|
||||
|
||||
```text
|
||||
WebTransport session
|
||||
-> one primary bidirectional reliable stream
|
||||
-> bounded backend framing
|
||||
-> TransportMessage
|
||||
```
|
||||
|
||||
Le framing interne candidat est :
|
||||
|
||||
```text
|
||||
u32 big-endian payload length
|
||||
payload bytes
|
||||
```
|
||||
|
||||
avec une limite produit vérifiée avant allocation/écriture. Ce framing sert uniquement à reconstruire les frontières `TransportMessage` sur un byte stream ; il n'est pas le futur wire codec métier, ne porte aucune version de protocole joueur/room et reste privé au backend.
|
||||
|
||||
Le client ouvre le stream principal ; le serveur l'accepte avant de considérer la `RealtimeConnection` établie. Ce choix conserve l'ordre des messages et permet au split commun de mapper naturellement le côté write/read du même stream.
|
||||
|
||||
### Datagrams
|
||||
|
||||
Les datagrams WebTransport sont non fiables, non ordonnés et non flow-controlled. Ils ne satisfont donc pas le contrat fiable/ordonné livré en `0.3.4`.
|
||||
|
||||
Ils seront exercés séparément dans le POC, sans élargir `RealtimeConnection` et sans créer une capability commune tant qu'un second consommateur réel et un besoin sémantique durable ne sont pas démontrés.
|
||||
|
||||
Une mesure backend-spécifique peut utiliser la session amont directement ou une surface expérimentale locale au launcher de mesure. Elle ne doit pas devenir une API durable uniquement pour permettre le benchmark.
|
||||
|
||||
## TLS et certificats de développement
|
||||
|
||||
Le navigateur impose une URL `https://` vers le serveur WebTransport. L'option `serverCertificateHashes` permet de faire confiance à un certificat connu sans PKI publique lorsque la connexion est dédiée.
|
||||
|
||||
La documentation MDN impose notamment pour ce mode :
|
||||
|
||||
- hash SHA-256 ;
|
||||
- certificat X.509v3 ;
|
||||
- validité totale inférieure à deux semaines ;
|
||||
- date courante dans la période de validité ;
|
||||
- ECDSA P-256 comme choix interopérable minimal.
|
||||
|
||||
Source : <https://developer.mozilla.org/en-US/docs/Web/API/WebTransport/WebTransport>
|
||||
|
||||
`web-transport-quinn` fournit `ClientBuilder::with_server_certificate_hashes`, ce qui permet de reprendre la même stratégie de pinning côté client natif sans désactiver la validation TLS.
|
||||
|
||||
Source : <https://docs.rs/web-transport-quinn/latest/web_transport_quinn/struct.ClientBuilder.html>
|
||||
|
||||
Le POC doit donc privilégier une identité self-signed courte générée pour localhost et un pin de hash explicite. Une API « dangerous/no certificate verification » ne devient pas le chemin normal du smoke.
|
||||
|
||||
Aucun certificat privé, clé privée durable ou secret ne doit être commité.
|
||||
|
||||
## Plateformes
|
||||
|
||||
### Linux natif
|
||||
|
||||
Cible de référence pour :
|
||||
|
||||
- serveur local UDP/QUIC ;
|
||||
- client natif ;
|
||||
- tests loopback déterministes ;
|
||||
- smoke runtime hors harness ;
|
||||
- benchmark local borné.
|
||||
|
||||
### Navigateur / WASM
|
||||
|
||||
Cible obligatoire du POC parce que WebTransport apporte une valeur spécifique au navigateur. Deux preuves distinctes sont nécessaires :
|
||||
|
||||
1. compilation `wasm32-unknown-unknown` du chemin Rust choisi ;
|
||||
2. interop runtime d'un navigateur récent avec le serveur Rust local.
|
||||
|
||||
Le smoke navigateur ne doit pas être confondu avec un simple `cargo check` WASM.
|
||||
|
||||
### Android
|
||||
|
||||
La pile native Quinn/Rustls rend Android plausible, mais `0.3.5-alpha.1` ne le déclare pas validé. Le plan réserve au minimum un contrôle de compilation ciblé si la dépendance choisie ne force pas une réouverture disproportionnée du pipeline Android.
|
||||
|
||||
Aucun changement Java/Gradle/JNI n'est prévu pour le POC ; la matrice quatre ABI `0.3.3` n'est donc pas rejouée par cérémonie.
|
||||
|
||||
### macOS / iOS
|
||||
|
||||
La trajectoire est documentée mais non validée en l'absence d'environnement Apple. Une compatibilité supposée depuis Quinn/Rustls ne doit pas être présentée comme un smoke réel.
|
||||
|
||||
## Fallback WebSocket
|
||||
|
||||
Le fallback est retenu au niveau composition/application du POC, pas dans le gameplay et pas dans `game-realtime-transport-lib`.
|
||||
|
||||
La preuve visée est :
|
||||
|
||||
```text
|
||||
attempt WebTransport
|
||||
success -> use WebTransport path
|
||||
classified establishment failure / unsupported path -> WebSocket baseline
|
||||
```
|
||||
|
||||
Le POC doit également permettre de forcer chaque branche afin de vérifier le fallback de façon déterministe. Il ne doit pas créer de registry dynamique, `TransportManager` générique ni système de plugins.
|
||||
|
||||
Aucune règle n'impose encore que cette logique devienne une crate réutilisable : un launcher technique suffit tant qu'un second consommateur réel ne justifie pas l'extraction.
|
||||
|
||||
## Mesures retenues
|
||||
|
||||
Les mesures minimales sont :
|
||||
|
||||
- temps d'établissement ;
|
||||
- RTT de petits payloads ;
|
||||
- débit sur payloads bornés ;
|
||||
- plusieurs messages en vol ;
|
||||
- comparaison WebSocket vs stream WebTransport fiable ;
|
||||
- comparaison datagram uniquement si la preuve datagram est effectivement réalisée ;
|
||||
- coût opérationnel observé : certificat, UDP, port, debug et build WASM.
|
||||
|
||||
Les résultats loopback sont décrits comme des mesures locales contrôlées. Ils ne seront jamais extrapolés en gains Internet/mobile sans test réseau correspondant.
|
||||
|
||||
CPU/mémoire peuvent être relevés si la méthode est stable, mais ne sont pas une gate de release.
|
||||
|
||||
## Risques principaux
|
||||
|
||||
- protocole HTTP/3 WebTransport encore en Internet-Draft ;
|
||||
- APIs amont actives mais encore susceptibles de casser ;
|
||||
- `web_sys_unstable_apis` imposé au build WASM ;
|
||||
- contraintes de certificats plus lourdes que la baseline `ws://` ;
|
||||
- UDP parfois bloqué par réseau, firewall ou infrastructure ;
|
||||
- browser smoke nécessitant plusieurs processus/outils locaux ;
|
||||
- framing message interne nécessaire sur le stream fiable ;
|
||||
- différences de close/reset entre session WebTransport et stream principal ;
|
||||
- dépendances crypto natives pouvant compliquer certains targets ;
|
||||
- Android plausible mais non prouvé ;
|
||||
- benchmark loopback trop bruité pour porter seul une décision produit.
|
||||
|
||||
## Conclusion de cadrage
|
||||
|
||||
Le POC est viable et justifie `0.3.5`, mais le forecast initial du prompt est trop grossier pour la règle de 15 à 30 minutes par delta. En particulier, backend natif, robustesse, smoke runtime, WASM, interop navigateur/TLS, fallback et mesures ne doivent pas être agrégés en deux grosses alpha.
|
||||
|
||||
Le plan actif découpe ces preuves en tranches verticales indépendantes et ajoute une consolidation explicite avant RC, conformément à `SESSION-009` et `VER-PHASE-010`.
|
||||
39
history/0.3.4/alpha.1.md
Normal file
39
history/0.3.4/alpha.1.md
Normal file
@@ -0,0 +1,39 @@
|
||||
<!-- file: history/0.3.4/alpha.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Historique 0.3.4-alpha.1
|
||||
|
||||
## Statut
|
||||
|
||||
`0.3.4-alpha.1` a été validée par l'utilisateur le 2026-09-21 après application du delta sur son checkout issu de la stable `0.3.3`.
|
||||
|
||||
Aucun `alpha.1.fix.N` n'est requis. La suite peut ouvrir `0.3.4-alpha.2` et matérialiser l'API transport-neutral planifiée.
|
||||
|
||||
## Nettoyage et gates statiques
|
||||
|
||||
L'utilisateur a d'abord exécuté :
|
||||
|
||||
```text
|
||||
cargo clean
|
||||
Removed 57247 files, 28.5GiB total
|
||||
```
|
||||
|
||||
Puis les audits et gates Rust ont tous terminé avec succès :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 260 file(s))
|
||||
Distribution layout audit: clean (49 required path(s), 8 forbidden path(s) absent)
|
||||
cargo fmt --all: clean
|
||||
cargo fmt --all -- --check: clean
|
||||
cargo check --workspace: clean
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings: clean
|
||||
```
|
||||
|
||||
La reconstruction complète après `cargo clean` confirme notamment le workspace à `0.3.4-alpha.1` sur les moteurs, jeux, adapters Desktop/Android/WASM/Tauri et bibliothèques communes.
|
||||
|
||||
## Conséquence
|
||||
|
||||
La migration de gouvernance et le cadrage de `0.3.4` sont acceptés. `alpha.2` peut ajouter uniquement le contrat commun realtime, sans Tokio, Tungstenite ni backend WebSocket ; ces dépendances restent réservées à la tranche suivante.
|
||||
48
history/0.3.4/alpha.2.md
Normal file
48
history/0.3.4/alpha.2.md
Normal file
@@ -0,0 +1,48 @@
|
||||
<!-- file: history/0.3.4/alpha.2.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Historique 0.3.4-alpha.2
|
||||
|
||||
## Statut
|
||||
|
||||
`0.3.4-alpha.2` a été validée par l'utilisateur le 2026-09-21. Le contrat transport-neutral compile dans le workspace, passe Clippy strict et ses sept tests ciblés sont propres.
|
||||
|
||||
Aucun `alpha.2.fix.N` n'est requis. La suite peut ouvrir `0.3.4-alpha.3` et introduire le backend WebSocket Tokio/tokio-tungstenite planifié.
|
||||
|
||||
## Gates statiques et Rust
|
||||
|
||||
La gate fournie est propre :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 262 file(s))
|
||||
Distribution layout audit: clean (49 required path(s), 8 forbidden path(s) absent)
|
||||
cargo fmt --all: clean
|
||||
cargo fmt --all -- --check: clean
|
||||
cargo check --workspace: clean
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings: clean
|
||||
```
|
||||
|
||||
Le workspace compilé porte `0.3.4-alpha.2`, y compris `game-realtime-transport-lib`.
|
||||
|
||||
## Tests du contrat transport
|
||||
|
||||
La commande :
|
||||
|
||||
```text
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
```
|
||||
|
||||
termine avec :
|
||||
|
||||
```text
|
||||
7 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
|
||||
```
|
||||
|
||||
Les tests couvrent le payload binaire possédé, le payload vide, la distinction message/fermeture propre, le split sender/receiver, les futures associées de send/receive/close et les catégories d'erreur transport-neutral.
|
||||
|
||||
## Conséquence
|
||||
|
||||
La frontière commune est acceptée sans Tokio, Tungstenite ni runtime concret. `alpha.3` peut ajouter une crate backend séparée qui implémente ce contrat, tout en conservant le gameplay et les moteurs indépendants du backend WebSocket.
|
||||
60
history/0.3.4/alpha.3.fix.1.md
Normal file
60
history/0.3.4/alpha.3.fix.1.md
Normal file
@@ -0,0 +1,60 @@
|
||||
<!-- file: history/0.3.4/alpha.3.fix.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Historique 0.3.4-alpha.3.fix.1
|
||||
|
||||
## Statut
|
||||
|
||||
`0.3.4-alpha.3.fix.1` a été validée par l'utilisateur le 2026-09-21. Le correctif de manifeste ferme le défaut de `alpha.3` et valide effectivement le backend WebSocket prévu par cette tranche.
|
||||
|
||||
Aucun nouveau fix de `alpha.3` n'est requis. La suite peut ouvrir `0.3.4-alpha.4` pour les limites, timeouts et cas négatifs planifiés.
|
||||
|
||||
## Gates statiques et Rust
|
||||
|
||||
La gate fournie est propre :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 265 file(s))
|
||||
Distribution layout audit: clean (49 required path(s), 8 forbidden path(s) absent)
|
||||
cargo fmt --all: clean
|
||||
cargo fmt --all -- --check: clean
|
||||
cargo check --workspace: clean
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings: clean
|
||||
```
|
||||
|
||||
Le workspace compilé porte `0.3.4-alpha.3.fix.1`, y compris `game-realtime-transport-lib` et `game-realtime-websocket-lib`.
|
||||
|
||||
## Tests
|
||||
|
||||
Le contrat transport-neutral reste propre :
|
||||
|
||||
```text
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
7 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
|
||||
```
|
||||
|
||||
Le backend WebSocket compile et son test d'intégration localhost passe :
|
||||
|
||||
```text
|
||||
cargo test -p game-realtime-websocket-lib --all-targets --all-features
|
||||
unit tests: 0 passed; 0 failed
|
||||
loopback: 1 passed; 0 failed
|
||||
```
|
||||
|
||||
Le loopback couvre le round-trip binaire dans les deux sens et la fermeture propre distante.
|
||||
|
||||
## Graphe de dépendances
|
||||
|
||||
`cargo tree -p game-realtime-websocket-lib --edges normal` confirme la frontière attendue :
|
||||
|
||||
- `game-realtime-websocket-lib` dépend directement de `game-realtime-transport-lib`, `futures-util 0.3.34`, `tokio 1.53.1`, `tokio-tungstenite 0.30.0` et `tracing 0.1.44` ;
|
||||
- `tokio-tungstenite 0.30.0` apporte `tungstenite 0.30.0` ;
|
||||
- aucune pile TLS `native-tls`/`rustls` n'apparaît dans le graphe normal ;
|
||||
- aucune crate gameplay ou moteur n'est introduite comme dépendance du backend.
|
||||
|
||||
## Conséquence
|
||||
|
||||
La baseline WebSocket de `alpha.3` est désormais réellement validée après son fix de manifeste. `alpha.4` peut ajouter la robustesse produit sans rouvrir l'API transport-neutral ni introduire de protocole session/gameplay.
|
||||
62
history/0.3.4/alpha.4.md
Normal file
62
history/0.3.4/alpha.4.md
Normal file
@@ -0,0 +1,62 @@
|
||||
<!-- file: history/0.3.4/alpha.4.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Historique 0.3.4-alpha.4
|
||||
|
||||
## Statut
|
||||
|
||||
`0.3.4-alpha.4` a été validée par l'utilisateur le 2026-09-21. Les limites, deadlines et cas négatifs du backend WebSocket compilent dans le workspace, passent Clippy strict et tous les tests ciblés sont propres.
|
||||
|
||||
Aucun `alpha.4.fix.N` n'est requis. La revue suivant cette gate a néanmoins identifié qu'aucun smoke runtime distinct du harness de test n'avait encore été exécuté. La suite ouvre donc `0.3.4-alpha.5` pour cette preuve avant la beta.
|
||||
|
||||
## Gates statiques et Rust
|
||||
|
||||
La gate fournie est propre :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 267 file(s))
|
||||
Distribution layout audit: clean (49 required path(s), 8 forbidden path(s) absent)
|
||||
cargo fmt --all: clean
|
||||
cargo fmt --all -- --check: clean
|
||||
cargo check --workspace: clean
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings: clean
|
||||
```
|
||||
|
||||
Le workspace compilé porte `0.3.4-alpha.4`, y compris `game-realtime-transport-lib` et `game-realtime-websocket-lib`.
|
||||
|
||||
## Tests transport et WebSocket
|
||||
|
||||
Le contrat transport-neutral reste propre :
|
||||
|
||||
```text
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
7 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
|
||||
```
|
||||
|
||||
Le backend WebSocket valide ensuite :
|
||||
|
||||
```text
|
||||
unit tests: 5 passed; 0 failed
|
||||
loopback: 1 passed; 0 failed
|
||||
robustness: 5 passed; 0 failed
|
||||
```
|
||||
|
||||
Les onze tests WebSocket couvrent notamment les defaults et invariants de configuration, les mappings capacité/backpressure, le round-trip binaire et close propre, les tailles hors limite, Text interdit, peer drop abrupt et timeout de handshake silencieux.
|
||||
|
||||
## Graphe de dépendances
|
||||
|
||||
`cargo tree -p game-realtime-websocket-lib --edges normal` confirme toujours la frontière attendue :
|
||||
|
||||
- `game-realtime-websocket-lib` dépend directement de `game-realtime-transport-lib`, `futures-util 0.3.34`, `tokio 1.53.1`, `tokio-tungstenite 0.30.0` et `tracing 0.1.44` ;
|
||||
- `tokio-tungstenite 0.30.0` apporte `tungstenite 0.30.0` ;
|
||||
- aucune pile TLS `native-tls`/`rustls` n'apparaît dans le graphe normal ;
|
||||
- aucune crate gameplay ou moteur ne dépend du backend WebSocket.
|
||||
|
||||
## Limite de la preuve
|
||||
|
||||
Cette gate est suffisante pour valider techniquement `alpha.4`, mais elle reste composée d'audits, compilation, lint et tests Cargo. Même le round-trip localhost est exécuté sous `#[test]`.
|
||||
|
||||
La validation runtime opérateur manque encore. `alpha.5` doit donc fournir un exécutable de smoke séparé qui utilise uniquement l'API publique sur un vrai socket loopback et dont le code de sortie atteste le résultat.
|
||||
85
history/0.3.4/alpha.5.md
Normal file
85
history/0.3.4/alpha.5.md
Normal file
@@ -0,0 +1,85 @@
|
||||
<!-- file: history/0.3.4/alpha.5.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Historique 0.3.4-alpha.5
|
||||
|
||||
## Statut
|
||||
|
||||
`0.3.4-alpha.5` a été validée par l'utilisateur le 2026-09-21. La gate complète est propre et le smoke runtime WebSocket distinct du harness de test affiche explicitement `game-realtime-websocket-smoke: PASS` avec sortie zéro.
|
||||
|
||||
Aucun `alpha.5.fix.N` n'est requis. Les critères d'entrée en beta sont satisfaits ; la suite ouvre `0.3.4-beta.1` sans nouveau scope fonctionnel.
|
||||
|
||||
## Gates statiques et Rust
|
||||
|
||||
La gate fournie est propre :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 269 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
cargo fmt --all: clean
|
||||
cargo fmt --all -- --check: clean
|
||||
cargo check --workspace: clean
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings: clean
|
||||
```
|
||||
|
||||
Le workspace compilé porte `0.3.4-alpha.5`, y compris le launcher `game-realtime-websocket-smoke`.
|
||||
|
||||
## Tests transport et WebSocket
|
||||
|
||||
Le contrat transport-neutral reste propre :
|
||||
|
||||
```text
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
7 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
|
||||
```
|
||||
|
||||
Le backend WebSocket valide :
|
||||
|
||||
```text
|
||||
unit tests: 5 passed; 0 failed
|
||||
loopback: 1 passed; 0 failed
|
||||
robustness: 5 passed; 0 failed
|
||||
```
|
||||
|
||||
Les scénarios couvrent notamment les invariants de configuration, les mappings capacité/backpressure, le round-trip binaire, le close propre, les tailles hors limite, Text interdit, peer drop abrupt et timeout de handshake silencieux.
|
||||
|
||||
## Smoke runtime
|
||||
|
||||
La commande :
|
||||
|
||||
```bash
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
```
|
||||
|
||||
s'exécute avec succès hors harness `#[test]` sur un port loopback éphémère. Le log fourni montre :
|
||||
|
||||
```text
|
||||
realtime WebSocket smoke started
|
||||
WebSocket listener bound address=127.0.0.1:42419
|
||||
loopback endpoint bound endpoint="ws://127.0.0.1:42419/"
|
||||
WebSocket peer accepted peer=127.0.0.1:42388
|
||||
WebSocket client connected endpoint="ws://127.0.0.1:42419/"
|
||||
game-realtime-websocket-smoke: PASS
|
||||
realtime WebSocket smoke passed
|
||||
```
|
||||
|
||||
Le port est alloué dynamiquement ; les valeurs ci-dessus décrivent uniquement cette exécution de validation.
|
||||
|
||||
## Graphe du smoke
|
||||
|
||||
`cargo tree -p game-realtime-websocket-smoke --edges normal` confirme que le launcher dépend directement de :
|
||||
|
||||
- `game-logging-lib` ;
|
||||
- `game-realtime-transport-lib` ;
|
||||
- `game-realtime-websocket-lib` ;
|
||||
- Tokio ;
|
||||
- tracing.
|
||||
|
||||
Le backend WebSocket reste sur Tokio `1.53.1`, `tokio-tungstenite 0.30.0` et Tungstenite `0.30.0`. Aucune pile TLS n'apparaît dans le graphe normal fourni.
|
||||
|
||||
## Conclusion alpha
|
||||
|
||||
La phase alpha a désormais produit et validé le contrat transport-neutral, le backend WebSocket, la robustesse, les cas négatifs et la preuve runtime publique. La beta peut se limiter à la validation large et à la recherche de régressions, conformément au plan actif.
|
||||
100
history/0.3.4/beta.1.md
Normal file
100
history/0.3.4/beta.1.md
Normal file
@@ -0,0 +1,100 @@
|
||||
<!-- file: history/0.3.4/beta.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Historique 0.3.4-beta.1
|
||||
|
||||
## Statut
|
||||
|
||||
`0.3.4-beta.1` a été validée par l'utilisateur le 2026-09-21. La gate large est entièrement propre : audits statiques, formatage, check, Clippy strict, test workspace complet, smoke runtime WebSocket et graphes de dépendances.
|
||||
|
||||
Aucun `beta.1.fix.N` n'est requis. Le comportement peut être gelé en `0.3.4-rc.1` sans créer de beta supplémentaire artificielle.
|
||||
|
||||
## Gates statiques et compilation
|
||||
|
||||
La sortie utilisateur confirme :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 271 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
cargo fmt --all: clean
|
||||
cargo fmt --all -- --check: clean
|
||||
cargo check --workspace: clean
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings: clean
|
||||
```
|
||||
|
||||
Le workspace compile intégralement sous `0.3.4-beta.1`, y compris les deux crates realtime et `game-realtime-websocket-smoke`.
|
||||
|
||||
## Test workspace complet
|
||||
|
||||
La commande :
|
||||
|
||||
```bash
|
||||
cargo test --workspace --all-targets --all-features
|
||||
```
|
||||
|
||||
est propre avec **53 tests réussis, 0 échec** sur l'ensemble des suites exécutées.
|
||||
|
||||
La gate couvre notamment :
|
||||
|
||||
- `engine-v1-common` : 8 tests ;
|
||||
- `engine-v1-platform-api` : 3 tests ;
|
||||
- `engine-v1-sdl` : 5 tests ;
|
||||
- `game-android-entrypoint` : 2 tests ;
|
||||
- `game-assets-lib` : 2 tests ;
|
||||
- `game-logging-lib` : 1 test d'intégration ;
|
||||
- `game-realtime-transport-lib` : 7 tests ;
|
||||
- `game-realtime-websocket-lib` : 5 tests unitaires, 1 loopback et 5 tests de robustesse ;
|
||||
- `game-reflex-poc` : 4 tests ;
|
||||
- `game-snake-poc` : 5 tests ;
|
||||
- `game-snake-poc-wasm` : 5 tests.
|
||||
|
||||
Les autres targets bin/lib de runners et hosts concernés s'exécutent également sans échec avec zéro test lorsqu'ils ne possèdent pas de suite propre.
|
||||
|
||||
## Smoke runtime
|
||||
|
||||
La commande :
|
||||
|
||||
```bash
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
```
|
||||
|
||||
passe hors harness `#[test]` et affiche :
|
||||
|
||||
```text
|
||||
game-realtime-websocket-smoke: PASS
|
||||
```
|
||||
|
||||
Le log de validation montre un bind éphémère `127.0.0.1:39077`, une connexion cliente réelle, l'accept serveur et la fermeture propre. Ce numéro de port décrit uniquement cette exécution ; le smoke continue d'utiliser `127.0.0.1:0`.
|
||||
|
||||
## Graphe de dépendances
|
||||
|
||||
`cargo tree -p game-realtime-websocket-lib --edges normal` confirme le backend attendu :
|
||||
|
||||
- `futures-util 0.3.34` ;
|
||||
- `game-realtime-transport-lib` ;
|
||||
- Tokio `1.53.1` ;
|
||||
- `tokio-tungstenite 0.30.0` / Tungstenite `0.30.0` ;
|
||||
- tracing.
|
||||
|
||||
Aucune pile TLS n'apparaît dans le graphe normal fourni.
|
||||
|
||||
L'arbre inverse :
|
||||
|
||||
```bash
|
||||
cargo tree -i game-realtime-websocket-lib --workspace --edges normal
|
||||
```
|
||||
|
||||
ne contient qu'un consommateur workspace :
|
||||
|
||||
```text
|
||||
game-realtime-websocket-smoke
|
||||
```
|
||||
|
||||
Aucune crate sous `crates/games/` ou `crates/engines/` ne dépend donc du backend WebSocket.
|
||||
|
||||
## Conclusion beta
|
||||
|
||||
La beta valide la baseline fonctionnelle et ses frontières sans régression transverse. La RC peut se limiter au gel de publication, à la documentation durable, au changelog, à l'historique et à la préparation du prompt `0.3.5`.
|
||||
83
history/0.3.4/rc.1.md
Normal file
83
history/0.3.4/rc.1.md
Normal file
@@ -0,0 +1,83 @@
|
||||
<!-- file: history/0.3.4/rc.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Historique 0.3.4-rc.1
|
||||
|
||||
## Statut
|
||||
|
||||
`0.3.4-rc.1` a été validée par l'utilisateur le 2026-09-21. La candidate gelée passe les audits, la compilation workspace, Clippy strict, les suites realtime ciblées, le smoke runtime et le contrôle inverse des dépendances sans défaut de publication.
|
||||
|
||||
Aucun `rc.1.fix.N` n'est requis. La candidate peut être promue mécaniquement vers la stable `0.3.4`.
|
||||
|
||||
## Gates statiques et compilation
|
||||
|
||||
La sortie utilisateur confirme :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 277 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
cargo fmt --all: clean
|
||||
cargo fmt --all -- --check: clean
|
||||
cargo check --workspace: clean
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings: clean
|
||||
```
|
||||
|
||||
Le workspace compilé porte `0.3.4-rc.1`, y compris les deux crates realtime et le launcher de smoke.
|
||||
|
||||
## Tests realtime
|
||||
|
||||
Le contrat transport-neutral passe :
|
||||
|
||||
```text
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
7 passed; 0 failed
|
||||
```
|
||||
|
||||
Le backend WebSocket passe ses trois ensembles de tests :
|
||||
|
||||
```text
|
||||
unit tests: 5 passed; 0 failed
|
||||
loopback: 1 passed; 0 failed
|
||||
robustness: 5 passed; 0 failed
|
||||
```
|
||||
|
||||
La RC valide donc **18 tests realtime ciblés, 0 échec**. Le full workspace de 53 tests avait déjà été validé en `beta.1` et n'a pas été répété puisque la RC n'a modifié aucun code Rust ni dépendance fonctionnelle.
|
||||
|
||||
## Smoke runtime
|
||||
|
||||
La commande :
|
||||
|
||||
```bash
|
||||
cargo run -p game-realtime-websocket-smoke
|
||||
```
|
||||
|
||||
passe hors harness `#[test]` et affiche :
|
||||
|
||||
```text
|
||||
game-realtime-websocket-smoke: PASS
|
||||
```
|
||||
|
||||
Le log fourni montre un bind loopback éphémère, l'accept serveur, la connexion cliente, l'échange prévu et la fermeture propre. Le port observé `46581` est propre à cette exécution ; le smoke continue de binder `127.0.0.1:0`.
|
||||
|
||||
## Frontière de dépendances
|
||||
|
||||
L'arbre inverse :
|
||||
|
||||
```bash
|
||||
cargo tree -i game-realtime-websocket-lib --workspace --edges normal
|
||||
```
|
||||
|
||||
ne contient qu'un consommateur workspace :
|
||||
|
||||
```text
|
||||
game-realtime-websocket-smoke
|
||||
```
|
||||
|
||||
Aucune crate moteur ou gameplay ne dépend donc du backend WebSocket.
|
||||
|
||||
## Conclusion RC
|
||||
|
||||
Le comportement realtime et sa documentation de publication sont gelés et validés. La stable peut se limiter aux changements mécaniques de version, changelog, roadmap, clôture du plan, historique RC et delta final.
|
||||
39
history/0.3.5/alpha.1.md
Normal file
39
history/0.3.5/alpha.1.md
Normal file
@@ -0,0 +1,39 @@
|
||||
<!-- file: history/0.3.5/alpha.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Historique 0.3.5-alpha.1
|
||||
|
||||
## Statut
|
||||
|
||||
`0.3.5-alpha.1` a été validée par l'utilisateur le 2026-09-21. Le cadrage WebTransport/QUIC, le plan actif et la synchronisation de version sont acceptés sans fix.
|
||||
|
||||
La suite peut ouvrir `0.3.5-alpha.2` pour introduire le backend natif minimal et prouver l'établissement TLS/WebTransport avec pinning de certificat.
|
||||
|
||||
## Gates fournies
|
||||
|
||||
Les commandes exécutées par l'utilisateur :
|
||||
|
||||
```text
|
||||
cargo fmt --all -- --check
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
cargo check --workspace
|
||||
```
|
||||
|
||||
ont terminé proprement avec :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 282 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
cargo check --workspace: clean
|
||||
```
|
||||
|
||||
Le workspace compilé porte `0.3.5-alpha.1`, y compris les deux POC Tauri affichés dans la sortie finale.
|
||||
|
||||
## Conséquence
|
||||
|
||||
Le forecast révisé de `docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md` est retenu. `alpha.2` reste limitée à la crate backend, aux dépendances/features minimales, à l'identité TLS/hash pinning et à l'établissement natif ; streams fiables, framing et contrat commun restent réservés à `alpha.3`.
|
||||
59
history/0.3.5/alpha.2.fix.1.md
Normal file
59
history/0.3.5/alpha.2.fix.1.md
Normal file
@@ -0,0 +1,59 @@
|
||||
<!-- file: history/0.3.5/alpha.2.fix.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Historique 0.3.5-alpha.2.fix.1
|
||||
|
||||
## Statut
|
||||
|
||||
`0.3.5-alpha.2.fix.1` a été validée par l'utilisateur le 2026-09-21. Le correctif ferme l'unique défaut de la gate `alpha.2` : la comparaison d'adresse distante accepte désormais la représentation IPv4-mapped IPv6 remontée par Quinn sans relâcher la comparaison du port ou d'une adresse réellement différente.
|
||||
|
||||
Aucun autre fix n'est requis. La suite peut ouvrir directement `0.3.5-alpha.3` pour le stream bidirectionnel principal, le framing fiable borné et l'adaptation au contrat commun.
|
||||
|
||||
## Gates statiques et compilation
|
||||
|
||||
Les commandes utilisateur ont terminé proprement :
|
||||
|
||||
```text
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
```
|
||||
|
||||
La sortie confirme :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 286 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
cargo check --workspace: clean
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings: clean
|
||||
```
|
||||
|
||||
Le workspace compilé porte `0.3.5-alpha.2.fix.1`, y compris `game-realtime-webtransport-lib` et les autres targets workspace affichées par la gate.
|
||||
|
||||
## Tests WebTransport
|
||||
|
||||
La commande :
|
||||
|
||||
```bash
|
||||
cargo test -p game-realtime-webtransport-lib --all-targets --all-features
|
||||
```
|
||||
|
||||
est entièrement propre :
|
||||
|
||||
```text
|
||||
unit tests: 4 passed; 0 failed
|
||||
establishment integration tests: 2 passed; 0 failed
|
||||
```
|
||||
|
||||
Le test positif `pinned_client_and_server_establish_a_loopback_session` passe désormais, tout comme le rejet d'un mauvais pin. La preuve d'établissement natif TLS/WebTransport de `alpha.2` est donc fermée.
|
||||
|
||||
## Conséquence
|
||||
|
||||
Le forecast reste inchangé fonctionnellement : `alpha.3` peut introduire un unique stream bidirectionnel fiable principal, le framing privé `u32` big-endian + payload borné avant allocation, `RealtimeConnection`/sender/receiver, le round-trip multi-message ordonné et la fermeture distante de base.
|
||||
92
history/0.3.5/alpha.3.md
Normal file
92
history/0.3.5/alpha.3.md
Normal file
@@ -0,0 +1,92 @@
|
||||
<!-- file: history/0.3.5/alpha.3.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Historique 0.3.5-alpha.3
|
||||
|
||||
## Statut
|
||||
|
||||
`0.3.5-alpha.3` a été validée par l'utilisateur le 2026-09-21. Le stream fiable principal, le framing privé borné et l'implémentation du contrat realtime commun sont donc fermés sans correctif.
|
||||
|
||||
La suite peut ouvrir `0.3.5-alpha.4` pour la robustesse et le lifecycle sans modifier le scope de `alpha.5`, qui reste le smoke natif hors harness.
|
||||
|
||||
## Gates statiques et compilation
|
||||
|
||||
Les commandes utilisateur ont terminé proprement :
|
||||
|
||||
```text
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
python3 scripts/audit_rust_workspace_rules.py
|
||||
python3 scripts/audit_markdown_tables.py README.md RULES.md ROADMAP.md CHANGELOG.md docs prompts crates Android Web deltas history
|
||||
python3 scripts/audit_distribution_layout.py
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
```
|
||||
|
||||
La sortie confirme :
|
||||
|
||||
```text
|
||||
General Rust rule audit: clean
|
||||
Rust export completeness audit: 0 candidate(s)
|
||||
games.sasedev workspace audit: clean
|
||||
Markdown table audit: clean (5 table(s), 289 file(s))
|
||||
Distribution layout audit: clean (50 required path(s), 8 forbidden path(s) absent)
|
||||
cargo check --workspace: clean
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings: clean
|
||||
```
|
||||
|
||||
Le workspace compilé porte `0.3.5-alpha.3`, y compris `game-realtime-webtransport-lib` et l'ensemble des targets workspace affichées par la gate.
|
||||
|
||||
## Tests du contrat realtime commun
|
||||
|
||||
La commande :
|
||||
|
||||
```bash
|
||||
cargo test -p game-realtime-transport-lib --all-targets --all-features
|
||||
```
|
||||
|
||||
est entièrement propre :
|
||||
|
||||
```text
|
||||
7 passed; 0 failed
|
||||
```
|
||||
|
||||
Les preuves couvrent notamment split, fermeture distante propre, payload vide/binaire et stabilité des catégories d'erreurs du contrat commun.
|
||||
|
||||
## Tests WebTransport
|
||||
|
||||
La commande :
|
||||
|
||||
```bash
|
||||
cargo test -p game-realtime-webtransport-lib --all-targets --all-features
|
||||
```
|
||||
|
||||
est entièrement propre :
|
||||
|
||||
```text
|
||||
unit tests: 5 passed; 0 failed
|
||||
establishment integration tests: 2 passed; 0 failed
|
||||
realtime_connection integration tests: 1 passed; 0 failed
|
||||
```
|
||||
|
||||
Le test `primary_stream_round_trip_is_binary_ordered_and_closes_cleanly` confirme le stream bidirectionnel principal, les messages binaires ordonnés et le FIN propre du chemin fiable.
|
||||
|
||||
## Graphe de dépendances
|
||||
|
||||
La commande :
|
||||
|
||||
```bash
|
||||
cargo tree -i game-realtime-webtransport-lib --workspace --edges normal
|
||||
```
|
||||
|
||||
ne remonte que :
|
||||
|
||||
```text
|
||||
game-realtime-webtransport-lib v0.3.5-alpha.3
|
||||
```
|
||||
|
||||
Le backend concret ne fuite donc pas vers une crate engine, gameplay ou application existante.
|
||||
|
||||
## Conséquence
|
||||
|
||||
`alpha.4` peut matérialiser limites configurables, deadlines, flow-control/backpressure observable, reset/abort/drop/cancellation, cas négatifs de framing et mapping d'erreurs. Le smoke natif public reste séparé en `alpha.5` afin de conserver des deltas de taille bornée.
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: history/000-README.md -->
|
||||
<!-- version: 1 -->
|
||||
<!-- version: 2 -->
|
||||
|
||||
# Historique transitoire validé
|
||||
|
||||
@@ -10,13 +10,14 @@ Cette arborescence conserve l'historique durable des jalons transitoires effecti
|
||||
```text
|
||||
history/
|
||||
└── X.Y.Z/
|
||||
├── 0-pre.N.md
|
||||
├── 0-pre.N.fix.M.md
|
||||
├── 1-alpha.N.md
|
||||
├── 2-beta.N.md
|
||||
└── 3-rc.N.md
|
||||
├── alpha.N.md
|
||||
├── alpha.N.fix.M.md
|
||||
├── beta.N.md
|
||||
├── beta.N.fix.M.md
|
||||
├── rc.N.md
|
||||
└── rc.N.fix.M.md
|
||||
```
|
||||
|
||||
Un fichier n'est créé qu'après validation du jalon qu'il décrit et devient ensuite immuable.
|
||||
Un fichier n'est créé qu'après validation du jalon qu'il décrit et devient ensuite immuable. Les répertoires historiques antérieurs à `0.3.4` conservent volontairement leurs anciens labels `0-pre.N`, `1-alpha.N`, `2-beta.N` et `3-rc.N` ; ils ne sont ni renommés ni réécrits.
|
||||
|
||||
Le fichier delta correspondant décrit la livraison candidate et les commandes attendues ; le fichier `history/` décrit le résultat validé.
|
||||
|
||||
404
prompts/006-V0_3_5_START_PROMPT.md
Normal file
404
prompts/006-V0_3_5_START_PROMPT.md
Normal file
@@ -0,0 +1,404 @@
|
||||
<!-- file: prompts/006-V0_3_5_START_PROMPT.md -->
|
||||
<!-- version: 2 -->
|
||||
|
||||
# Prompt de démarrage `0.3.5` — POC WebTransport/QUIC et fallback WebSocket
|
||||
|
||||
## 1. Base exacte et cible
|
||||
|
||||
Partir uniquement de la version stable/taggée :
|
||||
|
||||
```text
|
||||
v0.3.4
|
||||
```
|
||||
|
||||
Ce prompt est destiné à être utilisé depuis la stable taggée `v0.3.4`. Une archive annoncée comme téléchargement ZIP du tag Gitea est autoritaire conformément à `CMD-GIT-003` et `CMD-GIT-004` ; l'absence de `.git` n'est pas un défaut.
|
||||
|
||||
Version cible :
|
||||
|
||||
```text
|
||||
0.3.5
|
||||
```
|
||||
|
||||
Première tranche attendue :
|
||||
|
||||
```text
|
||||
0.3.5-alpha.1
|
||||
```
|
||||
|
||||
`alpha.1` est obligatoirement le gate de cadrage : audit de la stable, recherche des stacks WebTransport/QUIC actuelles, requirements, sizing, risques, matrice plateforme, validations et création du plan actif avant développement lourd.
|
||||
|
||||
## 2. Sources de vérité
|
||||
|
||||
Lire intégralement, dans cet ordre :
|
||||
|
||||
```text
|
||||
RULES.md
|
||||
ROADMAP.md
|
||||
CHANGELOG.md
|
||||
docs/000-README.md
|
||||
```
|
||||
|
||||
Puis au minimum :
|
||||
|
||||
```text
|
||||
docs/rules/RULES_GENERAL.md
|
||||
docs/rules/RULES_RUST.md
|
||||
docs/rules/RULES_PROJECT.md
|
||||
docs/rules/RULES_DOCUMENTATION.md
|
||||
docs/rules/FILE_CONTRACTS.md
|
||||
docs/rules/VERSION_WORKFLOW.md
|
||||
docs/rules/RULES_COMMANDS.md
|
||||
docs/rules/RULES_VALIDATION_MATRIX.md
|
||||
docs/rules/RULES_SESSION_PLANNING.md
|
||||
docs/rules/PROMPT_STRUCTURE.md
|
||||
```
|
||||
|
||||
Transmission réseau et plateforme :
|
||||
|
||||
```text
|
||||
docs/architecture/012-MODULAR_LAYERING_AND_OWNERSHIP.md
|
||||
docs/architecture/013-NETWORK_AND_SERVER_ARCHITECTURE.md
|
||||
docs/architecture/015-PLATFORM_POC_ARCHITECTURE.md
|
||||
docs/studies/006-REALTIME_MULTIPLAYER_SERVER_STUDY.md
|
||||
docs/studies/009-PLATFORM_POC_CANDIDATES.md
|
||||
docs/studies/011-PLATFORM_POC_VALIDATION_MATRIX.md
|
||||
docs/studies/012-PLATFORM_POC_SEQUENCE.md
|
||||
docs/plans/004-V0_3_4_REALTIME_TRANSPORT_WEBSOCKET_PLAN.md
|
||||
history/0.3.4/
|
||||
deltas/0.3.4/
|
||||
crates/common/game-realtime-transport-lib/README.md
|
||||
crates/common/game-realtime-websocket-lib/README.md
|
||||
crates/common/game-realtime-websocket-lib/USAGE.md
|
||||
```
|
||||
|
||||
Le plan `0.3.4` est historique une fois la stable publiée ; `0.3.5-alpha.1` crée `docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md`, qui devient alors l'autorité prévisionnelle active.
|
||||
|
||||
## 3. État hérité attendu de 0.3.4
|
||||
|
||||
La stable `0.3.4` doit laisser une frontière realtime déjà testée :
|
||||
|
||||
```text
|
||||
transport-neutral contract
|
||||
↓
|
||||
WebSocket backend
|
||||
↓
|
||||
future wire/session layers
|
||||
```
|
||||
|
||||
État attendu :
|
||||
|
||||
- `game-realtime-transport-lib` sans Tokio, WebSocket, QUIC, HTTP ou TLS ;
|
||||
- payload binaire opaque `TransportMessage` ;
|
||||
- split `RealtimeConnection -> Sender + Receiver` ;
|
||||
- fermeture distante propre distinguée des erreurs ;
|
||||
- catégories d'erreur transport-neutral ;
|
||||
- `game-realtime-websocket-lib` comme backend de référence Tokio/tokio-tungstenite ;
|
||||
- client `ws://`, listener serveur, close propre, limites, deadlines et tracing ;
|
||||
- aucun runtime Tokio privé ni task backend détachée ;
|
||||
- aucun moteur ou gameplay dépendant du backend WebSocket ;
|
||||
- `game-realtime-websocket-smoke` comme preuve runtime localhost hors harness `#[test]` ;
|
||||
- aucune politique TLS directe, aucun wire codec final, aucune session joueur/room et aucune simulation authoritative.
|
||||
|
||||
La stable `0.3.4` hérite des validations réellement obtenues pendant `beta.1` et `rc.1` : workspace complet validé en beta, gates de publication realtime ciblées validées en RC, smoke runtime `PASS` et frontière de dépendances confirmée. Relire `history/0.3.4/` et `deltas/0.3.4/rel.001.md` comme preuves détaillées au lieu d'inventer ou d'extrapoler des validations supplémentaires.
|
||||
|
||||
## 4. Mission 0.3.5
|
||||
|
||||
Évaluer puis prototyper **WebTransport/QUIC** comme second transport realtime en conservant WebSocket comme baseline/fallback de référence.
|
||||
|
||||
Le résultat recherché n'est pas « remplacer WebSocket parce que QUIC est plus moderne ». `0.3.5` doit répondre avec des preuves :
|
||||
|
||||
- un backend WebTransport/QUIC est-il viable sur les plateformes réellement visées ?
|
||||
- peut-il consommer la frontière `game-realtime-transport-lib` sans la déformer artificiellement ?
|
||||
- quelles différences de sémantique existent entre WebSocket et WebTransport : streams, datagrams, ordering, reliability, fermeture, backpressure ?
|
||||
- le bénéfice mesuré justifie-t-il la complexité TLS/HTTP3/QUIC et les contraintes navigateur/infrastructure ?
|
||||
- quel fallback WebSocket est réellement nécessaire et à quel niveau doit-il être choisi ?
|
||||
|
||||
La frontière conceptuelle reste :
|
||||
|
||||
```text
|
||||
transport
|
||||
↓
|
||||
wire codec
|
||||
↓
|
||||
session protocol
|
||||
↓
|
||||
synchronization
|
||||
↓
|
||||
authoritative simulation
|
||||
```
|
||||
|
||||
`0.3.5` reste concentrée sur le transport et la comparaison. Elle ne doit pas profiter du POC QUIC pour concevoir prématurément les couches supérieures.
|
||||
|
||||
## 5. Recherche alpha.1 obligatoire
|
||||
|
||||
Avant de choisir une crate ou d'écrire un backend, vérifier sur les sources actuelles :
|
||||
|
||||
- état et versions des crates Rust candidates WebTransport/QUIC ;
|
||||
- maintenance, MSRV, Tokio/runtime, licence et dépendances ;
|
||||
- support client et serveur natif ;
|
||||
- possibilité réelle côté navigateur/WASM et relation éventuelle avec l'API WebTransport du navigateur ;
|
||||
- support Android natif pertinent pour la trajectoire du projet ;
|
||||
- exigences TLS/certificats et contraintes de développement localhost ;
|
||||
- HTTP/3/QUIC sous-jacent et besoins UDP ;
|
||||
- compatibilité Debian Stable pour un serveur auto-hébergé ;
|
||||
- interaction avec reverse proxy/edge lorsqu'elle est réellement nécessaire ;
|
||||
- support des streams bidirectionnels/unidirectionnels et des datagrams ;
|
||||
- comportement de backpressure, limites, fermeture et cancellation ;
|
||||
- maturité des APIs de test loopback/local ;
|
||||
- disponibilité et stabilité des APIs navigateur sur les cibles réellement testables.
|
||||
|
||||
Ne pas figer dans ce prompt un nom de crate WebTransport/QUIC : `alpha.1` doit comparer l'état actuel de l'écosystème au moment du développement.
|
||||
|
||||
## 6. Question centrale : compatibilité du contrat 0.3.4
|
||||
|
||||
Le contrat `game-realtime-transport-lib` a été volontairement minimal et orienté « messages binaires fiables/ordonnés » parce que WebSocket était le premier backend.
|
||||
|
||||
`alpha.1` doit déterminer si :
|
||||
|
||||
1. WebTransport peut implémenter ce contrat proprement via un stream fiable sans perte significative ;
|
||||
2. les datagrams WebTransport apportent une capability réellement utile qui ne rentre pas dans ce contrat ;
|
||||
3. une capability supplémentaire doit être séparée au lieu d'élargir `RealtimeConnection` ;
|
||||
4. le POC doit garder deux chemins distincts afin de comparer avant toute extraction commune.
|
||||
|
||||
Interdiction de modifier `game-realtime-transport-lib` uniquement pour rendre les APIs WebSocket et QUIC esthétiquement identiques. Toute évolution du contrat commun doit être motivée par au moins deux consommateurs réels et un besoin sémantique partagé.
|
||||
|
||||
## 7. Scope inclus
|
||||
|
||||
Le scope candidat comprend :
|
||||
|
||||
- audit/recherche WebTransport/QUIC ;
|
||||
- plan `0.3.5` et matrice de preuves ;
|
||||
- second backend transport si la stack retenue est suffisamment viable ;
|
||||
- preuve client/serveur locale ou équivalent reproductible ;
|
||||
- payload binaire opaque réutilisant le contrat commun lorsque cela est sémantiquement correct ;
|
||||
- fermeture/cancellation, limites, timeouts et erreurs du nouveau backend ;
|
||||
- tracing séparé ;
|
||||
- preuve du fallback WebSocket ou d'un choix de transport au niveau approprié, uniquement si le POC le justifie ;
|
||||
- comparaison mesurée WebSocket vs WebTransport/QUIC ;
|
||||
- documentation des contraintes plateforme/TLS/infrastructure ;
|
||||
- smoke runtime distinct du harness de test si nécessaire pour prouver le nouveau chemin.
|
||||
|
||||
## 8. Hors scope
|
||||
|
||||
Sauf nécessité strictement démontrée par le POC transport, ne pas introduire :
|
||||
|
||||
- Uroburas Mode 3 ;
|
||||
- matchmaking ;
|
||||
- auth complète ;
|
||||
- protocole session joueur/room ;
|
||||
- codec wire définitif ;
|
||||
- snapshot/delta gameplay ;
|
||||
- prediction/reconciliation ou rollback ;
|
||||
- simulation authoritative ;
|
||||
- persistence gameplay ;
|
||||
- Redis/NATS/Kafka ;
|
||||
- sharding/regions ;
|
||||
- CDN/edge complexe ;
|
||||
- orchestration Kubernetes ;
|
||||
- remplacement de la stack Web/API Actix ;
|
||||
- framework générique multi-transport massif.
|
||||
|
||||
## 9. Mesures et comparaison
|
||||
|
||||
Le POC doit définir avant mesure les métriques réellement utiles. Candidats :
|
||||
|
||||
- temps d'établissement ;
|
||||
- latence aller-retour de petits payloads ;
|
||||
- débit sur payloads bornés ;
|
||||
- overhead observable ;
|
||||
- comportement sous plusieurs messages en vol ;
|
||||
- coût CPU/mémoire si la mesure est suffisamment reproductible ;
|
||||
- différence fiable/ordonnée vs datagram lorsque ce dernier est réellement disponible ;
|
||||
- complexité opérationnelle : certificats, UDP, ports, reverse proxy et debugging.
|
||||
|
||||
Un benchmark loopback ne suffit pas à conclure sur Internet/mobile. Il sert à vérifier l'implémentation et à comparer des overheads locaux contrôlés. Toute conclusion produit doit distinguer mesure locale, comportement protocolaire connu et test réseau externe réellement effectué.
|
||||
|
||||
Les benchmarks doivent rester bornés, reproductibles et ne pas devenir une infrastructure de performance disproportionnée pour un POC.
|
||||
|
||||
## 10. Fallback WebSocket
|
||||
|
||||
WebSocket reste la baseline fonctionnelle jusqu'à preuve contraire.
|
||||
|
||||
Le fallback ne doit pas être codé dans le gameplay. `alpha.1` doit décider l'ownership du choix de transport parmi :
|
||||
|
||||
- composition/application ;
|
||||
- client/platform adapter ;
|
||||
- petit sélecteur technique dédié si deux backends réels le justifient.
|
||||
|
||||
Ne pas créer un `TransportManager`, registry dynamique ou système de plugins uniquement pour choisir entre deux transports POC.
|
||||
|
||||
## 11. Plateformes à challenger
|
||||
|
||||
Le plan `alpha.1` doit expliciter ce qui est réellement testable dans la session :
|
||||
|
||||
- Linux natif : client/server local de référence ;
|
||||
- navigateur/WASM : important pour WebTransport, mais seulement avec une chaîne de test réaliste ;
|
||||
- Android : vérifier la trajectoire et la compatibilité, sans rouvrir le pipeline multi-ABI `0.3.3` si aucun code Android n'est touché ;
|
||||
- iOS/macOS : documenter les contraintes connues mais ne pas bloquer la version en l'absence d'environnement Apple.
|
||||
|
||||
Une plateforme non testée ne doit pas être présentée comme validée.
|
||||
|
||||
## 12. TLS, certificats et sécurité transport
|
||||
|
||||
Contrairement à la baseline locale `ws://`, WebTransport navigateur peut imposer des contraintes de sécurité/certificats. `alpha.1` doit vérifier les exigences actuelles au lieu de les supposer.
|
||||
|
||||
La version peut introduire uniquement la politique minimale nécessaire au POC. Ne pas transformer `0.3.5` en projet PKI complet. Les certificats de développement, s'ils sont nécessaires, restent hors secrets du dépôt et leur génération/installation doit être documentée de façon reproductible.
|
||||
|
||||
Aucune désactivation dangereuse de validation TLS ne devient un chemin produit permanent uniquement pour simplifier un smoke.
|
||||
|
||||
## 13. Documentation README/USAGE
|
||||
|
||||
Appliquer `DOC-CRATE-*` à tout nouveau composant :
|
||||
|
||||
- backend WebTransport/QUIC durable : README probable ;
|
||||
- configuration/workflow/certificats non triviaux : USAGE probablement utile ;
|
||||
- launcher de benchmark/smoke très petit : documentation locale seulement si le plan central ne couvre pas suffisamment son rôle ;
|
||||
- ne jamais créer des fichiers vides ou redondants par cérémonie.
|
||||
|
||||
La documentation propre à la fonctionnalité évolue avec la tranche qui l'introduit ; la RC ne doit pas être utilisée pour reporter toute documentation à la fin.
|
||||
|
||||
## 14. Validation et responsabilité
|
||||
|
||||
Les audits statiques peuvent être exécutés par le générateur. Les builds, tests, benchmarks et smokes finaux restent côté utilisateur conformément à `CMD-BUILD-005` et ne sont jamais déclarés réussis sans sortie réelle.
|
||||
|
||||
Dès qu'un fichier Rust ou Cargo change :
|
||||
|
||||
```bash
|
||||
cargo fmt --all
|
||||
cargo fmt --all -- --check
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
```
|
||||
|
||||
Les tests restent ciblés pendant l'implémentation. `cargo test --workspace --all-targets --all-features` est réservé aux jalons larges planifiés ou lorsqu'une évolution transverse le justifie.
|
||||
|
||||
`cargo tree` est utilisé lorsque les dépendances changent ou lorsqu'une frontière doit être prouvée, pas comme cérémonie à chaque tranche.
|
||||
|
||||
Toute commande nécessitant un `cd` doit être englobée dans un sous-shell `(cd ... && ...)`.
|
||||
|
||||
## 15. Deltas, history, changelog et roadmap
|
||||
|
||||
À partir de `0.3.5`, conserver la nomenclature :
|
||||
|
||||
```text
|
||||
0.3.5-alpha.N
|
||||
0.3.5-alpha.N.fix.M
|
||||
0.3.5-beta.N
|
||||
0.3.5-beta.N.fix.M
|
||||
0.3.5-rc.N
|
||||
0.3.5-rc.N.fix.M
|
||||
0.3.5
|
||||
```
|
||||
|
||||
Chaque delta indique sa base, son scope, les fichiers touchés et les validations attendues.
|
||||
|
||||
`history/0.3.5/<jalon>.md` est créé uniquement par la tranche suivante ou son fix après validation réelle du jalon précédent.
|
||||
|
||||
`CHANGELOG.md` reste normalement silencieux avant la RC. `ROADMAP.md` reste macroscopique et ne change que si le scope, l'ordre ou le statut évolue réellement.
|
||||
|
||||
Un échec fermé d'une tranche produit `<jalon>.fix.N`. Une validation propre permet de poursuivre automatiquement vers la tranche planifiée suivante. Une session doit fermer au minimum une version concrète jusqu'à sa stable ; ne pas s'arrêter volontairement sur une prerelease.
|
||||
|
||||
## 16. Cadrage alpha.1 obligatoire
|
||||
|
||||
Avant développement lourd :
|
||||
|
||||
1. auditer la stable `v0.3.4` et vérifier ses gates/historique ;
|
||||
2. relire le contrat transport et le backend WebSocket réellement livrés ;
|
||||
3. rechercher l'écosystème WebTransport/QUIC actuel ;
|
||||
4. établir une matrice plateforme/runtime/TLS ;
|
||||
5. comparer les stacks candidates et justifier le choix ;
|
||||
6. décider si le contrat transport-neutral reste inchangé ;
|
||||
7. décider ownership physique des nouvelles crates/outils ;
|
||||
8. définir les preuves locales, navigateur éventuel, benchmarks et smokes ;
|
||||
9. définir précisément ce que signifie « fallback WebSocket » dans ce POC ;
|
||||
10. créer `docs/plans/005-V0_3_5_WEBTRANSPORT_QUIC_POC_PLAN.md` ;
|
||||
11. produire un forecast révisé jusqu'à stable et redécouper la version si le scope excède une session raisonnable.
|
||||
|
||||
## 17. Forecast initial non contraignant
|
||||
|
||||
Le forecast ci-dessous est une hypothèse de départ. `alpha.1` doit le réviser à partir des résultats réels et le plan actif devient ensuite l'autorité prévisionnelle.
|
||||
|
||||
### `0.3.5-alpha.1` — audit WebTransport/QUIC et design du POC
|
||||
|
||||
- audit stable `0.3.4` ;
|
||||
- recherche des stacks actuelles ;
|
||||
- matrice plateforme/TLS/runtime ;
|
||||
- challenge du contrat commun ;
|
||||
- stratégie fallback ;
|
||||
- métriques et gates ;
|
||||
- plan actif.
|
||||
|
||||
Aucun backend lourd n'est créé avant fermeture de ces décisions.
|
||||
|
||||
### `0.3.5-alpha.2` — backend minimal et loopback
|
||||
|
||||
Si `alpha.1` confirme la viabilité :
|
||||
|
||||
- créer le backend retenu avec dépendances minimales ;
|
||||
- établir client/server local ;
|
||||
- transporter un payload binaire ;
|
||||
- close/cancellation et erreurs de base ;
|
||||
- tests loopback déterministes ;
|
||||
- tracing dédié.
|
||||
|
||||
Si le contrat commun ne convient pas, documenter le besoin avant de le modifier.
|
||||
|
||||
### `0.3.5-alpha.3` — plateforme/fallback réel
|
||||
|
||||
Selon les résultats :
|
||||
|
||||
- preuve navigateur/WASM si elle est techniquement et opérationnellement réalisable ;
|
||||
- ou preuve native plus complète si le navigateur exige une infrastructure disproportionnée à cette tranche ;
|
||||
- fallback WebSocket au niveau d'ownership retenu ;
|
||||
- tests des deux chemins sans couplage au gameplay.
|
||||
|
||||
Cette tranche peut être fusionnée ou scindée selon TLS/certificats et tooling réellement nécessaires.
|
||||
|
||||
### `0.3.5-alpha.4` — mesures et robustesse conditionnelles
|
||||
|
||||
Si nécessaire :
|
||||
|
||||
- mesures WebSocket vs WebTransport/QUIC ;
|
||||
- streams vs datagrams lorsque réellement supportés ;
|
||||
- limites, timeouts, backpressure et peer drop ;
|
||||
- smoke runtime/benchmark borné ;
|
||||
- décision documentée sur la valeur réelle du second transport.
|
||||
|
||||
Ne pas créer cette tranche si `alpha.2/alpha.3` ferment déjà ces preuves proprement.
|
||||
|
||||
### `0.3.5-beta.1` — validation large
|
||||
|
||||
- workspace complet ;
|
||||
- smokes réellement retenus ;
|
||||
- graphes de dépendances ;
|
||||
- vérification qu'aucun gameplay/engine ne dépend d'un backend concret ;
|
||||
- comparaison et limitations documentées.
|
||||
|
||||
Un défaut fermé produit `beta.1.fix.N`. Une capacité majeure manquante réouvre une alpha.
|
||||
|
||||
### `0.3.5-rc.1` — candidate gelée
|
||||
|
||||
- aucun nouveau comportement volontaire ;
|
||||
- consolidation durable ;
|
||||
- `CHANGELOG.md` ;
|
||||
- `ROADMAP.md` si statut macro à réconcilier ;
|
||||
- historique beta ;
|
||||
- prompt `0.3.6` préparant la consolidation des POC plateforme/réseau ;
|
||||
- gates de publication proportionnelles aux changements depuis beta.
|
||||
|
||||
### `0.3.5` — stable
|
||||
|
||||
Promotion autant que possible mécanique : version stable, historique RC, changelog stable, clôture du plan, roadmap, delta final et ajustement mécanique du prompt `0.3.6`.
|
||||
|
||||
## 18. Critère de réussite produit de 0.3.5
|
||||
|
||||
La version est réussie même si la conclusion est de **ne pas adopter WebTransport immédiatement**, à condition que le POC fournisse une réponse technique solide et reproductible.
|
||||
|
||||
La décision finale doit pouvoir distinguer clairement :
|
||||
|
||||
- WebTransport/QUIC retenu comme second backend utile ;
|
||||
- viable mais reporté faute de bénéfice suffisant ou de contraintes plateforme/infrastructure ;
|
||||
- non viable pour la trajectoire actuelle ;
|
||||
- besoin d'une étude complémentaire explicitement reportée.
|
||||
|
||||
Le résultat ne doit jamais être forcé pour justifier le temps investi dans le POC.
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env python3
|
||||
# file: scripts/audit_distribution_layout.py
|
||||
# version: 17
|
||||
# version: 18
|
||||
|
||||
"""Audit the static distribution layout expected by supported POCs."""
|
||||
|
||||
@@ -24,6 +24,7 @@ FORBIDDEN_PATHS = (
|
||||
|
||||
|
||||
REQUIRED_PATHS = (
|
||||
"crates/apps/game-realtime-websocket-smoke/Cargo.toml",
|
||||
"crates/apps/game-reflex-poc-desktop/Cargo.toml",
|
||||
"crates/apps/game-snake-poc-desktop/Cargo.toml",
|
||||
"crates/apps/game-reflex-poc-tauri/Cargo.toml",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env python3
|
||||
# file: scripts/audit_project_workspace_rules.py
|
||||
# version: 7
|
||||
# version: 8
|
||||
|
||||
"""Audit mechanically verifiable games.sasedev workspace boundaries."""
|
||||
|
||||
@@ -12,7 +12,15 @@ import re
|
||||
import sys
|
||||
import tomllib
|
||||
|
||||
SEMVER = re.compile(r"^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-(?:0-pre|1-alpha|2-beta|3-rc)\.[1-9][0-9]*(?:\.fix\.[1-9][0-9]*)?)?$", re.ASCII)
|
||||
CURRENT_SEMVER = re.compile(
|
||||
r"^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-(?:alpha|beta|rc)\.[1-9][0-9]*(?:\.fix\.[1-9][0-9]*)?)?$",
|
||||
re.ASCII,
|
||||
)
|
||||
LEGACY_MILESTONE_SEMVER = re.compile(
|
||||
r"^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)-(?:0-pre|1-alpha|2-beta|3-rc)\.[1-9][0-9]*(?:\.fix\.[1-9][0-9]*)?$",
|
||||
re.ASCII,
|
||||
)
|
||||
LEGACY_HISTORY_BASE_VERSIONS = frozenset({"0.1.0", "0.2.0", "0.3.0", "0.3.1", "0.3.3"})
|
||||
|
||||
|
||||
def is_generated_path(path: pathlib.Path, root: pathlib.Path) -> bool:
|
||||
@@ -32,7 +40,7 @@ def main() -> int:
|
||||
errors: list[str] = []
|
||||
manifest = tomllib.loads((root / "Cargo.toml").read_text(encoding="utf-8"))
|
||||
workspace_version = manifest.get("workspace", {}).get("package", {}).get("version")
|
||||
if not isinstance(workspace_version, str) or SEMVER.fullmatch(workspace_version) is None:
|
||||
if not isinstance(workspace_version, str) or CURRENT_SEMVER.fullmatch(workspace_version) is None:
|
||||
errors.append("VERSION-001: workspace.package.version does not follow the canonical games.sasedev SemVer scheme")
|
||||
members = manifest.get("workspace", {}).get("members", [])
|
||||
for member in members:
|
||||
@@ -47,7 +55,7 @@ def main() -> int:
|
||||
if version.get("workspace") is not True:
|
||||
errors.append(f"GAME-WS-004: {relative}: table version must use workspace = true")
|
||||
elif isinstance(version, str):
|
||||
if SEMVER.fullmatch(version) is None:
|
||||
if CURRENT_SEMVER.fullmatch(version) is None:
|
||||
errors.append(f"GAME-WS-005: {relative}: explicit crate version does not follow the canonical games.sasedev SemVer scheme")
|
||||
else:
|
||||
errors.append(f"GAME-WS-004: {relative}: crate must inherit or explicitly own a version")
|
||||
@@ -84,7 +92,9 @@ def main() -> int:
|
||||
errors.append(f"DOC-010: invalid history base version directory: {history_path.relative_to(root).as_posix()}")
|
||||
label = filename[:-3]
|
||||
candidate = f"{base_version}-{label}"
|
||||
if SEMVER.fullmatch(candidate) is None:
|
||||
is_current = CURRENT_SEMVER.fullmatch(candidate) is not None
|
||||
is_legacy = base_version in LEGACY_HISTORY_BASE_VERSIONS and LEGACY_MILESTONE_SEMVER.fullmatch(candidate) is not None
|
||||
if not is_current and not is_legacy:
|
||||
errors.append(f"DOC-010: invalid history milestone filename: {history_path.relative_to(root).as_posix()}")
|
||||
|
||||
docs_root = root / "docs"
|
||||
|
||||
Reference in New Issue
Block a user