mirrors/actix-web
1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2025-01-09 00:35:56 +00:00
Code Issues Projects Releases Wiki Activity

add field name in deserialize error

Browse source 
* gated under feature flag 'beautify-errors'
* use serde_path_to_error
This commit is contained in:
Roms1383 2024-07-15 01:31:53 +07:00
parent b6bee346f7
commit 570d0fc156
6 changed files with 1020 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
actix-web/Cargo.toml
View file

@ -33,6 +33,7 @@ features = [
"compress-zstd", "compress-zstd",
"cookies", "cookies",
"secure-cookies", "secure-cookies",
"beautify-errors"
] ]
[package.metadata.cargo_check_external_types] [package.metadata.cargo_check_external_types]
@ -89,6 +90,9 @@ cookies = ["dep:cookie"]
# Secure & signed cookies # Secure & signed cookies
secure-cookies = ["cookies", "cookie/secure"] secure-cookies = ["cookies", "cookie/secure"]
# Field names in deserialization errors
beautify-errors = ["dep:serde_path_to_error"]
# HTTP/2 support (including h2c). # HTTP/2 support (including h2c).
http2 = ["actix-http/http2"] http2 = ["actix-http/http2"]
@ -160,6 +164,7 @@ regex = { version = "1.5.5", optional = true }
regex-lite = "0.1" regex-lite = "0.1"
serde = "1.0" serde = "1.0"
serde_json = "1.0" serde_json = "1.0"
serde_path_to_error = { version = "0.1", optional = true }
serde_urlencoded = "0.7" serde_urlencoded = "0.7"
smallvec = "1.6.1" smallvec = "1.6.1"
socket2 = "0.5" socket2 = "0.5"
@ -211,6 +216,10 @@ required-features = ["compress-gzip"]
name = "on-connect" name = "on-connect"
required-features = [] required-features = []
[[example]]
name = "error"
required-features = ["beautify-errors"]
[[bench]] [[bench]]
name = "server" name = "server"
harness = false harness = false

77
actix-web/examples/error.rs Normal file
View file

@ -0,0 +1,77 @@
use actix_web::{
get, middleware, post,
web::{Json, Query},
App, HttpServer,
};
use serde::Deserialize;
#[get("/optional")]
async fn optional_query_params(maybe_qs: Option<Query<OptionalFilters>>) -> String {
format!("you asked for the optional query params: {:#?}", maybe_qs)
}
#[get("/mandatory")]
async fn mandatory_query_params(qs: Query<MandatoryFilters>) -> String {
format!("you asked for the mandatory query params: {:#?}", qs)
}
#[post("/optional")]
async fn optional_payload(
maybe_qs: Option<Query<OptionalFilters>>,
maybe_payload: Option<Json<OptionalPayload>>,
) -> String {
format!(
"you asked for the optional query params: {:#?} and optional body: {:#?}",
maybe_qs, maybe_payload
)
}
#[post("/mandatory")]
async fn mandatory_payload(qs: Query<MandatoryFilters>, payload: Json<OptionalPayload>) -> String {
format!(
"you asked for the mandatory query params: {:#?} and mandatory body: {:#?}",
qs, payload
)
}
#[actix_web::main]
async fn main() -> std::io::Result<()> {
env_logger::init_from_env(env_logger::Env::new().default_filter_or("info"));
HttpServer::new(|| {
App::new()
.wrap(middleware::Logger::default())
.service(optional_query_params)
.service(mandatory_query_params)
.service(optional_payload)
.service(mandatory_payload)
})
.bind("127.0.0.1:8080")?
.workers(1)
.run()
.await
}
#[derive(Debug, Deserialize)]
pub struct OptionalFilters {
limit: Option<i32>,
active: Option<bool>,
}
#[derive(Debug, Deserialize)]
pub struct MandatoryFilters {
limit: i32,
active: bool,
}
#[derive(Debug, Deserialize)]
pub struct OptionalPayload {
name: Option<String>,
age: Option<i32>,
}
#[derive(Debug, Deserialize)]
pub struct MandatoryPayload {
name: String,
age: i32,
}

848
actix-web/examples/error_postman.json Normal file
View file

@ -0,0 +1,848 @@
{
"info": {
"_postman_id": "1147f102-8d16-40e4-8642-5f0679879e59",
"name": "actix-web",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "field in deserialize errors",
"item": [
{
"name": "optional filters",
"item": [
{
"name": "without filters",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "127.0.0.1:8080/optional",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
]
}
},
"response": []
},
{
"name": "with a single filter",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "127.0.0.1:8080/optional?limit=1",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
],
"query": [
{
"key": "limit",
"value": "1"
}
]
}
},
"response": []
},
{
"name": "with both filters",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "127.0.0.1:8080/optional?limit=1&active=true",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
],
"query": [
{
"key": "limit",
"value": "1"
},
{
"key": "active",
"value": "true"
}
]
}
},
"response": []
},
{
"name": "with a single invalid filter",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "127.0.0.1:8080/optional?limit=wrong&active=true",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
],
"query": [
{
"key": "limit",
"value": "wrong"
},
{
"key": "active",
"value": "true"
}
]
}
},
"response": []
},
{
"name": "with both invalid filters",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "127.0.0.1:8080/optional?limit=wrong&active=wrong",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
],
"query": [
{
"key": "limit",
"value": "wrong"
},
{
"key": "active",
"value": "wrong"
}
]
}
},
"response": []
}
]
},
{
"name": "mandatory filters",
"item": [
{
"name": "without filters",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "127.0.0.1:8080/mandatory",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
]
}
},
"response": []
},
{
"name": "with a single filter",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "127.0.0.1:8080/mandatory?limit=1",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
],
"query": [
{
"key": "limit",
"value": "1"
}
]
}
},
"response": []
},
{
"name": "with both filters",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "127.0.0.1:8080/mandatory?limit=1&active=true",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
],
"query": [
{
"key": "limit",
"value": "1"
},
{
"key": "active",
"value": "true"
}
]
}
},
"response": []
},
{
"name": "with a single invalid filter",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "127.0.0.1:8080/mandatory?limit=wrong&active=true",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
],
"query": [
{
"key": "limit",
"value": "wrong"
},
{
"key": "active",
"value": "true"
}
]
}
},
"response": []
},
{
"name": "with both invalid filters",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "127.0.0.1:8080/mandatory?limit=wrong&active=wrong",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
],
"query": [
{
"key": "limit",
"value": "wrong"
},
{
"key": "active",
"value": "wrong"
}
]
}
},
"response": []
}
]
},
{
"name": "optional filters and payload",
"item": [
{
"name": "without filters",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": 13\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/optional",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
]
}
},
"response": []
},
{
"name": "with a single filter",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": 13\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/optional?limit=1",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
],
"query": [
{
"key": "limit",
"value": "1"
}
]
}
},
"response": []
},
{
"name": "with both filters",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": 13\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/optional?limit=1&active=true",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
],
"query": [
{
"key": "limit",
"value": "1"
},
{
"key": "active",
"value": "true"
}
]
}
},
"response": []
},
{
"name": "with a single invalid filter",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": 13\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/optional?limit=wrong&active=true",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
],
"query": [
{
"key": "limit",
"value": "wrong"
},
{
"key": "active",
"value": "true"
}
]
}
},
"response": []
},
{
"name": "with both invalid filters",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": 13\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/optional?limit=wrong&active=wrong",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
],
"query": [
{
"key": "limit",
"value": "wrong"
},
{
"key": "active",
"value": "wrong"
}
]
}
},
"response": []
},
{
"name": "with both filters and invalid payload",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": \"wrong\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/optional?limit=1&active=true",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
],
"query": [
{
"key": "limit",
"value": "1"
},
{
"key": "active",
"value": "true"
}
]
}
},
"response": []
},
{
"name": "with both invalid filters and invalid payload",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": \"wrong\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/optional?limit=wrong&active=wrong",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"optional"
],
"query": [
{
"key": "limit",
"value": "wrong"
},
{
"key": "active",
"value": "wrong"
}
]
}
},
"response": []
}
]
},
{
"name": "mandatory filters and payload",
"item": [
{
"name": "without filters",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": 13\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/mandatory",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
]
}
},
"response": []
},
{
"name": "with a single filter",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": 13\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/mandatory?limit=1",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
],
"query": [
{
"key": "limit",
"value": "1"
}
]
}
},
"response": []
},
{
"name": "with both filters",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": 13\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/mandatory?limit=1&active=true",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
],
"query": [
{
"key": "limit",
"value": "1"
},
{
"key": "active",
"value": "true"
}
]
}
},
"response": []
},
{
"name": "with a single invalid filter",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": 13\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/mandatory?limit=wrong&active=true",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
],
"query": [
{
"key": "limit",
"value": "wrong"
},
{
"key": "active",
"value": "true"
}
]
}
},
"response": []
},
{
"name": "with both invalid filters",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": 13\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/mandatory?limit=wrong&active=wrong",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
],
"query": [
{
"key": "limit",
"value": "wrong"
},
{
"key": "active",
"value": "wrong"
}
]
}
},
"response": []
},
{
"name": "with both filters and invalid payload",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": \"wrong\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/mandatory?limit=1&active=true",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
],
"query": [
{
"key": "limit",
"value": "1"
},
{
"key": "active",
"value": "true"
}
]
}
},
"response": []
},
{
"name": "with both invalid filters and invalid payload",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"John\",\n \"age\": \"wrong\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "127.0.0.1:8080/mandatory?limit=wrong&active=wrong",
"host": [
"127",
"0",
"0",
"1"
],
"port": "8080",
"path": [
"mandatory"
],
"query": [
{
"key": "limit",
"value": "wrong"
},
{
"key": "active",
"value": "wrong"
}
]
}
},
"response": []
}
]
}
]
}
]
}

