Rename BlobId fields in File/Directory for clarity

brioche-dev · Jan 27, 2024 · 8c1e861 · 8c1e861
1 parent 5240090
commit 8c1e861
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 36 deletions.
diff --git a/crates/brioche/benches/brioche_bench/mod.rs b/crates/brioche/benches/brioche_bench/mod.rs
@@ -46,7 +46,7 @@ pub async fn blob(brioche: &Brioche, content: impl AsRef<[u8]> + std::marker::Un
 
 pub fn lazy_file(blob: BlobId, executable: bool) -> brioche::brioche::artifact::LazyArtifact {
     brioche::brioche::artifact::LazyArtifact::File {
-        data: blob,
+        content_blob: blob,
         executable,
         resources: Box::new(WithMeta::without_meta(
             brioche::brioche::artifact::LazyArtifact::Directory(Directory::default()),
@@ -56,7 +56,7 @@ pub fn lazy_file(blob: BlobId, executable: bool) -> brioche::brioche::artifact::
 
 pub fn file(blob: BlobId, executable: bool) -> brioche::brioche::artifact::CompleteArtifact {
     brioche::brioche::artifact::CompleteArtifact::File(File {
-        data: blob,
+        content_blob: blob,
         executable,
         resources: Directory::default(),
     })
@@ -68,7 +68,7 @@ pub fn file_with_resources(
     resources: brioche::brioche::artifact::Directory,
 ) -> brioche::brioche::artifact::CompleteArtifact {
     brioche::brioche::artifact::CompleteArtifact::File(File {
-        data: blob,
+        content_blob: blob,
         executable,
         resources,
     })

diff --git a/crates/brioche/src/brioche/artifact.rs b/crates/brioche/src/brioche/artifact.rs
@@ -34,7 +34,7 @@ use super::{
 pub enum LazyArtifact {
     #[serde(rename_all = "camelCase")]
     File {
-        data: BlobId,
+        content_blob: BlobId,
         executable: bool,
         resources: Box<WithMeta<LazyArtifact>>,
     },
@@ -54,7 +54,7 @@ pub enum LazyArtifact {
     #[serde(rename_all = "camelCase")]
     CreateFile {
         #[serde_as(as = "UrlEncoded")]
-        data: BString,
+        content: BString,
         executable: bool,
         resources: Box<WithMeta<LazyArtifact>>,
     },
@@ -334,7 +334,7 @@ impl CompleteArtifact {
 #[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct File {
-    pub data: BlobId,
+    pub content_blob: BlobId,
     pub executable: bool,
     pub resources: Directory,
 }
@@ -343,7 +343,7 @@ pub struct File {
 #[derive(Debug, Default, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct Directory {
-    pub tree: Option<BlobId>,
+    pub listing_blob: Option<BlobId>,
 }
 
 impl Directory {
@@ -359,16 +359,16 @@ impl Directory {
         );
         listing.serialize(&mut serializer)?;
 
-        let tree_blob_id =
+        let listing_blob =
             blob::save_blob(brioche, &listing_json, blob::SaveBlobOptions::default()).await?;
 
         Ok(Self {
-            tree: Some(tree_blob_id),
+            listing_blob: Some(listing_blob),
         })
     }
 
     pub async fn listing(&self, brioche: &Brioche) -> anyhow::Result<DirectoryListing> {
-        match self.tree {
+        match self.listing_blob {
             Some(tree_blob_id) => {
                 let blob_path = blob::blob_path(brioche, tree_blob_id);
                 let listing_json = tokio::fs::read(&blob_path).await?;
@@ -380,7 +380,7 @@ impl Directory {
     }
 
     pub fn is_empty(&self) -> bool {
-        self.tree.is_none()
+        self.listing_blob.is_none()
     }
 }
 
@@ -576,7 +576,7 @@ impl TryFrom<LazyArtifact> for CompleteArtifact {
     fn try_from(value: LazyArtifact) -> Result<Self, Self::Error> {
         match value {
             LazyArtifact::File {
-                data,
+                content_blob: data,
                 executable,
                 resources,
             } => {
@@ -585,7 +585,7 @@ impl TryFrom<LazyArtifact> for CompleteArtifact {
                     return Err(ArtifactIncomplete);
                 };
                 Ok(CompleteArtifact::File(File {
-                    data,
+                    content_blob: data,
                     executable,
                     resources,
                 }))
@@ -616,11 +616,11 @@ impl From<CompleteArtifact> for LazyArtifact {
     fn from(value: CompleteArtifact) -> Self {
         match value {
             CompleteArtifact::File(File {
-                data,
+                content_blob: data,
                 executable,
                 resources,
             }) => Self::File {
-                data,
+                content_blob: data,
                 executable,
                 resources: Box::new(WithMeta::without_meta(LazyArtifact::Directory(resources))),
             },

diff --git a/crates/brioche/src/brioche/input.rs b/crates/brioche/src/brioche/input.rs
@@ -154,7 +154,7 @@ pub async fn create_input(
 
         Ok(WithMeta::new(
             CompleteArtifact::File(File {
-                data: blob_id,
+                content_blob: blob_id,
                 executable,
                 resources,
             }),

diff --git a/crates/brioche/src/brioche/output.rs b/crates/brioche/src/brioche/output.rs
@@ -24,7 +24,7 @@ pub async fn create_output<'a: 'async_recursion>(
 ) -> anyhow::Result<()> {
     match artifact {
         CompleteArtifact::File(File {
-            data,
+            content_blob,
             executable,
             resources,
         }) => {
@@ -45,7 +45,7 @@ pub async fn create_output<'a: 'async_recursion>(
                 .await?;
             }
 
-            let blob_path = super::blob::blob_path(brioche, *data);
+            let blob_path = super::blob::blob_path(brioche, *content_blob);
             tokio::fs::copy(&blob_path, options.output_path)
                 .await
                 .with_context(|| {

diff --git a/crates/brioche/src/brioche/resolve.rs b/crates/brioche/src/brioche/resolve.rs
@@ -189,7 +189,7 @@ async fn resolve_inner(
 ) -> anyhow::Result<CompleteArtifact> {
     match artifact {
         LazyArtifact::File {
-            data,
+            content_blob,
             executable,
             resources,
         } => {
@@ -198,7 +198,7 @@ async fn resolve_inner(
                 anyhow::bail!("file resources resolved to non-directory value");
             };
             Ok(CompleteArtifact::File(File {
-                data,
+                content_blob,
                 executable,
                 resources,
             }))
@@ -230,12 +230,12 @@ async fn resolve_inner(
             Ok(result)
         }
         LazyArtifact::CreateFile {
-            data,
+            content,
             executable,
             resources,
         } => {
             let blob_id =
-                super::blob::save_blob(brioche, &data, super::blob::SaveBlobOptions::default())
+                super::blob::save_blob(brioche, &content, super::blob::SaveBlobOptions::default())
                     .await?;
 
             let resources = resolve(brioche, *resources).await?;
@@ -244,7 +244,7 @@ async fn resolve_inner(
             };
 
             Ok(CompleteArtifact::File(File {
-                data: blob_id,
+                content_blob: blob_id,
                 executable,
                 resources,
             }))

diff --git a/crates/brioche/src/brioche/resolve/download.rs b/crates/brioche/src/brioche/resolve/download.rs
@@ -72,7 +72,7 @@ pub async fn resolve_download(
     );
 
     Ok(File {
-        data: blob_id,
+        content_blob: blob_id,
         executable: false,
         resources: Directory::default(),
     })

diff --git a/crates/brioche/src/brioche/resolve/unpack.rs b/crates/brioche/src/brioche/resolve/unpack.rs
@@ -19,7 +19,11 @@ pub async fn resolve_unpack(
     unpack: UnpackArtifact,
 ) -> anyhow::Result<Directory> {
     let file = super::resolve(brioche, *unpack.file).await?;
-    let CompleteArtifact::File(File { data: blob_id, .. }) = file.value else {
+    let CompleteArtifact::File(File {
+        content_blob: blob_id,
+        ..
+    }) = file.value
+    else {
         anyhow::bail!("expected archive to be a file");
     };
 
@@ -62,7 +66,7 @@ pub async fn resolve_unpack(
                     let executable = entry_mode & 0o100 != 0;
 
                     CompleteArtifact::File(File {
-                        data: entry_blob_id,
+                        content_blob: entry_blob_id,
                         executable,
                         resources: Directory::default(),
                     })

diff --git a/crates/brioche/tests/artifact_hash_stable.rs b/crates/brioche/tests/artifact_hash_stable.rs
@@ -63,7 +63,7 @@ async fn test_artifact_hash_stable_file() -> anyhow::Result<()> {
         )
         .hash()
         .to_string(),
-        "4ffde3f046dfb46f4d7e7c794799dfe81b452683fd90bc18659dccd792c4a400",
+        "47bb5f180d0206135e843e3aa81f12106124851e8f48f0143e7d6a35053c6f6e",
     ));
     asserts.push((
         brioche_test::lazy_file_with_resources(
@@ -79,7 +79,7 @@ async fn test_artifact_hash_stable_file() -> anyhow::Result<()> {
         )
         .hash()
         .to_string(),
-        "551c9204afe0b6fe0438b84b889df3c76d19368e2c3ed0a4c13ebde8fadf6dfe",
+        "3ded790822fdddc49a48fef5ec466d4cfa5b36629799e732be561dad7cad1cef",
     ));
 
     let left: Vec<_> = asserts.iter().map(|(left, _)| left).collect();
@@ -118,7 +118,7 @@ async fn test_artifact_hash_stable_directory() -> anyhow::Result<()> {
         .await
         .hash()
         .to_string(),
-        "e741c7f33e7845f3f659c0484bb889645daf338677d2a3209a472e4406eae404",
+        "773e23ae9256d18dbea707c79f6d2d2c018b910a992b6c75e71ef26dd7a32233",
     ));
     asserts.push((
         LazyArtifact::from(
@@ -130,7 +130,7 @@ async fn test_artifact_hash_stable_directory() -> anyhow::Result<()> {
         )
         .hash()
         .to_string(),
-        "e741c7f33e7845f3f659c0484bb889645daf338677d2a3209a472e4406eae404",
+        "773e23ae9256d18dbea707c79f6d2d2c018b910a992b6c75e71ef26dd7a32233",
     ));
 
     asserts.push((
@@ -148,7 +148,7 @@ async fn test_artifact_hash_stable_directory() -> anyhow::Result<()> {
         .await
         .hash()
         .to_string(),
-        "02360a3026e4c5623a29b0437b5f7ca21fc23810befdc20c3ce5915dce96ba17",
+        "04155278894583935b64b9fe655e6d865ac3aff93fa790bcff4bbe9710ebe08b",
     ));
     asserts.push((
         LazyArtifact::from(
@@ -170,7 +170,7 @@ async fn test_artifact_hash_stable_directory() -> anyhow::Result<()> {
         )
         .hash()
         .to_string(),
-        "02360a3026e4c5623a29b0437b5f7ca21fc23810befdc20c3ce5915dce96ba17",
+        "04155278894583935b64b9fe655e6d865ac3aff93fa790bcff4bbe9710ebe08b",
     ));
 
     asserts.push((

diff --git a/crates/brioche/tests/brioche_test/mod.rs b/crates/brioche/tests/brioche_test/mod.rs
@@ -58,7 +58,7 @@ pub async fn blob(brioche: &Brioche, content: impl AsRef<[u8]> + std::marker::Un
 
 pub fn lazy_file(blob: BlobId, executable: bool) -> brioche::brioche::artifact::LazyArtifact {
     brioche::brioche::artifact::LazyArtifact::File {
-        data: blob,
+        content_blob: blob,
         executable,
         resources: Box::new(WithMeta::without_meta(
             brioche::brioche::artifact::LazyArtifact::Directory(Directory::default()),
@@ -72,15 +72,15 @@ pub fn lazy_file_with_resources(
     resources: brioche::brioche::artifact::LazyArtifact,
 ) -> brioche::brioche::artifact::LazyArtifact {
     brioche::brioche::artifact::LazyArtifact::File {
-        data: blob,
+        content_blob: blob,
         executable,
         resources: Box::new(WithMeta::without_meta(resources)),
     }
 }
 
 pub fn file(blob: BlobId, executable: bool) -> brioche::brioche::artifact::CompleteArtifact {
     brioche::brioche::artifact::CompleteArtifact::File(File {
-        data: blob,
+        content_blob: blob,
         executable,
         resources: Directory::default(),
     })
@@ -92,7 +92,7 @@ pub fn file_with_resources(
     resources: brioche::brioche::artifact::Directory,
 ) -> brioche::brioche::artifact::CompleteArtifact {
     brioche::brioche::artifact::CompleteArtifact::File(File {
-        data: blob,
+        content_blob: blob,
         executable,
         resources,
     })