fix: add a suggestion to the error message of timeout (#837)

* fix: add suggestion to timeout message

* test: add test suit

* chore: fix message

* chore: wording

* chore: update

Co-authored-by: patak <matias.capeletto@gmail.com>
Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>

packages/vitest/src/runtime/context.ts

@@ -24,22 +24,29 @@ export function getDefaultHookTimeout() {
   return __vitest_worker__!.config!.hookTimeout
 }
 
-export function withTimeout<T extends((...args: any[]) => any)>(fn: T, _timeout?: number): T {
-  const timeout = _timeout ?? getDefaultTestTimeout()
+export function withTimeout<T extends((...args: any[]) => any)>(
+  fn: T,
+  timeout = getDefaultTestTimeout(),
+  isHook = false,
+): T {
   if (timeout <= 0 || timeout === Infinity)
     return fn
 
   return ((...args: (T extends ((...args: infer A) => any) ? A : never)) => {
     return Promise.race([fn(...args), new Promise((resolve, reject) => {
       const timer = setTimeout(() => {
         clearTimeout(timer)
-        reject(new Error(`Test timed out in ${timeout}ms.`))
+        reject(new Error(makeTimeoutMsg(isHook, timeout)))
       }, timeout)
       timer.unref()
     })]) as Awaitable<void>
   }) as T
 }
 
+function makeTimeoutMsg(isHook: boolean, timeout: number) {
+  return `${isHook ? 'Hook' : 'Test'} timed out in ${timeout}ms.\nIf this is a long-running test, pass a timeout value as the last argument or configure it globally with "${isHook ? 'hookTimeout' : 'testTimeout'}".`
+}
+
 function ensureAsyncTest(fn: TestFunction): () => Awaitable<void> {
   if (!fn.length)
     return fn as () => Awaitable<void>

packages/vitest/src/runtime/hooks.ts

@@ -3,7 +3,7 @@ import { getDefaultHookTimeout, withTimeout } from './context'
 import { getCurrentSuite } from './suite'
 
 // suite hooks
-export const beforeAll = (fn: SuiteHooks['beforeAll'][0], timeout?: number) => getCurrentSuite().on('beforeAll', withTimeout(fn, timeout ?? getDefaultHookTimeout()))
-export const afterAll = (fn: SuiteHooks['afterAll'][0], timeout?: number) => getCurrentSuite().on('afterAll', withTimeout(fn, timeout ?? getDefaultHookTimeout()))
-export const beforeEach = (fn: SuiteHooks['beforeEach'][0], timeout?: number) => getCurrentSuite().on('beforeEach', withTimeout(fn, timeout ?? getDefaultHookTimeout()))
-export const afterEach = (fn: SuiteHooks['afterEach'][0], timeout?: number) => getCurrentSuite().on('afterEach', withTimeout(fn, timeout ?? getDefaultHookTimeout()))
+export const beforeAll = (fn: SuiteHooks['beforeAll'][0], timeout?: number) => getCurrentSuite().on('beforeAll', withTimeout(fn, timeout ?? getDefaultHookTimeout(), true))
+export const afterAll = (fn: SuiteHooks['afterAll'][0], timeout?: number) => getCurrentSuite().on('afterAll', withTimeout(fn, timeout ?? getDefaultHookTimeout(), true))
+export const beforeEach = (fn: SuiteHooks['beforeEach'][0], timeout?: number) => getCurrentSuite().on('beforeEach', withTimeout(fn, timeout ?? getDefaultHookTimeout(), true))
+export const afterEach = (fn: SuiteHooks['afterEach'][0], timeout?: number) => getCurrentSuite().on('afterEach', withTimeout(fn, timeout ?? getDefaultHookTimeout(), true))

test/fails/fixtures/hook-timeout.test.ts

@@ -0,0 +1,10 @@
+import { beforeEach, describe, expect, it } from 'vitest'
+
+describe('hooks should timeout', () => {
+  beforeEach(async() => {
+    await new Promise(resolve => setTimeout(resolve, 20))
+  }, 10)
+  it('hello', () => {
+    expect(true).toBe(true)
+  })
+})

test/fails/test/__snapshots__/runner.test.ts.snap

@@ -2,6 +2,8 @@
 
 exports[`should fails > expect.test.ts > expect.test.ts 1`] = `"AssertionError: expected 2 to deeply equal 3"`;
 
+exports[`should fails > hook-timeout.test.ts > hook-timeout.test.ts 1`] = `"Error: Hook timed out in 10ms."`;
+
 exports[`should fails > nested-suite.test.ts > nested-suite.test.ts 1`] = `"AssertionError: expected true to be false // Object.is equality"`;
 
 exports[`should fails > stall.test.ts > stall.test.ts 1`] = `"TypeError: failure"`;