ci: run clippy on features separately to find issues (#2866)

Co-authored-by: Cijo Thomas <[email protected]>

Author: bantonsson

.github/workflows/ci.yml

@@ -58,7 +58,10 @@ jobs:
         submodules: true
     - uses: dtolnay/rust-toolchain@stable
       with:
-        components: rustfmt
+        components: rustfmt, clippy
+    - uses: taiki-e/install-action@v2
+      with:
+          tool: cargo-hack
     - uses: arduino/setup-protoc@v3
       with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}

examples/tracing-grpc/Cargo.toml

@@ -22,7 +22,7 @@ opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["rt-tokio"]
 opentelemetry-stdout = { workspace = true, features = ["trace"] }
 prost = { workspace = true }
 tokio = { workspace = true, features = ["full"] }
-tonic = { workspace = true, features = ["server", "codegen", "channel", "prost"] }
+tonic = { workspace = true, features = ["server", "codegen", "channel", "prost", "router"] }
 
 [build-dependencies]
 tonic-build = { workspace = true }

opentelemetry-otlp/src/exporter/tonic/mod.rs

@@ -145,6 +145,8 @@ impl Default for TonicExporterBuilder {
 }
 
 impl TonicExporterBuilder {
+    // This is for clippy to work with only the grpc-tonic feature enabled
+    #[allow(unused)]
     fn build_channel(
         self,
         signal_endpoint_var: &str,

opentelemetry-otlp/src/lib.rs

@@ -370,6 +370,8 @@ pub struct NoExporterBuilderSet;
 ///
 /// Allowing access to [TonicExporterBuilder] specific configuration methods.
 #[cfg(feature = "grpc-tonic")]
+// This is for clippy to work with only the grpc-tonic feature enabled
+#[allow(unused)]
 #[derive(Debug, Default)]
 pub struct TonicExporterBuilderSet(TonicExporterBuilder);
 

opentelemetry-otlp/tests/integration_test/src/lib.rs

@@ -1,4 +1,10 @@
 pub mod logs_asserter;
+#[cfg(any(
+    feature = "hyper-client",
+    feature = "reqwest-client",
+    feature = "reqwest-blocking-client",
+    feature = "tonic-client"
+))]
 pub mod metric_helpers;
 pub mod test_utils;
 pub mod trace_asserter;

opentelemetry-sdk/Cargo.toml

@@ -43,7 +43,7 @@ pprof = { version = "0.14", features = ["flamegraph", "criterion"] }
 [features]
 default = ["trace", "metrics", "logs", "internal-logs"]
 trace = ["opentelemetry/trace", "rand", "percent-encoding"]
-jaeger_remote_sampler = ["trace", "opentelemetry-http", "http", "serde", "serde_json", "url"]
+jaeger_remote_sampler = ["trace", "opentelemetry-http", "http", "serde", "serde_json", "url", "experimental_async_runtime"]
 logs = ["opentelemetry/logs", "serde_json"]
 spec_unstable_logs_enabled = ["logs", "opentelemetry/spec_unstable_logs_enabled"]
 metrics = ["opentelemetry/metrics", "glob"]
@@ -52,11 +52,11 @@ experimental_async_runtime = []
 rt-tokio = ["tokio", "tokio-stream", "experimental_async_runtime"]
 rt-tokio-current-thread = ["tokio", "tokio-stream", "experimental_async_runtime"]
 internal-logs = ["tracing"]
-experimental_metrics_periodicreader_with_async_runtime = ["metrics"]
+experimental_metrics_periodicreader_with_async_runtime = ["metrics", "experimental_async_runtime"]
 spec_unstable_metrics_views = ["metrics"]
-experimental_logs_batch_log_processor_with_async_runtime = ["logs"]
+experimental_logs_batch_log_processor_with_async_runtime = ["logs", "experimental_async_runtime"]
 experimental_logs_concurrent_log_processor = ["logs"]
-experimental_trace_batch_span_processor_with_async_runtime = ["trace"]
+experimental_trace_batch_span_processor_with_async_runtime = ["trace", "experimental_async_runtime"]
 experimental_metrics_disable_name_validation = ["metrics"]
 
 [package.metadata.cargo-machete]

