mirror of
https://github.com/fafhrd91/actix-web
synced 2025-02-21 20:02:47 +01:00
add client middleware (#2013)
This commit is contained in:
parent
badae2f8fd
commit
c836de44af
@ -47,7 +47,7 @@ trust-dns = ["actix-http/trust-dns"]
|
|||||||
actix-codec = "0.4.0-beta.1"
|
actix-codec = "0.4.0-beta.1"
|
||||||
actix-service = "2.0.0-beta.4"
|
actix-service = "2.0.0-beta.4"
|
||||||
actix-http = "3.0.0-beta.3"
|
actix-http = "3.0.0-beta.3"
|
||||||
actix-rt = "2.1"
|
actix-rt = { version = "2.1", default-features = false }
|
||||||
|
|
||||||
base64 = "0.13"
|
base64 = "0.13"
|
||||||
bytes = "1"
|
bytes = "1"
|
||||||
@ -57,6 +57,7 @@ futures-core = { version = "0.3.7", default-features = false }
|
|||||||
log =" 0.4"
|
log =" 0.4"
|
||||||
mime = "0.3"
|
mime = "0.3"
|
||||||
percent-encoding = "2.1"
|
percent-encoding = "2.1"
|
||||||
|
pin-project-lite = "0.2"
|
||||||
rand = "0.8"
|
rand = "0.8"
|
||||||
serde = "1.0"
|
serde = "1.0"
|
||||||
serde_json = "1.0"
|
serde_json = "1.0"
|
||||||
|
@ -10,24 +10,27 @@ use actix_http::{
|
|||||||
http::{self, header, Error as HttpError, HeaderMap, HeaderName, Uri},
|
http::{self, header, Error as HttpError, HeaderMap, HeaderName, Uri},
|
||||||
};
|
};
|
||||||
use actix_rt::net::TcpStream;
|
use actix_rt::net::TcpStream;
|
||||||
use actix_service::Service;
|
use actix_service::{boxed, Service};
|
||||||
|
|
||||||
use crate::connect::ConnectorWrapper;
|
use crate::connect::DefaultConnector;
|
||||||
use crate::{Client, ClientConfig};
|
use crate::error::SendRequestError;
|
||||||
|
use crate::middleware::{NestTransform, Transform};
|
||||||
|
use crate::{Client, ClientConfig, ConnectRequest, ConnectResponse, ConnectorService};
|
||||||
|
|
||||||
/// An HTTP Client builder
|
/// An HTTP Client builder
|
||||||
///
|
///
|
||||||
/// This type can be used to construct an instance of `Client` through a
|
/// This type can be used to construct an instance of `Client` through a
|
||||||
/// builder-like pattern.
|
/// builder-like pattern.
|
||||||
pub struct ClientBuilder<T = (), U = ()> {
|
pub struct ClientBuilder<S = (), Io = (), M = ()> {
|
||||||
default_headers: bool,
|
default_headers: bool,
|
||||||
max_http_version: Option<http::Version>,
|
max_http_version: Option<http::Version>,
|
||||||
stream_window_size: Option<u32>,
|
stream_window_size: Option<u32>,
|
||||||
conn_window_size: Option<u32>,
|
conn_window_size: Option<u32>,
|
||||||
headers: HeaderMap,
|
headers: HeaderMap,
|
||||||
timeout: Option<Duration>,
|
timeout: Option<Duration>,
|
||||||
|
connector: Connector<S, Io>,
|
||||||
|
middleware: M,
|
||||||
local_address: Option<IpAddr>,
|
local_address: Option<IpAddr>,
|
||||||
connector: Connector<T, U>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl ClientBuilder {
|
impl ClientBuilder {
|
||||||
@ -39,8 +42,10 @@ impl ClientBuilder {
|
|||||||
Error = TcpConnectError,
|
Error = TcpConnectError,
|
||||||
> + Clone,
|
> + Clone,
|
||||||
TcpStream,
|
TcpStream,
|
||||||
|
(),
|
||||||
> {
|
> {
|
||||||
ClientBuilder {
|
ClientBuilder {
|
||||||
|
middleware: (),
|
||||||
default_headers: true,
|
default_headers: true,
|
||||||
headers: HeaderMap::new(),
|
headers: HeaderMap::new(),
|
||||||
timeout: Some(Duration::from_secs(5)),
|
timeout: Some(Duration::from_secs(5)),
|
||||||
@ -53,7 +58,7 @@ impl ClientBuilder {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<S, Io> ClientBuilder<S, Io>
|
impl<S, Io, M> ClientBuilder<S, Io, M>
|
||||||
where
|
where
|
||||||
S: Service<TcpConnect<Uri>, Response = TcpConnection<Uri, Io>, Error = TcpConnectError>
|
S: Service<TcpConnect<Uri>, Response = TcpConnection<Uri, Io>, Error = TcpConnectError>
|
||||||
+ Clone
|
+ Clone
|
||||||
@ -61,7 +66,7 @@ where
|
|||||||
Io: AsyncRead + AsyncWrite + Unpin + fmt::Debug + 'static,
|
Io: AsyncRead + AsyncWrite + Unpin + fmt::Debug + 'static,
|
||||||
{
|
{
|
||||||
/// Use custom connector service.
|
/// Use custom connector service.
|
||||||
pub fn connector<S1, Io1>(self, connector: Connector<S1, Io1>) -> ClientBuilder<S1, Io1>
|
pub fn connector<S1, Io1>(self, connector: Connector<S1, Io1>) -> ClientBuilder<S1, Io1, M>
|
||||||
where
|
where
|
||||||
S1: Service<
|
S1: Service<
|
||||||
TcpConnect<Uri>,
|
TcpConnect<Uri>,
|
||||||
@ -72,10 +77,11 @@ where
|
|||||||
Io1: AsyncRead + AsyncWrite + Unpin + fmt::Debug + 'static,
|
Io1: AsyncRead + AsyncWrite + Unpin + fmt::Debug + 'static,
|
||||||
{
|
{
|
||||||
ClientBuilder {
|
ClientBuilder {
|
||||||
|
middleware: self.middleware,
|
||||||
default_headers: self.default_headers,
|
default_headers: self.default_headers,
|
||||||
headers: self.headers,
|
headers: self.headers,
|
||||||
timeout: self.timeout,
|
timeout: self.timeout,
|
||||||
local_address: None,
|
local_address: self.local_address,
|
||||||
connector,
|
connector,
|
||||||
max_http_version: self.max_http_version,
|
max_http_version: self.max_http_version,
|
||||||
stream_window_size: self.stream_window_size,
|
stream_window_size: self.stream_window_size,
|
||||||
@ -181,8 +187,38 @@ where
|
|||||||
self.header(header::AUTHORIZATION, format!("Bearer {}", token))
|
self.header(header::AUTHORIZATION, format!("Bearer {}", token))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Registers middleware, in the form of a middleware component (type),
|
||||||
|
/// that runs during inbound and/or outbound processing in the request
|
||||||
|
/// life-cycle (request -> response), modifying request/response as
|
||||||
|
/// necessary, across all requests managed by the Client.
|
||||||
|
pub fn wrap<S1, M1>(
|
||||||
|
self,
|
||||||
|
mw: M1,
|
||||||
|
) -> ClientBuilder<S, Io, NestTransform<M, M1, S1, ConnectRequest>>
|
||||||
|
where
|
||||||
|
M: Transform<S1, ConnectRequest>,
|
||||||
|
M1: Transform<M::Transform, ConnectRequest>,
|
||||||
|
{
|
||||||
|
ClientBuilder {
|
||||||
|
middleware: NestTransform::new(self.middleware, mw),
|
||||||
|
default_headers: self.default_headers,
|
||||||
|
max_http_version: self.max_http_version,
|
||||||
|
stream_window_size: self.stream_window_size,
|
||||||
|
conn_window_size: self.conn_window_size,
|
||||||
|
headers: self.headers,
|
||||||
|
timeout: self.timeout,
|
||||||
|
connector: self.connector,
|
||||||
|
local_address: self.local_address,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Finish build process and create `Client` instance.
|
/// Finish build process and create `Client` instance.
|
||||||
pub fn finish(self) -> Client {
|
pub fn finish(self) -> Client
|
||||||
|
where
|
||||||
|
M: Transform<ConnectorService, ConnectRequest> + 'static,
|
||||||
|
M::Transform:
|
||||||
|
Service<ConnectRequest, Response = ConnectResponse, Error = SendRequestError>,
|
||||||
|
{
|
||||||
let mut connector = self.connector;
|
let mut connector = self.connector;
|
||||||
|
|
||||||
if let Some(val) = self.max_http_version {
|
if let Some(val) = self.max_http_version {
|
||||||
@ -198,10 +234,13 @@ where
|
|||||||
connector = connector.local_address(val);
|
connector = connector.local_address(val);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let connector = boxed::service(DefaultConnector::new(connector.finish()));
|
||||||
|
let connector = boxed::service(self.middleware.new_transform(connector));
|
||||||
|
|
||||||
let config = ClientConfig {
|
let config = ClientConfig {
|
||||||
headers: self.headers,
|
headers: self.headers,
|
||||||
timeout: self.timeout,
|
timeout: self.timeout,
|
||||||
connector: Box::new(ConnectorWrapper::new(connector.finish())) as _,
|
connector,
|
||||||
};
|
};
|
||||||
|
|
||||||
Client(Rc::new(config))
|
Client(Rc::new(config))
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
use std::{
|
use std::{
|
||||||
fmt, io, net,
|
fmt,
|
||||||
|
future::Future,
|
||||||
|
io, net,
|
||||||
pin::Pin,
|
pin::Pin,
|
||||||
task::{Context, Poll},
|
task::{Context, Poll},
|
||||||
};
|
};
|
||||||
@ -9,24 +11,14 @@ use actix_http::{
|
|||||||
body::Body,
|
body::Body,
|
||||||
client::{Connect as ClientConnect, ConnectError, Connection, SendRequestError},
|
client::{Connect as ClientConnect, ConnectError, Connection, SendRequestError},
|
||||||
h1::ClientCodec,
|
h1::ClientCodec,
|
||||||
RequestHead, RequestHeadType, ResponseHead,
|
Payload, RequestHead, RequestHeadType, ResponseHead,
|
||||||
};
|
};
|
||||||
use actix_service::Service;
|
use actix_service::Service;
|
||||||
use futures_core::future::LocalBoxFuture;
|
use futures_core::{future::LocalBoxFuture, ready};
|
||||||
|
|
||||||
use crate::response::ClientResponse;
|
use crate::response::ClientResponse;
|
||||||
|
|
||||||
pub(crate) struct ConnectorWrapper<T> {
|
pub type ConnectorService = Box<
|
||||||
connector: T,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> ConnectorWrapper<T> {
|
|
||||||
pub(crate) fn new(connector: T) -> Self {
|
|
||||||
Self { connector }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub type ConnectService = Box<
|
|
||||||
dyn Service<
|
dyn Service<
|
||||||
ConnectRequest,
|
ConnectRequest,
|
||||||
Response = ConnectResponse,
|
Response = ConnectResponse,
|
||||||
@ -65,16 +57,25 @@ impl ConnectResponse {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T> Service<ConnectRequest> for ConnectorWrapper<T>
|
pub(crate) struct DefaultConnector<S> {
|
||||||
|
connector: S,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<S> DefaultConnector<S> {
|
||||||
|
pub(crate) fn new(connector: S) -> Self {
|
||||||
|
Self { connector }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<S> Service<ConnectRequest> for DefaultConnector<S>
|
||||||
where
|
where
|
||||||
T: Service<ClientConnect, Error = ConnectError>,
|
S: Service<ClientConnect, Error = ConnectError>,
|
||||||
T::Response: Connection,
|
S::Response: Connection,
|
||||||
<T::Response as Connection>::Io: 'static,
|
<S::Response as Connection>::Io: 'static,
|
||||||
T::Future: 'static,
|
|
||||||
{
|
{
|
||||||
type Response = ConnectResponse;
|
type Response = ConnectResponse;
|
||||||
type Error = SendRequestError;
|
type Error = SendRequestError;
|
||||||
type Future = LocalBoxFuture<'static, Result<Self::Response, Self::Error>>;
|
type Future = ConnectRequestFuture<S::Future, <S::Response as Connection>::Io>;
|
||||||
|
|
||||||
actix_service::forward_ready!(connector);
|
actix_service::forward_ready!(connector);
|
||||||
|
|
||||||
@ -91,26 +92,76 @@ where
|
|||||||
}),
|
}),
|
||||||
};
|
};
|
||||||
|
|
||||||
Box::pin(async move {
|
ConnectRequestFuture::Connection {
|
||||||
let connection = fut.await?;
|
fut,
|
||||||
|
req: Some(req),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
match req {
|
pin_project_lite::pin_project! {
|
||||||
ConnectRequest::Client(head, body, ..) => {
|
#[project = ConnectRequestProj]
|
||||||
// send request
|
pub(crate) enum ConnectRequestFuture<Fut, Io> {
|
||||||
let (head, payload) = connection.send_request(head, body).await?;
|
Connection {
|
||||||
|
#[pin]
|
||||||
|
fut: Fut,
|
||||||
|
req: Option<ConnectRequest>
|
||||||
|
},
|
||||||
|
Client {
|
||||||
|
fut: LocalBoxFuture<'static, Result<(ResponseHead, Payload), SendRequestError>>
|
||||||
|
},
|
||||||
|
Tunnel {
|
||||||
|
fut: LocalBoxFuture<
|
||||||
|
'static,
|
||||||
|
Result<(ResponseHead, Framed<Io, ClientCodec>), SendRequestError>,
|
||||||
|
>,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
Ok(ConnectResponse::Client(ClientResponse::new(head, payload)))
|
impl<Fut, C, Io> Future for ConnectRequestFuture<Fut, Io>
|
||||||
}
|
where
|
||||||
ConnectRequest::Tunnel(head, ..) => {
|
Fut: Future<Output = Result<C, ConnectError>>,
|
||||||
// send request
|
C: Connection<Io = Io>,
|
||||||
let (head, framed) =
|
Io: AsyncRead + AsyncWrite + Unpin + 'static,
|
||||||
connection.open_tunnel(RequestHeadType::from(head)).await?;
|
{
|
||||||
|
type Output = Result<ConnectResponse, SendRequestError>;
|
||||||
let framed = framed.into_map_io(|io| BoxedSocket(Box::new(Socket(io))));
|
|
||||||
Ok(ConnectResponse::Tunnel(head, framed))
|
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
|
||||||
|
match self.as_mut().project() {
|
||||||
|
ConnectRequestProj::Connection { fut, req } => {
|
||||||
|
let connection = ready!(fut.poll(cx))?;
|
||||||
|
let req = req.take().unwrap();
|
||||||
|
match req {
|
||||||
|
ConnectRequest::Client(head, body, ..) => {
|
||||||
|
// send request
|
||||||
|
let fut = ConnectRequestFuture::Client {
|
||||||
|
fut: connection.send_request(head, body),
|
||||||
|
};
|
||||||
|
self.as_mut().set(fut);
|
||||||
|
}
|
||||||
|
ConnectRequest::Tunnel(head, ..) => {
|
||||||
|
// send request
|
||||||
|
let fut = ConnectRequestFuture::Tunnel {
|
||||||
|
fut: connection.open_tunnel(RequestHeadType::from(head)),
|
||||||
|
};
|
||||||
|
self.as_mut().set(fut);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
self.poll(cx)
|
||||||
}
|
}
|
||||||
})
|
ConnectRequestProj::Client { fut } => {
|
||||||
|
let (head, payload) = ready!(fut.as_mut().poll(cx))?;
|
||||||
|
Poll::Ready(Ok(ConnectResponse::Client(ClientResponse::new(
|
||||||
|
head, payload,
|
||||||
|
))))
|
||||||
|
}
|
||||||
|
ConnectRequestProj::Tunnel { fut } => {
|
||||||
|
let (head, framed) = ready!(fut.as_mut().poll(cx))?;
|
||||||
|
let framed = framed.into_map_io(|io| BoxedSocket(Box::new(Socket(io))));
|
||||||
|
Poll::Ready(Ok(ConnectResponse::Tunnel(head, framed)))
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -107,12 +107,13 @@ use actix_http::{
|
|||||||
RequestHead,
|
RequestHead,
|
||||||
};
|
};
|
||||||
use actix_rt::net::TcpStream;
|
use actix_rt::net::TcpStream;
|
||||||
use actix_service::Service;
|
use actix_service::{boxed, Service};
|
||||||
|
|
||||||
mod builder;
|
mod builder;
|
||||||
mod connect;
|
mod connect;
|
||||||
pub mod error;
|
pub mod error;
|
||||||
mod frozen;
|
mod frozen;
|
||||||
|
pub mod middleware;
|
||||||
mod request;
|
mod request;
|
||||||
mod response;
|
mod response;
|
||||||
mod sender;
|
mod sender;
|
||||||
@ -120,14 +121,12 @@ pub mod test;
|
|||||||
pub mod ws;
|
pub mod ws;
|
||||||
|
|
||||||
pub use self::builder::ClientBuilder;
|
pub use self::builder::ClientBuilder;
|
||||||
pub use self::connect::{BoxedSocket, ConnectRequest, ConnectResponse, ConnectService};
|
pub use self::connect::{BoxedSocket, ConnectRequest, ConnectResponse, ConnectorService};
|
||||||
pub use self::frozen::{FrozenClientRequest, FrozenSendBuilder};
|
pub use self::frozen::{FrozenClientRequest, FrozenSendBuilder};
|
||||||
pub use self::request::ClientRequest;
|
pub use self::request::ClientRequest;
|
||||||
pub use self::response::{ClientResponse, JsonBody, MessageBody};
|
pub use self::response::{ClientResponse, JsonBody, MessageBody};
|
||||||
pub use self::sender::SendClientRequest;
|
pub use self::sender::SendClientRequest;
|
||||||
|
|
||||||
use self::connect::ConnectorWrapper;
|
|
||||||
|
|
||||||
/// An asynchronous HTTP and WebSocket client.
|
/// An asynchronous HTTP and WebSocket client.
|
||||||
///
|
///
|
||||||
/// ## Examples
|
/// ## Examples
|
||||||
@ -151,7 +150,7 @@ use self::connect::ConnectorWrapper;
|
|||||||
pub struct Client(Rc<ClientConfig>);
|
pub struct Client(Rc<ClientConfig>);
|
||||||
|
|
||||||
pub(crate) struct ClientConfig {
|
pub(crate) struct ClientConfig {
|
||||||
pub(crate) connector: ConnectService,
|
pub(crate) connector: ConnectorService,
|
||||||
pub(crate) headers: HeaderMap,
|
pub(crate) headers: HeaderMap,
|
||||||
pub(crate) timeout: Option<Duration>,
|
pub(crate) timeout: Option<Duration>,
|
||||||
}
|
}
|
||||||
@ -159,7 +158,9 @@ pub(crate) struct ClientConfig {
|
|||||||
impl Default for Client {
|
impl Default for Client {
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
Client(Rc::new(ClientConfig {
|
Client(Rc::new(ClientConfig {
|
||||||
connector: Box::new(ConnectorWrapper::new(Connector::new().finish())),
|
connector: boxed::service(self::connect::DefaultConnector::new(
|
||||||
|
Connector::new().finish(),
|
||||||
|
)),
|
||||||
headers: HeaderMap::new(),
|
headers: HeaderMap::new(),
|
||||||
timeout: Some(Duration::from_secs(5)),
|
timeout: Some(Duration::from_secs(5)),
|
||||||
}))
|
}))
|
||||||
|
71
awc/src/middleware/mod.rs
Normal file
71
awc/src/middleware/mod.rs
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
mod redirect;
|
||||||
|
|
||||||
|
pub use self::redirect::Redirect;
|
||||||
|
|
||||||
|
use std::marker::PhantomData;
|
||||||
|
|
||||||
|
use actix_service::Service;
|
||||||
|
|
||||||
|
/// Trait for transform a type to another one.
|
||||||
|
/// Both the input and output type should impl [actix_service::Service] trait.
|
||||||
|
pub trait Transform<S, Req> {
|
||||||
|
type Transform: Service<Req>;
|
||||||
|
|
||||||
|
/// Creates and returns a new Transform component.
|
||||||
|
fn new_transform(self, service: S) -> Self::Transform;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[doc(hidden)]
|
||||||
|
/// Helper struct for constructing Nested types that would call `Transform::new_transform`
|
||||||
|
/// in a chain.
|
||||||
|
///
|
||||||
|
/// The child field would be called first and the output `Service` type is
|
||||||
|
/// passed to parent as input type.
|
||||||
|
pub struct NestTransform<T1, T2, S, Req>
|
||||||
|
where
|
||||||
|
T1: Transform<S, Req>,
|
||||||
|
T2: Transform<T1::Transform, Req>,
|
||||||
|
{
|
||||||
|
child: T1,
|
||||||
|
parent: T2,
|
||||||
|
_service: PhantomData<(S, Req)>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T1, T2, S, Req> NestTransform<T1, T2, S, Req>
|
||||||
|
where
|
||||||
|
T1: Transform<S, Req>,
|
||||||
|
T2: Transform<T1::Transform, Req>,
|
||||||
|
{
|
||||||
|
pub(crate) fn new(child: T1, parent: T2) -> Self {
|
||||||
|
NestTransform {
|
||||||
|
child,
|
||||||
|
parent,
|
||||||
|
_service: PhantomData,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T1, T2, S, Req> Transform<S, Req> for NestTransform<T1, T2, S, Req>
|
||||||
|
where
|
||||||
|
T1: Transform<S, Req>,
|
||||||
|
T2: Transform<T1::Transform, Req>,
|
||||||
|
{
|
||||||
|
type Transform = T2::Transform;
|
||||||
|
|
||||||
|
fn new_transform(self, service: S) -> Self::Transform {
|
||||||
|
let service = self.child.new_transform(service);
|
||||||
|
self.parent.new_transform(service)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Dummy impl for kick start `NestTransform` type in `ClientBuilder` type
|
||||||
|
impl<S, Req> Transform<S, Req> for ()
|
||||||
|
where
|
||||||
|
S: Service<Req>,
|
||||||
|
{
|
||||||
|
type Transform = S;
|
||||||
|
|
||||||
|
fn new_transform(self, service: S) -> Self::Transform {
|
||||||
|
service
|
||||||
|
}
|
||||||
|
}
|
350
awc/src/middleware/redirect.rs
Normal file
350
awc/src/middleware/redirect.rs
Normal file
@ -0,0 +1,350 @@
|
|||||||
|
use std::{
|
||||||
|
convert::TryFrom,
|
||||||
|
future::Future,
|
||||||
|
net::SocketAddr,
|
||||||
|
pin::Pin,
|
||||||
|
rc::Rc,
|
||||||
|
task::{Context, Poll},
|
||||||
|
};
|
||||||
|
|
||||||
|
use actix_http::{
|
||||||
|
body::Body,
|
||||||
|
client::{InvalidUrl, SendRequestError},
|
||||||
|
http::{header, Method, StatusCode, Uri},
|
||||||
|
RequestHead, RequestHeadType,
|
||||||
|
};
|
||||||
|
use actix_service::Service;
|
||||||
|
use bytes::Bytes;
|
||||||
|
use futures_core::ready;
|
||||||
|
|
||||||
|
use super::Transform;
|
||||||
|
|
||||||
|
use crate::connect::{ConnectRequest, ConnectResponse};
|
||||||
|
use crate::ClientResponse;
|
||||||
|
|
||||||
|
pub struct Redirect {
|
||||||
|
max_redirect_times: u8,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for Redirect {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self::new()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Redirect {
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Self {
|
||||||
|
max_redirect_times: 10,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn max_redirect_times(mut self, times: u8) -> Self {
|
||||||
|
self.max_redirect_times = times;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<S> Transform<S, ConnectRequest> for Redirect
|
||||||
|
where
|
||||||
|
S: Service<ConnectRequest, Response = ConnectResponse, Error = SendRequestError> + 'static,
|
||||||
|
{
|
||||||
|
type Transform = RedirectService<S>;
|
||||||
|
|
||||||
|
fn new_transform(self, service: S) -> Self::Transform {
|
||||||
|
RedirectService {
|
||||||
|
max_redirect_times: self.max_redirect_times,
|
||||||
|
connector: Rc::new(service),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct RedirectService<S> {
|
||||||
|
max_redirect_times: u8,
|
||||||
|
connector: Rc<S>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<S> Service<ConnectRequest> for RedirectService<S>
|
||||||
|
where
|
||||||
|
S: Service<ConnectRequest, Response = ConnectResponse, Error = SendRequestError> + 'static,
|
||||||
|
{
|
||||||
|
type Response = S::Response;
|
||||||
|
type Error = S::Error;
|
||||||
|
type Future = RedirectServiceFuture<S>;
|
||||||
|
|
||||||
|
actix_service::forward_ready!(connector);
|
||||||
|
|
||||||
|
fn call(&self, req: ConnectRequest) -> Self::Future {
|
||||||
|
match req {
|
||||||
|
ConnectRequest::Tunnel(head, addr) => {
|
||||||
|
let fut = self.connector.call(ConnectRequest::Tunnel(head, addr));
|
||||||
|
RedirectServiceFuture::Tunnel { fut }
|
||||||
|
}
|
||||||
|
ConnectRequest::Client(head, body, addr) => {
|
||||||
|
let connector = self.connector.clone();
|
||||||
|
let max_redirect_times = self.max_redirect_times;
|
||||||
|
|
||||||
|
// backup the uri and method for reuse schema and authority.
|
||||||
|
let (uri, method) = match head {
|
||||||
|
RequestHeadType::Owned(ref head) => (head.uri.clone(), head.method.clone()),
|
||||||
|
RequestHeadType::Rc(ref head, ..) => {
|
||||||
|
(head.uri.clone(), head.method.clone())
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let body_opt = match body {
|
||||||
|
Body::Bytes(ref b) => Some(b.clone()),
|
||||||
|
_ => None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let fut = connector.call(ConnectRequest::Client(head, body, addr));
|
||||||
|
|
||||||
|
RedirectServiceFuture::Client {
|
||||||
|
fut,
|
||||||
|
max_redirect_times,
|
||||||
|
uri: Some(uri),
|
||||||
|
method: Some(method),
|
||||||
|
body: body_opt,
|
||||||
|
addr,
|
||||||
|
connector: Some(connector),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pin_project_lite::pin_project! {
|
||||||
|
#[project = RedirectServiceProj]
|
||||||
|
pub enum RedirectServiceFuture<S>
|
||||||
|
where
|
||||||
|
S: Service<ConnectRequest, Response = ConnectResponse, Error = SendRequestError>,
|
||||||
|
S: 'static
|
||||||
|
{
|
||||||
|
Tunnel { #[pin] fut: S::Future },
|
||||||
|
Client {
|
||||||
|
#[pin]
|
||||||
|
fut: S::Future,
|
||||||
|
max_redirect_times: u8,
|
||||||
|
uri: Option<Uri>,
|
||||||
|
method: Option<Method>,
|
||||||
|
body: Option<Bytes>,
|
||||||
|
addr: Option<SocketAddr>,
|
||||||
|
connector: Option<Rc<S>>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<S> Future for RedirectServiceFuture<S>
|
||||||
|
where
|
||||||
|
S: Service<ConnectRequest, Response = ConnectResponse, Error = SendRequestError> + 'static,
|
||||||
|
{
|
||||||
|
type Output = Result<ConnectResponse, SendRequestError>;
|
||||||
|
|
||||||
|
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
|
||||||
|
match self.as_mut().project() {
|
||||||
|
RedirectServiceProj::Tunnel { fut } => fut.poll(cx),
|
||||||
|
RedirectServiceProj::Client {
|
||||||
|
fut,
|
||||||
|
max_redirect_times,
|
||||||
|
uri,
|
||||||
|
method,
|
||||||
|
body,
|
||||||
|
addr,
|
||||||
|
connector,
|
||||||
|
} => match ready!(fut.poll(cx))? {
|
||||||
|
ConnectResponse::Client(res) => match res.head().status {
|
||||||
|
StatusCode::MOVED_PERMANENTLY
|
||||||
|
| StatusCode::FOUND
|
||||||
|
| StatusCode::SEE_OTHER
|
||||||
|
if *max_redirect_times > 0 =>
|
||||||
|
{
|
||||||
|
let org_uri = uri.take().unwrap();
|
||||||
|
// rebuild uri from the location header value.
|
||||||
|
let uri = rebuild_uri(&res, org_uri)?;
|
||||||
|
|
||||||
|
// reset method
|
||||||
|
let method = method.take().unwrap();
|
||||||
|
let method = match method {
|
||||||
|
Method::GET | Method::HEAD => method,
|
||||||
|
_ => Method::GET,
|
||||||
|
};
|
||||||
|
|
||||||
|
// take ownership of states that could be reused
|
||||||
|
let addr = addr.take();
|
||||||
|
let connector = connector.take();
|
||||||
|
let mut max_redirect_times = *max_redirect_times;
|
||||||
|
|
||||||
|
// use a new request head.
|
||||||
|
let mut head = RequestHead::default();
|
||||||
|
head.uri = uri.clone();
|
||||||
|
head.method = method.clone();
|
||||||
|
|
||||||
|
let head = RequestHeadType::Owned(head);
|
||||||
|
|
||||||
|
max_redirect_times -= 1;
|
||||||
|
|
||||||
|
let fut = connector
|
||||||
|
.as_ref()
|
||||||
|
.unwrap()
|
||||||
|
// remove body
|
||||||
|
.call(ConnectRequest::Client(head, Body::None, addr));
|
||||||
|
|
||||||
|
self.as_mut().set(RedirectServiceFuture::Client {
|
||||||
|
fut,
|
||||||
|
max_redirect_times,
|
||||||
|
uri: Some(uri),
|
||||||
|
method: Some(method),
|
||||||
|
// body is dropped on 301,302,303
|
||||||
|
body: None,
|
||||||
|
addr,
|
||||||
|
connector,
|
||||||
|
});
|
||||||
|
|
||||||
|
self.poll(cx)
|
||||||
|
}
|
||||||
|
StatusCode::TEMPORARY_REDIRECT | StatusCode::PERMANENT_REDIRECT
|
||||||
|
if *max_redirect_times > 0 =>
|
||||||
|
{
|
||||||
|
let org_uri = uri.take().unwrap();
|
||||||
|
// rebuild uri from the location header value.
|
||||||
|
let uri = rebuild_uri(&res, org_uri)?;
|
||||||
|
|
||||||
|
// try to reuse body
|
||||||
|
let body = body.take();
|
||||||
|
let body_new = match body {
|
||||||
|
Some(ref bytes) => Body::Bytes(bytes.clone()),
|
||||||
|
// TODO: should this be Body::Empty or Body::None.
|
||||||
|
_ => Body::Empty,
|
||||||
|
};
|
||||||
|
|
||||||
|
let addr = addr.take();
|
||||||
|
let method = method.take().unwrap();
|
||||||
|
let connector = connector.take();
|
||||||
|
let mut max_redirect_times = *max_redirect_times;
|
||||||
|
|
||||||
|
// use a new request head.
|
||||||
|
let mut head = RequestHead::default();
|
||||||
|
head.uri = uri.clone();
|
||||||
|
head.method = method.clone();
|
||||||
|
|
||||||
|
let head = RequestHeadType::Owned(head);
|
||||||
|
|
||||||
|
max_redirect_times -= 1;
|
||||||
|
|
||||||
|
let fut = connector
|
||||||
|
.as_ref()
|
||||||
|
.unwrap()
|
||||||
|
.call(ConnectRequest::Client(head, body_new, addr));
|
||||||
|
|
||||||
|
self.as_mut().set(RedirectServiceFuture::Client {
|
||||||
|
fut,
|
||||||
|
max_redirect_times,
|
||||||
|
uri: Some(uri),
|
||||||
|
method: Some(method),
|
||||||
|
body,
|
||||||
|
addr,
|
||||||
|
connector,
|
||||||
|
});
|
||||||
|
|
||||||
|
self.poll(cx)
|
||||||
|
}
|
||||||
|
_ => Poll::Ready(Ok(ConnectResponse::Client(res))),
|
||||||
|
},
|
||||||
|
_ => unreachable!("ConnectRequest::Tunnel is not handled by Redirect"),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn rebuild_uri(res: &ClientResponse, org_uri: Uri) -> Result<Uri, SendRequestError> {
|
||||||
|
let uri = res
|
||||||
|
.headers()
|
||||||
|
.get(header::LOCATION)
|
||||||
|
.map(|value| {
|
||||||
|
// try to parse the location to a full uri
|
||||||
|
let uri = Uri::try_from(value.as_bytes())
|
||||||
|
.map_err(|e| SendRequestError::Url(InvalidUrl::HttpError(e.into())))?;
|
||||||
|
if uri.scheme().is_none() || uri.authority().is_none() {
|
||||||
|
let uri = Uri::builder()
|
||||||
|
.scheme(org_uri.scheme().cloned().unwrap())
|
||||||
|
.authority(org_uri.authority().cloned().unwrap())
|
||||||
|
.path_and_query(value.as_bytes())
|
||||||
|
.build()?;
|
||||||
|
Ok::<_, SendRequestError>(uri)
|
||||||
|
} else {
|
||||||
|
Ok(uri)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
// TODO: this error type is wrong.
|
||||||
|
.ok_or(SendRequestError::Url(InvalidUrl::MissingScheme))??;
|
||||||
|
|
||||||
|
Ok(uri)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use actix_web::{test::start, web, App, Error, HttpResponse};
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
use crate::ClientBuilder;
|
||||||
|
|
||||||
|
#[actix_rt::test]
|
||||||
|
async fn test_basic_redirect() {
|
||||||
|
let client = ClientBuilder::new()
|
||||||
|
.connector(crate::Connector::new())
|
||||||
|
.wrap(Redirect::new().max_redirect_times(10))
|
||||||
|
.finish();
|
||||||
|
|
||||||
|
let srv = start(|| {
|
||||||
|
App::new()
|
||||||
|
.service(web::resource("/test").route(web::to(|| async {
|
||||||
|
Ok::<_, Error>(HttpResponse::BadRequest())
|
||||||
|
})))
|
||||||
|
.service(web::resource("/").route(web::to(|| async {
|
||||||
|
Ok::<_, Error>(
|
||||||
|
HttpResponse::Found()
|
||||||
|
.append_header(("location", "/test"))
|
||||||
|
.finish(),
|
||||||
|
)
|
||||||
|
})))
|
||||||
|
});
|
||||||
|
|
||||||
|
let res = client.get(srv.url("/")).send().await.unwrap();
|
||||||
|
|
||||||
|
assert_eq!(res.status().as_u16(), 400);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[actix_rt::test]
|
||||||
|
async fn test_redirect_limit() {
|
||||||
|
let client = ClientBuilder::new()
|
||||||
|
.wrap(Redirect::new().max_redirect_times(1))
|
||||||
|
.connector(crate::Connector::new())
|
||||||
|
.finish();
|
||||||
|
|
||||||
|
let srv = start(|| {
|
||||||
|
App::new()
|
||||||
|
.service(web::resource("/").route(web::to(|| async {
|
||||||
|
Ok::<_, Error>(
|
||||||
|
HttpResponse::Found()
|
||||||
|
.append_header(("location", "/test"))
|
||||||
|
.finish(),
|
||||||
|
)
|
||||||
|
})))
|
||||||
|
.service(web::resource("/test").route(web::to(|| async {
|
||||||
|
Ok::<_, Error>(
|
||||||
|
HttpResponse::Found()
|
||||||
|
.append_header(("location", "/test2"))
|
||||||
|
.finish(),
|
||||||
|
)
|
||||||
|
})))
|
||||||
|
.service(web::resource("/test2").route(web::to(|| async {
|
||||||
|
Ok::<_, Error>(HttpResponse::BadRequest())
|
||||||
|
})))
|
||||||
|
});
|
||||||
|
|
||||||
|
let res = client.get(srv.url("/")).send().await.unwrap();
|
||||||
|
|
||||||
|
assert_eq!(res.status().as_u16(), 302);
|
||||||
|
}
|
||||||
|
}
|
@ -492,9 +492,7 @@ mod tests {
|
|||||||
JsonPayloadError::Payload(PayloadError::Overflow) => {
|
JsonPayloadError::Payload(PayloadError::Overflow) => {
|
||||||
matches!(other, JsonPayloadError::Payload(PayloadError::Overflow))
|
matches!(other, JsonPayloadError::Payload(PayloadError::Overflow))
|
||||||
}
|
}
|
||||||
JsonPayloadError::ContentType => {
|
JsonPayloadError::ContentType => matches!(other, JsonPayloadError::ContentType),
|
||||||
matches!(other, JsonPayloadError::ContentType)
|
|
||||||
}
|
|
||||||
_ => false,
|
_ => false,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -400,12 +400,8 @@ mod tests {
|
|||||||
UrlencodedError::Overflow { .. } => {
|
UrlencodedError::Overflow { .. } => {
|
||||||
matches!(other, UrlencodedError::Overflow { .. })
|
matches!(other, UrlencodedError::Overflow { .. })
|
||||||
}
|
}
|
||||||
UrlencodedError::UnknownLength => {
|
UrlencodedError::UnknownLength => matches!(other, UrlencodedError::UnknownLength),
|
||||||
matches!(other, UrlencodedError::UnknownLength)
|
UrlencodedError::ContentType => matches!(other, UrlencodedError::ContentType),
|
||||||
}
|
|
||||||
UrlencodedError::ContentType => {
|
|
||||||
matches!(other, UrlencodedError::ContentType)
|
|
||||||
}
|
|
||||||
_ => false,
|
_ => false,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -441,9 +441,7 @@ mod tests {
|
|||||||
fn json_eq(err: JsonPayloadError, other: JsonPayloadError) -> bool {
|
fn json_eq(err: JsonPayloadError, other: JsonPayloadError) -> bool {
|
||||||
match err {
|
match err {
|
||||||
JsonPayloadError::Overflow => matches!(other, JsonPayloadError::Overflow),
|
JsonPayloadError::Overflow => matches!(other, JsonPayloadError::Overflow),
|
||||||
JsonPayloadError::ContentType => {
|
JsonPayloadError::ContentType => matches!(other, JsonPayloadError::ContentType),
|
||||||
matches!(other, JsonPayloadError::ContentType)
|
|
||||||
}
|
|
||||||
_ => false,
|
_ => false,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user