fix: move Vitest.setServer to post configureServer hook to enable import analysis for workspace config loading (#6584)

hi-ogawa · web-flow · commit e7f35214c8fd · 2024-10-01T13:25:51.000+02:00
diff --git a/packages/ui/node/index.ts b/packages/ui/node/index.ts
@@ -22,41 +22,44 @@ export default (ctx: Vitest): Plugin => {
   return <Plugin>{
     name: 'vitest:ui',
     apply: 'serve',
-    configureServer(server) {
-      const uiOptions = ctx.config
-      const base = uiOptions.uiBase
-      const coverageFolder = resolveCoverageFolder(ctx)
-      const coveragePath = coverageFolder ? coverageFolder[1] : undefined
-      if (coveragePath && base === coveragePath) {
-        throw new Error(
-          `The ui base path and the coverage path cannot be the same: ${base}, change coverage.reportsDirectory`,
-        )
-      }
+    configureServer: {
+      order: 'post',
+      handler(server) {
+        const uiOptions = ctx.config
+        const base = uiOptions.uiBase
+        const coverageFolder = resolveCoverageFolder(ctx)
+        const coveragePath = coverageFolder ? coverageFolder[1] : undefined
+        if (coveragePath && base === coveragePath) {
+          throw new Error(
+            `The ui base path and the coverage path cannot be the same: ${base}, change coverage.reportsDirectory`,
+          )
+        }
 
-      if (coverageFolder) {
+        if (coverageFolder) {
+          server.middlewares.use(
+            coveragePath!,
+            sirv(coverageFolder[0], {
+              single: true,
+              dev: true,
+              setHeaders: (res) => {
+                res.setHeader(
+                  'Cache-Control',
+                  'public,max-age=0,must-revalidate',
+                )
+              },
+            }),
+          )
+        }
+
+        const clientDist = resolve(fileURLToPath(import.meta.url), '../client')
         server.middlewares.use(
-          coveragePath!,
-          sirv(coverageFolder[0], {
+          base,
+          sirv(clientDist, {
             single: true,
             dev: true,
-            setHeaders: (res) => {
-              res.setHeader(
-                'Cache-Control',
-                'public,max-age=0,must-revalidate',
-              )
-            },
           }),
         )
-      }
-
-      const clientDist = resolve(fileURLToPath(import.meta.url), '../client')
-      server.middlewares.use(
-        base,
-        sirv(clientDist, {
-          single: true,
-          dev: true,
-        }),
-      )
+      },
     },
   }
 }
diff --git a/packages/vitest/src/node/plugins/index.ts b/packages/vitest/src/node/plugins/index.ts
@@ -233,22 +233,26 @@ export async function VitestPlugin(
 
         hijackVitePluginInject(viteConfig)
       },
-      async configureServer(server) {
-        if (options.watch && process.env.VITE_TEST_WATCHER_DEBUG) {
-          server.watcher.on('ready', () => {
-            // eslint-disable-next-line no-console
-            console.log('[debug] watcher is ready')
-          })
-        }
-        await ctx.setServer(options, server, userConfig)
-        if (options.api && options.watch) {
-          (await import('../../api/setup')).setup(ctx)
-        }
+      configureServer: {
+        // runs after vite:import-analysis as it relies on `server` instance on Vite 5
+        order: 'post',
+        async handler(server) {
+          if (options.watch && process.env.VITE_TEST_WATCHER_DEBUG) {
+            server.watcher.on('ready', () => {
+              // eslint-disable-next-line no-console
+              console.log('[debug] watcher is ready')
+            })
+          }
+          await ctx.setServer(options, server, userConfig)
+          if (options.api && options.watch) {
+            (await import('../../api/setup')).setup(ctx)
+          }
 
-        // #415, in run mode we don't need the watcher, close it would improve the performance
-        if (!options.watch) {
-          await server.watcher.close()
-        }
+          // #415, in run mode we don't need the watcher, close it would improve the performance
+          if (!options.watch) {
+            await server.watcher.close()
+          }
+        },
       },
     },
     SsrReplacerPlugin(),
diff --git a/test/config/fixtures/workspace/config-import-analysis/dep.ts b/test/config/fixtures/workspace/config-import-analysis/dep.ts
@@ -0,0 +1 @@
+export default [] satisfies string[];
diff --git a/test/config/fixtures/workspace/config-import-analysis/packages/a/package.json b/test/config/fixtures/workspace/config-import-analysis/packages/a/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "a"
+}
diff --git a/test/config/fixtures/workspace/config-import-analysis/packages/a/test.test.ts b/test/config/fixtures/workspace/config-import-analysis/packages/a/test.test.ts
@@ -0,0 +1,3 @@
+import { test } from 'vitest';
+
+test('test - a')
diff --git a/test/config/fixtures/workspace/config-import-analysis/vitest.workspace.ts b/test/config/fixtures/workspace/config-import-analysis/vitest.workspace.ts
@@ -0,0 +1,6 @@
+import depAsJs from "./dep.js"
+
+export default [
+  "./packages/*",
+  ...depAsJs,
+]
diff --git a/test/config/test/workspace.test.ts b/test/config/test/workspace.test.ts
@@ -81,3 +81,12 @@ it('fails if referenced file doesnt exist', async () => {
     `Workspace config file "vitest.workspace.ts" references a non-existing file or a directory: ${resolve('fixtures/workspace/invalid-non-existing-config/vitest.config.js')}`,
   )
 })
+
+it('vite import analysis is applied when loading workspace config', async () => {
+  const { stderr, stdout } = await runVitest({
+    root: 'fixtures/workspace/config-import-analysis',
+    workspace: './fixtures/workspace/config-import-analysis/vitest.workspace.ts',
+  })
+  expect(stderr).toBe('')
+  expect(stdout).toContain('test - a')
+})

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { test } from 'vitest';`
	`2`	`+`
	`3`	`+test('test - a')`