fix!: replace deprecated ErrorWithDiff with TestError (#8195)

sheremet-va · web-flow · commit da59eb887bd9 · 2025-06-20T11:58:26.000+02:00
diff --git a/docs/advanced/runner.md b/docs/advanced/runner.md
@@ -238,7 +238,7 @@ export interface TaskResult {
    * Errors that occurred during the task execution. It is possible to have several errors
    * if `expect.soft()` failed multiple times.
    */
-  errors?: ErrorWithDiff[]
+  errors?: TestError[]
   /**
    * How long in milliseconds the task took to run.
    */
diff --git a/packages/browser/src/client/tester/rpc.ts b/packages/browser/src/client/tester/rpc.ts
@@ -4,28 +4,21 @@ import { getSafeTimers } from 'vitest/internal/browser'
 const { get } = Reflect
 
 function withSafeTimers(getTimers: typeof getSafeTimers, fn: () => void) {
-  const { setTimeout, clearTimeout, setImmediate, clearImmediate }
-    = getTimers()
+  const { setTimeout, clearTimeout } = getTimers()
 
   const currentSetTimeout = globalThis.setTimeout
   const currentClearTimeout = globalThis.clearTimeout
-  const currentSetImmediate = globalThis.setImmediate
-  const currentClearImmediate = globalThis.clearImmediate
 
   try {
     globalThis.setTimeout = setTimeout
     globalThis.clearTimeout = clearTimeout
-    globalThis.setImmediate = setImmediate
-    globalThis.clearImmediate = clearImmediate
 
     const result = fn()
     return result
   }
   finally {
     globalThis.setTimeout = currentSetTimeout
     globalThis.clearTimeout = currentClearTimeout
-    globalThis.setImmediate = currentSetImmediate
-    globalThis.clearImmediate = currentClearImmediate
   }
 }
 
diff --git a/packages/browser/src/node/project.ts b/packages/browser/src/node/project.ts
@@ -1,6 +1,6 @@
 import type { StackTraceParserOptions } from '@vitest/utils/source-map'
 import type { ViteDevServer } from 'vite'
-import type { ErrorWithDiff, ParsedStack, SerializedConfig } from 'vitest'
+import type { ParsedStack, SerializedConfig, TestError } from 'vitest'
 import type {
   BrowserProvider,
   ProjectBrowser as IProjectBrowser,
@@ -93,7 +93,7 @@ export class ProjectBrowser implements IProjectBrowser {
   }
 
   public parseErrorStacktrace(
-    e: ErrorWithDiff,
+    e: TestError,
     options: StackTraceParserOptions = {},
   ): ParsedStack[] {
     return this.parent.parseErrorStacktrace(e, options)
diff --git a/packages/browser/src/node/projectParent.ts b/packages/browser/src/node/projectParent.ts
@@ -1,6 +1,6 @@
 import type { StackTraceParserOptions } from '@vitest/utils/source-map'
 import type { HtmlTagDescriptor } from 'vite'
-import type { ErrorWithDiff, ParsedStack } from 'vitest'
+import type { ParsedStack, TestError } from 'vitest'
 import type {
   BrowserCommand,
   BrowserScript,
@@ -159,7 +159,7 @@ export class ParentBrowserProject {
   }
 
   public parseErrorStacktrace(
-    e: ErrorWithDiff,
+    e: TestError,
     options: StackTraceParserOptions = {},
   ): ParsedStack[] {
     return parseErrorStacktrace(e, {
diff --git a/packages/browser/src/node/rpc.ts b/packages/browser/src/node/rpc.ts
@@ -1,6 +1,6 @@
 import type { MockerRegistry } from '@vitest/mocker'
 import type { Duplex } from 'node:stream'
-import type { ErrorWithDiff } from 'vitest'
+import type { TestError } from 'vitest'
 import type { BrowserCommandContext, ResolveSnapshotPathHandlerContext, TestProject } from 'vitest/node'
 import type { WebSocket } from 'ws'
 import type { ParentBrowserProject } from './projectParent'
@@ -128,7 +128,7 @@ export function setupBrowserRpc(globalServer: ParentBrowserProject, defaultMocke
       {
         async onUnhandledError(error, type) {
           if (error && typeof error === 'object') {
-            const _error = error as ErrorWithDiff
+            const _error = error as TestError
             _error.stacks = globalServer.parseErrorStacktrace(_error)
           }
           vitest.state.catchError(error, type)
diff --git a/packages/runner/src/types/tasks.ts b/packages/runner/src/types/tasks.ts
@@ -1,4 +1,4 @@
-import type { Awaitable, ErrorWithDiff } from '@vitest/utils'
+import type { Awaitable, TestError } from '@vitest/utils'
 import type { FixtureItem } from '../fixture'
 import type { ChainableFunction } from '../utils/chain'
 
@@ -118,7 +118,7 @@ export interface TaskResult {
    * Errors that occurred during the task execution. It is possible to have several errors
    * if `expect.soft()` failed multiple times or `retry` was triggered.
    */
-  errors?: ErrorWithDiff[]
+  errors?: TestError[]
   /**
    * How long in milliseconds the task took to run.
    */
diff --git a/packages/ui/client/components/dashboard/ErrorEntry.vue b/packages/ui/client/components/dashboard/ErrorEntry.vue
@@ -1,8 +1,8 @@
 <script setup lang="ts">
-import type { ErrorWithDiff } from '@vitest/utils'
+import type { TestError } from '@vitest/utils'
 
 defineProps<{
-  error: ErrorWithDiff
+  error: TestError
 }>()
 </script>
 
diff --git a/packages/ui/client/components/views/ViewEditor.vue b/packages/ui/client/components/views/ViewEditor.vue
@@ -1,7 +1,7 @@
 <script setup lang="ts">
 import type { Task } from '@vitest/runner'
 import type CodeMirror from 'codemirror'
-import type { ErrorWithDiff, File, TestAnnotation, TestError } from 'vitest'
+import type { File, TestAnnotation, TestError } from 'vitest'
 import { createTooltip, destroyTooltip } from 'floating-vue'
 import { getAttachmentUrl, sanitizeFilePath } from '~/composables/attachments'
 import { client, isReport } from '~/composables/client'
@@ -144,7 +144,7 @@ watch(
   { immediate: true },
 )
 
-function createErrorElement(e: ErrorWithDiff) {
+function createErrorElement(e: TestError) {
   const stacks = (e?.stacks || []).filter(
     i => i.file && i.file === props.file?.filepath,
   )
diff --git a/packages/ui/client/components/views/ViewReportError.vue b/packages/ui/client/components/views/ViewReportError.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import type { ErrorWithDiff, ParsedStack } from 'vitest'
+import type { ParsedStack, TestError } from 'vitest'
 import { showLocationSource } from '~/composables/codemirror'
 import { isTestFile, openInEditor } from '~/composables/error'
 import { escapeHtml } from '~/utils/escape'
@@ -8,7 +8,7 @@ const props = defineProps<{
   fileId: string
   root: string
   filename?: string
-  error: ErrorWithDiff
+  error: TestError
 }>()
 
 function relative(p: string) {
diff --git a/packages/ui/client/composables/client/state.ts b/packages/ui/client/composables/client/state.ts
@@ -1,7 +1,7 @@
-import type { ErrorWithDiff } from '@vitest/utils'
+import type { TestError } from '@vitest/utils'
 import type { Ref } from 'vue'
 import type { RunState } from '../../../types'
 
 export const testRunState: Ref<RunState> = ref('idle')
 export const finished = computed(() => testRunState.value === 'idle')
-export const unhandledErrors: Ref<ErrorWithDiff[]> = ref([])
+export const unhandledErrors: Ref<TestError[]> = ref([])
diff --git a/packages/ui/client/composables/error.ts b/packages/ui/client/composables/error.ts
@@ -1,5 +1,5 @@
 import type Convert from 'ansi-to-html'
-import type { ErrorWithDiff, RunnerTask } from 'vitest'
+import type { RunnerTask, TestError } from 'vitest'
 import { parseStacktrace } from '@vitest/utils/source-map'
 import Filter from 'ansi-to-html'
 import { escapeHtml } from '~/utils/escape'
@@ -33,7 +33,7 @@ function isPrimitive(value: unknown) {
 }
 
 export function parseError(e: unknown) {
-  let error = e as ErrorWithDiff
+  let error = e as TestError
 
   if (isPrimitive(e)) {
     error = {
@@ -59,7 +59,7 @@ export function parseError(e: unknown) {
   return error
 }
 
-function createHtmlError(filter: Convert, error: ErrorWithDiff) {
+function createHtmlError(filter: Convert, error: TestError) {
   let htmlError = ''
   if (error.message?.includes('\x1B')) {
     htmlError = `<b>${error.name}</b>: ${filter.toHtml(
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -46,7 +46,6 @@ export type {
   Awaitable,
   Constructable,
   DeepMerge,
-  ErrorWithDiff,
   MergeInsertions,
   MutableArray,
   Nullable,
diff --git a/packages/utils/src/source-map.ts b/packages/utils/src/source-map.ts
@@ -1,5 +1,5 @@
 import type { SourceMapInput } from '@jridgewell/trace-mapping'
-import type { ErrorWithDiff, ParsedStack } from './types'
+import type { ParsedStack, TestError } from './types'
 import { originalPositionFor, TraceMap } from '@jridgewell/trace-mapping'
 import { resolve } from 'pathe'
 import { isPrimitive, notNullish } from './helpers'
@@ -17,7 +17,7 @@ export interface StackTraceParserOptions {
   ignoreStackEntries?: (RegExp | string)[]
   getSourceMap?: (file: string) => unknown
   getUrlId?: (id: string) => string
-  frameFilter?: (error: ErrorWithDiff, frame: ParsedStack) => boolean | void
+  frameFilter?: (error: TestError, frame: ParsedStack) => boolean | void
 }
 
 const CHROME_IE_STACK_REGEXP = /^\s*at .*(?:\S:\d+|\(native\))/m
@@ -270,14 +270,14 @@ function parseV8Stacktrace(stack: string): ParsedStack[] {
 }
 
 export function parseErrorStacktrace(
-  e: ErrorWithDiff,
+  e: TestError | Error,
   options: StackTraceParserOptions = {},
 ): ParsedStack[] {
   if (!e || isPrimitive(e)) {
     return []
   }
 
-  if (e.stacks) {
+  if ('stacks' in e && e.stacks) {
     return e.stacks
   }
 
@@ -300,10 +300,10 @@ export function parseErrorStacktrace(
 
   if (options.frameFilter) {
     stackFrames = stackFrames.filter(
-      f => options.frameFilter!(e, f) !== false,
+      f => options.frameFilter!(e as TestError, f) !== false,
     )
   }
 
-  e.stacks = stackFrames
+  ;(e as TestError).stacks = stackFrames
   return stackFrames
 }
diff --git a/packages/utils/src/types.ts b/packages/utils/src/types.ts
@@ -47,22 +47,3 @@ export interface TestError extends SerializedError {
   actual?: string
   expected?: string
 }
-
-/**
- * @deprecated Use `TestError` instead
- */
-export interface ErrorWithDiff {
-  message: string
-  name?: string
-  cause?: unknown
-  stack?: string
-  stacks?: ParsedStack[]
-  showDiff?: boolean
-  actual?: any
-  expected?: any
-  operator?: string
-  type?: string
-  frame?: string
-  diff?: string
-  codeFrame?: string
-}
diff --git a/packages/vitest/src/node/logger.ts b/packages/vitest/src/node/logger.ts
@@ -1,5 +1,4 @@
 import type { Task } from '@vitest/runner'
-import type { ErrorWithDiff } from '@vitest/utils'
 import type { Writable } from 'node:stream'
 import type { TypeCheckError } from '../typecheck/typechecker'
 import type { Vitest } from './core'
@@ -271,7 +270,7 @@ export class Logger {
     errors.forEach((err) => {
       this.printError(err, {
         fullStack: true,
-        type: (err as ErrorWithDiff).type || 'Unhandled Error',
+        type: (err as any).type || 'Unhandled Error',
       })
     })
     this.error(c.red(divider()))
diff --git a/packages/vitest/src/node/printError.ts b/packages/vitest/src/node/printError.ts
@@ -1,5 +1,5 @@
 /* eslint-disable prefer-template */
-import type { ErrorWithDiff, ParsedStack } from '@vitest/utils'
+import type { ParsedStack, TestError } from '@vitest/utils'
 import type { Vitest } from './core'
 import type { ErrorOptions, Logger } from './logger'
 import type { TestProject } from './project'
@@ -27,7 +27,7 @@ interface PrintErrorOptions {
   showCodeFrame?: boolean
   printProperties?: boolean
   screenshotPaths?: string[]
-  parseErrorStacktrace: (error: ErrorWithDiff) => ParsedStack[]
+  parseErrorStacktrace: (error: TestError) => ParsedStack[]
 }
 
 interface PrintErrorResult {
@@ -99,7 +99,7 @@ function printErrorInner(
 ): PrintErrorResult | undefined {
   const { showCodeFrame = true, type, printProperties = true } = options
   const logger = options.logger
-  let e = error as ErrorWithDiff
+  let e = error as TestError
 
   if (isPrimitive(e)) {
     e = {
@@ -277,7 +277,7 @@ const skipErrorProperties = new Set([
   ...Object.getOwnPropertyNames(Object.prototype),
 ])
 
-function getErrorProperties(e: ErrorWithDiff) {
+function getErrorProperties(e: TestError) {
   const errorObject = Object.create(null)
   if (e.name === 'AssertionError') {
     return errorObject
@@ -289,7 +289,7 @@ function getErrorProperties(e: ErrorWithDiff) {
       errorObject[key] = e[key]
     }
     else if (key !== 'stack' && !skipErrorProperties.has(key)) {
-      errorObject[key] = e[key as keyof ErrorWithDiff]
+      errorObject[key] = e[key as keyof TestError]
     }
   }
 
@@ -364,7 +364,7 @@ function printModuleWarningForSourceCode(logger: ErrorLogger, path: string) {
   )
 }
 
-function printErrorMessage(error: ErrorWithDiff, logger: ErrorLogger) {
+function printErrorMessage(error: TestError, logger: ErrorLogger) {
   const errorName = error.name || 'Unknown Error'
   if (!error.message) {
     logger.error(error)
diff --git a/packages/vitest/src/node/reporters/base.ts b/packages/vitest/src/node/reporters/base.ts
@@ -1,5 +1,5 @@
 import type { File, Task } from '@vitest/runner'
-import type { ErrorWithDiff, UserConsoleLog } from '../../types/general'
+import type { TestError, UserConsoleLog } from '../../types/general'
 import type { Vitest } from '../core'
 import type { Reporter } from '../types/reporter'
 import type { TestCase, TestCollection, TestModule, TestModuleState, TestResult, TestSuite, TestSuiteState } from './reported-tasks'
@@ -253,7 +253,7 @@ export abstract class BaseReporter implements Reporter {
     return getFullName(test, separator)
   }
 
-  protected formatShortError(error: ErrorWithDiff): string {
+  protected formatShortError(error: TestError): string {
     return `${F_RIGHT} ${error.message}`
   }
 
@@ -602,7 +602,7 @@ export abstract class BaseReporter implements Reporter {
   }
 
   private printTaskErrors(tasks: Task[], errorDivider: () => void) {
-    const errorsQueue: [error: ErrorWithDiff | undefined, tests: Task[]][] = []
+    const errorsQueue: [error: TestError | undefined, tests: Task[]][] = []
 
     for (const task of tasks) {
       // Merge identical errors
diff --git a/packages/vitest/src/node/reporters/tap.ts b/packages/vitest/src/node/reporters/tap.ts
@@ -1,11 +1,14 @@
 import type { File, Task } from '@vitest/runner'
-import type { ErrorWithDiff, ParsedStack } from '@vitest/utils'
+import type { ParsedStack, TestError } from '@vitest/utils'
 import type { Vitest } from '../core'
 import type { Reporter } from '../types/reporter'
 import { parseErrorStacktrace } from '../../utils/source-map'
 import { IndentedLogger } from './renderers/indented-logger'
 
-function yamlString(str: string): string {
+function yamlString(str: string | undefined): string {
+  if (!str) {
+    return ''
+  }
   return `"${str.replace(/"/g, '\\"')}"`
 }
 
@@ -40,7 +43,7 @@ export class TapReporter implements Reporter {
     }
   }
 
-  private logErrorDetails(error: ErrorWithDiff, stack?: ParsedStack) {
+  private logErrorDetails(error: TestError, stack?: ParsedStack) {
     const errorName = error.name || 'Unknown Error'
     this.logger.log(`name: ${yamlString(String(errorName))}`)
     this.logger.log(`message: ${yamlString(String(error.message))}`)
diff --git a/packages/vitest/src/node/types/browser.ts b/packages/vitest/src/node/types/browser.ts
@@ -1,6 +1,6 @@
 import type { MockedModule } from '@vitest/mocker'
 import type { CancelReason } from '@vitest/runner'
-import type { Awaitable, ErrorWithDiff, ParsedStack } from '@vitest/utils'
+import type { Awaitable, ParsedStack, TestError } from '@vitest/utils'
 import type { StackTraceParserOptions } from '@vitest/utils/source-map'
 import type { ViteDevServer } from 'vite'
 import type { BrowserTesterOptions } from '../../types/browser'
@@ -275,7 +275,7 @@ export interface ProjectBrowser {
   close: () => Promise<void>
   initBrowserProvider: (project: TestProject) => Promise<void>
   parseStacktrace: (stack: string) => ParsedStack[]
-  parseErrorStacktrace: (error: ErrorWithDiff, options?: StackTraceParserOptions) => ParsedStack[]
+  parseErrorStacktrace: (error: TestError, options?: StackTraceParserOptions) => ParsedStack[]
 }
 
 export interface BrowserCommand<Payload extends unknown[]> {
diff --git a/packages/vitest/src/node/types/config.ts b/packages/vitest/src/node/types/config.ts
diff --git a/packages/vitest/src/public/index.ts b/packages/vitest/src/public/index.ts
diff --git a/packages/vitest/src/typecheck/typechecker.ts b/packages/vitest/src/typecheck/typechecker.ts
diff --git a/packages/vitest/src/types/general.ts b/packages/vitest/src/types/general.ts
diff --git a/test/reporters/src/data.ts b/test/reporters/src/data.ts