19
actix-web/src/types/json.rs
View file

@ -17,6 +17,8 @@ use serde::{de::DeserializeOwned, Serialize};
#[cfg(feature = "__compress")] #[cfg(feature = "__compress")]
use crate::dev::Decompress; use crate::dev::Decompress;
#[cfg(feature = "beautify-errors")]
use crate::web::map_deserialize_error;
use crate::{ use crate::{
body::EitherBody, body::EitherBody,
error::{Error, JsonPayloadError}, error::{Error, JsonPayloadError},
@ -427,11 +429,28 @@ impl<T: DeserializeOwned> Future for JsonBody<T> {
buf.extend_from_slice(&chunk); buf.extend_from_slice(&chunk);
} }
} }
#[cfg(not(feature = "beautify-errors"))]
None => { None => {
let json = serde_json::from_slice::<T>(buf) let json = serde_json::from_slice::<T>(buf)
.map_err(JsonPayloadError::Deserialize)?; .map_err(JsonPayloadError::Deserialize)?;
return Poll::Ready(Ok(json)); return Poll::Ready(Ok(json));
} }
#[cfg(feature = "beautify-errors")]
None => {
let mut deserializer = serde_json::Deserializer::from_slice(buf);
let json =
serde_path_to_error::deserialize(&mut deserializer).map_err(|e| {
JsonPayloadError::Deserialize(
<serde_json::error::Error as serde::de::Error>::custom(
map_deserialize_error(
&e.path().to_string(),
&e.inner().to_string(),
),
),
)
})?;
return Poll::Ready(Ok(json));
}
} }
}, },
JsonBody::Error(e) => Poll::Ready(Err(e.take().unwrap())), JsonBody::Error(e) => Poll::Ready(Err(e.take().unwrap())),

8
actix-web/src/types/mod.rs
View file

@ -21,3 +21,11 @@ pub use self::{
query::{Query, QueryConfig}, query::{Query, QueryConfig},
readlines::Readlines, readlines::Readlines,
}; };
#[cfg(feature = "beautify-errors")]
pub fn map_deserialize_error(field: &str, original: &str) -> String {
if field == "." {
return original.to_string();
}
format!("'{}': {}", field, original)
}

60
actix-web/src/types/query.rs
View file

