use std::fmt;
use crate::router::{IntoPattern, ResourceDef};
use crate::service::dev::{AndThen, ServiceChain, ServiceChainFactory};
use crate::service::{Ctx, factory, svc};
use crate::service::{Identity, IntoServiceFactory, Middleware, Service, ServiceFactory};
use crate::{http::Response, util::Extensions};
use super::dev::{WebServiceConfig, WebServiceFactory, insert_slash};
use super::error::WebResponseError;
use super::extract::FromRequest;
use super::guard::Guard;
use super::route::{IntoRoutes, Route, RouteService};
use super::stack::{Filter, WebStack};
use super::{AppState, Handler, HttpHandler, HttpService, WebRequest, WebResponse};
type ResourcePipeline<St, F> = ServiceChain<AndThen<F, ResourceRouter<St>>, St, WebRequest>;
#[derive(derive_more::Debug)]
#[debug("Resource({rdef:?})")]
pub struct Resource<St: AppState, Cfg = (), M = Identity, F = Filter<St>> {
middleware: M,
filter: ServiceChainFactory<F, St, WebRequest, Cfg>,
rdef: Vec<String>,
name: Option<String>,
routes: Vec<Route<St>>,
state: Option<Extensions>,
guards: Vec<Box<dyn Guard>>,
default: Option<HttpService<St, Cfg>>,
}
impl<St: AppState, Cfg> Resource<St, Cfg> {
#[allow(clippy::needless_pass_by_value)]
pub fn new<T: IntoPattern>(path: T) -> Resource<St, Cfg> {
Resource {
routes: Vec::new(),
rdef: path.patterns(),
name: None,
state: None,
middleware: Identity,
filter: factory(Filter::new()),
guards: Vec::new(),
default: None,
}
}
}
impl<St, Cfg, M, Sf> Resource<St, Cfg, M, Sf>
where
St: AppState,
Cfg: Clone + 'static,
Sf: ServiceFactory<St, WebRequest, Cfg, Res = WebRequest, Error = St::Error, InitError = ()>,
{
#[must_use]
pub fn name(mut self, name: &str) -> Self {
self.name = Some(name.to_string());
self
}
#[must_use]
pub fn guard<G: Guard + 'static>(mut self, guard: G) -> Self {
self.guards.push(Box::new(guard));
self
}
pub(crate) fn add_guards(mut self, guards: Vec<Box<dyn Guard>>) -> Self {
self.guards.extend(guards);
self
}
#[must_use]
pub fn state<D: 'static>(mut self, st: D) -> Self {
if self.state.is_none() {
self.state = Some(Extensions::new());
}
self.state.as_mut().unwrap().insert(st);
self
}
#[must_use]
pub fn route<R>(mut self, route: R) -> Self
where
R: IntoRoutes<St>,
{
for route in route.routes() {
self.routes.push(route);
}
self
}
#[must_use]
pub fn to<F, Args>(mut self, handler: F) -> Self
where
F: Handler<St, Args> + 'static,
Args: FromRequest<St> + 'static,
Args::Error: WebResponseError<St::Error>,
{
self.routes.push(Route::new().to(handler));
self
}
#[must_use]
pub fn filter<U>(
self,
filter: impl IntoServiceFactory<U, St, WebRequest, Cfg>,
) -> Resource<
St,
Cfg,
M,
impl ServiceFactory<St, WebRequest, Cfg, Res = WebRequest, Error = St::Error, InitError = ()>,
>
where
U: ServiceFactory<St, WebRequest, Cfg, Res = WebRequest, Error = St::Error>,
{
Resource {
filter: self
.filter
.and_then(filter.into_factory().map_init_err(|_| ())),
middleware: self.middleware,
rdef: self.rdef,
name: self.name,
state: self.state,
guards: self.guards,
routes: self.routes,
default: self.default,
}
}
#[must_use]
pub fn middleware<U>(self, mw: U) -> Resource<St, Cfg, WebStack<St, M, U>, Sf> {
Resource {
middleware: WebStack::new(self.middleware, mw),
filter: self.filter,
rdef: self.rdef,
name: self.name,
state: self.state,
guards: self.guards,
routes: self.routes,
default: self.default,
}
}
#[must_use]
pub fn default_service<S>(mut self, f: impl IntoServiceFactory<S, St, WebRequest, Cfg>) -> Self
where
S: ServiceFactory<St, WebRequest, Cfg, Res = WebResponse, Error = St::Error> + 'static,
S::InitError: fmt::Debug,
{
self.default = Some(HttpService::new(f.into_factory().map_init_err(|e| {
log::error!("Cannot construct default service: {e:?}");
})));
self
}
}
impl<St, Cfg, M, Sf> WebServiceFactory<St, Cfg> for Resource<St, Cfg, M, Sf>
where
St: AppState,
Cfg: Clone + 'static,
Sf: ServiceFactory<St, WebRequest, Cfg, Res = WebRequest, Error = St::Error, InitError = ()>
+ 'static,
M: Middleware<ResourcePipeline<St, Sf::Service>, St, Cfg> + 'static,
M::Service: Service<St, WebRequest, Res = WebResponse, Error = St::Error>,
{
fn register(mut self, config: &mut WebServiceConfig<St, Cfg>) {
let guards = if self.guards.is_empty() {
None
} else {
Some(std::mem::take(&mut self.guards))
};
let mut rdef = if config.is_root() || !self.rdef.is_empty() {
ResourceDef::new(insert_slash(self.rdef.clone()))
} else {
ResourceDef::new(self.rdef.clone())
};
if let Some(ref name) = self.name {
rdef.name_mut().clone_from(name);
}
let router_factory = ResourceRouterFactory {
routes: self.routes,
default: self.default.take(),
};
config.register_service(
rdef,
ResourceServiceFactory {
middleware: self.middleware,
filter: self.filter,
routing: router_factory,
},
guards,
None,
);
}
}
impl<St, Cfg, M, Sf>
IntoServiceFactory<
ResourceServiceFactory<St, Cfg, M, ServiceChainFactory<Sf, St, WebRequest, Cfg>>,
St,
WebRequest,
Cfg,
> for Resource<St, Cfg, M, Sf>
where
St: AppState,
Cfg: Clone + 'static,
Sf: ServiceFactory<St, WebRequest, Cfg, Res = WebRequest, Error = St::Error, InitError = ()>
+ 'static,
M: Middleware<ResourcePipeline<St, Sf::Service>, St, Cfg> + 'static,
M::Service: Service<St, WebRequest, Res = WebResponse, Error = St::Error>,
{
fn into_factory(
mut self,
) -> ResourceServiceFactory<St, Cfg, M, ServiceChainFactory<Sf, St, WebRequest, Cfg>> {
let router_factory = ResourceRouterFactory {
routes: self.routes,
default: self.default.take(),
};
ResourceServiceFactory {
middleware: self.middleware,
filter: self.filter,
routing: router_factory,
}
}
}
#[derive(derive_more::Debug)]
#[debug("ResourceServiceFactory")]
pub struct ResourceServiceFactory<St: AppState, Cfg, M, F> {
middleware: M,
filter: F,
routing: ResourceRouterFactory<St, Cfg>,
}
impl<St, Cfg, M, F> ServiceFactory<St, WebRequest, Cfg> for ResourceServiceFactory<St, Cfg, M, F>
where
St: AppState,
M: Middleware<ResourcePipeline<St, F::Service>, St, Cfg> + 'static,
M::Service: Service<St, WebRequest, Res = WebResponse, Error = St::Error>,
F: ServiceFactory<St, WebRequest, Cfg, Res = WebRequest, Error = St::Error, InitError = ()>
+ 'static,
{
type Res = WebResponse;
type Error = St::Error;
type Service = M::Service;
type InitError = ();
async fn create(&self, cfg: &Cfg) -> Result<Self::Service, Self::InitError> {
let filter = self.filter.create(cfg).await?;
let routing = self.routing.create(cfg).await?;
Ok(self.middleware.create(svc(filter).and_then(routing), cfg))
}
}
struct ResourceRouterFactory<St: AppState, Cfg> {
routes: Vec<Route<St>>,
default: Option<HttpService<St, Cfg>>,
}
impl<St, Cfg> ServiceFactory<St, WebRequest, Cfg> for ResourceRouterFactory<St, Cfg>
where
St: AppState,
{
type Res = WebResponse;
type Error = St::Error;
type Service = ResourceRouter<St>;
type InitError = ();
async fn create(&self, cfg: &Cfg) -> Result<Self::Service, Self::InitError> {
let default = if let Some(ref default) = self.default {
Some(default.create(cfg).await?)
} else {
None
};
Ok(ResourceRouter {
default,
routes: self.routes.iter().map(Route::service).collect(),
})
}
}
#[derive(derive_more::Debug)]
#[debug("ResourceRouter")]
pub struct ResourceRouter<St: AppState> {
routes: Vec<RouteService<St>>,
default: Option<HttpHandler<St>>,
}
impl<St: AppState> Service<St, WebRequest> for ResourceRouter<St> {
type Res = WebResponse;
type Error = St::Error;
async fn call(
&self,
mut req: WebRequest,
ctx: Ctx<'_, Self, St>,
) -> Result<Self::Res, Self::Error> {
for route in &self.routes {
if route.check(&mut req) {
return ctx.call(route, req).await;
}
}
if let Some(ref default) = self.default {
ctx.call(default, req).await
} else {
Ok(WebResponse::new(
Response::MethodNotAllowed().finish(),
req.into_parts().0,
))
}
}
}
#[cfg(test)]
mod tests {
use crate::http::{Method, StatusCode};
use crate::time::{Millis, sleep};
use crate::web::test::{TestRequest, call_service, init_service};
use crate::web::{self, App, HttpResponse, guard, request::WebRequest};
#[crate::rt_test]
async fn test_filter() {
let filter = std::rc::Rc::new(std::cell::Cell::new(false));
let filter2 = filter.clone();
let srv = init_service(
App::new().service(
web::resource("/test")
.filter(async move |req: WebRequest| {
filter2.set(true);
Ok(req)
})
.route(web::get().to(async || HttpResponse::Ok())),
),
)
.await;
let req = TestRequest::with_uri("/test").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
assert!(filter.get());
}
#[crate::rt_test]
async fn test_to() {
let srv = init_service(App::new().service(web::resource("/test").to(async || {
sleep(Millis(100)).await;
HttpResponse::Ok()
})))
.await;
let req = TestRequest::with_uri("/test").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
}
#[crate::rt_test]
async fn test_pattern() {
let srv = init_service(
App::new().service(web::resource(["/test", "/test2"]).to(async || HttpResponse::Ok())),
)
.await;
let req = TestRequest::with_uri("/test").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/test2").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
}
#[crate::rt_test]
async fn test_default_resource() {
let srv = init_service(
App::new()
.service(web::resource("/test").route(web::get().to(async || HttpResponse::Ok())))
.default_service(async move |r: WebRequest| {
Ok(r.into_response(HttpResponse::BadRequest()))
}),
)
.await;
let req = TestRequest::with_uri("/test").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/test")
.method(Method::POST)
.to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
let srv = init_service(
App::new().service(
web::resource("/test")
.route(web::get().to(async || HttpResponse::Ok()))
.default_service(async move |r: WebRequest| {
Ok(r.into_response(HttpResponse::BadRequest()))
}),
),
)
.await;
let req = TestRequest::with_uri("/test").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/test")
.method(Method::POST)
.to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
}
#[crate::rt_test]
async fn test_resource_guards() {
let srv = init_service(
App::new()
.service(
web::resource("/test/{p}")
.guard(guard::Get())
.to(async || HttpResponse::Ok()),
)
.service(
web::resource("/test/{p}")
.guard(guard::Put())
.to(async || HttpResponse::Created()),
)
.service(
web::resource("/test/{p}")
.guard(guard::Delete())
.to(async || HttpResponse::NoContent()),
),
)
.await;
let req = TestRequest::with_uri("/test/it")
.method(Method::GET)
.to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/test/it")
.method(Method::PUT)
.to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::CREATED);
let req = TestRequest::with_uri("/test/it")
.method(Method::DELETE)
.to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::NO_CONTENT);
}
}