fix(pnp): disable patching binding.fstat when possible (#5402)

yarnpkg · Apr 24, 2023 · f253613 · f253613
1 parent 638fba9
commit f253613
Show file tree

Hide file tree

Showing 5 changed files with 97 additions and 60 deletions.
diff --git a/.pnp.loader.mjs b/.pnp.loader.mjs
diff --git a/.yarn/versions/75340348.yml b/.yarn/versions/75340348.yml
@@ -0,0 +1,27 @@
+releases:
+  "@yarnpkg/cli": patch
+  "@yarnpkg/plugin-pnp": patch
+  "@yarnpkg/pnp": patch
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-dlx"
+  - "@yarnpkg/plugin-essentials"
+  - "@yarnpkg/plugin-init"
+  - "@yarnpkg/plugin-interactive-tools"
+  - "@yarnpkg/plugin-nm"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/plugin-pack"
+  - "@yarnpkg/plugin-patch"
+  - "@yarnpkg/plugin-pnpm"
+  - "@yarnpkg/plugin-stage"
+  - "@yarnpkg/plugin-typescript"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/plugin-workspace-tools"
+  - "@yarnpkg/builder"
+  - "@yarnpkg/core"
+  - "@yarnpkg/doctor"
+  - "@yarnpkg/nm"
+  - "@yarnpkg/pnpify"
+  - "@yarnpkg/sdks"
diff --git a/packages/yarnpkg-pnp/sources/esm-loader/built-loader.js b/packages/yarnpkg-pnp/sources/esm-loader/built-loader.js
diff --git a/packages/yarnpkg-pnp/sources/esm-loader/fspatch.ts b/packages/yarnpkg-pnp/sources/esm-loader/fspatch.ts
@@ -1,7 +1,10 @@
-import fs from 'fs';
+import fs                            from 'fs';
+
+import {HAS_LAZY_LOADED_TRANSLATORS} from './loaderFlags';
 
 //#region ESM to CJS support
-/*
+if (!HAS_LAZY_LOADED_TRANSLATORS) {
+  /*
   In order to import CJS files from ESM Node does some translating
   internally[1]. This translator calls an unpatched `readFileSync`[2]
   which itself calls an internal `tryStatSync`[3] which calls
@@ -16,34 +19,33 @@ import fs from 'fs';
   5: https://github.com/nodejs/node/pull/39513
 */
 
-const binding = (process as any).binding(`fs`) as {
-  fstat: (fd: number, useBigint: false, req: any, ctx: object) => Float64Array;
-};
-const originalfstat = binding.fstat;
+  const binding = (process as any).binding(`fs`) as {
+    fstat: (fd: number, useBigint: false, req: any, ctx: object) => Float64Array;
+  };
+  const originalfstat = binding.fstat;
 
-// Those values must be synced with packages/yarnpkg-fslib/sources/ZipOpenFS.ts
-//
-const ZIP_MASK  = 0xff000000;
-const ZIP_MAGIC = 0x2a000000;
+  // Those values must be synced with packages/yarnpkg-fslib/sources/ZipOpenFS.ts
+  const ZIP_MASK  = 0xff000000;
+  const ZIP_MAGIC = 0x2a000000;
 
-binding.fstat = function(...args) {
-  const [fd, useBigint, req] = args;
-  if ((fd & ZIP_MASK) === ZIP_MAGIC && useBigint === false && req === undefined) {
-    try {
-      const stats = fs.fstatSync(fd);
-      // The reverse of this internal util
-      // https://github.com/nodejs/node/blob/8886b63cf66c29d453fdc1ece2e489dace97ae9d/lib/internal/fs/utils.js#L542-L551
-      return new Float64Array([
-        stats.dev,
-        stats.mode,
-        stats.nlink,
-        stats.uid,
-        stats.gid,
-        stats.rdev,
-        stats.blksize,
-        stats.ino,
-        stats.size,
-        stats.blocks,
+  binding.fstat = function(...args) {
+    const [fd, useBigint, req] = args;
+    if ((fd & ZIP_MASK) === ZIP_MAGIC && useBigint === false && req === undefined) {
+      try {
+        const stats = fs.fstatSync(fd);
+        // The reverse of this internal util
+        // https://github.com/nodejs/node/blob/8886b63cf66c29d453fdc1ece2e489dace97ae9d/lib/internal/fs/utils.js#L542-L551
+        return new Float64Array([
+          stats.dev,
+          stats.mode,
+          stats.nlink,
+          stats.uid,
+          stats.gid,
+          stats.rdev,
+          stats.blksize,
+          stats.ino,
+          stats.size,
+          stats.blocks,
         // atime sec
         // atime ns
         // mtime sec
@@ -52,10 +54,11 @@ binding.fstat = function(...args) {
         // ctime ns
         // birthtime sec
         // birthtime ns
-      ]);
-    } catch {}
-  }
+        ]);
+      } catch {}
+    }
 
-  return originalfstat.apply(this, args);
-};
+    return originalfstat.apply(this, args);
+  };
+}
 //#endregion
diff --git a/packages/yarnpkg-pnp/sources/esm-loader/loaderFlags.ts b/packages/yarnpkg-pnp/sources/esm-loader/loaderFlags.ts
@@ -11,3 +11,7 @@ export const HAS_JSON_IMPORT_ASSERTION_REQUIREMENT = major > 17 || (major === 17
 
 // The message switched to using an array in https://github.com/nodejs/node/pull/45348
 export const WATCH_MODE_MESSAGE_USES_ARRAYS = major > 19 || (major === 19 && minor >= 2) || (major === 18 && minor >= 13);
+
+// https://github.com/nodejs/node/pull/45659 changed the internal translators to be lazy loaded
+// TODO: Update the version range if https://github.com/nodejs/node/pull/46425 lands.
+export const HAS_LAZY_LOADED_TRANSLATORS = major > 19 || (major === 19 && minor >= 3);