Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow setting timestamp when writing archives #171

Merged
merged 2 commits into from
Apr 18, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions crates/rattler_package_streaming/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ rattler_conda_types = { version = "0.2.0", path = "../rattler_conda_types" }
itertools = "0.10.5"
serde_json = "1.0.94"
url = "2.3.1"
chrono = "0.4.24"

[features]
tokio = ["dep:tokio", "bzip2/tokio", "tokio/fs", "tokio-util/io", "tokio-util/io-util", "reqwest?/stream", "futures-util"]
Expand Down
28 changes: 23 additions & 5 deletions crates/rattler_package_streaming/src/write.rs
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ pub fn write_tar_bz2_package<W: Write>(
base_path: &Path,
paths: &[PathBuf],
compression_level: CompressionLevel,
timestamp: &Option<chrono::DateTime<chrono::Utc>>,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use Option<&T> instead of &Option<T>.

See: https://stackoverflow.com/a/71027236

) -> Result<(), std::io::Error> {
let mut archive = tar::Builder::new(bzip2::write::BzEncoder::new(
writer,
Expand All @@ -130,7 +131,7 @@ pub fn write_tar_bz2_package<W: Write>(
// sort paths alphabetically, and sort paths beginning with `info/` first
let (info_paths, other_paths) = sort_paths(paths, base_path);
for path in info_paths.chain(other_paths) {
append_path_to_archive(&mut archive, base_path, &path)?;
append_path_to_archive(&mut archive, base_path, &path, timestamp)?;
}

archive.into_inner()?.finish()?;
Expand All @@ -144,14 +145,15 @@ fn write_zst_archive<W: Write>(
base_path: &Path,
paths: impl Iterator<Item = PathBuf>,
compression_level: CompressionLevel,
timestamp: &Option<chrono::DateTime<chrono::Utc>>,
) -> Result<(), std::io::Error> {
// TODO figure out multi-threading for zstd
let compression_level = compression_level.to_zstd_level()?;
let mut archive = tar::Builder::new(zstd::Encoder::new(writer, compression_level)?);
archive.follow_symlinks(false);

for path in paths {
append_path_to_archive(&mut archive, base_path, &path)?;
append_path_to_archive(&mut archive, base_path, &path, timestamp)?;
}

archive.into_inner()?.finish()?;
Expand Down Expand Up @@ -182,6 +184,7 @@ pub fn write_conda_package<W: Write + Seek>(
paths: &[PathBuf],
compression_level: CompressionLevel,
out_name: &str,
timestamp: Option<chrono::DateTime<chrono::Utc>>,
) -> Result<(), std::io::Error> {
// first create the outer zip archive that uses no compression
let mut outer_archive = zip::ZipWriter::new(writer);
Expand All @@ -202,18 +205,28 @@ pub fn write_conda_package<W: Write + Seek>(
base_path,
other_paths,
compression_level,
&timestamp,
)?;

// info paths come last
outer_archive.start_file(format!("info-{out_name}.tar.zst"), options)?;
write_zst_archive(&mut outer_archive, base_path, info_paths, compression_level)?;
write_zst_archive(
&mut outer_archive,
base_path,
info_paths,
compression_level,
&timestamp,
)?;

outer_archive.finish()?;

Ok(())
}

fn prepare_header(path: &Path) -> Result<tar::Header, std::io::Error> {
fn prepare_header(
path: &Path,
timestamp: &Option<chrono::DateTime<chrono::Utc>>,
) -> Result<tar::Header, std::io::Error> {
let mut header = tar::Header::new_gnu();
let name = b"././@LongLink";
header.as_gnu_mut().unwrap().name[..name.len()].clone_from_slice(&name[..]);
Expand All @@ -227,6 +240,10 @@ fn prepare_header(path: &Path) -> Result<tar::Header, std::io::Error> {
header.set_device_minor(0)?;
header.set_device_major(0)?;

if let Some(timestamp) = timestamp {
header.set_mtime(timestamp.timestamp() as u64);
}

// let file_size = stat.len();
// TODO do we need this
// + 1 to be compliant with GNU tar
Expand All @@ -243,9 +260,10 @@ fn append_path_to_archive(
archive: &mut tar::Builder<impl Write>,
base_path: &Path,
path: &Path,
timestamp: &Option<chrono::DateTime<chrono::Utc>>,
) -> Result<(), std::io::Error> {
// create a tar header
let mut header = prepare_header(&base_path.join(path))
let mut header = prepare_header(&base_path.join(path), timestamp)
.map_err(|err| trace_file_error(&base_path.join(path), err))?;

if header.entry_type().is_file() {
Expand Down
10 changes: 9 additions & 1 deletion crates/rattler_package_streaming/tests/write.rs
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,14 @@ fn test_rewrite_tar_bz2() {

let writer = File::create(&new_archive).unwrap();
let paths = find_all_package_files(&target_dir);
write_tar_bz2_package(writer, &target_dir, &paths, CompressionLevel::Default).unwrap();
write_tar_bz2_package(
writer,
&target_dir,
&paths,
CompressionLevel::Default,
&None,
)
.unwrap();

// compare the two archives
let mut f1 = File::open(&file_path).unwrap();
Expand Down Expand Up @@ -217,6 +224,7 @@ fn test_rewrite_conda() {
&paths,
CompressionLevel::Default,
&name,
None,
)
.unwrap();

Expand Down