perf(module-runner): add client-side builtin module check (#20924)

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Author: jiji-hoon96

packages/vite/src/module-runner/runner.ts

@@ -6,6 +6,7 @@ import {
   type NormalizedModuleRunnerTransport,
   normalizeModuleRunnerTransport,
 } from '../shared/moduleRunnerTransport'
+import { createIsBuiltin } from '../shared/builtin'
 import type { EvaluatedModuleNode } from './evaluatedModules'
 import { EvaluatedModules } from './evaluatedModules'
 import type {
@@ -44,6 +45,8 @@ export class ModuleRunner {
     string,
     Promise<EvaluatedModuleNode>
   >()
+  private isBuiltin?: (id: string) => boolean
+  private builtinsPromise?: Promise<void>
 
   private closed = false
 
@@ -238,6 +241,23 @@ export class ModuleRunner {
     return cached
   }
 
+  private ensureBuiltins(): Promise<void> | undefined {
+    if (this.isBuiltin) return
+
+    this.builtinsPromise ??= (async () => {
+      try {
+        this.debug?.('[module runner] fetching builtins from server')
+        const builtins = await this.transport.invoke('getBuiltins', [])
+        this.isBuiltin = createIsBuiltin(builtins)
+        this.debug?.('[module runner] builtins loaded:', builtins)
+      } finally {
+        this.builtinsPromise = undefined
+      }
+    })()
+
+    return this.builtinsPromise
+  }
+
   private async getModuleInformation(
     url: string,
     importer: string | undefined,
@@ -247,13 +267,15 @@ export class ModuleRunner {
       throw new Error(`Vite module runner has been closed.`)
     }
 
+    await this.ensureBuiltins()
+
     this.debug?.('[module runner] fetching', url)
 
     const isCached = !!(typeof cachedModule === 'object' && cachedModule.meta)
 
     const fetchedModule = // fast return for established externalized pattern
       (
-        url.startsWith('data:')
+        url.startsWith('data:') || this.isBuiltin?.(url)
           ? { externalize: url, type: 'builtin' }
           : await this.transport.invoke('fetchModule', [
               url,

packages/vite/src/node/server/environment.ts

@@ -133,6 +133,9 @@ export class DevEnvironment extends BaseEnvironment {
       fetchModule: (id, importer, options) => {
         return this.fetchModule(id, importer, options)
       },
+      getBuiltins: async () => {
+        return this.config.resolve.builtins
+      },
     })
 
     this.hot.on(

packages/vite/src/node/ssr/runtime/__tests__/fixtures/builtin-import.ts

@@ -0,0 +1,3 @@
+import { basename } from 'node:path'
+
+export default basename('/foo/bar/baz.txt')

packages/vite/src/node/ssr/runtime/__tests__/server-worker-runner.invoke.spec.ts

@@ -98,4 +98,13 @@ describe('running module runner inside a worker and using the ModuleRunnerTransp
     expect(output).not.toHaveProperty('result')
     expect(output.error).toContain('Error: Unknown invoke error')
   })
+
+  it('resolves builtin module without server round-trip', async () => {
+    handleInvoke = (data: any) => server.environments.ssr.hot.handleInvoke(data)
+
+    const output = await run('./fixtures/builtin-import.ts')
+    expect(output).toHaveProperty('result')
+    expect(output.result).toBe('baz.txt')
+    expect(output.error).toBeUndefined()
+  })
 })

packages/vite/src/node/utils.ts

@@ -30,6 +30,7 @@ import {
   withTrailingSlash,
 } from '../shared/utils'
 import { VALID_ID_PREFIX } from '../shared/constants'
+import { createIsBuiltin } from '../shared/builtin'
 import {
   CLIENT_ENTRY,
   CLIENT_PUBLIC_PATH,
@@ -117,20 +118,6 @@ export function isBuiltin(builtins: (string | RegExp)[], id: string): boolean {
   return isBuiltin(id)
 }
 
-export function createIsBuiltin(
-  builtins: (string | RegExp)[],
-): (id: string) => boolean {
-  const plainBuiltinsSet = new Set(
-    builtins.filter((builtin) => typeof builtin === 'string'),
-  )
-  const regexBuiltins = builtins.filter(
-    (builtin) => typeof builtin !== 'string',
-  )
-
-  return (id) =>
-    plainBuiltinsSet.has(id) || regexBuiltins.some((regexp) => regexp.test(id))
-}
-
 export const nodeLikeBuiltins: (string | RegExp)[] = [
   ...nodeBuiltins,
   new RegExp(`^${NODE_BUILTIN_NAMESPACE}`),

packages/vite/src/shared/builtin.ts

@@ -0,0 +1,13 @@
+export function createIsBuiltin(
+  builtins: (string | RegExp)[],
+): (id: string) => boolean {
+  const plainBuiltinsSet = new Set(
+    builtins.filter((builtin) => typeof builtin === 'string'),
+  )
+  const regexBuiltins = builtins.filter(
+    (builtin) => typeof builtin !== 'string',
+  )
+
+  return (id: string) =>
+    plainBuiltinsSet.has(id) || regexBuiltins.some((regexp) => regexp.test(id))
+}

packages/vite/src/shared/invokeMethods.ts

@@ -82,4 +82,6 @@ export type InvokeMethods = {
     importer?: string,
     options?: FetchFunctionOptions,
   ) => Promise<FetchResult>
+
+  getBuiltins: () => Promise<(string | RegExp)[]>
 }