apollo_config: add serialize_optional_comma_separated fn (#9646)

Author: asmaastarkware

Cargo.lock

@@ -273,6 +273,18 @@ where
         .collect()
 }
 
+/// Serializes an optional list into a comma-separated string.
+/// Returns `None` if the input is `None`.
+pub fn serialize_optional_comma_separated<T>(list: &Option<Vec<T>>) -> Option<String>
+where
+    T: ToString,
+{
+    match list {
+        None => None,
+        Some(list) => Some(list.iter().map(|item| item.to_string()).collect::<Vec<_>>().join(",")),
+    }
+}
+
 /// Deserializes an optional comma-separated list of values implementing `FromStr` into
 /// `Option<Vec<T>>`. Returns `None` for empty or missing strings.
 pub fn deserialize_comma_separated_str<'de, D, T>(de: D) -> Result<Option<Vec<T>>, D::Error>

crates/apollo_config/src/converters.rs

@@ -6,6 +6,7 @@ use apollo_config::converters::{
     deserialize_comma_separated_str,
     deserialize_milliseconds_to_duration,
     deserialize_seconds_to_duration,
+    serialize_optional_comma_separated,
 };
 use apollo_config::dumping::{ser_optional_param, ser_param, SerializeConfig};
 use apollo_config::{ParamPath, ParamPrivacyInput, SerializedParam};
@@ -253,9 +254,7 @@ impl SerializeConfig for ContextConfig {
             ParamPrivacyInput::Public,
         ));
         dump.extend(ser_optional_param(
-            &self.validator_ids.as_ref().map(|accounts| {
-                accounts.iter().map(|addr| addr.0.to_string()).collect::<Vec<_>>().join(",")
-            }),
+            &serialize_optional_comma_separated(&self.validator_ids),
             "".to_string(),
             "validator_ids",
             "Optional explicit set of validator IDs (comma separated).",

crates/apollo_consensus_orchestrator_config/src/config.rs

@@ -15,7 +15,6 @@ apollo_http_server_config.workspace = true
 apollo_infra.workspace = true
 apollo_infra_utils.workspace = true
 apollo_monitoring_endpoint_config.workspace = true
-apollo_network.workspace = true
 apollo_node_config.workspace = true
 indexmap.workspace = true
 libp2p.workspace = true

crates/apollo_deployments/Cargo.toml

@@ -1,9 +1,9 @@
 use std::path::Path;
 
+use apollo_config::converters::serialize_optional_comma_separated;
 use apollo_infra_utils::dumping::serialize_to_file;
 #[cfg(test)]
 use apollo_infra_utils::dumping::serialize_to_file_test;
-use apollo_network::serialize_multi_addrs;
 use libp2p::Multiaddr;
 use serde::{Serialize, Serializer};
 use serde_json::to_value;
@@ -185,7 +185,10 @@ impl DeploymentConfigOverride {
 #[derive(Clone, Debug, Serialize, PartialEq)]
 pub struct PeerToPeerBootstrapConfig {
     // Bootstrap peer address.
-    #[serde(rename = "bootstrap_peer_multiaddr", serialize_with = "serialize_multi_addrs_wrapper")]
+    #[serde(
+        rename = "bootstrap_peer_multiaddr",
+        serialize_with = "serialize_optional_comma_separated_wrapper"
+    )]
     bootstrap_peers_multiaddrs: Option<Vec<Multiaddr>>,
     #[serde(rename = "bootstrap_peer_multiaddr.#is_none")]
     bootstrap_peer_multiaddr_is_none: bool,
@@ -244,23 +247,19 @@ impl InstanceConfigOverride {
     }
 }
 
-// Wrapper function for the custom `serialize_multi_addrs` function, to be
+// Wrapper function for the generic `serialize_optional_comma_separated` function, to be
 // compatible with serde's `serialize_with` attribute. It first applies the custom serialization
 // logic to convert the optional list into a `String`, and then serializes that string.
-fn serialize_multi_addrs_wrapper<S>(
-    optional_multi_addrs: &Option<Vec<Multiaddr>>,
+fn serialize_optional_comma_separated_wrapper<S, T>(
+    optional_list: &Option<Vec<T>>,
     serializer: S,
 ) -> Result<S::Ok, S::Error>
 where
     S: Serializer,
+    T: ToString,
 {
-    match optional_multi_addrs {
+    match serialize_optional_comma_separated(optional_list) {
         None => serializer.serialize_none(),
-        Some(multi_addrs) => {
-            // Call the implemented custom serialization function
-            let s = serialize_multi_addrs(&Some(multi_addrs.clone()));
-            // Serialize the returned String
-            serializer.serialize_some(&s)
-        }
+        Some(s) => serializer.serialize_some(&s),
     }
 }

crates/apollo_deployments/src/config_override.rs

@@ -1,6 +1,9 @@
 use std::collections::BTreeMap;
 
-use apollo_config::converters::deserialize_comma_separated_str;
+use apollo_config::converters::{
+    deserialize_comma_separated_str,
+    serialize_optional_comma_separated,
+};
 use apollo_config::dumping::{
     prepend_sub_config_name,
     ser_optional_param,
@@ -47,9 +50,7 @@ impl SerializeConfig for GatewayConfig {
         ));
         dump.extend(prepend_sub_config_name(self.chain_info.dump(), "chain_info"));
         dump.extend(ser_optional_param(
-            &self.authorized_declarer_accounts.as_ref().map(|accounts| {
-                accounts.iter().map(|addr| addr.0.to_string()).collect::<Vec<_>>().join(",")
-            }),
+            &serialize_optional_comma_separated(&self.authorized_declarer_accounts),
             "".to_string(),
             "authorized_declarer_accounts",
             "Authorized declarer accounts. If set, only these accounts can declare new contracts. \

crates/apollo_gateway_config/src/config.rs

@@ -25,6 +25,7 @@ use apollo_config::converters::{
     deserialize_comma_separated_str,
     deserialize_optional_vec_u8,
     deserialize_seconds_to_duration,
+    serialize_optional_comma_separated,
     serialize_optional_vec_u8,
 };
 use apollo_config::dumping::{
@@ -45,18 +46,6 @@ use validator::{Validate, ValidationError};
 
 pub(crate) type Bytes = Vec<u8>;
 
-// TODO(Tsabary): move to the config converter module.
-pub fn serialize_multi_addrs(multi_addrs: &Option<Vec<Multiaddr>>) -> String {
-    match multi_addrs {
-        None => "".to_owned(),
-        Some(multi_addrs) => multi_addrs
-            .iter()
-            .map(|multiaddr| multiaddr.to_string())
-            .collect::<Vec<String>>()
-            .join(","),
-    }
-}
-
 // TODO(Shahak): add peer manager config to the network config
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Validate)]
 pub struct NetworkConfig {
@@ -123,11 +112,7 @@ impl SerializeConfig for NetworkConfig {
         // TODO(Tsabary): this is not the proper way to dump a config. Needs fixing, and
         // specifically, need to move the condition to be part of the serialization fn.
         config.extend(ser_optional_param(
-            &if self.bootstrap_peer_multiaddr.is_some(){
-                Some(serialize_multi_addrs(&self.bootstrap_peer_multiaddr))
-            } else {
-                None
-            },
+            &serialize_optional_comma_separated(&self.bootstrap_peer_multiaddr),
             String::from(""),
             "bootstrap_peer_multiaddr",
             "The multiaddress of the peer node. It should include the peer's id. For more info: https://docs.libp2p.io/concepts/fundamentals/peers/",