review feedback

shotover · Mar 22, 2023 · 9ed3fe1 · 9ed3fe1
1 parent 1b0d414
commit 9ed3fe1
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/shotover-proxy/src/config/chain.rs b/shotover-proxy/src/config/chain.rs
@@ -22,6 +22,25 @@ impl TransformChainConfig {
  }
 }
 
+/// This function is a custom deserializer that works around a mismatch in the way yaml and typetag represent things,
+/// resulting in typetagged structs with no fields failing to deserialize from a single line yaml entry.
+/// e.g. with typetag + yaml + the default serializer:
+/// this would fail to deserialize:
+/// ```yaml
+/// chain_config:
+/// redis_chain:
+/// - NullSink
+/// ```
+///
+/// but this would work fine:
+/// ```yaml
+/// chain_config:
+/// redis_chain:
+/// - NullSink: {}
+/// ```
+///
+/// With the use of this custom deserializer both cases now deserialize correctly.
+/// The implementation was a suggestion from dtolnay: https://github.com/dtolnay/typetag/pull/40#issuecomment-1454961686
 fn vec_transform_config<'de, D>(deserializer: D) -> Result<Vec<Box<dyn TransformConfig>>, D::Error>
 where
  D: Deserializer<'de>,