Add axum support #30
Open
Add axum support #30
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
irevoire
requested changes
Feb 2, 2023
There was a problem hiding this comment.
Nice PR!
I have a few comments that all come down to the same thing; we're not generic enough on the error type.
You can see it easily if you try to return a QueryParamError in the deserr example like that;
async fn deserr(item: AxumJson<Query, QueryParamError>) -> AxumJson<Query, QueryParamError> {
item
}This should work without requiring the user to implement anything specific I think 🤔
| @@ -2,8 +2,7 @@ | |||
| name = "actix_web_server" | |||
| version = "0.1.0" | |||
| edition = "2021" | |||
|
|
|||
| # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html | |||
| publish = false | |||
| @@ -2,6 +2,8 @@ | |||
|
|
|||
| #[cfg(feature = "actix-web")] | |||
| pub mod actix_web; | |||
| // #[cfg(feature = "axum")] | |||
There was a problem hiding this comment.
This should not be commented 😁
Suggested change
| // #[cfg(feature = "axum")] | |
| #[cfg(feature = "axum")] |
| } | ||
| } | ||
|
|
||
| /// This handler uses the official `AxumJson` deserr |
There was a problem hiding this comment.
Suggested change
| /// This handler uses the official `AxumJson` deserr | |
| /// This handler uses the official `AxumJson` deserr extractor |
Comment on lines
+25
to
+29
| #[derive(Debug)] | ||
| pub enum AxumJsonRejection { | ||
| DeserrError(JsonError), | ||
| JsonRejection(JsonRejection), | ||
| } |
There was a problem hiding this comment.
We should let the end user decide which kind of error they want to return.
Suggested change
| #[derive(Debug)] | |
| pub enum AxumJsonRejection { | |
| DeserrError(JsonError), | |
| JsonRejection(JsonRejection), | |
| } | |
| #[derive(Debug)] | |
| pub enum AxumJsonRejection<E: DeserializeError> { | |
| DeserrError(E), | |
| JsonRejection(JsonRejection), | |
| } |
Comment on lines
+40
to
+58
| #[async_trait] | ||
| impl<T, S, B, E: DeserializeError> FromRequest<S, B> for AxumJson<T, E> | ||
| where | ||
| T: Deserr<E>, | ||
| E: DeserializeError + 'static, | ||
| B: HttpBody + Send + 'static, | ||
| B::Data: Send, | ||
| B::Error: Into<BoxError>, | ||
| S: Send + Sync, | ||
| AxumJsonRejection: std::convert::From<E>, | ||
| { | ||
| type Rejection = AxumJsonRejection; | ||
|
|
||
| async fn from_request(req: Request<B>, state: &S) -> Result<Self, Self::Rejection> { | ||
| let Json(value): Json<serde_json::Value> = Json::from_request(req, state).await?; | ||
| let data = deserr::deserialize::<_, _, _>(value)?; | ||
| Ok(AxumJson(data, PhantomData)) | ||
| } | ||
| } |
There was a problem hiding this comment.
Suggested change
| #[async_trait] | |
| impl<T, S, B, E: DeserializeError> FromRequest<S, B> for AxumJson<T, E> | |
| where | |
| T: Deserr<E>, | |
| E: DeserializeError + 'static, | |
| B: HttpBody + Send + 'static, | |
| B::Data: Send, | |
| B::Error: Into<BoxError>, | |
| S: Send + Sync, | |
| AxumJsonRejection: std::convert::From<E>, | |
| { | |
| type Rejection = AxumJsonRejection; | |
| async fn from_request(req: Request<B>, state: &S) -> Result<Self, Self::Rejection> { | |
| let Json(value): Json<serde_json::Value> = Json::from_request(req, state).await?; | |
| let data = deserr::deserialize::<_, _, _>(value)?; | |
| Ok(AxumJson(data, PhantomData)) | |
| } | |
| } | |
| #[async_trait] | |
| impl<T, S, B, E: DeserializeError> FromRequest<S, B> for AxumJson<T, E> | |
| where | |
| T: Deserr<E>, | |
| E: DeserializeError + 'static, | |
| B: HttpBody + Send + 'static, | |
| B::Data: Send, | |
| B::Error: Into<BoxError>, | |
| S: Send + Sync, | |
| { | |
| type Rejection = AxumJsonRejection<E>; | |
| async fn from_request(req: Request<B>, state: &S) -> Result<Self, Self::Rejection> { | |
| let Json(value): Json<serde_json::Value> = Json::from_request(req, state).await?; | |
| let data = deserr::deserialize::<_, _, _>(value)?; | |
| Ok(AxumJson(data, PhantomData)) | |
| } | |
| } |
Comment on lines
+60
to
+64
| impl From<JsonError> for AxumJsonRejection { | ||
| fn from(value: JsonError) -> Self { | ||
| AxumJsonRejection::DeserrError(value) | ||
| } | ||
| } |
There was a problem hiding this comment.
Suggested change
| impl From<JsonError> for AxumJsonRejection { | |
| fn from(value: JsonError) -> Self { | |
| AxumJsonRejection::DeserrError(value) | |
| } | |
| } |
I don't think we can keep this while being fully generic over the error type.
Comment on lines
+72
to
+79
| impl IntoResponse for AxumJsonRejection { | ||
| fn into_response(self) -> axum::response::Response { | ||
| match self { | ||
| AxumJsonRejection::DeserrError(e) => e.into_response(), | ||
| AxumJsonRejection::JsonRejection(e) => e.into_response(), | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Maybe in the previous comments, we were supposed to also constraint E to implement IntoResponse?
Comment on lines
+81
to
+85
| impl IntoResponse for JsonError { | ||
| fn into_response(self) -> axum::response::Response { | ||
| (StatusCode::BAD_REQUEST, self.to_string()).into_response() | ||
| } | ||
| } |
There was a problem hiding this comment.
This is nice though, it will help someone who don't want to use his own error type 👍
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR add deserr support for axum via the
AxumJsonwrapper type.Note that unlike the actix-web feature serde is needed to provide a
axum::IntoResponseblanquet implementation forT: serde::Serialize.Misc