refactor: rename function and clarify some comments after review

dlachaume · dlachaume · commit 7467237f72cc · 2024-04-19T14:24:28.000+02:00
- Rename function 'allow_unparsable_block' to 'compute_allow_unparsable_block' and clarify its comment
- Add reference to pre-production network in 'allow_unparsable_block' comments
diff --git a/.github/workflows/actions/deploy-terraform-infrastructure/action.yml b/.github/workflows/actions/deploy-terraform-infrastructure/action.yml
@@ -101,7 +101,7 @@ inputs:
     description: CExplorer url of the list of pools that is used by the mithril aggregator.
     required: false
   mithril_aggregator_allow_unparsable_block:
-    description: If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on production networks.
+    description: If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on (pre)production networks.
     required: false
     default: "false"
   prometheus_auth_username:
diff --git a/docs/website/root/manual/developer-docs/nodes/mithril-aggregator.md b/docs/website/root/manual/developer-docs/nodes/mithril-aggregator.md
@@ -445,7 +445,7 @@ Here is a list of the available parameters:
 | `signed_entity_types` | `--signed-entity-types` | - | `SIGNED_ENTITY_TYPES` | Signed entity types parameters (discriminants names in an ordered comma separated list) | - | `MithrilStakeDistribution,CardanoImmutableFilesFull,CardanoStakeDistribution` | - |
 | `snapshot_compression_algorithm` | `--snapshot-compression-algorithm` | - | `SNAPSHOT_COMPRESSION_ALGORITHM` | Compression algorithm of the snapshot archive | `zstandard` | `gzip` or `zstandard` | - |
 | `zstandard_parameters` | - | - | `ZSTANDARD_PARAMETERS__LEVEL` and `ZSTANDARD_PARAMETERS__NUMBER_OF_WORKERS` | Zstandard specific parameters | - | `{ level: 9, number_of_workers: 4 }` | - |
-| `allow_unparsable_block` | `--allow-unparsable-block` | - | `ALLOW_UNPARSABLE_BLOCK` | If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on production networks. | `false` | - | - |
+| `allow_unparsable_block` | `--allow-unparsable-block` | - | `ALLOW_UNPARSABLE_BLOCK` | If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on (pre)production networks. | `false` | - | - |
 
 `genesis bootstrap` command:
 
diff --git a/docs/website/root/manual/developer-docs/nodes/mithril-signer.md b/docs/website/root/manual/developer-docs/nodes/mithril-signer.md
@@ -165,7 +165,7 @@ Options:
       --allow-unparsable-block
           If set no error is returned in case of unparsable block and an error log is written instead.
           
-          Will be ignored on production networks.
+          Will be ignored on (pre)production networks.
 
   -h, --help
           Print help (see a summary with '-h')
@@ -251,4 +251,4 @@ Here is a list of the available parameters:
 | `enable_metrics_server` | `--enable-metrics-server` | - | `ENABLE_METRICS_SERVER` | Enable metrics HTTP server (Prometheus endpoint on /metrics) | `false` | - | - |
 | `metrics_server_ip` | `--metrics-server-ip` | - | `METRICS_SERVER_IP` | Metrics HTTP server IP | `0.0.0.0` | - | - |
 | `metrics_server_port` | `--metrics-server-port` | - | `METRICS_SERVER_PORT` | Metrics HTTP server listening port | `9090` | - | - |
-| `allow_unparsable_block` | `--allow-unparsable-block` | - | `ALLOW_UNPARSABLE_BLOCK` | If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on production networks. | `false` | - | - |
+| `allow_unparsable_block` | `--allow-unparsable-block` | - | `ALLOW_UNPARSABLE_BLOCK` | If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on (pre)production networks. | `false` | - | - |
diff --git a/mithril-aggregator/src/commands/serve_command.rs b/mithril-aggregator/src/commands/serve_command.rs
@@ -39,7 +39,7 @@ pub struct ServeCommand {
 
     /// If set no error is returned in case of unparsable block and an error log is written instead.
     ///
-    /// Will be ignored on production networks.
+    /// Will be ignored on (pre)production networks.
     #[clap(long)]
     allow_unparsable_block: bool,
 }
diff --git a/mithril-aggregator/src/configuration.rs b/mithril-aggregator/src/configuration.rs
@@ -150,7 +150,7 @@ pub struct Configuration {
 
     /// If set no error is returned in case of unparsable block and an error log is written instead.
     ///
-    /// Will be ignored on production networks.
+    /// Will be ignored on (pre)production networks.
     pub allow_unparsable_block: bool,
 }
 
@@ -357,7 +357,7 @@ pub struct DefaultConfiguration {
 
     /// If set no error is returned in case of unparsable block and an error log is written instead.
     ///
-    /// Will be ignored on production networks.
+    /// Will be ignored on (pre)production networks.
     pub allow_unparsable_block: String,
 }
 
