Share common hydration helpers in a Hydrator struct

This struct is the previous `SignedEntityHydrator` renamed and
generalized to works with multiple common types.

Author: Alenar

internal/mithril-persistence/src/database/signed_entity_hydrator.rs renamed to internal/mithril-persistence/src/database/hydrator.rs

@@ -1,17 +1,42 @@
-//! Signed Entity helpers for persistence
+//! Shared hydrator helpers for persistence
 
 use mithril_common::entities::{
     CardanoDbBeacon, Epoch, SignedEntityType, SignedEntityTypeDiscriminants,
 };
 
 use crate::sqlite::HydrationError;
 
-/// Helper struct to hydrate [SignedEntityType].
-pub struct SignedEntityTypeHydrator {}
+/// Helper struct to hydrate common data.
+pub struct Hydrator;
+
+impl Hydrator {
+    /// Read a signed entity beacon column from the database
+    pub fn read_signed_entity_beacon_column<U: sqlite::RowIndex + Clone>(
+        row: &sqlite::Row,
+        column_index: U,
+    ) -> String {
+        // We need to check first that the cell can be read as a string first
+        // (e.g. when beacon json is '{"network": "dev", "epoch": 1, "immutable_file_number": 2}').
+        // If it fails, we fallback on reading the cell as an integer (e.g. when beacon json is '5').
+        // TODO: Maybe there is a better way of doing this.
+        match row.try_read::<&str, _>(column_index.clone()) {
+            Ok(value) => value.to_string(),
+            Err(_) => (row.read::<i64, _>(column_index)).to_string(),
+        }
+    }
+
+    /// Try to convert an i64 field from the database to a u64
+    pub fn try_to_u64(field: &str, value: i64) -> Result<u64, HydrationError> {
+        u64::try_from(value)
+            .map_err(|e|
+                HydrationError::InvalidData(
+                    format!("Integer field {field} (value={value}) is incompatible with u64 representation. Error = {e}")
+                )
+            )
+    }
 
-impl SignedEntityTypeHydrator {
     /// Create a [SignedEntityType] from data coming from the database
-    pub fn hydrate(
+    pub fn hydrate_signed_entity_type(
         signed_entity_type_id: usize,
         beacon_str: &str,
     ) -> Result<SignedEntityType, HydrationError> {

internal/mithril-persistence/src/database/mod.rs

@@ -3,14 +3,14 @@
 
 pub mod cardano_transaction_migration;
 mod db_version;
+mod hydrator;
 pub(crate) mod provider;
 pub mod record;
 pub mod repository;
-mod signed_entity_hydrator;
 mod version_checker;
 
 pub use db_version::*;
-pub use signed_entity_hydrator::SignedEntityTypeHydrator;
+pub use hydrator::Hydrator;
 pub use version_checker::{DatabaseVersionChecker, SqlMigration};
 
 /// Database version.

internal/mithril-persistence/src/database/record/block_range_root.rs

@@ -3,7 +3,7 @@ use sqlite::Row;
 use mithril_common::crypto_helper::MKTreeNode;
 use mithril_common::entities::BlockRange;
 
-use crate::database::record::hydrator::try_to_u64;
+use crate::database::Hydrator;
 use crate::sqlite::{HydrationError, Projection, SqLiteEntity};
 
 /// Block range root record is the representation of block range with its merkle root precomputed.
@@ -35,8 +35,8 @@ impl SqLiteEntity for BlockRangeRootRecord {
     where
         Self: Sized,
     {
-        let start = try_to_u64("block_range.start", row.read::<i64, _>(0))?;
-        let end = try_to_u64("block_range.end", row.read::<i64, _>(1))?;
+        let start = Hydrator::try_to_u64("block_range.start", row.read::<i64, _>(0))?;
+        let end = Hydrator::try_to_u64("block_range.end", row.read::<i64, _>(1))?;
         let range = BlockRange::from_block_number(start);
         let merkle_root = row.read::<&str, _>(2);
 
@@ -69,10 +69,12 @@ impl SqLiteEntity for BlockRangeRootRecord {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use mithril_common::entities::BlockNumber;
     use sqlite::Connection;
 
+    use mithril_common::entities::BlockNumber;
+
+    use super::*;
+
     fn select_block_range_from_db(start: BlockNumber, end: BlockNumber, merkle_root: &str) -> Row {
         let conn = Connection::open(":memory:").unwrap();
         let query = format!("SELECT {start}, {end}, '{merkle_root}'");

internal/mithril-persistence/src/database/record/cardano_transaction.rs

@@ -4,6 +4,7 @@ use mithril_common::entities::{
     BlockHash, BlockNumber, CardanoTransaction, ImmutableFileNumber, SlotNumber, TransactionHash,
 };
 
+use crate::database::Hydrator;
 use crate::sqlite::{HydrationError, Projection, SqLiteEntity};
 
 /// Cardano Transaction record is the representation of a cardano transaction.
@@ -73,17 +74,12 @@ impl SqLiteEntity for CardanoTransactionRecord {
     where
         Self: Sized,
     {
-        // TODO: generalize this method to other hydrator
-        fn try_to_u64(field: &str, value: i64) -> Result<u64, HydrationError> {
-            u64::try_from(value)
-                .map_err(|e| HydrationError::InvalidData(format!("Integer field cardano_tx.{field} (value={value}) is incompatible with u64 representation. Error = {e}")))
-        }
-
         let transaction_hash = row.read::<&str, _>(0);
-        let block_number = try_to_u64("block_number", row.read::<i64, _>(1))?;
-        let slot_number = try_to_u64("slot_number", row.read::<i64, _>(2))?;
+        let block_number = Hydrator::try_to_u64("cardano_tx.block_number", row.read::<i64, _>(1))?;
+        let slot_number = Hydrator::try_to_u64("cardano_tx.slot_number", row.read::<i64, _>(2))?;
         let block_hash = row.read::<&str, _>(3);
-        let immutable_file_number = try_to_u64("immutable_file_number", row.read::<i64, _>(4))?;
+        let immutable_file_number =
+            Hydrator::try_to_u64("cardano_tx.immutable_file_number", row.read::<i64, _>(4))?;
 
         Ok(Self {
             transaction_hash: transaction_hash.to_string(),

internal/mithril-persistence/src/database/record/interval_without_block_range_root.rs

@@ -6,7 +6,7 @@ use sqlite::Row;
 use mithril_common::entities::BlockNumber;
 use mithril_common::StdResult;
 
-use crate::database::record::hydrator::try_to_u64;
+use crate::database::Hydrator;
 use crate::sqlite::{HydrationError, Projection, SqLiteEntity};
 
 /// Interval of block numbers (`[start, end[`) without block ranges root.
@@ -47,11 +47,11 @@ impl SqLiteEntity for IntervalWithoutBlockRangeRootRecord {
     {
         let start = row
             .read::<Option<i64>, _>(0)
-            .map(|v| try_to_u64("interval_start.start", v))
+            .map(|v| Hydrator::try_to_u64("interval_start.start", v))
             .transpose()?;
         let end = row
             .read::<Option<i64>, _>(1)
-            .map(|v| try_to_u64("interval_end.end", v))
+            .map(|v| Hydrator::try_to_u64("interval_end.end", v))
             .transpose()?;
 
         Ok(Self { start, end })

internal/mithril-persistence/src/database/record/mod.rs

@@ -7,31 +7,3 @@ mod interval_without_block_range_root;
 pub use block_range_root::*;
 pub use cardano_transaction::*;
 pub use interval_without_block_range_root::*;
-
-// TODO: this probably should be in `mithril-persistence` crate
-pub(crate) mod hydrator {
-    use crate::sqlite::HydrationError;
-
-    pub fn read_signed_entity_beacon_column<U: sqlite::RowIndex + Clone>(
-        row: &sqlite::Row,
-        column_index: U,
-    ) -> String {
-        // TODO: We need to check first that the cell can be read as a string first
-        // (e.g. when beacon json is '{"network": "dev", "epoch": 1, "immutable_file_number": 2}').
-        // If it fails, we fallback on reading the cell as an integer (e.g. when beacon json is '5').
-        // Maybe there is a better way of doing this.
-        match row.try_read::<&str, _>(column_index.clone()) {
-            Ok(value) => value.to_string(),
-            Err(_) => (row.read::<i64, _>(column_index)).to_string(),
-        }
-    }
-
-    pub fn try_to_u64(field: &str, value: i64) -> Result<u64, HydrationError> {
-        u64::try_from(value)
-            .map_err(|e|
-                HydrationError::InvalidData(
-                    format!("Integer field {field} (value={value}) is incompatible with u64 representation. Error = {e}")
-                )
-            )
-    }
-}

mithril-aggregator/src/database/record/block_range_root.rs

@@ -2,10 +2,9 @@ use sqlite::Row;
 
 use mithril_common::crypto_helper::MKTreeNode;
 use mithril_common::entities::BlockRange;
+use mithril_persistence::database::Hydrator;
 use mithril_persistence::sqlite::{HydrationError, Projection, SqLiteEntity};
 
-use crate::database::record::hydrator::try_to_u64;
-
 /// Block range root record is the representation of block range with its merkle root precomputed.
 #[derive(Debug, PartialEq, Clone)]
 pub struct BlockRangeRootRecord {
@@ -35,8 +34,8 @@ impl SqLiteEntity for BlockRangeRootRecord {
     where
         Self: Sized,
     {
-        let start = try_to_u64("block_range.start", row.read::<i64, _>(0))?;
-        let end = try_to_u64("block_range.end", row.read::<i64, _>(1))?;
+        let start = Hydrator::try_to_u64("block_range.start", row.read::<i64, _>(0))?;
+        let end = Hydrator::try_to_u64("block_range.end", row.read::<i64, _>(1))?;
         let range = BlockRange::from_block_number(start);
         let merkle_root = row.read::<&str, _>(2);
 
@@ -69,10 +68,12 @@ impl SqLiteEntity for BlockRangeRootRecord {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use mithril_common::entities::BlockNumber;
     use sqlite::Connection;
 
+    use mithril_common::entities::BlockNumber;
+
+    use super::*;
+
     fn select_block_range_from_db(start: BlockNumber, end: BlockNumber, merkle_root: &str) -> Row {
         let conn = Connection::open(":memory:").unwrap();
         let query = format!("SELECT {start}, {end}, '{merkle_root}'");

mithril-aggregator/src/database/record/cardano_transaction.rs

@@ -3,6 +3,7 @@ use sqlite::Row;
 use mithril_common::entities::{
     BlockHash, BlockNumber, CardanoTransaction, ImmutableFileNumber, SlotNumber, TransactionHash,
 };
+use mithril_persistence::database::Hydrator;
 use mithril_persistence::sqlite::{HydrationError, Projection, SqLiteEntity};
 
 /// Cardano Transaction record is the representation of a cardano transaction.
@@ -53,17 +54,12 @@ impl SqLiteEntity for CardanoTransactionRecord {
     where
         Self: Sized,
     {
-        // TODO: generalize this method to other hydrator
-        fn try_to_u64(field: &str, value: i64) -> Result<u64, HydrationError> {
-            u64::try_from(value)
-                .map_err(|e| HydrationError::InvalidData(format!("Integer field cardano_tx.{field} (value={value}) is incompatible with u64 representation. Error = {e}")))
-        }
-
         let transaction_hash = row.read::<&str, _>(0);
-        let block_number = try_to_u64("block_number", row.read::<i64, _>(1))?;
-        let slot_number = try_to_u64("slot_number", row.read::<i64, _>(2))?;
+        let block_number = Hydrator::try_to_u64("cardano_tx.block_number", row.read::<i64, _>(1))?;
+        let slot_number = Hydrator::try_to_u64("cardano_tx.slot_number", row.read::<i64, _>(2))?;
         let block_hash = row.read::<&str, _>(3);
-        let immutable_file_number = try_to_u64("immutable_file_number", row.read::<i64, _>(4))?;
+        let immutable_file_number =
+            Hydrator::try_to_u64("cardano_tx.immutable_file_number", row.read::<i64, _>(4))?;
 
         Ok(Self {
             transaction_hash: transaction_hash.to_string(),

mithril-aggregator/src/database/record/certificate.rs

@@ -13,12 +13,10 @@ use mithril_common::messages::{
 #[cfg(test)]
 use mithril_common::test_utils::{fake_data, fake_keys};
 use mithril_persistence::{
-    database::SignedEntityTypeHydrator,
+    database::Hydrator,
     sqlite::{HydrationError, Projection, SqLiteEntity},
 };
 
-use crate::database::record::hydrator;
-
 era_deprecate!("Remove immutable_file_number");
 /// Certificate record is the representation of a stored certificate.
 #[derive(Debug, PartialEq, Clone)]
@@ -314,7 +312,7 @@ impl SqLiteEntity for CertificateRecord {
         let network = row.read::<&str, _>(6).to_string();
         let immutable_file_number = row.read::<i64, _>(7);
         let signed_entity_type_id = row.read::<i64, _>(8);
-        let signed_entity_beacon_string = hydrator::read_signed_entity_beacon_column(&row, 9);
+        let signed_entity_beacon_string = Hydrator::read_signed_entity_beacon_column(&row, 9);
         let protocol_version = row.read::<&str, _>(10).to_string();
         let protocol_parameters_string = row.read::<&str, _>(11);
         let protocol_message_string = row.read::<&str, _>(12);
@@ -339,7 +337,7 @@ impl SqLiteEntity for CertificateRecord {
                     "Could not cast i64 ({immutable_file_number}) to u64. Error: '{e}'"
                 ))
             })?,
-            signed_entity_type: SignedEntityTypeHydrator::hydrate(
+            signed_entity_type: Hydrator::hydrate_signed_entity_type(
                 signed_entity_type_id.try_into().map_err(|e| {
                     HydrationError::InvalidData(format!(
                         "Could not cast i64 ({signed_entity_type_id}) to u64. Error: '{e}'"

mithril-aggregator/src/database/record/interval_without_block_range_root.rs

@@ -5,10 +5,9 @@ use sqlite::Row;
 
 use mithril_common::entities::BlockNumber;
 use mithril_common::StdResult;
+use mithril_persistence::database::Hydrator;
 use mithril_persistence::sqlite::{HydrationError, Projection, SqLiteEntity};
 
-use crate::database::record::hydrator::try_to_u64;
-
 /// Interval of block numbers (`[start, end[`) without block ranges root.
 pub struct IntervalWithoutBlockRangeRootRecord {
     /// Start of the interval, fetched from the last block range root end
@@ -47,11 +46,11 @@ impl SqLiteEntity for IntervalWithoutBlockRangeRootRecord {
     {
         let start = row
             .read::<Option<i64>, _>(0)
-            .map(|v| try_to_u64("interval_start.start", v))
+            .map(|v| Hydrator::try_to_u64("interval_start.start", v))
             .transpose()?;
         let end = row
             .read::<Option<i64>, _>(1)
-            .map(|v| try_to_u64("interval_end.end", v))
+            .map(|v| Hydrator::try_to_u64("interval_end.end", v))
             .transpose()?;
 
         Ok(Self { start, end })