Ensure each and every feature flags can be used independently (#1455)

Author: tony-iqlusion

.changelog/unreleased/bug-fixes/1454-fix-feature-flags.md

@@ -0,0 +1,2 @@
+- Fix newly introduced `std` and `json-schema` features, and ensure all feature flag can be used independently and in isolation.
+  ([\#1454](https://github.com/informalsystems/tendermint-rs/issues/1454))

.github/workflows/test.yml

@@ -34,32 +34,36 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
-      - run: cargo test-all-features -p tendermint
+      - uses: taiki-e/install-action@cargo-hack
+      - run: cargo test -p tendermint
+      - run: cargo hack test --each-feature -p tendermint
 
   tendermint-rpc:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
-      - run: cargo test-all-features -p tendermint-rpc
+      - uses: taiki-e/install-action@cargo-hack
+      - run: cargo test -p tendermint-rpc
+      - run: cargo hack test --each-feature -p tendermint-rpc
 
   tendermint-proto:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
-      - run: cargo test-all-features -p tendermint-proto
+      - uses: taiki-e/install-action@cargo-hack
+      - run: cargo test -p tendermint-proto
+      - run: cargo hack test --each-feature -p tendermint-proto
 
   tendermint-light-client:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
-      # NOTE: We test with default features to make sure things work without "unstable".
-      - name: Test with default features
-        run: cargo test -p tendermint-light-client
-      - name: Test with all features
-        run: cargo test-all-features -p tendermint-light-client
+      - uses: taiki-e/install-action@cargo-hack
+      - run: cargo test -p tendermint-light-client
+      - run: cargo hack test --each-feature -p tendermint-light-client
 
   # From https://rustwasm.github.io/docs/wasm-bindgen/wasm-bindgen-test/continuous-integration.html#github-actions
   tendermint-light-client-js:

light-client/Cargo.toml

@@ -57,6 +57,7 @@ regex = { version = "1.7.3" }
 
 [dev-dependencies]
 tendermint-testgen = { path = "../testgen", default-features = false }
+tendermint-light-client-verifier = { version = "0.39.0", path = "../light-client-verifier", features = ["rust-crypto"] }
 
 serde_json = { version = "1.0.51", default-features = false }
 gumdrop = { version = "0.8.0", default-features = false }

proto/Cargo.toml

@@ -17,8 +17,8 @@ description = """
 default = []
 std = []
 grpc = ["grpc-server"]
-grpc-server = ["dep:tonic"]
-json-schema = ["dep:schemars"]
+grpc-server = ["dep:tonic", "std"]
+json-schema = ["dep:schemars", "std"]
 borsh = ["dep:borsh"]
 parity-scale-codec = ["dep:parity-scale-codec", "dep:scale-info"]
 

proto/src/lib.rs

@@ -1,6 +1,6 @@
 //! tendermint-proto library gives the developer access to the Tendermint proto-defined structs.
 
-#![cfg_attr(not(any(feature = "grpc-server")), no_std)]
+#![cfg_attr(not(feature = "std"), no_std)]
 #![deny(warnings, trivial_casts, trivial_numeric_casts, unused_import_braces)]
 #![allow(clippy::large_enum_variant)]
 #![forbid(unsafe_code)]

rpc/Cargo.toml

@@ -29,7 +29,13 @@ path = "src/client/bin/main.rs"
 required-features = [ "cli" ]
 
 [features]
-default = ["flex-error/std", "flex-error/eyre_tracer"]
+default = [
+  "flex-error/std",
+  "flex-error/eyre_tracer"
+]
+secp256k1 = [
+  "tendermint/secp256k1"
+]
 cli = [
   "http-client",
   "structopt",
@@ -42,17 +48,20 @@ http-client = [
   "tokio/macros",
   "tracing"
 ]
-secp256k1 = [ "tendermint/secp256k1" ]
 websocket-client = [
   "async-tungstenite",
   "futures",
   "tokio/rt-multi-thread",
-  "tokio/fs",
   "tokio/macros",
   "tokio/sync",
   "tokio/time",
   "tracing"
 ]
+mock-client = [
+  "futures",
+  "tracing",
+  "tokio/macros"
+]
 
 [dependencies]
 tendermint = { version = "0.39.0", default-features = false, path = "../tendermint" }
@@ -92,3 +101,4 @@ tendermint = { version = "0.39.0", default-features = false, path = "../tendermi
 http = { version = "1", default-features = false, features = ["std"] }
 lazy_static = { version = "1.4.0", default-features = false }
 tokio-test = { version = "0.4", default-features = false }
+tokio = { version = "1.0", default-features = false, features = ["rt-multi-thread", "fs"] }

rpc/src/client.rs

@@ -3,15 +3,31 @@
 mod compat;
 pub use compat::CompatMode;
 
-#[cfg(any(feature = "http-client", feature = "websocket-client"))]
+#[cfg(any(
+    feature = "http-client",
+    feature = "websocket-client",
+    feature = "mock-client"
+))]
 mod subscription;
-#[cfg(any(feature = "http-client", feature = "websocket-client"))]
+#[cfg(any(
+    feature = "http-client",
+    feature = "websocket-client",
+    feature = "mock-client"
+))]
 pub use subscription::{Subscription, SubscriptionClient};
 
-#[cfg(any(feature = "http-client", feature = "websocket-client"))]
+#[cfg(any(
+    feature = "http-client",
+    feature = "websocket-client",
+    feature = "mock-client"
+))]
 pub mod sync;
 
-#[cfg(any(feature = "http-client", feature = "websocket-client"))]
+#[cfg(any(
+    feature = "http-client",
+    feature = "websocket-client",
+    feature = "mock-client"
+))]
 mod transport;
 
 #[cfg(feature = "http-client")]
@@ -21,7 +37,7 @@ pub use transport::websocket::{
     self, WebSocketClient, WebSocketClientDriver, WebSocketClientUrl, WebSocketConfig,
 };
 
-#[cfg(any(feature = "http-client", feature = "websocket-client"))]
+#[cfg(feature = "mock-client")]
 pub use transport::mock::{MockClient, MockRequestMatcher, MockRequestMethodMatcher};
 
 use core::fmt;

rpc/src/client/subscription.rs

@@ -90,7 +90,7 @@ impl Stream for Subscription {
 }
 
 impl Subscription {
-    pub(crate) fn new(id: String, query: Query, rx: SubscriptionRx) -> Self {
+    pub fn new(id: String, query: Query, rx: SubscriptionRx) -> Self {
         Self { id, query, rx }
     }
 

rpc/src/client/transport.rs

@@ -1,7 +1,6 @@
 //! Tendermint RPC client implementations for different transports.
 
 mod auth;
-pub mod mock;
 mod router;
 
 macro_rules! perform_with_compat {
@@ -24,5 +23,7 @@ macro_rules! perform_with_compat {
 
 #[cfg(feature = "http-client")]
 pub mod http;
+#[cfg(feature = "mock-client")]
+pub mod mock;
 #[cfg(feature = "websocket-client")]
 pub mod websocket;

rpc/src/lib.rs

@@ -34,13 +34,16 @@ mod prelude;
 
 pub mod client;
 
-#[cfg(any(feature = "http-client", feature = "websocket-client"))]
-pub use client::{
-    Client, MockClient, MockRequestMatcher, MockRequestMethodMatcher, Subscription,
-    SubscriptionClient,
-};
+#[cfg(any(
+    feature = "http-client",
+    feature = "websocket-client",
+    feature = "mock-client"
+))]
+pub use client::{Client, Subscription, SubscriptionClient};
 #[cfg(feature = "http-client")]
 pub use client::{HttpClient, HttpClientUrl};
+#[cfg(feature = "mock-client")]
+pub use client::{MockClient, MockRequestMatcher, MockRequestMethodMatcher};
 #[cfg(feature = "websocket-client")]
 pub use client::{WebSocketClient, WebSocketClientDriver, WebSocketClientUrl, WebSocketConfig};
 

tendermint/Cargo.toml

@@ -57,8 +57,8 @@ ripemd = { version = "0.1.3", optional = true, default-features = false }
 default = ["std", "rust-crypto"]
 std = ["flex-error/std", "clock"]
 clock = ["time/std"]
-secp256k1 = ["k256", "ripemd"]
-rust-crypto = ["sha2", "ed25519-consensus"]
+secp256k1 = ["rust-crypto", "dep:k256", "dep:ripemd"]
+rust-crypto = ["dep:sha2", "dep:ed25519-consensus"]
 
 [dev-dependencies]
 k256 = { version = "0.13", default-features = false, features = ["ecdsa"] }