berkus
/
actix-web
mirror of https://github.com/fafhrd91/actix-web
1
0
Fork 0
Code Issues Releases Wiki Activity

unify generics across App, Scope and Resource

This commit is contained in:
Ali MJ Al-Nasrawy 2022-01-05 13:22:28 +03:00
parent 2d11ab5977
commit 68844c54e5
3 changed files with 94 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
src/app.rs
View File

@ -51,7 +51,10 @@ impl App<AppEntry> {
} }
} }
impl<T> App<T> { impl<T> App<T>
where
T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>,
{
/// Set application (root level) data. /// Set application (root level) data.
/// ///
/// Application data stored with `App::app_data()` method is available through the /// Application data stored with `App::app_data()` method is available through the
@ -347,35 +350,27 @@ impl<T> App<T> {
/// .route("/index.html", web::get().to(index)); /// .route("/index.html", web::get().to(index));
/// } /// }
/// ``` /// ```
pub fn wrap<M, B, B1>( pub fn wrap<M, B>(
self, self,
mw: M, mw: M,
) -> App< ) -> App<
impl ServiceFactory< impl ServiceFactory<
ServiceRequest, ServiceRequest,
Config = (), Config = (),
Response = ServiceResponse<B1>, Response = ServiceResponse<B>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, >,
> >
where where
T: ServiceFactory<
ServiceRequest,
Response = ServiceResponse<B>,
Error = Error,
Config = (),
InitError = (),
>,
B: MessageBody,
M: Transform< M: Transform<
T::Service, T::Service,
ServiceRequest, ServiceRequest,
Response = ServiceResponse<B1>, Response = ServiceResponse<B>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, > + 'static,
B1: MessageBody, B: MessageBody,
{ {
App { App {
endpoint: apply(mw, self.endpoint), endpoint: apply(mw, self.endpoint),
@ -395,6 +390,9 @@ impl<T> App<T> {
/// ///
/// Use middleware when you need to read or modify *every* request or response in some way. /// Use middleware when you need to read or modify *every* request or response in some way.
/// ///
/// See [`App::wrap`] for details on how middlewares compose with each other.
///
/// # Examples
/// ``` /// ```
/// use actix_service::Service; /// use actix_service::Service;
/// use actix_web::{web, App}; /// use actix_web::{web, App};
@ -419,30 +417,22 @@ impl<T> App<T> {
/// .route("/index.html", web::get().to(index)); /// .route("/index.html", web::get().to(index));
/// } /// }
/// ``` /// ```
pub fn wrap_fn<F, R, B, B1>( pub fn wrap_fn<F, R, B>(
self, self,
mw: F, mw: F,
) -> App< ) -> App<
impl ServiceFactory< impl ServiceFactory<
ServiceRequest, ServiceRequest,
Config = (), Config = (),
Response = ServiceResponse<B1>, Response = ServiceResponse<B>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, >,
> >
where where
T: ServiceFactory< F: Fn(ServiceRequest, &T::Service) -> R + Clone + 'static,
ServiceRequest, R: Future<Output = Result<ServiceResponse<B>, Error>>,
Response = ServiceResponse<B>,
Error = Error,
Config = (),
InitError = (),
>,
B: MessageBody, B: MessageBody,
F: Fn(ServiceRequest, &T::Service) -> R + Clone,
R: Future<Output = Result<ServiceResponse<B1>, Error>>,
B1: MessageBody,
{ {
App { App {
endpoint: apply_fn_factory(self.endpoint, mw), endpoint: apply_fn_factory(self.endpoint, mw),
@ -458,15 +448,14 @@ impl<T> App<T> {
impl<T, B> IntoServiceFactory<AppInit<T, B>, Request> for App<T> impl<T, B> IntoServiceFactory<AppInit<T, B>, Request> for App<T>
where where
B: MessageBody,
T: ServiceFactory< T: ServiceFactory<
ServiceRequest, ServiceRequest,
Config = (), Config = (),
Response = ServiceResponse<B>, Response = ServiceResponse<B>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, > + 'static,
T::Future: 'static, B: MessageBody,
{ {
fn into_factory(self) -> AppInit<T, B> { fn into_factory(self) -> AppInit<T, B> {
AppInit { AppInit {

75
src/resource.rs
View File

@ -1,6 +1,6 @@
use std::{cell::RefCell, fmt, future::Future, marker::PhantomData, rc::Rc}; use std::{cell::RefCell, fmt, future::Future, rc::Rc};
use actix_http::{body::BoxBody, Extensions}; use actix_http::Extensions;
use actix_router::{IntoPatterns, Patterns}; use actix_router::{IntoPatterns, Patterns};
use actix_service::{ use actix_service::{
apply, apply_fn_factory, boxed, fn_service, IntoServiceFactory, Service, ServiceFactory, apply, apply_fn_factory, boxed, fn_service, IntoServiceFactory, Service, ServiceFactory,
@ -42,7 +42,7 @@ use crate::{
/// ///
/// If no matching route could be found, *405* response code get returned. Default behavior could be /// If no matching route could be found, *405* response code get returned. Default behavior could be
/// overridden with `default_resource()` method. /// overridden with `default_resource()` method.
pub struct Resource<T = ResourceEndpoint, B = BoxBody> { pub struct Resource<T = ResourceEndpoint> {
endpoint: T, endpoint: T,
rdef: Patterns, rdef: Patterns,
name: Option<String>, name: Option<String>,
@ -51,7 +51,6 @@ pub struct Resource<T = ResourceEndpoint, B = BoxBody> {
guards: Vec<Box<dyn Guard>>, guards: Vec<Box<dyn Guard>>,
default: BoxedHttpServiceFactory, default: BoxedHttpServiceFactory,
factory_ref: Rc<RefCell<Option<ResourceFactory>>>, factory_ref: Rc<RefCell<Option<ResourceFactory>>>,
_phantom: PhantomData<B>,
} }
impl Resource { impl Resource {
@ -69,21 +68,13 @@ impl Resource {
default: boxed::factory(fn_service(|req: ServiceRequest| async { default: boxed::factory(fn_service(|req: ServiceRequest| async {
Ok(req.into_response(HttpResponse::MethodNotAllowed())) Ok(req.into_response(HttpResponse::MethodNotAllowed()))
})), })),
_phantom: PhantomData,
} }
} }
} }
impl<T, B> Resource<T, B> impl<T> Resource<T>
where where
T: ServiceFactory< T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>,
ServiceRequest,
Config = (),
Response = ServiceResponse<B>,
Error = Error,
InitError = (),
>,
B: MessageBody,
{ {
/// Set resource name. /// Set resource name.
/// ///
@ -241,35 +232,31 @@ where
self self
} }
/// Register a resource middleware. /// Registers middleware, in the form of a middleware component (type),
/// that can modify the request and response across all routes managed by this `Resource`.
/// ///
/// This is similar to `App's` middlewares, but middleware get invoked on resource level. /// See [`App::wrap`](crate::App::wrap) for details.
/// Resource level middlewares are not allowed to change response pub fn wrap<M, B>(
/// type (i.e modify response's body).
///
/// **Note**: middlewares get called in opposite order of middlewares registration.
pub fn wrap<M, B1>(
self, self,
mw: M, mw: M,
) -> Resource< ) -> Resource<
impl ServiceFactory< impl ServiceFactory<
ServiceRequest, ServiceRequest,
Config = (), Config = (),
Response = ServiceResponse<B1>, Response = ServiceResponse<B>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, >,
B1,
> >
where where
M: Transform< M: Transform<
T::Service, T::Service,
ServiceRequest, ServiceRequest,
Response = ServiceResponse<B1>, Response = ServiceResponse<B>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, > + 'static,
B1: MessageBody, B: MessageBody,
{ {
Resource { Resource {
endpoint: apply(mw, self.endpoint), endpoint: apply(mw, self.endpoint),
@ -280,19 +267,15 @@ where
default: self.default, default: self.default,
app_data: self.app_data, app_data: self.app_data,
factory_ref: self.factory_ref, factory_ref: self.factory_ref,
_phantom: PhantomData,
} }
} }
/// Register a resource middleware function. /// Registers middleware, in the form of a closure,
/// that can modify the request and response across all routes managed by this `Resource`.
/// ///
/// This function accepts instance of `ServiceRequest` type and /// See [`App::wrap_fn`](crate::App::wrap_fn) for details.
/// mutable reference to the next middleware in chain.
///
/// This is similar to `App's` middlewares, but middleware get invoked on resource level.
/// Resource level middlewares are not allowed to change response
/// type (i.e modify response's body).
/// ///
/// # Examples
/// ``` /// ```
/// use actix_service::Service; /// use actix_service::Service;
/// use actix_web::{web, App}; /// use actix_web::{web, App};
@ -318,23 +301,22 @@ where
/// .route(web::get().to(index))); /// .route(web::get().to(index)));
/// } /// }
/// ``` /// ```
pub fn wrap_fn<F, R, B1>( pub fn wrap_fn<F, R, B>(
self, self,
mw: F, mw: F,
) -> Resource< ) -> Resource<
impl ServiceFactory< impl ServiceFactory<
ServiceRequest, ServiceRequest,
Config = (), Config = (),
Response = ServiceResponse<B1>, Response = ServiceResponse<B>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, >,
B1,
> >
where where
F: Fn(ServiceRequest, &T::Service) -> R + Clone, F: Fn(ServiceRequest, &T::Service) -> R + Clone + 'static,
R: Future<Output = Result<ServiceResponse<B1>, Error>>, R: Future<Output = Result<ServiceResponse<B>, Error>>,
B1: MessageBody, B: MessageBody,
{ {
Resource { Resource {
endpoint: apply_fn_factory(self.endpoint, mw), endpoint: apply_fn_factory(self.endpoint, mw),
@ -345,7 +327,6 @@ where
default: self.default, default: self.default,
app_data: self.app_data, app_data: self.app_data,
factory_ref: self.factory_ref, factory_ref: self.factory_ref,
_phantom: PhantomData,
} }
} }
@ -373,7 +354,7 @@ where
} }
} }
impl<T, B> HttpServiceFactory for Resource<T, B> impl<T, B> HttpServiceFactory for Resource<T>
where where
T: ServiceFactory< T: ServiceFactory<
ServiceRequest, ServiceRequest,
@ -533,7 +514,7 @@ mod tests {
impl ServiceFactory< impl ServiceFactory<
ServiceRequest, ServiceRequest,
Config = (), Config = (),
Response = ServiceResponse, Response = ServiceResponse<impl MessageBody>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, >,

86
src/scope.rs
View File

@ -1,9 +1,6 @@
use std::{cell::RefCell, fmt, future::Future, marker::PhantomData, mem, rc::Rc}; use std::{cell::RefCell, fmt, future::Future, mem, rc::Rc};
use actix_http::{ use actix_http::{body::MessageBody, Extensions};
body::{BoxBody, MessageBody},
Extensions,
};
use actix_router::{ResourceDef, Router}; use actix_router::{ResourceDef, Router};
use actix_service::{ use actix_service::{
apply, apply_fn_factory, boxed, IntoServiceFactory, Service, ServiceFactory, apply, apply_fn_factory, boxed, IntoServiceFactory, Service, ServiceFactory,
@ -57,7 +54,7 @@ type Guards = Vec<Box<dyn Guard>>;
/// ///
/// [pat]: crate::dev::ResourceDef#prefix-resources /// [pat]: crate::dev::ResourceDef#prefix-resources
/// [dynamic segments]: crate::dev::ResourceDef#dynamic-segments /// [dynamic segments]: crate::dev::ResourceDef#dynamic-segments
pub struct Scope<T = ScopeEndpoint, B = BoxBody> { pub struct Scope<T = ScopeEndpoint> {
endpoint: T, endpoint: T,
rdef: String, rdef: String,
app_data: Option<Extensions>, app_data: Option<Extensions>,
@ -66,7 +63,6 @@ pub struct Scope<T = ScopeEndpoint, B = BoxBody> {
default: Option<Rc<BoxedHttpServiceFactory>>, default: Option<Rc<BoxedHttpServiceFactory>>,
external: Vec<ResourceDef>, external: Vec<ResourceDef>,
factory_ref: Rc<RefCell<Option<ScopeFactory>>>, factory_ref: Rc<RefCell<Option<ScopeFactory>>>,
_phantom: PhantomData<B>,
} }
impl Scope { impl Scope {
@ -83,21 +79,13 @@ impl Scope {
default: None, default: None,
external: Vec::new(), external: Vec::new(),
factory_ref, factory_ref,
_phantom: Default::default(),
} }
} }
} }
impl<T, B> Scope<T, B> impl<T> Scope<T>
where where
T: ServiceFactory< T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>,
ServiceRequest,
Config = (),
Response = ServiceResponse<B>,
Error = Error,
InitError = (),
>,
B: 'static,
{ {
/// Add match guard to a scope. /// Add match guard to a scope.
/// ///
@ -296,32 +284,31 @@ where
self self
} }
/// Registers middleware, in the form of a middleware component (type), that runs during inbound /// Registers middleware, in the form of a middleware component (type),
/// processing in the request life-cycle (request -> response), modifying request as necessary, /// that can modify the request and response across all routes managed by this `Scope`.
/// across all requests managed by the *Scope*.
/// ///
/// Use middleware when you need to read or modify *every* request in some way. /// See [`App::wrap`](crate::App::wrap) for details.
pub fn wrap<M, B1>( pub fn wrap<M, B>(
self, self,
mw: M, mw: M,
) -> Scope< ) -> Scope<
impl ServiceFactory< impl ServiceFactory<
ServiceRequest, ServiceRequest,
Config = (), Config = (),
Response = ServiceResponse<B1>, Response = ServiceResponse<B>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, >,
B1,
> >
where where
M: Transform< M: Transform<
T::Service, T::Service,
ServiceRequest, ServiceRequest,
Response = ServiceResponse<B1>, Response = ServiceResponse<B>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, > + 'static,
B: MessageBody,
{ {
Scope { Scope {
endpoint: apply(mw, self.endpoint), endpoint: apply(mw, self.endpoint),
@ -332,13 +319,13 @@ where
default: self.default, default: self.default,
external: self.external, external: self.external,
factory_ref: self.factory_ref, factory_ref: self.factory_ref,
_phantom: PhantomData,
} }
} }
/// Registers middleware, in the form of a closure, that runs during inbound processing in the /// Registers middleware, in the form of a closure,
/// request life-cycle (request -> response), modifying request as necessary, across all /// that can modify the request and response across all routes managed by this `Scope`.
/// requests managed by the *Scope*. ///
/// See [`App::wrap_fn`](crate::App::wrap_fn) for details.
/// ///
/// # Examples /// # Examples
/// ``` /// ```
@ -364,22 +351,22 @@ where
/// }) /// })
/// .route("/index.html", web::get().to(index))); /// .route("/index.html", web::get().to(index)));
/// ``` /// ```
pub fn wrap_fn<F, R, B1>( pub fn wrap_fn<F, R, B>(
self, self,
mw: F, mw: F,
) -> Scope< ) -> Scope<
impl ServiceFactory< impl ServiceFactory<
ServiceRequest, ServiceRequest,
Config = (), Config = (),
Response = ServiceResponse<B1>, Response = ServiceResponse<B>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, >,
B1,
> >
where where
F: Fn(ServiceRequest, &T::Service) -> R + Clone, F: Fn(ServiceRequest, &T::Service) -> R + Clone + 'static,
R: Future<Output = Result<ServiceResponse<B1>, Error>>, R: Future<Output = Result<ServiceResponse<B>, Error>>,
B: MessageBody,
{ {
Scope { Scope {
endpoint: apply_fn_factory(self.endpoint, mw), endpoint: apply_fn_factory(self.endpoint, mw),
@ -390,12 +377,11 @@ where
default: self.default, default: self.default,
external: self.external, external: self.external,
factory_ref: self.factory_ref, factory_ref: self.factory_ref,
_phantom: PhantomData,
} }
} }
} }
impl<T, B> HttpServiceFactory for Scope<T, B> impl<T, B> HttpServiceFactory for Scope<T>
where where
T: ServiceFactory< T: ServiceFactory<
ServiceRequest, ServiceRequest,
@ -596,7 +582,7 @@ mod tests {
header::{self, HeaderValue}, header::{self, HeaderValue},
Method, StatusCode, Method, StatusCode,
}, },
middleware::{Compat, DefaultHeaders}, middleware::DefaultHeaders,
service::{ServiceRequest, ServiceResponse}, service::{ServiceRequest, ServiceResponse},
test::{assert_body_eq, call_service, init_service, read_body, TestRequest}, test::{assert_body_eq, call_service, init_service, read_body, TestRequest},
web, App, HttpMessage, HttpRequest, HttpResponse, web, App, HttpMessage, HttpRequest, HttpResponse,
@ -604,16 +590,16 @@ mod tests {
#[test] #[test]
fn can_be_returned_from_fn() { fn can_be_returned_from_fn() {
fn my_scope() -> Scope { fn my_scope_1() -> Scope {
web::scope("/test") web::scope("/test")
.service(web::resource("").route(web::get().to(|| async { "hello" }))) .service(web::resource("").route(web::get().to(|| async { "hello" })))
} }
fn my_compat_scope() -> Scope< fn my_scope_2() -> Scope<
impl ServiceFactory< impl ServiceFactory<
ServiceRequest, ServiceRequest,
Config = (), Config = (),
Response = ServiceResponse, Response = ServiceResponse<impl MessageBody>,
Error = Error, Error = Error,
InitError = (), InitError = (),
>, >,
@ -623,11 +609,17 @@ mod tests {
let fut = srv.call(req); let fut = srv.call(req);
async { Ok(fut.await?.map_into_right_body::<()>()) } async { Ok(fut.await?.map_into_right_body::<()>()) }
}) })
.wrap(Compat::noop())
.service(web::resource("").route(web::get().to(|| async { "hello" }))) .service(web::resource("").route(web::get().to(|| async { "hello" })))
} }
App::new().service(my_scope()).service(my_compat_scope()); fn my_scope_3() -> impl HttpServiceFactory {
my_scope_2()
}
App::new()
.service(my_scope_1())
.service(my_scope_2())
.service(my_scope_3());
} }
#[actix_rt::test] #[actix_rt::test]