Suffix open message database type with "record"

Co-authored-by: Grégoire HUBERT <[email protected]>
Co-authored-by: Jean-Philippe Raynaud <[email protected]>

Author: 3 people

mithril-aggregator/src/certifier_service.rs

@@ -20,8 +20,8 @@ use thiserror::Error;
 use tokio::sync::RwLock;
 
 use crate::database::provider::{
-    CertificateRepository, OpenMessage, OpenMessageRepository, OpenMessageWithSingleSignatures,
-    SingleSignatureRepository,
+    CertificateRepository, OpenMessageRecord, OpenMessageRepository,
+    OpenMessageWithSingleSignaturesRecord, SingleSignatureRepository,
 };
 use crate::MultiSigner;
 
@@ -88,14 +88,14 @@ pub trait CertifierService: Sync + Send {
         &self,
         signed_entity_type: &SignedEntityType,
         protocol_message: &ProtocolMessage,
-    ) -> StdResult<OpenMessage>;
+    ) -> StdResult<OpenMessageRecord>;
 
     /// Return the open message at the given Beacon. If the message does not
     /// exist, None is returned.
     async fn get_open_message(
         &self,
         signed_entity_type: &SignedEntityType,
-    ) -> StdResult<Option<OpenMessageWithSingleSignatures>>;
+    ) -> StdResult<Option<OpenMessageWithSingleSignaturesRecord>>;
 
     /// Create a certificate if possible. If the pointed open message does
     /// not exist or has been already certified, an error is raised. If a multi
