ntex 4.9.1

Framework for composable network services
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
use std::{fmt, mem, rc::Rc};

use crate::error::Failure;
use crate::http::Method;
use crate::service::{Ctx, Service, ServiceFactory};

use super::error::{WebError, WebResponseError};
use super::guard::{self, AllGuard, Guard};
use super::handler::{Handler, HandlerFn, HandlerSt, HandlerStWrapper, HandlerWrapper};
use super::{FromRequest, HttpResponse, State, WebRequest, WebResponse};

/// Connects a handler to the requests it should handle.
///
/// A route belongs to a [`Resource`](super::Resource). It does not define a
/// path itself; instead, its method and custom guards decide which requests
/// within that resource should reach its handler.
///
/// Routes are checked in registration order. A route matches when the request
/// method matches one of its configured methods and every custom guard accepts
/// the request. Without a method or custom guard, it matches any request that
/// reaches the resource.
///
/// If a route does not match, the resource tries the next one. When no route
/// matches, the resource fallback runs and returns `405 Method Not Allowed` by
/// default.
///
/// Use helpers such as [`web::get()`] and [`web::post()`] to create
/// method-specific routes, then attach a handler with [`Route::to()`] or
/// [`Route::to_with_state()`]. Handler arguments are populated through
/// [`FromRequest`], and the returned value is converted into a response through
/// [`Responder`](super::Responder).
///
/// A route without an explicitly configured handler returns `404 Not Found`
/// when called.
///
/// ```rust
/// use ntex::web::{self, App, HttpResponse};
///
/// App::default().service(
///     web::resource("/users/{id}")
///         .route(web::get().to(async || "user"))
///         .route(web::delete().to(async || HttpResponse::NoContent())),
/// );
/// ```
///
/// [`web::get()`]: super::get()
/// [`web::post()`]: super::post()
pub struct Route<St: State, In = ()> {
    handler: Rc<dyn HandlerFn<St, In>>,
    methods: Vec<Method>,
    guards: Rc<AllGuard>,
}

impl<St: State, In: 'static> Route<St, In> {
    /// Create new route which matches any request.
    pub fn new() -> Route<St, In> {
        Route {
            handler: HandlerWrapper::<St, In, _, ()>::create(async || HttpResponse::NotFound()),
            methods: Vec::new(),
            guards: Rc::default(),
        }
    }

    /// Moves the route's guards out for promotion to a resource.
    ///
    /// Custom guards stay conjunctive, while the configured methods are
    /// alternatives and become a single method guard.
    pub(super) fn take_guards(&mut self) -> Vec<Box<dyn Guard>> {
        let mut guards = mem::take(&mut Rc::get_mut(&mut self.guards).unwrap().0);
        match self.methods.as_slice() {
            [] => (),
            [method] => guards.push(Box::new(guard::Method(method.clone()))),
            methods => guards.push(Box::new(guard::AnyGuard(
                methods
                    .iter()
                    .map(|m| Box::new(guard::Method(m.clone())) as Box<dyn Guard>)
                    .collect(),
            ))),
        }
        guards
    }

    pub(super) fn service(&self) -> RouteService<St, In> {
        RouteService {
            handler: self.handler.clone(),
            guards: self.guards.clone(),
            methods: self.methods.clone(),
        }
    }
}

impl<St: State, In: 'static> Default for Route<St, In> {
    fn default() -> Self {
        Self::new()
    }
}

impl<St: State, In: 'static> ServiceFactory<St, WebRequest<In>> for Route<St, In> {
    type Res = WebResponse;
    type Error = WebError<St, St::Error>;

    type Service = RouteService<St, In>;
    type InitError = Failure;

    async fn create(&self, _: &St) -> Result<Self::Service, Self::InitError> {
        Ok(self.service())
    }
}

