fix: optimize deps on dev SSR, builtin imports in node

[patak-dev]

Description

Follow up to:

• feat: support cjs noExternal in SSR dev, fix #2579 #8430

These changes were triggered by a report from @DylanPiercey while testing Vite v3 with Marko.

Refactor

Even if the PR looks big, the main change is a straight forward refactoring from:

getDepsOptimizer(config)?.metadata({ ssr })

to

getDepsOptimizer(config, { ssr }).metadata

We need this because we have now added more responsibilities to the optimizer, like tracking of the iddle state before optimizing. Having separate optimizers allows us to cleanly make the calls from the ssr pipeline noop. See later in the code:

    // noop, there is no scanning during dev SSR
    // the optimizer blocks the server start
    run: () => {},
    registerWorkersSource: (id: string) => {},
    delayDepsOptimizerUntil: (id: string, done: () => Promise<any>) => {},
    resetRegisteredIds: () => {},
    ensureFirstRun: () => {},

Before this PR, there could be race conditions between the SSR requests and regular requests when registering ids in delayDepsOptimizerUntil.

New experimental optimizeDeps.devSsr option

Edit: This is no longer needed, the optimizer is started on the first ssrLoadModule call

Before this PR, there was a simple condition to check if we should optimize deps for dev SSR:

if (!isBuild && config.ssr) {
  ssrServerDepsMetadata = await optimizeServerSsrDeps(config)
}

This was generating runs of the dev SSR optimizer when using the Vue plugin, since it auto injects vue as ssr.noExternal.

The PR right now adds an option to opt-in.

Note: I think we could change this to init the optimizer automatically on the first call to ssrLoadModule.

Passing SSR state to esbuildDepPlugin

In SSR, before this PR we ended up with browserExternalId for node modules in CJS. Forwarding the ssr flag fixed this issue.

Patching Esbuild dynamic require error

The last issue with the added test case seems to be an unresolved esbuild bug:

• should use esm/cjs's native way to import externals (no wrappers needed) evanw/esbuild#1927

This PR implements the banner workaround mentioned here evanw/esbuild#1921 (comment). Interested in your feedback @benmccann since I saw you participating in that thread

---

What is the purpose of this pull request?

• Bug fix
• New Feature
• Documentation update
• Other

[netlify]

✅ Deploy Preview for vite-docs-main ready!

Name	Link
🔨 Latest commit	c043ebe
🔍 Latest deploy log	https://app.netlify.com/sites/vite-docs-main/deploys/62bcc5fa8e1a19000936258e
😎 Deploy Preview	https://deploy-preview-8854--vite-docs-main.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[patak-dev]

Remove the new optimizeDeps.devSsr option in:

• refactor: avoid the need for a new option

[patak-dev]

vite-ecosystem-ci run against this PR https://github.com/vitejs/vite-ecosystem-ci/actions/runs/2583218491

[bluwy]

Thanks for the PR explanations. It made reviewing easier!

[bluwy]

I think we can put a comment above about why this is needed.

[bluwy]

Perhaps we can explain why we use non-ssr optimized deps here. I'm actually not sure too 🤔

[patak-dev]

We use them because in v2, we only had these deps. Actually we only need the list of deps for known imports. During ssr true we don't have that list, we only optimize the explicitly defined deps right now. And I don't think we should touch how legacy cjs externalization heuristics work