Fix /snapshot/raw_snapshot/{tag} voting_power_cap serialization bug (#142)

Update `voting_power_cap` field serialization for `RawSnapshotInput`.

Fixes #98

Author: minikin

src/vit-servicing-station/vit-servicing-station-lib/src/utils/serde.rs

@@ -2,7 +2,9 @@ use crate::db::models::vote_options::VoteOptions;
 use crate::utils::datetime::unix_timestamp_to_datetime;
 use serde::de::Visitor;
 use serde::{ser::Error, Deserialize, Deserializer, Serializer};
+use snapshot_lib::Fraction;
 use std::fmt;
+use std::str::FromStr;
 use time::{format_description::well_known::Rfc3339, OffsetDateTime};
 
 // this warning should be disable here since the interface for this function requires
@@ -113,7 +115,7 @@ pub fn deserialize_vote_options_from_string<'de, D>(
 where
     D: Deserializer<'de>,
 {
-    struct VoteOptionsDeserializer();
+    struct VoteOptionsDeserializer;
 
     impl<'de> Visitor<'de> for VoteOptionsDeserializer {
         type Value = VoteOptions;
@@ -130,7 +132,7 @@ where
         }
     }
 
-    deserializer.deserialize_str(VoteOptionsDeserializer())
+    deserializer.deserialize_str(VoteOptionsDeserializer)
 }
 
 pub fn serialize_vote_options_to_string<S: Serializer>(
@@ -150,3 +152,39 @@ where
         "x" | "1" | "true"
     ))
 }
+
+pub fn serialize_fraction_to_string<S: Serializer>(
+    fraction: &Fraction,
+    serializer: S,
+) -> Result<S::Ok, S::Error> {
+    serializer.serialize_str(&fraction.to_string())
+}
+
+pub fn deserialize_fraction_from_string<'de, D>(deserializer: D) -> Result<Fraction, D::Error>
+where
+    D: Deserializer<'de>,
+{
+    struct FractionDeserializer;
+
+    impl<'de> Visitor<'de> for FractionDeserializer {
+        type Value = Fraction;
+
+        fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
+            formatter.write_str("A fraction value e.g. 1.0, 0.56")
+        }
+
+        fn visit_str<E>(self, value: &str) -> Result<Fraction, E>
+        where
+            E: serde::de::Error,
+        {
+            match value {
+                "NaN" => Err(E::custom(
+                    "Invalid value format, should be a number e.g. 1.0, 0.56".to_string(),
+                )),
+                _ => Ok(Fraction::from_str(value).map_err(|e| E::custom(e.to_string()))?),
+            }
+        }
+    }
+
+    deserializer.deserialize_str(FractionDeserializer)
+}

src/vit-servicing-station/vit-servicing-station-lib/src/v0/endpoints/snapshot/handlers.rs

@@ -49,6 +49,8 @@ pub struct RawSnapshotInput {
     #[serde(serialize_with = "crate::utils::serde::serialize_unix_timestamp_as_rfc3339")]
     pub update_timestamp: i64,
     pub min_stake_threshold: Value,
+    #[serde(deserialize_with = "crate::utils::serde::deserialize_fraction_from_string")]
+    #[serde(serialize_with = "crate::utils::serde::serialize_fraction_to_string")]
     pub voting_power_cap: Fraction,
     pub direct_voters_group: Option<String>,
     pub representatives_group: Option<String>,

src/vit-servicing-station/vit-servicing-station-lib/src/v0/endpoints/snapshot/mod.rs

@@ -695,10 +695,11 @@ mod test {
         const GROUP1: &str = "group1";
         const GROUP2: &str = "group2";
 
-        let _e = tracing_subscriber::fmt()
+        tracing_subscriber::fmt()
             .with_max_level(Level::TRACE)
             .with_writer(tracing_subscriber::fmt::TestWriter::new())
-            .try_init();
+            .try_init()
+            .unwrap();
 
         let keys = [
             "0000000000000000000000000000000000000000000000000000000000000000",
@@ -818,10 +819,11 @@ mod test {
 
     #[tokio::test]
     async fn test_snapshot_get_tags_2() {
-        let _e = tracing_subscriber::fmt()
+        tracing_subscriber::fmt()
             .with_max_level(Level::TRACE)
             .with_writer(tracing_subscriber::fmt::TestWriter::new())
-            .try_init();
+            .try_init()
+            .unwrap();
 
         let key = "0000000000000000000000000000000000000000000000000000000000000000";
 
@@ -949,4 +951,27 @@ mod test {
 
         assert_eq!(tags, vec!["tag_a", "tag_b"]);
     }
+
+    #[tokio::test]
+    async fn test_put_raw_snapshot() {
+        let content = r#"{"snapshot":[{"stake_public_key":"0xa6a3c0447aeb9cc54cf6422ba32b294e5e1c3ef6d782f2acff4a70694c4d1663","voting_power":2,"reward_address":"0xa6a3c0447aeb9cc54cf6422ba32b294e5e1c3ef6d782f2acff4a70694c4d1663","delegations":"0x0000000000000000000000000000000000000000000000000000000000000000","voting_purpose":0},{"stake_public_key":"0x00588e8e1d18cba576a4d35758069fe94e53f638b6faf7c07b8abd2bc5c5cdee","voting_power":1,"reward_address":"0x00588e8e1d18cba576a4d35758069fe94e53f638b6faf7c07b8abd2bc5c5cdee","delegations":"0x0000000000000000000000000000000000000000000000000000000000000000","voting_purpose":0}],"update_timestamp":"1970-01-01T00:00:00Z","min_stake_threshold":0,"voting_power_cap": "NaN","direct_voters_group":null,"representatives_group":null}"#;
+
+        let context = new_db_test_shared_context();
+        let db_conn = &context.read().await.db_connection_pool.get().unwrap();
+        initialize_db_with_migration(db_conn).unwrap();
+
+        let snapshot_root = warp::path!("snapshot" / ..).boxed();
+        let put_filter = snapshot_root.and(update_filter(context));
+
+        assert_eq!(
+            warp::test::request()
+                .path("/snapshot/raw_snapshot/tag_a")
+                .method("PUT")
+                .body(content)
+                .reply(&put_filter)
+                .await
+                .status(),
+            StatusCode::BAD_REQUEST
+        );
+    }
 }