Add snapshot archive compression algorithm in explorer

mithril-aggregator/Cargo.toml

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

mithril-aggregator/src/message_adapters/to_snapshot_list_message.rs

@@ -18,6 +18,7 @@ impl ToMessageAdapter<Vec<SignedEntity<Snapshot>>, SnapshotListMessage>
                 size: entity.artifact.size,
                 created_at: entity.created_at,
                 locations: entity.artifact.locations,
+                compression_algorithm: Some(entity.artifact.compression_algorithm),
                 cardano_node_version: Some(entity.artifact.cardano_node_version),
             })
             .collect()

mithril-client/src/services/snapshot.rs

@@ -369,6 +369,7 @@ mod tests {
             size: 1024,
             created_at: DateTime::<Utc>::default(),
             locations: vec!["location-1.1".to_string(), "location-1.2".to_string()],
+            compression_algorithm: Some(CompressionAlgorithm::Zstandard),
             cardano_node_version: None,
         };
         let item2 = SnapshotListItemMessage {
@@ -378,6 +379,7 @@ mod tests {
             size: 1024,
             created_at: DateTime::<Utc>::default(),
             locations: vec!["location-2.1".to_string(), "location-2.2".to_string()],
+            compression_algorithm: None,
             cardano_node_version: Some("1.0.0".to_string()),
         };
 

mithril-common/src/messages/snapshot_list.rs

@@ -1,7 +1,7 @@
 use chrono::{DateTime, Utc};
 use serde::{Deserialize, Serialize};
 
-use crate::entities::{Beacon, Epoch};
+use crate::entities::{Beacon, CompressionAlgorithm, Epoch};
 
 /// Message structure of a snapshot list
 pub type SnapshotListMessage = Vec<SnapshotListItemMessage>;
@@ -27,6 +27,10 @@ pub struct SnapshotListItemMessage {
     /// Locations where the binary content of the snapshot can be retrieved
     pub locations: Vec<String>,
 
+    /// Compression algorithm of the snapshot archive
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub compression_algorithm: Option<CompressionAlgorithm>,
+
     /// Cardano node version
     #[serde(skip_serializing_if = "Option::is_none")]
     pub cardano_node_version: Option<String>,
@@ -49,6 +53,7 @@ impl SnapshotListItemMessage {
                 .unwrap()
                 .with_timezone(&Utc),
             locations: vec!["https://host/certificate.tar.gz".to_string()],
+            compression_algorithm: Some(CompressionAlgorithm::default()),
             cardano_node_version: None,
         }
     }
@@ -73,6 +78,7 @@ mod tests {
                 .unwrap()
                 .with_timezone(&Utc),
             locations: vec!["https://host/certificate.tar.gz".to_string()],
+            compression_algorithm: None,
             cardano_node_version: None,
         }]
     }
@@ -92,6 +98,27 @@ mod tests {
                 .unwrap()
                 .with_timezone(&Utc),
             locations: vec!["https://host/certificate.tar.gz".to_string()],
+            compression_algorithm: None,
+            cardano_node_version: Some("1.0.0".to_string()),
+        }]
+    }
+
+    fn golden_message_v3() -> SnapshotListMessage {
+        vec![SnapshotListItemMessage {
+            digest: "0b9f5ad7f33cc523775c82249294eb8a1541d54f08eb3107cafc5638403ec7c6".to_string(),
+            beacon: Beacon {
+                network: "preview".to_string(),
+                epoch: Epoch(86),
+                immutable_file_number: 1728,
+            },
+            certificate_hash: "d5daf6c03ace4a9c074e951844075b9b373bafc4e039160e3e2af01823e9abfb"
+                .to_string(),
+            size: 807803196,
+            created_at: DateTime::parse_from_rfc3339("2023-01-19T13:43:05.618857482Z")
+                .unwrap()
+                .with_timezone(&Utc),
+            locations: vec!["https://host/certificate.tar.gz".to_string()],
+            compression_algorithm: Some(CompressionAlgorithm::Zstandard),
             cardano_node_version: Some("1.0.0".to_string()),
         }]
     }
@@ -144,4 +171,30 @@ mod tests {
 
         assert_eq!(golden_message_v2(), message);
     }
+
+    // Test the retro compatibility with possible future upgrades.
+    #[test]
+    fn test_v3() {
+        let json = r#"[{
+"digest": "0b9f5ad7f33cc523775c82249294eb8a1541d54f08eb3107cafc5638403ec7c6",
+"beacon": {
+  "network": "preview",
+  "epoch": 86,
+  "immutable_file_number": 1728
+},
+"certificate_hash": "d5daf6c03ace4a9c074e951844075b9b373bafc4e039160e3e2af01823e9abfb",
+"size": 807803196,
+"created_at": "2023-01-19T13:43:05.618857482Z",
+"locations": [
+  "https://host/certificate.tar.gz"
+],
+"compression_algorithm": "zstandard",
+"cardano_node_version": "1.0.0"
+}]"#;
+        let message: SnapshotListMessage = serde_json::from_str(json).expect(
+            "This JSON is expected to be succesfully parsed into a SnapshotListMessage instance.",
+        );
+
+        assert_eq!(golden_message_v3(), message);
+    }
 }

mithril-explorer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mithril-explorer",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "private": true,
   "scripts": {
     "dev": "next dev",
@@ -32,4 +32,4 @@
     "jest-environment-jsdom": "^29.6.4",
     "next-router-mock": "^0.9.9"
   }
-}
+}

mithril-explorer/src/components/Artifacts/SnapshotsList/index.js

@@ -79,9 +79,12 @@ export default function SnapshotsList(props) {
                       <Card.Title>{snapshot.digest}</Card.Title>
                       <ListGroup variant="flush" className="data-list-group">
                         <ListGroup.Item>Epoch: {snapshot.beacon.epoch}</ListGroup.Item>
-                        <ListGroup.Item>Immutable File Number: {snapshot.beacon.immutable_file_number}</ListGroup.Item>
+                        <ListGroup.Item>Immutable file number: {snapshot.beacon.immutable_file_number}</ListGroup.Item>
                         {snapshot.cardano_node_version &&
-                          <ListGroup.Item>Cardano Node Version: {snapshot.cardano_node_version}</ListGroup.Item>
+                          <ListGroup.Item>Cardano node: {snapshot.cardano_node_version}</ListGroup.Item>
+                        }
+                        {snapshot.compression_algorithm &&
+                          <ListGroup.Item>Compression: {snapshot.compression_algorithm}</ListGroup.Item>
                         }
                         <ListGroup.Item>Certificate hash: <br />
                           {snapshot.certificate_hash}{' '}
@@ -90,7 +93,7 @@ export default function SnapshotsList(props) {
                         <ListGroup.Item>
                           Created: <LocalDateTime datetime={snapshot.created_at} />
                         </ListGroup.Item>
-                        <ListGroup.Item>Size: {formatBytes(snapshot.size)}</ListGroup.Item>
+                        <ListGroup.Item>Archive size: {formatBytes(snapshot.size)}</ListGroup.Item>
                       </ListGroup>
                     </Card.Body>
                     <Card.Footer>