ssr: Nested built-in dependencies of ESM dependencies can't be resolved

[jplhomer]

Describe the bug

When I attempt to load an entrypoint with ssrLoadModule which references an ESM dependency e.g. https://github.com/jplhomer/repro-ssr-pkg, there is an esbuild error indicating the built-in dependency cannot be loaded.

This only happens during the optimize missing deps phase of the dev server.

Potential similar issues, but slightly different:

• ssrLoadModule does not load nested dependency #3609
• feat(optimizer): nested optimization #4634

Reproduction

https://github.com/jplhomer/repro-ssr-modules

System Info

System:
    OS: macOS 11.5.2
    CPU: (12) x64 Intel(R) Core(TM) i7-9750H CPU @ 2.60GHz
    Memory: 254.77 MB / 32.00 GB
    Shell: 5.8 - /bin/zsh
  Binaries:
    Node: 15.9.0 - ~/.nvm/versions/node/v15.9.0/bin/node
    Yarn: 1.22.11 - ~/.nvm/versions/node/v15.9.0/bin/yarn
    npm: 7.5.3 - ~/.nvm/versions/node/v15.9.0/bin/npm
    Watchman: 4.9.0 - /usr/local/bin/watchman
  Browsers:
    Chrome: 92.0.4515.159
    Firefox: 86.0
    Safari: 14.1.2
  npmPackages:
    vite: ^2.5.0 => 2.5.0

Used Package Manager

yarn

Logs

2:26:32 PM [vite] new dependencies found: repro-ssr-pkg, updating...
 > node_modules/react-dom/cjs/react-dom-server.node.development.js:18:21: error: Could not read from file: /Users/joshlarson/src/github.com/jplhomer/repro-ssr-modules/stream
    18 │ var stream = require('stream');
       ╵                      ~~~~~~~~

2:26:32 PM [vite] error while updating dependencies:
Error: Build failed with 1 error:
node_modules/react-dom/cjs/react-dom-server.node.development.js:18:21: error: Could not read from file: /Users/joshlarson/src/github.com/jplhomer/repro-ssr-modules/stream
    at failureErrorWithLog (/Users/joshlarson/src/github.com/jplhomer/repro-ssr-modules/node_modules/esbuild/lib/main.js:1449:15)
    at /Users/joshlarson/src/github.com/jplhomer/repro-ssr-modules/node_modules/esbuild/lib/main.js:1131:28
    at runOnEndCallbacks (/Users/joshlarson/src/github.com/jplhomer/repro-ssr-modules/node_modules/esbuild/lib/main.js:921:63)
    at buildResponseToResult (/Users/joshlarson/src/github.com/jplhomer/repro-ssr-modules/node_modules/esbuild/lib/main.js:1129:7)
    at /Users/joshlarson/src/github.com/jplhomer/repro-ssr-modules/node_modules/esbuild/lib/main.js:1236:14
    at /Users/joshlarson/src/github.com/jplhomer/repro-ssr-modules/node_modules/esbuild/lib/main.js:609:9
    at handleIncomingPacket (/Users/joshlarson/src/github.com/jplhomer/repro-ssr-modules/node_modules/esbuild/lib/main.js:706:9)
    at Socket.readFromStdout (/Users/joshlarson/src/github.com/jplhomer/repro-ssr-modules/node_modules/esbuild/lib/main.js:576:7)
    at Socket.emit (node:events:378:20)
    at Socket.EventEmitter.emit (node:domain:470:12)

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• Make sure this is a Vite issue and not a framework-specific issue. For example, if it's a Vue SFC related bug, it should likely be reported to https://github.com/vuejs/vue-next instead.
• Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
• The provided reproduction is a minimal reproducible example of the bug.

[ygj6]

This error occurs because esbuildDepPlugin incorrectly resolve the built-in module:

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

Lines 113 to 131 in e623b4a

	// use vite's own resolver
	const resolved = await resolve(id, importer, kind)
	if (resolved) {
	if (resolved.startsWith(browserExternalId)) {
	return {
	path: id,
	namespace: 'browser-external'
	}
	}
	if (isExternalUrl(resolved)) {
	return {
	path: resolved,
	external: true
	}
	}
	return {
	path: path.resolve(resolved)
	}
	}

Vite's own resolver will return the built-in module id, the id will be resolved by path.resolve(resolve), and the result is:
/project/path/built-in-module-id

The resolved content is wrong, we need to externalize the built-in module during SSR, modify the source code:

  if (isExternalUrl(resolved) || (ssr && isBuiltin(id))) {
    return {
      path: resolved,
      external: true
    }
  }

So the esbuild will resolve the correct content. I will submit a pull request later.

[jplhomer]

Thanks, @ygj6. You're a hero!