Merge pull request #2768 from github/smowton/fix/zstd-tarball-trailin…

…g-zeros Pass `--ignore-zeros` to `tar` when decompressing `zstd`-compressed tarballs
github · Feb 18, 2025 · 1bb15d0 · 1bb15d0
2 parents acadfed + c4158ff
commit 1bb15d0
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/lib/tar.js b/lib/tar.js
diff --git a/lib/tar.js.map b/lib/tar.js.map
diff --git a/src/tar.ts b/src/tar.ts
@@ -168,7 +168,16 @@ export async function extractTarZst(
 
   try {
     // Initialize args
-    const args = ["-x", "--zstd"];
+    //
+    // `--ignore-zeros` means that trailing zero bytes at the end of an archive will be read
+    // by `tar` in case a further concatenated archive follows. Otherwise when a tarball built
+    // by GNU tar, which writes many trailing zeroes, is read by BSD tar, which expects less, then
+    // BSD tar can hang up the pipe to its filter program early, and if that program is `zstd`
+    // then it will try to write the remaining zeroes, get an EPIPE error because `tar` has closed
+    // its end of the pipe, return 1, and `tar` will pass the error along.
+    //
+    // See also https://github.com/facebook/zstd/issues/4294
+    const args = ["-x", "--zstd", "--ignore-zeros"];
 
     if (tarVersion.type === "gnu") {
       // Suppress warnings when using GNU tar to extract archives created by BSD tar