1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
use std::sync::Arc;
use crate::{bounds, erase, retry, Client, TriState, MISSING_SLEEP_IMPL_RECOMMENDATION};
use aws_smithy_async::rt::sleep::{default_async_sleep, AsyncSleep};
use aws_smithy_http::body::SdkBody;
use aws_smithy_http::result::ConnectorError;
use aws_smithy_types::timeout::TimeoutConfig;
/// A builder that provides more customization options when constructing a [`Client`].
///
/// To start, call [`Builder::new`]. Then, chain the method calls to configure the `Builder`.
/// When configured to your liking, call [`Builder::build`]. The individual methods have additional
/// documentation.
#[derive(Clone, Debug, Default)]
pub struct Builder<C = (), M = (), R = retry::Standard> {
connector: C,
middleware: M,
retry_policy: R,
timeout_config: TimeoutConfig,
sleep_impl: TriState<Arc<dyn AsyncSleep>>,
}
// It'd be nice to include R where R: Default here, but then the caller ends up always having to
// specify R explicitly since type parameter defaults (like the one for R) aren't picked up when R
// cannot be inferred. This is, arguably, a compiler bug/missing language feature, but is
// complicated: https://github.com/rust-lang/rust/issues/27336.
//
// For the time being, we stick with just <C, M> for ::new. Those can usually be inferred since we
// only implement .constructor and .middleware when C and M are () respectively. Users who really
// need a builder for a custom R can use ::default instead.
impl<C, M> Builder<C, M>
where
C: Default,
M: Default,
{
/// Construct a new builder. This does not specify a [connector](Builder::connector)
/// or [middleware](Builder::middleware).
/// It uses the [standard retry mechanism](retry::Standard).
pub fn new() -> Self {
Self::default()
}
}
impl<M, R> Builder<(), M, R> {
/// Specify the connector for the eventual client to use.
///
/// The connector dictates how requests are turned into responses. Normally, this would entail
/// sending the request to some kind of remote server, but in certain settings it's useful to
/// be able to use a custom connector instead, such as to mock the network for tests.
///
/// If you just want to specify a function from request to response instead, use
/// [`Builder::connector_fn`].
pub fn connector<C>(self, connector: C) -> Builder<C, M, R> {
Builder {
connector,
retry_policy: self.retry_policy,
middleware: self.middleware,
timeout_config: self.timeout_config,
sleep_impl: self.sleep_impl,
}
}
/// Use a function that directly maps each request to a response as a connector.
///
/// ```no_run
/// use aws_smithy_client::Builder;
/// use aws_smithy_http::body::SdkBody;
/// let client = Builder::new()
/// # /*
/// .middleware(..)
/// # */
/// # .middleware(tower::layer::util::Identity::new())
/// .connector_fn(|req: http::Request<SdkBody>| {
/// async move {
/// Ok(http::Response::new(SdkBody::empty()))
/// }
/// })
/// .build();
/// # client.check();
/// ```
pub fn connector_fn<F, FF>(self, map: F) -> Builder<tower::util::ServiceFn<F>, M, R>
where
F: Fn(http::Request<SdkBody>) -> FF + Send,
FF: std::future::Future<Output = Result<http::Response<SdkBody>, ConnectorError>>,
// NOTE: The extra bound here is to help the type checker give better errors earlier.
tower::util::ServiceFn<F>: bounds::SmithyConnector,
{
self.connector(tower::service_fn(map))
}
}
impl<C, R> Builder<C, (), R> {
/// Specify the middleware for the eventual client ot use.
///
/// The middleware adjusts requests before they are dispatched to the connector. It is
/// responsible for filling in any request parameters that aren't specified by the Smithy
/// protocol definition, such as those used for routing (like the URL), authentication, and
/// authorization.
///
/// The middleware takes the form of a [`tower::Layer`] that wraps the actual connection for
/// each request. The [`tower::Service`] that the middleware produces must accept requests of
/// the type [`aws_smithy_http::operation::Request`] and return responses of the type
/// [`http::Response<SdkBody>`], most likely by modifying the provided request in place,
/// passing it to the inner service, and then ultimately returning the inner service's
/// response.
///
/// If your requests are already ready to be sent and need no adjustment, you can use
/// [`tower::layer::util::Identity`] as your middleware.
pub fn middleware<M>(self, middleware: M) -> Builder<C, M, R> {
Builder {
connector: self.connector,
retry_policy: self.retry_policy,
timeout_config: self.timeout_config,
middleware,
sleep_impl: self.sleep_impl,
}
}
/// Use a function-like middleware that directly maps each request.
///
/// ```no_run
/// use aws_smithy_client::Builder;
/// use aws_smithy_client::erase::DynConnector;
/// use aws_smithy_client::never::NeverConnector;
/// use aws_smithy_http::body::SdkBody;
/// let my_connector = DynConnector::new(
/// // Your own connector here or use `dyn_https()`
/// # NeverConnector::new()
/// );
/// let client = Builder::new()
/// .connector(my_connector)
/// .middleware_fn(|req: aws_smithy_http::operation::Request| {
/// req
/// })
/// .build();
/// # client.check();
/// ```
pub fn middleware_fn<F>(self, map: F) -> Builder<C, tower::util::MapRequestLayer<F>, R>
where
F: Fn(aws_smithy_http::operation::Request) -> aws_smithy_http::operation::Request
+ Clone
+ Send
+ Sync
+ 'static,
{
self.middleware(tower::util::MapRequestLayer::new(map))
}
}
impl<C, M> Builder<C, M, retry::Standard> {
/// Specify the retry policy for the eventual client to use.
///
/// By default, the Smithy client uses a standard retry policy that works well in most
/// settings. You can use this method to override that policy with a custom one. A new policy
/// instance will be instantiated for each request using [`retry::NewRequestPolicy`]. Each
/// policy instance must implement [`tower::retry::Policy`].
///
/// If you just want to modify the policy _configuration_ for the standard retry policy, use
/// [`Builder::set_retry_config`].
pub fn retry_policy<R>(self, retry_policy: R) -> Builder<C, M, R> {
Builder {
connector: self.connector,
retry_policy,
timeout_config: self.timeout_config,
middleware: self.middleware,
sleep_impl: self.sleep_impl,
}
}
}
impl<C, M> Builder<C, M> {
/// Set the standard retry policy's configuration.
pub fn set_retry_config(&mut self, config: retry::Config) {
self.retry_policy.with_config(config);
}
/// Set a timeout config for the builder
pub fn set_timeout_config(&mut self, timeout_config: TimeoutConfig) {
self.timeout_config = timeout_config;
}
/// Set the [`AsyncSleep`] function that the [`Client`] will use to create things like timeout futures.
pub fn set_sleep_impl(&mut self, async_sleep: Option<Arc<dyn AsyncSleep>>) {
self.sleep_impl = async_sleep.into();
}
/// Set the [`AsyncSleep`] function that the [`Client`] will use to create things like timeout futures.
pub fn sleep_impl(mut self, async_sleep: Option<Arc<dyn AsyncSleep>>) -> Self {
self.set_sleep_impl(async_sleep);
self
}
/// Sets the sleep implementation to [`default_async_sleep`].
pub fn default_async_sleep(mut self) -> Self {
self.sleep_impl = TriState::or_unset(default_async_sleep());
self
}
}
impl<C, M, R> Builder<C, M, R> {
/// Use a connector that wraps the current connector.
pub fn map_connector<F, C2>(self, map: F) -> Builder<C2, M, R>
where
F: FnOnce(C) -> C2,
{
Builder {
connector: map(self.connector),
middleware: self.middleware,
retry_policy: self.retry_policy,
timeout_config: self.timeout_config,
sleep_impl: self.sleep_impl,
}
}
/// Use a middleware that wraps the current middleware.
pub fn map_middleware<F, M2>(self, map: F) -> Builder<C, M2, R>
where
F: FnOnce(M) -> M2,
{
Builder {
connector: self.connector,
middleware: map(self.middleware),
retry_policy: self.retry_policy,
timeout_config: self.timeout_config,
sleep_impl: self.sleep_impl,
}
}
/// Build a Smithy service [`Client`].
pub fn build(self) -> Client<C, M, R> {
if matches!(self.sleep_impl, TriState::Unset) {
if self.timeout_config.has_timeouts() {
tracing::warn!(
"One or more timeouts were set, but no `sleep_impl` was passed into the \
builder. Timeouts and retry both require a sleep implementation. No timeouts \
will occur with the current configuration. {}",
MISSING_SLEEP_IMPL_RECOMMENDATION
);
} else {
tracing::warn!(
"Retries require a `sleep_impl`, but none was passed into the builder. \
No retries will occur with the current configuration. {}",
MISSING_SLEEP_IMPL_RECOMMENDATION
);
}
}
Client {
connector: self.connector,
retry_policy: self.retry_policy,
middleware: self.middleware,
timeout_config: self.timeout_config,
sleep_impl: self.sleep_impl,
}
}
}
impl<C, M, R> Builder<C, M, R>
where
C: bounds::SmithyConnector,
M: bounds::SmithyMiddleware<erase::DynConnector> + Send + Sync + 'static,
R: retry::NewRequestPolicy,
{
/// Build a type-erased Smithy service [`Client`].
///
/// Note that if you're using the standard retry mechanism, [`retry::Standard`], `DynClient<R>`
/// is equivalent to [`Client`] with no type arguments.
///
/// ```no_run
/// # #[cfg(feature = "https")]
/// # fn not_main() {
/// use aws_smithy_client::{Builder, Client};
/// struct MyClient {
/// client: aws_smithy_client::Client,
/// }
///
/// let client = Builder::new()
/// .https()
/// .middleware(tower::layer::util::Identity::new())
/// .build_dyn();
/// let client = MyClient { client };
/// # client.client.check();
/// # }
pub fn build_dyn(self) -> erase::DynClient<R> {
self.build().into_dyn()
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::never::NeverConnector;
use aws_smithy_async::rt::sleep::Sleep;
use std::time::Duration;
#[derive(Clone, Debug)]
struct StubSleep;
impl AsyncSleep for StubSleep {
fn sleep(&self, _duration: Duration) -> Sleep {
todo!()
}
}
const TIMEOUTS_WITHOUT_SLEEP_MSG: &str =
"One or more timeouts were set, but no `sleep_impl` was passed into the builder";
const RETRIES_WITHOUT_SLEEP_MSG: &str =
"Retries require a `sleep_impl`, but none was passed into the builder.";
const RECOMMENDATION_MSG: &str =
"consider using the `aws-config` crate to load a shared config";
#[test]
#[tracing_test::traced_test]
fn sleep_impl_given_no_warns() {
let _client = Builder::new()
.connector(NeverConnector::new())
.middleware(tower::layer::util::Identity::new())
.sleep_impl(Some(Arc::new(StubSleep)))
.build();
assert!(!logs_contain(TIMEOUTS_WITHOUT_SLEEP_MSG));
assert!(!logs_contain(RETRIES_WITHOUT_SLEEP_MSG));
assert!(!logs_contain(RECOMMENDATION_MSG));
}
#[test]
#[tracing_test::traced_test]
fn timeout_missing_sleep_impl_warn() {
let mut builder = Builder::new()
.connector(NeverConnector::new())
.middleware(tower::layer::util::Identity::new());
builder.set_timeout_config(
TimeoutConfig::new().with_connect_timeout(Some(Duration::from_secs(1))),
);
builder.build();
assert!(logs_contain(TIMEOUTS_WITHOUT_SLEEP_MSG));
assert!(!logs_contain(RETRIES_WITHOUT_SLEEP_MSG));
assert!(logs_contain(RECOMMENDATION_MSG));
}
#[test]
#[tracing_test::traced_test]
fn retry_missing_sleep_impl_warn() {
Builder::new()
.connector(NeverConnector::new())
.middleware(tower::layer::util::Identity::new())
.build();
assert!(!logs_contain(TIMEOUTS_WITHOUT_SLEEP_MSG));
assert!(logs_contain(RETRIES_WITHOUT_SLEEP_MSG));
assert!(logs_contain(RECOMMENDATION_MSG));
}
}