apollo_infra: add component config validations

Author: nadin-Starkware

crates/apollo_node/src/config/component_execution_config.rs

@@ -254,16 +254,54 @@ fn validate_max_concurrency(max_concurrency: usize) -> Result<(), ValidationErro
         Ok(())
     } else {
         Err(create_validation_error(
-            format!("Invalid max_concurrency: {}", max_concurrency),
+            format!("Invalid max_concurrency: {max_concurrency}"),
             "Invalid max concurrency",
             "Ensure the max concurrency is greater than 0.",
         ))
     }
 }
 
+fn check_expectation(
+    field: &'static str,
+    has: bool,
+    required: bool,
+    execution_mode: &ReactiveComponentExecutionMode,
+) -> Result<(), ValidationError> {
+    if required && !has {
+        return Err(create_validation_error(
+            format!("{field} config is required when execution mode is {execution_mode:?}."),
+            "Missing expected server config.",
+            "Ensure the server config is set.",
+        ));
+    }
+    if !required && has {
+        return Err(create_validation_error(
+            format!("{field} config should not be set when execution mode is {execution_mode:?}."),
+            "Unexpected server config.",
+            "Ensure the server config is not set.",
+        ));
+    }
+    Ok(())
+}
+
 fn validate_reactive_component_execution_config(
     component_config: &ReactiveComponentExecutionConfig,
 ) -> Result<(), ValidationError> {
+    // Validate the execution mode matches presence/absence of local and remote server configs.
+    let has_local = component_config.local_server_config.is_some();
+    let has_remote = component_config.remote_client_config.is_some();
+
+    // Expected local and remote server configs expected values based on the execution mode.
+    let (local_req, remote_req) = match &component_config.execution_mode {
+        ReactiveComponentExecutionMode::Disabled => (false, false),
+        ReactiveComponentExecutionMode::Remote => (false, true),
+        ReactiveComponentExecutionMode::LocalExecutionWithRemoteDisabled
+        | ReactiveComponentExecutionMode::LocalExecutionWithRemoteEnabled => (true, false),
+    };
+    check_expectation("local server", has_local, local_req, &component_config.execution_mode)?;
+    check_expectation("remote client", has_remote, remote_req, &component_config.execution_mode)?;
+
+    // Validate the execution mode matches socket validity.
     match (&component_config.execution_mode, component_config.is_valid_socket()) {
         (ReactiveComponentExecutionMode::Disabled, _) => Ok(()),
         (ReactiveComponentExecutionMode::Remote, true)

crates/apollo_node/src/config/config_test.rs

@@ -37,48 +37,48 @@ const VALID_PORT: u16 = 8080;
 #[rstest]
 #[case::local(
     ReactiveComponentExecutionMode::Disabled,
-    LocalServerConfig::default(),
-    RemoteClientConfig::default(),
+    None,
+    None,
     VALID_URL,
     VALID_IP,
     VALID_PORT
 )]
 #[case::local(
     ReactiveComponentExecutionMode::Remote,
-    LocalServerConfig::default(),
-    RemoteClientConfig::default(),
+    None,
+    Some(RemoteClientConfig::default()),
     VALID_URL,
     VALID_IP,
     VALID_PORT
 )]
 #[case::local(
     LOCAL_EXECUTION_MODE,
-    LocalServerConfig::default(),
-    RemoteClientConfig::default(),
+    Some(LocalServerConfig::default()),
+    None,
     VALID_URL,
     VALID_IP,
     VALID_PORT
 )]
 #[case::remote(
     ENABLE_REMOTE_CONNECTION_MODE,
