fix(fs): Fixes the Zip magic fd bits (#4737)

* Fixes the Zip magic fd bits * Reverts changes to the readdir signatures * Reverts extra changes * Updates the hook * Feedback
yarnpkg · Aug 12, 2022 · 380b32b · 380b32b
1 parent 3741be5
commit 380b32b
Show file tree

Hide file tree

Showing 6 changed files with 115 additions and 37 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.yarn/versions/70c62085.yml b/.yarn/versions/70c62085.yml
@@ -0,0 +1,37 @@
+releases:
+  "@yarnpkg/cli": patch
+  "@yarnpkg/fslib": patch
+  "@yarnpkg/pnp": patch
+
+declined:
+  - "@yarnpkg/builder"
+  - "@yarnpkg/esbuild-plugin-pnp"
+  - "@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-init"
+  - "@yarnpkg/plugin-interactive-tools"
+  - "@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-typescript"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/plugin-workspace-tools"
+  - vscode-zipfs
+  - "@yarnpkg/core"
+  - "@yarnpkg/doctor"
+  - "@yarnpkg/nm"
+  - "@yarnpkg/pnpify"
+  - "@yarnpkg/sdks"
+  - "@yarnpkg/shell"
diff --git a/packages/yarnpkg-fslib/sources/ZipOpenFS.ts b/packages/yarnpkg-fslib/sources/ZipOpenFS.ts
@@ -11,7 +11,15 @@ import {watchFile, unwatchFile, unwatchAllFiles}
 import * as errors                                                                                                                                   from './errors';
 import {Filename, FSPath, npath, PortablePath, ppath}                                                                                                from './path';
 
-const ZIP_FD = 0x80000000;
+// Only file descriptors prefixed by those values will be forwarded to the ZipFS
+// instances. Note that the highest ZIP_MAGIC bit MUST NOT be set, otherwise the
+// resulting fd becomes a negative integer, which isn't supposed to happen per
+// the unix rules (caused problems w/ Go).
+//
+// Those values must be synced with packages/yarnpkg-pnp/sources/esm-loader/fspatch.ts
+//
+const ZIP_MASK  = 0xff000000;
+const ZIP_MAGIC = 0x2a000000;
 
 /**
  * Extracts the archive part (ending in the first instance of `extension`) from a path.
@@ -155,7 +163,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   }
 
   private remapFd(zipFs: ZipFS, fd: number) {
-    const remappedFd = this.nextFd++ | ZIP_FD;
+    const remappedFd = this.nextFd++ | ZIP_MAGIC;
     this.fdMap.set(remappedFd, [zipFs, fd]);
     return remappedFd;
   }
@@ -197,7 +205,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   }
 
   async readPromise(fd: number, buffer: Buffer, offset: number, length: number, position: number) {
-    if ((fd & ZIP_FD) === 0)
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC)
       return await this.baseFs.readPromise(fd, buffer, offset, length, position);
 
     const entry = this.fdMap.get(fd);
@@ -209,7 +217,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   }
 
   readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number) {
-    if ((fd & ZIP_FD) === 0)
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC)
       return this.baseFs.readSync(fd, buffer, offset, length, position);
 
     const entry = this.fdMap.get(fd);
@@ -223,7 +231,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   writePromise(fd: number, buffer: Buffer, offset?: number, length?: number, position?: number): Promise<number>;
   writePromise(fd: number, buffer: string, position?: number): Promise<number>;
   async writePromise(fd: number, buffer: Buffer | string, offset?: number, length?: number, position?: number): Promise<number> {
-    if ((fd & ZIP_FD) === 0) {
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC) {
       if (typeof buffer === `string`) {
         return await this.baseFs.writePromise(fd, buffer, offset);
       } else {
@@ -247,7 +255,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   writeSync(fd: number, buffer: Buffer, offset?: number, length?: number, position?: number): number;
   writeSync(fd: number, buffer: string, position?: number): number;
   writeSync(fd: number, buffer: Buffer | string, offset?: number, length?: number, position?: number): number {
-    if ((fd & ZIP_FD) === 0) {
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC) {
       if (typeof buffer === `string`) {
         return this.baseFs.writeSync(fd, buffer, offset);
       } else {
@@ -269,7 +277,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   }
 
   async closePromise(fd: number) {
-    if ((fd & ZIP_FD) === 0)
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC)
       return await this.baseFs.closePromise(fd);
 
     const entry = this.fdMap.get(fd);
@@ -283,7 +291,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   }
 
   closeSync(fd: number) {
-    if ((fd & ZIP_FD) === 0)
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC)
       return this.baseFs.closeSync(fd);
 
     const entry = this.fdMap.get(fd);
@@ -415,7 +423,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   async fstatPromise(fd: number, opts: {bigint: true}): Promise<BigIntStats>
   async fstatPromise(fd: number, opts?: {bigint: boolean}): Promise<BigIntStats | Stats>
   async fstatPromise(fd: number, opts?: { bigint: boolean }) {
-    if ((fd & ZIP_FD) === 0)
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC)
       return this.baseFs.fstatPromise(fd, opts);
 
     const entry = this.fdMap.get(fd);
@@ -430,7 +438,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   fstatSync(fd: number, opts: {bigint: true}): BigIntStats
   fstatSync(fd: number, opts?: {bigint: boolean}): BigIntStats | Stats
   fstatSync(fd: number, opts?: { bigint: boolean }) {
-    if ((fd & ZIP_FD) === 0)
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC)
       return this.baseFs.fstatSync(fd, opts);
 
     const entry = this.fdMap.get(fd);
@@ -469,7 +477,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   }
 
   async fchmodPromise(fd: number, mask: number): Promise<void> {
-    if ((fd & ZIP_FD) === 0)
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC)
       return this.baseFs.fchmodPromise(fd, mask);
 
     const entry = this.fdMap.get(fd);
@@ -481,7 +489,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   }
 
   fchmodSync(fd: number, mask: number): void {
-    if ((fd & ZIP_FD) === 0)
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC)
       return this.baseFs.fchmodSync(fd, mask);
 
     const entry = this.fdMap.get(fd);
@@ -857,7 +865,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   }
 
   async ftruncatePromise(fd: number, len?: number): Promise<void> {
-    if ((fd & ZIP_FD) === 0)
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC)
       return this.baseFs.ftruncatePromise(fd, len);
 
     const entry = this.fdMap.get(fd);
@@ -869,7 +877,7 @@ export class ZipOpenFS extends BasePortableFakeFS {
   }
 
   ftruncateSync(fd: number, len?: number): void {
-    if ((fd & ZIP_FD) === 0)
+    if ((fd & ZIP_MASK) !== ZIP_MAGIC)
       return this.baseFs.ftruncateSync(fd, len);
 
     const entry = this.fdMap.get(fd);