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
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
//! Types for representing the interaction between a service an a client, referred to as an "operation" in smithy.
//! Clients "send" operations to services, which are composed of 1 or more HTTP requests.
use crate::body::SdkBody;
use crate::property_bag::{PropertyBag, SharedPropertyBag};
use crate::retry::DefaultResponseRetryClassifier;
use aws_smithy_types::config_bag::{Storable, StoreReplace};
use std::borrow::Cow;
use std::ops::{Deref, DerefMut};
pub mod error;
/// Metadata attached to an [`Operation`] that identifies the API being called.
#[derive(Clone, Debug)]
pub struct Metadata {
operation: Cow<'static, str>,
service: Cow<'static, str>,
}
impl Metadata {
/// Returns the operation name.
pub fn name(&self) -> &str {
&self.operation
}
/// Returns the service name.
pub fn service(&self) -> &str {
&self.service
}
/// Creates [`Metadata`].
pub fn new(
operation: impl Into<Cow<'static, str>>,
service: impl Into<Cow<'static, str>>,
) -> Self {
Metadata {
operation: operation.into(),
service: service.into(),
}
}
}
impl Storable for Metadata {
type Storer = StoreReplace<Self>;
}
/// Non-request parts of an [`Operation`].
///
/// Generics:
/// - `H`: Response handler
/// - `R`: Implementation of `ClassifyRetry`
#[non_exhaustive]
#[derive(Clone, Debug)]
pub struct Parts<H, R> {
/// The response deserializer that will convert the connector's response into an `operation::Response`
pub response_handler: H,
/// The classifier that will determine if an HTTP response indicates that a request failed for a retryable reason.
pub retry_classifier: R,
/// Metadata describing this operation and the service it relates to.
pub metadata: Option<Metadata>,
}
// TODO(enableNewSmithyRuntimeCleanup): Delete `operation::Operation` when cleaning up middleware
/// An [`Operation`] is a request paired with a response handler, retry classifier,
/// and metadata that identifies the API being called.
///
/// Generics:
/// - `H`: Response handler
/// - `R`: Implementation of `ClassifyRetry`
#[derive(Debug)]
pub struct Operation<H, R> {
request: Request,
parts: Parts<H, R>,
}
impl<H, R> Operation<H, R> {
/// Converts this operation into its parts.
pub fn into_request_response(self) -> (Request, Parts<H, R>) {
(self.request, self.parts)
}
/// Constructs an [`Operation`] from a request and [`Parts`]
pub fn from_parts(request: Request, parts: Parts<H, R>) -> Self {
Self { request, parts }
}
/// Returns a mutable reference to the request's property bag.
pub fn properties_mut(&mut self) -> impl DerefMut<Target = PropertyBag> + '_ {
self.request.properties_mut()
}
/// Returns an immutable reference to the request's property bag.
pub fn properties(&self) -> impl Deref<Target = PropertyBag> + '_ {
self.request.properties()
}
/// Gives mutable access to the underlying HTTP request.
pub fn request_mut(&mut self) -> &mut http::Request<SdkBody> {
self.request.http_mut()
}
/// Gives readonly access to the underlying HTTP request.
pub fn request(&self) -> &http::Request<SdkBody> {
self.request.http()
}
/// Attaches metadata to the operation.
pub fn with_metadata(mut self, metadata: Metadata) -> Self {
self.parts.metadata = Some(metadata);
self
}
/// Replaces the retry classifier on the operation.
pub fn with_retry_classifier<R2>(self, retry_classifier: R2) -> Operation<H, R2> {
Operation {
request: self.request,
parts: Parts {
response_handler: self.parts.response_handler,
retry_classifier,
metadata: self.parts.metadata,
},
}
}
/// Returns the retry classifier for this operation.
pub fn retry_classifier(&self) -> &R {
&self.parts.retry_classifier
}
/// Attempts to clone the operation.
///
/// Will return `None` if the request body is already consumed and can't be replayed.
pub fn try_clone(&self) -> Option<Self>
where
H: Clone,
R: Clone,
{
let request = self.request.try_clone()?;
Some(Self {
request,
parts: self.parts.clone(),
})
}
}
impl<H> Operation<H, ()> {
/// Creates a new [`Operation`].
pub fn new(
request: Request,
response_handler: H,
) -> Operation<H, DefaultResponseRetryClassifier> {
Operation {
request,
parts: Parts {
response_handler,
retry_classifier: DefaultResponseRetryClassifier::new(),
metadata: None,
},
}
}
}
// TODO(enableNewSmithyRuntimeCleanup): Delete `operation::Request` when cleaning up middleware
/// Operation request type that associates a property bag with an underlying HTTP request.
/// This type represents the request in the Tower `Service` in middleware so that middleware
/// can share information with each other via the properties.
#[derive(Debug)]
pub struct Request {
/// The underlying HTTP Request
inner: http::Request<SdkBody>,
/// Property bag of configuration options
///
/// Middleware can read and write from the property bag and use its
/// contents to augment the request (see [`Request::augment`](Request::augment))
properties: SharedPropertyBag,
}
impl Request {
/// Creates a new operation `Request` with the given `inner` HTTP request.
pub fn new(inner: http::Request<SdkBody>) -> Self {
Request {
inner,
properties: SharedPropertyBag::new(),
}
}
/// Creates a new operation `Request` from its parts.
pub fn from_parts(inner: http::Request<SdkBody>, properties: SharedPropertyBag) -> Self {
Request { inner, properties }
}
/// Allows modification of the HTTP request and associated properties with a fallible closure.
pub fn augment<T>(
self,
f: impl FnOnce(http::Request<SdkBody>, &mut PropertyBag) -> Result<http::Request<SdkBody>, T>,
) -> Result<Request, T> {
let inner = {
let properties: &mut PropertyBag = &mut self.properties.acquire_mut();
f(self.inner, properties)?
};
Ok(Request {
inner,
properties: self.properties,
})
}
/// Gives mutable access to the properties.
pub fn properties_mut(&mut self) -> impl DerefMut<Target = PropertyBag> + '_ {
self.properties.acquire_mut()
}
/// Gives readonly access to the properties.
pub fn properties(&self) -> impl Deref<Target = PropertyBag> + '_ {
self.properties.acquire()
}
/// Gives mutable access to the underlying HTTP request.
pub fn http_mut(&mut self) -> &mut http::Request<SdkBody> {
&mut self.inner
}
/// Gives readonly access to the underlying HTTP request.
pub fn http(&self) -> &http::Request<SdkBody> {
&self.inner
}
/// Attempts to clone the operation `Request`. This can fail if the
/// request body can't be cloned, such as if it is being streamed and the
/// stream can't be recreated.
pub fn try_clone(&self) -> Option<Request> {
let cloned_body = self.inner.body().try_clone()?;
let mut cloned_request = http::Request::builder()
.uri(self.inner.uri().clone())
.method(self.inner.method());
*cloned_request
.headers_mut()
.expect("builder has not been modified, headers must be valid") =
self.inner.headers().clone();
let inner = cloned_request
.body(cloned_body)
.expect("a clone of a valid request should be a valid request");
Some(Request {
inner,
properties: self.properties.clone(),
})
}
/// Consumes the operation `Request` and returns the underlying HTTP request and properties.
pub fn into_parts(self) -> (http::Request<SdkBody>, SharedPropertyBag) {
(self.inner, self.properties)
}
}
// TODO(enableNewSmithyRuntimeCleanup): Delete `operation::Response` when cleaning up middleware
/// Operation response type that associates a property bag with an underlying HTTP response.
/// This type represents the response in the Tower `Service` in middleware so that middleware
/// can share information with each other via the properties.
#[derive(Debug)]
pub struct Response {
/// The underlying HTTP Response
inner: http::Response<SdkBody>,
/// Property bag of configuration options
properties: SharedPropertyBag,
}
impl Response {
/// Creates a new operation `Response` with the given `inner` HTTP response.
pub fn new(inner: http::Response<SdkBody>) -> Self {
Response {
inner,
properties: SharedPropertyBag::new(),
}
}
/// Gives mutable access to the properties.
pub fn properties_mut(&mut self) -> impl DerefMut<Target = PropertyBag> + '_ {
self.properties.acquire_mut()
}
/// Gives readonly access to the properties.
pub fn properties(&self) -> impl Deref<Target = PropertyBag> + '_ {
self.properties.acquire()
}
/// Gives mutable access to the underlying HTTP response.
pub fn http_mut(&mut self) -> &mut http::Response<SdkBody> {
&mut self.inner
}
/// Gives readonly access to the underlying HTTP response.
pub fn http(&self) -> &http::Response<SdkBody> {
&self.inner
}
/// Consumes the operation `Request` and returns the underlying HTTP response and properties.
pub fn into_parts(self) -> (http::Response<SdkBody>, SharedPropertyBag) {
(self.inner, self.properties)
}
/// Return mutable references to the response and property bag contained within this `operation::Response`
pub fn parts_mut(
&mut self,
) -> (
&mut http::Response<SdkBody>,
impl DerefMut<Target = PropertyBag> + '_,
) {
(&mut self.inner, self.properties.acquire_mut())
}
/// Creates a new operation `Response` from an HTTP response and property bag.
pub fn from_parts(inner: http::Response<SdkBody>, properties: SharedPropertyBag) -> Self {
Response { inner, properties }
}
}
#[cfg(test)]
mod test {
use crate::body::SdkBody;
use crate::operation::Request;
use http::header::{AUTHORIZATION, CONTENT_LENGTH};
use http::Uri;
#[test]
fn try_clone_clones_all_data() {
let mut request = Request::new(
http::Request::builder()
.uri(Uri::from_static("http://www.amazon.com"))
.method("POST")
.header(CONTENT_LENGTH, 456)
.header(AUTHORIZATION, "Token: hello")
.body(SdkBody::from("hello world!"))
.expect("valid request"),
);
request.properties_mut().insert("hello");
let cloned = request.try_clone().expect("request is cloneable");
let (request, config) = cloned.into_parts();
assert_eq!(request.uri(), &Uri::from_static("http://www.amazon.com"));
assert_eq!(request.method(), "POST");
assert_eq!(request.headers().len(), 2);
assert_eq!(
request.headers().get(AUTHORIZATION).unwrap(),
"Token: hello"
);
assert_eq!(request.headers().get(CONTENT_LENGTH).unwrap(), "456");
assert_eq!(request.body().bytes().unwrap(), "hello world!".as_bytes());
assert_eq!(config.acquire().get::<&str>(), Some(&"hello"));
}
}