-    LocalServerConfig::default(),
-    RemoteClientConfig::default(),
+    Some(LocalServerConfig::default()),
+    None,
     VALID_URL,
     VALID_IP,
     VALID_PORT
 )]
 fn valid_component_execution_config(
     #[case] execution_mode: ReactiveComponentExecutionMode,
-    #[case] local_server_config: LocalServerConfig,
-    #[case] remote_client_config: RemoteClientConfig,
+    #[case] local_server_config: Option<LocalServerConfig>,
+    #[case] remote_client_config: Option<RemoteClientConfig>,
     #[case] url: &str,
     #[case] ip: IpAddr,
     #[case] port: u16,
 ) {
     let component_exe_config = ReactiveComponentExecutionConfig {
         execution_mode,
-        local_server_config: Some(local_server_config),
-        remote_client_config: Some(remote_client_config),
+        local_server_config,
+        remote_client_config,
         max_concurrency: 1,
         url: url.to_string(),
         ip,

crates/apollo_node/src/config/node_config.rs

@@ -278,8 +278,9 @@ impl Default for SequencerNodeConfig {
     }
 }
 
-macro_rules! ensure_component_config_matches_mode {
+macro_rules! validate_component_config_is_set_iff_running_locally {
     ($self:ident, $component_field:ident, $config_field:ident) => {{
+        // The component config should be set iff its running locally.
         if $self.components.$component_field.is_running_locally() != $self.$config_field.is_some() {
             let execution_mode = &$self.components.$component_field.execution_mode;
             let component_config_availability =
@@ -314,33 +315,57 @@ impl SequencerNodeConfig {
 
     fn cross_member_validations(&self) -> Result<(), ConfigError> {
         // TODO(Tsabary): should be based on iteration of `ComponentConfig` fields.
-        ensure_component_config_matches_mode!(self, batcher, batcher_config);
-        ensure_component_config_matches_mode!(self, class_manager, class_manager_config);
-        ensure_component_config_matches_mode!(self, gateway, gateway_config);
-        ensure_component_config_matches_mode!(
+        validate_component_config_is_set_iff_running_locally!(self, batcher, batcher_config);
+        validate_component_config_is_set_iff_running_locally!(
+            self,
+            class_manager,
+            class_manager_config
+        );
+        validate_component_config_is_set_iff_running_locally!(self, gateway, gateway_config);
+        validate_component_config_is_set_iff_running_locally!(
             self,
             l1_endpoint_monitor,
             l1_endpoint_monitor_config
         );
-        ensure_component_config_matches_mode!(self, l1_provider, l1_provider_config);
-        ensure_component_config_matches_mode!(
+        validate_component_config_is_set_iff_running_locally!(
+            self,
+            l1_provider,
+            l1_provider_config
+        );
+        validate_component_config_is_set_iff_running_locally!(
             self,
             l1_gas_price_provider,
             l1_gas_price_provider_config
         );
-        ensure_component_config_matches_mode!(self, mempool, mempool_config);
-        ensure_component_config_matches_mode!(self, mempool_p2p, mempool_p2p_config);
-        ensure_component_config_matches_mode!(self, sierra_compiler, sierra_compiler_config);
-        ensure_component_config_matches_mode!(self, state_sync, state_sync_config);
-        ensure_component_config_matches_mode!(self, consensus_manager, consensus_manager_config);
-        ensure_component_config_matches_mode!(self, http_server, http_server_config);
-        ensure_component_config_matches_mode!(self, l1_scraper, l1_scraper_config);
-        ensure_component_config_matches_mode!(
+        validate_component_config_is_set_iff_running_locally!(self, mempool, mempool_config);
+        validate_component_config_is_set_iff_running_locally!(
+            self,
+            mempool_p2p,
+            mempool_p2p_config
+        );
+        validate_component_config_is_set_iff_running_locally!(
+            self,
+            sierra_compiler,
+            sierra_compiler_config
+        );
+        validate_component_config_is_set_iff_running_locally!(self, state_sync, state_sync_config);
+        validate_component_config_is_set_iff_running_locally!(
+            self,
+            consensus_manager,
+            consensus_manager_config
+        );
+        validate_component_config_is_set_iff_running_locally!(
+            self,
+            http_server,
+            http_server_config
+        );
+        validate_component_config_is_set_iff_running_locally!(self, l1_scraper, l1_scraper_config);
+        validate_component_config_is_set_iff_running_locally!(
             self,
             l1_gas_price_scraper,
             l1_gas_price_scraper_config
         );
-        ensure_component_config_matches_mode!(
+        validate_component_config_is_set_iff_running_locally!(
             self,
             monitoring_endpoint,
             monitoring_endpoint_config