feat(browser): add trackUnhandledErrors option (#8386)

Author: sheremet-va

docs/guide/browser/config.md

@@ -326,6 +326,17 @@ The timeout in milliseconds. If connection to the browser takes longer, the test
 This is the time it should take for the browser to establish the WebSocket connection with the Vitest server. In normal circumstances, this timeout should never be reached.
 :::
 
+## browser.trackUnhandledErrors
+
+- **Type:** `boolean`
+- **Default:** `true`
+
+Enables tracking uncaught errors and exceptions so they can be reported by Vitest.
+
+If you need to hide certain errors, it is recommended to use [`onUnhandledError`](/config/#onunhandlederror) option instead.
+
+Disabling this will completely remove all Vitest error handlers, which can help debugging with the "Pause on exceptions" checkbox turned on.
+
 ## browser.expect
 
 - **Type:** `ExpectOptions`

docs/guide/cli-generated.md

@@ -376,6 +376,13 @@ Should browser test files run in parallel. Use `--browser.fileParallelism=false`
 
 If connection to the browser takes longer, the test suite will fail (default: `60_000`)
 
+### browser.trackUnhandledErrors
+
+- **CLI:** `--browser.trackUnhandledErrors`
+- **Config:** [browser.trackUnhandledErrors](/guide/browser/config#browser-trackunhandlederrors)
+
+Control if Vitest catches uncaught exceptions so they can be reported (default: `true`)
+
 ### pool
 
 - **CLI:** `--pool <pool>`

packages/browser/src/client/public/error-catcher.js

@@ -55,10 +55,14 @@ function catchWindowErrors(errorEvent, prop, cb) {
 }
 
 function registerUnexpectedErrors() {
-  catchWindowErrors('error', 'error', event =>
+  const offError = catchWindowErrors('error', 'error', event =>
     reportUnexpectedError('Error', event.error))
-  catchWindowErrors('unhandledrejection', 'reason', event =>
+  const offRejection = catchWindowErrors('unhandledrejection', 'reason', event =>
     reportUnexpectedError('Unhandled Rejection', event.reason))
+  return () => {
+    offError()
+    offRejection()
+  }
 }
 
 async function reportUnexpectedError(
@@ -71,4 +75,4 @@ async function reportUnexpectedError(
   }).catch(console.error)
 }
 
-registerUnexpectedErrors()
+globalThis.__vitest_browser_runner__.disposeExceptionTracker = registerUnexpectedErrors()

packages/browser/src/client/public/esm-client-injector.js

@@ -19,6 +19,7 @@
   window.__vitest_browser_runner__ = {
     wrapModule,
     wrapDynamicImport: wrapModule,
+    disposeExceptionTracker: () => {},
     moduleCache,
     cleanups: [],
     config: { __VITEST_CONFIG__ },

packages/browser/src/client/tester/tester.ts

@@ -217,6 +217,10 @@ async function prepare(options: PrepareOptions) {
       })
     })(),
   ])
+
+  if (!config.browser.trackUnhandledErrors) {
+    getBrowserState().disposeExceptionTracker()
+  }
 }
 
 async function cleanup() {

packages/browser/src/client/utils.ts

@@ -75,6 +75,7 @@ export interface BrowserRunnerState {
   }
   providedContext: string
   type: 'tester' | 'orchestrator'
+  disposeExceptionTracker: () => void
   wrapModule: <T>(module: () => T) => T
   iframeId?: string
   sessionId: string

packages/vitest/src/node/cli/cli-config.ts

@@ -411,6 +411,9 @@ export const cliOptionsConfig: VitestCLIOptions = {
         description: 'If connection to the browser takes longer, the test suite will fail (default: `60_000`)',
         argument: '<timeout>',
       },
+      trackUnhandledErrors: {
+        description: 'Control if Vitest catches uncaught exceptions so they can be reported (default: `true`)',
+      },
       orchestratorScripts: null,
       testerScripts: null,
       commands: null,

packages/vitest/src/node/config/serializeConfig.ts

@@ -156,6 +156,7 @@ export function serializeConfig(
               actionTimeout: (browser.providerOptions as any)?.context?.actionTimeout,
             }
           : {},
+        trackUnhandledErrors: browser.trackUnhandledErrors ?? true,
       }
     })(config.browser),
     standalone: config.standalone,

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

@@ -248,6 +248,16 @@ export interface BrowserConfigOptions {
       }
     }[keyof ToMatchScreenshotComparators] & ToMatchScreenshotOptions
   }
+
+  /**
+   * Enables tracking uncaught errors and exceptions so they can be reported by Vitest.
+   *
+   * If you need to hide certain errors, it is recommended to use [`onUnhandledError`](https://vitest.dev/config/#onunhandlederror) option instead.
+   *
+   * Disabling this will completely remove all Vitest error handlers, which can help debugging with the "Pause on exceptions" checkbox turned on.
+   * @default true
+   */
+  trackUnhandledErrors?: boolean
 }
 
 export interface BrowserCommandContext {

packages/vitest/src/runtime/config.ts

@@ -122,6 +122,7 @@ export interface SerializedConfig {
       // for playwright
       actionTimeout?: number
     }
+    trackUnhandledErrors: boolean
   }
   standalone: boolean
   logHeapUsage: boolean | undefined