add: example showing how to use native-tls #946
Conversation
update: aws-config to correctly separate the native-tls and rustls features for its dependencies fix: native-tls feature gate typo update: prefix unused id field with an underscore
|
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
|
| id: &'static str, | ||
| _id: &'static str, |
There was a problem hiding this comment.
Clippy was complaining about this locally and the field seemed unused so I added the underscore
| # aws-config pulls in rustls and several other things by default. We have to disable defaults in order to use native-tls | ||
| # and then manually bring the other defaults back | ||
| aws-config = { path = "../../build/aws-sdk/sdk/aws-config", default-features = false, features = ["default-provider", "native-tls", "rt-tokio", "dns", "tcp-connector"] } | ||
| # aws-sdk-s3 brings in rustls by default so we disable that in order to use native-tls only | ||
| aws-sdk-s3 = { package = "aws-sdk-s3", path = "../../build/aws-sdk/sdk/s3", default-features = false, features = ["native-tls"] } | ||
| # aws-sdk-sts is the same as aws-sdk-s3 | ||
| aws-sdk-sts = { package = "aws-sdk-sts", path = "../../build/aws-sdk/sdk/sts", default-features = false, features = ["native-tls"] } |
There was a problem hiding this comment.
Thanks to John's suggestion of removing default features for runtime crates, we don't even need to include them here!
|
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
|
|
A new generated diff is ready to view.
|
|
A new generated diff is ready to view.
|
|
A new doc preview is ready to view. |
| @@ -32,7 +32,7 @@ dns = ["tokio/rt"] | |||
| default = ["default-provider", "rustls", "rt-tokio", "dns", "tcp-connector"] | |||
|
|
|||
| [dependencies] | |||
| aws-sdk-sts = { path = "../../sdk/build/aws-sdk/sdk/sts", optional = true } | |||
| aws-sdk-sts = { path = "../../sdk/build/aws-sdk/sdk/sts", default-features = false, optional = true } | |||
There was a problem hiding this comment.
Should the rustls and native-tls features in aws-config also enable the equivalent features on the STS crate? Or to reframe the question, is it working by coincidence right now without explicitly enabling those?
There was a problem hiding this comment.
I had that previously and removed it because it didn't seem to matter. The test runs and doesn't detect rustls even though aws-config is a dependency so I believe we're good. Personally, my gut tells me to include the features but I can't articulate why so I'm ignoring the feeling.
There was a problem hiding this comment.
@jdisanti they should not: this is because the only purpose of those in the STS crate are to support from_conf (constructing the client without a connection). But this crate will always provide a connection when constructing a client.
| let cargo_location = std::env::var("CARGO").unwrap(); | ||
| let cargo_command = std::process::Command::new(&cargo_location) | ||
| .arg("tree") | ||
| .arg("--invert") | ||
| .arg("rustls") | ||
| .output() |
There was a problem hiding this comment.
Clever!
Does this differentiate between something being wrong with the cargo binary (not able to execute or something) vs. exiting with a non-zero status?
There was a problem hiding this comment.
This only checks that Cargo writes a specific message to stderr when the command is run. The possible paths I see are:
- rustls is not in tree, message is logged to stderr, we panic with that message and match on it with
should_panic, it's a match so that's a test pass - some other failure occurs, message is logged to stderr, we panic with that message and match on it with
should_panic, It's not a match so that's a test fail - rustls is in the tree, print tree and exit, test fails cause no panic
So, to answer your question: yes, it does differentiate
|
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
|
|
A new generated diff is ready to view.
|
|
A new doc preview is ready to view. |
|
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
|
Motivation and Context
It's not currently possible to avoid using rustls
Description
This PR makes it possible to use
native-tlsand disablerustlsand includes an example for users demonstrating how to do it.Testing
I included a test that ensures
rustlsis not in useChecklist
CHANGELOG.next.tomlif I made changes to the smithy-rs codegen or runtime cratesCHANGELOG.next.tomlif I made changes to the AWS SDK, generated SDK code, or SDK runtime cratesBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.