1use std::{cell::RefCell, fmt, future::Future, rc::Rc};
2
3use actix_http::Extensions;
4use actix_router::{IntoPatterns, Patterns};
5use actix_service::{
6 apply, apply_fn_factory, boxed, fn_service, IntoServiceFactory, Service, ServiceFactory,
7 ServiceFactoryExt, Transform,
8};
9use futures_core::future::LocalBoxFuture;
10use futures_util::future::join_all;
11
12use crate::{
13 body::MessageBody,
14 data::Data,
15 dev::{ensure_leading_slash, AppService, ResourceDef},
16 guard::{self, Guard},
17 handler::Handler,
18 http::header,
19 route::{Route, RouteService},
20 service::{
21 BoxedHttpService, BoxedHttpServiceFactory, HttpServiceFactory, ServiceRequest,
22 ServiceResponse,
23 },
24 web, Error, FromRequest, HttpResponse, Responder,
25};
26
27pub struct Resource<T = ResourceEndpoint> {
52 endpoint: T,
53 rdef: Patterns,
54 name: Option<String>,
55 routes: Vec<Route>,
56 app_data: Option<Extensions>,
57 guards: Vec<Box<dyn Guard>>,
58 default: BoxedHttpServiceFactory,
59 factory_ref: Rc<RefCell<Option<ResourceFactory>>>,
60}
61
62impl Resource {
63 pub fn new<T: IntoPatterns>(path: T) -> Resource {
65 let factory_ref = Rc::new(RefCell::new(None));
66
67 Resource {
68 routes: Vec::new(),
69 rdef: path.patterns(),
70 name: None,
71 endpoint: ResourceEndpoint::new(Rc::clone(&factory_ref)),
72 factory_ref,
73 guards: Vec::new(),
74 app_data: None,
75 default: boxed::factory(fn_service(|req: ServiceRequest| async {
76 use crate::HttpMessage as _;
77
78 let allowed = req.extensions().get::<guard::RegisteredMethods>().cloned();
79
80 if let Some(methods) = allowed {
81 Ok(req.into_response(
82 HttpResponse::MethodNotAllowed()
83 .insert_header(header::Allow(methods.0))
84 .finish(),
85 ))
86 } else {
87 Ok(req.into_response(HttpResponse::MethodNotAllowed()))
88 }
89 })),
90 }
91 }
92}
93
94impl<T> Resource<T>
95where
96 T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>,
97{
98 pub fn name(mut self, name: &str) -> Self {
102 self.name = Some(name.to_string());
103 self
104 }
105
106 pub fn guard<G: Guard + 'static>(mut self, guard: G) -> Self {
128 self.guards.push(Box::new(guard));
129 self
130 }
131
132 pub(crate) fn add_guards(mut self, guards: Vec<Box<dyn Guard>>) -> Self {
133 self.guards.extend(guards);
134 self
135 }
136
137 pub fn route(mut self, route: Route) -> Self {
169 self.routes.push(route);
170 self
171 }
172
173 #[doc(alias = "manage")]
206 pub fn app_data<U: 'static>(mut self, data: U) -> Self {
207 self.app_data
208 .get_or_insert_with(Extensions::new)
209 .insert(data);
210
211 self
212 }
213
214 #[deprecated(since = "4.0.0", note = "Use `.app_data(Data::new(val))` instead.")]
218 pub fn data<U: 'static>(self, data: U) -> Self {
219 self.app_data(Data::new(data))
220 }
221
222 pub fn to<F, Args>(mut self, handler: F) -> Self
242 where
243 F: Handler<Args>,
244 Args: FromRequest + 'static,
245 F::Output: Responder + 'static,
246 {
247 self.routes.push(Route::new().to(handler));
248 self
249 }
250
251 #[doc(alias = "middleware")]
258 #[doc(alias = "use")] pub fn wrap<M, B>(
260 self,
261 mw: M,
262 ) -> Resource<
263 impl ServiceFactory<
264 ServiceRequest,
265 Config = (),
266 Response = ServiceResponse<B>,
267 Error = Error,
268 InitError = (),
269 >,
270 >
271 where
272 M: Transform<
273 T::Service,
274 ServiceRequest,
275 Response = ServiceResponse<B>,
276 Error = Error,
277 InitError = (),
278 > + 'static,
279 B: MessageBody,
280 {
281 Resource {
282 endpoint: apply(mw, self.endpoint),
283 rdef: self.rdef,
284 name: self.name,
285 guards: self.guards,
286 routes: self.routes,
287 default: self.default,
288 app_data: self.app_data,
289 factory_ref: self.factory_ref,
290 }
291 }
292
293 #[doc(alias = "middleware")]
301 #[doc(alias = "use")] pub fn wrap_fn<F, R, B>(
303 self,
304 mw: F,
305 ) -> Resource<
306 impl ServiceFactory<
307 ServiceRequest,
308 Config = (),
309 Response = ServiceResponse<B>,
310 Error = Error,
311 InitError = (),
312 >,
313 >
314 where
315 F: Fn(ServiceRequest, &T::Service) -> R + Clone + 'static,
316 R: Future<Output = Result<ServiceResponse<B>, Error>>,
317 B: MessageBody,
318 {
319 Resource {
320 endpoint: apply_fn_factory(self.endpoint, mw),
321 rdef: self.rdef,
322 name: self.name,
323 guards: self.guards,
324 routes: self.routes,
325 default: self.default,
326 app_data: self.app_data,
327 factory_ref: self.factory_ref,
328 }
329 }
330
331 pub fn default_service<F, U>(mut self, f: F) -> Self
354 where
355 F: IntoServiceFactory<U, ServiceRequest>,
356 U: ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse, Error = Error>
357 + 'static,
358 U::InitError: fmt::Debug,
359 {
360 self.default = boxed::factory(f.into_factory().map_init_err(|err| {
362 log::error!("Can not construct default service: {err:?}");
363 }));
364
365 self
366 }
367}
368
369macro_rules! route_shortcut {
370 ($method_fn:ident, $method_upper:literal) => {
371 #[doc = concat!(" Adds a ", $method_upper, " route.")]
372 #[doc = concat!(" .", stringify!($method_fn), "(|| async { \"Hello World!\" })")]
381 pub fn $method_fn<F, Args>(self, handler: F) -> Self
384 where
385 F: Handler<Args>,
386 Args: FromRequest + 'static,
387 F::Output: Responder + 'static,
388 {
389 self.route(web::$method_fn().to(handler))
390 }
391 };
392}
393
394impl<T> Resource<T>
396where
397 T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>,
398{
399 route_shortcut!(get, "GET");
400 route_shortcut!(post, "POST");
401 route_shortcut!(put, "PUT");
402 route_shortcut!(patch, "PATCH");
403 route_shortcut!(delete, "DELETE");
404 route_shortcut!(query, "QUERY");
405 route_shortcut!(head, "HEAD");
406 route_shortcut!(trace, "TRACE");
407}
408
409impl<T, B> HttpServiceFactory for Resource<T>
410where
411 T: ServiceFactory<
412 ServiceRequest,
413 Config = (),
414 Response = ServiceResponse<B>,
415 Error = Error,
416 InitError = (),
417 > + 'static,
418 B: MessageBody + 'static,
419{
420 fn register(mut self, config: &mut AppService) {
421 let routes = std::mem::take(&mut self.routes);
422
423 let guards = if self.guards.is_empty() {
424 None
425 } else {
426 Some(std::mem::take(&mut self.guards))
427 };
428
429 let mut rdef = if config.is_root() || !self.rdef.is_empty() {
430 ResourceDef::new(ensure_leading_slash(self.rdef.clone()))
431 } else {
432 ResourceDef::new(self.rdef.clone())
433 };
434 #[cfg(feature = "experimental-introspection")]
435 {
436 use crate::http::Method;
437
438 let full_paths = crate::introspection::expand_patterns(&config.current_prefix, &rdef);
439 let patterns = rdef
440 .pattern_iter()
441 .map(|pattern| pattern.to_string())
442 .collect::<Vec<_>>();
443 let guards_routes = routes.iter().map(|r| r.guards()).collect::<Vec<_>>();
444 let scope_id = config.scope_id_stack.last().copied();
445 let resource_guards: &[Box<dyn Guard>] = guards.as_deref().unwrap_or(&[]);
446 let resource_name = self.name.clone();
447
448 for route_guards in guards_routes {
449 let mut guard_names = Vec::new();
451 let mut methods = Vec::new();
452
453 for guard in resource_guards.iter().chain(route_guards.iter()) {
454 guard_names.push(guard.name());
455 methods.extend(
456 guard
457 .details()
458 .unwrap_or_default()
459 .into_iter()
460 .flat_map(|d| {
461 if let crate::guard::GuardDetail::HttpMethods(v) = d {
462 v.into_iter()
463 .filter_map(|s| s.parse::<Method>().ok())
464 .collect::<Vec<_>>()
465 } else {
466 Vec::new()
467 }
468 }),
469 );
470 }
471
472 let guard_details = crate::introspection::guard_reports_from_iter(
473 resource_guards.iter().chain(route_guards.iter()),
474 );
475
476 for full_path in &full_paths {
477 let info = crate::introspection::RouteInfo::new(
478 full_path.clone(),
479 methods.clone(),
480 guard_names.clone(),
481 guard_details.clone(),
482 patterns.clone(),
483 resource_name.clone(),
484 );
485 config
486 .introspector
487 .borrow_mut()
488 .register_route(info, scope_id);
489 }
490 }
491 }
492
493 if let Some(ref name) = self.name {
494 rdef.set_name(name);
495 }
496
497 *self.factory_ref.borrow_mut() = Some(ResourceFactory {
498 routes,
499 default: self.default,
500 });
501
502 let resource_data = self.app_data.map(Rc::new);
503
504 let endpoint = apply_fn_factory(self.endpoint, move |mut req: ServiceRequest, srv| {
506 if let Some(ref data) = resource_data {
507 req.add_data_container(Rc::clone(data));
508 }
509
510 let fut = srv.call(req);
511
512 async { Ok(fut.await?.map_into_boxed_body()) }
513 });
514
515 config.register_service(rdef, guards, endpoint, None)
516 }
517}
518
519pub struct ResourceFactory {
520 routes: Vec<Route>,
521 default: BoxedHttpServiceFactory,
522}
523
524impl ServiceFactory<ServiceRequest> for ResourceFactory {
525 type Response = ServiceResponse;
526 type Error = Error;
527 type Config = ();
528 type Service = ResourceService;
529 type InitError = ();
530 type Future = LocalBoxFuture<'static, Result<Self::Service, Self::InitError>>;
531
532 fn new_service(&self, _: ()) -> Self::Future {
533 let default_fut = self.default.new_service(());
535
536 let factory_fut = join_all(self.routes.iter().map(|route| route.new_service(())));
538
539 Box::pin(async move {
540 let default = default_fut.await?;
541 let routes = factory_fut
542 .await
543 .into_iter()
544 .collect::<Result<Vec<_>, _>>()?;
545
546 Ok(ResourceService { routes, default })
547 })
548 }
549}
550
551pub struct ResourceService {
552 routes: Vec<RouteService>,
553 default: BoxedHttpService,
554}
555
556impl Service<ServiceRequest> for ResourceService {
557 type Response = ServiceResponse;
558 type Error = Error;
559 type Future = LocalBoxFuture<'static, Result<Self::Response, Self::Error>>;
560
561 actix_service::always_ready!();
562
563 fn call(&self, mut req: ServiceRequest) -> Self::Future {
564 for route in &self.routes {
565 if route.check(&mut req) {
566 return route.call(req);
567 }
568 }
569
570 self.default.call(req)
571 }
572}
573
574#[doc(hidden)]
575pub struct ResourceEndpoint {
576 factory: Rc<RefCell<Option<ResourceFactory>>>,
577}
578
579impl ResourceEndpoint {
580 fn new(factory: Rc<RefCell<Option<ResourceFactory>>>) -> Self {
581 ResourceEndpoint { factory }
582 }
583}
584
585impl ServiceFactory<ServiceRequest> for ResourceEndpoint {
586 type Response = ServiceResponse;
587 type Error = Error;
588 type Config = ();
589 type Service = ResourceService;
590 type InitError = ();
591 type Future = LocalBoxFuture<'static, Result<Self::Service, Self::InitError>>;
592
593 fn new_service(&self, _: ()) -> Self::Future {
594 self.factory.borrow().as_ref().unwrap().new_service(())
595 }
596}
597
598#[cfg(test)]
599mod tests {
600 use std::{future::ready, time::Duration};
601
602 use tokio::time::sleep;
603
604 use super::*;
605 use crate::{
606 http::{header::HeaderValue, Method, StatusCode},
607 middleware::DefaultHeaders,
608 test::{call_service, init_service, TestRequest},
609 App, HttpMessage,
610 };
611
612 #[test]
613 fn can_be_returned_from_fn() {
614 fn my_resource_1() -> Resource {
615 web::resource("/test1").route(web::get().to(|| async { "hello" }))
616 }
617
618 fn my_resource_2() -> Resource<
619 impl ServiceFactory<
620 ServiceRequest,
621 Config = (),
622 Response = ServiceResponse<impl MessageBody>,
623 Error = Error,
624 InitError = (),
625 >,
626 > {
627 web::resource("/test2")
628 .wrap_fn(|req, srv| {
629 let fut = srv.call(req);
630 async { Ok(fut.await?.map_into_right_body::<()>()) }
631 })
632 .route(web::get().to(|| async { "hello" }))
633 }
634
635 fn my_resource_3() -> impl HttpServiceFactory {
636 web::resource("/test3").route(web::get().to(|| async { "hello" }))
637 }
638
639 App::new()
640 .service(my_resource_1())
641 .service(my_resource_2())
642 .service(my_resource_3());
643 }
644
645 #[actix_rt::test]
646 async fn test_middleware() {
647 let srv = init_service(
648 App::new().service(
649 web::resource("/test")
650 .name("test")
651 .wrap(
652 DefaultHeaders::new()
653 .add((header::CONTENT_TYPE, HeaderValue::from_static("0001"))),
654 )
655 .route(web::get().to(HttpResponse::Ok)),
656 ),
657 )
658 .await;
659 let req = TestRequest::with_uri("/test").to_request();
660 let resp = call_service(&srv, req).await;
661 assert_eq!(resp.status(), StatusCode::OK);
662 assert_eq!(
663 resp.headers().get(header::CONTENT_TYPE).unwrap(),
664 HeaderValue::from_static("0001")
665 );
666 }
667
668 #[actix_rt::test]
669 async fn test_middleware_fn() {
670 let srv = init_service(
671 App::new().service(
672 web::resource("/test")
673 .wrap_fn(|req, srv| {
674 let fut = srv.call(req);
675 async {
676 fut.await.map(|mut res| {
677 res.headers_mut()
678 .insert(header::CONTENT_TYPE, HeaderValue::from_static("0001"));
679 res
680 })
681 }
682 })
683 .route(web::get().to(HttpResponse::Ok)),
684 ),
685 )
686 .await;
687 let req = TestRequest::with_uri("/test").to_request();
688 let resp = call_service(&srv, req).await;
689 assert_eq!(resp.status(), StatusCode::OK);
690 assert_eq!(
691 resp.headers().get(header::CONTENT_TYPE).unwrap(),
692 HeaderValue::from_static("0001")
693 );
694 }
695
696 #[actix_rt::test]
697 async fn test_to() {
698 let srv = init_service(App::new().service(web::resource("/test").to(|| async {
699 sleep(Duration::from_millis(100)).await;
700 Ok::<_, Error>(HttpResponse::Ok())
701 })))
702 .await;
703 let req = TestRequest::with_uri("/test").to_request();
704 let resp = call_service(&srv, req).await;
705 assert_eq!(resp.status(), StatusCode::OK);
706 }
707
708 #[actix_rt::test]
709 async fn test_pattern() {
710 let srv = init_service(App::new().service(
711 web::resource(["/test", "/test2"]).to(|| async { Ok::<_, Error>(HttpResponse::Ok()) }),
712 ))
713 .await;
714 let req = TestRequest::with_uri("/test").to_request();
715 let resp = call_service(&srv, req).await;
716 assert_eq!(resp.status(), StatusCode::OK);
717 let req = TestRequest::with_uri("/test2").to_request();
718 let resp = call_service(&srv, req).await;
719 assert_eq!(resp.status(), StatusCode::OK);
720 }
721
722 #[actix_rt::test]
723 async fn test_default_resource() {
724 let srv = init_service(
725 App::new()
726 .service(
727 web::resource("/test")
728 .route(web::get().to(HttpResponse::Ok))
729 .route(web::delete().to(HttpResponse::Ok)),
730 )
731 .default_service(|r: ServiceRequest| {
732 ready(Ok(r.into_response(HttpResponse::BadRequest())))
733 }),
734 )
735 .await;
736 let req = TestRequest::with_uri("/test").to_request();
737 let resp = call_service(&srv, req).await;
738 assert_eq!(resp.status(), StatusCode::OK);
739
740 let req = TestRequest::with_uri("/test")
741 .method(Method::POST)
742 .to_request();
743 let resp = call_service(&srv, req).await;
744 assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
745 assert_eq!(
746 resp.headers().get(header::ALLOW).unwrap().as_bytes(),
747 b"GET, DELETE"
748 );
749
750 let srv = init_service(
751 App::new().service(
752 web::resource("/test")
753 .route(web::get().to(HttpResponse::Ok))
754 .default_service(|r: ServiceRequest| {
755 ready(Ok(r.into_response(HttpResponse::BadRequest())))
756 }),
757 ),
758 )
759 .await;
760
761 let req = TestRequest::with_uri("/test").to_request();
762 let resp = call_service(&srv, req).await;
763 assert_eq!(resp.status(), StatusCode::OK);
764
765 let req = TestRequest::with_uri("/test")
766 .method(Method::POST)
767 .to_request();
768 let resp = call_service(&srv, req).await;
769 assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
770 }
771
772 #[actix_rt::test]
773 async fn test_resource_guards() {
774 let srv = init_service(
775 App::new()
776 .service(
777 web::resource("/test/{p}")
778 .guard(guard::Get())
779 .to(HttpResponse::Ok),
780 )
781 .service(
782 web::resource("/test/{p}")
783 .guard(guard::Put())
784 .to(HttpResponse::Created),
785 )
786 .service(
787 web::resource("/test/{p}")
788 .guard(guard::Delete())
789 .to(HttpResponse::NoContent),
790 ),
791 )
792 .await;
793
794 let req = TestRequest::with_uri("/test/it")
795 .method(Method::GET)
796 .to_request();
797 let resp = call_service(&srv, req).await;
798 assert_eq!(resp.status(), StatusCode::OK);
799
800 let req = TestRequest::with_uri("/test/it")
801 .method(Method::PUT)
802 .to_request();
803 let resp = call_service(&srv, req).await;
804 assert_eq!(resp.status(), StatusCode::CREATED);
805
806 let req = TestRequest::with_uri("/test/it")
807 .method(Method::DELETE)
808 .to_request();
809 let resp = call_service(&srv, req).await;
810 assert_eq!(resp.status(), StatusCode::NO_CONTENT);
811 }
812
813 #[actix_rt::test]
814 async fn test_query_method() {
815 let srv = init_service(
816 App::new().service(web::resource("/test").route(web::query().to(HttpResponse::Ok))),
817 )
818 .await;
819
820 let req = TestRequest::with_uri("/test")
822 .method(Method::from_bytes(b"QUERY").unwrap())
823 .to_request();
824 let resp = call_service(&srv, req).await;
825 assert_eq!(resp.status(), StatusCode::OK);
826
827 let req = TestRequest::with_uri("/test")
829 .method(Method::GET)
830 .to_request();
831 let resp = call_service(&srv, req).await;
832 assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);
833 assert_eq!(
834 resp.headers().get(header::ALLOW).unwrap().as_bytes(),
835 b"QUERY"
836 );
837 }
838
839 #[allow(deprecated)]
841 #[actix_rt::test]
842 async fn test_data() {
843 let srv = init_service(
844 App::new()
845 .data(1.0f64)
846 .data(1usize)
847 .app_data(web::Data::new('-'))
848 .service(
849 web::resource("/test")
850 .data(10usize)
851 .app_data(web::Data::new('*'))
852 .guard(guard::Get())
853 .to(
854 |data1: web::Data<usize>,
855 data2: web::Data<char>,
856 data3: web::Data<f64>| {
857 assert_eq!(**data1, 10);
858 assert_eq!(**data2, '*');
859 let error = f64::EPSILON;
860 assert!((**data3 - 1.0).abs() < error);
861 HttpResponse::Ok()
862 },
863 ),
864 ),
865 )
866 .await;
867
868 let req = TestRequest::get().uri("/test").to_request();
869 let resp = call_service(&srv, req).await;
870 assert_eq!(resp.status(), StatusCode::OK);
871 }
872
873 #[allow(deprecated)]
875 #[actix_rt::test]
876 async fn test_data_default_service() {
877 let srv =
878 init_service(
879 App::new().data(1usize).service(
880 web::resource("/test")
881 .data(10usize)
882 .default_service(web::to(|data: web::Data<usize>| {
883 assert_eq!(**data, 10);
884 HttpResponse::Ok()
885 })),
886 ),
887 )
888 .await;
889
890 let req = TestRequest::get().uri("/test").to_request();
891 let resp = call_service(&srv, req).await;
892 assert_eq!(resp.status(), StatusCode::OK);
893 }
894
895 #[actix_rt::test]
896 async fn test_middleware_app_data() {
897 let srv = init_service(
898 App::new().service(
899 web::resource("test")
900 .app_data(1usize)
901 .wrap_fn(|req, srv| {
902 assert_eq!(req.app_data::<usize>(), Some(&1usize));
903 req.extensions_mut().insert(1usize);
904 srv.call(req)
905 })
906 .route(web::get().to(HttpResponse::Ok))
907 .default_service(|req: ServiceRequest| async move {
908 let (req, _) = req.into_parts();
909
910 assert_eq!(req.extensions().get::<usize>(), Some(&1));
911
912 Ok(ServiceResponse::new(
913 req,
914 HttpResponse::BadRequest().finish(),
915 ))
916 }),
917 ),
918 )
919 .await;
920
921 let req = TestRequest::get().uri("/test").to_request();
922 let resp = call_service(&srv, req).await;
923 assert_eq!(resp.status(), StatusCode::OK);
924
925 let req = TestRequest::post().uri("/test").to_request();
926 let resp = call_service(&srv, req).await;
927 assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
928 }
929
930 #[actix_rt::test]
931 async fn test_middleware_body_type() {
932 let srv = init_service(
933 App::new().service(
934 web::resource("/test")
935 .wrap_fn(|req, srv| {
936 let fut = srv.call(req);
937 async { Ok(fut.await?.map_into_right_body::<()>()) }
938 })
939 .route(web::get().to(|| async { "hello" })),
940 ),
941 )
942 .await;
943
944 use actix_http::body::MessageBody as _;
946 let req = TestRequest::with_uri("/test").to_request();
947 let resp = call_service(&srv, req).await;
948 let body = resp.into_body();
949 assert_eq!(body.try_into_bytes().unwrap(), b"hello".as_ref());
950 }
951}