fix: ignore non-string stack properties (#7995)

Author: sheremet-va

packages/utils/src/error.ts

@@ -124,10 +124,10 @@ export function processError(
 
   // stack is not serialized in worker communication
   // we stringify it first
-  if (err.stack) {
+  if (typeof err.stack === 'string') {
     err.stackStr = String(err.stack)
   }
-  if (err.name) {
+  if (typeof err.name === 'string') {
     err.nameStr = String(err.name)
   }
 

packages/utils/src/source-map.ts

@@ -278,7 +278,11 @@ export function parseErrorStacktrace(
   }
 
   const stackStr = e.stack || e.stackStr || ''
-  let stackFrames = parseStacktrace(stackStr, options)
+  // if "stack" property was overwritten at runtime to be something else,
+  // ignore the value because we don't know how to process it
+  let stackFrames = typeof stackStr === 'string'
+    ? parseStacktrace(stackStr, options)
+    : []
 
   if (!stackFrames.length) {
     const e_ = e as any

packages/vitest/src/node/logger.ts

@@ -8,7 +8,7 @@ import { Console } from 'node:console'
 import { toArray } from '@vitest/utils'
 import c from 'tinyrainbow'
 import { highlightCode } from '../utils/colors'
-import { printError } from './error'
+import { printError } from './printError'
 import { divider, errorBanner, formatProjectName, withLabel } from './reporters/renderers/utils'
 import { RandomSequencer } from './sequencers/RandomSequencer'
 

packages/vitest/src/node/plugins/mocks.ts

@@ -2,7 +2,7 @@ import type { Plugin } from 'vite'
 import { automockPlugin, hoistMocksPlugin } from '@vitest/mocker/node'
 import { normalize } from 'pathe'
 import { distDir } from '../../paths'
-import { generateCodeFrame } from '../error'
+import { generateCodeFrame } from '../printError'
 
 export interface MocksPluginOptions {
   filter?: (id: string) => boolean

packages/vitest/src/node/error.ts renamed to packages/vitest/src/node/printError.ts

@@ -251,7 +251,6 @@ function printErrorType(type: string, ctx: Vitest) {
 
 const skipErrorProperties = new Set([
   'nameStr',
-  'stack',
   'cause',
   'stacks',
   'stackStr',
@@ -286,7 +285,11 @@ function getErrorProperties(e: ErrorWithDiff) {
   }
 
   for (const key of Object.getOwnPropertyNames(e)) {
-    if (!skipErrorProperties.has(key)) {
+    // print the original stack if it was ever changed manually by the user
+    if (key === 'stack' && e[key] != null && typeof e[key] !== 'string') {
+      errorObject[key] = e[key]
+    }
+    else if (key !== 'stack' && !skipErrorProperties.has(key)) {
       errorObject[key] = e[key as keyof ErrorWithDiff]
     }
   }

packages/vitest/src/node/reporters/github-actions.ts

@@ -4,7 +4,7 @@ import type { TestProject } from '../project'
 import type { Reporter } from '../types/reporter'
 import { stripVTControlCharacters } from 'node:util'
 import { getFullName, getTasks } from '@vitest/runner/utils'
-import { capturePrintError } from '../error'
+import { capturePrintError } from '../printError'
 
 export class GithubActionsReporter implements Reporter {
   ctx: Vitest = undefined!

packages/vitest/src/node/reporters/junit.ts

@@ -8,7 +8,7 @@ import { stripVTControlCharacters } from 'node:util'
 import { getSuites } from '@vitest/runner/utils'
 import { dirname, relative, resolve } from 'pathe'
 import { getOutputFile } from '../../utils/config-helpers'
-import { capturePrintError } from '../error'
+import { capturePrintError } from '../printError'
 import { IndentedLogger } from './renderers/indented-logger'
 
 interface ClassnameTemplateVariables {

test/cli/test/print-error.test.ts

@@ -0,0 +1,42 @@
+import { expect, test } from 'vitest'
+import { runInlineTests } from '../../test-utils'
+
+test('prints a custom error stack', async () => {
+  const { stderr } = await runInlineTests({
+    'basic.test.ts': `
+    test('failed test', () => {
+      throw {
+        message: 'from failed test',
+        stack: ['stack 1', 'stack 2'],
+      }
+    })
+
+    test('fails toJson', () => {
+      class CustomError extends Error {
+        toJSON() {
+          return {
+            message: this.message,
+            stack: ['custom stack 1', 'custom stack 2']
+          }
+        }
+      }
+
+      throw new CustomError('custom error')
+    })
+    `,
+  }, { globals: true })
+
+  expect(stderr).toContain(`
+ FAIL  basic.test.ts > failed test
+Unknown Error: from failed test
+⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
+Serialized Error: { stack: [ 'stack 1', 'stack 2' ] }
+    `.trim())
+
+  expect(stderr).toContain(`
+ FAIL  basic.test.ts > fails toJson
+Unknown Error: custom error
+⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
+Serialized Error: { stack: [ 'custom stack 1', 'custom stack 2' ] }
+    `.trim())
+})

test/core/test/injector-mock.test.ts

@@ -2,8 +2,8 @@ import type { HoistMocksPluginOptions } from '../../../packages/mocker/src/node/
 import { stripVTControlCharacters } from 'node:util'
 import { parseAst } from 'vite'
 import { describe, expect, it, test } from 'vitest'
-import { generateCodeFrame } from 'vitest/src/node/error.js'
 import { hoistMocks } from '../../../packages/mocker/src/node/hoistMocksPlugin'
+import { generateCodeFrame } from '../../../packages/vitest/src/node/printError.js'
 
 function parse(code: string, options: any) {
   return parseAst(code, options)

test/reporters/tests/__snapshots__/junit.test.ts.snap

@@ -112,13 +112,7 @@ Unknown Error: 1234
         </testcase>
         <testcase classname="error.test.ts" name="number name object" time="...">
             <failure type="1234">
-{
-  name: 1234,
-  nameStr: &apos;1234&apos;,
-  expected: &apos;undefined&apos;,
-  actual: &apos;undefined&apos;,
-  stacks: []
-}
+{ name: 1234, expected: &apos;undefined&apos;, actual: &apos;undefined&apos;, stacks: [] }
             </failure>
         </testcase>
         <testcase classname="error.test.ts" name="xml" time="...">