fix: don't crash when using --experimental-vm-threads, interop CJS default inside node_modules (#3876)

Author: sheremet-va

packages/vitest/src/runtime/execute.ts

@@ -146,7 +146,11 @@ export class VitestExecutor extends ViteNodeRunner {
   }
 
   constructor(public options: ExecuteOptions) {
-    super(options)
+    super({
+      ...options,
+      // interop is done inside the external executor instead
+      interopDefault: options.context ? false : options.interopDefault,
+    })
 
     this.mocker = new VitestMocker(this)
 
@@ -169,6 +173,7 @@ export class VitestExecutor extends ViteNodeRunner {
     }
     else {
       this.externalModules = new ExternalModulesExecutor({
+        ...options,
         context: options.context,
         packageCache: options.packageCache,
       })

packages/vitest/src/runtime/external-executor.ts

@@ -6,9 +6,10 @@ import { dirname } from 'node:path'
 import { Module as _Module, createRequire } from 'node:module'
 import { readFileSync, statSync } from 'node:fs'
 import { basename, extname, join, normalize } from 'pathe'
-import { getCachedData, isNodeBuiltin, setCacheData } from 'vite-node/utils'
+import { getCachedData, isNodeBuiltin, isPrimitive, setCacheData } from 'vite-node/utils'
 import { CSS_LANGS_RE, KNOWN_ASSET_RE } from 'vite-node/constants'
 import { getColors } from '@vitest/utils'
+import type { ExecuteOptions } from './execute'
 
 // need to copy paste types for vm
 // because they require latest @types/node which we don't bundle
@@ -95,7 +96,7 @@ const nativeResolve = import.meta.resolve!
 const dataURIRegex
   = /^data:(?<mime>text\/javascript|application\/json|application\/wasm)(?:;(?<encoding>charset=utf-8|base64))?,(?<code>.*)$/
 
-interface ExternalModulesExecutorOptions {
+export interface ExternalModulesExecutorOptions extends ExecuteOptions {
   context: vm.Context
   packageCache: Map<string, any>
 }
@@ -273,7 +274,7 @@ export class ExternalModulesExecutor {
     return buffer
   }
 
-  private findNearestPackageData(basedir: string) {
+  private findNearestPackageData(basedir: string): { type?: 'module' | 'commonjs' } {
     const originalBasedir = basedir
     const packageCache = this.options.packageCache
     while (basedir) {
@@ -300,12 +301,11 @@ export class ExternalModulesExecutor {
       basedir = nextBasedir
     }
 
-    return null
+    return {}
   }
 
-  private wrapSynteticModule(identifier: string, exports: Record<string, unknown>) {
-    // TODO: technically module should be parsed to find static exports, implement for strict mode in #2854
-    const moduleKeys = Object.keys(exports).filter(key => key !== 'default')
+  private wrapCoreSynteticModule(identifier: string, exports: Record<string, unknown>) {
+    const moduleKeys = Object.keys(exports)
     const m: any = new SyntheticModule(
       [...moduleKeys, 'default'],
       () => {
@@ -321,6 +321,52 @@ export class ExternalModulesExecutor {
     return m
   }
 
+  private interopCommonJsModule(mod: any) {
+    if (isPrimitive(mod) || Array.isArray(mod) || mod instanceof Promise) {
+      return {
+        keys: [],
+        moduleExports: {},
+        defaultExport: mod,
+      }
+    }
+
+    if (this.options.interopDefault !== false && '__esModule' in mod && !isPrimitive(mod.default)) {
+      return {
+        keys: Array.from(new Set(Object.keys(mod.default).concat(Object.keys(mod)).filter(key => key !== 'default'))),
+        moduleExports: new Proxy(mod, {
+          get(mod, prop) {
+            return mod[prop] ?? mod.default?.[prop]
+          },
+        }),
+        defaultExport: mod,
+      }
+    }
+
+    return {
+      keys: Object.keys(mod).filter(key => key !== 'default'),
+      moduleExports: mod,
+      defaultExport: mod,
+    }
+  }
+
+  private wrapCommonJsSynteticModule(identifier: string, exports: Record<string, unknown>) {
+    // TODO: technically module should be parsed to find static exports, implement for strict mode in #2854
+    const { keys, moduleExports, defaultExport } = this.interopCommonJsModule(exports)
+    const m: any = new SyntheticModule(
+      [...keys, 'default'],
+      () => {
+        for (const key of keys)
+          m.setExport(key, moduleExports[key])
+        m.setExport('default', defaultExport)
+      },
+      {
+        context: this.context,
+        identifier,
+      },
+    )
+    return m
+  }
+
   private async evaluateModule<T extends VMModule>(m: T): Promise<T> {
     if (m.status === 'unlinked') {
       this.esmLinkMap.set(
@@ -582,7 +628,7 @@ c.green(`export default {
 
     if (extension === '.node' || isNodeBuiltin(identifier)) {
       const exports = this.requireCoreModule(identifier)
-      return this.wrapSynteticModule(identifier, exports)
+      return this.wrapCoreSynteticModule(identifier, exports)
     }
 
     const isFileUrl = identifier.startsWith('file://')
@@ -600,7 +646,7 @@ c.green(`export default {
     if (extension === '.cjs') {
       const module = this.createCommonJSNodeModule(pathUrl)
       const exports = this.loadCommonJSModule(module, pathUrl)
-      return this.wrapSynteticModule(fileUrl, exports)
+      return this.wrapCommonJsSynteticModule(fileUrl, exports)
     }
 
     if (extension === '.mjs')
@@ -613,7 +659,7 @@ c.green(`export default {
 
     const module = this.createCommonJSNodeModule(pathUrl)
     const exports = this.loadCommonJSModule(module, pathUrl)
-    return this.wrapSynteticModule(fileUrl, exports)
+    return this.wrapCommonJsSynteticModule(fileUrl, exports)
   }
 
   async import(identifier: string) {

pnpm-lock.yaml

@@ -1,11 +1,13 @@
 import { Console } from 'node:console'
 import { Writable } from 'node:stream'
 import fs from 'node:fs'
+import { fileURLToPath } from 'node:url'
 import { type UserConfig, type VitestRunMode, afterEach } from 'vitest'
 import type { Vitest } from 'vitest/node'
 import { startVitest } from 'vitest/node'
 import { type Options, execa } from 'execa'
 import stripAnsi from 'strip-ansi'
+import { dirname, resolve } from 'pathe'
 
 export async function runVitest(config: UserConfig, cliFilters: string[] = [], mode: VitestRunMode = 'test') {
   // Reset possible previous runs
@@ -215,14 +217,16 @@ afterEach(() => {
     fs.writeFileSync(file, content, 'utf-8')
   })
   createdFiles.forEach((file) => {
-    fs.unlinkSync(file)
+    if (fs.existsSync(file))
+      fs.unlinkSync(file)
   })
   originalFiles.clear()
   createdFiles.clear()
 })
 
 export function createFile(file: string, content: string) {
   createdFiles.add(file)
+  fs.mkdirSync(dirname(file), { recursive: true })
   fs.writeFileSync(file, content, 'utf-8')
 }
 
@@ -232,3 +236,8 @@ export function editFile(file: string, callback: (content: string) => string) {
     originalFiles.set(file, content)
   fs.writeFileSync(file, callback(content), 'utf-8')
 }
+
+export function resolvePath(baseUrl: string, path: string) {
+  const filename = fileURLToPath(baseUrl)
+  return resolve(dirname(filename), path)
+}

test/test-utils/index.ts

@@ -1,6 +1,7 @@
 {
   "name": "@vitest/test-utils",
   "private": true,
+  "main": "./index.ts",
   "scripts": {
     "test": "echo \"No tests\""
   },

test/test-utils/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@vitest/test-vm-threads",
+  "private": true,
+  "scripts": {
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "vitest": "workspace:*"
+  }
+}

test/vm-threads/package.json

@@ -0,0 +1,7 @@
+module.exports = {
+  a: 'a',
+  b: 'b',
+  object: {
+    h: 'h',
+  },
+}

test/vm-threads/src/external/default-cjs.cjs

@@ -0,0 +1,2 @@
+export * from './default-cjs.cjs'
+export { default } from './default-cjs.cjs'

test/vm-threads/src/external/export-default-cjs.js

@@ -0,0 +1,2 @@
+export * from './nested-default-cjs.cjs'
+export { default } from './nested-default-cjs.cjs'

test/vm-threads/src/external/export-nested-default-cjs.js

@@ -0,0 +1,8 @@
+exports.default = {
+  a: 'a',
+  b: 'b',
+  object: {
+    h: 'h',
+  },
+}
+Object.defineProperty(exports, '__esModule', { value: true, enumerable: false })

test/vm-threads/src/external/nested-default-cjs.cjs

@@ -0,0 +1 @@
+module.exports = 42

test/vm-threads/src/external/package-null/package-null.js

@@ -0,0 +1 @@
+{ "type": "module" }

test/vm-threads/src/external/package.json

@@ -0,0 +1 @@
+module.exports = 'string'

test/vm-threads/src/external/primitive-cjs.cjs

@@ -0,0 +1,32 @@
+import { createRequire } from 'node:module'
+import { describe, expect, test } from 'vitest'
+import { createFile, resolvePath } from '../../test-utils'
+
+const require = createRequire(import.meta.url)
+
+test('can require if package.json is null', () => {
+  createFile(resolvePath(import.meta.url, '../src/external/package-null/package-null.json'), 'null')
+  expect(() => require('../src/external/package-null/package-null.js')).not.toThrow()
+})
+
+describe('validating nested defaults in isolation', async () => {
+  const nestedDefaultExternalCjs = await import('../src/external/export-nested-default-cjs.js')
+  const moduleDefaultCjs = await import('../src/external/export-default-cjs.js')
+
+  test('nested default should be resolved', () => {
+    expect(nestedDefaultExternalCjs).toHaveProperty('default')
+    expect(nestedDefaultExternalCjs.default).not.toHaveProperty('default')
+    expect(nestedDefaultExternalCjs.default.a).toBe('a')
+    expect(nestedDefaultExternalCjs.default.b).toBe('b')
+    expect(nestedDefaultExternalCjs.a).toBe('a')
+    expect(nestedDefaultExternalCjs.b).toBe('b')
+  })
+
+  test('externalized "module.exports" CJS module interops default', () => {
+    expect(moduleDefaultCjs).toHaveProperty('default')
+    expect(moduleDefaultCjs.default).toHaveProperty('a')
+    expect(moduleDefaultCjs.default.a).toBe('a')
+    expect(moduleDefaultCjs).toHaveProperty('a')
+    expect(moduleDefaultCjs.a).toBe('a')
+  })
+})

test/vm-threads/test/require-cjs.test.js

@@ -0,0 +1,12 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    experimentalVmThreads: true,
+    server: {
+      deps: {
+        external: [/src\/external/],
+      },
+    },
+  },
+})