refactor: introduce SignableBuilderServiceDependencies to simplify MithrilSignableBuilderService constructor

It reduces the number of parameters in the constructor by encapsulating dependencies into a single struct.

Author: dlachaume

mithril-aggregator/src/dependency_injection/builder.rs

@@ -37,8 +37,8 @@ use mithril_common::{
     signable_builder::{
         CardanoImmutableFilesFullSignableBuilder, CardanoStakeDistributionSignableBuilder,
         CardanoTransactionsSignableBuilder, MithrilSignableBuilderService,
-        MithrilStakeDistributionSignableBuilder, SignableBuilderService, SignableSeedBuilder,
-        TransactionsImporter,
+        MithrilStakeDistributionSignableBuilder, SignableBuilderService,
+        SignableBuilderServiceDependencies, SignableSeedBuilder, TransactionsImporter,
     },
     signed_entity_type_lock::SignedEntityTypeLock,
     MithrilTickerService, TickerService,
@@ -1129,13 +1129,16 @@ impl DependenciesBuilder {
             CardanoStakeDistributionSignableBuilder::new(self.get_stake_store().await?),
         );
         let era_checker = self.get_era_checker().await?;
-        let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(
-            era_checker,
-            seed_signable_builder,
+        let signable_builders_dependencies = SignableBuilderServiceDependencies::new(
             mithril_stake_distribution_builder,
             immutable_signable_builder,
             cardano_transactions_builder,
             cardano_stake_distribution_builder,
+        );
+        let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(
+            era_checker,
+            seed_signable_builder,
+            signable_builders_dependencies,
             self.root_logger(),
         ));
 

mithril-common/src/signable_builder/signable_builder_service.rs

@@ -36,24 +36,47 @@ pub struct MithrilSignableBuilderService {
     logger: Logger,
 }
 
-impl MithrilSignableBuilderService {
-    /// MithrilSignableBuilderService factory
+/// SignableBuilders dependencies required by the [MithrilSignableBuilderService].
+pub struct SignableBuilderServiceDependencies {
+    mithril_stake_distribution_builder: Arc<dyn SignableBuilder<Epoch>>,
+    immutable_signable_builder: Arc<dyn SignableBuilder<CardanoDbBeacon>>,
+    cardano_transactions_signable_builder: Arc<dyn SignableBuilder<BlockNumber>>,
+    cardano_stake_distribution_builder: Arc<dyn SignableBuilder<Epoch>>,
+}
+
+impl SignableBuilderServiceDependencies {
+    /// Create a new instance of [SignableBuilderServiceDependencies].
     pub fn new(
-        era_checker: Arc<EraChecker>,
-        seed_signable_builder: Arc<dyn SignableSeedBuilder>,
         mithril_stake_distribution_builder: Arc<dyn SignableBuilder<Epoch>>,
         immutable_signable_builder: Arc<dyn SignableBuilder<CardanoDbBeacon>>,
         cardano_transactions_signable_builder: Arc<dyn SignableBuilder<BlockNumber>>,
         cardano_stake_distribution_builder: Arc<dyn SignableBuilder<Epoch>>,
-        logger: Logger,
     ) -> Self {
         Self {
-            era_checker,
-            seed_signable_builder,
             mithril_stake_distribution_builder,
             immutable_signable_builder,
             cardano_transactions_signable_builder,
             cardano_stake_distribution_builder,
+        }
+    }
+}
+
+impl MithrilSignableBuilderService {
+    /// MithrilSignableBuilderService factory
+    pub fn new(
+        era_checker: Arc<EraChecker>,
+        seed_signable_builder: Arc<dyn SignableSeedBuilder>,
+        dependencies: SignableBuilderServiceDependencies,
+        logger: Logger,
+    ) -> Self {
+        Self {
+            era_checker,
+            seed_signable_builder,
+            mithril_stake_distribution_builder: dependencies.mithril_stake_distribution_builder,
+            immutable_signable_builder: dependencies.immutable_signable_builder,
+            cardano_transactions_signable_builder: dependencies
+                .cardano_transactions_signable_builder,
+            cardano_stake_distribution_builder: dependencies.cardano_stake_distribution_builder,
             logger: logger.new_with_component_name::<Self>(),
         }
     }
@@ -200,13 +223,17 @@ mod tests {
         }
 
         fn build_signable_builder_service(self) -> MithrilSignableBuilderService {
-            MithrilSignableBuilderService::new(
-                Arc::new(self.era_checker),
-                Arc::new(self.mock_signable_seed_builder),
+            let dependencies = SignableBuilderServiceDependencies::new(
                 Arc::new(self.mock_mithril_stake_distribution_signable_builder),
                 Arc::new(self.mock_cardano_immutable_files_full_signable_builder),
                 Arc::new(self.mock_cardano_transactions_signable_builder),
                 Arc::new(self.mock_cardano_stake_distribution_signable_builder),
+            );
+
+            MithrilSignableBuilderService::new(
+                Arc::new(self.era_checker),
+                Arc::new(self.mock_signable_seed_builder),
+                dependencies,
                 TestLogger::stdout(),
             )
         }

mithril-signer/src/dependency_injection/builder.rs

@@ -24,7 +24,7 @@ use mithril_common::era::{EraChecker, EraReader};
 use mithril_common::signable_builder::{
     CardanoImmutableFilesFullSignableBuilder, CardanoStakeDistributionSignableBuilder,
     CardanoTransactionsSignableBuilder, MithrilSignableBuilderService,
-    MithrilStakeDistributionSignableBuilder,
+    MithrilStakeDistributionSignableBuilder, SignableBuilderServiceDependencies,
 };
 use mithril_common::signed_entity_type_lock::SignedEntityTypeLock;
 use mithril_common::{MithrilTickerService, StdResult, TickerService};
@@ -342,13 +342,16 @@ impl<'a> DependenciesBuilder<'a> {
             epoch_service.clone(),
             protocol_initializer_store.clone(),
         ));
-        let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(
-            era_checker.clone(),
-            signable_seed_builder_service,
+        let signable_builders_dependencies = SignableBuilderServiceDependencies::new(
             mithril_stake_distribution_signable_builder,
             cardano_immutable_snapshot_builder,
             cardano_transactions_builder,
             cardano_stake_distribution_signable_builder,
+        );
+        let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(
+            era_checker.clone(),
+            signable_seed_builder_service,
+            signable_builders_dependencies,
             self.root_logger(),
         ));
         let metrics_service = Arc::new(MetricsService::new(self.root_logger())?);

mithril-signer/src/runtime/runner.rs

@@ -327,6 +327,7 @@ impl Runner for SignerRunner {
 
 #[cfg(test)]
 mod tests {
+    use mithril_common::signable_builder::SignableBuilderServiceDependencies;
     use mockall::mock;
     use mockall::predicate::eq;
     use std::collections::BTreeSet;
@@ -464,13 +465,16 @@ mod tests {
             epoch_service.clone(),
             protocol_initializer_store.clone(),
         ));
-        let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(
-            era_checker.clone(),
-            signable_seed_builder_service,
+        let signable_builders_dependencies = SignableBuilderServiceDependencies::new(
             mithril_stake_distribution_signable_builder,
             cardano_immutable_signable_builder,
             cardano_transactions_builder,
             cardano_stake_distribution_builder,
+        );
+        let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(
+            era_checker.clone(),
+            signable_seed_builder_service,
+            signable_builders_dependencies,
             logger.clone(),
         ));
         let metrics_service = Arc::new(MetricsService::new(logger.clone()).unwrap());

mithril-signer/tests/test_extensions/state_machine_tester.rs

@@ -30,7 +30,7 @@ use mithril_common::{
     signable_builder::{
         CardanoImmutableFilesFullSignableBuilder, CardanoStakeDistributionSignableBuilder,
         CardanoTransactionsSignableBuilder, MithrilSignableBuilderService,
-        MithrilStakeDistributionSignableBuilder,
+        MithrilStakeDistributionSignableBuilder, SignableBuilderServiceDependencies,
     },
     signed_entity_type_lock::SignedEntityTypeLock,
     MithrilTickerService, StdError, TickerService,
@@ -225,13 +225,16 @@ impl StateMachineTester {
             epoch_service.clone(),
             protocol_initializer_store.clone(),
         ));
-        let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(
-            era_checker.clone(),
-            signable_seed_builder_service,
+        let signable_builders_dependencies = SignableBuilderServiceDependencies::new(
             mithril_stake_distribution_signable_builder,
             cardano_immutable_snapshot_builder,
             cardano_transactions_builder,
             cardano_stake_distribution_builder,
+        );
+        let signable_builder_service = Arc::new(MithrilSignableBuilderService::new(
+            era_checker.clone(),
+            signable_seed_builder_service,
+            signable_builders_dependencies,
             logger.clone(),
         ));
         let metrics_service = Arc::new(MetricsService::new(logger.clone()).unwrap());