Merge pull request #1228 from input-output-hk/damien/798/implement-anyhow-for-digesters

Implement anyhow context for digesters

Author: dlachaume

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.3.87"
+version = "0.3.88"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-aggregator/Cargo.toml

@@ -5,6 +5,7 @@
 
 use std::sync::Arc;
 
+use anyhow::Context;
 use async_trait::async_trait;
 use mithril_common::{
     chain_observer::ChainObserver,
@@ -70,7 +71,15 @@ impl TickerService for MithrilTickerService {
 
     async fn get_current_immutable_beacon(&self) -> StdResult<Beacon> {
         let epoch = self.get_current_epoch().await?;
-        let immutable_file_number = self.immutable_observer.get_last_immutable_number().await?;
+        let immutable_file_number = self
+            .immutable_observer
+            .get_last_immutable_number()
+            .await
+            .with_context(|| {
+                format!(
+                    "Mithril Ticker Service can not get last immutable file number for epoch: '{epoch}'"
+                )
+            })?;
 
         Ok(Beacon::new(
             self.network.to_string(),

mithril-aggregator/src/services/ticker.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.2.110"
+version = "0.2.111"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }

mithril-common/Cargo.toml

@@ -58,15 +58,18 @@ impl BeaconProvider for BeaconProviderImpl {
             .get_current_epoch()
             .await
             .map_err(|e| anyhow!(e))
-            .with_context(|| "Can not get current epoch")?
+            .with_context(|| "Beacon Provider can not get current epoch")?
             .ok_or(BeaconProviderError::NoEpoch())?;
 
         let immutable_file_number = self
             .immutable_observer
             .get_last_immutable_number()
             .await
-            .map_err(|e| anyhow!(e))
-            .with_context(|| "Can not get last immutable file number")?;
+            .with_context(|| {
+                format!(
+                    "Beacon Provider can not get last immutable file number for epoch: '{epoch}'"
+                )
+            })?;
 
         let beacon = Beacon {
             network: self.network.to_string(),

mithril-common/src/beacon_provider.rs

@@ -1,6 +1,7 @@
-use crate::digesters::{ImmutableFile, ImmutableFileListingError};
+use crate::digesters::ImmutableFile;
 use crate::entities::ImmutableFileNumber;
-use crate::StdResult;
+use crate::{StdError, StdResult};
+use anyhow::{anyhow, Context};
 use async_trait::async_trait;
 use std::ops::Add;
 use std::path::PathBuf;
@@ -14,7 +15,7 @@ where
     Self: Sync + Send,
 {
     /// Get the [ImmutableFileNumber] of the last immutable file in the cardano database.
-    async fn get_last_immutable_number(&self) -> Result<u64, ImmutableFileObserverError>;
+    async fn get_last_immutable_number(&self) -> StdResult<u64>;
 }
 
 /// [ImmutableFileObserver] related errors.
@@ -26,7 +27,7 @@ pub enum ImmutableFileObserverError {
 
     /// Raised when [immutable file listing][ImmutableFile::list_completed_in_dir] fails.
     #[error("immutable file creation error: {0}")]
-    ImmutableFileListing(#[from] ImmutableFileListingError),
+    ImmutableFileListing(StdError),
 }
 
 /// An [ImmutableFileObserver] using the filesystem.
@@ -45,11 +46,13 @@ impl ImmutableFileSystemObserver {
 
 #[async_trait]
 impl ImmutableFileObserver for ImmutableFileSystemObserver {
-    async fn get_last_immutable_number(&self) -> Result<u64, ImmutableFileObserverError> {
-        let immutable_file_number = ImmutableFile::list_completed_in_dir(&self.db_path)?
+    async fn get_last_immutable_number(&self) -> StdResult<u64> {
+        let immutable_file_number = ImmutableFile::list_completed_in_dir(&self.db_path)
+            .map_err(|e| anyhow!(e))
+            .with_context(|| "Immutable File System Observer can not list all immutable files")?
             .into_iter()
             .last()
-            .ok_or(ImmutableFileObserverError::Missing())?
+            .ok_or(anyhow!(ImmutableFileObserverError::Missing()))?
             .number;
 
         Ok(immutable_file_number)
@@ -104,11 +107,11 @@ impl DumbImmutableFileObserver {
 
 #[async_trait]
 impl ImmutableFileObserver for DumbImmutableFileObserver {
-    async fn get_last_immutable_number(&self) -> Result<u64, ImmutableFileObserverError> {
+    async fn get_last_immutable_number(&self) -> StdResult<u64> {
         self.shall_return
             .read()
             .await
-            .ok_or_else(ImmutableFileObserverError::Missing)
+            .ok_or_else(|| anyhow!(ImmutableFileObserverError::Missing()))
     }
 }
 

mithril-common/src/digesters/immutable_file_observer.rs

@@ -9,6 +9,7 @@ use crate::{
     signable_builder::SignableBuilder,
     StdResult,
 };
+use anyhow::Context;
 use async_trait::async_trait;
 use slog::{debug, info, Logger};
 
@@ -41,7 +42,13 @@ impl SignableBuilder<Beacon> for CardanoImmutableFilesFullSignableBuilder {
         let digest = self
             .immutable_digester
             .compute_digest(&self.dirpath, &beacon)
-            .await?;
+            .await
+            .with_context(|| {
+                format!(
+                    "Cardano Immutable Files Full Signable Builder can not compute digest of '{}'",
+                    &self.dirpath.display()
+                )
+            })?;
         info!(self.logger, "SignableBuilder: digest = '{digest}'.");
         let mut protocol_message = ProtocolMessage::new();
         protocol_message.set_message_part(ProtocolMessagePartKey::SnapshotDigest, digest);

mithril-common/src/signable_builder/cardano_immutable_full_signable_builder.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-signer"
-version = "0.2.76"
+version = "0.2.77"
 description = "A Mithril Signer"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-signer/Cargo.toml

@@ -302,7 +302,7 @@ impl StateMachineTester {
             .immutable_observer
             .get_last_immutable_number()
             .await
-            .map_err(|e| TestError::SubsystemError(e.into()))?;
+            .map_err(TestError::SubsystemError)?;
         let new_immutable = immutable_number + increment;
         self.assert(
             expected == new_immutable,

mithril-signer/tests/test_extensions/state_machine_tester.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-end-to-end"
-version = "0.2.12"
+version = "0.2.13"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }