use serde_json;
use std::convert::TryFrom;
+use std::fmt;
#[cfg(not(feature = "tokio"))]
use std::io::Write;
-use std::net::ToSocketAddrs;
+use std::net::{SocketAddr, ToSocketAddrs};
use std::time::Duration;
#[cfg(feature = "tokio")]
/// Timeout for reading the first byte of a response. This is separate from the general read
/// timeout as it is not uncommon for Bitcoin Core to be blocked waiting on UTXO cache flushes for
-/// upwards of a minute or more. Note that we always retry once when we time out, so the maximum
-/// time we allow Bitcoin Core to block for is twice this value.
-const TCP_STREAM_RESPONSE_TIMEOUT: Duration = Duration::from_secs(120);
+/// upwards of 10 minutes on slow devices (e.g. RPis with SSDs over USB). Note that we always retry
+/// once when we time out, so the maximum time we allow Bitcoin Core to block for is twice this
+/// value.
+const TCP_STREAM_RESPONSE_TIMEOUT: Duration = Duration::from_secs(300);
/// Maximum HTTP message header size in bytes.
const MAX_HTTP_MESSAGE_HEADER_SIZE: usize = 8192;
/// Client for making HTTP requests.
pub(crate) struct HttpClient {
+ address: SocketAddr,
stream: TcpStream,
}
TcpStream::from_std(stream)?
};
- Ok(Self { stream })
+ Ok(Self { address, stream })
}
/// Sends a `GET` request for a resource identified by `uri` at the `host`.
/// Sends an HTTP request message and reads the response, returning its body. Attempts to
/// reconnect and retry if the connection has been closed.
async fn send_request_with_retry(&mut self, request: &str) -> std::io::Result<Vec<u8>> {
- let endpoint = self.stream.peer_addr().unwrap();
match self.send_request(request).await {
Ok(bytes) => Ok(bytes),
Err(_) => {
tokio::time::sleep(Duration::from_millis(100)).await;
#[cfg(not(feature = "tokio"))]
std::thread::sleep(Duration::from_millis(100));
- *self = Self::connect(endpoint)?;
+ *self = Self::connect(self.address)?;
self.send_request(request).await
},
}
if !status.is_ok() {
// TODO: Handle 3xx redirection responses.
- let error_details = match contents.is_ascii() {
- true => String::from_utf8_lossy(&contents).to_string(),
- false => "binary".to_string()
+ let error = HttpError {
+ status_code: status.code.to_string(),
+ contents,
};
- let error_msg = format!("Errored with status: {} and contents: {}",
- status.code, error_details);
- return Err(std::io::Error::new(std::io::ErrorKind::Other, error_msg));
+ return Err(std::io::Error::new(std::io::ErrorKind::Other, error));
}
Ok(contents)
}
}
+/// HTTP error consisting of a status code and body contents.
+#[derive(Debug)]
+pub(crate) struct HttpError {
+ pub(crate) status_code: String,
+ pub(crate) contents: Vec<u8>,
+}
+
+impl std::error::Error for HttpError {}
+
+impl fmt::Display for HttpError {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ let contents = String::from_utf8_lossy(&self.contents);
+ write!(f, "status_code: {}, contents: {}", self.status_code, contents)
+ }
+}
+
/// HTTP response status code as defined by [RFC 7231].
///
/// [RFC 7231]: https://tools.ietf.org/html/rfc7231#section-6
#[test]
fn convert_to_socket_addrs() {
- let endpoint = HttpEndpoint::for_host("foo.com".into());
+ let endpoint = HttpEndpoint::for_host("localhost".into());
let host = endpoint.host();
let port = endpoint.port();
use std::net::ToSocketAddrs;
match (&endpoint).to_socket_addrs() {
Err(e) => panic!("Unexpected error: {:?}", e),
- Ok(mut socket_addrs) => {
- match socket_addrs.next() {
- None => panic!("Expected socket address"),
- Some(addr) => {
- assert_eq!(addr, (host, port).to_socket_addrs().unwrap().next().unwrap());
- assert!(socket_addrs.next().is_none());
- }
+ Ok(socket_addrs) => {
+ let mut std_addrs = (host, port).to_socket_addrs().unwrap();
+ for addr in socket_addrs {
+ assert_eq!(addr, std_addrs.next().unwrap());
}
+ assert!(std_addrs.next().is_none());
}
}
}
}
impl HttpServer {
- pub fn responding_with_ok<T: ToString>(body: MessageBody<T>) -> Self {
+ fn responding_with_body<T: ToString>(status: &str, body: MessageBody<T>) -> Self {
let response = match body {
- MessageBody::Empty => "HTTP/1.1 200 OK\r\n\r\n".to_string(),
+ MessageBody::Empty => format!("{}\r\n\r\n", status),
MessageBody::Content(body) => {
let body = body.to_string();
format!(
- "HTTP/1.1 200 OK\r\n\
+ "{}\r\n\
Content-Length: {}\r\n\
\r\n\
- {}", body.len(), body)
+ {}", status, body.len(), body)
},
MessageBody::ChunkedContent(body) => {
let mut chuncked_body = Vec::new();
encoder.write_all(body.to_string().as_bytes()).unwrap();
}
format!(
- "HTTP/1.1 200 OK\r\n\
+ "{}\r\n\
Transfer-Encoding: chunked\r\n\
\r\n\
- {}", String::from_utf8(chuncked_body).unwrap())
+ {}", status, String::from_utf8(chuncked_body).unwrap())
},
};
HttpServer::responding_with(response)
}
+ pub fn responding_with_ok<T: ToString>(body: MessageBody<T>) -> Self {
+ HttpServer::responding_with_body("HTTP/1.1 200 OK", body)
+ }
+
pub fn responding_with_not_found() -> Self {
- let response = "HTTP/1.1 404 Not Found\r\n\r\n".to_string();
- HttpServer::responding_with(response)
+ HttpServer::responding_with_body::<String>("HTTP/1.1 404 Not Found", MessageBody::Empty)
+ }
+
+ pub fn responding_with_server_error<T: ToString>(content: T) -> Self {
+ let body = MessageBody::Content(content);
+ HttpServer::responding_with_body("HTTP/1.1 500 Internal Server Error", body)
}
fn responding_with(response: String) -> Self {
#[test]
fn connect_to_unresolvable_host() {
match HttpClient::connect(("example.invalid", 80)) {
- Err(e) => assert_eq!(e.kind(), std::io::ErrorKind::Other),
+ Err(e) => {
+ assert!(e.to_string().contains("failed to lookup address information") ||
+ e.to_string().contains("No such host"), "{:?}", e);
+ },
Ok(_) => panic!("Expected error"),
}
}
#[tokio::test]
async fn read_error() {
- let response = String::from(
- "HTTP/1.1 500 Internal Server Error\r\n\
- Content-Length: 10\r\n\r\ntest error\r\n");
- let server = HttpServer::responding_with(response);
+ let server = HttpServer::responding_with_server_error("foo");
let mut client = HttpClient::connect(&server.endpoint()).unwrap();
match client.get::<JsonResponse>("/foo", "foo.com").await {
Err(e) => {
- assert_eq!(e.get_ref().unwrap().to_string(), "Errored with status: 500 and contents: test error");
assert_eq!(e.kind(), std::io::ErrorKind::Other);
+ let http_error = e.into_inner().unwrap().downcast::<HttpError>().unwrap();
+ assert_eq!(http_error.status_code, "500");
+ assert_eq!(http_error.contents, "foo".as_bytes());
},
Ok(_) => panic!("Expected error"),
}