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
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
use std::fmt::Debug;
use std::fmt::Formatter;
use std::future;
use std::mem;
use std::ops::Deref;
use std::str::FromStr;
use std::sync::Arc;
use futures::Future;
use futures::TryStreamExt;
use http::Request;
use http::Response;
use once_cell::sync::Lazy;
use raw::oio::Read;
use super::parse_content_encoding;
use super::parse_content_length;
use super::HttpBody;
use crate::raw::*;
use crate::*;
/// Http client used across opendal for loading credentials.
/// This is merely a temporary solution because reqsign requires a reqwest client to be passed.
/// We will remove it after the next major version of reqsign, which will enable users to provide their own client.
#[allow(dead_code)]
pub(crate) static GLOBAL_REQWEST_CLIENT: Lazy<reqwest::Client> = Lazy::new(reqwest::Client::new);
/// HttpFetcher is a type erased [`HttpFetch`].
pub type HttpFetcher = Arc<dyn HttpFetchDyn>;
/// HttpClient that used across opendal.
#[derive(Clone)]
pub struct HttpClient {
fetcher: HttpFetcher,
}
/// We don't want users to know details about our clients.
impl Debug for HttpClient {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("HttpClient").finish()
}
}
impl HttpClient {
/// Create a new http client in async context.
pub fn new() -> Result<Self> {
let fetcher = Arc::new(reqwest::Client::new());
Ok(Self { fetcher })
}
/// Construct `Self` with given [`reqwest::Client`]
pub fn with(client: impl HttpFetch) -> Self {
let fetcher = Arc::new(client);
Self { fetcher }
}
/// Build a new http client in async context.
#[deprecated]
pub fn build(builder: reqwest::ClientBuilder) -> Result<Self> {
let client = builder.build().map_err(|err| {
Error::new(ErrorKind::Unexpected, "http client build failed").set_source(err)
})?;
let fetcher = Arc::new(client);
Ok(Self { fetcher })
}
/// Send a request in async way.
pub async fn send(&self, req: Request<Buffer>) -> Result<Response<Buffer>> {
let (parts, mut body) = self.fetch(req).await?.into_parts();
let buffer = body.read_all().await?;
Ok(Response::from_parts(parts, buffer))
}
/// Fetch a request in async way.
pub async fn fetch(&self, req: Request<Buffer>) -> Result<Response<HttpBody>> {
self.fetcher.fetch(req).await
}
}
/// HttpFetch is the trait to fetch a request in async way.
/// User should implement this trait to provide their own http client.
pub trait HttpFetch: Send + Sync + Unpin + 'static {
/// Fetch a request in async way.
fn fetch(
&self,
req: Request<Buffer>,
) -> impl Future<Output = Result<Response<HttpBody>>> + MaybeSend;
}
/// HttpFetchDyn is the dyn version of [`HttpFetch`]
/// which make it possible to use as `Arc<dyn HttpFetchDyn>`.
/// User should never implement this trait, but use `HttpFetch` instead.
pub trait HttpFetchDyn: Send + Sync + Unpin + 'static {
/// The dyn version of [`HttpFetch::fetch`].
///
/// This function returns a boxed future to make it object safe.
fn fetch_dyn(&self, req: Request<Buffer>) -> BoxedFuture<Result<Response<HttpBody>>>;
}
impl<T: HttpFetch + ?Sized> HttpFetchDyn for T {
fn fetch_dyn(&self, req: Request<Buffer>) -> BoxedFuture<Result<Response<HttpBody>>> {
Box::pin(self.fetch(req))
}
}
impl<T: HttpFetchDyn + ?Sized> HttpFetch for Arc<T> {
async fn fetch(&self, req: Request<Buffer>) -> Result<Response<HttpBody>> {
self.deref().fetch_dyn(req).await
}
}
impl HttpFetch for reqwest::Client {
async fn fetch(&self, req: Request<Buffer>) -> Result<Response<HttpBody>> {
// Uri stores all string alike data in `Bytes` which means
// the clone here is cheap.
let uri = req.uri().clone();
let is_head = req.method() == http::Method::HEAD;
let (parts, body) = req.into_parts();
let mut req_builder = self
.request(
parts.method,
reqwest::Url::from_str(&uri.to_string()).expect("input request url must be valid"),
)
.headers(parts.headers);
// Client under wasm doesn't support set version.
#[cfg(not(target_arch = "wasm32"))]
{
req_builder = req_builder.version(parts.version);
}
// Don't set body if body is empty.
if !body.is_empty() {
#[cfg(not(target_arch = "wasm32"))]
{
req_builder = req_builder.body(reqwest::Body::wrap_stream(body))
}
#[cfg(target_arch = "wasm32")]
{
req_builder = req_builder.body(reqwest::Body::from(body.to_bytes()))
}
}
let mut resp = req_builder.send().await.map_err(|err| {
Error::new(ErrorKind::Unexpected, "send http request")
.with_operation("http_util::Client::send")
.with_context("url", uri.to_string())
.with_temporary(is_temporary_error(&err))
.set_source(err)
})?;
// Get content length from header so that we can check it.
//
// - If the request method is HEAD, we will ignore content length.
// - If response contains content_encoding, we should omit its content length.
let content_length = if is_head || parse_content_encoding(resp.headers())?.is_some() {
None
} else {
parse_content_length(resp.headers())?
};
let mut hr = Response::builder()
.status(resp.status())
// Insert uri into response extension so that we can fetch
// it later.
.extension(uri.clone());
// Response builder under wasm doesn't support set version.
#[cfg(not(target_arch = "wasm32"))]
{
hr = hr.version(resp.version());
}
// Swap headers directly instead of copy the entire map.
mem::swap(hr.headers_mut().unwrap(), resp.headers_mut());
let bs = HttpBody::new(
resp.bytes_stream()
.try_filter(|v| future::ready(!v.is_empty()))
.map_ok(Buffer::from)
.map_err(move |err| {
Error::new(ErrorKind::Unexpected, "read data from http response")
.with_operation("http_util::Client::send")
.with_context("url", uri.to_string())
.with_temporary(is_temporary_error(&err))
.set_source(err)
}),
content_length,
);
let resp = hr.body(bs).expect("response must build succeed");
Ok(resp)
}
}
#[inline]
fn is_temporary_error(err: &reqwest::Error) -> bool {
// error sending request
err.is_request()||
// request or response body error
err.is_body() ||
// error decoding response body, for example, connection reset.
err.is_decode()
}