vitest 3.2.0-beta.2 → 3.2.0-beta.3

package/dist/chunks/{index.CV36oG_L.js → index.Bter3jj9.js}

@@ -5,7 +5,7 @@ import { parseStacktrace, parseErrorStacktrace } from '@vitest/utils/source-map'
 import { isAbsolute, relative, dirname, basename, resolve, normalize } from 'pathe';
 import c from 'tinyrainbow';
 import { i as isTTY } from './env.Dq0hM4Xv.js';
-import { h as hasFailedSnapshot, g as getOutputFile, T as TypeCheckError } from './typechecker.DnTrplSJ.js';
+import { h as hasFailedSnapshot, g as getOutputFile, T as TypeCheckError } from './typechecker.BgzF-6iO.js';
 import { stripVTControlCharacters } from 'node:util';
 import { existsSync, readFileSync, promises } from 'node:fs';
 import { mkdir, writeFile, readdir, stat, readFile } from 'node:fs/promises';
@@ -283,6 +283,8 @@ class BaseReporter {
 		let testsCount = 0;
 		let failedCount = 0;
 		let skippedCount = 0;
+		// delaying logs to calculate the test stats first
+		// which minimizes the amount of for loops
 		const logs = [];
 		const originalLog = this.log.bind(this);
 		this.log = (msg) => logs.push(msg);
@@ -290,6 +292,7 @@ class BaseReporter {
 			for (const child of children) {
 				if (child.type === "suite") {
 					const suiteState = child.state();
+					// Skipped suites are hidden when --hideSkippedTests, print otherwise
 					if (!this.ctx.config.hideSkippedTests || suiteState !== "skipped") {
 						this.printTestSuite(child);
 					}
@@ -303,6 +306,7 @@ class BaseReporter {
 						skippedCount++;
 					}
 					if (this.ctx.config.hideSkippedTests && suiteState === "skipped") {
+						// Skipped suites are hidden when --hideSkippedTests
 						continue;
 					}
 					this.printTestCase(moduleState, child);
@@ -334,6 +338,7 @@ class BaseReporter {
 		}
 		if (testResult.state === "failed") {
 			this.log(c.red(` ${padding}${taskFail} ${this.getTestName(test.task, c.dim(" > "))}`) + suffix);
+			// print short errors, full errors will be at the end in summary
 			testResult.errors.forEach((error) => {
 				const message = this.formatShortError(error);
 				if (message) {
@@ -370,7 +375,9 @@ class BaseReporter {
 		}
 		return ` ${title} ${testModule.task.name} ${suffix}`;
 	}
-	printTestSuite(_suite) {}
+	printTestSuite(_suite) {
+		// Suite name is included in getTestName by default
+	}
 	getTestName(test, separator) {
 		return getTestName(test, separator);
 	}
@@ -407,6 +414,7 @@ class BaseReporter {
 	onWatcherRerun(files, trigger) {
 		this.watchFilters = files;
 		this.failedUnwatchedFiles = this.ctx.state.getTestModules().filter((testModule) => !files.includes(testModule.task.filepath) && testModule.state() === "failed");
+		// Update re-run count for each file
 		files.forEach((filepath) => {
 			let reruns = this._filesInWatchMode.get(filepath) ?? 0;
 			this._filesInWatchMode.set(filepath, ++reruns);
@@ -449,6 +457,7 @@ class BaseReporter {
 		}
 		write(c.gray(log.type + c.dim(` | ${headerText}\n`)) + log.content);
 		if (log.origin) {
+			// browser logs don't have an extra end of line at the end like Node.js does
 			if (log.browser) {
 				write("\n");
 			}
@@ -520,6 +529,7 @@ class BaseReporter {
 			this.log(padSummaryTitle("Duration"), formatTime(collectTime + testsTime + setupTime));
 		} else {
 			const blobs = this.ctx.state.blobs;
+			// Execution time is either sum of all runs of `--merge-reports` or the current run's time
 			const executionTime = blobs?.executionTimes ? sum(blobs.executionTimes, (time) => time) : this.end - this.start;
 			const environmentTime = sum(files, (file) => file.environmentLoad);
 			const prepareTime = sum(files, (file) => file.prepareDuration);
@@ -585,6 +595,7 @@ class BaseReporter {
 	printTaskErrors(tasks, errorDivider) {
 		const errorsQueue = [];
 		for (const task of tasks) {
+			// Merge identical errors
 			task.result?.errors?.forEach((error) => {
 				let previous;
 				if (error?.stackStr) {
@@ -642,6 +653,7 @@ class BasicReporter extends BaseReporter {
 		ctx.logger.deprecate(`'basic' reporter is deprecated and will be removed in Vitest v3.\n` + `Remove 'basic' from 'reporters' option. To match 'basic' reporter 100%, use configuration:\n${JSON.stringify({ test: { reporters: [["default", { summary: false }]] } }, null, 2)}`);
 	}
 	reportSummary(files, errors) {
+		// non-tty mode doesn't add a new line
 		this.ctx.logger.log();
 		return super.reportSummary(files, errors);
 	}
@@ -809,6 +821,7 @@ async function writeBlob(content, filename) {
 	await writeFile(filename, report, "utf-8");
 }
 async function readBlobs(currentVersion, blobsDirectory, projectsArray) {
+	// using process.cwd() because --merge-reports can only be used in CLI
 	const resolvedDir = resolve(process.cwd(), blobsDirectory);
 	const blobsFiles = await readdir(resolvedDir);
 	const promises = blobsFiles.map(async (filename) => {
@@ -843,6 +856,7 @@ async function readBlobs(currentVersion, blobsDirectory, projectsArray) {
 	if (!versions.has(currentVersion)) {
 		throw new Error(`the blobs in "${blobsDirectory}" were generated by a different version of Vitest. Expected v${currentVersion}, but received v${blobs[0].version}`);
 	}
+	// fake module graph - it is used to check if module is imported, but we don't use values inside
 	const projects = Object.fromEntries(projectsArray.map((p) => [p.name, p]));
 	blobs.forEach((blob) => {
 		blob.moduleKeys.forEach(([projectName, moduleIds]) => {
@@ -903,6 +917,7 @@ class WindowRenderer {
 			error: options.logger.errorStream.write.bind(options.logger.errorStream)
 		};
 		this.cleanups.push(this.interceptStream(process.stdout, "output"), this.interceptStream(process.stderr, "error"));
+		// Write buffered content on unexpected exits, e.g. direct `process.exit()` calls
 		this.options.logger.onTerminalCleanup(() => {
 			this.flushBuffer();
 			this.stop();
@@ -943,6 +958,7 @@ class WindowRenderer {
 			return this.render();
 		}
 		let current;
+		// Concatenate same types into a single render
 		for (const next of this.buffer.splice(0)) {
 			if (!current) {
 				current = next;
@@ -994,6 +1010,7 @@ class WindowRenderer {
 	}
 	interceptStream(stream, type) {
 		const original = stream.write;
+		// @ts-expect-error -- not sure how 2 overloads should be typed
 		stream.write = (chunk, _, callback) => {
 			if (chunk) {
 				if (this.finished) {
@@ -1077,6 +1094,7 @@ class SummaryReporter {
 		clearInterval(this.durationInterval);
 	}
 	onTestModuleQueued(module) {
+		// When new test module starts, take the place of previously finished test module, if any
 		if (this.finishedModules.size) {
 			const finished = this.finishedModules.keys().next().value;
 			this.removeTestModule(finished);
@@ -1123,6 +1141,7 @@ class SummaryReporter {
 		stats.hook.visible = false;
 	}
 	onTestCaseReady(test) {
+		// Track slow running tests only on verbose mode
 		if (!this.options.verbose) {
 			return;
 		}
@@ -1176,16 +1195,22 @@ class SummaryReporter {
 			this.modules.skipped++;
 		}
 		const left = this.modules.total - this.modules.completed;
+		// Keep finished tests visible in summary for a while if there are more tests left.
+		// When a new test starts in onTestModuleQueued it will take this ones place.
+		// This reduces flickering by making summary more stable.
 		if (left > this.maxParallelTests) {
 			this.finishedModules.set(module.id, setTimeout(() => {
 				this.removeTestModule(module.id);
 			}, FINISHED_TEST_CLEANUP_TIME_MS).unref());
 		} else {
+			// Run is about to end as there are less tests left than whole run had parallel at max.
+			// Remove finished test immediately.
 			this.removeTestModule(module.id);
 		}
 		this.renderer.schedule();
 	}
 	getHookStats({ entity }) {
+		// Track slow running hooks only on verbose mode
 		if (!this.options.verbose) {
 			return;
 		}
@@ -1300,6 +1325,14 @@ class DefaultReporter extends BaseReporter {
 		}
 	}
 	onTestRunStart(specifications) {
+		if (this.isTTY) {
+			if (this.renderSucceed === undefined) {
+				this.renderSucceed = !!this.renderSucceed;
+			}
+			if (this.renderSucceed !== true) {
+				this.renderSucceed = specifications.length <= 1;
+			}
+		}
 		this.summary?.onTestRunStart(specifications);
 	}
 	onTestModuleQueued(file) {
@@ -1329,16 +1362,6 @@ class DefaultReporter extends BaseReporter {
 		super.onInit(ctx);
 		this.summary?.onInit(ctx, { verbose: this.verbose });
 	}
-	onPathsCollected(paths = []) {
-		if (this.isTTY) {
-			if (this.renderSucceed === undefined) {
-				this.renderSucceed = !!this.renderSucceed;
-			}
-			if (this.renderSucceed !== true) {
-				this.renderSucceed = paths.length <= 1;
-			}
-		}
-	}
 	onTestRunEnd() {
 		this.summary?.onTestRunEnd();
 	}
@@ -1379,6 +1402,7 @@ class DotReporter extends BaseReporter {
 	}
 	onTestModuleCollected(module) {
 		for (const test of module.children.allTests()) {
+			// Dot reporter marks pending tests as running
 			this.onTestCaseReady(test);
 		}
 	}
@@ -1408,6 +1432,7 @@ class DotReporter extends BaseReporter {
 		if (finishedTests.length < columns) {
 			return;
 		}
+		// Remove finished tests from state and render them in static output
 		const states = [];
 		let count = 0;
 		for (const [id, state] of finishedTests) {
@@ -1424,6 +1449,7 @@ class DotReporter extends BaseReporter {
 		return [formatTests(Array.from(this.tests.values())), ""];
 	}
 }
+// These are compared with reference equality in formatTests
 const pass = {
 	char: "·",
 	color: c.green
@@ -1463,6 +1489,7 @@ function formatTests(states) {
 			continue;
 		}
 		output += currentIcon.color(currentIcon.char.repeat(count));
+		// Start tracking new group
 		count = 1;
 		currentIcon = icon;
 	}
@@ -1470,6 +1497,7 @@ function formatTests(states) {
 	return output;
 }
 
+// use Logger with custom Console to capture entire error printing
 function capturePrintError(error, ctx, options) {
 	let output = "";
 	const writable = new Writable({ write(chunk, _encoding, callback) {
@@ -1499,9 +1527,12 @@ function printError(error, ctx, logger, options) {
 		screenshotPaths: options.screenshotPaths,
 		printProperties: options.verbose,
 		parseErrorStacktrace(error) {
+			// browser stack trace needs to be processed differently,
+			// so there is a separate method for that
 			if (options.task?.file.pool === "browser" && project.browser) {
 				return project.browser.parseErrorStacktrace(error, { ignoreStackEntries: options.fullStack ? [] : undefined });
 			}
+			// node.js stack trace already has correct source map locations
 			return parseErrorStacktrace(error, {
 				frameFilter: project.config.onStackTrace,
 				ignoreStackEntries: options.fullStack ? [] : undefined
@@ -1526,6 +1557,7 @@ function printErrorInner(error, project, options) {
 			stack: error.stack
 		};
 	}
+	// Error may have occurred even before the configuration was resolved
 	if (!project) {
 		printErrorMessage(e, logger);
 		return;
@@ -1554,6 +1586,7 @@ function printErrorInner(error, project, options) {
 		logger.error(`${e.codeFrame}\n`);
 	}
 	if ("__vitest_rollup_error__" in e) {
+		// https://github.com/vitejs/vite/blob/95020ab49e12d143262859e095025cf02423c1d9/packages/vite/src/node/server/middlewares/error.ts#L25-L36
 		const err = e.__vitest_rollup_error__;
 		logger.error([
 			err.plugin && `  Plugin: ${c.magenta(err.plugin)}`,
@@ -1561,9 +1594,11 @@ function printErrorInner(error, project, options) {
 			err.frame && c.yellow(err.frame.split(/\r?\n/g).map((l) => ` `.repeat(2) + l).join(`\n`))
 		].filter(Boolean).join("\n"));
 	}
+	// E.g. AssertionError from assert does not set showDiff but has both actual and expected properties
 	if (e.diff) {
 		logger.error(`\n${e.diff}\n`);
 	}
+	// if the error provide the frame
 	if (e.frame) {
 		logger.error(c.yellow(e.frame));
 	} else {
@@ -1578,6 +1613,7 @@ function printErrorInner(error, project, options) {
 	const testPath = e.VITEST_TEST_PATH;
 	const testName = e.VITEST_TEST_NAME;
 	const afterEnvTeardown = e.VITEST_AFTER_ENV_TEARDOWN;
+	// testName has testPath inside
 	if (testPath) {
 		logger.error(c.red(`This error originated in "${c.bold(relative(project.config.root, testPath))}" test file. It doesn't mean the error was thrown inside the file itself, but while it was running.`));
 	}
@@ -1603,7 +1639,6 @@ function printErrorType(type, ctx) {
 }
 const skipErrorProperties = new Set([
 	"nameStr",
-	"stack",
 	"cause",
 	"stacks",
 	"stackStr",
@@ -1634,7 +1669,10 @@ function getErrorProperties(e) {
 		return errorObject;
 	}
 	for (const key of Object.getOwnPropertyNames(e)) {
-		if (!skipErrorProperties.has(key)) {
+		// print the original stack if it was ever changed manually by the user
+		if (key === "stack" && e[key] != null && typeof e[key] !== "string") {
+			errorObject[key] = e[key];
+		} else if (key !== "stack" && !skipErrorProperties.has(key)) {
 			errorObject[key] = e[key];
 		}
 	}
@@ -1681,6 +1719,7 @@ function printErrorMessage(error, logger) {
 		return;
 	}
 	if (error.message.length > 5e3) {
+		// Protect against infinite stack trace in tinyrainbow
 		logger.error(`${c.red(c.bold(errorName))}: ${error.message}`);
 	} else {
 		logger.error(c.red(`${c.bold(errorName)}: ${error.message}`));
@@ -1703,6 +1742,7 @@ function printStack(logger, project, stack, highlight, errorProperties, onStack)
 	}
 }
 function hasProperties(obj) {
+	// eslint-disable-next-line no-unreachable-loop
 	for (const _key in obj) {
 		return true;
 	}
@@ -1724,11 +1764,13 @@ function generateCodeFrame(source, indent = 0, loc, range = 2) {
 					continue;
 				}
 				const lineLength = lines[j].length;
+				// too long, maybe it's a minified file, skip for codeframe
 				if (stripVTControlCharacters(lines[j]).length > 200) {
 					return "";
 				}
 				res.push(lineNo(j + 1) + truncateString(lines[j].replace(/\t/g, " "), columns - 5 - indent));
 				if (j === i) {
+					// push underline
 					const pad = start - (count - lineLength) + (nl - 1);
 					const length = Math.max(1, end > count ? lineLength - pad : end - start);
 					res.push(lineNo() + " ".repeat(pad) + c.red("^".repeat(length)));
@@ -1754,10 +1796,15 @@ function lineNo(no = "") {
 
 class GithubActionsReporter {
 	ctx = undefined;
+	options;
+	constructor(options = {}) {
+		this.options = options;
+	}
 	onInit(ctx) {
 		this.ctx = ctx;
 	}
 	onFinished(files = [], errors = []) {
+		// collect all errors and associate them with projects
 		const projectErrors = new Array();
 		for (const error of errors) {
 			projectErrors.push({
@@ -1784,6 +1831,8 @@ class GithubActionsReporter {
 				}
 			}
 		}
+		const onWritePath = this.options.onWritePath ?? defaultOnWritePath;
+		// format errors via `printError`
 		for (const { project, title, error, file } of projectErrors) {
 			const result = capturePrintError(error, this.ctx, {
 				project,
@@ -1796,7 +1845,7 @@ class GithubActionsReporter {
 			const formatted = formatMessage({
 				command: "error",
 				properties: {
-					file: stack.file,
+					file: onWritePath(stack.file),
 					title,
 					line: String(stack.line),
 					column: String(stack.column)
@@ -1807,6 +1856,12 @@ class GithubActionsReporter {
 		}
 	}
 }
+function defaultOnWritePath(path) {
+	return path;
+}
+// workflow command formatting based on
+// https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message
+// https://github.com/actions/toolkit/blob/f1d9b4b985e6f0f728b4b766db73498403fd5ca3/packages/core/src/command.ts#L80-L85
 function formatMessage({ command, properties, message }) {
 	let result = `::${command}`;
 	Object.entries(properties).forEach(([k, v], i) => {
@@ -1976,16 +2031,18 @@ function flattenTasks$1(task, baseName = "") {
 		}];
 	}
 }
+// https://gist.github.com/john-doherty/b9195065884cdbfd2017a4756e6409cc
 function removeInvalidXMLCharacters(value, removeDiscouragedChars) {
 	let regex = /([\0-\x08\v\f\x0E-\x1F\uFFFD\uFFFE\uFFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?:[^\uD800-\uDBFF]|^)[\uDC00-\uDFFF])/g;
 	value = String(value || "").replace(regex, "");
 	{
+		// remove everything discouraged by XML 1.0 specifications
 		regex = new RegExp(
 			/* eslint-disable regexp/prefer-character-class, regexp/no-obscure-range, regexp/no-useless-non-capturing-group */
 			"([\\x7F-\\x84]|[\\x86-\\x9F]|[\\uFDD0-\\uFDEF]|\\uD83F[\\uDFFE\\uDFFF]|(?:\\uD87F[\\uDF" + "FE\\uDFFF])|\\uD8BF[\\uDFFE\\uDFFF]|\\uD8FF[\\uDFFE\\uDFFF]|(?:\\uD93F[\\uDFFE\\uD" + "FFF])|\\uD97F[\\uDFFE\\uDFFF]|\\uD9BF[\\uDFFE\\uDFFF]|\\uD9FF[\\uDFFE\\uDFFF]" + "|\\uDA3F[\\uDFFE\\uDFFF]|\\uDA7F[\\uDFFE\\uDFFF]|\\uDABF[\\uDFFE\\uDFFF]|(?:\\" + "uDAFF[\\uDFFE\\uDFFF])|\\uDB3F[\\uDFFE\\uDFFF]|\\uDB7F[\\uDFFE\\uDFFF]|(?:\\uDBBF" + "[\\uDFFE\\uDFFF])|\\uDBFF[\\uDFFE\\uDFFF](?:[\\0-\\t\\v\\f\\x0E-\\u2027\\u202A-\\uD7FF\\" + "uE000-\\uFFFF]|[\\uD800-\\uDBFF][\\uDC00-\\uDFFF]|[\\uD800-\\uDBFF](?![\\uDC00-\\uDFFF])|" + "(?:[^\\uD800-\\uDBFF]|^)[\\uDC00-\\uDFFF]))",
 			"g"
 			/* eslint-enable */
-);
+		);
 		value = value.replace(regex, "");
 	}
 	return value;
@@ -2131,6 +2188,7 @@ class JUnitReporter {
 				failures: 0,
 				skipped: 0
 			});
+			// inject failed suites to surface errors during beforeAll/afterAll
 			const suites = getSuites(file);
 			for (const suite of suites) {
 				if (suite.result?.errors) {
@@ -2138,6 +2196,7 @@ class JUnitReporter {
 					stats.failures += 1;
 				}
 			}
+			// If there are no tests, but the file failed to load, we still want to report it as a failure
 			if (tasks.length === 0 && file.result?.state === "fail") {
 				stats.failures = 1;
 				tasks.push({
@@ -2228,6 +2287,7 @@ class TapReporter {
 		this.logger.log(`name: ${yamlString(String(errorName))}`);
 		this.logger.log(`message: ${yamlString(String(error.message))}`);
 		if (stack) {
+			// For compatibility with tap-mocha-reporter
 			this.logger.log(`stack: ${yamlString(`${stack.file}:${stack.line}:${stack.column}`)}`);
 		}
 	}
@@ -2302,12 +2362,18 @@ class VerboseReporter extends DefaultReporter {
 	verbose = true;
 	renderSucceed = true;
 	printTestModule(module) {
+		// still print the test module in TTY,
+		// but don't print it in the CLI because we
+		// print all the tests when they finish
+		// instead of printing them when the test file finishes
 		if (this.isTTY) {
 			return super.printTestModule(module);
 		}
 	}
 	onTestCaseResult(test) {
 		super.onTestCaseResult(test);
+		// don't print tests in TTY as they go, only print them
+		// in the CLI when they finish
 		if (this.isTTY) {
 			return;
 		}
@@ -2346,6 +2412,7 @@ class VerboseReporter extends DefaultReporter {
 		return "  ".repeat(getIndentation(test));
 	}
 	formatShortError() {
+		// Short errors are not shown in tree-view
 		return "";
 	}
 }

package/dist/chunks/{index.DswW_LEs.js → index.CbT4iuwc.js}

@@ -1,9 +1,9 @@
 import * as chai from 'chai';
 import { resolve } from 'node:path';
-import { l as loadDiffConfig, b as loadSnapshotSerializers, t as takeCoverageInsideWorker } from './setup-common.CYo3Y0dD.js';
+import { l as loadDiffConfig, b as loadSnapshotSerializers, t as takeCoverageInsideWorker } from './setup-common.CF-O-dZX.js';
 import { distDir } from '../path.js';
-import { r as rpc } from './rpc.D9_013TY.js';
-import { g as getWorkerState } from './utils.CgTj3MsC.js';
+import { r as rpc } from './rpc.BKExFSRG.js';
+import { g as getWorkerState } from './utils.BlI4TC7Y.js';
 
 function setupChaiConfig(config) {
 	Object.assign(chai.config, config);
@@ -11,7 +11,7 @@ function setupChaiConfig(config) {
 
 async function resolveSnapshotEnvironment(config, executor) {
 	if (!config.snapshotEnvironment) {
-		const { VitestNodeSnapshotEnvironment } = await import('./node.3xsWotC9.js');
+		const { VitestNodeSnapshotEnvironment } = await import('./node.Be-ntJnD.js');
 		return new VitestNodeSnapshotEnvironment();
 	}
 	const mod = await executor.executeId(config.snapshotEnvironment);
@@ -36,6 +36,7 @@ async function getTestRunnerConstructor(config, executor) {
 async function resolveTestRunner(config, executor) {
 	const TestRunner = await getTestRunnerConstructor(config, executor);
 	const testRunner = new TestRunner(config);
+	// inject private executor to every runner
 	Object.defineProperty(testRunner, "__vitest_executor", {
 		value: executor,
 		enumerable: false,
@@ -49,6 +50,7 @@ async function resolveTestRunner(config, executor) {
 	}
 	const [diffOptions] = await Promise.all([loadDiffConfig(config, executor), loadSnapshotSerializers(config, executor)]);
 	testRunner.config.diffOptions = diffOptions;
+	// patch some methods, so custom runners don't need to call RPC
 	const originalOnTaskUpdate = testRunner.onTaskUpdate;
 	testRunner.onTaskUpdate = async (task, events) => {
 		const p = rpc().onTaskUpdate(task, events);
@@ -66,6 +68,7 @@ async function resolveTestRunner(config, executor) {
 		files.forEach((file) => {
 			file.prepareDuration = state.durations.prepare;
 			file.environmentLoad = state.durations.environment;
+			// should be collected only for a single test file in a batch
 			state.durations.prepare = 0;
 			state.durations.environment = 0;
 		});