feat(options): defaultTimeout (#85)

Author: Aslemammad

src/constants.ts

@@ -3,10 +3,6 @@ import { fileURLToPath } from 'url'
 
 export const distDir = resolve(fileURLToPath(import.meta.url), '../../dist')
 
-// TODO: make then globally configureable in vitest.config.js
-export const defaultTestTimeout = 5000
-export const defaultHookTimeout = 5000
-
 export const defaultIncludes = ['**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}']
 export const defaultExcludes = ['**/node_modules/**', '**/dist/**']
 

src/runtime/suite.ts

@@ -1,5 +1,4 @@
 import { nanoid } from 'nanoid/non-secure'
-import { defaultTestTimeout, defaultHookTimeout } from '../constants'
 import type { SuiteHooks, Test, SuiteCollector, TestCollector, RunMode, ComputeMode, TestFactory, TestFunction, File, Suite, Awaitable } from '../types'
 import { context } from './context'
 import { getHooks, setFn, setHooks } from './map'
@@ -12,6 +11,14 @@ function getCurrentSuite() {
   return context.currentSuite || defaultSuite
 }
 
+const getDefaultTestTimeout = () => {
+  return process.__vitest_worker__?.config?.testTimeout ?? 5000
+}
+
+const getDefaultHookTimeout = () => {
+  return process.__vitest_worker__?.config?.hookTimeout ?? 5000
+}
+
 export function createSuiteHooks() {
   return {
     beforeAll: [],
@@ -209,10 +216,10 @@ export const describe = suite
 export const it = test
 
 // hooks
-export const beforeAll = (fn: SuiteHooks['beforeAll'][0], timeout = defaultHookTimeout) => getCurrentSuite().on('beforeAll', withTimeout(fn, timeout))
-export const afterAll = (fn: SuiteHooks['afterAll'][0], timeout = defaultHookTimeout) => getCurrentSuite().on('afterAll', withTimeout(fn, timeout))
-export const beforeEach = (fn: SuiteHooks['beforeEach'][0], timeout = defaultHookTimeout) => getCurrentSuite().on('beforeEach', withTimeout(fn, timeout))
-export const afterEach = (fn: SuiteHooks['afterEach'][0], timeout = defaultHookTimeout) => getCurrentSuite().on('afterEach', withTimeout(fn, timeout))
+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()))
 
 // utils
 export function clearContext() {
@@ -221,7 +228,8 @@ export function clearContext() {
   context.currentSuite = defaultSuite
 }
 
-function withTimeout<T extends((...args: any[]) => any)>(fn: T, timeout = defaultTestTimeout): T {
+function withTimeout<T extends((...args: any[]) => any)>(fn: T, _timeout?: number): T {
+  const timeout = _timeout ?? getDefaultTestTimeout()
   if (timeout <= 0 || timeout === Infinity)
     return fn
 

src/types/options.ts

@@ -103,6 +103,20 @@ export interface UserOptions {
    * @default true
    */
   interpretDefault?: boolean
+
+  /*
+   * Default timeout of a test in milliseconds
+   *
+   * @default 5000
+   */
+  testTimeout?: number
+
+  /*
+   * Default timeout of a hook in milliseconds
+   *
+   * @default 5000
+   */
+  hookTimeout?: number
 }
 
 export interface CliOptions extends UserOptions {

test/core/vitest.config.ts

@@ -2,6 +2,7 @@ import { defineConfig } from 'vite'
 
 export default defineConfig({
   test: {
+    testTimeout: 1000,
     // threads: false,
   },
 })