Merge pull request #46 from arielb1/no-aws-defaults

feat: support not enabling aws default features

Author: arielb1

.github/actions/rust-build/action.yml

@@ -20,7 +20,8 @@ runs:
           if [ "${{ inputs.toolchain }}" != stable ]; then
               rm -fv Cargo.lock
           fi
-          cargo build --all-features --verbose
+          cargo build --verbose ${{ inputs.flags }}
     - name: Run tests
       shell: bash
-      run: cargo test --all-features --verbose
+      run: |
+          cargo test --verbose ${{ inputs.flags }}

.github/workflows/build.yml

@@ -10,6 +10,11 @@ jobs:
         toolchain:
           - "1.85" # Current MSRV due to Cargo MSRV feature
           - stable
+        flags:
+          - "--all-features"
+          - "--no-default-features"
+          - "--no-default-features --features=s3-no-defaults"
+          - "--no-default-features --features=aws-metadata-no-defaults"
     env:
       RUST_BACKTRACE: 1
     steps:
@@ -18,6 +23,7 @@ jobs:
         uses: ./.github/actions/rust-build
         with:
           toolchain: ${{ matrix.toolchain }}
+          flags: ${{ matrix.flags }}
   build-for-testing:
     name: Build for testing
     runs-on: ubuntu-latest

Cargo.lock

@@ -9,18 +9,19 @@ edition = "2021"
 
 [dependencies]
 async-trait = "0.1"
+# not really an AWS crate so no need to disable default features
 aws-arn = { version = "0.3", optional = true }
-aws-config = { version = "1", optional = true }
-aws-sdk-s3 = { version = "1", optional = true }
+aws-config = { version = "1", optional = true, default-features = false }
+aws-sdk-s3 = { version = "1", optional = true, default-features = false }
 chrono = "0.4"
-futures = { version = "0.3", default-features = false }
+futures = { version = "0.3", default-features = false, features = ["alloc"] }
 libloading = "0.8"
-reqwest = { version = "0.12", default-features = false, optional = true, features = ["charset", "http2", "rustls-tls"] }
+reqwest = { version = "0.12", default-features = false, optional = true, features = ["charset", "http2"] }
 serde_json = "1"
 serde = { version = "1", features = ["derive"] }
 tempfile = "3"
 thiserror = "2"
-tokio = { version = "1", features = ["macros"], optional = true }
+tokio = { version = "1", features = ["fs", "macros", "rt", "sync", "time"] }
 tracing = "0.1"
 zip = { version = "3", default-features = false, features = ["deflate"] }
 
@@ -38,5 +39,9 @@ name = 'simple'
 
 [features]
 default = ["s3", "aws-metadata"]
-s3 = ["dep:aws-config", "dep:aws-sdk-s3", "dep:tokio"]
-aws-metadata = ["dep:reqwest", "dep:aws-config", "dep:aws-arn"]
+s3 = ["s3-no-defaults", "aws-config/default", "aws-sdk-s3/default"]
+# A version of the s3 feature that does not enable AWS default features
+s3-no-defaults = ["dep:aws-config", "dep:aws-sdk-s3"]
+aws-metadata = ["aws-metadata-no-defaults", "aws-config/default", "reqwest/rustls-tls"]
+# A version of the aws-metadata feature that does not enable AWS default features
+aws-metadata-no-defaults = ["dep:reqwest", "dep:aws-config", "dep:aws-arn"]

Cargo.toml

