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
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
use super::{
Action, BodyData, ConnectionId, Direction, Error, Event, NetworkTraffic, Request, Response,
Version,
};
use aws_smithy_runtime_api::client::connector_metadata::ConnectorMetadata;
use aws_smithy_runtime_api::client::http::{
HttpClient, HttpConnector, HttpConnectorFuture, HttpConnectorSettings, SharedHttpConnector,
};
use aws_smithy_runtime_api::client::orchestrator::HttpRequest;
use aws_smithy_runtime_api::client::runtime_components::RuntimeComponents;
use aws_smithy_runtime_api::shared::IntoShared;
use aws_smithy_types::body::SdkBody;
use std::path::Path;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::{Arc, Mutex, MutexGuard};
use std::{fs, io};
use tokio::task::JoinHandle;
/// Recording client
///
/// `RecordingClient` wraps an inner connection and records all traffic, enabling traffic replay.
///
/// # Example
///
/// ```rust,ignore
/// use aws_smithy_async::rt::sleep::default_async_sleep;
/// use aws_smithy_runtime::client::http::hyper_014::default_connector;
/// use aws_smithy_http_client::test_util::dvr::RecordingClient;
/// use aws_smithy_runtime_api::client::http::HttpConnectorSettingsBuilder;
/// use aws_sdk_s3::{Client, Config};
///
/// #[tokio::test]
/// async fn test_content_length_enforcement_is_not_applied_to_head_request() {
/// let settings = HttpConnectorSettingsBuilder::default().build();
/// let http_client = default_connector(&settings, default_async_sleep()).unwrap();
/// let http_client = RecordingClient::new(http_client);
///
/// // Since we need to send a real request for this,
/// // you'll need to use your real credentials.
/// let config = aws_config::load_defaults(BehaviorVersion::latest()).await;
/// let config = Config::from(&config).to_builder()
/// .http_client(http_client.clone())
/// .region(Region::new("us-east-1"))
/// .build();
///
/// let client = Client::from_conf(config);
/// let _resp = client
/// .head_object()
/// .key("some-test-file.txt")
/// .bucket("your-test-bucket")
/// .send()
/// .await
/// .unwrap();
///
/// // If the request you want to record has a body, don't forget to poll
/// // the body to completion BEFORE calling `dump_to_file`. Otherwise, your
/// // test json won't include the body.
/// // let _body = _resp.body.collect().await.unwrap();
///
/// // This path is relative to your project or workspace `Cargo.toml` file.
/// http_client.dump_to_file("tests/data/content-length-enforcement/head-object.json").unwrap();
/// }
/// ```
#[derive(Clone, Debug)]
pub struct RecordingClient {
pub(crate) data: Arc<Mutex<Vec<Event>>>,
pub(crate) num_events: Arc<AtomicUsize>,
pub(crate) inner: SharedHttpConnector,
}
#[cfg(feature = "legacy-rustls-ring")]
impl RecordingClient {
/// Construct a recording connection wrapping a default HTTPS implementation without any timeouts.
pub fn https() -> Self {
#[allow(deprecated)]
use crate::hyper_014::HyperConnector;
Self {
data: Default::default(),
num_events: Arc::new(AtomicUsize::new(0)),
#[allow(deprecated)]
inner: SharedHttpConnector::new(HyperConnector::builder().build_https()),
}
}
}
impl RecordingClient {
/// Create a new recording connection from a connection
pub fn new(underlying_connector: impl HttpConnector + 'static) -> Self {
Self {
data: Default::default(),
num_events: Arc::new(AtomicUsize::new(0)),
inner: underlying_connector.into_shared(),
}
}
/// Return the traffic recorded by this connection
pub fn events(&self) -> MutexGuard<'_, Vec<Event>> {
self.data.lock().unwrap()
}
/// NetworkTraffic struct suitable for serialization
pub fn network_traffic(&self) -> NetworkTraffic {
NetworkTraffic {
events: self.events().clone(),
docs: Some("todo docs".into()),
version: Version::V0,
}
}
/// Dump the network traffic to a file
pub fn dump_to_file(&self, path: impl AsRef<Path>) -> Result<(), io::Error> {
fs::write(
path,
serde_json::to_string(&self.network_traffic()).unwrap(),
)
}
fn next_id(&self) -> ConnectionId {
ConnectionId(self.num_events.fetch_add(1, Ordering::Relaxed))
}
}
fn record_body(
body: &mut SdkBody,
event_id: ConnectionId,
direction: Direction,
event_bus: Arc<Mutex<Vec<Event>>>,
) -> JoinHandle<()> {
let (sender, output_body) = crate::test_util::body::channel_body();
let real_body = std::mem::replace(body, output_body);
tokio::spawn(async move {
let mut real_body = real_body;
let mut sender = sender;
loop {
let data = crate::test_util::body::next_data_frame(&mut real_body).await;
match data {
Some(Ok(data)) => {
event_bus.lock().unwrap().push(Event {
connection_id: event_id,
action: Action::Data {
data: BodyData::from(data.clone()),
direction,
},
});
// This happens if the real connection is closed during recording.
// Need to think more carefully if this is the correct thing to log in this
// case.
if sender.send_data(data).await.is_err() {
event_bus.lock().unwrap().push(Event {
connection_id: event_id,
action: Action::Eof {
direction: direction.opposite(),
ok: false,
},
})
};
}
None => {
event_bus.lock().unwrap().push(Event {
connection_id: event_id,
action: Action::Eof {
ok: true,
direction,
},
});
drop(sender);
break;
}
Some(Err(_err)) => {
event_bus.lock().unwrap().push(Event {
connection_id: event_id,
action: Action::Eof {
ok: false,
direction,
},
});
sender.abort();
break;
}
}
}
})
}
impl HttpConnector for RecordingClient {
fn call(&self, mut request: HttpRequest) -> HttpConnectorFuture {
let event_id = self.next_id();
// A request has three phases:
// 1. A "Request" phase. This is initial HTTP request, headers, & URI
// 2. A body phase. This may contain multiple data segments.
// 3. A finalization phase. An EOF of some sort is sent on the body to indicate that
// the channel should be closed.
// Phase 1: the initial http request
self.data.lock().unwrap().push(Event {
connection_id: event_id,
action: Action::Request {
request: Request::from(&request),
},
});
// Phase 2: Swap out the real request body for one that will log all traffic that passes
// through it
// This will also handle phase three when the request body runs out of data.
record_body(
request.body_mut(),
event_id,
Direction::Request,
self.data.clone(),
);
let events = self.data.clone();
// create a channel we'll use to stream the data while reading it
let resp_fut = self.inner.call(request);
let fut = async move {
let resp = resp_fut.await;
match resp {
Ok(mut resp) => {
// push the initial response event
events.lock().unwrap().push(Event {
connection_id: event_id,
action: Action::Response {
response: Ok(Response::from(&resp)),
},
});
// instrument the body and record traffic
record_body(resp.body_mut(), event_id, Direction::Response, events);
Ok(resp)
}
Err(e) => {
events.lock().unwrap().push(Event {
connection_id: event_id,
action: Action::Response {
response: Err(Error(format!("{}", &e))),
},
});
Err(e)
}
}
};
HttpConnectorFuture::new(fut)
}
}
impl HttpClient for RecordingClient {
fn http_connector(
&self,
_: &HttpConnectorSettings,
_: &RuntimeComponents,
) -> SharedHttpConnector {
self.clone().into_shared()
}
fn connector_metadata(&self) -> Option<ConnectorMetadata> {
Some(ConnectorMetadata::new("recording-client", None))
}
}