mirror of https://github.com/fafhrd91/actix-web
make `Condition` generic over body type
This commit is contained in:
parent
1d1a65282f
commit
4099389b2a
|
@ -1,18 +1,20 @@
|
||||||
//! For middleware documentation, see [`Condition`].
|
//! For middleware documentation, see [`Condition`].
|
||||||
|
|
||||||
use std::task::{Context, Poll};
|
use std::{
|
||||||
|
future::Future,
|
||||||
|
pin::Pin,
|
||||||
|
task::{Context, Poll},
|
||||||
|
};
|
||||||
|
|
||||||
use actix_service::{Service, Transform};
|
use actix_service::{Service, Transform};
|
||||||
use actix_utils::future::Either;
|
use futures_core::{future::LocalBoxFuture, ready};
|
||||||
use futures_core::future::LocalBoxFuture;
|
|
||||||
use futures_util::future::FutureExt as _;
|
use futures_util::future::FutureExt as _;
|
||||||
|
use pin_project_lite::pin_project;
|
||||||
|
|
||||||
|
use crate::{body::EitherBody, dev::ServiceResponse};
|
||||||
|
|
||||||
/// Middleware for conditionally enabling other middleware.
|
/// Middleware for conditionally enabling other middleware.
|
||||||
///
|
///
|
||||||
/// The controlled middleware must not change the `Service` interfaces. This means you cannot
|
|
||||||
/// control such middlewares like `Logger` or `Compress` directly. See the [`Compat`](super::Compat)
|
|
||||||
/// middleware for a workaround.
|
|
||||||
///
|
|
||||||
/// # Examples
|
/// # Examples
|
||||||
/// ```
|
/// ```
|
||||||
/// use actix_web::middleware::{Condition, NormalizePath};
|
/// use actix_web::middleware::{Condition, NormalizePath};
|
||||||
|
@ -36,16 +38,16 @@ impl<T> Condition<T> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<S, T, Req> Transform<S, Req> for Condition<T>
|
impl<S, T, Req, BE, BD, Err> Transform<S, Req> for Condition<T>
|
||||||
where
|
where
|
||||||
S: Service<Req> + 'static,
|
S: Service<Req, Response = ServiceResponse<BD>, Error = Err> + 'static,
|
||||||
T: Transform<S, Req, Response = S::Response, Error = S::Error>,
|
T: Transform<S, Req, Response = ServiceResponse<BE>, Error = Err>,
|
||||||
T::Future: 'static,
|
T::Future: 'static,
|
||||||
T::InitError: 'static,
|
T::InitError: 'static,
|
||||||
T::Transform: 'static,
|
T::Transform: 'static,
|
||||||
{
|
{
|
||||||
type Response = S::Response;
|
type Response = ServiceResponse<EitherBody<BE, BD>>;
|
||||||
type Error = S::Error;
|
type Error = Err;
|
||||||
type Transform = ConditionMiddleware<T::Transform, S>;
|
type Transform = ConditionMiddleware<T::Transform, S>;
|
||||||
type InitError = T::InitError;
|
type InitError = T::InitError;
|
||||||
type Future = LocalBoxFuture<'static, Result<Self::Transform, Self::InitError>>;
|
type Future = LocalBoxFuture<'static, Result<Self::Transform, Self::InitError>>;
|
||||||
|
@ -69,14 +71,14 @@ pub enum ConditionMiddleware<E, D> {
|
||||||
Disable(D),
|
Disable(D),
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<E, D, Req> Service<Req> for ConditionMiddleware<E, D>
|
impl<E, D, Req, BE, BD, Err> Service<Req> for ConditionMiddleware<E, D>
|
||||||
where
|
where
|
||||||
E: Service<Req>,
|
E: Service<Req, Response = ServiceResponse<BE>, Error = Err>,
|
||||||
D: Service<Req, Response = E::Response, Error = E::Error>,
|
D: Service<Req, Response = ServiceResponse<BD>, Error = Err>,
|
||||||
{
|
{
|
||||||
type Response = E::Response;
|
type Response = ServiceResponse<EitherBody<BE, BD>>;
|
||||||
type Error = E::Error;
|
type Error = Err;
|
||||||
type Future = Either<E::Future, D::Future>;
|
type Future = ConditionMiddlewareFuture<E::Future, D::Future>;
|
||||||
|
|
||||||
fn poll_ready(&self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
|
fn poll_ready(&self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
|
||||||
match self {
|
match self {
|
||||||
|
@ -87,16 +89,45 @@ where
|
||||||
|
|
||||||
fn call(&self, req: Req) -> Self::Future {
|
fn call(&self, req: Req) -> Self::Future {
|
||||||
match self {
|
match self {
|
||||||
ConditionMiddleware::Enable(service) => Either::left(service.call(req)),
|
ConditionMiddleware::Enable(service) => ConditionMiddlewareFuture::Left {
|
||||||
ConditionMiddleware::Disable(service) => Either::right(service.call(req)),
|
fut: service.call(req),
|
||||||
|
},
|
||||||
|
ConditionMiddleware::Disable(service) => ConditionMiddlewareFuture::Right {
|
||||||
|
fut: service.call(req),
|
||||||
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pin_project! {
|
||||||
|
#[project = EitherProj]
|
||||||
|
pub enum ConditionMiddlewareFuture<L, R> {
|
||||||
|
Left { #[pin] fut: L, },
|
||||||
|
Right { #[pin] fut: R, },
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<L, R, BL, BR, Err> Future for ConditionMiddlewareFuture<L, R>
|
||||||
|
where
|
||||||
|
L: Future<Output = Result<ServiceResponse<BL>, Err>>,
|
||||||
|
R: Future<Output = Result<ServiceResponse<BR>, Err>>,
|
||||||
|
{
|
||||||
|
type Output = Result<ServiceResponse<EitherBody<BL, BR>>, Err>;
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
|
||||||
|
let res = match self.project() {
|
||||||
|
EitherProj::Left { fut } => ready!(fut.poll(cx))?.map_into_left_body(),
|
||||||
|
EitherProj::Right { fut } => ready!(fut.poll(cx))?.map_into_right_body(),
|
||||||
|
};
|
||||||
|
|
||||||
|
Poll::Ready(Ok(res))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use actix_service::IntoService;
|
use actix_service::IntoService;
|
||||||
use actix_utils::future::ok;
|
|
||||||
|
|
||||||
use super::*;
|
use super::*;
|
||||||
use crate::{
|
use crate::{
|
||||||
|
@ -106,11 +137,13 @@ mod tests {
|
||||||
header::{HeaderValue, CONTENT_TYPE},
|
header::{HeaderValue, CONTENT_TYPE},
|
||||||
StatusCode,
|
StatusCode,
|
||||||
},
|
},
|
||||||
middleware::{err_handlers::*, Compat},
|
middleware::err_handlers::*,
|
||||||
test::{self, TestRequest},
|
test::{self, TestRequest},
|
||||||
HttpResponse,
|
HttpResponse,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
fn assert_type<T>(_: &T) {}
|
||||||
|
|
||||||
#[allow(clippy::unnecessary_wraps)]
|
#[allow(clippy::unnecessary_wraps)]
|
||||||
fn render_500<B>(mut res: ServiceResponse<B>) -> Result<ErrorHandlerResponse<B>> {
|
fn render_500<B>(mut res: ServiceResponse<B>) -> Result<ErrorHandlerResponse<B>> {
|
||||||
res.response_mut()
|
res.response_mut()
|
||||||
|
@ -122,31 +155,31 @@ mod tests {
|
||||||
|
|
||||||
#[actix_rt::test]
|
#[actix_rt::test]
|
||||||
async fn test_handler_enabled() {
|
async fn test_handler_enabled() {
|
||||||
let srv = |req: ServiceRequest| {
|
let srv = |req: ServiceRequest| async move {
|
||||||
ok(req.into_response(HttpResponse::InternalServerError().finish()))
|
let resp = HttpResponse::InternalServerError().message_body(String::new())?;
|
||||||
|
Ok(req.into_response(resp))
|
||||||
};
|
};
|
||||||
|
|
||||||
let mw = Compat::new(
|
let mw = ErrorHandlers::new().handler(StatusCode::INTERNAL_SERVER_ERROR, render_500);
|
||||||
ErrorHandlers::new().handler(StatusCode::INTERNAL_SERVER_ERROR, render_500),
|
|
||||||
);
|
|
||||||
|
|
||||||
let mw = Condition::new(true, mw)
|
let mw = Condition::new(true, mw)
|
||||||
.new_transform(srv.into_service())
|
.new_transform(srv.into_service())
|
||||||
.await
|
.await
|
||||||
.unwrap();
|
.unwrap();
|
||||||
|
|
||||||
let resp = test::call_service(&mw, TestRequest::default().to_srv_request()).await;
|
let resp = test::call_service(&mw, TestRequest::default().to_srv_request()).await;
|
||||||
|
assert_type::<ServiceResponse<EitherBody<EitherBody<_, _>, String>>>(&resp);
|
||||||
assert_eq!(resp.headers().get(CONTENT_TYPE).unwrap(), "0001");
|
assert_eq!(resp.headers().get(CONTENT_TYPE).unwrap(), "0001");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[actix_rt::test]
|
#[actix_rt::test]
|
||||||
async fn test_handler_disabled() {
|
async fn test_handler_disabled() {
|
||||||
let srv = |req: ServiceRequest| {
|
let srv = |req: ServiceRequest| async move {
|
||||||
ok(req.into_response(HttpResponse::InternalServerError().finish()))
|
let resp = HttpResponse::InternalServerError().message_body(String::new())?;
|
||||||
|
Ok(req.into_response(resp))
|
||||||
};
|
};
|
||||||
|
|
||||||
let mw = Compat::new(
|
let mw = ErrorHandlers::new().handler(StatusCode::INTERNAL_SERVER_ERROR, render_500);
|
||||||
ErrorHandlers::new().handler(StatusCode::INTERNAL_SERVER_ERROR, render_500),
|
|
||||||
);
|
|
||||||
|
|
||||||
let mw = Condition::new(false, mw)
|
let mw = Condition::new(false, mw)
|
||||||
.new_transform(srv.into_service())
|
.new_transform(srv.into_service())
|
||||||
|
@ -154,6 +187,7 @@ mod tests {
|
||||||
.unwrap();
|
.unwrap();
|
||||||
|
|
||||||
let resp = test::call_service(&mw, TestRequest::default().to_srv_request()).await;
|
let resp = test::call_service(&mw, TestRequest::default().to_srv_request()).await;
|
||||||
|
assert_type::<ServiceResponse<EitherBody<EitherBody<_, _>, String>>>(&resp);
|
||||||
assert_eq!(resp.headers().get(CONTENT_TYPE), None);
|
assert_eq!(resp.headers().get(CONTENT_TYPE), None);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue