pipework 0.288.0 → 0.290.0

package/src/test/shared-registry.ts

@@ -0,0 +1,71 @@
+import { readFileSync, globSync } from 'node:fs'
+import { matchesGlob, resolve, sep } from 'node:path'
+
+// A project with `isolate: false` (and a non-vm pool) keeps one module registry per
+// worker. A test file that resets or mocks modules changes that registry for itself
+// and for every file after it: `vi.resetModules()` re-evaluates the app's modules but
+// not pipework (Node's own cache), so each `pipe.define(...)` runs twice against the
+// one registry and the file after it fails at load (#1001). Such files are routed to an
+// isolated sibling project from their own text; the guard setup file refuses the same
+// calls in shared-registry projects for anything the text scan misses.
+
+/** The `vi` calls that change a worker's module registry or the next file's importers. */
+export const REGISTRY_CALLS = ['resetModules', 'mock', 'doMock', 'unmock', 'doUnmock'] as const
+
+// `vi.mock(`, `vi.mock<T>(`, `vitest.doMock (` and `vi?.resetModules(`. Decided from the
+// file's own text, comments and strings included: a miss is caught by the guard, a
+// false hit only costs one isolated worker.
+const REGISTRY_CALL_PATTERN = new RegExp(
+  `\\b(?:vi|vitest)\\s*\\??\\.\\s*(?:${REGISTRY_CALLS.join('|')})\\s*(?:<[^>]*>)?\\s*\\(`,
+)
+
+export function callsRegistryApi(text: string): boolean {
+  return REGISTRY_CALL_PATTERN.test(text)
+}
+
+/** Name of the isolated sibling that takes the registry-changing files of `project`. */
+export function isolatedSiblingName(project: string): string {
+  return `${project}:registry-isolated`
+}
+
+/** Glob-escape a literal path, so `[id].test.ts` matches only itself. */
+export function escapeGlob(path: string): string {
+  return path.replace(/[\\*?[\]{}()!|+@]/g, '\\$&')
+}
+
+/**
+ * The files `include` selects under `base`, minus `exclude`, as sorted `/`-separated
+ * paths relative to `base`. Vitest globs the same way, so this is the file set the
+ * project would run. A base that does not exist selects nothing.
+ */
+export function listProjectFiles(base: string, include: readonly string[], exclude: readonly string[]): string[] {
+  let found: string[]
+  try {
+    found = globSync([...include], {
+      cwd: base,
+      // Prune the two trees nothing is ever tested in, without walking them.
+      exclude: (path) => {
+        const name = path.split(/[\\/]/).pop()
+        return name === 'node_modules' || name === '.git'
+      },
+    })
+  } catch {
+    return []
+  }
+  const files = found
+    .map(file => file.split(sep).join('/'))
+    .filter(file => !exclude.some(pattern => matchesGlob(file, pattern)))
+  return [...new Set(files)].sort()
+}
+
+/** The files of the project whose own text calls a registry-changing `vi` API. */
+export function findRegistryFiles(base: string, include: readonly string[], exclude: readonly string[]): string[] {
+  return listProjectFiles(base, include, exclude).filter(file => {
+    try {
+      return callsRegistryApi(readFileSync(resolve(base, file), 'utf8'))
+    } catch {
+      return false
+    }
+  })
+}
+

package/src/test/vitest-workspace.ts

@@ -1,4 +1,4 @@
-import { resolve, dirname } from 'node:path'
+import { resolve, dirname, isAbsolute } from 'node:path'
 import { configDefaults } from 'vitest/config'
 import type { ViteUserConfig, UserWorkspaceConfig } from 'vitest/config'
 import type { VitestConfig, VitestModuleConfig, VitestProfileConfig, CoverageConfig } from '../core/config/schema.js'
@@ -10,6 +10,7 @@ import { loadEnvFiles } from '../core/config/env.js'
 import { resolveModules } from '../workspace/discover.js'
 import { workspaceSourcePaths } from '../workspace/source-paths.js'
 import { pipework as pipeworkPlugin } from './vitest-plugin.js'
+import { escapeGlob, findRegistryFiles, isolatedSiblingName } from './shared-registry.js'
 
 const DEFAULT_TEST_TIMEOUT = 30_000
 export const DEFAULT_HOOK_TIMEOUT = 60_000
@@ -22,6 +23,9 @@ export const DEFAULT_HOOK_TIMEOUT = 60_000
 const DEFAULT_POOL = 'forks'
 const DEFAULT_ISOLATE = false
 
