refactor: add source component when a logger is passed in a ctor in mithril-common

Alenar · Alenar · commit 6df1fbc55b01 · 2024-09-20T14:32:31.000+02:00
And remove prefixes in log since we have now the source.
diff --git a/mithril-common/src/cardano_block_scanner/chain_reader_block_streamer.rs b/mithril-common/src/cardano_block_scanner/chain_reader_block_streamer.rs
@@ -31,7 +31,7 @@ pub struct ChainReaderBlockStreamer {
 #[async_trait]
 impl BlockStreamer for ChainReaderBlockStreamer {
     async fn poll_next(&mut self) -> StdResult<Option<ChainScannedBlocks>> {
-        debug!(self.logger, "ChainReaderBlockStreamer polls next");
+        debug!(self.logger, "polls next");
 
         let chain_scanned_blocks: ChainScannedBlocks;
         let mut roll_forwards = vec![];
@@ -111,7 +111,7 @@ impl ChainReaderBlockStreamer {
             from,
             until,
             max_roll_forwards_per_poll,
-            logger,
+            logger: logger.new(slog::o!("src" => "ChainReaderBlockStreamer")),
         })
     }
 
@@ -122,14 +122,14 @@ impl ChainReaderBlockStreamer {
                 if parsed_block.block_number > self.until {
                     trace!(
                         self.logger,
-                        "ChainReaderBlockStreamer received a RollForward above threshold block number ({})",
+                        "received a RollForward above threshold block number ({})",
                         parsed_block.block_number
                     );
                     Ok(None)
                 } else {
                     trace!(
                         self.logger,
-                        "ChainReaderBlockStreamer received a RollForward below threshold block number ({})",
+                        "received a RollForward below threshold block number ({})",
                         parsed_block.block_number
                     );
                     Ok(Some(BlockStreamerNextAction::ChainBlockNextAction(
@@ -142,7 +142,7 @@ impl ChainReaderBlockStreamer {
             }) => {
                 trace!(
                     self.logger,
-                    "ChainReaderBlockStreamer received a RollBackward({rollback_slot_number:?})"
+                    "received a RollBackward({rollback_slot_number:?})"
                 );
                 let block_streamer_next_action = if rollback_slot_number == self.from.slot_number {
                     BlockStreamerNextAction::SkipToNextAction
@@ -156,7 +156,7 @@ impl ChainReaderBlockStreamer {
                 Ok(Some(block_streamer_next_action))
             }
             None => {
-                trace!(self.logger, "ChainReaderBlockStreamer received nothing");
+                trace!(self.logger, "received nothing");
                 Ok(None)
             }
         }
diff --git a/mithril-common/src/cardano_transactions_preloader.rs b/mithril-common/src/cardano_transactions_preloader.rs
@@ -71,34 +71,31 @@ impl CardanoTransactionsPreloader {
             importer,
             security_parameter,
             chain_observer,
-            logger,
+            logger: logger.new(slog::o!("src" => "CardanoTransactionsPreloader")),
             activation_state,
         }
     }
 
     /// Preload the Cardano Transactions by running the importer up to the current chain block number.
     pub async fn preload(&self) -> StdResult<()> {
         if !self.is_activated().await? {
-            debug!(
-                self.logger,
-                "⟳ Preload Cardano Transactions - Not running, conditions not met"
-            );
+            debug!(self.logger, "Not running, conditions not met");
             return Ok(());
         }
 
-        info!(self.logger, "⟳ Preload Cardano Transactions - Started");
-        debug!(self.logger, "⟳ Locking signed entity type"; "entity_type" => "CardanoTransactions");
+        info!(self.logger, "Started");
+        debug!(self.logger, "Locking signed entity type"; "entity_type" => "CardanoTransactions");
         self.signed_entity_type_lock
             .lock(SignedEntityTypeDiscriminants::CardanoTransactions)
             .await;
 
         let preload_result = self.do_preload().await;
 
-        debug!(self.logger, "⟳ Releasing signed entity type"; "entity_type" => "CardanoTransactions");
+        debug!(self.logger, "Releasing signed entity type"; "entity_type" => "CardanoTransactions");
         self.signed_entity_type_lock
             .release(SignedEntityTypeDiscriminants::CardanoTransactions)
             .await;
-        info!(self.logger, "⟳ Preload Cardano Transactions - Finished");
+        info!(self.logger, "Finished");
 
         preload_result
     }
diff --git a/mithril-common/src/certificate_chain/certificate_verifier.rs b/mithril-common/src/certificate_chain/certificate_verifier.rs
@@ -122,7 +122,7 @@ impl MithrilCertificateVerifier {
     pub fn new(logger: Logger, certificate_retriever: Arc<dyn CertificateRetriever>) -> Self {
         debug!(logger, "New MithrilCertificateVerifier created");
         Self {
-            logger,
+            logger: logger.new(slog::o!("src" => "MithrilCertificateVerifier")),
             certificate_retriever,
         }
     }
diff --git a/mithril-common/src/chain_reader/pallas_chain_reader.rs b/mithril-common/src/chain_reader/pallas_chain_reader.rs
@@ -28,7 +28,7 @@ impl PallasChainReader {
             socket: socket.to_owned(),
             network,
             client: None,
-            logger,
+            logger: logger.new(slog::o!("src" => "PallasChainReader")),
         }
     }
 
@@ -45,7 +45,7 @@ impl PallasChainReader {
     async fn get_client(&mut self) -> StdResult<&mut NodeClient> {
         if self.client.is_none() {
             self.client = Some(self.new_client().await?);
-            debug!(self.logger, "PallasChainReader connected to a new client");
+            debug!(self.logger, "connected to a new client");
         }
 
         self.client
@@ -60,12 +60,12 @@ impl PallasChainReader {
         let chainsync = client.chainsync();
 
         if chainsync.has_agency() {
-            debug!(logger, "PallasChainReader has agency, finding intersect point..."; "point" => ?point);
+            debug!(logger, "has agency, finding intersect point..."; "point" => ?point);
             chainsync
                 .find_intersect(vec![point.to_owned().into()])
                 .await?;
         } else {
-            debug!(logger, "PallasChainReader doesn't have agency, no need to find intersect point";);
+            debug!(logger, "doesn't have agency, no need to find intersect point";);
         }
 
         Ok(())
diff --git a/mithril-common/src/digesters/cache/json_provider_builder.rs b/mithril-common/src/digesters/cache/json_provider_builder.rs
@@ -43,7 +43,7 @@ impl<'a> JsonImmutableFileDigestCacheProviderBuilder<'a> {
 
     /// Set the [Logger] to use.
     pub fn with_logger(&mut self, logger: Logger) -> &mut Self {
-        self.logger = logger;
+        self.logger = logger.new(slog::o!("src" => "JsonImmutableFileDigestCacheProviderBuilder"));
         self
     }
 
diff --git a/mithril-common/src/digesters/cardano_immutable_digester.rs b/mithril-common/src/digesters/cardano_immutable_digester.rs
@@ -32,7 +32,7 @@ impl CardanoImmutableDigester {
     ) -> Self {
         Self {
             cache_provider,
-            logger,
+            logger: logger.new(slog::o!("src" => "CardanoImmutableDigester")),
         }
     }
 }
diff --git a/mithril-common/src/signable_builder/cardano_immutable_full_signable_builder.rs b/mithril-common/src/signable_builder/cardano_immutable_full_signable_builder.rs
@@ -29,7 +29,7 @@ impl CardanoImmutableFilesFullSignableBuilder {
     ) -> Self {
         Self {
             immutable_digester,
-            logger,
+            logger: logger.new(slog::o!("src" => "CardanoImmutableFilesFullSignableBuilder")),
             dirpath: dirpath.to_owned(),
         }
     }
@@ -41,7 +41,7 @@ impl SignableBuilder<CardanoDbBeacon> for CardanoImmutableFilesFullSignableBuild
         &self,
         beacon: CardanoDbBeacon,
     ) -> StdResult<ProtocolMessage> {
-        debug!(self.logger, "SignableBuilder::compute_signable({beacon:?})");
+        debug!(self.logger, "compute_signable({beacon:?})");
         let digest = self
             .immutable_digester
             .compute_digest(&self.dirpath, &beacon)
@@ -52,7 +52,7 @@ impl SignableBuilder<CardanoDbBeacon> for CardanoImmutableFilesFullSignableBuild
                     &self.dirpath.display()
                 )
             })?;
-        info!(self.logger, "SignableBuilder: digest = '{digest}'.");
+        info!(self.logger, "digest = '{digest}'.");
         let mut protocol_message = ProtocolMessage::new();
         protocol_message.set_message_part(ProtocolMessagePartKey::SnapshotDigest, digest);
 
diff --git a/mithril-common/src/signable_builder/cardano_transactions.rs b/mithril-common/src/signable_builder/cardano_transactions.rs
@@ -65,7 +65,7 @@ impl<S: MKTreeStorer> CardanoTransactionsSignableBuilder<S> {
         Self {
             transaction_importer,
             block_range_root_retriever,
-            logger,
+            logger: logger.new(slog::o!("src" => "CardanoTransactionsSignableBuilder")),
         }
     }
 }
@@ -113,8 +113,7 @@ mod tests {
 
     fn compute_mk_map_from_transactions(
         transactions: Vec<CardanoTransaction>,
-    ) -> MKMap<BlockRange, MKMapNode<BlockRange, MKTreeStoreInMemory>, MKTreeStoreInMemory>
-    {
+    ) -> MKMap<BlockRange, MKMapNode<BlockRange, MKTreeStoreInMemory>, MKTreeStoreInMemory> {
         MKMap::new_from_iter(transactions.iter().map(|tx| {
             (
                 BlockRange::from_block_number(tx.block_number),

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ impl MithrilCertificateVerifier {`
`122`	`122`	`pub fn new(logger: Logger, certificate_retriever: Arc<dyn CertificateRetriever>) -> Self {`
`123`	`123`	`debug!(logger, "New MithrilCertificateVerifier created");`
`124`	`124`	`Self {`
`125`		`- logger,`
	`125`	`+ logger: logger.new(slog::o!("src" => "MithrilCertificateVerifier")),`
`126`	`126`	`certificate_retriever,`
`127`	`127`	`}`
`128`	`128`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ impl<'a> JsonImmutableFileDigestCacheProviderBuilder<'a> {`
`43`	`43`
`44`	`44`	`/// Set the [Logger] to use.`
`45`	`45`	`pub fn with_logger(&mut self, logger: Logger) -> &mut Self {`
`46`		`- self.logger = logger;`
	`46`	`+ self.logger = logger.new(slog::o!("src" => "JsonImmutableFileDigestCacheProviderBuilder"));`
`47`	`47`	`self`
`48`	`48`	`}`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ impl CardanoImmutableDigester {`
`32`	`32`	`) -> Self {`
`33`	`33`	`Self {`
`34`	`34`	`cache_provider,`
`35`		`- logger,`
	`35`	`+ logger: logger.new(slog::o!("src" => "CardanoImmutableDigester")),`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ impl<S: MKTreeStorer> CardanoTransactionsSignableBuilder<S> {`
`65`	`65`	`Self {`
`66`	`66`	`transaction_importer,`
`67`	`67`	`block_range_root_retriever,`
`68`		`- logger,`
	`68`	`+ logger: logger.new(slog::o!("src" => "CardanoTransactionsSignableBuilder")),`
`69`	`69`	`}`
`70`	`70`	`}`
`71`	`71`	`}`
`@@ -113,8 +113,7 @@ mod tests {`
`113`	`113`
`114`	`114`	`fn compute_mk_map_from_transactions(`
`115`	`115`	`transactions: Vec<CardanoTransaction>,`
`116`		`- ) -> MKMap<BlockRange, MKMapNode<BlockRange, MKTreeStoreInMemory>, MKTreeStoreInMemory>`
`117`		`- {`
	`116`	`+ ) -> MKMap<BlockRange, MKMapNode<BlockRange, MKTreeStoreInMemory>, MKTreeStoreInMemory> {`
`118`	`117`	`MKMap::new_from_iter(transactions.iter().map(\|tx\| {`
`119`	`118`	`(`
`120`	`119`	`BlockRange::from_block_number(tx.block_number),`