fix(ZipFS): support empty archives resulting from an unlink after wri…

…te in `getBufferAndClose` (#5179) * fix(ZipFS): support empty archives resulting from an unlink after write in `getBufferAndClose` * chore: update artifacts
yarnpkg · Jan 6, 2023 · f6ecf9d · f6ecf9d
1 parent 8bf48bb
commit f6ecf9d
Showing 7 changed files with 69 additions and 2 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.yarn/versions/1f698bb0.yml b/.yarn/versions/1f698bb0.yml
@@ -0,0 +1,36 @@
+releases:
+  "@yarnpkg/fslib": patch
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-dlx"
+  - "@yarnpkg/plugin-essentials"
+  - "@yarnpkg/plugin-exec"
+  - "@yarnpkg/plugin-file"
+  - "@yarnpkg/plugin-git"
+  - "@yarnpkg/plugin-github"
+  - "@yarnpkg/plugin-http"
+  - "@yarnpkg/plugin-init"
+  - "@yarnpkg/plugin-link"
+  - "@yarnpkg/plugin-nm"
+  - "@yarnpkg/plugin-npm"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/plugin-pack"
+  - "@yarnpkg/plugin-patch"
+  - "@yarnpkg/plugin-pnp"
+  - "@yarnpkg/plugin-pnpm"
+  - "@yarnpkg/plugin-stage"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/plugin-workspace-tools"
+  - vscode-zipfs
+  - "@yarnpkg/builder"
+  - "@yarnpkg/cli"
+  - "@yarnpkg/core"
+  - "@yarnpkg/doctor"
+  - "@yarnpkg/json-proxy"
+  - "@yarnpkg/nm"
+  - "@yarnpkg/pnp"
+  - "@yarnpkg/pnpify"
+  - "@yarnpkg/sdks"
+  - "@yarnpkg/shell"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,12 @@ Yarn now accepts sponsorships! Please give a look at our [OpenCollective](https:
 
 ## Master
 
+## TBD
+
+### Bugfixes
+
+- `ZipFS.prototype.getBufferAndClose` will not error on empty archives resulting from an unlink after write.
+
 ## 3.3.1
 
 ### Installs

diff --git a/packages/yarnpkg-core/sources/worker-zip/index.js b/packages/yarnpkg-core/sources/worker-zip/index.js
diff --git a/packages/yarnpkg-fslib/sources/ZipFS.ts b/packages/yarnpkg-fslib/sources/ZipFS.ts
@@ -238,6 +238,12 @@ export class ZipFS extends BasePortableFakeFS {
     if (!this.lzSource)
       throw new Error(`ZipFS was not created from a Buffer`);
 
+    // zip_source_open on an unlink-after-write empty archive fails with "Entry has been deleted"
+    if (this.entries.size === 0) {
+      this.discardAndClose();
+      return makeEmptyArchive();
+    }
+
     try {
       // Prevent close from cleaning up the source
       this.libzip.source.keep(this.lzSource);

diff --git a/packages/yarnpkg-fslib/tests/ZipFS.test.ts b/packages/yarnpkg-fslib/tests/ZipFS.test.ts
@@ -705,6 +705,21 @@ describe(`ZipFS`, () => {
     expect(new ZipFS(buffer, {libzip}).readdirSync(PortablePath.root)).toHaveLength(0);
   });
 
+  it(`should support getting the buffer from an empty in-memory zip archive (unlink after write)`, () => {
+    const libzip = getLibzipSync();
+
+    const zipFs = new ZipFS(null, {libzip});
+
+    zipFs.writeFileSync(`/foo.txt` as PortablePath, `foo`);
+    zipFs.unlinkSync(`/foo.txt` as PortablePath);
+
+    const buffer = zipFs.getBufferAndClose();
+
+    expect(buffer).toStrictEqual(makeEmptyArchive());
+
+    expect(new ZipFS(buffer, {libzip}).readdirSync(PortablePath.root)).toHaveLength(0);
+  });
+
   ifNotWin32It(`should preserve the umask`, async () => {
     const tmpdir = xfs.mktempSync();
     const archive = `${tmpdir}/archive.zip` as PortablePath;

diff --git a/packages/yarnpkg-pnp/sources/hook.js b/packages/yarnpkg-pnp/sources/hook.js