+// Setup file that refuses registry-changing `vi` calls in a shared-registry project.
+const SHARED_REGISTRY_GUARD = 'pipework/test/shared-registry'
+
 type PoolName = NonNullable<VitestConfig['pool']>
 
 /**
@@ -199,14 +203,12 @@ export function resolveVitestModules(
 
   for (const [modulePath, moduleConfig] of [...included.entries()].sort(([a], [b]) => a.localeCompare(b))) {
     refuseProjectCoverage(`vitest.modules["${modulePath}"].coverage`, moduleConfig)
-    const project = buildProjectConfig(modulePath, moduleConfig, vitestConfig, configDir, workspacePackages)
-    projects.push(project)
+    pushRouted(projects, buildProjectConfig(modulePath, moduleConfig, vitestConfig, configDir, workspacePackages))
 
     if (moduleConfig.profiles !== undefined) {
       for (const [profileName, profileConfig] of Object.entries(moduleConfig.profiles).sort(([a], [b]) => a.localeCompare(b))) {
         refuseProjectCoverage(`vitest.modules["${modulePath}"].profiles["${profileName}"].coverage`, profileConfig)
-        const profileProject = buildProfileConfig(modulePath, profileName, moduleConfig, profileConfig, vitestConfig, configDir, workspacePackages)
-        projects.push(profileProject)
+        pushRouted(projects, buildProfileConfig(modulePath, profileName, moduleConfig, profileConfig, vitestConfig, configDir, workspacePackages))
       }
     }
   }
@@ -411,6 +413,7 @@ interface ProjectBuildInput {
 
 function buildProject(input: ProjectBuildInput): UserWorkspaceConfig {
   const inlineDeps = buildInlineDeps(input)
+  const shared = sharesRegistry(input)
   return {
     ...input.extra,
     plugins: [
@@ -434,7 +437,7 @@ function buildProject(input: ProjectBuildInput): UserWorkspaceConfig {
           inline: inlineDeps,
         },
       },
-      setupFiles: input.setupFiles,
+      setupFiles: shared ? [...input.setupFiles, SHARED_REGISTRY_GUARD] : input.setupFiles,
       // `vitest.pool` / `vitest.isolate` are dedicated fields, so an explicitly
       // configured one wins over `extra.test`; unset, the default above stands and
       // `extra.test` still overrides it as it always did.
@@ -458,19 +461,25 @@ function buildSetupFiles(database: boolean, userSetupFiles: string[] | undefined
   return files
 }
 
-// Pipework is inlined only where the effective isolate is true: a fresh module
-// registry per file needs it. A shared-registry fork already matches Node's single
-// module instance, so inlining buys nothing there. The vm pools isolate per file
-// whatever `isolate` says, so they always inline. Precedence mirrors buildProject's
-// emitted config: dedicated field, then `extra.test`, then the default.
-function buildInlineDeps(input: ProjectBuildInput): string[] {
+// Whether the project's workers share one module registry: the effective isolate is
+// false and the pool is not a vm pool (those isolate per file whatever `isolate` says).
+// Precedence mirrors buildProject's emitted config: dedicated field, then `extra.test`,
+// then the default.
+function sharesRegistry(input: ProjectBuildInput): boolean {
   const extraTest = 'test' in input.extra ? input.extra['test'] as Record<string, unknown> : {}
   const extraIsolate = typeof extraTest['isolate'] === 'boolean' ? extraTest['isolate'] : undefined
   const extraPool = extraTest['pool']
   const isolate = input.isolate ?? extraIsolate ?? DEFAULT_ISOLATE
   const pool = input.pool ?? extraPool ?? DEFAULT_POOL
+  return !isolate && pool !== 'vmThreads' && pool !== 'vmForks'
+}
+
+// Pipework is inlined only where the registry is not shared: a fresh module registry
+// per file needs it. A shared-registry fork already matches Node's single module
+// instance, so inlining buys nothing there.
+function buildInlineDeps(input: ProjectBuildInput): string[] {
   const deps = new Set<string>()
-  if (isolate || pool === 'vmThreads' || pool === 'vmForks') {
+  if (!sharesRegistry(input)) {
     deps.add('pipework')
   }
   for (const dep of input.inlineDeps) {
@@ -479,6 +488,50 @@ function buildInlineDeps(input: ProjectBuildInput): string[] {
   return [...deps]
 }
 
+// Routing for #1001. `isolate: false` projects keep one module registry per worker, and a
+// file that calls vi.resetModules / vi.mock / vi.doMock / vi.unmock / vi.doUnmock breaks
+// the files after it. Per project, the files its `include` selects (under `dir` or the
+// root, minus its merged `exclude`) are read; those whose own text calls one move to a
+// sibling project `<name>:registry-isolated` that is the same project with `isolate: true`
+// and an `include` of exactly those files, and the project itself excludes them. Each
+// project decides for itself from the file's text, so a file two projects select (a
+// module and its profile, or nested module roots) is routed in each, and still runs once
+// per project as before. Files are visited in sorted order, projects in config order.
+function pushRouted(projects: UserWorkspaceConfig[], project: UserWorkspaceConfig): void {
+  const test = project.test
+  const setup = test?.setupFiles
+  if (test === undefined || typeof test.root !== 'string' || !Array.isArray(setup) || !setup.includes(SHARED_REGISTRY_GUARD)) {
+    projects.push(project)
+    return
+  }
+  const root = test.root
+  const name = String(test.name)
+  const dir = typeof test.dir === 'string' ? (isAbsolute(test.dir) ? test.dir : resolve(root, test.dir)) : root
+  const include = test.include ?? [...configDefaults.include]
+  const exclude = test.exclude ?? [...configDefaults.exclude]
+  const routed = findRegistryFiles(dir, include, exclude)
+  if (routed.length === 0) {
+    projects.push(project)
+    return
+  }
+  const escaped = routed.map(escapeGlob)
+  projects.push({
+    ...project,
+    test: { ...test, exclude: [...exclude, ...escaped] },
+  })
+  projects.push({
+    ...project,
+    test: {
+      ...test,
+      name: isolatedSiblingName(name),
+      isolate: true,
+      include: escaped,
+      setupFiles: setup.filter(file => file !== SHARED_REGISTRY_GUARD),
+      server: { deps: { inline: [...new Set(['pipework', ...((test.server?.deps?.inline as string[] | undefined) ?? [])])] } },
+    },
+  })
+}
+
 function closestMatch(input: string, candidates: string[]): string | null {
   if (candidates.length === 0) return null