diff --git a/Cargo.toml b/Cargo.toml index 7d5d794..615f7a5 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,12 +1,12 @@ # file: Cargo.toml -# version: 100 +# version: 101 [workspace] resolver = "3" members = ["crates/ksp-app-config-desk", "crates/ksp-config-lib", "crates/ksp-core-lib", "crates/ksp-logging-lib", "crates/ksp-onchain-transport-lib"] [workspace.package] -version = "0.2.1-pre.4" +version = "0.2.1-pre.4.fix.1" edition = "2024" license = "MIT" repository = "https://git.sasedev.com/Sasedev/khadhroony-solana-project" @@ -15,16 +15,16 @@ publish = false [workspace.dependencies] fs2 = { version = "^0.4" } -serde = { version = "^1.0", features = ["derive"] } +serde = { version = "^1.0" } serde_json = { version = "^1.0" } jsonschema = { version = "^0.49", default-features = false } -reqwest = { version = "^0.13", default-features = false, features = ["rustls"] } +reqwest = { version = "^0.13", default-features = false } solana-pubkey = { version = "^4.3", default-features = false } -tracing = { version = "^0.1", default-features = false, features = ["std"] } -tracing-subscriber = { version = "^0.3", default-features = false, features = ["fmt", "json", "ansi"] } +tracing = { version = "^0.1", default-features = false } +tracing-subscriber = { version = "^0.3", default-features = false } tracing-appender = { version = "^0.2", default-features = false } -tokio = { version = "^1.53", default-features = false, features = ["rt", "rt-multi-thread", "macros", "time"] } -chrono = { version = "^0.4", default-features = false, features = ["std", "now"] } +tokio = { version = "^1.53", default-features = false } +chrono = { version = "^0.4", default-features = false } tauri = { version = "^2.11" } tauri-build = { version = "^2.6" } tauri-plugin-tracing = { version = "^0.3" } diff --git a/crates/ksp-app-config-desk/Cargo.toml b/crates/ksp-app-config-desk/Cargo.toml index 7e1dddd..a4bcd6a 100644 --- a/crates/ksp-app-config-desk/Cargo.toml +++ b/crates/ksp-app-config-desk/Cargo.toml @@ -1,5 +1,5 @@ # file: crates/ksp-app-config-desk/Cargo.toml -# version: 7 +# version: 8 [package] name = "ksp-app-config-desk" @@ -26,12 +26,12 @@ fs2.workspace = true ksp-config-lib = { path = "../ksp-config-lib" } ksp-core-lib = { path = "../ksp-core-lib" } ksp-logging-lib = { path = "../ksp-logging-lib" } -serde.workspace = true +serde = { workspace = true, features = ["derive"] } serde_json.workspace = true tauri.workspace = true tauri-plugin-tracing.workspace = true -chrono.workspace = true -tokio.workspace = true +chrono = { workspace = true, features = ["std", "now"] } +tokio = { workspace = true, features = ["time"] } ts-rs.workspace = true [lints] diff --git a/crates/ksp-config-lib/Cargo.toml b/crates/ksp-config-lib/Cargo.toml index 9092477..65d3265 100644 --- a/crates/ksp-config-lib/Cargo.toml +++ b/crates/ksp-config-lib/Cargo.toml @@ -1,5 +1,5 @@ # file: crates/ksp-config-lib/Cargo.toml -# version: 3 +# version: 4 [package] name = "ksp-config-lib" @@ -10,7 +10,7 @@ repository.workspace = true [dependencies] ksp-core-lib = { path = "../ksp-core-lib" } ksp-logging-lib = { path = "../ksp-logging-lib" } -serde.workspace = true +serde = { workspace = true, features = ["derive"] } serde_json.workspace = true jsonschema.workspace = true diff --git a/crates/ksp-logging-lib/Cargo.toml b/crates/ksp-logging-lib/Cargo.toml index 823de65..a3ad4ea 100644 --- a/crates/ksp-logging-lib/Cargo.toml +++ b/crates/ksp-logging-lib/Cargo.toml @@ -1,5 +1,5 @@ # file: crates/ksp-logging-lib/Cargo.toml -# version: 4 +# version: 5 [package] name = "ksp-logging-lib" @@ -9,12 +9,12 @@ repository.workspace = true [dependencies] ksp-core-lib = { path = "../ksp-core-lib" } -tracing.workspace = true -tracing-subscriber.workspace = true +tracing = { workspace = true, features = ["std"] } +tracing-subscriber = { workspace = true, features = ["fmt", "json", "ansi"] } tracing-appender.workspace = true [dev-dependencies] -tokio.workspace = true +tokio = { workspace = true, features = ["macros", "rt", "rt-multi-thread"] } [lints] workspace = true diff --git a/crates/ksp-onchain-transport-lib/Cargo.toml b/crates/ksp-onchain-transport-lib/Cargo.toml index fa95723..6c154b8 100644 --- a/crates/ksp-onchain-transport-lib/Cargo.toml +++ b/crates/ksp-onchain-transport-lib/Cargo.toml @@ -1,5 +1,5 @@ # file: crates/ksp-onchain-transport-lib/Cargo.toml -# version: 2 +# version: 3 [package] name = "ksp-onchain-transport-lib" @@ -10,10 +10,13 @@ repository.workspace = true [dependencies] ksp-core-lib = { path = "../ksp-core-lib" } ksp-logging-lib = { path = "../ksp-logging-lib" } -reqwest.workspace = true -serde.workspace = true +reqwest = { workspace = true, features = ["rustls"] } +serde = { workspace = true, features = ["derive"] } serde_json.workspace = true -tokio = { workspace = true, features = ["sync"] } +tokio = { workspace = true, features = ["macros", "sync", "time"] } + +[dev-dependencies] +tokio = { workspace = true, features = ["rt"] } [lints] workspace = true diff --git a/crates/ksp-onchain-transport-lib/tests/dependency_boundary.rs b/crates/ksp-onchain-transport-lib/tests/dependency_boundary.rs index bd53abd..8ba6fdf 100644 --- a/crates/ksp-onchain-transport-lib/tests/dependency_boundary.rs +++ b/crates/ksp-onchain-transport-lib/tests/dependency_boundary.rs @@ -1,5 +1,5 @@ // file: crates/ksp-onchain-transport-lib/tests/dependency_boundary.rs -// version: 3 +// version: 4 //! Integration canary for the direct dependency firewall of `ksp-onchain-transport-lib`. @@ -12,6 +12,33 @@ fn transport_manifest_preserves_ksp_dependency_firewall() { } assert!(manifest.contains("ksp-core-lib")); assert!(manifest.contains("ksp-logging-lib")); - assert!(manifest.contains("reqwest.workspace = true")); - assert!(manifest.contains("tokio = { workspace = true, features = [\"sync\"] }")); + assert!(manifest.contains("reqwest = { workspace = true, features = [\"rustls\"] }")); + assert!(manifest.contains("tokio = { workspace = true, features = [\"macros\", \"sync\", \"time\"] }")); + assert!(manifest.contains("[dev-dependencies]")); + assert!(manifest.contains("tokio = { workspace = true, features = [\"rt\"] }")); +} + +#[test] +fn workspace_dependency_table_does_not_activate_consumer_features() { + let manifest_directory = std::path::Path::new(env!("CARGO_MANIFEST_DIR")); + let workspace_root = manifest_directory.parent().and_then(std::path::Path::parent); + assert!(workspace_root.is_some(), "transport crate must have a workspace root"); + let workspace_root = match workspace_root { + std::option::Option::Some(value) => value, + std::option::Option::None => return, + }; + let manifest_path = workspace_root.join("Cargo.toml"); + let manifest = std::fs::read_to_string(manifest_path.as_path()); + assert!(manifest.is_ok(), "workspace manifest must be readable during integration tests"); + let manifest = match manifest { + std::result::Result::Ok(value) => value, + std::result::Result::Err(_) => return, + }; + let workspace_dependencies = manifest.split("[workspace.dependencies]").nth(1).and_then(|tail| tail.split("[workspace.lints.rust]").next()); + assert!(workspace_dependencies.is_some(), "workspace dependencies section must exist"); + let workspace_dependencies = match workspace_dependencies { + std::option::Option::Some(value) => value, + std::option::Option::None => return, + }; + assert!(!workspace_dependencies.contains("features ="), "consumer feature activation must stay in member manifests"); } diff --git a/deltas/0.2.1/pre.004-fix.001.md b/deltas/0.2.1/pre.004-fix.001.md new file mode 100644 index 0000000..54b8e9c --- /dev/null +++ b/deltas/0.2.1/pre.004-fix.001.md @@ -0,0 +1,248 @@ + + + +# Delta `v0.2.1-pre.004-fix.001` + +## Base + +Base attendue : + +```text +v0.2.1-pre.004 +``` + +Version Cargo cible : + +```text +0.2.1-pre.4.fix.1 +``` + +## Objectif + +Corriger la responsabilité Cargo des features externes révélée pendant l'audit de `pre.004`, sans modifier le comportement fonctionnel de la résilience HTTP : + +- conserver au `Cargo.toml` racine la version et les options communes de résolution (`default-features`, etc.) ; +- retirer les activations `features = [...]` de `[workspace.dependencies]` ; +- activer chaque feature dans le manifeste de la crate KSP qui utilise réellement l'API correspondante ; +- distinguer lorsque c'est utile les features de production et celles requises uniquement par les tests ; +- formaliser explicitement cette règle sous `DEP-CARGO-*` ; +- ajouter une canarie empêchant le retour d'une activation de feature consumer dans `[workspace.dependencies]`. + +Ce fix ne modifie pas `ROADMAP.md` : il corrige un contrat Cargo et sa règle normative, pas la roadmap de `0.2.1`. + +## Validation de `pre.004` ayant précédé le fix + +Après application de `pre.004`, le user a exécuté : + +```text +cargo fmt --all : exécuté +cargo check --workspace : OK +cargo clippy --workspace --all-targets : OK +cargo test -p ksp-onchain-transport-lib : OK, 72 tests Transport au total +cargo test --workspace : OK ; 1 test diagnostic ignoré comme prévu +cargo tree -p ksp-onchain-transport-lib -e features : exécuté +cargo tree -p ksp-onchain-transport-lib -e normal : exécuté +``` + +Le problème n'est donc pas un échec fonctionnel de `pre.004`. L'audit `cargo tree -e features` a cependant rendu visible que les features Tokio déclarées au niveau workspace s'appliquaient au graphe Transport en plus de sa feature locale `sync`, ce qui rendait l'ownership des besoins réels trop global. + +## Décision normative + +La politique KSP retenue est désormais explicite : + +```text +[workspace.dependencies] + -> version + -> default-features et autres options communes de résolution + -> aucune activation features = [...] + +crates//Cargo.toml + -> dependency.workspace = true + -> features = [...] nécessaires à ce consumer +``` + +Lorsqu'une feature n'est nécessaire qu'aux tests/benchmarks/examples, son activation appartient à la section de dépendances de développement correspondante. + +Cette politique conserve la centralisation des versions sans transformer le feature-set d'une crate en politique implicite pour tous les autres consumers du workspace. + +## Répartition des features + +### `serde` + +Le root conserve uniquement : + +```toml +serde = { version = "^1.0" } +``` + +La feature `derive` est activée dans les trois crates qui utilisent réellement `serde::Serialize` / `serde::Deserialize` dérivés : + +```text +ksp-app-config-desk +ksp-config-lib +ksp-onchain-transport-lib +``` + +### `reqwest` + +Le root conserve : + +```toml +reqwest = { version = "^0.13", default-features = false } +``` + +`ksp-onchain-transport-lib` active localement : + +```text +rustls +``` + +### `tracing` / `tracing-subscriber` + +Le root conserve les versions avec `default-features = false`. + +Seul `ksp-logging-lib`, propriétaire KSP de ces dépendances, active : + +```text +tracing : std +tracing-subscriber : fmt, json, ansi +``` + +`tracing-appender` ne possédait aucune feature explicite à déplacer. + +### `chrono` + +Le root conserve uniquement la version avec `default-features = false`. + +`ksp-app-config-desk`, seul consumer direct actuel de `chrono::Utc::now`, active localement : + +```text +std, now +``` + +### `tokio` + +Le root devient : + +```toml +tokio = { version = "^1.53", default-features = false } +``` + +Les activations sont réparties selon l'usage réel : + +```text +ksp-app-config-desk + dependencies : time + +ksp-logging-lib + dev-dependencies : macros, rt, rt-multi-thread + +ksp-onchain-transport-lib + dependencies : macros, sync, time + dev-dependencies : rt +``` + +Pour Transport : + +- `sync` couvre `Notify`, `Semaphore` et `OwnedSemaphorePermit` ; +- `time` couvre `sleep_until` / `Instant` ; +- `macros` est une dépendance de production car `pool.rs` utilise `tokio::select!` ; +- `rt` est requis par `#[tokio::test]` et reste donc activé uniquement côté développement ; +- aucun besoin Transport actuel ne justifie `rt-multi-thread`. + +## Règles KSP + +`docs/rules/RULES_DEPENDENCIES.md` passe de la version `11` à `12`. + +`DEP-CARGO-003` précise maintenant que les features d'usage ne sont pas activées sous `[workspace.dependencies]` et appartiennent aux manifests consumers. + +Nouvelle règle `DEP-CARGO-006` : une feature requise uniquement par tests/benchmarks/examples doit être activée dans la section de dépendances de développement appropriée ; l'unification Cargo ne transfère pas cet ownership au root. + +## Canarie Cargo + +`crates/ksp-onchain-transport-lib/tests/dependency_boundary.rs` vérifie désormais aussi : + +- le feature-set direct attendu de `reqwest` et `tokio` pour Transport ; +- la séparation du `tokio/rt` de test sous `[dev-dependencies]` ; +- l'absence de toute chaîne `features =` dans la section `[workspace.dependencies]` du manifeste racine. + +Cette canarie complète le firewall Transport existant sans introduire de nouvelle dépendance d'audit. + +## Version Cargo + +Le fix modifie plusieurs manifests et donc le contrat de build : + +```text +0.2.1-pre.4 -> 0.2.1-pre.4.fix.1 +``` + +Toutes les crates KSP continuent d'hériter `version.workspace = true`. + +## Fichiers ajoutés + +```text +deltas/0.2.1/pre.004-fix.001.md +``` + +## Fichiers modifiés + +```text +Cargo.toml +crates/ksp-app-config-desk/Cargo.toml +crates/ksp-config-lib/Cargo.toml +crates/ksp-logging-lib/Cargo.toml +crates/ksp-onchain-transport-lib/Cargo.toml +crates/ksp-onchain-transport-lib/tests/dependency_boundary.rs +docs/rules/RULES_DEPENDENCIES.md +``` + +## Fichiers supprimés + +Aucun. + +## Graphe de dépendances + +Aucune crate externe n'est ajoutée ou retirée. Le fix modifie en revanche volontairement les feature-sets directs par consumer ; les audits Cargo doivent donc être rejoués après application. + +Pour Transport, vérifier au minimum : + +```bash +cargo tree -p ksp-onchain-transport-lib +cargo tree -p ksp-onchain-transport-lib -d +cargo tree -p ksp-onchain-transport-lib -e features +cargo tree -p ksp-onchain-transport-lib -e normal +``` + +Il est également utile de vérifier les consumers dont les features ont été relocalisées : + +```bash +cargo tree -p ksp-app-config-desk -e features +cargo tree -p ksp-config-lib -e features +cargo tree -p ksp-logging-lib -e features +``` + +## Validation du fix + +Le sandbox de préparation ne dispose pas de `cargo`/`rustc`. Les validations Rust du correctif ne sont donc pas déclarées réussies ici. + +Après application : + +```bash +cargo fmt --all +cargo check --workspace +cargo clippy --workspace --all-targets +cargo test -p ksp-onchain-transport-lib +cargo test --workspace +``` + +Puis exécuter les `cargo tree` indiqués ci-dessus afin de confirmer que chaque crate expose uniquement les features directes qu'elle possède, sous réserve de l'unification transitive normale de Cargo au niveau du build effectif. + +## Suite + +Après validation et commit de ce fix, `0.2.1` reprend avec : + +```text +v0.2.1-pre.005 +``` + +Le périmètre fonctionnel prévu de `pre.005` reste inchangé : exécuteur HTTP JSON-RPC réel et quatre méthodes canari typées. diff --git a/docs/rules/RULES_DEPENDENCIES.md b/docs/rules/RULES_DEPENDENCIES.md index 8e55952..0f843a4 100644 --- a/docs/rules/RULES_DEPENDENCIES.md +++ b/docs/rules/RULES_DEPENDENCIES.md @@ -1,5 +1,5 @@ - + # Règles des dépendances KSP @@ -27,9 +27,10 @@ Elles complètent les règles Rust générales et le graphe de `docs/architectur - **DEP-CARGO-001** — Toute dépendance externe utilisée par une crate membre du workspace est déclarée une seule fois dans le `Cargo.toml` racine sous `[workspace.dependencies]`. - **DEP-CARGO-002** — Une crate membre consomme une dépendance centralisée avec `.workspace = true` et ne redéclare pas localement sa version. -- **DEP-CARGO-003** — Les options communes de résolution telles que `default-features` et la contrainte de version sont définies au niveau `[workspace.dependencies]`. Une crate membre n'ajoute localement que des features réellement propres à son usage lorsqu'elles sont nécessaires et compatibles avec l'héritage Cargo. +- **DEP-CARGO-003** — Les options communes de résolution telles que `default-features` et la contrainte de version sont définies au niveau `[workspace.dependencies]`. Les features d'usage ne sont pas activées dans cette table commune : chaque crate membre active localement uniquement les features nécessaires à son propre code avec ` = { workspace = true, features = [...] }`. - **DEP-CARGO-004** — Lorsqu'une génération majeure/mineure compatible est retenue, KSP exprime explicitement l'intention sous forme caret `^M.m` (par exemple `^4.3`) plutôt qu'avec une écriture patch telle que `4.3.0`. Même si Cargo interprète aussi par défaut cette dernière comme une contrainte compatible caret, KSP normalise la syntaxe pour rendre l'intention manifeste. Un pin exact `=M.m.p` ou un bornage différent requiert une justification explicite. - **DEP-CARGO-005** — Le `Cargo.lock` résout la version patch concrète à l'intérieur de la contrainte du workspace ; cette résolution ne remplace pas la politique de version déclarée dans le manifeste racine. +- **DEP-CARGO-006** — Lorsqu'une feature externe n'est nécessaire qu'aux tests/benchmarks/examples d'une crate, son activation appartient à la section de dépendances de développement correspondante plutôt qu'aux dépendances de production. L'unification des features effectuée par Cargo lors d'un build ne transfère pas cet ownership vers le `Cargo.toml` racine. ## Codecs wire et cohérence des versions