Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve deserialization error message #505

Merged
merged 2 commits into from
Dec 22, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 23 additions & 18 deletions src/serde_support.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ use crate::prelude::*;
use core::fmt;
use serde::{de, Deserialize, Deserializer, Serialize, Serializer};

#[cfg(feature = "serde")]
impl Serialize for Uuid {
fn serialize<S: Serializer>(
&self,
Expand All @@ -28,11 +27,14 @@ impl Serialize for Uuid {
}
}

#[cfg(feature = "serde")]
impl<'de> Deserialize<'de> for Uuid {
fn deserialize<D: Deserializer<'de>>(
deserializer: D,
) -> Result<Self, D::Error> {
fn de_error<E: de::Error>(e: crate::Error) -> E {
E::custom(format_args!("UUID parsing failed: {}", e))
}

if deserializer.is_human_readable() {
struct UuidStringVisitor;

Expand All @@ -50,14 +52,14 @@ impl<'de> Deserialize<'de> for Uuid {
self,
value: &str,
) -> Result<Uuid, E> {
value.parse::<Uuid>().map_err(E::custom)
value.parse::<Uuid>().map_err(de_error)
}

fn visit_bytes<E: de::Error>(
self,
value: &[u8],
) -> Result<Uuid, E> {
Uuid::from_slice(value).map_err(E::custom)
Uuid::from_slice(value).map_err(de_error)
}
}

Expand All @@ -79,7 +81,7 @@ impl<'de> Deserialize<'de> for Uuid {
self,
value: &[u8],
) -> Result<Uuid, E> {
Uuid::from_slice(value).map_err(E::custom)
Uuid::from_slice(value).map_err(de_error)
}
}

Expand All @@ -88,33 +90,36 @@ impl<'de> Deserialize<'de> for Uuid {
}
}

#[cfg(all(test, feature = "serde"))]
#[cfg(test)]
mod serde_tests {
use serde_test;
use serde_test::{Compact, Configure, Readable, Token};

use crate::prelude::*;

#[test]
fn test_serialize_readable() {
use serde_test::Configure;

let uuid_str = "f9168c5e-ceb2-4faa-b6bf-329bf39fa1e4";
let u = Uuid::parse_str(uuid_str).unwrap();
serde_test::assert_tokens(
&u.readable(),
&[serde_test::Token::Str(uuid_str)],
);
serde_test::assert_tokens(&u.readable(), &[Token::Str(uuid_str)]);
}

#[test]
fn test_serialize_compact() {
use serde_test::Configure;

let uuid_bytes = b"F9168C5E-CEB2-4F";
let u = Uuid::from_slice(uuid_bytes).unwrap();
serde_test::assert_tokens(
&u.compact(),
&[serde_test::Token::Bytes(uuid_bytes)],
serde_test::assert_tokens(&u.compact(), &[Token::Bytes(uuid_bytes)]);
}

#[test]
fn test_de_failure() {
serde_test::assert_de_tokens_error::<Readable<Uuid>>(
&[Token::Str("hello_world")],
"UUID parsing failed: invalid length: expected one of [36, 32], found 11",
);

serde_test::assert_de_tokens_error::<Compact<Uuid>>(
&[Token::Bytes(b"hello_world")],
"UUID parsing failed: invalid bytes length: expected 16, found 11",
);
}
}