Merge branch 'main' into fix-skip-suite-snapshot

examples/mocks/src/cyclic-deps/module-1.mjs

@@ -0,0 +1 @@
+import './module-2'

examples/mocks/src/cyclic-deps/module-2.mjs

@@ -0,0 +1 @@
+import './module-3'

examples/mocks/src/cyclic-deps/module-3.mjs

@@ -0,0 +1 @@
+import './module-4'

examples/mocks/src/cyclic-deps/module-4.mjs

@@ -0,0 +1 @@
+import './module-1'

examples/mocks/test/cyclic-import-actual.spec.ts

@@ -0,0 +1,13 @@
+import { expect, test, vi } from 'vitest'
+
+import '../src/cyclic-deps/module-1'
+
+vi.mock('../src/cyclic-deps/module-2', async () => {
+  await vi.importActual('../src/cyclic-deps/module-2')
+
+  return { default: () => {} }
+})
+
+test('some test', () => {
+  expect(1 + 1).toBe(2)
+})

examples/mocks/test/cyclic-import-original.spec.ts

@@ -0,0 +1,13 @@
+import { expect, test, vi } from 'vitest'
+
+import '../src/cyclic-deps/module-1'
+
+vi.mock('../src/cyclic-deps/module-2', async (importOriginal) => {
+  await importOriginal()
+
+  return { default: () => {} }
+})
+
+test('some test', () => {
+  expect(1 + 1).toBe(2)
+})

packages/runner/src/run.ts

@@ -183,6 +183,7 @@ export async function runTest(test: Test | Custom, runner: VitestRunner) {
         test.mode = 'skip'
         test.result = { state: 'skip' }
         updateTask(test, runner)
+        setCurrentTest(undefined)
         return
       }
 

packages/ui/package.json

@@ -61,7 +61,7 @@
     "@faker-js/faker": "^8.2.0",
     "@iconify-json/logos": "^1.1.41",
     "@testing-library/cypress": "^10.0.1",
-    "@types/codemirror": "^5.60.13",
+    "@types/codemirror": "^5.60.15",
     "@types/d3-force": "^3.0.9",
     "@types/d3-selection": "^3.0.10",
     "@types/ws": "^8.5.9",
@@ -73,10 +73,10 @@
     "@vueuse/core": "^10.6.1",
     "ansi-to-html": "^0.7.2",
     "birpc": "0.2.14",
-    "codemirror": "^5.65.15",
+    "codemirror": "^5.65.16",
     "codemirror-theme-vars": "^0.1.2",
-    "cypress": "^13.6.0",
-    "d3-graph-controller": "^3.0.1",
+    "cypress": "^13.6.2",
+    "d3-graph-controller": "^3.0.2",
     "floating-vue": "^2.0.0-y.0",
     "splitpanes": "^3.1.5",
     "unocss": "^0.57.4",

packages/vitest/src/integrations/env/edge-runtime.ts

@@ -1,4 +1,3 @@
-import { importModule } from 'local-pkg'
 import type { Environment } from '../../types'
 import { populateGlobal } from './utils'
 import { KEYS } from './jsdom-keys'
