fix: allow mocking CJS module with interoped default (#2598)

* fix: allow mocking CJS module with interoped default * chore: cleanup * chore: cleanup
vitest-dev · Jan 6, 2023 · 6b3e36d · 6b3e36d
1 parent 9a29f98
commit 6b3e36d
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 5 deletions.
diff --git a/examples/mocks/src/external/default-function.cjs b/examples/mocks/src/external/default-function.cjs
@@ -0,0 +1,3 @@
+module.exports = function () {
+  return true
+}
diff --git a/examples/mocks/test/external.test.ts b/examples/mocks/test/external.test.ts
@@ -1,7 +1,14 @@
 import '../src/external/external.mjs'
 import { expect, test, vi } from 'vitest'
 import axios from 'axios'
+import defaultFunc from '../src/external/default-function.cjs'
+
+vi.mock('../src/external/default-function.cjs')
 
 test('axios is mocked', () => {
   expect(vi.isMockFunction(axios.get)).toBe(true)
 })
+
+test('defaultFunc is mocked', () => {
+  expect(vi.isMockFunction(defaultFunc)).toBe(true)
+})
diff --git a/examples/mocks/vite.config.ts b/examples/mocks/vite.config.ts
@@ -25,6 +25,7 @@ export default defineConfig({
     environment: 'node',
     deps: {
       external: [/src\/external/],
+      interopDefault: true,
     },
   },
 })
diff --git a/packages/vite-node/src/client.ts b/packages/vite-node/src/client.ts
@@ -424,6 +424,14 @@ export class ViteNodeRunner {
 
     const { mod, defaultExport } = interopModule(importedModule)
 
+    const modKeys = Reflect.ownKeys(mod)
+    let defaultKeys = !isPrimitive(defaultExport) ? Reflect.ownKeys(defaultExport) : []
+    // remove reserved keys from default keys
+    if (typeof mod !== 'function' && typeof defaultExport === 'function') {
+      const reservedKeys = ['arguments', 'caller', 'prototype', 'name', 'length']
+      defaultKeys = defaultKeys.filter(n => typeof n === 'string' && !reservedKeys.includes(n))
+    }
+
     return new Proxy(mod, {
       get(mod, prop) {
         if (prop === 'default')
@@ -436,11 +444,10 @@ export class ViteNodeRunner {
         return prop in mod || (defaultExport && prop in defaultExport)
       },
       // this is needed for mocker to know what is available to mock
-      ownKeys(mod) {
-        const keys = Reflect.ownKeys(mod)
+      ownKeys() {
         if (!defaultExport || isPrimitive(defaultExport))
-          return keys
-        const allKeys = [...keys, 'default', ...Reflect.ownKeys(defaultExport)]
+          return modKeys
+        const allKeys = [...modKeys, 'default', ...defaultKeys]
         return Array.from(new Set(allKeys))
       },
       getOwnPropertyDescriptor(mod, prop) {

diff --git a/packages/vitest/src/runtime/execute.ts b/packages/vitest/src/runtime/execute.ts
@@ -73,6 +73,8 @@ export class VitestRunner extends ViteNodeRunner {
   }
 
   shouldInterop(path: string, mod: any) {
-    return this.options.interopDefault ?? (getCurrentEnvironment() !== 'node' && super.shouldInterop(path, mod))
+    if (this.options.interopDefault === false)
+      return false
+    return (this.options.interopDefault || getCurrentEnvironment() !== 'node') && super.shouldInterop(path, mod)
   }
 }