Only allow last extractor to mutate the request (#1272)

* Only allow last extractor to mutate the request * Change `FromRequest` and add `FromRequestParts` trait (#1275) * Add `Once`/`Mut` type parameter for `FromRequest` and `RequestParts` * 🪄 * split traits * `FromRequest` for tuples * Remove `BodyAlreadyExtracted` * don't need fully qualified path * don't export `Once` and `Mut` * remove temp tests * depend on axum again Co-authored-by: Jonas Platte <[email protected]> * Port `Handler` and most extractors (#1277) * Port `Handler` and most extractors * Put `M` inside `Handler` impls, not trait itself * comment out tuples for now * fix lints * Reorder arguments to `Handler` (#1281) I think `Request<B>, Arc<S>` is better since its consistent with `FromRequest` and `FromRequestParts`. * Port most things in axum-extra (#1282) * Port `#[derive(TypedPath)]` and `#[debug_handler]` (#1283) * port #[derive(TypedPath)] * wip: #[debug_handler] * fix #[debug_handler] * don't need itertools * also require `Send` * update expected error * support fully qualified `self` * Implement FromRequest[Parts] for tuples (#1286) * Port docs for axum and axum-core (#1285) * Port axum-extra (#1287) * Port axum-extra * Update axum-core/Cargo.toml Co-authored-by: Jonas Platte <[email protected]> * remove `impl FromRequest for Either*` Co-authored-by: Jonas Platte <[email protected]> * New FromRequest[Parts] trait cleanup (#1288) * Make private module truly private again * Simplify tuple FromRequest implementation * Port `#[derive(FromRequest)]` (#1289) * fix tests * fix docs * revert examples * fix docs link * fix intra docs links * Port examples (#1291) * Document wrapping other extractors (#1292) * axum-extra doesn't need to depend on axum-core (#1294) Missed this in https://github.com/tokio-rs/axum/pull/1287 * Add `FromRequest` changes to changelogs (#1293) * Update changelog * Remove default type for `S` in `Handler` * Clarify which types have default types for `S` * Apply suggestions from code review Co-authored-by: Jonas Platte <[email protected]> Co-authored-by: Jonas Platte <[email protected]> * remove unused import * Rename `Mut` and `Once` (#1296) * fix trybuild expected output Co-authored-by: Jonas Platte <[email protected]>
2026-09-07 00:00:12 +02:00 · 2022-08-22 12:23:20 +02:00
parent f1769e5134
commit be624306f4
104 changed files with 1513 additions and 1936 deletions
@@ -1,9 +0,0 @@
-use axum_macros::FromRequest;
-
-#[derive(FromRequest)]
-#[from_request(rejection_derive(!Debug, !Display))]
-struct Extractor {
-    body: String,
-}
-
-fn main() {}
@@ -1,5 +0,0 @@
-error: opt out of `Debug` and `Display` requires also opting out of `Error`. Use `#[from_request(rejection_derive(!Debug, !Display, !Error))]`
- --> tests/from_request/fail/derive_opt_out_debug_and_display_without_error.rs:4:34
-  |
-4 | #[from_request(rejection_derive(!Debug, !Display))]
-  |                                  ^^^^^
@@ -1,9 +0,0 @@
-use axum_macros::FromRequest;
-
-#[derive(FromRequest)]
-#[from_request(rejection_derive(!Debug))]
-struct Extractor {
-    body: String,
-}
-
-fn main() {}
@@ -1,5 +0,0 @@
-error: opt out of `Debug` requires also opting out of `Error`. Use `#[from_request(rejection_derive(!Debug, !Error))]`
- --> tests/from_request/fail/derive_opt_out_debug_without_error.rs:4:34
-  |
-4 | #[from_request(rejection_derive(!Debug))]
-  |                                  ^^^^^
@@ -1,9 +0,0 @@
-use axum_macros::FromRequest;
-
-#[derive(FromRequest)]
-#[from_request(rejection_derive(!Display))]
-struct Extractor {
-    body: String,
-}
-
-fn main() {}
@@ -1,5 +0,0 @@
-error: opt out of `Display` requires also opting out of `Error`. Use `#[from_request(rejection_derive(!Display, !Error))]`
- --> tests/from_request/fail/derive_opt_out_display_without_error.rs:4:34
-  |
-4 | #[from_request(rejection_derive(!Display))]
-  |                                  ^^^^^^^
@@ -1,9 +0,0 @@
-use axum_macros::FromRequest;
-
-#[derive(FromRequest)]
-#[from_request(rejection_derive(!Error, !Error))]
-struct Extractor {
-    body: String,
-}
-
-fn main() {}
@@ -1,5 +0,0 @@
-error: `Error` opt out specified more than once
- --> tests/from_request/fail/derive_opt_out_duplicate.rs:4:42
-  |
-4 | #[from_request(rejection_derive(!Error, !Error))]
-  |                                          ^^^^^
@@ -1,7 +0,0 @@
-use axum_macros::FromRequest;
-
-#[derive(FromRequest, Clone)]
-#[from_request(rejection_derive(!Error))]
-enum Extractor {}
-
-fn main() {}
@@ -1,5 +0,0 @@
-error: cannot use `rejection_derive` on enums
- --> tests/from_request/fail/enum_rejection_derive.rs:4:16
-  |
-4 | #[from_request(rejection_derive(!Error))]
-  |                ^^^^^^^^^^^^^^^^
@@ -1,12 +0,0 @@
-use axum::{body::Body, routing::get, Router};
-use axum_macros::FromRequest;
-
-#[derive(FromRequest, Clone)]
-#[from_request(rejection_derive(!Error))]
-struct Extractor<T>(T);
-
-async fn foo(_: Extractor<()>) {}
-
-fn main() {
-    Router::<(), Body>::new().route("/", get(foo));
-}
@@ -1,21 +0,0 @@
-error: #[derive(FromRequest)] only supports generics when used with #[from_request(via)]
- --> tests/from_request/fail/generic_without_via_rejection_derive.rs:6:18
-  |
-6 | struct Extractor<T>(T);
-  |                  ^
-
-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: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
-    |
-    = 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`
-   --> $WORKSPACE/axum/src/routing/method_routing.rs
-    |
-    | top_level_handler_fn!(get, GET);
-    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ required by this bound in `axum::routing::get`
-    = note: this error originates in the macro `top_level_handler_fn` (in Nightly builds, run with -Z macro-backtrace for more info)
@@ -1,9 +0,0 @@
-use axum_macros::FromRequest;
-
-#[derive(FromRequest, Clone)]
-#[from_request(rejection_derive(!Error), via(axum::Extension))]
-struct Extractor {
-    config: String,
-}
-
-fn main() {}
@@ -1,5 +0,0 @@
-error: cannot use both `rejection_derive` and `via`
- --> tests/from_request/fail/rejection_derive_and_via.rs:4:42
-  |
-4 | #[from_request(rejection_derive(!Error), via(axum::Extension))]
-  |                                          ^^^
@@ -1,4 +1,4 @@
-error: expected one of: `via`, `rejection_derive`, `rejection`
+error: expected `via` or `rejection`
 --> tests/from_request/fail/unknown_attr_container.rs:4:16
  |
 4 | #[from_request(foo)]
@@ -1,9 +0,0 @@
-use axum_macros::FromRequest;
-
-#[derive(FromRequest, Clone)]
-#[from_request(via(axum::Extension), rejection_derive(!Error))]
-struct Extractor {
-    config: String,
-}
-
-fn main() {}
@@ -1,5 +0,0 @@
-error: cannot use both `via` and `rejection_derive`
- --> tests/from_request/fail/via_and_rejection_derive.rs:4:38
-  |
-4 | #[from_request(via(axum::Extension), rejection_derive(!Error))]
-  |                                      ^^^^^^^^^^^^^^^^
@@ -1,6 +1,7 @@
 use axum::{
    body::Body,
-    extract::{rejection::JsonRejection, FromRequest, Json},
+    extract::{FromRequest, Json},
+    response::Response,
 };
 use axum_macros::FromRequest;
 use serde::Deserialize;
@@ -15,7 +16,7 @@ struct Extractor {

 fn assert_from_request()
 where
-    Extractor: FromRequest<(), Body, Rejection = JsonRejection>,
+    Extractor: FromRequest<(), Body, Rejection = Response>,
 {
 }

@@ -1,38 +0,0 @@
-use axum::{
-    async_trait,
-    extract::{FromRequest, RequestParts},
-    response::{IntoResponse, Response},
-};
-use axum_macros::FromRequest;
-
-#[derive(FromRequest)]
-#[from_request(rejection_derive(!Display, !Error))]
-struct Extractor {
-    other: OtherExtractor,
-}
-
-struct OtherExtractor;
-
-#[async_trait]
-impl<S, B> FromRequest<S, B> for OtherExtractor
-where
-    B: Send,
-    S: Send + Sync,
-{
-    type Rejection = OtherExtractorRejection;
-
-    async fn from_request(_req: &mut RequestParts<S, B>) -> Result<Self, Self::Rejection> {
-        unimplemented!()
-    }
-}
-
-#[derive(Debug)]
-struct OtherExtractorRejection;
-
-impl IntoResponse for OtherExtractorRejection {
-    fn into_response(self) -> Response {
-        unimplemented!()
-    }
-}
-
-fn main() {}
@@ -1,10 +1,10 @@
 use axum::{
    body::Body,
-    extract::{FromRequest, TypedHeader, rejection::{TypedHeaderRejection, StringRejection}},
+    extract::{FromRequest, TypedHeader, rejection::TypedHeaderRejection},
+    response::Response,
    headers::{self, UserAgent},
 };
 use axum_macros::FromRequest;
-use std::convert::Infallible;

 #[derive(FromRequest)]
 struct Extractor {
@@ -18,34 +18,8 @@ struct Extractor {

 fn assert_from_request()
 where
-    Extractor: FromRequest<(), Body, Rejection = ExtractorRejection>,
+    Extractor: FromRequest<(), Body, Rejection = Response>,
 {
 }

-fn assert_rejection(rejection: ExtractorRejection)
-where
-    ExtractorRejection: std::fmt::Debug + std::fmt::Display + std::error::Error,
-{
-    match rejection {
-        ExtractorRejection::Uri(inner) => {
-            let _: Infallible = inner;
-        }
-        ExtractorRejection::Body(inner) => {
-            let _: StringRejection = inner;
-        }
-        ExtractorRejection::UserAgent(inner) => {
-            let _: TypedHeaderRejection = inner;
-        }
-        ExtractorRejection::ContentType(inner) => {
-            let _: TypedHeaderRejection = inner;
-        }
-        ExtractorRejection::Etag(inner) => {
-            let _: Infallible = inner;
-        }
-        ExtractorRejection::Host(inner) => {
-            let _: Infallible = inner;
-        }
-    }
-}
-
 fn main() {}
@@ -1,13 +1,13 @@
 use axum::{
    body::Body,
+    response::Response,
    extract::{
-        rejection::{ExtensionRejection, TypedHeaderRejection},
+        rejection::TypedHeaderRejection,
        Extension, FromRequest, TypedHeader,
    },
    headers::{self, UserAgent},
 };
 use axum_macros::FromRequest;
-use std::convert::Infallible;

 #[derive(FromRequest)]
 struct Extractor {
@@ -25,33 +25,10 @@ struct Extractor {

 fn assert_from_request()
 where
-    Extractor: FromRequest<(), Body, Rejection = ExtractorRejection>,
+    Extractor: FromRequest<(), Body, Rejection = Response>,
 {
 }

-fn assert_rejection(rejection: ExtractorRejection)
-where
-    ExtractorRejection: std::fmt::Debug + std::fmt::Display + std::error::Error,
-{
-    match rejection {
-        ExtractorRejection::State(inner) => {
-            let _: ExtensionRejection = inner;
-        }
-        ExtractorRejection::UserAgent(inner) => {
-            let _: TypedHeaderRejection = inner;
-        }
-        ExtractorRejection::ContentType(inner) => {
-            let _: TypedHeaderRejection = inner;
-        }
-        ExtractorRejection::Etag(inner) => {
-            let _: Infallible = inner;
-        }
-        ExtractorRejection::Host(inner) => {
-            let _: Infallible = inner;
-        }
-    }
-}
-
 #[derive(Clone)]
 struct State;

@@ -1,7 +1,7 @@
 use axum::{
    async_trait,
-    extract::{rejection::ExtensionRejection, FromRequest, RequestParts},
-    http::StatusCode,
+    extract::{rejection::ExtensionRejection, FromRequest},
+    http::{StatusCode, Request},
    response::{IntoResponse, Response},
    routing::get,
    Extension, Router,
@@ -36,7 +36,7 @@ where
    // this rejection doesn't implement `Display` and `Error`
    type Rejection = (StatusCode, String);

-    async fn from_request(_req: &mut RequestParts<S, B>) -> Result<Self, Self::Rejection> {
+    async fn from_request(_req: Request<B>, _state: &S) -> Result<Self, Self::Rejection> {
        todo!()
    }
 }
@@ -1,4 +1,4 @@
-use axum::extract::{Query, rejection::*};
+use axum::extract::Query;
 use axum_macros::FromRequest;
 use serde::Deserialize;

@@ -17,18 +17,4 @@ where
 {
 }

-fn assert_rejection(rejection: ExtractorRejection)
-where
-    ExtractorRejection: std::fmt::Debug + std::fmt::Display + std::error::Error,
-{
-    match rejection {
-        ExtractorRejection::QueryPayload(inner) => {
-            let _: QueryRejection = inner;
-        }
-        ExtractorRejection::JsonPayload(inner) => {
-            let _: JsonRejection = inner;
-        }
-    }
-}
-
 fn main() {}
@@ -1,4 +1,5 @@
-use axum::extract::{Query, rejection::*};
+use axum::extract::Query;
+use axum::response::Response;
 use axum_macros::FromRequest;
 use serde::Deserialize;

@@ -8,26 +9,12 @@ struct Extractor(
    #[from_request(via(axum::extract::Json))] Payload,
 );

-fn assert_rejection(rejection: ExtractorRejection)
-where
-    ExtractorRejection: std::fmt::Debug + std::fmt::Display + std::error::Error,
-{
-    match rejection {
-        ExtractorRejection::QueryPayload(inner) => {
-            let _: QueryRejection = inner;
-        }
-        ExtractorRejection::JsonPayload(inner) => {
-            let _: JsonRejection = inner;
-        }
-    }
-}
-
 #[derive(Deserialize)]
 struct Payload {}

 fn assert_from_request()
 where
-    Extractor: axum::extract::FromRequest<(), axum::body::Body>,
+    Extractor: axum::extract::FromRequest<(), axum::body::Body, Rejection = Response>,
 {
 }