@vitest/runner 4.1.0-beta.5 → 4.1.0

package/README.md

@@ -1,5 +1,7 @@
 # @vitest/runner
 
-Vitest mechanism to collect and run tasks.
+[![NPM version](https://img.shields.io/npm/v/@vitest/runner?color=a1b858&label=)](https://npmx.dev/package/@vitest/runner)
 
-[GitHub](https://github.com/vitest-dev/vitest) | [Documentation](https://vitest.dev/advanced/runner)
+Vitest mechanism to collect and run tests.
+
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/runner) | [Documentation](https://vitest.dev/api/advanced/runner)

package/dist/index.js

@@ -1,5 +1,5 @@
 import { processError } from '@vitest/utils/error';
-import { isObject, filterOutComments, createDefer, assertTypes, toArray, isNegativeNaN, unique, objectAttr, shuffle } from '@vitest/utils/helpers';
+import { isObject, filterOutComments, ordinal, createDefer, assertTypes, toArray, isNegativeNaN, unique, objectAttr, shuffle } from '@vitest/utils/helpers';
 import { getSafeTimers } from '@vitest/utils/timers';
 import { format, formatRegExp, objDisplay } from '@vitest/utils/display';
 import { w as getChainableContext, a as createChainable, v as validateTags, e as createTaskName, x as createNoTagsError, f as findTestFileStackTrace, d as createTagsFilter, b as createFileTask, c as calculateSuiteHash, u as someTasksAreOnly, q as interpretTaskModes, s as limitConcurrency, t as partitionSuiteChildren, p as hasTests, o as hasFailed } from './chunk-tasks.js';
@@ -27,6 +27,12 @@ class TestRunAbortError extends Error {
 class FixtureDependencyError extends Error {
 	name = "FixtureDependencyError";
 }
+class FixtureAccessError extends Error {
+	name = "FixtureAccessError";
+}
+class FixtureParseError extends Error {
+	name = "FixtureParseError";
+}
 class AroundHookSetupError extends Error {
 	name = "AroundHookSetupError";
 }
@@ -272,7 +278,7 @@ async function callFixtureCleanupFrom(context, fromIndex) {
 const contextHasFixturesCache = new WeakMap();
 function withFixtures(fn, options) {
 	const collector = getCurrentSuite();
-	const suite = collector.suite || collector.file;
+	const suite = options?.suite || collector.suite || collector.file;
 	return async (hookContext) => {
 		const context = hookContext || options?.context;
 		if (!context) {
@@ -442,25 +448,35 @@ function resolveDeps(usedFixtures, registrations, depSet = new Set(), pendingFix
 	});
 	return pendingFixtures;
 }
-function validateSuiteHook(fn, hook, error) {
-	const usedProps = getUsedProps(fn);
+function validateSuiteHook(fn, hook, suiteError) {
+	const usedProps = getUsedProps(fn, {
+		sourceError: suiteError,
+		suiteHook: hook
+	});
 	if (usedProps.size) {
-		console.warn(`The ${hook} hook uses fixtures "${[...usedProps].join("\", \"")}", but has no access to context. Did you forget to call it as "test.${hook}()" instead of "${hook}()"? This will throw an error in a future major. See https://vitest.dev/guide/test-context#suite-level-hooks`);
-		if (error) {
-			const processor = globalThis.__vitest_worker__?.onFilterStackTrace || ((s) => s || "");
-			const stack = processor(error.stack || "");
-			console.warn(stack);
+		const error = new FixtureAccessError(`The ${hook} hook uses fixtures "${[...usedProps].join("\", \"")}", but has no access to context. ` + `Did you forget to call it as "test.${hook}()" instead of "${hook}()"?\n` + `If you used internal "suite" task as the first argument previously, access it in the second argument instead. ` + `See https://vitest.dev/guide/test-context#suite-level-hooks`);
+		if (suiteError) {
+			error.stack = suiteError.stack?.replace(suiteError.message, error.message);
 		}
+		throw error;
 	}
 }
 const kPropsSymbol = Symbol("$vitest:fixture-props");
+const kPropNamesSymbol = Symbol("$vitest:fixture-prop-names");
 function configureProps(fn, options) {
 	Object.defineProperty(fn, kPropsSymbol, {
 		value: options,
 		enumerable: false
 	});
 }
-function getUsedProps(fn) {
+function memoProps(fn, props) {
+	fn[kPropNamesSymbol] = props;
+	return props;
+}
+function getUsedProps(fn, { sourceError, suiteHook } = {}) {
+	if (kPropNamesSymbol in fn) {
+		return fn[kPropNamesSymbol];
+	}
 	const { index: fixturesIndex = 0, original: implementation = fn } = kPropsSymbol in fn ? fn[kPropsSymbol] : {};
 	let fnString = filterOutComments(implementation.toString());
 	// match lowered async function and strip it off
@@ -473,18 +489,23 @@ function getUsedProps(fn) {
 	}
 	const match = fnString.match(/[^(]*\(([^)]*)/);
 	if (!match) {
-		return new Set();
+		return memoProps(fn, new Set());
 	}
 	const args = splitByComma(match[1]);
 	if (!args.length) {
-		return new Set();
+		return memoProps(fn, new Set());
 	}
 	const fixturesArgument = args[fixturesIndex];
 	if (!fixturesArgument) {
-		return new Set();
+		return memoProps(fn, new Set());
 	}
 	if (!(fixturesArgument[0] === "{" && fixturesArgument.endsWith("}"))) {
-		throw new Error(`The first argument inside a fixture must use object destructuring pattern, e.g. ({ test } => {}). Instead, received "${fixturesArgument}".`);
+		const ordinalArgument = ordinal(fixturesIndex + 1);
+		const error = new FixtureParseError(`The ${ordinalArgument} argument inside a fixture must use object destructuring pattern, e.g. ({ task } => {}). ` + `Instead, received "${fixturesArgument}".` + `${suiteHook ? ` If you used internal "suite" task as the ${ordinalArgument} argument previously, access it in the ${ordinal(fixturesIndex + 2)} argument instead.` : ""}`);
+		if (sourceError) {
+			error.stack = sourceError.stack?.replace(sourceError.message, error.message);
+		}
+		throw error;
 	}
 	const _first = fixturesArgument.slice(1, -1).replace(/\s/g, "");
 	const props = splitByComma(_first).map((prop) => {
@@ -492,9 +513,13 @@ function getUsedProps(fn) {
 	});
 	const last = props.at(-1);
 	if (last && last.startsWith("...")) {
-		throw new Error(`Rest parameters are not supported in fixtures, received "${last}".`);
+		const error = new FixtureParseError(`Rest parameters are not supported in fixtures, received "${last}".`);
+		if (sourceError) {
+			error.stack = sourceError.stack?.replace(sourceError.message, error.message);
+		}
+		throw error;
 	}
-	return new Set(props);
+	return memoProps(fn, new Set(props));
 }
 function splitByComma(s) {
 	const result = [];
@@ -625,7 +650,11 @@ 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, abortIfTimeout), {
+	const wrapper = (context, suite) => {
+		const fixtureResolver = withFixtures(fn, { suite });
+		return fixtureResolver(context);
+	};
+	return getCurrentSuite().on("beforeEach", Object.assign(withTimeout(wrapper, timeout ?? getDefaultHookTimeout(), true, stackTraceError, abortIfTimeout), {
 		[CLEANUP_TIMEOUT_KEY]: timeout,
 		[CLEANUP_STACK_TRACE_KEY]: stackTraceError
 	}));
@@ -649,7 +678,11 @@ 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"), abortIfTimeout));
+	const wrapper = (context, suite) => {
+		const fixtureResolver = withFixtures(fn, { suite });
+		return fixtureResolver(context);
+	};
+	return getCurrentSuite().on("afterEach", withTimeout(wrapper, timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR"), abortIfTimeout));
 }
 /**
 * Registers a callback function to be executed when a test fails within the current suite.
@@ -773,7 +806,7 @@ function aroundEach(fn, timeout) {
 			index: 1,
 			original: fn
 		});
-		const fixtureResolver = withFixtures(innerFn);
+		const fixtureResolver = withFixtures(innerFn, { suite });
 		return fixtureResolver(context);
 	};
 	return getCurrentSuite().on("aroundEach", Object.assign(wrapper, {
@@ -1566,7 +1599,7 @@ function formatTemplateString(cases, args) {
 	return res;
 }
 
-const now$2 = Date.now;
+const now$2 = globalThis.performance ? globalThis.performance.now.bind(globalThis.performance) : Date.now;
 const collectorContext = {
 	tasks: [],
 	currentSuite: null

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@vitest/runner",
   "type": "module",
-  "version": "4.1.0-beta.5",
+  "version": "4.1.0",
   "description": "Vitest test runner",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/runner#readme",
+  "homepage": "https://vitest.dev/api/advanced/runner",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
@@ -14,6 +14,11 @@
   "bugs": {
     "url": "https://github.com/vitest-dev/vitest/issues"
   },
+  "keywords": [
+    "vitest",
+    "test",
+    "test-runner"
+  ],
   "sideEffects": true,
   "exports": {
     ".": {
@@ -39,7 +44,7 @@
   ],
   "dependencies": {
     "pathe": "^2.0.3",
-    "@vitest/utils": "4.1.0-beta.5"
+    "@vitest/utils": "4.1.0"
   },
   "scripts": {
     "build": "premove dist && rollup -c",