Add type safe state extractor

axum-core/CHANGELOG.md

@@ -7,7 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 # Unreleased
 
-- None.
+- **breaking:** `FromRequest` and `RequestParts` has a new `S` type param which
+  represents the state ([#1155])
+
+[#1155]: https://github.com/tokio-rs/axum/pull/1155
 
 # 0.2.6 (18. June, 2022)
 

axum-extra/CHANGELOG.md

@@ -25,9 +25,13 @@ and this project adheres to [Semantic Versioning].
 - **added:** `WithRejection` extractor for customizing other extractors' rejections ([#1262])
 - **added:** Add sync constructors to `CookieJar`, `PrivateCookieJar`, and
   `SignedCookieJar` so they're easier to use in custom middleware
+- **breaking:** `Resource` has a new `S` type param which represents the state ([#1155])
+- **breaking:** `RouterExt::route_with_tsr` now only accepts `MethodRouter`s ([#1155])
+- **added:** `RouterExt::route_service_with_tsr` for routing to any `Service` ([#1155])
 
 [#1086]: https://github.com/tokio-rs/axum/pull/1086
 [#1119]: https://github.com/tokio-rs/axum/pull/1119
+[#1155]: https://github.com/tokio-rs/axum/pull/1155
 [#1170]: https://github.com/tokio-rs/axum/pull/1170
 [#1214]: https://github.com/tokio-rs/axum/pull/1214
 [#1239]: https://github.com/tokio-rs/axum/pull/1239

axum-extra/src/either.rs

@@ -190,15 +190,16 @@ macro_rules! impl_traits_for_either {
         $last:ident $(,)?
     ) => {
         #[async_trait]
-        impl<B, $($ident),*, $last> FromRequest<B> for $either<$($ident),*, $last>
+        impl<B, S, $($ident),*, $last> FromRequest<B, S> for $either<$($ident),*, $last>
         where
-            $($ident: FromRequest<B>),*,
-            $last: FromRequest<B>,
+            $($ident: FromRequest<B, S>),*,
+            $last: FromRequest<B, S>,
             B: Send,
+            S: Send,
         {
             type Rejection = $last::Rejection;
 
-            async fn from_request(req: &mut RequestParts<B>) -> Result<Self, Self::Rejection> {
+            async fn from_request(req: &mut RequestParts<B, S>) -> Result<Self, Self::Rejection> {
                 $(
                     if let Ok(value) = req.extract().await {
                         return Ok(Self::$ident(value));

axum-extra/src/extract/cached.rs

@@ -155,7 +155,7 @@ mod tests {
             }
         }
 
-        let mut req = RequestParts::with_state(Request::new(()), ());
+        let mut req = RequestParts::new(Request::new(()));
 
         let first = Cached::<Extractor>::from_request(&mut req).await.unwrap().0;
         assert_eq!(COUNTER.load(Ordering::SeqCst), 1);

axum-extra/src/extract/with_rejection.rs

@@ -107,15 +107,16 @@ impl<E, R> DerefMut for WithRejection<E, R> {
 }
 
 #[async_trait]
-impl<B, E, R> FromRequest<B> for WithRejection<E, R>
+impl<B, E, R, S> FromRequest<B, S> for WithRejection<E, R>
 where
     B: Send,
-    E: FromRequest<B>,
+    S: Send,
+    E: FromRequest<B, S>,
     R: From<E::Rejection> + IntoResponse,
 {
     type Rejection = R;
 
-    async fn from_request(req: &mut RequestParts<B>) -> Result<Self, Self::Rejection> {
+    async fn from_request(req: &mut RequestParts<B, S>) -> Result<Self, Self::Rejection> {
         let extractor = req.extract::<E>().await?;
         Ok(WithRejection(extractor, PhantomData))
     }
@@ -134,10 +135,14 @@ mod tests {
         struct TestRejection;
 
         #[async_trait]
-        impl<B: Send> FromRequest<B> for TestExtractor {
+        impl<B, S> FromRequest<B, S> for TestExtractor
+        where
+            B: Send,
+            S: Send,
+        {
             type Rejection = ();
 
-            async fn from_request(_: &mut RequestParts<B>) -> Result<Self, Self::Rejection> {
+            async fn from_request(_: &mut RequestParts<B, S>) -> Result<Self, Self::Rejection> {
                 Err(())
             }
         }

axum-extra/src/lib.rs

@@ -76,47 +76,6 @@ pub mod json_lines;
 #[cfg(feature = "protobuf")]
 pub mod protobuf;
 
-/// Combines two extractors or responses into a single type.
-#[derive(Debug, Copy, Clone)]
-pub enum Either<L, R> {
-    /// A value of type L.
-    Left(L),
-    /// A value of type R.
-    Right(R),
-}
-
-#[async_trait]
-impl<L, R, B, S> FromRequest<B, S> for Either<L, R>
-where
-    L: FromRequest<B, S>,
-    R: FromRequest<B, S>,
-    B: Send,
-    S: Send,
-{
-    type Rejection = R::Rejection;
-
-    async fn from_request(req: &mut RequestParts<B, S>) -> Result<Self, Self::Rejection> {
-        if let Ok(l) = req.extract().await {
-            return Ok(Either::Left(l));
-        }
-
-        Ok(Either::Right(req.extract().await?))
-    }
-}
-
-impl<L, R> IntoResponse for Either<L, R>
-where
-    L: IntoResponse,
-    R: IntoResponse,
-{
-    fn into_response(self) -> axum::response::Response {
-        match self {
-            Self::Left(inner) => inner.into_response(),
-            Self::Right(inner) => inner.into_response(),
-        }
-    }
-}
-
 #[cfg(feature = "typed-routing")]
 #[doc(hidden)]
 pub mod __private {

axum-extra/src/routing/mod.rs

@@ -2,11 +2,13 @@
 
 use axum::{
     handler::Handler,
-    response::Redirect,
+    http::Request,
+    response::{IntoResponse, Redirect},
     routing::{any, MethodRouter},
     Router,
 };
-use std::future::ready;
+use std::{convert::Infallible, future::ready};
+use tower_service::Service;
 
 mod resource;
 
@@ -161,6 +163,16 @@ pub trait RouterExt<S, B>: sealed::Sealed {
     fn route_with_tsr(self, path: &str, method_router: MethodRouter<S, B>) -> Self
     where
         Self: Sized;
+
+    /// Add another route to the router with an additional "trailing slash redirect" route.
+    ///
+    /// This works like [`RouterExt::route_with_tsr`] but accepts any [`Service`].
+    fn route_service_with_tsr<T>(self, path: &str, service: T) -> Self
+    where
+        T: Service<Request<B>, Error = Infallible> + Clone + Send + 'static,
+        T::Response: IntoResponse,
+        T::Future: Send + 'static,
+        Self: Sized;
 }
 
 impl<S, B> RouterExt<S, B> for Router<S, B>
@@ -265,6 +277,27 @@ where
             self.route(&format!("{}/", path), any(move || ready(redirect.clone())))
         }
     }
+
+    fn route_service_with_tsr<T>(mut self, path: &str, service: T) -> Self
+    where
+        T: Service<Request<B>, Error = Infallible> + Clone + Send + 'static,
+        T::Response: IntoResponse,
+        T::Future: Send + 'static,
+        Self: Sized,
+    {
+        self = self.route_service(path, service);
+
+        let redirect = Redirect::permanent(path);
+
+        if let Some(path_without_trailing_slash) = path.strip_suffix('/') {
+            self.route(
+                path_without_trailing_slash,
+                any(move || ready(redirect.clone())),
+            )
+        } else {
+            self.route(&format!("{}/", path), any(move || ready(redirect.clone())))
+        }
+    }
 }
 
 mod sealed {

axum-macros/tests/from_request/fail/double_via_attr.rs

@@ -1,8 +1,7 @@
 use axum_macros::FromRequest;
-use axum::extract::Extension;
 
 #[derive(FromRequest)]
-struct Extractor(#[from_request(via(Extension), via(Extension))] State);
+struct Extractor(#[from_request(via(axum::Extension), via(axum::Extension))] State);
 
 #[derive(Clone)]
 struct State;

axum-macros/tests/from_request/fail/double_via_attr.stderr

@@ -1,13 +1,5 @@
 error: `via` specified more than once
- --> tests/from_request/fail/double_via_attr.rs:5:49
+ --> tests/from_request/fail/double_via_attr.rs:4:55
   |
-5 | struct Extractor(#[from_request(via(Extension), via(Extension))] State);
-  |                                                 ^^^
-
-warning: unused import: `axum::extract::Extension`
- --> tests/from_request/fail/double_via_attr.rs:2:5
-  |
-2 | use axum::extract::Extension;
-  |     ^^^^^^^^^^^^^^^^^^^^^^^^
-  |
-  = note: `#[warn(unused_imports)]` on by default
+4 | struct Extractor(#[from_request(via(axum::Extension), via(axum::Extension))] State);
+  |                                                       ^^^

axum-macros/tests/from_request/fail/generic_without_via.rs

@@ -1,4 +1,4 @@
-use axum::{body::Body, routing::get, Extension, Router};
+use axum::{body::Body, routing::get, Router};
 use axum_macros::FromRequest;
 
 #[derive(FromRequest, Clone)]
@@ -7,5 +7,5 @@ struct Extractor<T>(T);
 async fn foo(_: Extractor<()>) {}
 
 fn main() {
-    Router::<Body>::new().route("/", get(foo));
+    Router::<(), Body>::new().route("/", get(foo));
 }

axum-macros/tests/from_request/fail/generic_without_via.stderr

@@ -4,30 +4,13 @@ error: #[derive(FromRequest)] only supports generics when used with #[from_reque
 5 | struct Extractor<T>(T);
   |                  ^
 
-warning: unused import: `Extension`
- --> tests/from_request/fail/generic_without_via.rs:1:38
-  |
-1 | use axum::{body::Body, routing::get, Extension, Router};
-  |                                      ^^^^^^^^^
-  |
-  = note: `#[warn(unused_imports)]` on by default
-
-error[E0599]: no function or associated item named `new` found for struct `Router<Body>` in the current scope
-  --> tests/from_request/fail/generic_without_via.rs:10:21
-   |
-10 |     Router::<Body>::new().route("/", get(foo));
-   |                     ^^^ function or associated item not found in `Router<Body>`
-   |
-   = note: the function or associated item was found for
-           - `Router<(), B>`
-
 error[E0277]: the trait bound `fn(Extractor<()>) -> impl Future<Output = ()> {foo}: Handler<_, _, _>` is not satisfied
-   --> tests/from_request/fail/generic_without_via.rs:10:42
+   --> tests/from_request/fail/generic_without_via.rs:10:46
     |
-10  |     Router::<Body>::new().route("/", get(foo));
-    |                                      --- ^^^ the trait `Handler<_, _, _>` is not implemented for `fn(Extractor<()>) -> impl Future<Output = ()> {foo}`
-    |                                      |
-    |                                      required by a bound introduced by this call
+10  |     Router::<(), Body>::new().route("/", get(foo));
+    |                                          --- ^^^ the trait `Handler<_, _, _>` is not implemented for `fn(Extractor<()>) -> impl Future<Output = ()> {foo}`
+    |                                          |
+    |                                          required by a bound introduced by this call
     |
     = help: the trait `Handler<T, S, B>` is implemented for `Layered<L, H, T, S, B>`
 note: required by a bound in `axum::routing::get`

axum-macros/tests/from_request/fail/generic_without_via_rejection.rs

@@ -1,4 +1,4 @@
-use axum::{body::Body, routing::get, Extension, Router};
+use axum::{body::Body, routing::get, Router};
 use axum_macros::FromRequest;
 
 #[derive(FromRequest, Clone)]
@@ -8,5 +8,5 @@ struct Extractor<T>(T);
 async fn foo(_: Extractor<()>) {}
 
 fn main() {
-    Router::<Body>::new().route("/", get(foo));
+    Router::<(), Body>::new().route("/", get(foo));
 }

axum-macros/tests/from_request/fail/generic_without_via_rejection.stderr

@@ -4,30 +4,13 @@ error: #[derive(FromRequest)] only supports generics when used with #[from_reque
 6 | struct Extractor<T>(T);
   |                  ^
 
-warning: unused import: `Extension`
- --> tests/from_request/fail/generic_without_via_rejection.rs:1:38
-  |
-1 | use axum::{body::Body, routing::get, Extension, Router};
-  |                                      ^^^^^^^^^
-  |
-  = note: `#[warn(unused_imports)]` on by default
-
-error[E0599]: no function or associated item named `new` found for struct `Router<Body>` in the current scope
-  --> tests/from_request/fail/generic_without_via_rejection.rs:11:21
-   |
-11 |     Router::<Body>::new().route("/", get(foo));
-   |                     ^^^ function or associated item not found in `Router<Body>`
-   |
-   = note: the function or associated item was found for
-           - `Router<(), B>`
-
 error[E0277]: the trait bound `fn(Extractor<()>) -> impl Future<Output = ()> {foo}: Handler<_, _, _>` is not satisfied
-   --> tests/from_request/fail/generic_without_via_rejection.rs:11:42
+   --> tests/from_request/fail/generic_without_via_rejection.rs:11:46
     |
-11  |     Router::<Body>::new().route("/", get(foo));
-    |                                      --- ^^^ the trait `Handler<_, _, _>` is not implemented for `fn(Extractor<()>) -> impl Future<Output = ()> {foo}`
-    |                                      |
-    |                                      required by a bound introduced by this call
+11  |     Router::<(), Body>::new().route("/", get(foo));
+    |                                          --- ^^^ the trait `Handler<_, _, _>` is not implemented for `fn(Extractor<()>) -> impl Future<Output = ()> {foo}`
+    |                                          |
+    |                                          required by a bound introduced by this call
     |
     = help: the trait `Handler<T, S, B>` is implemented for `Layered<L, H, T, S, B>`
 note: required by a bound in `axum::routing::get`

axum-macros/tests/from_request/fail/generic_without_via_rejection_derive.rs

@@ -1,4 +1,4 @@
-use axum::{body::Body, routing::get, Extension, Router};
+use axum::{body::Body, routing::get, Router};
 use axum_macros::FromRequest;
 
 #[derive(FromRequest, Clone)]
@@ -8,5 +8,5 @@ struct Extractor<T>(T);
 async fn foo(_: Extractor<()>) {}
 
 fn main() {
-    Router::<Body>::new().route("/", get(foo));
+    Router::<(), Body>::new().route("/", get(foo));
 }

axum-macros/tests/from_request/fail/generic_without_via_rejection_derive.stderr

@@ -4,30 +4,13 @@ error: #[derive(FromRequest)] only supports generics when used with #[from_reque
 6 | struct Extractor<T>(T);
   |                  ^
 
-warning: unused import: `Extension`
- --> tests/from_request/fail/generic_without_via_rejection_derive.rs:1:38
-  |
-1 | use axum::{body::Body, routing::get, Extension, Router};
-  |                                      ^^^^^^^^^
-  |
-  = note: `#[warn(unused_imports)]` on by default
-
-error[E0599]: no function or associated item named `new` found for struct `Router<Body>` in the current scope
-  --> tests/from_request/fail/generic_without_via_rejection_derive.rs:11:21
-   |
-11 |     Router::<Body>::new().route("/", get(foo));
-   |                     ^^^ function or associated item not found in `Router<Body>`
-   |
-   = note: the function or associated item was found for
-           - `Router<(), B>`
-
 error[E0277]: the trait bound `fn(Extractor<()>) -> impl Future<Output = ()> {foo}: Handler<_, _, _>` is not satisfied
-   --> tests/from_request/fail/generic_without_via_rejection_derive.rs:11:42
+   --> tests/from_request/fail/generic_without_via_rejection_derive.rs:11:46
     |
-11  |     Router::<Body>::new().route("/", get(foo));
-    |                                      --- ^^^ the trait `Handler<_, _, _>` is not implemented for `fn(Extractor<()>) -> impl Future<Output = ()> {foo}`
-    |                                      |
-    |                                      required by a bound introduced by this call
+11  |     Router::<(), Body>::new().route("/", get(foo));
+    |                                          --- ^^^ the trait `Handler<_, _, _>` is not implemented for `fn(Extractor<()>) -> impl Future<Output = ()> {foo}`
+    |                                          |
+    |                                          required by a bound introduced by this call
     |
     = help: the trait `Handler<T, S, B>` is implemented for `Layered<L, H, T, S, B>`
 note: required by a bound in `axum::routing::get`

axum-macros/tests/from_request/fail/rejection_derive_and_via.rs

@@ -1,8 +1,7 @@
 use axum_macros::FromRequest;
-use axum::extract::Extension;
 
 #[derive(FromRequest, Clone)]
-#[from_request(rejection_derive(!Error), via(Extension))]
+#[from_request(rejection_derive(!Error), via(axum::Extension))]
 struct Extractor {
     config: String,
 }