fix(vitest): always inline setup files (#6689)

Author: sheremet-va

packages/vite-node/src/cli.ts

@@ -182,6 +182,7 @@ function parseServerOptions(
     ...serverOptions,
     deps: {
       ...serverOptions.deps,
+      inlineFiles: toArray(serverOptions.deps?.inlineFiles),
       inline:
         inlineOptions !== true
           ? inlineOptions.map((dep) => {

packages/vite-node/src/externalize.ts

@@ -119,6 +119,9 @@ async function _shouldExternalize(
   if (matchExternalizePattern(id, moduleDirectories, options?.inline)) {
     return false
   }
+  if (options?.inlineFiles && options?.inlineFiles.includes(id)) {
+    return false
+  }
   if (matchExternalizePattern(id, moduleDirectories, options?.external)) {
     return id
   }

packages/vite-node/src/server.ts

@@ -1,6 +1,7 @@
 import { performance } from 'node:perf_hooks'
 import { existsSync } from 'node:fs'
 import assert from 'node:assert'
+import { pathToFileURL } from 'node:url'
 import { join, normalize, relative, resolve } from 'pathe'
 import type { TransformResult, ViteDevServer } from 'vite'
 import createDebug from 'debug'
@@ -105,6 +106,16 @@ export class ViteNodeServer {
       this.debugger = new Debugger(server.config.root, options.debug!)
     }
 
+    if (options.deps.inlineFiles) {
+      options.deps.inlineFiles = options.deps.inlineFiles.flatMap((file) => {
+        if (file.startsWith('file://')) {
+          return file
+        }
+        const resolvedId = resolve(file)
+        return [resolvedId, pathToFileURL(resolvedId).href]
+      })
+    }
+
     options.deps.moduleDirectories ??= []
 
     const envValue

packages/vite-node/src/types.ts

@@ -9,6 +9,7 @@ export type Awaitable<T> = T | PromiseLike<T>
 export interface DepsHandlingOptions {
   external?: (string | RegExp)[]
   inline?: (string | RegExp)[] | true
+  inlineFiles?: string[]
   /**
    * A list of directories that are considered to hold Node.js modules
    * Have to include "/" at the start and end of the path

packages/vitest/src/node/config/resolveConfig.ts

@@ -307,6 +307,27 @@ export function resolveConfig(
   resolved.deps.web.transformCss ??= true
   resolved.deps.web.transformGlobPattern ??= []
 
+  resolved.setupFiles = toArray(resolved.setupFiles || []).map(file =>
+    resolvePath(file, resolved.root),
+  )
+  resolved.globalSetup = toArray(resolved.globalSetup || []).map(file =>
+    resolvePath(file, resolved.root),
+  )
+  resolved.coverage.exclude.push(
+    ...resolved.setupFiles.map(
+      file =>
+        `${resolved.coverage.allowExternal ? '**/' : ''}${relative(
+          resolved.root,
+          file,
+        )}`,
+    ),
+  )
+
+  resolved.forceRerunTriggers = [
+    ...resolved.forceRerunTriggers,
+    ...resolved.setupFiles,
+  ]
+
   resolved.server ??= {}
   resolved.server.deps ??= {}
 
@@ -366,6 +387,8 @@ export function resolveConfig(
     }
   }
 
+  resolved.server.deps.inlineFiles ??= []
+  resolved.server.deps.inlineFiles.push(...resolved.setupFiles)
   resolved.server.deps.moduleDirectories ??= []
   resolved.server.deps.moduleDirectories.push(
     ...resolved.deps.moduleDirectories,
@@ -554,27 +577,6 @@ export function resolveConfig(
     }
   }
 
-  resolved.setupFiles = toArray(resolved.setupFiles || []).map(file =>
-    resolvePath(file, resolved.root),
-  )
-  resolved.globalSetup = toArray(resolved.globalSetup || []).map(file =>
-    resolvePath(file, resolved.root),
-  )
-  resolved.coverage.exclude.push(
-    ...resolved.setupFiles.map(
-      file =>
-        `${resolved.coverage.allowExternal ? '**/' : ''}${relative(
-          resolved.root,
-          file,
-        )}`,
-    ),
-  )
-
-  resolved.forceRerunTriggers = [
-    ...resolved.forceRerunTriggers,
-    ...resolved.setupFiles,
-  ]
-
   if (resolved.diff) {
     resolved.diff = resolvePath(resolved.diff, resolved.root)
     resolved.forceRerunTriggers.push(resolved.diff)

test/config/fixtures/inline-setup-file/file-setup.js

@@ -0,0 +1,3 @@
+if (typeof __vite_ssr_import__ === 'undefined') {
+  throw new Error('Setup file was externalized')
+}

test/config/fixtures/inline-setup-file/test.test.js

@@ -0,0 +1,3 @@
+import { test } from 'vitest'
+
+test('test', () => {})

test/config/fixtures/inline-setup-file/vitest.config.js

@@ -0,0 +1,13 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    setupFiles: ['./file-setup'],
+    server: {
+      deps: {
+        // try to force setup file to be external
+        external: [/file-setup/]
+      }
+    }
+  }
+})

test/config/test/inline-setup-file.test.ts

@@ -0,0 +1,11 @@
+import path from 'node:path'
+import { expect, test } from 'vitest'
+import { runVitest } from '../../test-utils'
+
+test('import a generated file', async () => {
+  const root = path.resolve(import.meta.dirname, '../fixtures/inline-setup-file')
+
+  const { stderr, exitCode } = await runVitest({ root })
+  expect(stderr).toBe('')
+  expect(exitCode).toBe(0)
+})

vitest.workspace.vscode.ts

@@ -3,4 +3,5 @@ import { defineWorkspace } from 'vitest/config'
 export default defineWorkspace([
   './test/core',
   './test/cli',
+  './test/config',
 ])