use std::{cell::RefCell, fmt, rc::Rc, task::Context};
use crate::http::Response;
use crate::router::{IntoPattern, ResourceDef, Router};
use crate::service::boxed::{self, BoxService, BoxServiceFactory};
use crate::service::cfg::SharedCfg;
use crate::service::{Identity, Middleware, Service, ServiceCtx, ServiceFactory};
use crate::service::{IntoServiceFactory, chain_factory, dev::ServiceChainFactory};
use crate::util::{Extensions, join};
use super::app::Filter;
use super::config::ServiceConfig;
use super::dev::{WebServiceConfig, WebServiceFactory};
use super::error::ErrorRenderer;
use super::guard::Guard;
use super::request::WebRequest;
use super::resource::Resource;
use super::response::WebResponse;
use super::rmap::ResourceMap;
use super::route::Route;
use super::service::{AppServiceFactory, AppState, ServiceFactoryWrapper};
use super::stack::WebStack;
type Guards = Vec<Box<dyn Guard>>;
type HttpService<Err: ErrorRenderer> =
BoxService<WebRequest<Err>, WebResponse, Err::Container>;
type HttpNewService<Err: ErrorRenderer> =
BoxServiceFactory<SharedCfg, WebRequest<Err>, WebResponse, Err::Container, ()>;
#[derive(derive_more::Debug)]
#[debug("Scope({rdef:?})")]
pub struct Scope<Err: ErrorRenderer, M = Identity, T = Filter<Err>> {
middleware: M,
filter: ServiceChainFactory<T, WebRequest<Err>, SharedCfg>,
rdef: Vec<String>,
state: Option<Extensions>,
services: Vec<Box<dyn AppServiceFactory<Err>>>,
guards: Vec<Box<dyn Guard>>,
default: Rc<RefCell<Option<Rc<HttpNewService<Err>>>>>,
external: Vec<ResourceDef>,
case_insensitive: bool,
}
impl<Err: ErrorRenderer> Scope<Err> {
#[allow(clippy::needless_pass_by_value)]
pub fn new<T: IntoPattern>(path: T) -> Scope<Err> {
Scope {
middleware: Identity,
filter: chain_factory(Filter::new()),
rdef: path.patterns(),
state: None,
guards: Vec::new(),
services: Vec::new(),
default: Rc::new(RefCell::new(None)),
external: Vec::new(),
case_insensitive: false,
}
}
}
impl<Err, M, T> Scope<Err, M, T>
where
T: ServiceFactory<
WebRequest<Err>,
SharedCfg,
Response = WebRequest<Err>,
Error = Err::Container,
InitError = (),
>,
Err: ErrorRenderer,
{
#[must_use]
pub fn guard<G: Guard + 'static>(mut self, guard: G) -> Self {
self.guards.push(Box::new(guard));
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 case_insensitive_routing(mut self) -> Self {
self.case_insensitive = true;
self
}
#[must_use]
pub fn configure<F>(mut self, f: F) -> Self
where
F: FnOnce(&mut ServiceConfig<Err>),
{
let mut cfg = ServiceConfig::new();
f(&mut cfg);
self.services.extend(cfg.services);
self.external.extend(cfg.external);
if !cfg.state.is_empty() {
let mut state = self.state.unwrap_or_default();
state.extend(cfg.state);
self.state = Some(state);
}
self
}
#[must_use]
pub fn service<F>(mut self, factory: F) -> Self
where
F: WebServiceFactory<Err> + 'static,
{
self.services
.push(Box::new(ServiceFactoryWrapper::new(factory)));
self
}
#[must_use]
pub fn route(self, path: &str, mut route: Route<Err>) -> Self {
self.service(
Resource::new(path)
.add_guards(route.take_guards())
.route(route),
)
}
#[must_use]
pub fn default_service<F, S>(mut self, f: F) -> Self
where
F: IntoServiceFactory<S, WebRequest<Err>, SharedCfg>,
S: ServiceFactory<
WebRequest<Err>,
SharedCfg,
Response = WebResponse,
Error = Err::Container,
> + 'static,
S::InitError: fmt::Debug,
{
self.default = Rc::new(RefCell::new(Some(Rc::new(boxed::factory(
chain_factory(f.into_factory())
.map_init_err(|e| log::error!("Cannot construct default service: {e:?}")),
)))));
self
}
#[must_use]
pub fn filter<U, F>(
self,
filter: F,
) -> Scope<
Err,
M,
impl ServiceFactory<
WebRequest<Err>,
SharedCfg,
Response = WebRequest<Err>,
Error = Err::Container,
InitError = (),
>,
>
where
U: ServiceFactory<
WebRequest<Err>,
SharedCfg,
Response = WebRequest<Err>,
Error = Err::Container,
>,
F: IntoServiceFactory<U, WebRequest<Err>, SharedCfg>,
{
Scope {
filter: self
.filter
.and_then(filter.into_factory().map_init_err(|_| ())),
middleware: self.middleware,
rdef: self.rdef,
state: self.state,
guards: self.guards,
services: self.services,
default: self.default,
external: self.external,
case_insensitive: self.case_insensitive,
}
}
#[must_use]
pub fn middleware<U>(self, mw: U) -> Scope<Err, WebStack<M, U, Err>, T> {
Scope {
middleware: WebStack::new(self.middleware, mw),
filter: self.filter,
rdef: self.rdef,
state: self.state,
guards: self.guards,
services: self.services,
default: self.default,
external: self.external,
case_insensitive: self.case_insensitive,
}
}
#[doc(hidden)]
#[deprecated(since = "3.2.0", note = "use `middleware()` instead")]
pub fn wrap<U>(self, mw: U) -> Scope<Err, WebStack<M, U, Err>, T> {
self.middleware(mw)
}
}
impl<Err, M, T> WebServiceFactory<Err> for Scope<Err, M, T>
where
T: ServiceFactory<
WebRequest<Err>,
SharedCfg,
Response = WebRequest<Err>,
Error = Err::Container,
InitError = (),
> + 'static,
M: Middleware<ScopeService<T::Service, Err>, SharedCfg> + 'static,
M::Service: Service<WebRequest<Err>, Response = WebResponse, Error = Err::Container>,
Err: ErrorRenderer,
{
fn register(mut self, config: &mut WebServiceConfig<Err>) {
if self.default.borrow().is_none() {
*self.default.borrow_mut() = Some(config.default_service());
}
let state = self.state.take().map(|state| {
AppState::new(
state,
Some(config.state().clone()),
config.state().0.config.clone(),
)
});
let mut cfg = config.clone_config(state.clone());
self.services
.into_iter()
.for_each(|mut srv| srv.register(&mut cfg));
let slesh = self.rdef.iter().any(|s| s.ends_with('/'));
let mut rmap = ResourceMap::new(ResourceDef::root_prefix(self.rdef.clone()));
for mut rdef in std::mem::take(&mut self.external) {
rmap.add(&mut rdef, None);
}
let router_factory = ScopeRouterFactory {
state,
default: self.default.borrow_mut().take(),
case_insensitive: self.case_insensitive,
services: cfg
.into_services()
.into_iter()
.map(|(rdef, srv, guards, nested)| {
let mut rdef = if slesh && rdef.pattern() == "" {
ResourceDef::new("/")
} else {
rdef
};
rmap.add(&mut rdef, nested);
(rdef, srv, RefCell::new(guards))
})
.collect(),
};
let guards = if self.guards.is_empty() {
None
} else {
Some(self.guards)
};
config.register_service(
ResourceDef::root_prefix(self.rdef),
guards,
ScopeServiceFactory {
middleware: self.middleware,
filter: self.filter,
routing: router_factory,
},
Some(Rc::new(rmap)),
);
}
}
struct ScopeServiceFactory<M, F, Err: ErrorRenderer> {
middleware: M,
filter: F,
routing: ScopeRouterFactory<Err>,
}
impl<M, F, Err> ServiceFactory<WebRequest<Err>, SharedCfg>
for ScopeServiceFactory<M, F, Err>
where
M: Middleware<ScopeService<F::Service, Err>, SharedCfg> + 'static,
M::Service: Service<WebRequest<Err>, Response = WebResponse, Error = Err::Container>,
F: ServiceFactory<
WebRequest<Err>,
SharedCfg,
Response = WebRequest<Err>,
Error = Err::Container,
InitError = (),
> + 'static,
Err: ErrorRenderer,
{
type Response = WebResponse;
type Error = Err::Container;
type Service = M::Service;
type InitError = ();
async fn create(&self, cfg: SharedCfg) -> Result<Self::Service, Self::InitError> {
Ok(self.middleware.create(
ScopeService {
filter: self.filter.create(cfg.clone()).await?,
routing: self.routing.create(cfg.clone()).await?,
},
cfg,
))
}
}
#[derive(derive_more::Debug)]
#[debug("ScopeService")]
pub struct ScopeService<F, Err: ErrorRenderer> {
filter: F,
routing: ScopeRouter<Err>,
}
impl<F, Err> Service<WebRequest<Err>> for ScopeService<F, Err>
where
F: Service<WebRequest<Err>, Response = WebRequest<Err>, Error = Err::Container>,
Err: ErrorRenderer,
{
type Response = WebResponse;
type Error = Err::Container;
#[inline]
async fn ready(&self, ctx: ServiceCtx<'_, Self>) -> Result<(), Self::Error> {
let (ready1, ready2) =
join(ctx.ready(&self.filter), ctx.ready(&self.routing)).await;
ready1?;
ready2
}
#[inline]
fn poll(&self, cx: &mut Context<'_>) -> Result<(), Self::Error> {
self.filter.poll(cx)?;
self.routing.poll(cx)
}
#[inline]
async fn call(
&self,
req: WebRequest<Err>,
ctx: ServiceCtx<'_, Self>,
) -> Result<Self::Response, Self::Error> {
let req = ctx.call(&self.filter, req).await?;
ctx.call(&self.routing, req).await
}
}
struct ScopeRouterFactory<Err: ErrorRenderer> {
state: Option<AppState>,
services: Vec<(ResourceDef, HttpNewService<Err>, RefCell<Option<Guards>>)>,
default: Option<Rc<HttpNewService<Err>>>,
case_insensitive: bool,
}
impl<Err: ErrorRenderer> ServiceFactory<WebRequest<Err>, SharedCfg>
for ScopeRouterFactory<Err>
{
type Response = WebResponse;
type Error = Err::Container;
type InitError = ();
type Service = ScopeRouter<Err>;
async fn create(&self, cfg: SharedCfg) -> Result<Self::Service, Self::InitError> {
let mut router = Router::build();
if self.case_insensitive {
router.case_insensitive();
}
for (path, factory, guards) in &mut self.services.iter() {
let service = factory.create(cfg.clone()).await?;
router.rdef(path.clone(), service).2 = guards.borrow_mut().take();
}
let default = if let Some(ref default) = self.default {
Some(default.create(cfg).await?)
} else {
None
};
Ok(ScopeRouter {
default,
router: router.finish(),
state: self.state.clone(),
})
}
}
struct ScopeRouter<Err: ErrorRenderer> {
state: Option<AppState>,
router: Router<HttpService<Err>, Vec<Box<dyn Guard>>>,
default: Option<HttpService<Err>>,
}
impl<Err: ErrorRenderer> Service<WebRequest<Err>> for ScopeRouter<Err> {
type Response = WebResponse;
type Error = Err::Container;
async fn call(
&self,
mut req: WebRequest<Err>,
ctx: ServiceCtx<'_, Self>,
) -> Result<Self::Response, Self::Error> {
let res = self.router.recognize_checked(&mut req, |req, guards| {
if let Some(guards) = guards {
for f in guards {
if !f.check(req.head()) {
return false;
}
}
}
true
});
if let Some((srv, _info)) = res {
if let Some(ref state) = self.state {
req.set_state_container(state.clone());
}
ctx.call(srv, req).await
} else if let Some(ref default) = self.default {
ctx.call(default, req).await
} else {
let req = req.into_parts().0;
Ok(WebResponse::new(Response::NotFound().finish(), req))
}
}
}
#[cfg(test)]
mod tests {
use crate::http::body::{Body, ResponseBody};
use crate::http::header::{CONTENT_TYPE, HeaderValue};
use crate::http::{Method, StatusCode};
use crate::service::fn_service;
use crate::util::{Bytes, Ready};
use crate::web::DefaultError;
use crate::web::middleware::DefaultHeaders;
use crate::web::request::WebRequest;
use crate::web::test::{TestRequest, call_service, init_service, read_body};
use crate::web::{self, App, HttpRequest, HttpResponse, guard};
#[crate::rt_test]
async fn test_scope() {
let srv =
init_service(
App::new()
.service(web::scope("/app").service(
web::resource("/path1").to(|| async { HttpResponse::Ok() }),
))
.service(web::scope("/app2").case_insensitive_routing().service(
web::resource("/path1").to(|| async { HttpResponse::Ok() }),
)),
)
.await;
let req = TestRequest::with_uri("/app/path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/app/path10").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
let req = TestRequest::with_uri("/app2/path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/app2/Path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[crate::rt_test]
async fn test_scope_root() {
let srv = init_service(
App::new().service(
web::scope("/app")
.service(web::resource("").to(|| async { HttpResponse::Ok() }))
.service(web::resource("/").to(|| async { HttpResponse::Created() })),
),
)
.await;
let req = TestRequest::with_uri("/app").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/app/").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::CREATED);
}
#[crate::rt_test]
async fn test_scope_root_multi() {
let srv = init_service(
App::new().service(
web::scope(["/app", "/app2"])
.service(web::resource("").to(|| async { HttpResponse::Ok() }))
.service(web::resource("/").to(|| async { HttpResponse::Created() })),
),
)
.await;
for url in &["/app", "/app2"] {
let req = TestRequest::with_uri(url).to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
for url in &["/app/", "/app2/"] {
let req = TestRequest::with_uri(url).to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::CREATED);
}
}
#[crate::rt_test]
async fn test_scope_root2() {
let srv = init_service(
App::new().service(
web::scope("/app/")
.service(web::resource("").to(|| async { HttpResponse::Ok() })),
),
)
.await;
let req = TestRequest::with_uri("/app").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
let req = TestRequest::with_uri("/app/").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[crate::rt_test]
async fn test_scope_root2_multi() {
let srv = init_service(
App::new().service(
web::scope(["/app/", "/app2/"])
.service(web::resource("").to(|| async { HttpResponse::Ok() })),
),
)
.await;
for url in &["/app", "/app2"] {
let req = TestRequest::with_uri(url).to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
}
for url in &["/app/", "/app2/"] {
let req = TestRequest::with_uri(url).to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
}
#[crate::rt_test]
async fn test_scope_root3() {
let srv = init_service(
App::new().service(
web::scope("/app/")
.service(web::resource("/").to(|| async { HttpResponse::Ok() })),
),
)
.await;
let req = TestRequest::with_uri("/app").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
let req = TestRequest::with_uri("/app/").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[crate::rt_test]
async fn test_scope_route() {
let srv = init_service(
App::new().service(
web::scope("app")
.route("/path1", web::get().to(|| async { HttpResponse::Ok() }))
.route("/path1", web::delete().to(|| async { HttpResponse::Ok() })),
),
)
.await;
for (m, status) in &[
(Method::GET, StatusCode::OK),
(Method::DELETE, StatusCode::OK),
(Method::POST, StatusCode::NOT_FOUND),
] {
let req = TestRequest::with_uri("/app/path1")
.method(m.clone())
.to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), status.clone());
}
}
#[crate::rt_test]
async fn test_scope_route_multi() {
let srv = init_service(
App::new().service(
web::scope(["app", "app2"])
.route("/path1", web::get().to(|| async { HttpResponse::Ok() }))
.route("/path1", web::delete().to(|| async { HttpResponse::Ok() })),
),
)
.await;
for (m, status) in &[
(Method::GET, StatusCode::OK),
(Method::DELETE, StatusCode::OK),
(Method::POST, StatusCode::NOT_FOUND),
] {
let req = TestRequest::with_uri("/app/path1")
.method(m.clone())
.to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), status.clone());
let req = TestRequest::with_uri("/app2/path1")
.method(m.clone())
.to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), status.clone());
}
}
#[crate::rt_test]
async fn test_scope_route_without_leading_slash() {
let srv = init_service(
App::new().service(
web::scope("app").service(
web::resource("path1")
.route(web::get().to(|| async { HttpResponse::Ok() }))
.route(web::delete().to(|| async { HttpResponse::Ok() })),
),
),
)
.await;
let req = TestRequest::with_uri("/app/path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/app/path1")
.method(Method::DELETE)
.to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/app/path1")
.method(Method::POST)
.to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
}
#[crate::rt_test]
async fn test_scope_guard() {
let srv = init_service(
App::new()
.service(
web::scope("/app").guard(guard::Get()).service(
web::resource("/path1").to(|| async { HttpResponse::Ok() }),
),
)
.service(web::scope("/app").guard(guard::Post()).service(
web::resource("/path1").to(|| async { HttpResponse::NotModified() }),
))
.service(
web::resource("/app/path1").to(|| async { HttpResponse::NoContent() }),
),
)
.await;
let req = TestRequest::with_uri("/app/path1")
.method(Method::POST)
.to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NOT_MODIFIED);
let req = TestRequest::with_uri("/app/path1")
.method(Method::GET)
.to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/app/path1")
.method(Method::DELETE)
.to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NO_CONTENT);
}
#[crate::rt_test]
async fn test_scope_variable_segment() {
let srv = init_service(App::new().service(web::scope("/ab-{project}").service(
web::resource("/path1").to(|r: HttpRequest| async move {
HttpResponse::Ok().body(format!("project: {}", &r.match_info()["project"]))
}),
)))
.await;
let req = TestRequest::with_uri("/ab-project1/path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
if let ResponseBody::Body(Body::Bytes(b)) = resp.response().body() {
let bytes: Bytes = b.clone();
assert_eq!(bytes, Bytes::from_static(b"project: project1"));
}
let req = TestRequest::with_uri("/aa-project1/path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
}
#[crate::rt_test]
async fn test_scope_variable_segment2() {
let srv = init_service(App::new().service(web::scope("/ab-{project}").service(
web::resource(["", "/"]).to(|r: HttpRequest| async move {
HttpResponse::Ok().body(format!("project: {}", &r.match_info()["project"]))
}),
)))
.await;
let req = TestRequest::with_uri("/ab-project1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
if let ResponseBody::Body(Body::Bytes(b)) = resp.response().body() {
let bytes: Bytes = b.clone();
assert_eq!(bytes, Bytes::from_static(b"project: project1"));
}
let req = TestRequest::with_uri("/ab-project1/").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
if let ResponseBody::Body(Body::Bytes(b)) = resp.response().body() {
let bytes: Bytes = b.clone();
assert_eq!(bytes, Bytes::from_static(b"project: project1"));
}
let req = TestRequest::with_uri("/aa-project1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
}
#[crate::rt_test]
async fn test_nested_scope() {
let srv =
init_service(App::new().service(web::scope("/app").service(
web::scope("/t1").service(
web::resource("/path1").to(|| async { HttpResponse::Created() }),
),
)))
.await;
let req = TestRequest::with_uri("/app/t1/path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::CREATED);
}
#[crate::rt_test]
async fn test_nested_scope_no_slash() {
let srv =
init_service(App::new().service(web::scope("/app").service(
web::scope("t1").service(
web::resource("/path1").to(|| async { HttpResponse::Created() }),
),
)))
.await;
let req = TestRequest::with_uri("/app/t1/path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::CREATED);
}
#[crate::rt_test]
async fn test_nested_scope_root() {
let srv = init_service(
App::new().service(
web::scope("/app").service(
web::scope("/t1")
.service(web::resource("").to(|| async { HttpResponse::Ok() }))
.service(
web::resource("/").to(|| async { HttpResponse::Created() }),
),
),
),
)
.await;
let req = TestRequest::with_uri("/app/t1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
let req = TestRequest::with_uri("/app/t1/").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::CREATED);
}
#[crate::rt_test]
async fn test_nested_scope_filter() {
let srv =
init_service(App::new().service(
web::scope("/app").service(
web::scope("/t1").guard(guard::Get()).service(
web::resource("/path1").to(|| async { HttpResponse::Ok() }),
),
),
))
.await;
let req = TestRequest::with_uri("/app/t1/path1")
.method(Method::POST)
.to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
let req = TestRequest::with_uri("/app/t1/path1")
.method(Method::GET)
.to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[crate::rt_test]
async fn test_nested_scope_with_variable_segment() {
let srv = init_service(App::new().service(web::scope("/app").service(
web::scope("/{project_id}").service(web::resource("/path1").to(
|r: HttpRequest| async move {
HttpResponse::Created()
.body(format!("project: {}", &r.match_info()["project_id"]))
},
)),
)))
.await;
let req = TestRequest::with_uri("/app/project_1/path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::CREATED);
if let ResponseBody::Body(Body::Bytes(b)) = resp.response().body() {
let bytes: Bytes = b.clone();
assert_eq!(bytes, Bytes::from_static(b"project: project_1"));
}
}
#[crate::rt_test]
async fn test_nested2_scope_with_variable_segment() {
let srv = init_service(App::new().service(web::scope("/app").service(
web::scope("/{project}").service(web::scope("/{id}").service(
web::resource("/path1").to(|r: HttpRequest| async move {
HttpResponse::Created().body(format!(
"project: {} - {}",
&r.match_info()["project"],
&r.match_info()["id"],
))
}),
)),
)))
.await;
let req = TestRequest::with_uri("/app/test/1/path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::CREATED);
if let ResponseBody::Body(Body::Bytes(b)) = resp.response().body() {
let bytes: Bytes = b.clone();
assert_eq!(bytes, Bytes::from_static(b"project: test - 1"));
}
let req = TestRequest::with_uri("/app/test/1/path2").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
}
#[crate::rt_test]
async fn test_default_resource() {
let srv = init_service(
App::new().service(
web::scope("/app")
.service(web::resource("/path1").to(|| async { HttpResponse::Ok() }))
.default_service(|r: WebRequest<DefaultError>| async move {
Ok(r.into_response(HttpResponse::BadRequest()))
}),
),
)
.await;
let req = TestRequest::with_uri("/app/path2").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
let req = TestRequest::with_uri("/path2").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
}
#[crate::rt_test]
async fn test_default_resource_propagation() {
let srv = init_service(
App::new()
.service(web::scope("/app1").default_service(
web::resource("").to(|| async { HttpResponse::BadRequest() }),
))
.service(web::scope("/app2"))
.default_service(|r: WebRequest<DefaultError>| async move {
Ok(r.into_response(HttpResponse::MethodNotAllowed()))
}),
)
.await;
let req = TestRequest::with_uri("/non-exist").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
let req = TestRequest::with_uri("/app1/non-exist").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
let req = TestRequest::with_uri("/app2/non-exist").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
}
#[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::scope("app")
.filter(fn_service(move |req: WebRequest<_>| {
filter2.set(true);
Ready::Ok(req)
}))
.route("/test", web::get().to(|| async { HttpResponse::Ok() })),
),
)
.await;
let req = TestRequest::with_uri("/app/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_middleware() {
let srv = init_service(
App::new().service(
web::scope("app")
.middleware(
DefaultHeaders::new()
.header(CONTENT_TYPE, HeaderValue::from_static("0001")),
)
.service(
web::resource("/test")
.route(web::get().to(|| async { HttpResponse::Ok() })),
),
),
)
.await;
let req = TestRequest::with_uri("/app/test").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(
resp.headers().get(CONTENT_TYPE).unwrap(),
HeaderValue::from_static("0001")
);
}
#[crate::rt_test]
async fn test_scope_config() {
let srv = init_service(App::new().service(web::scope("/app").configure(|s| {
s.state("teat");
s.route("/path1", web::get().to(|| async { HttpResponse::Ok() }));
})))
.await;
let req = TestRequest::with_uri("/app/path1").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[crate::rt_test]
async fn test_override_state() {
let srv = init_service(App::new().state(1usize).service(
web::scope("app").state(10usize).state(100u16).route(
"/t",
web::get().to(
|data: web::types::State<usize>, data2: web::types::State<u16>| {
assert_eq!(*data, 10);
assert_eq!(*data2, 100);
async { HttpResponse::Ok() }
},
),
),
))
.await;
let req = TestRequest::with_uri("/app/t").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
}
#[crate::rt_test]
async fn test_scope_config_2() {
let srv = init_service(App::new().service(web::scope("/app").configure(|s| {
s.service(web::scope("/v1").configure(|s| {
s.route("/", web::get().to(|| async { HttpResponse::Ok() }));
}));
})))
.await;
let req = TestRequest::with_uri("/app/v1/").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[cfg(feature = "url")]
#[crate::rt_test]
async fn test_url_for_external() {
let srv = init_service(App::new().service(web::scope("/app").configure(|s| {
s.service(web::scope("/v1").configure(|s| {
s.external_resource("youtube", "https://youtube.com/watch/{video_id}");
s.route(
"/",
web::get().to(|req: HttpRequest| async move {
HttpResponse::Ok().body(
req.url_for("youtube", ["xxxxxx"])
.unwrap()
.as_str()
.to_string(),
)
}),
);
}));
})))
.await;
let req = TestRequest::with_uri("/app/v1/").to_request();
let resp = srv.call(req).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
let body = read_body(resp).await;
assert_eq!(body, &b"https://youtube.com/watch/xxxxxx"[..]);
}
#[cfg(feature = "url")]
#[crate::rt_test]
async fn test_url_for_nested() {
let srv = init_service(App::new().service(web::scope("/a").service(
web::scope("/b").service(web::resource("/c/{stuff}").name("c").route(
web::get().to(|req: HttpRequest| async move {
HttpResponse::Ok()
.body(format!("{}", req.url_for("c", ["12345"]).unwrap()))
}),
)),
)))
.await;
let req = TestRequest::with_uri("/a/b/c/test").to_request();
let resp = call_service(&srv, req).await;
assert_eq!(resp.status(), StatusCode::OK);
let body = read_body(resp).await;
assert_eq!(
body,
Bytes::from_static(b"http://localhost:8080/a/b/c/12345")
);
}
}