PR review: fix typos

Author: Damien LACHAUME / PALO-IT

docs/website/root/manual/developer-docs/nodes/mithril-client-library.md

@@ -12,7 +12,7 @@ import CompiledBinaries from '../../../compiled-binaries.md'
 Mithril client library can be used by Rust developers to use the Mithril network in their applications.
 
 It is responsible for handling the different types of data certified by Mithril, and available through a Mithril aggregator:
-- [**Snapshot**](../../../glossary.md#snapshot): list, get, download tarball and add statistics.
+- [**Snapshot**](../../../glossary.md#snapshot): list, get, download tarball and record statistics.
 - [**Mithril stake distribution**](../../../glossary.md#stake-distribution): list and get.
 - [**Certificate**](../../../glossary.md#certificate): list, get, and chain validation.
 
@@ -90,7 +90,7 @@ async fn main() -> mithril_client::MithrilResult<()> {
         .await?;
 
     if let Err(e) = client.snapshot().add_statistics(&snapshot).await {
-        println!("Could not POST snapshot download statistics: {:?}", e);
+        println!("Could not increment snapshot download statistics: {:?}", e);
     }
 
     let message = MessageBuilder::new()
@@ -148,7 +148,7 @@ async fn main() -> mithril_client::MithrilResult<()> {
         .await?;
 
     if let Err(e) = client.snapshot().add_statistics(&snapshot).await {
-        println!("Could not POST snapshot download statistics: {:?}", e);
+        println!("Could not increment snapshot download statistics: {:?}", e);
     }
 
     let message = MessageBuilder::new()

examples/client-snapshot/README.md

@@ -11,7 +11,7 @@ In this example, the client interacts with a real aggregator on the network `tes
 - verify a certificate chain
 - compute a message for a Snapshot
 - verify that the certificate signs the computed message
-- increments download statistics
+- increments snapshot download statistics
 
 The crate [indicatif](https://docs.rs/indicatif/latest/indicatif/) is used to nicely report the progress to the console.
 

examples/client-snapshot/src/main.rs

@@ -56,7 +56,7 @@ async fn main() -> MithrilResult<()> {
         .await?;
 
     if let Err(e) = client.snapshot().add_statistics(&snapshot).await {
-        println!("Could not POST snapshot download statistics: {:?}", e);
+        println!("Could not increment snapshot download statistics: {:?}", e);
     }
 
     println!("Computing snapshot '{}' message ...", snapshot.digest);

mithril-client-cli/src/commands/snapshot/download.rs

@@ -210,7 +210,7 @@ impl SnapshotDownloadCommand {
         // The snapshot download does not fail if the statistic call fails.
         // It would be nice to implement tests to verify the behavior of `add_statistics`
         if let Err(e) = client.snapshot().add_statistics(snapshot_message).await {
-            warn!("Could not POST snapshot download statistics: {e:?}");
+            warn!("Could not increment snapshot download statistics: {e:?}");
         }
 
         // Append 'clean' file to speedup node bootstrap

mithril-client/README.md

@@ -5,7 +5,7 @@
 * `mithril-client` defines all the tooling necessary to manipulate Mithril certified types available from a Mithril aggregator.
 
 * The different types of available data certified by Mithril are:
-    * Snapshot: list, get, download tarball and add statistics.
+    * Snapshot: list, get, download tarball and record statistics.
     * Mithril stake distribution: list and get.
     * Certificate: list, get, and chain validation.
 
@@ -39,7 +39,7 @@ async fn main() -> mithril_client::MithrilResult<()> {
         .await?;
 
     if let Err(e) = client.snapshot().add_statistics(&snapshot).await {
-        println!("Could not POST snapshot download statistics: {:?}", e);
+        println!("Could not increment snapshot download statistics: {:?}", e);
     }
 
     let message = MessageBuilder::new()

mithril-client/src/aggregator_client.rs

@@ -69,8 +69,8 @@ pub enum AggregatorRequest {
     /// Lists the aggregator [snapshots][crate::Snapshot]
     ListSnapshots,
 
-    /// Increments Aggregator's download statistics
-    AddStatistics,
+    /// Increments the aggregator snapshot download statistics
+    IncrementSnapshotStatistic,
 }
 
 impl AggregatorRequest {
@@ -91,7 +91,7 @@ impl AggregatorRequest {
                 format!("artifact/snapshot/{}", digest)
             }
             AggregatorRequest::ListSnapshots => "artifact/snapshots".to_string(),
-            AggregatorRequest::AddStatistics => "statistics/snapshot".to_string(),
+            AggregatorRequest::IncrementSnapshotStatistic => "statistics/snapshot".to_string(),
         }
     }
 }
@@ -106,7 +106,7 @@ pub trait AggregatorClient: Sync + Send {
         request: AggregatorRequest,
     ) -> Result<String, AggregatorClientError>;
 
-    /// Post information to the Aggregator, the URL is a relative path for a resource
+    /// Post information to the Aggregator
     async fn post_content(
         &self,
         request: AggregatorRequest,

mithril-client/src/lib.rs

@@ -6,7 +6,7 @@
 //!
 //! It handles the different types that can be queried to a Mithril aggregator:
 //!
-//! - [Snapshot][snapshot_client] list, get, download tarball and add statistics.
+//! - [Snapshot][snapshot_client] list, get, download tarball and record statistics.
 //! - [Mithril stake distribution][mithril_stake_distribution_client] list and get.
 //! - [Certificates][certificate_client] list, get, and chain validation.
 //!
@@ -47,7 +47,7 @@
 //!     .await?;
 //!
 //! if let Err(e) = client.snapshot().add_statistics(&snapshot).await {
-//!     println!("Could not POST snapshot download statistics: {:?}", e);
+//!     println!("Could not increment snapshot download statistics: {:?}", e);
 //! }
 //!
 //!

mithril-client/src/snapshot_client.rs

@@ -66,7 +66,7 @@
 //! # Add statistics
 //! **Note:** _Available on crate feature_ **fs** _only._
 //!
-//! Increments Aggregator's download statistics using the [ClientBuilder][crate::client::ClientBuilder].
+//! Increments the aggregator snapshot download statistics using the [ClientBuilder][crate::client::ClientBuilder].
 //!
 //! ```no_run
 //! # async fn run() -> mithril_client::MithrilResult<()> {
@@ -239,12 +239,12 @@ impl SnapshotClient {
         }
     }
 
-    /// Increments Aggregator's download statistics
+    /// Increments the aggregator snapshot download statistics
     pub async fn add_statistics(&self, snapshot: &Snapshot) -> MithrilResult<()> {
         let _response = self
             .aggregator_client
             .post_content(
-                AggregatorRequest::AddStatistics,
+                AggregatorRequest::IncrementSnapshotStatistic,
                 &serde_json::to_string(snapshot)?,
             )
             .await?;

mithril-client/tests/extensions/fake.rs

@@ -48,7 +48,6 @@ impl FakeAggregator {
     }
 
     pub async fn store_call_and_return_value(
-        _params: Vec<String>,
         full_path: FullPath,
         calls: FakeAggregatorCalls,
         returned_value: String,

mithril-client/tests/extensions/routes/certificate.rs

@@ -26,12 +26,7 @@ fn certificate_certificates(
         .and(warp::path::full().map(move |p| p))
         .and(with_calls_middleware(calls.clone()))
         .and_then(move |fullpath, calls| {
-            FakeAggregator::store_call_and_return_value(
-                vec![],
-                fullpath,
-                calls,
-                returned_value.clone(),
-            )
+            FakeAggregator::store_call_and_return_value(fullpath, calls, returned_value.clone())
         })
 }
 
@@ -43,12 +38,7 @@ fn certificate_certificate_hash(
     warp::path!("certificate" / String)
         .and(warp::path::full().map(move |p| p))
         .and(with_calls_middleware(calls.clone()))
-        .and_then(move |param, fullpath, calls| {
-            FakeAggregator::store_call_and_return_value(
-                vec![param],
-                fullpath,
-                calls,
-                returned_value.clone(),
-            )
+        .and_then(move |_param, fullpath, calls| {
+            FakeAggregator::store_call_and_return_value(fullpath, calls, returned_value.clone())
         })
 }