74fa87aa98
## Proposed Changes This is an extraction of the quoted int code from #1569, that I've come to rely on for #1544. It allows us to parse integers from serde strings in YAML, JSON, etc. The main differences from the code in Paul's original PR are: * Added a submodule that makes quoting mandatory (`require_quotes`). * Decoding is generic over the type `T` being decoded. You can use `#[serde(with = "serde_utils::quoted_u64::require_quotes")]` on `Epoch` and `Slot` fields (this is what I do in my slashing protection PR). I've turned on quoting for `Epoch` and `Slot` in this PR, but will leave the other `types` changes to you Paul. I opted to put everything in the `conseus/serde_utils` module so that BLS can use it without a circular dependency. In future when we want to publish `types` I think we could publish `serde_utils` as `lighthouse_serde_utils` or something. Open to other ideas on this front too.
92 lines
2.3 KiB
Rust
92 lines
2.3 KiB
Rust
use serde::ser::SerializeSeq;
|
|
use serde::{Deserializer, Serializer};
|
|
use serde_derive::{Deserialize, Serialize};
|
|
|
|
#[derive(Serialize, Deserialize)]
|
|
#[serde(transparent)]
|
|
pub struct QuotedIntWrapper {
|
|
#[serde(with = "crate::quoted_u64")]
|
|
int: u64,
|
|
}
|
|
|
|
pub struct QuotedIntVecVisitor;
|
|
impl<'a> serde::de::Visitor<'a> for QuotedIntVecVisitor {
|
|
type Value = Vec<u64>;
|
|
|
|
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
|
|
write!(formatter, "a list of quoted or unquoted integers")
|
|
}
|
|
|
|
fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
|
|
where
|
|
A: serde::de::SeqAccess<'a>,
|
|
{
|
|
let mut vec = vec![];
|
|
|
|
while let Some(val) = seq.next_element()? {
|
|
let val: QuotedIntWrapper = val;
|
|
vec.push(val.int);
|
|
}
|
|
|
|
Ok(vec)
|
|
}
|
|
}
|
|
|
|
pub fn serialize<S>(value: &[u64], serializer: S) -> Result<S::Ok, S::Error>
|
|
where
|
|
S: Serializer,
|
|
{
|
|
let mut seq = serializer.serialize_seq(Some(value.len()))?;
|
|
for &int in value {
|
|
seq.serialize_element(&QuotedIntWrapper { int })?;
|
|
}
|
|
seq.end()
|
|
}
|
|
|
|
pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u64>, D::Error>
|
|
where
|
|
D: Deserializer<'de>,
|
|
{
|
|
deserializer.deserialize_any(QuotedIntVecVisitor)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[derive(Debug, Serialize, Deserialize)]
|
|
struct Obj {
|
|
#[serde(with = "crate::quoted_u64_vec")]
|
|
values: Vec<u64>,
|
|
}
|
|
|
|
#[test]
|
|
fn quoted_list_success() {
|
|
let obj: Obj = serde_json::from_str(r#"{ "values": ["1", "2", "3", "4"] }"#).unwrap();
|
|
assert_eq!(obj.values, vec![1, 2, 3, 4]);
|
|
}
|
|
|
|
#[test]
|
|
fn unquoted_list_success() {
|
|
let obj: Obj = serde_json::from_str(r#"{ "values": [1, 2, 3, 4] }"#).unwrap();
|
|
assert_eq!(obj.values, vec![1, 2, 3, 4]);
|
|
}
|
|
|
|
#[test]
|
|
fn mixed_list_success() {
|
|
let obj: Obj = serde_json::from_str(r#"{ "values": ["1", 2, "3", "4"] }"#).unwrap();
|
|
assert_eq!(obj.values, vec![1, 2, 3, 4]);
|
|
}
|
|
|
|
#[test]
|
|
fn empty_list_success() {
|
|
let obj: Obj = serde_json::from_str(r#"{ "values": [] }"#).unwrap();
|
|
assert!(obj.values.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn whole_list_quoted_err() {
|
|
serde_json::from_str::<Obj>(r#"{ "values": "[1, 2, 3, 4]" }"#).unwrap_err();
|
|
}
|
|
}
|