junobuild_utils/serializers/
principal.rs

1use crate::serializers::types::DocDataPrincipal;
2use candid::Principal as CandidPrincipal;
3use serde::de::{self, MapAccess, Visitor};
4use serde::ser::SerializeStruct;
5use serde::{Deserialize, Deserializer, Serialize, Serializer};
6use std::fmt;
7
8impl Serialize for DocDataPrincipal {
9    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
10    where
11        S: Serializer,
12    {
13        let mut state = serializer.serialize_struct("DocDataPrincipal", 1)?;
14        state.serialize_field("__principal__", &self.value.to_string())?;
15        state.end()
16    }
17}
18
19impl<'de> Deserialize<'de> for DocDataPrincipal {
20    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
21    where
22        D: Deserializer<'de>,
23    {
24        deserializer.deserialize_struct(
25            "DocDataPrincipal",
26            &["__principal__"],
27            DocDataPrincipalVisitor,
28        )
29    }
30}
31
32struct DocDataPrincipalVisitor;
33
34impl<'de> Visitor<'de> for DocDataPrincipalVisitor {
35    type Value = DocDataPrincipal;
36
37    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
38        formatter.write_str("an object with a key __principal__")
39    }
40
41    fn visit_map<V>(self, mut map: V) -> Result<DocDataPrincipal, V::Error>
42    where
43        V: MapAccess<'de>,
44    {
45        let mut value = None;
46        while let Some(key) = map.next_key::<String>()? {
47            if key == "__principal__" {
48                if value.is_some() {
49                    return Err(de::Error::duplicate_field("__principal__"));
50                }
51                value = Some(map.next_value::<String>()?);
52            }
53        }
54        let value_str = value.ok_or_else(|| de::Error::missing_field("__principal__"))?;
55        let principal = CandidPrincipal::from_text(value_str)
56            .map_err(|_| de::Error::custom("Invalid format for __principal__"))?;
57        Ok(DocDataPrincipal { value: principal })
58    }
59}
60
61#[cfg(test)]
62mod tests {
63    use super::*;
64    use candid::Principal as CandidPrincipal;
65    use serde_json::{self};
66
67    fn p(txt: &str) -> CandidPrincipal {
68        CandidPrincipal::from_text(txt).expect("principal text should parse")
69    }
70
71    #[test]
72    fn serialize_doc_data_principal() {
73        let ddp = DocDataPrincipal {
74            value: p("aaaaa-aa"),
75        };
76        let s = serde_json::to_string(&ddp).expect("serialize");
77        assert_eq!(s, r#"{"__principal__":"aaaaa-aa"}"#);
78    }
79
80    #[test]
81    fn deserialize_doc_data_principal() {
82        let s = r#"{"__principal__":"aaaaa-aa"}"#;
83        let ddp: DocDataPrincipal = serde_json::from_str(s).expect("deserialize");
84        assert_eq!(ddp.value, p("aaaaa-aa"));
85    }
86
87    #[test]
88    fn round_trip() {
89        let original = DocDataPrincipal {
90            value: p("ryjl3-tyaaa-aaaaa-aaaba-cai"),
91        };
92        let json = serde_json::to_string(&original).unwrap();
93        let decoded: DocDataPrincipal = serde_json::from_str(&json).unwrap();
94        assert_eq!(decoded.value, original.value);
95    }
96
97    #[test]
98    fn error_on_missing_field() {
99        let err = serde_json::from_str::<DocDataPrincipal>(r#"{}"#).unwrap_err();
100        assert!(
101            err.to_string().contains("missing field `__principal__`"),
102            "got: {err}"
103        );
104    }
105
106    #[test]
107    fn error_on_duplicate_field() {
108        let s = r#"{"__principal__":"aaaaa-aa","__principal__":"aaaaa-aa"}"#;
109        let err = serde_json::from_str::<DocDataPrincipal>(s).unwrap_err();
110        assert!(
111            err.to_string().contains("duplicate field `__principal__`"),
112            "got: {err}"
113        );
114    }
115
116    #[test]
117    fn error_on_invalid_principal_format() {
118        let s = r#"{"__principal__":"not-a-principal"}"#;
119        let err = serde_json::from_str::<DocDataPrincipal>(s).unwrap_err();
120        assert!(
121            err.to_string().contains("Invalid format for __principal__"),
122            "got: {err}"
123        );
124    }
125}
junobuild_utils/serializers/principal.rs

junobuild_utils/serializers/
principal.rs
