fix: Handle the scenario where a package.json#browser field could be …

…set to {'./some-path': false}
vercel · Jun 21, 2024 · b8174ce · b8174ce
1 parent bd68351
commit b8174ce
Show file tree

Hide file tree

Showing 15 changed files with 62 additions and 1 deletion.
diff --git a/src/resolve-dependency.ts b/src/resolve-dependency.ts
@@ -128,7 +128,7 @@ interface PkgCfg {
   main: string | undefined;
   exports: PackageTarget;
   imports: { [key: string]: PackageTarget };
-  browser?: string | { [key: string]: string };
+  browser?: unknown;
 }
 
 async function getPkgCfg(
@@ -259,8 +259,21 @@ async function resolveRemappings(
 ): Promise<void> {
   if (job.conditions?.includes('browser')) {
     const { browser: pkgBrowser } = pkgCfg;
+    if (!pkgBrowser) {
+      return;
+    }
+    if (typeof pkgBrowser === 'string') {
+      return;
+    }
     if (typeof pkgBrowser === 'object') {
       for (const [key, value] of Object.entries(pkgBrowser)) {
+        if (typeof value !== 'string') {
+          /**
+           * `false` can be used to specify that a file is not meant to be included.
+           * Downstream processing is expected to handle this case, and it should remain in the mapping result
+           */
+          continue;
+        }
         if (!key.startsWith('./') || !value.startsWith('./')) {
           continue;
         }

diff --git a/test/unit/browser-remappings-false copy/.gitignore b/test/unit/browser-remappings-false copy/.gitignore
@@ -0,0 +1,2 @@
+# include node_modules for testing
+!node_modules 
diff --git a/test/unit/browser-remappings-false copy/input.js b/test/unit/browser-remappings-false copy/input.js
@@ -0,0 +1,2 @@
+require('pkg');
+
diff --git a/test/unit/browser-remappings-false copy/node_modules/pkg/browser.js b/test/unit/browser-remappings-false copy/node_modules/pkg/browser.js
diff --git a/test/unit/browser-remappings-false copy/node_modules/pkg/index.js b/test/unit/browser-remappings-false copy/node_modules/pkg/index.js
diff --git a/test/unit/browser-remappings-false copy/node_modules/pkg/package.json b/test/unit/browser-remappings-false copy/node_modules/pkg/package.json
diff --git a/test/unit/browser-remappings-false copy/output.js b/test/unit/browser-remappings-false copy/output.js
@@ -0,0 +1,7 @@
+[
+  "package.json",
+  "test/unit/browser-remappings-false/input.js",
+  "test/unit/browser-remappings-false/node_modules/pkg/browser.js",
+  "test/unit/browser-remappings-false/node_modules/pkg/index.js",
+  "test/unit/browser-remappings-false/node_modules/pkg/package.json"
+]
diff --git a/test/unit/browser-remappings-false copy/test-opts.json b/test/unit/browser-remappings-false copy/test-opts.json
@@ -0,0 +1,3 @@
+{
+  "conditions": ["browser"]
+}
diff --git a/test/unit/browser-remappings-false/.gitignore b/test/unit/browser-remappings-false/.gitignore
@@ -0,0 +1,2 @@
+# include node_modules for testing
+!node_modules 
diff --git a/test/unit/browser-remappings-false/input.js b/test/unit/browser-remappings-false/input.js
@@ -0,0 +1,2 @@
+require('pkg');
+
diff --git a/test/unit/browser-remappings-false/node_modules/pkg/browser.js b/test/unit/browser-remappings-false/node_modules/pkg/browser.js
diff --git a/test/unit/browser-remappings-false/node_modules/pkg/index.js b/test/unit/browser-remappings-false/node_modules/pkg/index.js
diff --git a/test/unit/browser-remappings-false/node_modules/pkg/package.json b/test/unit/browser-remappings-false/node_modules/pkg/package.json
diff --git a/test/unit/browser-remappings-false/output.js b/test/unit/browser-remappings-false/output.js
@@ -0,0 +1,7 @@
+[
+  "package.json",
+  "test/unit/browser-remappings-false/input.js",
+  "test/unit/browser-remappings-false/node_modules/pkg/browser.js",
+  "test/unit/browser-remappings-false/node_modules/pkg/index.js",
+  "test/unit/browser-remappings-false/node_modules/pkg/package.json"
+]
diff --git a/test/unit/browser-remappings-false/test-opts.json b/test/unit/browser-remappings-false/test-opts.json
@@ -0,0 +1,3 @@
+{
+  "conditions": ["browser"]
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# include node_modules for testing
		!node_modules