fix(runtime): require cache should not include unevaluated ESM modules. (#5233)

Author: paperclover

src/js/builtins/ImportMetaObject.ts

@@ -177,13 +177,11 @@ export function createRequireCache() {
 
     ownKeys(target) {
       var array = [...$requireMap.$keys()];
-      const registryKeys = [...Loader.registry.$keys()];
-      for (const key of registryKeys) {
-        if (!array.includes(key)) {
+      for (const key of Loader.registry.$keys()) {
+        if (!array.includes(key) && Loader.registry.$get(key)?.evaluated) {
           $arrayPush(array, key);
         }
       }
-
       return array;
     },
 
@@ -193,7 +191,7 @@ export function createRequireCache() {
     },
 
     getOwnPropertyDescriptor(target, key: string) {
-      if ($requireMap.$has(key) || Loader.registry.$has(key)) {
+      if ($requireMap.$has(key) || Loader.registry.$get(key)?.evaluated) {
         return {
           configurable: true,
           enumerable: true,

src/js/out/WebCoreJSBuiltins.cpp

@@ -0,0 +1,21 @@
+const { strictEqual, ok } = require("assert");
+
+Loader.registry.set("bad", { evaluated: false });
+strictEqual(require.cache.bad, undefined);
+ok(!Object.hasOwn(require.cache, "bad"));
+ok(!Object.getOwnPropertyNames(require.cache).includes("bad"));
+
+// hard to simplify this test case, but importing this would cause require.cache.extract to be set
+require("msgpackr-extract");
+
+strictEqual(require.cache["extract"], undefined);
+ok(!Object.hasOwnProperty.call(require.cache, "extract"));
+ok(!Object.getOwnPropertyNames(require.cache).includes("extract"));
+
+for (const key of Object.keys(require.cache)) {
+  if (!require.cache[key]) {
+    throw new Error("require.cache has an undefined value that was in it's keys");
+  }
+}
+
+console.log("--pass--");

test/bun.lockb

@@ -13,3 +13,15 @@ test("require.cache", () => {
   expect(stdout.toString().trim().endsWith("--pass--")).toBe(true);
   expect(exitCode).toBe(0);
 });
+
+// https://github.com/oven-sh/bun/issues/5188
+test("require.cache does not include unevaluated modules", () => {
+  const { stdout, exitCode } = Bun.spawnSync({
+    cmd: [bunExe(), "run", join(import.meta.dir, "require-cache-bug-5188.js")],
+    env: bunEnv,
+    stderr: "inherit",
+  });
+
+  expect(stdout.toString().trim().endsWith("--pass--")).toBe(true);
+  expect(exitCode).toBe(0);
+});

test/cli/run/require-cache-bug-5188.js

@@ -9,6 +9,7 @@
   },
   "dependencies": {
     "@prisma/client": "5.1.1",
+    "@resvg/resvg-js": "2.4.1",
     "@swc/core": "1.3.38",
     "body-parser": "1.20.2",
     "comlink": "4.4.1",
@@ -20,12 +21,12 @@
     "iconv-lite": "0.6.3",
     "jest-extended": "4.0.0",
     "lodash": "4.17.21",
+    "msgpackr-extract": "3.0.2",
     "nodemailer": "6.9.3",
     "pg": "8.11.1",
     "pg-connection-string": "2.6.1",
     "postgres": "3.3.5",
     "prisma": "5.1.1",
-    "@resvg/resvg-js": "2.4.1",
     "socket.io": "4.7.1",
     "socket.io-client": "4.7.1",
     "supertest": "6.3.3",