diff --git a/mithril-aggregator/src/dependency_injection/builder.rs b/mithril-aggregator/src/dependency_injection/builder.rs
@@ -718,7 +718,7 @@ impl DependenciesBuilder {
             self.get_logger().await?,
             self.configuration
                 .get_network()?
-                .allow_unparsable_block(self.configuration.allow_unparsable_block)?,
+                .compute_allow_unparsable_block(self.configuration.allow_unparsable_block)?,
         );
 
         Ok(Arc::new(transaction_parser))
diff --git a/mithril-common/src/entities/cardano_network.rs b/mithril-common/src/entities/cardano_network.rs
@@ -75,9 +75,8 @@ impl CardanoNetwork {
         }
     }
 
-    /// Evaluate the possibility of validating the request to allow unparsable block or not,
-    /// depending on the target Cardano network
-    pub fn allow_unparsable_block(&self, allow_unparsable_block: bool) -> StdResult<bool> {
+    /// Determines whether unparsable blocks should be allowed based on the specific Cardano network.
+    pub fn compute_allow_unparsable_block(&self, allow_unparsable_block: bool) -> StdResult<bool> {
         let allow_unparsable_block = match self {
             CardanoNetwork::MainNet => false,
             CardanoNetwork::TestNet(id) if *id == PREPROD_MAGIC_ID => false,
@@ -158,68 +157,68 @@ mod tests {
     }
 
     #[test]
-    fn allow_unparsable_block_should_always_return_false_on_mainnet_and_preprod() {
+    fn compute_allow_unparsable_block_should_always_return_false_on_mainnet_and_preprod() {
         let allow_unparsable_block = CardanoNetwork::MainNet
-            .allow_unparsable_block(false)
+            .compute_allow_unparsable_block(false)
             .unwrap();
         assert!(!allow_unparsable_block);
 
         let allow_unparsable_block = CardanoNetwork::MainNet
-            .allow_unparsable_block(true)
+            .compute_allow_unparsable_block(true)
             .unwrap();
         assert!(!allow_unparsable_block);
 
         let allow_unparsable_block = CardanoNetwork::TestNet(PREPROD_MAGIC_ID)
-            .allow_unparsable_block(false)
+            .compute_allow_unparsable_block(false)
             .unwrap();
         assert!(!allow_unparsable_block);
 
         let allow_unparsable_block = CardanoNetwork::TestNet(PREPROD_MAGIC_ID)
-            .allow_unparsable_block(true)
+            .compute_allow_unparsable_block(true)
             .unwrap();
         assert!(!allow_unparsable_block);
     }
 
     #[test]
-    fn allow_unparsable_block_should_return_value_passed_in_parameter_on_all_networks_other_than_mainnet_and_preprod(
+    fn compute_allow_unparsable_block_should_return_value_passed_in_parameter_on_all_networks_other_than_mainnet_and_preprod(
     ) {
         let allow_unparsable_block = CardanoNetwork::TestNet(PREVIEW_MAGIC_ID)
-            .allow_unparsable_block(false)
+            .compute_allow_unparsable_block(false)
             .unwrap();
         assert!(!allow_unparsable_block);
 
         let allow_unparsable_block = CardanoNetwork::TestNet(PREVIEW_MAGIC_ID)
-            .allow_unparsable_block(true)
+            .compute_allow_unparsable_block(true)
             .unwrap();
         assert!(allow_unparsable_block);
 
         let allow_unparsable_block = CardanoNetwork::TestNet(SANCHONET_MAGIC_ID)
-            .allow_unparsable_block(false)
+            .compute_allow_unparsable_block(false)
             .unwrap();
         assert!(!allow_unparsable_block);
 
         let allow_unparsable_block = CardanoNetwork::TestNet(SANCHONET_MAGIC_ID)
-            .allow_unparsable_block(true)
+            .compute_allow_unparsable_block(true)
             .unwrap();
         assert!(allow_unparsable_block);
 
         let allow_unparsable_block = CardanoNetwork::TestNet(TESTNET_MAGIC_ID)
-            .allow_unparsable_block(false)
+            .compute_allow_unparsable_block(false)
             .unwrap();
         assert!(!allow_unparsable_block);
 
         let allow_unparsable_block = CardanoNetwork::TestNet(TESTNET_MAGIC_ID)
-            .allow_unparsable_block(true)
+            .compute_allow_unparsable_block(true)
             .unwrap();
         assert!(allow_unparsable_block);
 
         let allow_unparsable_block = CardanoNetwork::DevNet(123)
-            .allow_unparsable_block(false)
+            .compute_allow_unparsable_block(false)
             .unwrap();
         assert!(!allow_unparsable_block);
 
         let allow_unparsable_block = CardanoNetwork::DevNet(123)
-            .allow_unparsable_block(true)
+            .compute_allow_unparsable_block(true)
             .unwrap();
         assert!(allow_unparsable_block);
     }
diff --git a/mithril-infra/variables.tf b/mithril-infra/variables.tf
@@ -251,7 +251,7 @@ variable "mithril_aggregator_cexplorer_pools_url" {
 
 variable "mithril_aggregator_allow_unparsable_block" {
   type        = bool
-  description = "If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on production networks."
+  description = "If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on (pre)production networks."
   default     = false
 }
 
diff --git a/mithril-signer/src/configuration.rs b/mithril-signer/src/configuration.rs
@@ -93,7 +93,7 @@ pub struct Configuration {
 
     /// If set no error is returned in case of unparsable block and an error log is written instead.
     ///
-    /// Will be ignored on production networks.
+    /// Will be ignored on (pre)production networks.
     pub allow_unparsable_block: bool,
 }
 
diff --git a/mithril-signer/src/main.rs b/mithril-signer/src/main.rs
@@ -78,7 +78,7 @@ pub struct Args {
 
     /// If set no error is returned in case of unparsable block and an error log is written instead.
     ///
-    /// Will be ignored on production networks.
+    /// Will be ignored on (pre)production networks.
     #[clap(long)]
     allow_unparsable_block: bool,
 }
diff --git a/mithril-signer/src/runtime/signer_services.rs b/mithril-signer/src/runtime/signer_services.rs
@@ -261,7 +261,7 @@ impl<'a> ServiceBuilder for ProductionServiceBuilder<'a> {
             slog_scope::logger(),
             self.config
                 .get_network()?
-                .allow_unparsable_block(self.config.allow_unparsable_block)?,
+                .compute_allow_unparsable_block(self.config.allow_unparsable_block)?,
         ));
         let transaction_store = Arc::new(CardanoTransactionRepository::new(
             transaction_sqlite_connection,

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ pub struct ServeCommand {`
`39`	`39`
`40`	`40`	`/// If set no error is returned in case of unparsable block and an error log is written instead.`
`41`	`41`	`///`
`42`		`- /// Will be ignored on production networks.`
	`42`	`+ /// Will be ignored on (pre)production networks.`
`43`	`43`	`#[clap(long)]`
`44`	`44`	`allow_unparsable_block: bool,`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ pub struct Configuration {`
`150`	`150`
`151`	`151`	`/// If set no error is returned in case of unparsable block and an error log is written instead.`
`152`	`152`	`///`
`153`		`- /// Will be ignored on production networks.`
	`153`	`+ /// Will be ignored on (pre)production networks.`
`154`	`154`	`pub allow_unparsable_block: bool,`
`155`	`155`	`}`
`156`	`156`
`@@ -357,7 +357,7 @@ pub struct DefaultConfiguration {`
`357`	`357`
`358`	`358`	`/// If set no error is returned in case of unparsable block and an error log is written instead.`
`359`	`359`	`///`
`360`		`- /// Will be ignored on production networks.`
	`360`	`+ /// Will be ignored on (pre)production networks.`
`361`	`361`	`pub allow_unparsable_block: String,`
`362`	`362`	`}`
`363`	`363`
Original file line number	Diff line number	Diff line change
`@@ -251,7 +251,7 @@ variable "mithril_aggregator_cexplorer_pools_url" {`
`251`	`251`
`252`	`252`	`variable "mithril_aggregator_allow_unparsable_block" {`
`253`	`253`	`type = bool`
`254`		`- description = "If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on production networks."`
	`254`	`+ description = "If set no error is returned in case of unparsable block and an error log is written instead. Will be ignored on (pre)production networks."`
`255`	`255`	`default = false`
`256`	`256`	`}`
`257`	`257`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ pub struct Configuration {`
`93`	`93`
`94`	`94`	`/// If set no error is returned in case of unparsable block and an error log is written instead.`
`95`	`95`	`///`
`96`		`- /// Will be ignored on production networks.`
	`96`	`+ /// Will be ignored on (pre)production networks.`
`97`	`97`	`pub allow_unparsable_block: bool,`
`98`	`98`	`}`
`99`	`99`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ pub struct Args {`
`78`	`78`
`79`	`79`	`/// If set no error is returned in case of unparsable block and an error log is written instead.`
`80`	`80`	`///`
`81`		`- /// Will be ignored on production networks.`
	`81`	`+ /// Will be ignored on (pre)production networks.`
`82`	`82`	`#[clap(long)]`
`83`	`83`	`allow_unparsable_block: bool,`
`84`	`84`	`}`