tarball: Rename async_process_tarball() to process_tarball()

eth3lbert · eth3lbert · commit 77c490e1b1ff · 2024-11-24T02:07:09.000+08:00
diff --git a/crates/crates_io_tarball/examples/check_all_crates.rs b/crates/crates_io_tarball/examples/check_all_crates.rs
@@ -1,6 +1,6 @@
 use anyhow::anyhow;
 use clap::Parser;
-use crates_io_tarball::async_process_tarball;
+use crates_io_tarball::process_tarball;
 use futures_util::{stream, StreamExt};
 use indicatif::{ParallelProgressIterator, ProgressBar, ProgressIterator, ProgressStyle};
 use rayon::prelude::*;
@@ -76,7 +76,7 @@ async fn process_path(path: &Path, pb: &ProgressBar) {
     let pkg_name = path_no_ext.file_name().unwrap().to_string_lossy();
     pb.set_message(format!("{pkg_name}"));
 
-    let result = async_process_tarball(&pkg_name, &mut file, u64::MAX).await;
+    let result = process_tarball(&pkg_name, &mut file, u64::MAX).await;
     pb.suspend(|| match result {
         Ok(result) => debug!(%pkg_name, path = %path.display(), ?result),
         Err(error) => warn!(%pkg_name, path = %path.display(), %error, "Failed to process tarball"),
diff --git a/crates/crates_io_tarball/examples/read_file.rs b/crates/crates_io_tarball/examples/read_file.rs
@@ -1,6 +1,6 @@
 use anyhow::{anyhow, Context};
 use clap::Parser;
-use crates_io_tarball::async_process_tarball;
+use crates_io_tarball::process_tarball;
 use std::path::PathBuf;
 use tokio::fs::File;
 use tracing_subscriber::filter::LevelFilter;
@@ -31,7 +31,7 @@ async fn main() -> anyhow::Result<()> {
     let path_no_ext = path.with_extension("");
     let pkg_name = path_no_ext.file_name().unwrap().to_string_lossy();
 
-    let result = async_process_tarball(&pkg_name, &mut file, u64::MAX)
+    let result = process_tarball(&pkg_name, &mut file, u64::MAX)
         .await
         .context("Failed to process tarball")?;
 
diff --git a/crates/crates_io_tarball/src/lib.rs b/crates/crates_io_tarball/src/lib.rs
@@ -49,7 +49,7 @@ pub enum TarballError {
 }
 
 #[instrument(skip_all, fields(%pkg_name))]
-pub async fn async_process_tarball<R: tokio::io::AsyncRead + Unpin>(
+pub async fn process_tarball<R: tokio::io::AsyncRead + Unpin>(
     pkg_name: &str,
     tarball: R,
     max_unpack: u64,
@@ -181,7 +181,7 @@ impl AbstractFilesystem for PathsFileSystem {
 
 #[cfg(test)]
 mod tests {
-    use super::async_process_tarball;
+    use super::process_tarball;
     use crate::TarballBuilder;
     use cargo_manifest::{MaybeInherited, StringOrBool};
     use insta::{assert_debug_snapshot, assert_snapshot};
@@ -197,14 +197,13 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         assert_none!(tarball_info.vcs_info);
         assert_none!(tarball_info.manifest.lib);
         assert_eq!(tarball_info.manifest.bin, vec![]);
         assert_eq!(tarball_info.manifest.example, vec![]);
 
-        let err = assert_err!(async_process_tarball("bar-0.0.1", &*tarball, MAX_SIZE).await);
+        let err = assert_err!(process_tarball("bar-0.0.1", &*tarball, MAX_SIZE).await);
         assert_snapshot!(err, @"invalid path found: foo-0.0.1/Cargo.toml");
     }
 
@@ -216,9 +215,8 @@ mod tests {
             .build()
             .await;
 
-        let err = assert_err!(
-            async_process_tarball("foo-0.0.1", &*tarball, tarball.len() as u64 - 1).await
-        );
+        let err =
+            assert_err!(process_tarball("foo-0.0.1", &*tarball, tarball.len() as u64 - 1).await);
         assert_snapshot!(err, @"uploaded tarball is malformed or too large when decompressed");
     }
 
@@ -232,8 +230,7 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         let vcs_info = assert_some!(tarball_info.vcs_info);
         assert_eq!(vcs_info.path_in_vcs, "");
     }
@@ -249,8 +246,7 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         let vcs_info = assert_some!(tarball_info.vcs_info);
         assert_eq!(vcs_info.path_in_vcs, "path/in/vcs");
     }
@@ -271,8 +267,7 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         let package = assert_some!(tarball_info.manifest.package);
         assert_matches!(package.readme, Some(MaybeInherited::Local(StringOrBool::String(s))) if s == "README.md");
         assert_matches!(package.repository, Some(MaybeInherited::Local(s)) if s ==  "https://github.com/foo/bar");
@@ -293,8 +288,7 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         let package = assert_some!(tarball_info.manifest.package);
         assert_matches!(package.rust_version, Some(MaybeInherited::Local(s)) if s == "1.23");
     }
@@ -307,8 +301,7 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         let package = assert_some!(tarball_info.manifest.package);
         assert_none!(package.readme);
     }
@@ -327,8 +320,7 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         let package = assert_some!(tarball_info.manifest.package);
         assert_matches!(package.readme, Some(MaybeInherited::Local(StringOrBool::Bool(b))) if !b);
     }
@@ -347,8 +339,7 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         let package = assert_some!(tarball_info.manifest.package);
         assert_matches!(package.repository, Some(MaybeInherited::Local(s)) if s ==  "https://github.com/foo/bar");
     }
@@ -362,7 +353,7 @@ mod tests {
                 .build()
                 .await;
 
-            async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await
+            process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await
         };
 
         let err = assert_err!(process("CARGO.TOML").await);
@@ -387,7 +378,7 @@ mod tests {
                 .build()
                 .await;
 
-            async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await
+            process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await
         };
 
         let err = assert_err!(process(vec!["cargo.toml", "Cargo.toml"]).await);
@@ -410,8 +401,7 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         let lib = assert_some!(tarball_info.manifest.lib);
         assert_debug_snapshot!(lib);
         assert_eq!(tarball_info.manifest.bin, vec![]);
@@ -434,8 +424,7 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         let lib = assert_some!(tarball_info.manifest.lib);
         assert_debug_snapshot!(lib);
         assert_debug_snapshot!(tarball_info.manifest.bin);
@@ -452,8 +441,7 @@ mod tests {
             .build()
             .await;
 
-        let tarball_info =
-            assert_ok!(async_process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
+        let tarball_info = assert_ok!(process_tarball("foo-0.0.1", &*tarball, MAX_SIZE).await);
         assert_none!(tarball_info.manifest.lib);
         assert_debug_snapshot!(tarball_info.manifest.bin);
         assert_eq!(tarball_info.manifest.example, vec![]);
diff --git a/src/controllers/krate/publish.rs b/src/controllers/krate/publish.rs
@@ -9,7 +9,7 @@ use axum::body::Bytes;
 use axum::Json;
 use cargo_manifest::{Dependency, DepsSet, TargetDepsSet};
 use chrono::{DateTime, SecondsFormat, Utc};
-use crates_io_tarball::{async_process_tarball, TarballError};
+use crates_io_tarball::{process_tarball, TarballError};
 use crates_io_worker::BackgroundJob;
 use diesel::dsl::{exists, select};
 use diesel::prelude::*;
@@ -154,7 +154,7 @@ pub async fn publish(app: AppState, req: BytesRequest) -> AppResult<Json<GoodCra
     let pkg_name = format!("{}-{}", &*metadata.name, &version_string);
     let tarball_bytes = tarball_bytes.clone();
     let tarball_info =
-        async_process_tarball(&pkg_name, &*tarball_bytes, maximums.max_unpack_size).await?;
+        process_tarball(&pkg_name, &*tarball_bytes, maximums.max_unpack_size).await?;
 
     // `unwrap()` is safe here since `process_tarball()` validates that
     // we only accept manifests with a `package` section and without
