@vitest/runner 3.1.3 → 3.2.0-beta.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { A as AfterAllListener, b as AfterEachListener, B as BeforeAllListener, d as BeforeEachListener, e as TaskHook, O as OnTestFailedHandler, f as OnTestFinishedHandler, a as Test, g as Custom, S as Suite, h as SuiteHooks, F as File, i as TaskUpdateEvent, T as Task, j as TestAPI, k as SuiteAPI, l as SuiteCollector } from './tasks.d-hsdzc98-.js';
-export { D as DoneCallback, E as ExtendedContext, m as Fixture, n as FixtureFn, o as FixtureOptions, p as Fixtures, H as HookCleanupCallback, q as HookListener, I as InferFixturesTypes, R as RunMode, r as RuntimeContext, s as SequenceHooks, t as SequenceSetupFiles, u as SuiteFactory, v as TaskBase, w as TaskContext, x as TaskCustomOptions, y as TaskEventPack, z as TaskMeta, G as TaskPopulated, J as TaskResult, K as TaskResultPack, L as TaskState, M as TestContext, N as TestFunction, P as TestOptions, U as Use } from './tasks.d-hsdzc98-.js';
+import { A as AfterAllListener, b as AfterEachListener, B as BeforeAllListener, d as BeforeEachListener, e as TaskHook, O as OnTestFailedHandler, f as OnTestFinishedHandler, a as Test, g as Custom, S as Suite, h as SuiteHooks, F as File, i as TaskUpdateEvent, T as Task, j as TestAPI, k as SuiteAPI, l as SuiteCollector } from './tasks.d-hzpC0pGR.js';
+export { D as DoneCallback, E as ExtendedContext, m as Fixture, n as FixtureFn, o as FixtureOptions, p as Fixtures, H as HookCleanupCallback, q as HookListener, I as InferFixturesTypes, R as RunMode, r as RuntimeContext, s as SequenceHooks, t as SequenceSetupFiles, u as SuiteFactory, v as TaskBase, w as TaskContext, x as TaskCustomOptions, y as TaskEventPack, z as TaskMeta, G as TaskPopulated, J as TaskResult, K as TaskResultPack, L as TaskState, M as TestContext, N as TestFunction, P as TestOptions, U as Use } from './tasks.d-hzpC0pGR.js';
 import { Awaitable } from '@vitest/utils';
 import { FileSpecification, VitestRunner } from './types.js';
 export { CancelReason, VitestRunnerConfig, VitestRunnerConstructor, VitestRunnerImportSource } from './types.js';

package/dist/index.js

@@ -15,6 +15,14 @@ class PendingError extends Error {
 		this.taskId = task.id;
 	}
 }
+class TestRunAbortError extends Error {
+	name = "TestRunAbortError";
+	reason;
+	constructor(message, reason) {
+		super(message);
+		this.reason = reason;
+	}
+}
 
 const fnMap = new WeakMap();
 const testFixtureMap = new WeakMap();