@ -4,7 +4,11 @@ use std::{fmt, ops, sync::Arc};
use actix_utils::future::{err, ok, Ready}; use actix_utils::future::{err, ok, Ready};
use serde::de::DeserializeOwned; use serde::de::DeserializeOwned;
#[cfg(feature = "beautify-errors")]
use url::form_urlencoded::parse;
#[cfg(feature = "beautify-errors")]
use crate::web::map_deserialize_error;
use crate::{dev::Payload, error::QueryPayloadError, Error, FromRequest, HttpRequest}; use crate::{dev::Payload, error::QueryPayloadError, Error, FromRequest, HttpRequest};
/// Extract typed information from the request's query. /// Extract typed information from the request's query.
@ -61,7 +65,6 @@ use crate::{dev::Payload, error::QueryPayloadError, Error, FromRequest, HttpRequ
pub struct Query<T>(pub T); pub struct Query<T>(pub T);
impl<T> Query<T> { impl<T> Query<T> {
/// Unwrap into inner `T` value.
pub fn into_inner(self) -> T { pub fn into_inner(self) -> T {
self.0 self.0
} }
@ -78,11 +81,30 @@ impl<T: DeserializeOwned> Query<T> {
/// assert_eq!(numbers.get("two"), Some(&2)); /// assert_eq!(numbers.get("two"), Some(&2));
/// assert!(numbers.get("three").is_none()); /// assert!(numbers.get("three").is_none());
/// ``` /// ```
#[cfg(not(feature = "beautify-errors"))]
pub fn from_query(query_str: &str) -> Result<Self, QueryPayloadError> { pub fn from_query(query_str: &str) -> Result<Self, QueryPayloadError> {
serde_urlencoded::from_str::<T>(query_str) serde_urlencoded::from_str::<T>(query_str)
.map(Self) .map(Self)
.map_err(QueryPayloadError::Deserialize) .map_err(QueryPayloadError::Deserialize)
} }
#[cfg(feature = "beautify-errors")]
pub fn from_query(query_str: &str) -> Result<Self, QueryPayloadError>
where
T: de::DeserializeOwned,
{
let deserializer = serde_urlencoded::Deserializer::new(parse(query_str.as_bytes()));
let qs = serde_path_to_error::deserialize(deserializer)
.map(Self)
.map_err(|e| {
QueryPayloadError::Deserialize(
<serde::de::value::Error as serde::de::Error>::custom(map_deserialize_error(
&e.path().to_string(),
&e.inner().to_string(),
)),
)
})?;
Ok(qs)
}
} }
impl<T> ops::Deref for Query<T> { impl<T> ops::Deref for Query<T> {
@ -110,6 +132,7 @@ impl<T: DeserializeOwned> FromRequest for Query<T> {
type Error = Error; type Error = Error;
type Future = Ready<Result<Self, Error>>; type Future = Ready<Result<Self, Error>>;
#[cfg(not(feature = "beautify-errors"))]
#[inline] #[inline]
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future { fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future {
let error_handler = req let error_handler = req
@ -136,6 +159,41 @@ impl<T: DeserializeOwned> FromRequest for Query<T> {
err(e) err(e)
}) })
} }
#[cfg(feature = "beautify-errors")]
#[inline]
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future {
let error_handler = req
.app_data::<QueryConfig>()
.and_then(|c| c.err_handler.clone());
let deserializer =
serde_urlencoded::Deserializer::new(parse(req.query_string().as_bytes()));
return serde_path_to_error::deserialize(deserializer)
.map(|val| ok(Query(val)))
.unwrap_or_else(move |e| {
let e = QueryPayloadError::Deserialize(
<serde::de::value::Error as serde::de::Error>::custom(map_deserialize_error(
&e.path().to_string(),
&e.inner().to_string(),
)),
);
log::debug!(
"Failed during Query extractor deserialization. \
Request path: {:?}",
req.path()
);
let e = if let Some(error_handler) = error_handler {
(error_handler)(e, req)
} else {
e.into()
};
err(e)
});
}
} }
/// Query extractor configuration. /// Query extractor configuration.