Skip to content

refactor!: normalize responses into a shared HttpResponse #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MaxFangX wants to merge 1 commit into
base: master
Choose a base branch
from
Open

refactor!: normalize responses into a shared HttpResponse #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

### Changed

* refactor(client)!: normalize responses into a shared `HttpResponse` [#243]
* feat(client): enable request pipelining for `AsyncClient` [#245]
* chore!: remove deprecated `BlockSummary` and `get_block` [#225]

Expand Down
104 changes: 44 additions & 60 deletions src/async.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ use bitcoin::hashes::{sha256, Hash};
use bitcoin::hex::{DisplayHex, FromHex};
use bitcoin::{Address, Amount, Block, BlockHash, FeeRate, MerkleBlock, Script, Transaction, Txid};

use bitreq::{Client, Method, Proxy, Request, RequestExt, Response};
use bitreq::{Client, Method, Proxy, Request, RequestExt};

use crate::{
duration_to_timeout_secs, is_retryable, is_success, sat_per_vbyte_to_feerate, AddressStats,
BlockInfo, BlockStatus, Builder, Error, EsploraTx, MempoolRecentTx, MempoolStats, MerkleProof,
duration_to_timeout_secs, sat_per_vbyte_to_feerate, AddressStats, BlockInfo, BlockStatus,
Builder, Error, EsploraTx, HttpResponse, MempoolRecentTx, MempoolStats, MerkleProof,
OutputStatus, ScriptHashStats, SubmitPackageResult, TxStatus, Utxo, BASE_BACKOFF_MILLIS,
};

Expand Down Expand Up @@ -150,22 +150,47 @@ impl<S: Sleeper> AsyncClient<S> {
Ok(request)
}

/// Sends a GET request to `url`, retrying on retryable status codes
/// Sends a single GET request to `path`.
async fn send_get(&self, path: &str) -> Result<HttpResponse, Error> {
let request = self.build_request(Method::Get, path)?.with_pipelining();
let response = request.send_async_with_client(&self.client).await?;
HttpResponse::from_bitreq(response)
}

/// Sends a single POST request to `path` with `body` and query parameters.
async fn send_post(
&self,
path: &str,
body: Vec<u8>,
query_params: Option<HashSet<(&str, String)>>,
) -> Result<HttpResponse, Error> {
let mut request = self.build_request(Method::Post, path)?.with_body(body);

for (key, value) in query_params.unwrap_or_default() {
request = request.with_param(key, value);
}

let response = request.send_async_with_client(&self.client).await?;
HttpResponse::from_bitreq(response)
}

/// Sends a GET request to `path`, retrying on retryable status codes
/// with exponential backoff until [`AsyncClient::max_retries`] is reached.
async fn get_with_retry(&self, path: &str) -> Result<Response, Error> {
///
/// Returns an [`Error::HttpResponse`] on a non-success status code.
async fn get_with_retry(&self, path: &str) -> Result<HttpResponse, Error> {
let mut delay = BASE_BACKOFF_MILLIS;
let mut attempts = 0;

let request = self.build_request(Method::Get, path)?.with_pipelining();

loop {
match request.clone().send_async_with_client(&self.client).await? {
response if attempts < self.max_retries && is_retryable(&response) => {
S::sleep(delay).await;
attempts += 1;
delay *= 2;
}
response => return Ok(response),
let response = self.send_get(path).await?;

if attempts < self.max_retries && response.is_retryable() {
S::sleep(delay).await;
attempts += 1;
delay *= 2;
} else {
return response.error_for_status();
}
}
}
Expand All @@ -180,14 +205,7 @@ impl<S: Sleeper> AsyncClient<S> {
/// Returns an [`Error`] if the request fails or deserialization fails.
async fn get_response<T: Decodable>(&self, path: &str) -> Result<T, Error> {
let response = self.get_with_retry(path).await?;

if !is_success(&response) {
let status = u16::try_from(response.status_code).map_err(Error::StatusCode)?;
let message = response.as_str().unwrap_or_default().to_string();
return Err(Error::HttpResponse { status, message });
}

Ok(deserialize::<T>(response.as_bytes())?)
Ok(deserialize::<T>(&response.body)?)
}

/// Makes a GET request to `path`, returning `None` on a 404 response.
Expand Down Expand Up @@ -215,14 +233,7 @@ impl<S: Sleeper> AsyncClient<S> {
path: &str,
) -> Result<T, Error> {
let response = self.get_with_retry(path).await?;

if !is_success(&response) {
let status = u16::try_from(response.status_code).map_err(Error::StatusCode)?;
let message = response.as_str().unwrap_or_default().to_string();
return Err(Error::HttpResponse { status, message });
}

response.json::<T>().map_err(Error::BitReq)
response.json::<T>()
}

/// Makes a GET request to `path`, returning `None` on a 404 response.
Expand Down Expand Up @@ -250,13 +261,6 @@ impl<S: Sleeper> AsyncClient<S> {
/// or consensus deserialization fails.
async fn get_response_hex<T: Decodable>(&self, path: &str) -> Result<T, Error> {
let response = self.get_with_retry(path).await?;

if !is_success(&response) {
let status = u16::try_from(response.status_code).map_err(Error::StatusCode)?;
let message = response.as_str().unwrap_or_default().to_string();
return Err(Error::HttpResponse { status, message });
}

let hex_str = response.as_str()?;
Ok(deserialize(&Vec::from_hex(hex_str)?)?)
}
Expand All @@ -282,13 +286,6 @@ impl<S: Sleeper> AsyncClient<S> {
/// Returns an [`Error`] if the request fails.
async fn get_response_text(&self, path: &str) -> Result<String, Error> {
let response = self.get_with_retry(path).await?;

if !is_success(&response) {
let status = u16::try_from(response.status_code).map_err(Error::StatusCode)?;
let message = response.as_str().unwrap_or_default().to_string();
return Err(Error::HttpResponse { status, message });
}

Ok(response.as_str()?.to_string())
}

Expand Down Expand Up @@ -317,22 +314,9 @@ impl<S: Sleeper> AsyncClient<S> {
path: &str,
body: T,
query_params: Option<HashSet<(&str, String)>>,
) -> Result<Response, Error> {
let mut request: bitreq::Request = self.build_request(Method::Post, path)?.with_body(body);

for (key, value) in query_params.unwrap_or_default() {
request = request.with_param(key, value);
}

let response = request.send_async_with_client(&self.client).await?;

if !is_success(&response) {
let status = u16::try_from(response.status_code).map_err(Error::StatusCode)?;
let message = response.as_str().unwrap_or_default().to_string();
return Err(Error::HttpResponse { status, message });
}

Ok(response)
) -> Result<HttpResponse, Error> {
let response = self.send_post(path, body.into(), query_params).await?;
response.error_for_status()
}

/// Get a raw [`Transaction`] given its [`Txid`].
Expand Down
74 changes: 20 additions & 54 deletions src/blocking.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,12 @@
//! [Esplora]: https://github.com/Blockstream/esplora/blob/master/API.md

use std::collections::{HashMap, HashSet};
use std::convert::TryFrom;
use std::str::FromStr;
use std::thread;
use std::time::Duration;

use bitcoin::consensus::encode::serialize_hex;
use bitreq::{Method, Proxy, Request, Response};
use bitreq::{Method, Proxy, Request};

use bitcoin::block::Header as BlockHeader;
use bitcoin::consensus::{deserialize, serialize, Decodable};
Expand All @@ -43,8 +42,8 @@ use bitcoin::hex::{DisplayHex, FromHex};
use bitcoin::{Address, Amount, Block, BlockHash, FeeRate, MerkleBlock, Script, Transaction, Txid};

use crate::{
duration_to_timeout_secs, is_retryable, is_success, sat_per_vbyte_to_feerate, AddressStats,
BlockInfo, BlockStatus, Builder, Error, EsploraTx, MempoolRecentTx, MempoolStats, MerkleProof,
duration_to_timeout_secs, sat_per_vbyte_to_feerate, AddressStats, BlockInfo, BlockStatus,
Builder, Error, EsploraTx, HttpResponse, MempoolRecentTx, MempoolStats, MerkleProof,
OutputStatus, ScriptHashStats, SubmitPackageResult, TxStatus, Utxo, BASE_BACKOFF_MILLIS,
};

Expand Down Expand Up @@ -133,43 +132,38 @@ impl BlockingClient {
///
/// This function will return an error either from the HTTP client, or the
/// response's [`serde_json`] deserialization.
pub fn post_request<T: Into<Vec<u8>>>(
fn post_request<T: Into<Vec<u8>>>(
&self,
path: &str,
body: T,
query_params: Option<HashSet<(&str, String)>>,
) -> Result<Response, Error> {
) -> Result<HttpResponse, Error> {
let mut request = self.build_request(Method::Post, path)?.with_body(body);

for (key, value) in query_params.unwrap_or_default() {
request = request.with_param(key, value);
}

let response = request.send()?;

if !is_success(&response) {
let status = u16::try_from(response.status_code).map_err(Error::StatusCode)?;
let message = response.as_str().unwrap_or_default().to_string();
return Err(Error::HttpResponse { status, message });
}

Ok(response)
let response = HttpResponse::from_bitreq(request.send()?)?;
response.error_for_status()
}

/// Sends a GET request to `url`, retrying on retryable status codes
/// with exponential backoff until [`BlockingClient::max_retries`] is reached.
fn get_with_retry(&self, url: &str) -> Result<Response, Error> {
fn get_with_retry(&self, url: &str) -> Result<HttpResponse, Error> {
let mut delay = BASE_BACKOFF_MILLIS;
let mut attempts = 0;

loop {
match self.build_request(Method::Get, url)?.send()? {
resp if attempts < self.max_retries && is_retryable(&resp) => {
thread::sleep(delay);
attempts += 1;
delay *= 2;
}
resp => return Ok(resp),
let response =
HttpResponse::from_bitreq(self.build_request(Method::Get, url)?.send()?)?;

if attempts < self.max_retries && response.is_retryable() {
thread::sleep(delay);
attempts += 1;
delay *= 2;
} else {
return response.error_for_status();
}
}
}
Expand All @@ -184,14 +178,7 @@ impl BlockingClient {
/// Returns an [`Error`] if the request fails or deserialization fails.
fn get_response<T: Decodable>(&self, path: &str) -> Result<T, Error> {
let response = self.get_with_retry(path)?;

if !is_success(&response) {
let status = u16::try_from(response.status_code).map_err(Error::StatusCode)?;
let message = response.as_str().unwrap_or_default().to_string();
return Err(Error::HttpResponse { status, message });
}

Ok(deserialize::<T>(response.as_bytes())?)
Ok(deserialize::<T>(&response.body)?)
}

/// Makes a GET request to `path`, returning `None` on a 404 response.
Expand All @@ -216,15 +203,8 @@ impl BlockingClient {
/// or consensus deserialization fails.
fn get_response_hex<T: Decodable>(&self, path: &str) -> Result<T, Error> {
let response = self.get_with_retry(path)?;

if !is_success(&response) {
let status = u16::try_from(response.status_code).map_err(Error::StatusCode)?;
let message = response.as_str().unwrap_or_default().to_string();
return Err(Error::HttpResponse { status, message });
}

let hex_str = response.as_str()?;
deserialize(&Vec::from_hex(hex_str)?).map_err(Error::BitcoinEncoding)
Ok(deserialize(&Vec::from_hex(hex_str)?)?)
}

/// Makes a GET request to `path`, returning `None` on a 404 response.
Expand Down Expand Up @@ -252,14 +232,7 @@ impl BlockingClient {
path: &'a str,
) -> Result<T, Error> {
let response = self.get_with_retry(path)?;

if !is_success(&response) {
let status = u16::try_from(response.status_code).map_err(Error::StatusCode)?;
let message = response.as_str().unwrap_or_default().to_string();
return Err(Error::HttpResponse { status, message });
}

response.json::<T>().map_err(Error::BitReq)
response.json::<T>()
}

/// Makes a GET request to `path`, returning `None` on a 404 response.
Expand All @@ -286,13 +259,6 @@ impl BlockingClient {
/// Returns an [`Error`] if the request fails.
fn get_response_text(&self, path: &str) -> Result<String, Error> {
let response = self.get_with_retry(path)?;

if !is_success(&response) {
let status = u16::try_from(response.status_code).map_err(Error::StatusCode)?;
let message = response.as_str().unwrap_or_default().to_string();
return Err(Error::HttpResponse { status, message });
}

Ok(response.as_str()?.to_string())
}

Expand Down
Loading
Loading