impl<St: State, In: 'static> Route<St, In> {
    /// Add method guard to the route.
    ///
    /// ```rust
    /// # use ntex::web::{self, *};
    /// # fn main() {
    /// App::default().service(web::resource("/path").route(
    ///     web::route()
    ///         .method(ntex::http::Method::CONNECT)
    ///         .guard(guard::Header("content-type", "text/plain"))
    ///         .to(async |req: HttpRequest| { HttpResponse::Ok() }))
    /// );
    /// # }
    /// ```
    #[must_use]
    pub fn method(mut self, method: Method) -> Self {
        self.methods.push(method);
        self
    }

    /// Add a match guard to this route.
    ///
    /// All guards registered on the route must accept the request. Guards are
    /// evaluated after the containing resource has matched. If a guard rejects
    /// the request, the resource tries its next route; if no route matches, the
    /// resource's default service is used.
    ///
    /// Method restrictions added by [`Route::method()`] are evaluated together
    /// with these guards.
    ///
    /// ```rust
    /// use ntex::web::{self, guard, App};
    ///
    /// App::default().service(
    ///     web::resource("/items")
    ///         .route(
    ///             web::get()
    ///                 .guard(guard::Header("accept", "application/json"))
    ///                 .to(async || "JSON items")
    ///         )
    ///         .route(web::get().to(async || "Default items"))
    /// );
    /// ```
    #[must_use]
    pub fn guard<F: Guard + 'static>(mut self, f: F) -> Self {
        Rc::get_mut(&mut self.guards).unwrap().add(f);
        self
    }

    /// Set the handler for this route.
    ///
    /// Handler arguments are populated through [`FromRequest`]. Each argument
    /// must implement [`FromRequest`] trait and are evaluated
    /// before the handler is called. If extraction fails, the error is
    /// converted into a response.
    ///
    /// The handler's return value must implement [`Responder`](super::Responder).
    /// Use [`Route::to_with_state()`] when the handler also needs a borrowed
    /// application state and the current request state.
    ///
    /// ```rust
    /// use std::collections::HashMap;
    /// use ntex::web;
    ///
    /// #[derive(serde::Deserialize)]
    /// struct UserPath {
    ///     user_id: u32,
    /// }
    ///
    /// async fn show_user(
    ///     path: web::types::Path<UserPath>,
    ///     query: web::types::Query<HashMap<String, String>>,
    /// ) -> String {
    ///     let format = query.get("format").map(String::as_str).unwrap_or("text");
    ///     format!("User {} as {format}", path.user_id)
    /// }
    ///
    /// web::App::default().service(
    ///     web::resource("/users/{user_id}")
    ///         .route(web::get().to(show_user))
    /// );
    /// ```
    #[must_use]
    pub fn to<H, Args>(mut self, handler: H) -> Self
    where
        H: Handler<St, Args> + 'static,
        Args: FromRequest<St> + 'static,
        Args::Error: WebResponseError<St, St::Error>,
    {
        self.handler = HandlerWrapper::create(handler);
        self
    }

    /// Set a state-aware handler for this route.
    ///
    /// The handler receives a shared reference to the application state,
    /// followed by the current request state and any request extractors.
    ///
    /// ```rust
    /// use ntex::web;
    ///
    /// struct AppState {
    ///     greeting: &'static str,
    /// }
    ///
    /// impl web::State for AppState {
    ///     type Error = web::DefaultError;
    /// }
    ///
    /// async fn index(
    ///     state: &AppState,
    ///     request_state: (),
    ///     name: web::types::Path<String>,
    /// ) -> String {
    ///     let _ = request_state;
    ///     format!("{}, {}!", state.greeting, name.into_inner())
    /// }
    ///
    /// web::App::<AppState>::new().service(
    ///     web::resource("/{name}").route(web::get().to_with_state(index))
    /// );
    /// ```
    #[must_use]
    pub fn to_with_state<H, Args>(mut self, handler: H) -> Self
    where
        H: HandlerSt<St, In, Args> + 'static,
        Args: FromRequest<St> + 'static,
        Args::Error: WebResponseError<St, St::Error>,
    {
        self.handler = HandlerStWrapper::create(handler);
        self
    }
}

impl<St: State, In> fmt::Debug for Route<St, In> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Route")
            .field("handler", &self.handler)
            .field("methods", &self.methods)
            .field("guards", &self.guards)
            .finish()
    }
}

pub struct RouteService<St: State, In> {
    handler: Rc<dyn HandlerFn<St, In>>,
    methods: Vec<Method>,
    guards: Rc<AllGuard>,
}

impl<St: State, In> RouteService<St, In> {
    pub fn check(&self, req: &mut WebRequest<In>) -> bool {
        if !self.methods.is_empty() && !self.methods.contains(&req.head().method) {
            return false;
        }

        self.guards.check(req.head())
    }

    /// Call the route handler directly, without service readiness.
    pub(super) fn handle<'a>(
        &'a self,
        st: &'a St,
        req: WebRequest<In>,
    ) -> impl Future<Output = WebResponse> + 'a {
        self.handler.call(st, req)
    }
}

impl<St: State, In> fmt::Debug for RouteService<St, In> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("RouteService")
            .field("handler", &self.handler)
            .field("methods", &self.methods)
            .field("guards", &self.guards)
            .finish()
    }
}

impl<St: State, In> Service<St, WebRequest<In>> for RouteService<St, In> {
    type Res = WebResponse;
    type Error = WebError<St, St::Error>;

    async fn call(
        &self,
        req: WebRequest<In>,
        ctx: Ctx<'_, Self, St>,
    ) -> Result<Self::Res, Self::Error> {
        Ok(self.handler.call(ctx.st(), req).await)
    }
}