opentelemetry-sdk/src/logs/log_processor_with_async_runtime.rs

@@ -6,7 +6,6 @@ use crate::{
 
 use opentelemetry::{otel_debug, otel_error, otel_warn, InstrumentationScope};
 
-use std::env;
 use std::{
     fmt::{self, Debug, Formatter},
     sync::Arc,
@@ -17,6 +16,7 @@ use std::{
 };
 
 use super::{BatchConfig, LogProcessor};
+#[cfg(feature = "experimental_async_runtime")]
 use crate::runtime::{to_interval_stream, RuntimeChannel, TrySend};
 use futures_channel::oneshot;
 use futures_util::{

opentelemetry-zipkin/src/exporter/env.rs

@@ -14,6 +14,8 @@ const ENV_TIMEOUT: &str = "OTEL_EXPORTER_ZIPKIN_TIMEOUT";
 /// Default Zipkin timeout in milliseconds
 const DEFAULT_COLLECTOR_TIMEOUT: Duration = Duration::from_millis(10_000);
 
+// This is for clippy to work with only the reqwest-rustls feature enabled
+#[allow(unused)]
 pub(crate) fn get_timeout() -> Duration {
     match env::var(ENV_TIMEOUT).ok().filter(|var| !var.is_empty()) {
         Some(timeout) => match timeout.parse() {

opentelemetry-zipkin/src/exporter/mod.rs

@@ -41,6 +41,7 @@ pub struct ZipkinExporterBuilder {
 
 impl Default for ZipkinExporterBuilder {
     fn default() -> Self {
+        #[cfg(any(feature = "reqwest-blocking-client", feature = "reqwest-client"))]
         let timeout = env::get_timeout();
 
         ZipkinExporterBuilder {

opentelemetry/Cargo.toml

@@ -32,8 +32,9 @@ tracing = {workspace = true, optional = true} # optional for opentelemetry inter
 js-sys = "0.3.63"
 
 [features]
-default = ["trace", "metrics", "logs", "internal-logs"]
-trace = ["pin-project-lite", "futures-sink", "futures-core", "thiserror"]
+default = ["trace", "metrics", "logs", "internal-logs", "futures"]
+futures = ["futures-core", "futures-sink", "pin-project-lite"]
+trace = ["futures", "thiserror"]
 metrics = []
 testing = ["trace"]
 logs = []

opentelemetry/src/context.rs

@@ -20,8 +20,10 @@ use std::hash::{BuildHasherDefault, Hasher};
 use std::marker::PhantomData;
 use std::sync::Arc;
 
+#[cfg(feature = "futures")]
 mod future_ext;
 
+#[cfg(feature = "futures")]
 pub use future_ext::FutureExt;
 
 thread_local! {
@@ -428,6 +430,8 @@ impl Context {
 impl fmt::Debug for Context {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let mut dbg = f.debug_struct("Context");
+
+        #[cfg(feature = "trace")]
         let mut entries = self.entries.as_ref().map_or(0, |e| e.len());
         #[cfg(feature = "trace")]
         {
@@ -438,6 +442,8 @@ impl fmt::Debug for Context {
                 dbg.field("span", &"None");
             }
         }
+        #[cfg(not(feature = "trace"))]
+        let entries = self.entries.as_ref().map_or(0, |e| e.len());
 
         dbg.field("entries count", &entries)
             .field("suppress_telemetry", &self.suppress_telemetry)

scripts/lint.sh

@@ -9,10 +9,14 @@ cargo_feature() {
     -Dwarnings
 }
 
-if rustup component add clippy; then
+if rustup component add clippy && \
+  ((cargo --list | grep -q hack) || cargo install cargo-hack); then
   # Exit with a nonzero code if there are clippy warnings
   cargo clippy --workspace --all-targets --all-features -- -Dwarnings
 
+  # Run through all the features one by one and exit if there are clippy warnings
+  cargo hack --each-feature --no-dev-deps clippy -- -Dwarnings
+
   # `opentelemetry-prometheus` doesn't belong to the workspace
   cargo clippy --manifest-path=opentelemetry-prometheus/Cargo.toml --all-targets --all-features -- \
     -Dwarnings