@@ -209,7 +209,7 @@ impl CertifierService for MithrilCertifierService {
         &self,
         signed_entity_type: &SignedEntityType,
         protocol_message: &ProtocolMessage,
-    ) -> StdResult<OpenMessage> {
+    ) -> StdResult<OpenMessageRecord> {
         debug!("CertifierService::create_open_message(signed_entity_type: {signed_entity_type:?}, protocol_message: {protocol_message:?})");
         let current_epoch = self.current_epoch.read().await;
 
@@ -229,7 +229,7 @@ impl CertifierService for MithrilCertifierService {
     async fn get_open_message(
         &self,
         signed_entity_type: &SignedEntityType,
-    ) -> StdResult<Option<OpenMessageWithSingleSignatures>> {
+    ) -> StdResult<Option<OpenMessageWithSingleSignaturesRecord>> {
         debug!("CertifierService::get_open_message(signed_entity_type: {signed_entity_type:?})");
 
         self.open_message_repository
@@ -325,7 +325,7 @@ impl CertifierService for MithrilCertifierService {
             .create_certificate(certificate)
             .await?;
 
-        let mut open_message_certified: OpenMessage = open_message.into();
+        let mut open_message_certified: OpenMessageRecord = open_message.into();
         open_message_certified.is_certified = true;
         self.open_message_repository
             .update_open_message(&open_message_certified)

mithril-aggregator/src/database/provider/open_message.rs

@@ -25,7 +25,7 @@ type StdResult<T> = Result<T, StdError>;
 /// generated if possible.
 #[allow(dead_code)]
 #[derive(Debug, Clone, PartialEq, Eq)]
-pub struct OpenMessage {
+pub struct OpenMessageRecord {
     /// OpenMessage unique identifier
     pub open_message_id: Uuid,
 
@@ -45,7 +45,7 @@ pub struct OpenMessage {
     pub created_at: NaiveDateTime,
 }
 
-impl OpenMessage {
+impl OpenMessageRecord {
     #[cfg(test)]
     /// Create a dumb OpenMessage instance mainly for test purposes
     pub fn dummy() -> Self {
@@ -64,8 +64,8 @@ impl OpenMessage {
     }
 }
 
-impl From<OpenMessageWithSingleSignatures> for OpenMessage {
-    fn from(value: OpenMessageWithSingleSignatures) -> Self {
+impl From<OpenMessageWithSingleSignaturesRecord> for OpenMessageRecord {
+    fn from(value: OpenMessageWithSingleSignaturesRecord) -> Self {
         Self {
             open_message_id: value.open_message_id,
             epoch: value.epoch,
@@ -77,7 +77,7 @@ impl From<OpenMessageWithSingleSignatures> for OpenMessage {
     }
 }
 
-impl SqLiteEntity for OpenMessage {
+impl SqLiteEntity for OpenMessageRecord {
     fn hydrate(row: Row) -> Result<Self, HydrationError>
     where
         Self: Sized,
@@ -199,7 +199,7 @@ impl<'client> OpenMessageProvider<'client> {
 }
 
 impl<'client> Provider<'client> for OpenMessageProvider<'client> {
-    type Entity = OpenMessage;
+    type Entity = OpenMessageRecord;
 
     fn get_definition(&self, condition: &str) -> String {
         let aliases = SourceAlias::new(&[
@@ -245,7 +245,7 @@ impl<'client> InsertOpenMessageProvider<'client> {
 }
 
 impl<'client> Provider<'client> for InsertOpenMessageProvider<'client> {
-    type Entity = OpenMessage;
+    type Entity = OpenMessageRecord;
 
     fn get_connection(&'client self) -> &'client Connection {
         self.connection
@@ -267,7 +267,7 @@ impl<'client> UpdateOpenMessageProvider<'client> {
         Self { connection }
     }
 
-    fn get_update_condition(&self, open_message: &OpenMessage) -> StdResult<WhereCondition> {
+    fn get_update_condition(&self, open_message: &OpenMessageRecord) -> StdResult<WhereCondition> {
         let expression = "(open_message_id, epoch_setting_id, beacon, signed_entity_type_id, protocol_message, is_certified) values (?*, ?*, ?*, ?*, ?*, ?*)";
         let beacon_str = open_message.signed_entity_type.get_json_beacon()?;
         let parameters = vec![
@@ -284,7 +284,7 @@ impl<'client> UpdateOpenMessageProvider<'client> {
 }
 
 impl<'client> Provider<'client> for UpdateOpenMessageProvider<'client> {
-    type Entity = OpenMessage;
+    type Entity = OpenMessageRecord;
 
     fn get_connection(&'client self) -> &'client Connection {
         self.connection
@@ -316,7 +316,7 @@ impl<'client> DeleteOpenMessageProvider<'client> {
 }
 
 impl<'client> Provider<'client> for DeleteOpenMessageProvider<'client> {
-    type Entity = OpenMessage;
+    type Entity = OpenMessageRecord;
 
     fn get_connection(&'client self) -> &'client Connection {
         self.connection
@@ -332,7 +332,7 @@ impl<'client> Provider<'client> for DeleteOpenMessageProvider<'client> {
 
 /// Open Message with associated single signatures if any.
 #[derive(Debug, Clone)]
-pub struct OpenMessageWithSingleSignatures {
+pub struct OpenMessageWithSingleSignaturesRecord {
     /// OpenMessage unique identifier
     pub open_message_id: Uuid,
 
@@ -355,7 +355,7 @@ pub struct OpenMessageWithSingleSignatures {
     pub created_at: NaiveDateTime,
 }
 
-impl OpenMessageWithSingleSignatures {
+impl OpenMessageWithSingleSignaturesRecord {
     /// Gather all signers party_id for this open message
     pub fn get_signers_id(&self) -> Vec<PartyId> {
         self.single_signatures
@@ -365,7 +365,7 @@ impl OpenMessageWithSingleSignatures {
     }
 }
 
-impl SqLiteEntity for OpenMessageWithSingleSignatures {
+impl SqLiteEntity for OpenMessageWithSingleSignaturesRecord {
     fn hydrate(row: Row) -> Result<Self, HydrationError>
     where
         Self: Sized,
@@ -378,7 +378,7 @@ impl SqLiteEntity for OpenMessageWithSingleSignatures {
                 ))
             })?;
 
-        let open_message = OpenMessage::hydrate(row)?;
+        let open_message = OpenMessageRecord::hydrate(row)?;
 
         let open_message = Self {
             open_message_id: open_message.open_message_id,
@@ -440,7 +440,7 @@ impl<'client> OpenMessageWithSingleSignaturesProvider<'client> {
 }
 
 impl<'client> Provider<'client> for OpenMessageWithSingleSignaturesProvider<'client> {
-    type Entity = OpenMessageWithSingleSignatures;
+    type Entity = OpenMessageWithSingleSignaturesRecord;
 
     fn get_definition(&self, condition: &str) -> String {
         let aliases = SourceAlias::new(&[
@@ -485,7 +485,7 @@ impl OpenMessageRepository {
     pub async fn get_open_message(
         &self,
         signed_entity_type: &SignedEntityType,
-    ) -> StdResult<Option<OpenMessage>> {
+    ) -> StdResult<Option<OpenMessageRecord>> {
         let lock = self.connection.lock().await;
         let provider = OpenMessageProvider::new(&lock);
         let filters = provider
@@ -502,7 +502,7 @@ impl OpenMessageRepository {
         epoch: Epoch,
         signed_entity_type: &SignedEntityType,
         protocol_message: &ProtocolMessage,
-    ) -> StdResult<OpenMessage> {
+    ) -> StdResult<OpenMessageRecord> {
         let lock = self.connection.lock().await;
         let provider = InsertOpenMessageProvider::new(&lock);
         let filters = provider.get_insert_condition(epoch, signed_entity_type, protocol_message)?;
@@ -514,7 +514,10 @@ impl OpenMessageRepository {
     }
 
     /// Updates an [OpenMessage] in the database.
-    pub async fn update_open_message(&self, open_message: &OpenMessage) -> StdResult<OpenMessage> {
+    pub async fn update_open_message(
+        &self,
+        open_message: &OpenMessageRecord,
+    ) -> StdResult<OpenMessageRecord> {
         let lock = self.connection.lock().await;
         let provider = UpdateOpenMessageProvider::new(&lock);
         let filters = provider.get_update_condition(open_message)?;
@@ -540,7 +543,7 @@ impl OpenMessageRepository {
     pub async fn get_open_message_with_single_signatures(
         &self,
         signed_entity_type: &SignedEntityType,
-    ) -> StdResult<Option<OpenMessageWithSingleSignatures>> {
+    ) -> StdResult<Option<OpenMessageWithSingleSignaturesRecord>> {
         let lock = self.connection.lock().await;
         let provider = OpenMessageWithSingleSignaturesProvider::new(&lock);
         let filters = provider.get_signed_entity_type_condition(signed_entity_type);
@@ -564,7 +567,7 @@ mod tests {
 
     #[test]
     fn open_message_with_single_signature_projection() {
-        let projection = OpenMessageWithSingleSignatures::get_projection();
+        let projection = OpenMessageWithSingleSignaturesRecord::get_projection();
         let aliases = SourceAlias::new(&[
             ("{:open_message:}", "open_message"),
             ("{:single_signature:}", "single_signature"),
@@ -578,7 +581,7 @@ mod tests {
 
     #[test]
     fn open_message_projection() {
-        let projection = OpenMessage::get_projection();
+        let projection = OpenMessageRecord::get_projection();
         let aliases = SourceAlias::new(&[("{:open_message:}", "open_message")]);
 
         assert_eq!(
@@ -659,7 +662,7 @@ mod tests {
     fn update_provider_condition() {
         let connection = Connection::open(":memory:").unwrap();
         let provider = UpdateOpenMessageProvider::new(&connection);
-        let open_message = OpenMessage {
+        let open_message = OpenMessageRecord {
             open_message_id: Uuid::new_v4(),
             epoch: Epoch(12),
             signed_entity_type: SignedEntityType::dummy(),
@@ -836,7 +839,7 @@ mod tests {
         setup_single_signature_db(&connection, single_signature_records.clone()).unwrap();
         let repository = OpenMessageRepository::new(Arc::new(Mutex::new(connection)));
 
-        let mut open_message = OpenMessage::dummy();
+        let mut open_message = OpenMessageRecord::dummy();
         open_message.open_message_id = single_signature_records[0].open_message_id;
         repository.update_open_message(&open_message).await.unwrap();
 
@@ -857,7 +860,7 @@ mod tests {
         setup_single_signature_db(&connection, Vec::new()).unwrap();
         let repository = OpenMessageRepository::new(Arc::new(Mutex::new(connection)));
 
-        let open_message = OpenMessage::dummy();
+        let open_message = OpenMessageRecord::dummy();
         repository
             .create_open_message(
                 open_message.epoch,

mithril-aggregator/src/database/provider/single_signature.rs

@@ -16,7 +16,7 @@ use mithril_common::StdError;
 use tokio::sync::Mutex;
 use uuid::Uuid;
 
-use super::OpenMessage;
+use super::OpenMessageRecord;
 
 /// SingleSignature record is the representation of a stored single_signature.
 #[derive(Debug, PartialEq, Clone)]
@@ -285,7 +285,7 @@ impl SingleSignatureRepository {
     pub async fn create_single_signature(
         &self,
         single_signature: &SingleSignatures,
-        open_message: &OpenMessage,
+        open_message: &OpenMessageRecord,
     ) -> Result<SingleSignatureRecord, StdError> {
         let connection = self.connection.lock().await;
         let single_signature = SingleSignatureRecord::from_single_signatures(

mithril-aggregator/src/multi_signer.rs

@@ -14,7 +14,7 @@ use mithril_common::{
 };
 
 use crate::{
-    database::provider::OpenMessageWithSingleSignatures, store::VerificationKeyStorer,
+    database::provider::OpenMessageWithSingleSignaturesRecord, store::VerificationKeyStorer,
     ProtocolParametersStore, ProtocolParametersStorer, VerificationKeyStore,
 };
 
@@ -184,7 +184,7 @@ pub trait MultiSigner: Sync + Send {
     /// Creates a multi signature from single signatures
     async fn create_multi_signature(
         &self,
-        open_message: &OpenMessageWithSingleSignatures,
+        open_message: &OpenMessageWithSingleSignaturesRecord,
     ) -> Result<Option<ProtocolMultiSignature>, ProtocolError>;
 }
 
@@ -539,7 +539,7 @@ impl MultiSigner for MultiSignerImpl {
     /// Creates a multi signature from single signatures
     async fn create_multi_signature(
         &self,
-        open_message: &OpenMessageWithSingleSignatures,
+        open_message: &OpenMessageWithSingleSignaturesRecord,
     ) -> Result<Option<ProtocolMultiSignature>, ProtocolError> {
         debug!("MultiSigner:create_multi_signature({open_message:?})");
         let protocol_parameters = self
@@ -805,7 +805,7 @@ mod tests {
             "they should be at least one signature that can be registered without reaching the quorum"
         );
 
-        let mut open_message = OpenMessageWithSingleSignatures {
+        let mut open_message = OpenMessageWithSingleSignaturesRecord {
             open_message_id: Uuid::parse_str("193d1442-e89b-43cf-9519-04d8db9a12ff").unwrap(),
             epoch: start_epoch,
             signed_entity_type: SignedEntityType::CardanoImmutableFilesFull(

mithril-aggregator/src/runtime/runner.rs

@@ -16,7 +16,7 @@ use std::path::Path;
 use std::path::PathBuf;
 use std::sync::Arc;
 
-use crate::database::provider::OpenMessage;
+use crate::database::provider::OpenMessageRecord;
 use crate::snapshot_uploaders::SnapshotLocation;
 use crate::snapshotter::OngoingSnapshot;
 use crate::RuntimeError;
@@ -172,7 +172,7 @@ pub trait AggregatorRunnerTrait: Sync + Send {
         &self,
         signed_entity_type: &SignedEntityType,
         protocol_message: &ProtocolMessage,
-    ) -> Result<OpenMessage, Box<dyn StdError + Sync + Send>>;
+    ) -> Result<OpenMessageRecord, Box<dyn StdError + Sync + Send>>;
 }
 
 /// The runner responsibility is to expose a code API for the state machine. It
@@ -614,7 +614,7 @@ impl AggregatorRunnerTrait for AggregatorRunner {
         &self,
         signed_entity_type: &SignedEntityType,
         protocol_message: &ProtocolMessage,
-    ) -> Result<OpenMessage, Box<dyn StdError + Sync + Send>> {
+    ) -> Result<OpenMessageRecord, Box<dyn StdError + Sync + Send>> {
         self.dependencies
             .certifier_service
             .create_open_message(signed_entity_type, protocol_message)

mithril-aggregator/src/runtime/state_machine.rs

@@ -1,5 +1,5 @@
 use crate::{
-    database::provider::OpenMessage,
+    database::provider::OpenMessageRecord,
     runtime::{AggregatorRunnerTrait, RuntimeError},
 };
 
@@ -22,7 +22,7 @@ pub struct ReadyState {
 #[derive(Clone, Debug, PartialEq)]
 pub struct SigningState {
     current_beacon: Beacon,
-    open_message: OpenMessage,
+    open_message: OpenMessageRecord,
 }
 
 #[derive(Clone, Debug, PartialEq)]
@@ -359,7 +359,7 @@ impl AggregatorRuntime {
 #[cfg(test)]
 mod tests {
 
-    use crate::database::provider::OpenMessage;
+    use crate::database::provider::OpenMessageRecord;
 
     use super::super::runner::MockAggregatorRunner;
     use super::*;
@@ -607,7 +607,7 @@ mod tests {
         runner
             .expect_create_open_message()
             .once()
-            .returning(|_, _| Ok(OpenMessage::dummy()));
+            .returning(|_, _| Ok(OpenMessageRecord::dummy()));
 
         let mut runtime = init_runtime(
             Some(AggregatorState::Ready(ReadyState {
@@ -642,7 +642,7 @@ mod tests {
 
                 beacon
             },
-            open_message: OpenMessage::dummy(),
+            open_message: OpenMessageRecord::dummy(),
         };
         let mut runtime = init_runtime(Some(AggregatorState::Signing(state)), runner).await;
         runtime.cycle().await.unwrap();
@@ -663,7 +663,7 @@ mod tests {
             .returning(|_| Ok(None));
         let state = SigningState {
             current_beacon: fake_data::beacon(),
-            open_message: OpenMessage::dummy(),
+            open_message: OpenMessageRecord::dummy(),
         };
         let mut runtime = init_runtime(Some(AggregatorState::Signing(state)), runner).await;
         runtime