Humanize array ser/deser #468
Merged
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
danielSanchezQ
requested changes
Oct 18, 2023
consensus-engine/src/types.rs
Outdated
Comment on lines
223
to
250
| let mut s = <&str>::deserialize(deserializer)?; | ||
| let extra_len = if s.starts_with("0x") || s.starts_with("0X") { | ||
| s = &s[2..]; | ||
| 2 | ||
| } else { | ||
| 0 | ||
| }; | ||
| if s.len() != N * 2 { | ||
| return Err(<D::Error as serde::de::Error>::invalid_length( | ||
| N + extra_len, | ||
| &format!("{N}").as_str(), | ||
| )); | ||
| } | ||
|
|
||
| let mut output = [0u8; N]; | ||
|
|
||
| for (chars, byte) in s.as_bytes().chunks_exact(2).zip(output.iter_mut()) { | ||
| let (l, r) = (chars[0] as char, chars[1] as char); | ||
| match (l.to_digit(16), r.to_digit(16)) { | ||
| (Some(l), Some(r)) => *byte = (l as u8) << 4 | r as u8, | ||
| (_, _) => { | ||
| return Err(<D::Error as serde::de::Error>::custom(format!( | ||
| "Invalid character pair '{l}{r}'" | ||
| ))) | ||
| } | ||
| }; | ||
| } | ||
| Ok(output) |
There was a problem hiding this comment.
This should be a single function.
consensus-engine/src/types.rs
Outdated
Comment on lines
252
to
263
| <&[u8]>::deserialize(deserializer).and_then(|bytes| { | ||
| if bytes.len() != N { | ||
| Err(<D::Error as serde::de::Error>::invalid_length( | ||
| bytes.len(), | ||
| &format!("{N}").as_str(), | ||
| )) | ||
| } else { | ||
| let mut output = [0u8; N]; | ||
| output.copy_from_slice(bytes); | ||
| Ok(output) | ||
| } | ||
| }) |
There was a problem hiding this comment.
This as well a single function
consensus-engine/src/types.rs
Outdated
| @@ -190,6 +190,81 @@ impl Qc { | |||
| } | |||
| } | |||
|
|
|||
| mod util { | |||
There was a problem hiding this comment.
Maybe we can have a utils module, inside a serde one:
consensus-engine/utils/serde?
consensus-engine/src/types.rs
Outdated
Comment on lines
203
to
210
| let size = N * 2 + 2; | ||
| let mut s = String::with_capacity(size); | ||
| s.push_str("0x"); | ||
| for v in src { | ||
| // unwrap is safe because we allocate enough space | ||
| write!(&mut s, "{:02x}", v).unwrap(); | ||
| } | ||
| s.serialize(serializer) |
zeegomo
requested changes
Oct 19, 2023
consensus-engine/src/utils.rs
Outdated
| } | ||
| } | ||
|
|
||
| fn deserialize_human_readable_bytes_array<'de, const N: usize, D: serde::Deserializer<'de>>( |
There was a problem hiding this comment.
there has to be a crate that does this (e.g. hex)
There was a problem hiding this comment.
Yeah, find a good one, switch to const-hex.
zeegomo
reviewed
Oct 19, 2023
consensus-engine/src/utils.rs
Outdated
| @@ -0,0 +1,66 @@ | |||
| #[cfg(feature = "serde")] | |||
| pub(crate) mod serde { | |||
There was a problem hiding this comment.
this should probably go in some more general module instead of consensus engine
There was a problem hiding this comment.
Yeah, cleaner, move it to the nomos-utils crate.
zeegomo
approved these changes
Oct 23, 2023
* Human readable serde for CommitteeId * Deserialize bytes to string if human readable * Don't allocate if possible in human serde bytes
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.
This PR solves the serialization/deserialization problem in OpenAPI, which was mentioned in Discord.