/// Convert object to a vec of routes
pub trait IntoRoutes<St: State, In> {
    /// Convert into a list of routes.
    fn routes(self) -> Vec<Route<St, In>>;
}

impl<St: State, In> IntoRoutes<St, In> for Route<St, In> {
    fn routes(self) -> Vec<Route<St, In>> {
        vec![self]
    }
}

impl<St: State, In> IntoRoutes<St, In> for Vec<Route<St, In>> {
    fn routes(self) -> Vec<Route<St, In>> {
        self
    }
}

macro_rules! tuple_routes(
    {$(#[$meta:meta])* $(($n:tt, $T:ident)),+} => {
        $(#[$meta])*
        #[allow(unused_parens)]
        impl<St: State, U, $($T,)+> IntoRoutes<St, U> for ($($T,)+)
        where
            $($T: Into<Route<St, U>> + 'static,)+ {
            fn routes(self) -> Vec<Route<St, U>> {
                vec![$(self.$n.into(),)+]
            }
        }
    }
);

impl<St: State, In, T, const N: usize> IntoRoutes<St, In> for [T; N]
where
    T: Into<Route<St, In>>,
{
    fn routes(self) -> Vec<Route<St, In>> {
        let mut routes = Vec::with_capacity(N);
        for route in self {
            routes.push(route.into());
        }
        routes
    }
}

#[allow(clippy::wildcard_imports)]
#[rustfmt::skip]
mod m {
    use variadics_please::all_tuples_enumerated;

    use super::*;

    all_tuples_enumerated!(#[doc(fake_variadic)] tuple_routes, 1, 12, T);
}

#[cfg(test)]
mod tests {
    use crate::http::{Method, StatusCode, header};
    use crate::time::{Millis, sleep};
    use crate::web::test::{TestRequest, call_service, init_service, read_body};
    use crate::web::{self, App, HttpResponse, error, guard};
    use crate::{ServiceFactory, util::Bytes};

    #[derive(serde::Serialize, PartialEq, Debug)]
    struct MyObject {
        name: String,
    }

    /// STATEMENT: Routes dispatch by method and guards and render handler results or errors.
    ///
    /// HOW:
    /// - Register synchronous-result and delayed handlers, including a header-guarded PATCH route.
    /// - Exercise supported, guarded, and unsupported methods and assert their distinct statuses.
    /// - Check a JSON handler's exact body and inspect route/factory debug metadata and creation.
    #[crate::rt_test]
    async fn test_route() {
        let srv = init_service(
            App::new()
                .service(web::resource("/test").route(vec![
                        web::get().to(async || { HttpResponse::Ok() }),
                        web::put().to(async || {
                            Err::<HttpResponse, _>(
                                error::ErrorBadRequest::<_>("err"),
                            )
                        }),
                        web::post().to(async || {
                            sleep(Millis(100)).await;
                            HttpResponse::Created()
                        }),
                        web::patch()
                            .guard(guard::fn_guard(|req|
                                req.headers().contains_key("content-type")
                            ))
                            .to(async || { HttpResponse::Conflict() }),
                        web::delete().to(async || {
                            sleep(Millis(100)).await;
                            Err::<HttpResponse, _>(error::ErrorBadRequest("err"))
                        }),
                    ]))
                .service(web::resource("/json").route(web::get().to(async || {
                    sleep(Millis(25)).await;
                    web::types::Json(MyObject {
                        name: "test".to_string(),
                    })
                }))),
        )
        .await;

        let req = TestRequest::with_uri("/test")
            .method(Method::GET)
            .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::CREATED);

        let req = TestRequest::with_uri("/test")
            .method(Method::PUT)
            .to_request();
        let resp = call_service(&srv, req).await;
        assert_eq!(resp.status(), StatusCode::BAD_REQUEST);

        let req = TestRequest::with_uri("/test")
            .method(Method::PATCH)
            .to_request();
        let resp = call_service(&srv, req).await;
        assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);

        let req = TestRequest::with_uri("/test")
            .method(Method::PATCH)
            .header(header::CONTENT_TYPE, "text/plain")
            .to_request();
        let resp = call_service(&srv, req).await;
        assert_eq!(resp.status(), StatusCode::CONFLICT);

        let req = TestRequest::with_uri("/test")
            .method(Method::DELETE)
            .to_request();
        let resp = call_service(&srv, req).await;
        assert_eq!(resp.status(), StatusCode::BAD_REQUEST);

        let req = TestRequest::with_uri("/test")
            .method(Method::HEAD)
            .to_request();
        let resp = call_service(&srv, req).await;
        assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);

        let req = TestRequest::with_uri("/json").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"{\"name\":\"test\"}"));

        let route: web::Route<(), ()> = web::get();
        let repr = format!("{route:?}");
        assert!(repr.contains("Route"), "{}", repr);
        assert!(
            repr.contains(
                "handler: HandlerNoState(\"ntex::web::route::Route<()>::new::{{closure}}\")"
            ),
            "{}",
            repr
        );
        assert!(repr.contains("methods: [GET]"), "{}", repr);
        assert!(repr.contains("guards: AllGuard()"), "{}", repr);

        assert!(route.create(&()).await.is_ok());

        let route_service = route.service();
        let repr = format!("{route_service:?}");
        assert!(repr.contains("RouteService"));
        assert!(repr.contains(
            "handler: HandlerNoState(\"ntex::web::route::Route<()>::new::{{closure}}\")"
        ));
        assert!(repr.contains("methods: [GET]"));
        assert!(repr.contains("guards: AllGuard()"));
    }

    /// STATEMENT: Route arrays select handlers independently of another route's extractor failures.
    ///
    /// HOW:
    /// - Register GET with a numeric `Path` extractor and POST without that extractor.
    /// - Assert numeric GET returns its value, invalid GET returns 404, and invalid-path POST returns 201.
    #[crate::rt_test]
    async fn test_route_array_and_extractor_error() {
        let srv = init_service(App::new().service(web::resource("/test/{id}").route([
            web::get().to(async |p: web::types::Path<u32>| {
                HttpResponse::Ok().body(format!("{}", p.into_inner()))
            }),
            web::post().to(async || HttpResponse::Created()),
        ])))
        .await;

        let req = TestRequest::with_uri("/test/10").to_request();
        let resp = call_service(&srv, req).await;
        assert_eq!(resp.status(), StatusCode::OK);
        assert_eq!(read_body(resp).await, Bytes::from_static(b"10"));

        let req = TestRequest::with_uri("/test/abc").to_request();
        let resp = call_service(&srv, req).await;
        assert_eq!(resp.status(), StatusCode::NOT_FOUND);

        let req = TestRequest::with_uri("/test/abc")
            .method(Method::POST)
            .to_request();
        let resp = call_service(&srv, req).await;
        assert_eq!(resp.status(), StatusCode::CREATED);
    }

    /// STATEMENT: Route debug output distinguishes stateless and state-aware handlers.
    ///
    /// HOW:
    /// - Build routes with `to` and `to_with_state` and format them.
    /// - Assert their debug output identifies `HandlerNoState` and `HandlerSt`, respectively.
    #[test]
    fn test_route_debug() {
        let route: web::Route<(), ()> = web::get().to(async || HttpResponse::Ok());
        let s = format!("{route:?}");
        assert!(s.contains("HandlerNoState"), "{s}");

        let route =
            web::Route::<(), ()>::new().to_with_state(async |(): &(), (): ()| HttpResponse::Ok());
        let s = format!("{route:?}");
        assert!(s.contains("HandlerSt("), "{s}");
    }

    /// STATEMENT: Path-based route helpers keep a route's methods as alternatives and its custom guards as requirements.
    ///
    /// HOW:
    /// - Register a GET-or-POST route requiring an `x-ok` header through `App::route`, continued `AppServices::route`, `Scope::route`, continued `ScopeServices::route`, and `ServiceConfig::route`.
    /// - For every path, assert GET and POST with the header reach the handler, while PUT and GET without the header return `404 Not Found`.
    /// - Register a PUT route on the `App::route` path and assert PUT falls through to that separate resource.
    #[crate::rt_test]
    async fn test_route_helpers_promote_method_alternatives() {
        fn multi() -> web::Route<()> {
            web::route()
                .method(Method::GET)
                .method(Method::POST)
                .guard(guard::Header("x-ok", "1"))
                .to(async || HttpResponse::Ok())
        }

        let srv = init_service(
            App::new()
                .route("/a", multi())
                .route("/b", multi())
                .route("/a", web::put().to(async || HttpResponse::Created()))
                .service(web::scope("/s").route("/a", multi()).route("/b", multi()))
                .service(web::scope("/c").configure(|cfg| {
                    cfg.route("/a", multi());
                })),
        )
        .await;

        for path in ["/a", "/b", "/s/a", "/s/b", "/c/a"] {
            let call = async |method: Method, header: bool| {
                let mut req = TestRequest::with_uri(path).method(method);
                if header {
                    req = req.header("x-ok", "1");
                }
                call_service(&srv, req.to_request()).await.status()
            };
            assert_eq!(call(Method::GET, true).await, StatusCode::OK, "{path}");
            assert_eq!(call(Method::POST, true).await, StatusCode::OK, "{path}");
            assert_eq!(
                call(Method::GET, false).await,
                StatusCode::NOT_FOUND,
                "{path}"
            );
            let put = if path == "/a" {
                StatusCode::CREATED
            } else {
                StatusCode::NOT_FOUND
            };
            assert_eq!(call(Method::PUT, true).await, put, "{path}");
        }
    }
}