2019-03-04 06:02:01 +01:00
|
|
|
use std::cell::RefCell;
|
|
|
|
use std::rc::Rc;
|
|
|
|
|
|
|
|
use actix_http::Response;
|
|
|
|
use actix_router::{ResourceDef, ResourceInfo, Router};
|
|
|
|
use actix_service::boxed::{self, BoxedNewService, BoxedService};
|
|
|
|
use actix_service::{
|
2019-03-05 06:37:57 +01:00
|
|
|
ApplyTransform, IntoNewService, IntoTransform, NewService, Service, Transform,
|
2019-03-04 06:02:01 +01:00
|
|
|
};
|
|
|
|
use futures::future::{ok, Either, Future, FutureResult};
|
|
|
|
use futures::{Async, Poll};
|
|
|
|
|
2019-03-07 04:19:27 +01:00
|
|
|
use crate::dev::{AppConfig, HttpServiceFactory};
|
2019-03-04 06:02:01 +01:00
|
|
|
use crate::guard::Guard;
|
|
|
|
use crate::resource::Resource;
|
|
|
|
use crate::route::Route;
|
2019-03-07 00:47:15 +01:00
|
|
|
use crate::service::{
|
|
|
|
ServiceFactory, ServiceFactoryWrapper, ServiceRequest, ServiceResponse,
|
|
|
|
};
|
2019-03-04 06:02:01 +01:00
|
|
|
|
2019-03-04 20:47:53 +01:00
|
|
|
type Guards = Vec<Box<Guard>>;
|
2019-03-04 06:02:01 +01:00
|
|
|
type HttpService<P> = BoxedService<ServiceRequest<P>, ServiceResponse, ()>;
|
|
|
|
type HttpNewService<P> = BoxedNewService<(), ServiceRequest<P>, ServiceResponse, (), ()>;
|
|
|
|
type BoxedResponse = Box<Future<Item = ServiceResponse, Error = ()>>;
|
|
|
|
|
|
|
|
/// Resources scope
|
|
|
|
///
|
|
|
|
/// Scope is a set of resources with common root path.
|
|
|
|
/// Scopes collect multiple paths under a common path prefix.
|
|
|
|
/// Scope path can contain variable path segments as resources.
|
|
|
|
/// Scope prefix is always complete path segment, i.e `/app` would
|
|
|
|
/// be converted to a `/app/` and it would not match `/app` path.
|
|
|
|
///
|
|
|
|
/// You can get variable path segments from `HttpRequest::match_info()`.
|
|
|
|
/// `Path` extractor also is able to extract scope level variable segments.
|
|
|
|
///
|
|
|
|
/// ```rust
|
2019-03-04 22:25:35 +01:00
|
|
|
/// use actix_web::{web, App, HttpResponse};
|
2019-03-04 06:02:01 +01:00
|
|
|
///
|
|
|
|
/// fn main() {
|
2019-03-07 00:47:15 +01:00
|
|
|
/// let app = App::new().service(
|
|
|
|
/// web::scope("/{project_id}/")
|
|
|
|
/// .service(web::resource("/path1").to(|| HttpResponse::Ok()))
|
|
|
|
/// .service(web::resource("/path2").route(web::get().to(|| HttpResponse::Ok())))
|
|
|
|
/// .service(web::resource("/path3").route(web::head().to(|| HttpResponse::MethodNotAllowed())))
|
|
|
|
/// );
|
2019-03-04 06:02:01 +01:00
|
|
|
/// }
|
|
|
|
/// ```
|
|
|
|
///
|
|
|
|
/// In the above example three routes get registered:
|
|
|
|
/// * /{project_id}/path1 - reponds to all http method
|
|
|
|
/// * /{project_id}/path2 - `GET` requests
|
|
|
|
/// * /{project_id}/path3 - `HEAD` requests
|
|
|
|
///
|
|
|
|
pub struct Scope<P, T = ScopeEndpoint<P>> {
|
|
|
|
endpoint: T,
|
2019-03-07 00:47:15 +01:00
|
|
|
rdef: String,
|
|
|
|
services: Vec<Box<ServiceFactory<P>>>,
|
2019-03-04 20:47:53 +01:00
|
|
|
guards: Vec<Box<Guard>>,
|
2019-03-04 06:02:01 +01:00
|
|
|
default: Rc<RefCell<Option<Rc<HttpNewService<P>>>>>,
|
|
|
|
factory_ref: Rc<RefCell<Option<ScopeFactory<P>>>>,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<P: 'static> Scope<P> {
|
|
|
|
/// Create a new scope
|
|
|
|
pub fn new(path: &str) -> Scope<P> {
|
|
|
|
let fref = Rc::new(RefCell::new(None));
|
|
|
|
Scope {
|
|
|
|
endpoint: ScopeEndpoint::new(fref.clone()),
|
2019-03-07 00:47:15 +01:00
|
|
|
rdef: path.to_string(),
|
2019-03-04 20:47:53 +01:00
|
|
|
guards: Vec::new(),
|
2019-03-04 06:02:01 +01:00
|
|
|
services: Vec::new(),
|
|
|
|
default: Rc::new(RefCell::new(None)),
|
|
|
|
factory_ref: fref,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-03-07 00:47:15 +01:00
|
|
|
impl<P, T> Scope<P, T>
|
2019-03-04 06:02:01 +01:00
|
|
|
where
|
2019-03-07 00:47:15 +01:00
|
|
|
P: 'static,
|
2019-03-04 06:02:01 +01:00
|
|
|
T: NewService<
|
2019-03-05 19:08:08 +01:00
|
|
|
ServiceRequest<P>,
|
2019-03-04 06:02:01 +01:00
|
|
|
Response = ServiceResponse,
|
|
|
|
Error = (),
|
|
|
|
InitError = (),
|
|
|
|
>,
|
|
|
|
{
|
2019-03-07 00:47:15 +01:00
|
|
|
/// Add match guard to a scope.
|
2019-03-04 06:02:01 +01:00
|
|
|
///
|
|
|
|
/// ```rust
|
2019-03-07 23:01:52 +01:00
|
|
|
/// use actix_web::{web, guard, App, HttpRequest, HttpResponse};
|
2019-03-04 06:02:01 +01:00
|
|
|
///
|
2019-03-07 23:01:52 +01:00
|
|
|
/// fn index(data: web::Path<(String, String)>) -> &'static str {
|
2019-03-04 06:02:01 +01:00
|
|
|
/// "Welcome!"
|
|
|
|
/// }
|
|
|
|
///
|
|
|
|
/// fn main() {
|
2019-03-07 00:47:15 +01:00
|
|
|
/// let app = App::new().service(
|
|
|
|
/// web::scope("/app")
|
2019-03-04 06:02:01 +01:00
|
|
|
/// .guard(guard::Header("content-type", "text/plain"))
|
2019-03-07 00:47:15 +01:00
|
|
|
/// .route("/test1", web::get().to(index))
|
2019-03-04 06:02:01 +01:00
|
|
|
/// .route("/test2", web::post().to(|r: HttpRequest| {
|
|
|
|
/// HttpResponse::MethodNotAllowed()
|
|
|
|
/// }))
|
2019-03-07 00:47:15 +01:00
|
|
|
/// );
|
2019-03-04 06:02:01 +01:00
|
|
|
/// }
|
|
|
|
/// ```
|
|
|
|
pub fn guard<G: Guard + 'static>(mut self, guard: G) -> Self {
|
2019-03-04 20:47:53 +01:00
|
|
|
self.guards.push(Box::new(guard));
|
2019-03-04 06:02:01 +01:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2019-03-07 00:47:15 +01:00
|
|
|
/// Create nested service.
|
2019-03-04 06:02:01 +01:00
|
|
|
///
|
|
|
|
/// ```rust
|
2019-03-07 00:47:15 +01:00
|
|
|
/// use actix_web::{web, App, HttpRequest};
|
2019-03-04 06:02:01 +01:00
|
|
|
///
|
|
|
|
/// struct AppState;
|
|
|
|
///
|
|
|
|
/// fn index(req: HttpRequest) -> &'static str {
|
|
|
|
/// "Welcome!"
|
|
|
|
/// }
|
|
|
|
///
|
|
|
|
/// fn main() {
|
2019-03-07 00:47:15 +01:00
|
|
|
/// let app = App::new().service(
|
|
|
|
/// web::scope("/app").service(
|
|
|
|
/// web::scope("/v1")
|
|
|
|
/// .service(web::resource("/test1").to(index)))
|
|
|
|
/// );
|
2019-03-04 06:02:01 +01:00
|
|
|
/// }
|
|
|
|
/// ```
|
2019-03-07 00:47:15 +01:00
|
|
|
pub fn service<F>(mut self, factory: F) -> Self
|
2019-03-04 06:02:01 +01:00
|
|
|
where
|
2019-03-07 00:47:15 +01:00
|
|
|
F: HttpServiceFactory<P> + 'static,
|
2019-03-04 06:02:01 +01:00
|
|
|
{
|
|
|
|
self.services
|
2019-03-07 00:47:15 +01:00
|
|
|
.push(Box::new(ServiceFactoryWrapper::new(factory)));
|
2019-03-04 06:02:01 +01:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Configure route for a specific path.
|
|
|
|
///
|
2019-03-07 00:47:15 +01:00
|
|
|
/// This is a simplified version of the `Scope::service()` method.
|
2019-03-04 06:02:01 +01:00
|
|
|
/// This method can not be could multiple times, in that case
|
|
|
|
/// multiple resources with one route would be registered for same resource path.
|
|
|
|
///
|
|
|
|
/// ```rust
|
2019-03-07 23:01:52 +01:00
|
|
|
/// use actix_web::{web, App, HttpResponse};
|
2019-03-04 06:02:01 +01:00
|
|
|
///
|
2019-03-07 23:01:52 +01:00
|
|
|
/// fn index(data: web::Path<(String, String)>) -> &'static str {
|
2019-03-04 06:02:01 +01:00
|
|
|
/// "Welcome!"
|
|
|
|
/// }
|
|
|
|
///
|
|
|
|
/// fn main() {
|
2019-03-07 00:47:15 +01:00
|
|
|
/// let app = App::new().service(
|
|
|
|
/// web::scope("/app")
|
|
|
|
/// .route("/test1", web::get().to(index))
|
2019-03-04 06:02:01 +01:00
|
|
|
/// .route("/test2", web::post().to(|| HttpResponse::MethodNotAllowed()))
|
2019-03-07 00:47:15 +01:00
|
|
|
/// );
|
2019-03-04 06:02:01 +01:00
|
|
|
/// }
|
|
|
|
/// ```
|
2019-03-07 00:47:15 +01:00
|
|
|
pub fn route(self, path: &str, mut route: Route<P>) -> Self {
|
|
|
|
self.service(
|
|
|
|
Resource::new(path)
|
|
|
|
.add_guards(route.take_guards())
|
|
|
|
.route(route),
|
|
|
|
)
|
2019-03-04 06:02:01 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Default resource to be used if no matching route could be found.
|
|
|
|
pub fn default_resource<F, U>(mut self, f: F) -> Self
|
|
|
|
where
|
|
|
|
F: FnOnce(Resource<P>) -> Resource<P, U>,
|
|
|
|
U: NewService<
|
2019-03-05 19:08:08 +01:00
|
|
|
ServiceRequest<P>,
|
2019-03-04 06:02:01 +01:00
|
|
|
Response = ServiceResponse,
|
|
|
|
Error = (),
|
|
|
|
InitError = (),
|
|
|
|
> + 'static,
|
|
|
|
{
|
|
|
|
// create and configure default resource
|
|
|
|
self.default = Rc::new(RefCell::new(Some(Rc::new(boxed::new_service(
|
2019-03-07 00:47:15 +01:00
|
|
|
f(Resource::new("")).into_new_service().map_init_err(|_| ()),
|
2019-03-04 06:02:01 +01:00
|
|
|
)))));
|
|
|
|
|
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Register a scope middleware
|
|
|
|
///
|
|
|
|
/// This is similar to `App's` middlewares, but
|
|
|
|
/// middleware is not allowed to change response type (i.e modify response's body).
|
|
|
|
/// Middleware get invoked on scope level.
|
|
|
|
pub fn middleware<M, F>(
|
|
|
|
self,
|
|
|
|
mw: F,
|
|
|
|
) -> Scope<
|
|
|
|
P,
|
|
|
|
impl NewService<
|
2019-03-05 19:08:08 +01:00
|
|
|
ServiceRequest<P>,
|
2019-03-04 06:02:01 +01:00
|
|
|
Response = ServiceResponse,
|
|
|
|
Error = (),
|
|
|
|
InitError = (),
|
|
|
|
>,
|
|
|
|
>
|
|
|
|
where
|
2019-03-05 06:37:57 +01:00
|
|
|
M: Transform<
|
2019-03-04 06:02:01 +01:00
|
|
|
T::Service,
|
2019-03-05 19:08:08 +01:00
|
|
|
ServiceRequest<P>,
|
2019-03-04 06:02:01 +01:00
|
|
|
Response = ServiceResponse,
|
|
|
|
Error = (),
|
|
|
|
InitError = (),
|
|
|
|
>,
|
2019-03-05 19:08:08 +01:00
|
|
|
F: IntoTransform<M, T::Service, ServiceRequest<P>>,
|
2019-03-04 06:02:01 +01:00
|
|
|
{
|
2019-03-05 06:37:57 +01:00
|
|
|
let endpoint = ApplyTransform::new(mw, self.endpoint);
|
2019-03-04 06:02:01 +01:00
|
|
|
Scope {
|
|
|
|
endpoint,
|
|
|
|
rdef: self.rdef,
|
|
|
|
guards: self.guards,
|
|
|
|
services: self.services,
|
|
|
|
default: self.default,
|
|
|
|
factory_ref: self.factory_ref,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-03-07 00:47:15 +01:00
|
|
|
impl<P, T> HttpServiceFactory<P> for Scope<P, T>
|
2019-03-04 06:02:01 +01:00
|
|
|
where
|
2019-03-07 00:47:15 +01:00
|
|
|
P: 'static,
|
2019-03-04 06:02:01 +01:00
|
|
|
T: NewService<
|
2019-03-07 00:47:15 +01:00
|
|
|
ServiceRequest<P>,
|
|
|
|
Response = ServiceResponse,
|
|
|
|
Error = (),
|
|
|
|
InitError = (),
|
|
|
|
> + 'static,
|
2019-03-04 06:02:01 +01:00
|
|
|
{
|
2019-03-07 00:47:15 +01:00
|
|
|
fn register(self, config: &mut AppConfig<P>) {
|
|
|
|
if self.default.borrow().is_none() {
|
|
|
|
*self.default.borrow_mut() = Some(config.default_service());
|
2019-03-04 06:02:01 +01:00
|
|
|
}
|
|
|
|
|
2019-03-07 00:47:15 +01:00
|
|
|
// register services
|
|
|
|
let mut cfg = config.clone_config();
|
|
|
|
self.services
|
|
|
|
.into_iter()
|
|
|
|
.for_each(|mut srv| srv.register(&mut cfg));
|
|
|
|
|
2019-03-04 06:02:01 +01:00
|
|
|
*self.factory_ref.borrow_mut() = Some(ScopeFactory {
|
|
|
|
default: self.default.clone(),
|
2019-03-04 20:47:53 +01:00
|
|
|
services: Rc::new(
|
2019-03-07 00:47:15 +01:00
|
|
|
cfg.into_services()
|
2019-03-04 20:47:53 +01:00
|
|
|
.into_iter()
|
|
|
|
.map(|(rdef, srv, guards)| (rdef, srv, RefCell::new(guards)))
|
|
|
|
.collect(),
|
|
|
|
),
|
2019-03-04 06:02:01 +01:00
|
|
|
});
|
|
|
|
|
2019-03-07 00:47:15 +01:00
|
|
|
let guards = if self.guards.is_empty() {
|
|
|
|
None
|
|
|
|
} else {
|
|
|
|
Some(self.guards)
|
|
|
|
};
|
2019-03-07 04:27:18 +01:00
|
|
|
config.register_service(
|
|
|
|
ResourceDef::root_prefix(&self.rdef),
|
|
|
|
guards,
|
|
|
|
self.endpoint,
|
|
|
|
)
|
2019-03-04 06:02:01 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
pub struct ScopeFactory<P> {
|
2019-03-04 20:47:53 +01:00
|
|
|
services: Rc<Vec<(ResourceDef, HttpNewService<P>, RefCell<Option<Guards>>)>>,
|
2019-03-04 06:02:01 +01:00
|
|
|
default: Rc<RefCell<Option<Rc<HttpNewService<P>>>>>,
|
|
|
|
}
|
|
|
|
|
2019-03-05 19:08:08 +01:00
|
|
|
impl<P: 'static> NewService<ServiceRequest<P>> for ScopeFactory<P> {
|
2019-03-04 06:02:01 +01:00
|
|
|
type Response = ServiceResponse;
|
|
|
|
type Error = ();
|
|
|
|
type InitError = ();
|
|
|
|
type Service = ScopeService<P>;
|
|
|
|
type Future = ScopeFactoryResponse<P>;
|
|
|
|
|
|
|
|
fn new_service(&self, _: &()) -> Self::Future {
|
|
|
|
let default_fut = if let Some(ref default) = *self.default.borrow() {
|
|
|
|
Some(default.new_service(&()))
|
|
|
|
} else {
|
|
|
|
None
|
|
|
|
};
|
|
|
|
|
|
|
|
ScopeFactoryResponse {
|
|
|
|
fut: self
|
|
|
|
.services
|
|
|
|
.iter()
|
2019-03-04 20:47:53 +01:00
|
|
|
.map(|(path, service, guards)| {
|
2019-03-04 06:02:01 +01:00
|
|
|
CreateScopeServiceItem::Future(
|
|
|
|
Some(path.clone()),
|
2019-03-04 20:47:53 +01:00
|
|
|
guards.borrow_mut().take(),
|
2019-03-04 06:02:01 +01:00
|
|
|
service.new_service(&()),
|
|
|
|
)
|
|
|
|
})
|
|
|
|
.collect(),
|
|
|
|
default: None,
|
|
|
|
default_fut,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Create app service
|
|
|
|
#[doc(hidden)]
|
|
|
|
pub struct ScopeFactoryResponse<P> {
|
|
|
|
fut: Vec<CreateScopeServiceItem<P>>,
|
|
|
|
default: Option<HttpService<P>>,
|
|
|
|
default_fut: Option<Box<Future<Item = HttpService<P>, Error = ()>>>,
|
|
|
|
}
|
|
|
|
|
|
|
|
type HttpServiceFut<P> = Box<Future<Item = HttpService<P>, Error = ()>>;
|
|
|
|
|
|
|
|
enum CreateScopeServiceItem<P> {
|
2019-03-04 20:47:53 +01:00
|
|
|
Future(Option<ResourceDef>, Option<Guards>, HttpServiceFut<P>),
|
|
|
|
Service(ResourceDef, Option<Guards>, HttpService<P>),
|
2019-03-04 06:02:01 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
impl<P> Future for ScopeFactoryResponse<P> {
|
|
|
|
type Item = ScopeService<P>;
|
|
|
|
type Error = ();
|
|
|
|
|
|
|
|
fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
|
|
|
|
let mut done = true;
|
|
|
|
|
|
|
|
if let Some(ref mut fut) = self.default_fut {
|
|
|
|
match fut.poll()? {
|
|
|
|
Async::Ready(default) => self.default = Some(default),
|
|
|
|
Async::NotReady => done = false,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// poll http services
|
|
|
|
for item in &mut self.fut {
|
|
|
|
let res = match item {
|
2019-03-04 20:47:53 +01:00
|
|
|
CreateScopeServiceItem::Future(
|
|
|
|
ref mut path,
|
|
|
|
ref mut guards,
|
|
|
|
ref mut fut,
|
|
|
|
) => match fut.poll()? {
|
|
|
|
Async::Ready(service) => {
|
|
|
|
Some((path.take().unwrap(), guards.take(), service))
|
2019-03-04 06:02:01 +01:00
|
|
|
}
|
2019-03-04 20:47:53 +01:00
|
|
|
Async::NotReady => {
|
|
|
|
done = false;
|
|
|
|
None
|
|
|
|
}
|
|
|
|
},
|
|
|
|
CreateScopeServiceItem::Service(_, _, _) => continue,
|
2019-03-04 06:02:01 +01:00
|
|
|
};
|
|
|
|
|
2019-03-04 20:47:53 +01:00
|
|
|
if let Some((path, guards, service)) = res {
|
|
|
|
*item = CreateScopeServiceItem::Service(path, guards, service);
|
2019-03-04 06:02:01 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if done {
|
|
|
|
let router = self
|
|
|
|
.fut
|
|
|
|
.drain(..)
|
|
|
|
.fold(Router::build(), |mut router, item| {
|
|
|
|
match item {
|
2019-03-04 20:47:53 +01:00
|
|
|
CreateScopeServiceItem::Service(path, guards, service) => {
|
|
|
|
router.rdef(path, service);
|
|
|
|
router.set_user_data(guards);
|
2019-03-04 06:02:01 +01:00
|
|
|
}
|
2019-03-04 20:47:53 +01:00
|
|
|
CreateScopeServiceItem::Future(_, _, _) => unreachable!(),
|
2019-03-04 06:02:01 +01:00
|
|
|
}
|
|
|
|
router
|
|
|
|
});
|
|
|
|
Ok(Async::Ready(ScopeService {
|
|
|
|
router: router.finish(),
|
|
|
|
default: self.default.take(),
|
|
|
|
_ready: None,
|
|
|
|
}))
|
|
|
|
} else {
|
|
|
|
Ok(Async::NotReady)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
pub struct ScopeService<P> {
|
2019-03-04 20:47:53 +01:00
|
|
|
router: Router<HttpService<P>, Vec<Box<Guard>>>,
|
2019-03-04 06:02:01 +01:00
|
|
|
default: Option<HttpService<P>>,
|
|
|
|
_ready: Option<(ServiceRequest<P>, ResourceInfo)>,
|
|
|
|
}
|
|
|
|
|
2019-03-05 19:08:08 +01:00
|
|
|
impl<P> Service<ServiceRequest<P>> for ScopeService<P> {
|
2019-03-04 06:02:01 +01:00
|
|
|
type Response = ServiceResponse;
|
|
|
|
type Error = ();
|
|
|
|
type Future = Either<BoxedResponse, FutureResult<Self::Response, Self::Error>>;
|
|
|
|
|
|
|
|
fn poll_ready(&mut self) -> Poll<(), Self::Error> {
|
|
|
|
Ok(Async::Ready(()))
|
|
|
|
}
|
|
|
|
|
|
|
|
fn call(&mut self, mut req: ServiceRequest<P>) -> Self::Future {
|
2019-03-04 20:47:53 +01:00
|
|
|
let res = self.router.recognize_mut_checked(&mut req, |req, guards| {
|
|
|
|
if let Some(ref guards) = guards {
|
|
|
|
for f in guards {
|
|
|
|
if !f.check(req.head()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
true
|
|
|
|
});
|
|
|
|
|
|
|
|
if let Some((srv, _info)) = res {
|
2019-03-04 06:02:01 +01:00
|
|
|
Either::A(srv.call(req))
|
|
|
|
} else if let Some(ref mut default) = self.default {
|
|
|
|
Either::A(default.call(req))
|
|
|
|
} else {
|
|
|
|
let req = req.into_request();
|
|
|
|
Either::B(ok(ServiceResponse::new(req, Response::NotFound().finish())))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[doc(hidden)]
|
|
|
|
pub struct ScopeEndpoint<P> {
|
|
|
|
factory: Rc<RefCell<Option<ScopeFactory<P>>>>,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<P> ScopeEndpoint<P> {
|
|
|
|
fn new(factory: Rc<RefCell<Option<ScopeFactory<P>>>>) -> Self {
|
|
|
|
ScopeEndpoint { factory }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-03-05 19:08:08 +01:00
|
|
|
impl<P: 'static> NewService<ServiceRequest<P>> for ScopeEndpoint<P> {
|
2019-03-04 06:02:01 +01:00
|
|
|
type Response = ServiceResponse;
|
|
|
|
type Error = ();
|
|
|
|
type InitError = ();
|
|
|
|
type Service = ScopeService<P>;
|
|
|
|
type Future = ScopeFactoryResponse<P>;
|
|
|
|
|
|
|
|
fn new_service(&self, _: &()) -> Self::Future {
|
|
|
|
self.factory.borrow_mut().as_mut().unwrap().new_service(&())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
2019-03-07 00:47:15 +01:00
|
|
|
use actix_service::Service;
|
2019-03-04 06:02:01 +01:00
|
|
|
use bytes::Bytes;
|
|
|
|
|
2019-03-07 00:47:15 +01:00
|
|
|
use crate::body::{Body, ResponseBody};
|
|
|
|
use crate::http::{Method, StatusCode};
|
|
|
|
use crate::test::{block_on, init_service, TestRequest};
|
2019-03-04 20:47:53 +01:00
|
|
|
use crate::{guard, web, App, HttpRequest, HttpResponse};
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_scope() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new().service(
|
|
|
|
web::scope("/app")
|
|
|
|
.service(web::resource("/path1").to(|| HttpResponse::Ok())),
|
|
|
|
),
|
|
|
|
);
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/path1").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_scope_root() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new().service(
|
|
|
|
web::scope("/app")
|
|
|
|
.service(web::resource("").to(|| HttpResponse::Ok()))
|
|
|
|
.service(web::resource("/").to(|| HttpResponse::Created())),
|
|
|
|
),
|
|
|
|
);
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::CREATED);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_scope_root2() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(App::new().service(
|
|
|
|
web::scope("/app/").service(web::resource("").to(|| HttpResponse::Ok())),
|
|
|
|
));
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_scope_root3() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(App::new().service(
|
|
|
|
web::scope("/app/").service(web::resource("/").to(|| HttpResponse::Ok())),
|
|
|
|
));
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_scope_route() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new().service(
|
|
|
|
web::scope("app")
|
|
|
|
.route("/path1", web::get().to(|| HttpResponse::Ok()))
|
|
|
|
.route("/path1", web::delete().to(|| HttpResponse::Ok())),
|
|
|
|
),
|
|
|
|
);
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/path1").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/path1")
|
|
|
|
.method(Method::DELETE)
|
|
|
|
.to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/path1")
|
|
|
|
.method(Method::POST)
|
|
|
|
.to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_scope_route_without_leading_slash() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new().service(
|
|
|
|
web::scope("app").service(
|
|
|
|
web::resource("path1")
|
|
|
|
.route(web::get().to(|| HttpResponse::Ok()))
|
|
|
|
.route(web::delete().to(|| HttpResponse::Ok())),
|
|
|
|
),
|
|
|
|
),
|
|
|
|
);
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/path1").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/path1")
|
|
|
|
.method(Method::DELETE)
|
|
|
|
.to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/path1")
|
|
|
|
.method(Method::POST)
|
|
|
|
.to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
|
|
|
|
}
|
|
|
|
|
2019-03-04 20:47:53 +01:00
|
|
|
#[test]
|
|
|
|
fn test_scope_guard() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new().service(
|
|
|
|
web::scope("/app")
|
2019-03-04 20:47:53 +01:00
|
|
|
.guard(guard::Get())
|
2019-03-07 00:47:15 +01:00
|
|
|
.service(web::resource("/path1").to(|| HttpResponse::Ok())),
|
|
|
|
),
|
|
|
|
);
|
2019-03-04 20:47:53 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/path1")
|
|
|
|
.method(Method::POST)
|
|
|
|
.to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 20:47:53 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/path1")
|
|
|
|
.method(Method::GET)
|
|
|
|
.to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 20:47:53 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
}
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_scope_variable_segment() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv =
|
|
|
|
init_service(App::new().service(web::scope("/ab-{project}").service(
|
|
|
|
web::resource("/path1").to(|r: HttpRequest| {
|
|
|
|
HttpResponse::Ok()
|
|
|
|
.body(format!("project: {}", &r.match_info()["project"]))
|
|
|
|
}),
|
|
|
|
)));
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/ab-project1/path1").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
|
|
|
|
match resp.body() {
|
|
|
|
ResponseBody::Body(Body::Bytes(ref b)) => {
|
|
|
|
let bytes: Bytes = b.clone().into();
|
|
|
|
assert_eq!(bytes, Bytes::from_static(b"project: project1"));
|
|
|
|
}
|
|
|
|
_ => panic!(),
|
|
|
|
}
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/aa-project1/path1").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_nested_scope() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new().service(
|
|
|
|
web::scope("/app")
|
|
|
|
.service(web::scope("/t1").service(
|
|
|
|
web::resource("/path1").to(|| HttpResponse::Created()),
|
|
|
|
)),
|
|
|
|
),
|
|
|
|
);
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/t1/path1").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::CREATED);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_nested_scope_no_slash() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new().service(
|
|
|
|
web::scope("/app")
|
|
|
|
.service(web::scope("t1").service(
|
|
|
|
web::resource("/path1").to(|| HttpResponse::Created()),
|
|
|
|
)),
|
|
|
|
),
|
|
|
|
);
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/t1/path1").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::CREATED);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_nested_scope_root() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new().service(
|
|
|
|
web::scope("/app").service(
|
|
|
|
web::scope("/t1")
|
|
|
|
.service(web::resource("").to(|| HttpResponse::Ok()))
|
|
|
|
.service(web::resource("/").to(|| HttpResponse::Created())),
|
|
|
|
),
|
|
|
|
),
|
|
|
|
);
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/t1").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/t1/").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::CREATED);
|
|
|
|
}
|
|
|
|
|
2019-03-04 20:47:53 +01:00
|
|
|
#[test]
|
|
|
|
fn test_nested_scope_filter() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new().service(
|
|
|
|
web::scope("/app").service(
|
|
|
|
web::scope("/t1")
|
2019-03-04 20:47:53 +01:00
|
|
|
.guard(guard::Get())
|
2019-03-07 00:47:15 +01:00
|
|
|
.service(web::resource("/path1").to(|| HttpResponse::Ok())),
|
|
|
|
),
|
|
|
|
),
|
|
|
|
);
|
2019-03-04 20:47:53 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/t1/path1")
|
|
|
|
.method(Method::POST)
|
|
|
|
.to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 20:47:53 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/t1/path1")
|
|
|
|
.method(Method::GET)
|
|
|
|
.to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 20:47:53 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
}
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_nested_scope_with_variable_segment() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(App::new().service(web::scope("/app").service(
|
|
|
|
web::scope("/{project_id}").service(web::resource("/path1").to(
|
|
|
|
|r: HttpRequest| {
|
|
|
|
HttpResponse::Created()
|
|
|
|
.body(format!("project: {}", &r.match_info()["project_id"]))
|
|
|
|
},
|
|
|
|
)),
|
|
|
|
)));
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/project_1/path1").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::CREATED);
|
|
|
|
|
|
|
|
match resp.body() {
|
|
|
|
ResponseBody::Body(Body::Bytes(ref b)) => {
|
|
|
|
let bytes: Bytes = b.clone().into();
|
|
|
|
assert_eq!(bytes, Bytes::from_static(b"project: project_1"));
|
|
|
|
}
|
|
|
|
_ => panic!(),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_nested2_scope_with_variable_segment() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(App::new().service(web::scope("/app").service(
|
|
|
|
web::scope("/{project}").service(web::scope("/{id}").service(
|
|
|
|
web::resource("/path1").to(|r: HttpRequest| {
|
|
|
|
HttpResponse::Created().body(format!(
|
|
|
|
"project: {} - {}",
|
|
|
|
&r.match_info()["project"],
|
|
|
|
&r.match_info()["id"],
|
|
|
|
))
|
|
|
|
}),
|
|
|
|
)),
|
|
|
|
)));
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/test/1/path1").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::CREATED);
|
|
|
|
|
|
|
|
match resp.body() {
|
|
|
|
ResponseBody::Body(Body::Bytes(ref b)) => {
|
|
|
|
let bytes: Bytes = b.clone().into();
|
|
|
|
assert_eq!(bytes, Bytes::from_static(b"project: test - 1"));
|
|
|
|
}
|
|
|
|
_ => panic!(),
|
|
|
|
}
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/test/1/path2").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_default_resource() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new().service(
|
|
|
|
web::scope("/app")
|
|
|
|
.service(web::resource("/path1").to(|| HttpResponse::Ok()))
|
|
|
|
.default_resource(|r| r.to(|| HttpResponse::BadRequest())),
|
|
|
|
),
|
|
|
|
);
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app/path2").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/path2").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::NOT_FOUND);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_default_resource_propagation() {
|
2019-03-07 00:47:15 +01:00
|
|
|
let mut srv = init_service(
|
|
|
|
App::new()
|
|
|
|
.service(
|
|
|
|
web::scope("/app1")
|
|
|
|
.default_resource(|r| r.to(|| HttpResponse::BadRequest())),
|
|
|
|
)
|
|
|
|
.service(web::scope("/app2"))
|
|
|
|
.default_resource(|r| r.to(|| HttpResponse::MethodNotAllowed())),
|
|
|
|
);
|
2019-03-04 06:02:01 +01:00
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/non-exist").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app1/non-exist").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
|
|
|
|
|
|
|
|
let req = TestRequest::with_uri("/app2/non-exist").to_request();
|
2019-03-04 22:25:35 +01:00
|
|
|
let resp = block_on(srv.call(req)).unwrap();
|
2019-03-04 06:02:01 +01:00
|
|
|
assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
|
|
|
|
}
|
|
|
|
}
|