fix: exclude dependency of optimized dependency (fix: 5410) (#5411)

Co-authored-by: Artem Khodyush <pakafpub@gmail.com>
Co-authored-by: Shinigami <chrissi92@hotmail.de>

packages/playground/nested-deps/__tests__/nested-deps.spec.ts

@@ -7,4 +7,5 @@ test('handle nested package', async () => {
   expect(await page.textContent('.side-c')).toBe(c)
   expect(await page.textContent('.d')).toBe('D@1.0.0')
   expect(await page.textContent('.nested-d')).toBe('D-nested@1.0.0')
+  expect(await page.textContent('.nested-e')).toBe('1')
 })

packages/playground/nested-deps/index.html

@@ -19,12 +19,16 @@ <h2>direct dependency D</h2>
 <h2>nested dependency nested-D (dep of D)</h2>
 <pre class="nested-d"></pre>
 
+<h2>exclude dependency of pre-bundled dependency</h2>
+<div>nested module instance count: <span class="nested-e"></span></div>
+
 <script type="module">
   import A from 'test-package-a'
   import B, { A as nestedA } from 'test-package-b'
   import C from 'test-package-c'
   import { C as sideC } from 'test-package-c/side'
   import D, { nestedD } from 'test-package-d'
+  import { testExcluded } from 'test-package-e'
 
   text('.a', A)
   text('.b', B)
@@ -36,6 +40,8 @@ <h2>nested dependency nested-D (dep of D)</h2>
   text('.d', D)
   text('.nested-d', nestedD)
 
+  text('.nested-e', testExcluded())
+
   function text(sel, text) {
     document.querySelector(sel).textContent = text
   }

packages/playground/nested-deps/package.json

@@ -12,6 +12,7 @@
     "test-package-a": "link:./test-package-a",
     "test-package-b": "link:./test-package-b",
     "test-package-c": "link:./test-package-c",
-    "test-package-d": "link:./test-package-d"
+    "test-package-d": "link:./test-package-d",
+    "test-package-e": "link:./test-package-e"
   }
 }

packages/playground/nested-deps/test-package-e/index.js

@@ -0,0 +1,2 @@
+export { testIncluded } from 'test-package-e-included'
+export { testExcluded } from 'test-package-e-excluded'

packages/playground/nested-deps/test-package-e/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "test-package-e",
+  "version": "0.1.0",
+  "main": "index.js",
+  "dependencies": {
+    "test-package-e-excluded": "link:./test-package-e-excluded",
+    "test-package-e-included": "link:./test-package-e-included"
+  }
+}

packages/playground/nested-deps/test-package-e/test-package-e-excluded/index.js

@@ -0,0 +1,11 @@
+const key = '$$excludedDependencyInstanceCount'
+
+if (!(key in window)) {
+  window[key] = 0
+}
+
+++window[key]
+
+export function testExcluded() {
+  return window[key]
+}

packages/playground/nested-deps/test-package-e/test-package-e-excluded/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "test-package-e-excluded",
+  "version": "0.1.0",
+  "main": "index.js"
+}

packages/playground/nested-deps/test-package-e/test-package-e-included/index.js

@@ -0,0 +1,5 @@
+import { testExcluded } from 'test-package-e-excluded'
+
+export function testIncluded() {
+  return testExcluded()
+}

packages/playground/nested-deps/test-package-e/test-package-e-included/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "test-package-e-included",
+  "version": "0.1.0",
+  "main": "index.js",
+  "dependencies": {
+    "test-package-e-excluded": "link:../test-package-e-excluded"
+  }
+}

packages/playground/nested-deps/vite.config.js

@@ -8,8 +8,9 @@ module.exports = {
       'test-package-b',
       'test-package-c',
       'test-package-c/side',
-      'test-package-d    > test-package-d-nested'
+      'test-package-d    > test-package-d-nested',
+      'test-package-e-included'
     ],
-    exclude: ['test-package-d']
+    exclude: ['test-package-d', 'test-package-e-excluded']
   }
 }

packages/vite/src/node/optimizer/esbuildDepPlugin.ts

@@ -6,7 +6,8 @@ import {
   isRunningWithYarnPnp,
   flattenId,
   normalizePath,
-  isExternalUrl
+  isExternalUrl,
+  moduleListContains
 } from '../utils'
 import { browserExternalId } from '../plugins/resolve'
 import { ExportsData } from '.'
@@ -99,6 +100,13 @@ export function esbuildDepPlugin(
       build.onResolve(
         { filter: /^[\w@][^:]/ },
         async ({ path: id, importer, kind }) => {
+          if (moduleListContains(config.optimizeDeps?.exclude, id)) {
+            return {
+              path: id,
+              external: true
+            }
+          }
+
           // ensure esbuild uses our resolved entries
           let entry: { path: string; namespace: string } | undefined
           // if this is an entry, return entry namespace resolve result

packages/vite/src/node/optimizer/scan.ts

@@ -14,6 +14,7 @@ import {
   normalizePath,
   isObject,
   cleanUrl,
+  moduleListContains,
   externalRE,
   dataUrlRE,
   multilineCommentsRE,
@@ -302,7 +303,7 @@ function esbuildScanPlugin(
           filter: /^[\w@][^:]/
         },
         async ({ path: id, importer }) => {
-          if (exclude?.some((e) => e === id || id.startsWith(e + '/'))) {
+          if (moduleListContains(exclude, id)) {
             return externalUnlessEntry({ path: id })
           }
           if (depImports[id]) {

packages/vite/src/node/plugins/importAnalysis.ts

@@ -19,7 +19,8 @@ import {
   timeFrom,
   normalizePath,
   removeImportQuery,
-  unwrapId
+  unwrapId,
+  moduleListContains
 } from '../utils'
 import {
   debugHmr,
@@ -179,13 +180,31 @@ export function importAnalysisPlugin(config: ResolvedConfig): Plugin {
           url = url.replace(base, '/')
         }
 
-        const resolved = await this.resolve(url, importer)
+        let importerFile = importer
+        if (
+          moduleListContains(config.optimizeDeps?.exclude, url) &&
+          server._optimizeDepsMetadata
+        ) {
+          // if the dependency encountered in the optimized file was excluded from the optimization
+          // the dependency needs to be resolved starting from the original source location of the optimized file
+          // because starting from node_modules/.vite will not find the dependency if it was not hoisted
+          // (that is, if it is under node_modules directory in the package source of the optimized file)
+          for (const optimizedModule of Object.values(
+            server._optimizeDepsMetadata.optimized
+          )) {
+            if (optimizedModule.file === importerModule.file) {
+              importerFile = optimizedModule.src
+            }
+          }
+        }
+
+        const resolved = await this.resolve(url, importerFile)
 
         if (!resolved) {
           this.error(
             `Failed to resolve import "${url}" from "${path.relative(
               process.cwd(),
-              importer
+              importerFile
             )}". Does the file exist?`,
             pos
           )

packages/vite/src/node/utils.ts

@@ -43,6 +43,13 @@ export function isBuiltin(id: string): boolean {
   return builtins.includes(id)
 }
 
+export function moduleListContains(
+  moduleList: string[] | undefined,
+  id: string
+): boolean | undefined {
+  return moduleList?.some((m) => m === id || id.startsWith(m + '/'))
+}
+
 export const bareImportRE = /^[\w@](?!.*:\/\/)/
 export const deepImportRE = /^([^@][^/]*)\/|^(@[^/]+\/[^/]+)\//