@@ -89,6 +89,12 @@ emit `tokio.PollCatchV1` events this way:
     }
 ```
 
+### Not enabling the AWS SDK / Reqwest default features
+
+The `aws-metadata-no-defaults` and `s3-no-defaults` feature flags do not enable feature flags for the AWS SDK and `reqwest`. 
+
+If you want things to work, you'll need to enable features for these crates to allow at least a TLS provider. This can be used to use a TLS provider other than the default Rustls
+
 ## Decoder
 
 The `decoder` directory in the Git repository contains a decoder that can be used to view JFR files, especially with PollCatch information.

README.md

@@ -1,16 +1,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+#[cfg(feature = "s3-no-defaults")]
+use async_profiler_agent::reporter::s3::{S3Reporter, S3ReporterConfig};
 use async_profiler_agent::{
     metadata::AgentMetadata,
     profiler::{ProfilerBuilder, ProfilerOptionsBuilder},
-    reporter::{
-        local::LocalReporter,
-        s3::{S3Reporter, S3ReporterConfig},
-    },
+    reporter::local::LocalReporter,
 };
 use std::time::Duration;
 
+#[cfg(feature = "s3-no-defaults")]
 use aws_config::BehaviorVersion;
 use clap::{ArgGroup, Parser};
 
@@ -29,20 +29,27 @@ pub fn set_up_tracing() {
         .init();
 }
 
+#[derive(Clone, Debug, Default, Parser)]
+struct S3BucketArgs {
+    #[arg(long, requires = "bucket_owner", requires = "profiling_group")]
+    bucket: Option<String>,
+    #[arg(long)]
+    bucket_owner: Option<String>,
+    #[arg(long)]
+    profiling_group: Option<String>,
+}
+
 /// Simple program to test the profiler agent
-#[derive(Parser, Debug)]
+#[derive(Debug, Parser)]
 #[command(group(
     ArgGroup::new("options")
         .required(true)
         .args(["local", "bucket"]),
 ))]
 struct Args {
-    #[arg(long)]
-    profiling_group: Option<String>,
-    #[arg(long)]
-    bucket_owner: Option<String>,
-    #[arg(long, requires = "bucket_owner", requires = "profiling_group")]
-    bucket: Option<String>,
+    #[cfg(feature = "s3-no-defaults")]
+    #[command(flatten)]
+    bucket_args: S3BucketArgs,
     #[arg(long)]
     local: Option<String>,
     #[arg(long)]
@@ -57,6 +64,18 @@ struct Args {
     native_mem: Option<String>,
 }
 
+impl Args {
+    #[cfg(feature = "s3-no-defaults")]
+    fn s3_bucket_args(&self) -> S3BucketArgs {
+        self.bucket_args.clone()
+    }
+
+    #[cfg(not(feature = "s3-no-defaults"))]
+    fn s3_bucket_args(&self) -> S3BucketArgs {
+        S3BucketArgs::default()
+    }
+}
+
 #[allow(unexpected_cfgs)]
 pub fn main() -> anyhow::Result<()> {
     let args = Args::parse();
@@ -82,23 +101,24 @@ async fn main_internal(args: Args) -> Result<(), anyhow::Error> {
 
     let profiler = ProfilerBuilder::default();
 
-    let profiler = match (
-        args.local,
-        args.bucket,
-        args.bucket_owner,
-        args.profiling_group,
-    ) {
-        (Some(local), _, _, _) => profiler
+    let profiler = match (&args.local, args.s3_bucket_args()) {
+        (Some(local), S3BucketArgs { .. }) => profiler
             .with_reporter(LocalReporter::new(local))
             .with_custom_agent_metadata(AgentMetadata::Other),
-        (_, Some(bucket), Some(bucket_owner), Some(profiling_group)) => {
-            profiler.with_reporter(S3Reporter::new(S3ReporterConfig {
-                sdk_config: &aws_config::defaults(BehaviorVersion::latest()).load().await,
-                bucket_owner: bucket_owner,
-                bucket_name: bucket,
-                profiling_group_name: profiling_group,
-            }))
-        }
+        #[cfg(feature = "s3-no-defaults")]
+        (
+            _,
+            S3BucketArgs {
+                bucket: Some(bucket_name),
+                bucket_owner: Some(bucket_owner),
+                profiling_group: Some(profiling_group_name),
+            },
+        ) => profiler.with_reporter(S3Reporter::new(S3ReporterConfig {
+            sdk_config: &aws_config::defaults(BehaviorVersion::latest()).load().await,
+            bucket_owner,
+            bucket_name,
+            profiling_group_name,
+        })),
         _ => unreachable!(),
     };
 

examples/simple/main.rs

@@ -25,7 +25,8 @@
 //!
 //! You can use the [`S3Reporter`], which uploads the reports to an S3 bucket, as follows:
 //!
-//! ```no_run
+#![cfg_attr(feature = "s3-no-defaults", doc = "```no_run")]
+#![cfg_attr(not(feature = "s3-no-defaults"), doc = "```compile_fail")]
 //! # use async_profiler_agent::profiler::{ProfilerBuilder, SpawnError};
 //! # use async_profiler_agent::reporter::s3::{S3Reporter, S3ReporterConfig};
 //! # use aws_config::BehaviorVersion;

src/lib.rs

@@ -60,7 +60,7 @@ pub struct ReportMetadata<'a> {
     pub reporting_interval: Duration,
 }
 
-#[cfg(feature = "aws-metadata")]
+#[cfg(feature = "aws-metadata-no-defaults")]
 pub mod aws;
 
 /// [private] dummy metadata to make testing easier

src/metadata/mod.rs

@@ -5,7 +5,7 @@
 
 use crate::{
     asprof::{self, AsProfError},
-    metadata::{aws::AwsProfilerMetadataError, AgentMetadata, ReportMetadata},
+    metadata::{AgentMetadata, ReportMetadata},
     reporter::Reporter,
 };
 use std::{
@@ -311,7 +311,8 @@ enum TickError {
     #[error(transparent)]
     AsProf(#[from] AsProfError),
     #[error(transparent)]
-    Metadata(#[from] AwsProfilerMetadataError),
+    #[cfg(feature = "aws-metadata-no-defaults")]
+    Metadata(#[from] crate::metadata::aws::AwsProfilerMetadataError),
     #[error("reporter: {0}")]
     Reporter(Box<dyn std::error::Error + Send>),
     #[error("broken clock: {0}")]

src/profiler.rs

@@ -16,7 +16,7 @@ use crate::metadata::ReportMetadata;
 
 pub mod local;
 pub mod multi;
-#[cfg(feature = "s3")]
+#[cfg(feature = "s3-no-defaults")]
 pub mod s3;
 
 /// Abstraction around reporting profiler data.