@@ -7,7 +6,7 @@ export default <Environment>({
   name: 'edge-runtime',
   transformMode: 'ssr',
   async setupVM() {
-    const { EdgeVM } = await importModule('@edge-runtime/vm') as typeof import('@edge-runtime/vm')
+    const { EdgeVM } = await import('@edge-runtime/vm')
     const vm = new EdgeVM({
       extend: (context) => {
         context.global = context
@@ -25,7 +24,7 @@ export default <Environment>({
     }
   },
   async setup(global) {
-    const { EdgeVM } = await importModule('@edge-runtime/vm') as typeof import('@edge-runtime/vm')
+    const { EdgeVM } = await import('@edge-runtime/vm')
     const vm = new EdgeVM({
       extend: (context) => {
         context.global = context

packages/vitest/src/integrations/env/happy-dom.ts

@@ -1,12 +1,11 @@
-import { importModule } from 'local-pkg'
 import type { Environment } from '../../types'
 import { populateGlobal } from './utils'
 
 export default <Environment>({
   name: 'happy-dom',
   transformMode: 'web',
   async setupVM({ happyDOM = {} }) {
-    const { Window } = await importModule('happy-dom') as typeof import('happy-dom')
+    const { Window } = await import('happy-dom')
     const win = new Window({
       ...happyDOM,
       console: (console && globalThis.console) ? globalThis.console : undefined,
@@ -36,7 +35,7 @@ export default <Environment>({
   async setup(global, { happyDOM = {} }) {
     // happy-dom v3 introduced a breaking change to Window, but
     // provides GlobalWindow as a way to use previous behaviour
-    const { Window, GlobalWindow } = await importModule('happy-dom') as typeof import('happy-dom')
+    const { Window, GlobalWindow } = await import('happy-dom')
     const win = new (GlobalWindow || Window)({
       ...happyDOM,
       console: (console && global.console) ? global.console : undefined,

packages/vitest/src/integrations/env/jsdom.ts

@@ -1,4 +1,3 @@
-import { importModule } from 'local-pkg'
 import type { Environment } from '../../types'
 import { populateGlobal } from './utils'
 
@@ -35,7 +34,7 @@ export default <Environment>({
       JSDOM,
       ResourceLoader,
       VirtualConsole,
-    } = await importModule('jsdom') as typeof import('jsdom')
+    } = await import('jsdom')
     const {
       html = '<!DOCTYPE html>',
       userAgent,
@@ -107,7 +106,7 @@ export default <Environment>({
       JSDOM,
       ResourceLoader,
       VirtualConsole,
-    } = await importModule('jsdom') as typeof import('jsdom')
+    } = await import('jsdom')
     const {
       html = '<!DOCTYPE html>',
       userAgent,

packages/vitest/src/integrations/vi.ts

@@ -482,7 +482,7 @@ function createVitest(): VitestUtils {
       _mocker.queueMock(
         path,
         importer,
-        factory ? () => factory(() => _mocker.importActual(path, importer)) : undefined,
+        factory ? () => factory(() => _mocker.importActual(path, importer, _mocker.getMockContext().callstack)) : undefined,
       )
     },
 
@@ -495,7 +495,7 @@ function createVitest(): VitestUtils {
       _mocker.queueMock(
         path,
         importer,
-        factory ? () => factory(() => _mocker.importActual(path, importer)) : undefined,
+        factory ? () => factory(() => _mocker.importActual(path, importer, _mocker.getMockContext().callstack)) : undefined,
       )
     },
 
@@ -504,7 +504,11 @@ function createVitest(): VitestUtils {
     },
 
     async importActual<T = unknown>(path: string): Promise<T> {
-      return _mocker.importActual<T>(path, getImporter())
+      return _mocker.importActual<T>(
+        path,
+        getImporter(),
+        _mocker.getMockContext().callstack,
+      )
     },
 
     async importMock<T>(path: string): Promise<MaybeMockedDeep<T>> {

packages/vitest/src/node/pools/browser.ts

@@ -44,7 +44,7 @@ export function createBrowserPool(ctx: Vitest): ProcessPool {
     if (project.config.browser.isolate) {
       for (const path of paths) {
         if (isCancelled) {
-          ctx.state.cancelFiles(files.slice(paths.indexOf(path)), ctx.config.root, project.getName())
+          ctx.state.cancelFiles(files.slice(paths.indexOf(path)), ctx.config.root, project.config.name)
           break
         }
 

packages/vitest/src/node/pools/child.ts

@@ -118,7 +118,7 @@ export function createChildProcessPool(ctx: Vitest, { execArgv, env, forksPath }
 
         // Intentionally cancelled
         else if (ctx.isCancelling && error instanceof Error && /The task has been cancelled/.test(error.message))
-          ctx.state.cancelFiles(files, ctx.config.root, project.getName())
+          ctx.state.cancelFiles(files, ctx.config.root, project.config.name)
 
         else
           throw error

packages/vitest/src/node/pools/threads.ts

@@ -106,7 +106,7 @@ export function createThreadsPool(ctx: Vitest, { execArgv, env, workerPath }: Po
 
         // Intentionally cancelled
         else if (ctx.isCancelling && error instanceof Error && /The task has been cancelled/.test(error.message))
-          ctx.state.cancelFiles(files, ctx.config.root, project.getName())
+          ctx.state.cancelFiles(files, ctx.config.root, project.config.name)
 
         else
           throw error

packages/vitest/src/node/pools/vm-threads.ts

@@ -111,7 +111,7 @@ export function createVmThreadsPool(ctx: Vitest, { execArgv, env, vmPath }: Pool
 
         // Intentionally cancelled
         else if (ctx.isCancelling && error instanceof Error && /The task has been cancelled/.test(error.message))
-          ctx.state.cancelFiles(files, ctx.config.root, project.getName())
+          ctx.state.cancelFiles(files, ctx.config.root, project.config.name)
 
         else
           throw error
@@ -123,6 +123,9 @@ export function createVmThreadsPool(ctx: Vitest, { execArgv, env, vmPath }: Pool
     }
 
     return async (specs, invalidates) => {
+      // Cancel pending tasks from pool when possible
+      ctx.onCancel(() => pool.cancelPendingTasks())
+
       const configs = new Map<WorkspaceProject, ResolvedConfig>()
       const getConfig = (project: WorkspaceProject): ResolvedConfig => {
         if (configs.has(project))

packages/vitest/src/runtime/mocker.ts

@@ -32,6 +32,13 @@ class RefTracker {
 
 type Key = string | symbol
 
+interface MockContext {
+  /**
+   * When mocking with a factory, this refers to the module that imported the mock.
+   */
+  callstack: null | string[]
+}
+
 function isSpecialProp(prop: Key, parentType: string) {
   return parentType.includes('Function')
       && typeof prop === 'string'
@@ -54,6 +61,10 @@ export class VitestMocker {
 
   private filterPublicKeys: (symbol | string)[]
 
+  private mockContext: MockContext = {
+    callstack: null,
+  }
+
   constructor(
     public executor: VitestExecutor,
   ) {
@@ -201,9 +212,9 @@ export class VitestMocker {
           throw this.createError(
             `[vitest] No "${String(prop)}" export is defined on the "${mockpath}" mock. `
             + 'Did you forget to return it from "vi.mock"?'
-            + '\nIf you need to partially mock a module, you can use "vi.importActual" inside:\n\n'
-            + `${c.green(`vi.mock("${mockpath}", async () => {
-  const actual = await vi.importActual("${mockpath}")
+            + '\nIf you need to partially mock a module, you can use "importOriginal" helper inside:\n\n'
+            + `${c.green(`vi.mock("${mockpath}", async (importOriginal) => {
+  const actual = await importOriginal()
   return {
     ...actual,
     // your mocked methods
@@ -221,6 +232,10 @@ export class VitestMocker {
     return moduleExports
   }
 
+  public getMockContext() {
+    return this.mockContext
+  }
+
   public getMockPath(dep: string) {
     return `mock:${dep}`
   }
@@ -407,9 +422,9 @@ export class VitestMocker {
     this.deleteCachedItem(id)
   }
 
-  public async importActual<T>(rawId: string, importee: string): Promise<T> {
-    const { id, fsPath } = await this.resolvePath(rawId, importee)
-    const result = await this.executor.cachedRequest(id, fsPath, [importee])
+  public async importActual<T>(rawId: string, importer: string, callstack?: string[] | null): Promise<T> {
+    const { id, fsPath } = await this.resolvePath(rawId, importer)
+    const result = await this.executor.cachedRequest(id, fsPath, callstack || [importer])
     return result as T
   }
 
@@ -453,9 +468,14 @@ export class VitestMocker {
     if (typeof mock === 'function' && !callstack.includes(mockPath) && !callstack.includes(url)) {
       try {
         callstack.push(mockPath)
+        // this will not work if user does Promise.all(import(), import())
+        // we can also use AsyncLocalStorage to store callstack, but this won't work in the browser
+        // maybe we should improve mock API in the future?
+        this.mockContext.callstack = callstack
         return await this.callFunctionMock(mockPath, mock)
       }
       finally {
+        this.mockContext.callstack = null
         const indexMock = callstack.indexOf(mockPath)
         callstack.splice(indexMock, 1)
       }

packages/vitest/src/runtime/runners/test.ts

@@ -1,4 +1,4 @@
-import type { CancelReason, Custom, ExtendedContext, File, Suite, TaskContext, Test, VitestRunner, VitestRunnerImportSource } from '@vitest/runner'
+import type { CancelReason, Custom, ExtendedContext, Suite, TaskContext, Test, VitestRunner, VitestRunnerImportSource } from '@vitest/runner'
 import type { ExpectStatic } from '@vitest/expect'
 import { GLOBAL_EXPECT, getState, setState } from '@vitest/expect'
 import { getSnapshotClient } from '../../integrations/snapshot/chai'
@@ -27,25 +27,23 @@ export class VitestTestRunner implements VitestRunner {
     this.snapshotClient.clear()
   }
 
-  async onAfterRunFiles(files?: File[]) {
-    // mark snapshots in skipped tests as not obsolete
-    // TODO: this probably doesn't work when `VitestTestRunner` is handling multiple files concurrently,
-    //       but `snapshotClient.startCurrentRun/finishCurrentRun` doesn't work in that case already?
-    for (const test of getTests(files ?? [])) {
-      if (test.mode === 'skip') {
-        const name = getNames(test).slice(1).join(' > ')
-        this.snapshotClient.skipTestSnapshots(name)
-      }
-    }
-
-    const result = await this.snapshotClient.finishCurrentRun()
-    if (result)
-      await rpc().snapshotSaved(result)
-  }
-
-  onAfterRunSuite(suite: Suite) {
+  async onAfterRunSuite(suite: Suite) {
     if (this.config.logHeapUsage && typeof process !== 'undefined')
       suite.result!.heap = process.memoryUsage().heapUsed
+
+    if (suite.mode !== 'skip' && typeof suite.filepath !== 'undefined') {
+      // mark snapshots in skipped tests as not obsolete
+      for (const test of getTests(suite)) {
+        if (test.mode === 'skip') {
+          const name = getNames(test).slice(1).join(' > ')
+          this.snapshotClient.skipTestSnapshots(name)
+        }
+      }
+
+      const result = await this.snapshotClient.finishCurrentRun()
+      if (result)
+        await rpc().snapshotSaved(result)
+    }
   }
 
   onAfterRunTask(test: Test) {
@@ -62,23 +60,27 @@ export class VitestTestRunner implements VitestRunner {
   }
 
   async onBeforeRunTask(test: Test) {
-    const name = getNames(test).slice(1).join(' > ')
-
     if (this.cancelRun)
       test.mode = 'skip'
 
     if (test.mode !== 'run')
       return
 
     clearModuleMocks(this.config)
-    await this.snapshotClient.startCurrentRun(test.file!.filepath, name, this.workerState.config.snapshotOptions)
 
     this.workerState.current = test
   }
 
-  onBeforeRunSuite(suite: Suite) {
+  async onBeforeRunSuite(suite: Suite) {
     if (this.cancelRun)
       suite.mode = 'skip'
+
+    // initialize snapshot state before running file suite
+    if (suite.mode !== 'skip' && typeof suite.filepath !== 'undefined') {
+      // default "name" is irrelevant for Vitest since each snapshot assertion
+      // (e.g. `toMatchSnapshot`) specifies "filepath" / "name" pair explicitly
+      await this.snapshotClient.startCurrentRun(suite.filepath, '__default_name_', this.workerState.config.snapshotOptions)
+    }
   }
 
   onBeforeTryTask(test: Test) {