@@ -240,6 +248,16 @@ function setCurrentTest(test) {
 function getCurrentTest() {
 	return _test;
 }
+const tests = [];
+function addRunningTest(test) {
+	tests.push(test);
+	return () => {
+		tests.splice(tests.indexOf(test));
+	};
+}
+function getRunningTests() {
+	return tests;
+}
 
 /**
 * Creates a suite of tests, allowing for grouping and hierarchical organization of tests.
@@ -481,7 +499,7 @@ function createSuiteCollector(name, factory = () => {}, mode, each, suiteOptions
 		const stackTraceError = new Error("STACK_TRACE_ERROR");
 		Error.stackTraceLimit = limit;
 		if (handler) {
-			setFn(task, withTimeout(withAwaitAsyncAssertions(withFixtures(handler, context), task), timeout, false, stackTraceError));
+			setFn(task, withTimeout(withAwaitAsyncAssertions(withFixtures(handler, context), task), timeout, false, stackTraceError, (_, error) => abortIfTimeout([context], error)));
 		}
 		if (runner.config.includeTaskLocation) {
 			const error = stackTraceError.stack;
@@ -839,7 +857,7 @@ async function runWithSuite(suite, fn) {
 	await fn();
 	collectorContext.currentSuite = prev;
 }
-function withTimeout(fn, timeout, isHook = false, stackTraceError) {
+function withTimeout(fn, timeout, isHook = false, stackTraceError, onTimeout) {
 	if (timeout <= 0 || timeout === Number.POSITIVE_INFINITY) {
 		return fn;
 	}
@@ -857,7 +875,9 @@ function withTimeout(fn, timeout, isHook = false, stackTraceError) {
 			}, timeout);
 			(_timer$unref = timer.unref) === null || _timer$unref === void 0 ? void 0 : _timer$unref.call(timer);
 			function rejectTimeoutError() {
-				reject_(makeTimeoutError(isHook, timeout, stackTraceError));
+				const error = makeTimeoutError(isHook, timeout, stackTraceError);
+				onTimeout === null || onTimeout === void 0 ? void 0 : onTimeout(args, error);
+				reject_(error);
 			}
 			function resolve(result) {
 				runner._currentTaskStartTime = undefined;
@@ -888,11 +908,27 @@ function withTimeout(fn, timeout, isHook = false, stackTraceError) {
 		});
 	};
 }
+const abortControllers = new WeakMap();
+function abortIfTimeout([context], error) {
+	if (context) {
+		abortContextSignal(context, error);
+	}
+}
+function abortContextSignal(context, error) {
+	const abortController = abortControllers.get(context);
+	abortController === null || abortController === void 0 ? void 0 : abortController.abort(error);
+}
 function createTestContext(test, runner) {
 	var _runner$extendTaskCon;
 	const context = function() {
 		throw new Error("done() callback is deprecated, use promise instead");
 	};
+	let abortController = abortControllers.get(context);
+	if (!abortController) {
+		abortController = new AbortController();
+		abortControllers.set(context, abortController);
+	}
+	context.signal = abortController.signal;
 	context.task = test;
 	context.skip = (condition, note) => {
 		if (condition === false) {
@@ -904,11 +940,11 @@ function createTestContext(test, runner) {
 	};
 	context.onTestFailed = (handler, timeout) => {
 		test.onFailed || (test.onFailed = []);
-		test.onFailed.push(withTimeout(handler, timeout ?? runner.config.hookTimeout, true, new Error("STACK_TRACE_ERROR")));
+		test.onFailed.push(withTimeout(handler, timeout ?? runner.config.hookTimeout, true, new Error("STACK_TRACE_ERROR"), (_, error) => abortController.abort(error)));
 	};
 	context.onTestFinished = (handler, timeout) => {
 		test.onFinished || (test.onFinished = []);
-		test.onFinished.push(withTimeout(handler, timeout ?? runner.config.hookTimeout, true, new Error("STACK_TRACE_ERROR")));
+		test.onFinished.push(withTimeout(handler, timeout ?? runner.config.hookTimeout, true, new Error("STACK_TRACE_ERROR"), (_, error) => abortController.abort(error)));
 	};
 	return ((_runner$extendTaskCon = runner.extendTaskContext) === null || _runner$extendTaskCon === void 0 ? void 0 : _runner$extendTaskCon.call(runner, context)) || context;
 }
@@ -926,11 +962,15 @@ function getDefaultHookTimeout() {
 }
 const CLEANUP_TIMEOUT_KEY = Symbol.for("VITEST_CLEANUP_TIMEOUT");
 const CLEANUP_STACK_TRACE_KEY = Symbol.for("VITEST_CLEANUP_STACK_TRACE");
-function getBeforeHookCleanupCallback(hook, result) {
+function getBeforeHookCleanupCallback(hook, result, context) {
 	if (typeof result === "function") {
 		const timeout = CLEANUP_TIMEOUT_KEY in hook && typeof hook[CLEANUP_TIMEOUT_KEY] === "number" ? hook[CLEANUP_TIMEOUT_KEY] : getDefaultHookTimeout();
 		const stackTraceError = CLEANUP_STACK_TRACE_KEY in hook && hook[CLEANUP_STACK_TRACE_KEY] instanceof Error ? hook[CLEANUP_STACK_TRACE_KEY] : undefined;
-		return withTimeout(result, timeout, true, stackTraceError);
+		return withTimeout(result, timeout, true, stackTraceError, (_, error) => {
+			if (context) {
+				abortContextSignal(context, error);
+			}
+		});
 	}
 }
 /**
@@ -999,7 +1039,7 @@ function afterAll(fn, timeout) {
 function beforeEach(fn, timeout = getDefaultHookTimeout()) {
 	assertTypes(fn, "\"beforeEach\" callback", ["function"]);
 	const stackTraceError = new Error("STACK_TRACE_ERROR");
-	return getCurrentSuite().on("beforeEach", Object.assign(withTimeout(withFixtures(fn), timeout ?? getDefaultHookTimeout(), true, stackTraceError), {
+	return getCurrentSuite().on("beforeEach", Object.assign(withTimeout(withFixtures(fn), timeout ?? getDefaultHookTimeout(), true, stackTraceError, abortIfTimeout), {
 		[CLEANUP_TIMEOUT_KEY]: timeout,
 		[CLEANUP_STACK_TRACE_KEY]: stackTraceError
 	}));
@@ -1023,7 +1063,7 @@ function beforeEach(fn, timeout = getDefaultHookTimeout()) {
 */
 function afterEach(fn, timeout) {
 	assertTypes(fn, "\"afterEach\" callback", ["function"]);
-	return getCurrentSuite().on("afterEach", withTimeout(withFixtures(fn), timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR")));
+	return getCurrentSuite().on("afterEach", withTimeout(withFixtures(fn), timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR"), abortIfTimeout));
 }
 /**
 * Registers a callback function to be executed when a test fails within the current suite.
@@ -1045,7 +1085,7 @@ function afterEach(fn, timeout) {
 */
 const onTestFailed = createTestHook("onTestFailed", (test, handler, timeout) => {
 	test.onFailed || (test.onFailed = []);
-	test.onFailed.push(withTimeout(handler, timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR")));
+	test.onFailed.push(withTimeout(handler, timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR"), abortIfTimeout));
 });
 /**
 * Registers a callback function to be executed when the current test finishes, regardless of the outcome (pass or fail).
@@ -1072,7 +1112,7 @@ const onTestFailed = createTestHook("onTestFailed", (test, handler, timeout) =>
 */
 const onTestFinished = createTestHook("onTestFinished", (test, handler, timeout) => {
 	test.onFinished || (test.onFinished = []);
-	test.onFinished.push(withTimeout(handler, timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR")));
+	test.onFinished.push(withTimeout(handler, timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR"), abortIfTimeout));
 });
 function createTestHook(name, handler) {
 	return (fn, timeout) => {
@@ -1197,12 +1237,13 @@ async function callTestHooks(runner, test, hooks, sequence) {
 	if (!hooks.length) {
 		return;
 	}
+	const context = test.context;
 	const onTestFailed = test.context.onTestFailed;
 	const onTestFinished = test.context.onTestFinished;
-	test.context.onTestFailed = () => {
+	context.onTestFailed = () => {
 		throw new Error(`Cannot call "onTestFailed" inside a test hook.`);
 	};
-	test.context.onTestFinished = () => {
+	context.onTestFinished = () => {
 		throw new Error(`Cannot call "onTestFinished" inside a test hook.`);
 	};
 	if (sequence === "parallel") {
@@ -1220,8 +1261,8 @@ async function callTestHooks(runner, test, hooks, sequence) {
 			}
 		}
 	}
-	test.context.onTestFailed = onTestFailed;
-	test.context.onTestFinished = onTestFinished;
+	context.onTestFailed = onTestFailed;
+	context.onTestFinished = onTestFinished;
 }
 async function callSuiteHook(suite, currentTask, name, runner, args) {
 	const sequence = runner.config.sequence.hooks;
@@ -1235,7 +1276,7 @@ async function callSuiteHook(suite, currentTask, name, runner, args) {
 		updateSuiteHookState(currentTask, name, "run", runner);
 	}
 	async function runHook(hook) {
-		return getBeforeHookCleanupCallback(hook, await hook(...args));
+		return getBeforeHookCleanupCallback(hook, await hook(...args), name === "beforeEach" ? args[0] : undefined);
 	}
 	if (sequence === "parallel") {
 		callbacks.push(...await Promise.all(hooks.map((hook) => runHook(hook))));
@@ -1334,6 +1375,7 @@ async function runTest(test, runner) {
 		retryCount: 0
 	};
 	updateTask("test-prepare", test, runner);
+	const cleanupRunningTest = addRunningTest(test);
 	setCurrentTest(test);
 	const suite = test.suite || test.file;
 	const repeats = test.repeats ?? 0;
@@ -1403,6 +1445,7 @@ async function runTest(test, runner) {
 				};
 				updateTask("test-finished", test, runner);
 				setCurrentTest(undefined);
+				cleanupRunningTest();
 				return;
 			}
 			if (test.result.state === "pass") {
@@ -1425,6 +1468,7 @@ async function runTest(test, runner) {
 			test.result.errors = undefined;
 		}
 	}
+	cleanupRunningTest();
 	setCurrentTest(undefined);
 	test.result.duration = now() - start;
 	await ((_runner$onAfterRunTas = runner.onAfterRunTask) === null || _runner$onAfterRunTas === void 0 ? void 0 : _runner$onAfterRunTas.call(runner, test));
@@ -1562,16 +1606,27 @@ async function runFiles(files, runner) {
 	}
 }
 async function startTests(specs, runner) {
-	var _runner$onBeforeColle, _runner$onCollected, _runner$onBeforeRunFi, _runner$onAfterRunFil;
-	const paths = specs.map((f) => typeof f === "string" ? f : f.filepath);
-	await ((_runner$onBeforeColle = runner.onBeforeCollect) === null || _runner$onBeforeColle === void 0 ? void 0 : _runner$onBeforeColle.call(runner, paths));
-	const files = await collectTests(specs, runner);
-	await ((_runner$onCollected = runner.onCollected) === null || _runner$onCollected === void 0 ? void 0 : _runner$onCollected.call(runner, files));
-	await ((_runner$onBeforeRunFi = runner.onBeforeRunFiles) === null || _runner$onBeforeRunFi === void 0 ? void 0 : _runner$onBeforeRunFi.call(runner, files));
-	await runFiles(files, runner);
-	await ((_runner$onAfterRunFil = runner.onAfterRunFiles) === null || _runner$onAfterRunFil === void 0 ? void 0 : _runner$onAfterRunFil.call(runner, files));
-	await finishSendTasksUpdate(runner);
-	return files;
+	var _runner$cancel;
+	const cancel = (_runner$cancel = runner.cancel) === null || _runner$cancel === void 0 ? void 0 : _runner$cancel.bind(runner);
+	runner.cancel = (reason) => {
+		const error = new TestRunAbortError("The test run was aborted by the user.", reason);
+		getRunningTests().forEach((test) => abortContextSignal(test.context, error));
+		return cancel === null || cancel === void 0 ? void 0 : cancel(reason);
+	};
+	try {
+		var _runner$onBeforeColle, _runner$onCollected, _runner$onBeforeRunFi, _runner$onAfterRunFil;
+		const paths = specs.map((f) => typeof f === "string" ? f : f.filepath);
+		await ((_runner$onBeforeColle = runner.onBeforeCollect) === null || _runner$onBeforeColle === void 0 ? void 0 : _runner$onBeforeColle.call(runner, paths));
+		const files = await collectTests(specs, runner);
+		await ((_runner$onCollected = runner.onCollected) === null || _runner$onCollected === void 0 ? void 0 : _runner$onCollected.call(runner, files));
+		await ((_runner$onBeforeRunFi = runner.onBeforeRunFiles) === null || _runner$onBeforeRunFi === void 0 ? void 0 : _runner$onBeforeRunFi.call(runner, files));
+		await runFiles(files, runner);
+		await ((_runner$onAfterRunFil = runner.onAfterRunFiles) === null || _runner$onAfterRunFil === void 0 ? void 0 : _runner$onAfterRunFil.call(runner, files));
+		await finishSendTasksUpdate(runner);
+		return files;
+	} finally {
+		runner.cancel = cancel;
+	}
 }
 async function publicCollect(specs, runner) {
 	var _runner$onBeforeColle2, _runner$onCollected2;

package/dist/{tasks.d-hsdzc98-.d.ts → tasks.d-hzpC0pGR.d.ts}

@@ -454,20 +454,25 @@ interface TestContext {
 	/**
 	* Metadata of the current test
 	*/
-	task: Readonly<Test<TestContext>>;
+	readonly task: Readonly<Test>;
+	/**
+	* An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that will be aborted if the test times out or
+	* the test run was cancelled.
+	*/
+	readonly signal: AbortSignal;
 	/**
 	* Extract hooks on test failed
 	*/
-	onTestFailed: (fn: OnTestFailedHandler, timeout?: number) => void;
+	readonly onTestFailed: (fn: OnTestFailedHandler, timeout?: number) => void;
 	/**
 	* Extract hooks on test failed
 	*/
-	onTestFinished: (fn: OnTestFinishedHandler, timeout?: number) => void;
+	readonly onTestFinished: (fn: OnTestFinishedHandler, timeout?: number) => void;
 	/**
 	* Mark tests as skipped. All execution after this call will be skipped.
 	* This function throws an error, so make sure you are not catching it accidentally.
 	*/
-	skip: {
+	readonly skip: {
 		(note?: string): never
 		(condition: boolean, note?: string): void
 	};

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 import { DiffOptions } from '@vitest/utils/diff';
-import { F as File, T as Task, a as Test, S as Suite, K as TaskResultPack, y as TaskEventPack, M as TestContext, s as SequenceHooks, t as SequenceSetupFiles } from './tasks.d-hsdzc98-.js';
-export { A as AfterAllListener, b as AfterEachListener, B as BeforeAllListener, d as BeforeEachListener, g as Custom, j as CustomAPI, D as DoneCallback, E as ExtendedContext, m as Fixture, n as FixtureFn, o as FixtureOptions, p as Fixtures, H as HookCleanupCallback, q as HookListener, I as InferFixturesTypes, O as OnTestFailedHandler, f as OnTestFinishedHandler, R as RunMode, r as RuntimeContext, k as SuiteAPI, l as SuiteCollector, u as SuiteFactory, h as SuiteHooks, v as TaskBase, w as TaskContext, x as TaskCustomOptions, e as TaskHook, z as TaskMeta, G as TaskPopulated, J as TaskResult, L as TaskState, i as TaskUpdateEvent, j as TestAPI, N as TestFunction, P as TestOptions, U as Use } from './tasks.d-hsdzc98-.js';
+import { F as File, T as Task, a as Test, S as Suite, K as TaskResultPack, y as TaskEventPack, M as TestContext, s as SequenceHooks, t as SequenceSetupFiles } from './tasks.d-hzpC0pGR.js';
+export { A as AfterAllListener, b as AfterEachListener, B as BeforeAllListener, d as BeforeEachListener, g as Custom, j as CustomAPI, D as DoneCallback, E as ExtendedContext, m as Fixture, n as FixtureFn, o as FixtureOptions, p as Fixtures, H as HookCleanupCallback, q as HookListener, I as InferFixturesTypes, O as OnTestFailedHandler, f as OnTestFinishedHandler, R as RunMode, r as RuntimeContext, k as SuiteAPI, l as SuiteCollector, u as SuiteFactory, h as SuiteHooks, v as TaskBase, w as TaskContext, x as TaskCustomOptions, e as TaskHook, z as TaskMeta, G as TaskPopulated, J as TaskResult, L as TaskState, i as TaskUpdateEvent, j as TestAPI, N as TestFunction, P as TestOptions, U as Use } from './tasks.d-hzpC0pGR.js';
 import '@vitest/utils';
 
 /**
@@ -60,7 +60,7 @@ interface VitestRunner {
 	* Runner should listen for this method and mark tests and suites as skipped in
 	* "onBeforeRunSuite" and "onBeforeRunTask" when called.
 	*/
-	onCancel?: (reason: CancelReason) => unknown;
+	cancel?: (reason: CancelReason) => unknown;
 	/**
 	* Called before running a single test. Doesn't have "result" yet.
 	*/

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
-import { S as Suite, F as File, T as Task, a as Test } from './tasks.d-hsdzc98-.js';
-export { C as ChainableFunction, c as createChainable } from './tasks.d-hsdzc98-.js';
+import { S as Suite, F as File, T as Task, a as Test } from './tasks.d-hzpC0pGR.js';
+export { C as ChainableFunction, c as createChainable } from './tasks.d-hzpC0pGR.js';
 import { Arrayable } from '@vitest/utils';
 
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/runner",
   "type": "module",
-  "version": "3.1.3",
+  "version": "3.2.0-beta.1",
   "description": "Vitest test runner",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -39,7 +39,7 @@
   ],
   "dependencies": {
     "pathe": "^2.0.3",
-    "@vitest/utils": "3.1.3"
+    "@vitest/utils": "3.2.0-beta.1"
   },
   "scripts": {
     "build": "rimraf dist && rollup -c",