ava 5.3.1 → 6.0.0

package/lib/reporters/default.js

@@ -25,7 +25,7 @@ class LineWriter extends stream.Writable {
 		super();
 
 		this.dest = dest;
-		this.columns = dest.columns || 80;
+		this.columns = dest.columns ?? 80;
 		this.lastLineIsEmpty = false;
 	}
 
@@ -91,7 +91,7 @@ export default class Reporter {
 		this.consumeStateChange = decorateWriter(this.consumeStateChange);
 		this.endRun = decorateWriter(this.endRun);
 
-		this.durationThreshold = durationThreshold || 100;
+		this.durationThreshold = durationThreshold ?? 100;
 		this.lineWriter = new LineWriter(this.reportStream);
 
 		this.reset();
@@ -148,7 +148,7 @@ export default class Reporter {
 			this.consumeStateChange(evt);
 		});
 
-		if (this.watching && plan.runVector > 1) {
+		if (this.watching && !plan.firstRun) {
 			this.lineWriter.write(chalk.gray.dim('\u2500'.repeat(this.lineWriter.columns)) + os.EOL);
 		}
 
@@ -208,9 +208,7 @@ export default class Reporter {
 					this.write(colors.error(`${figures.cross} Internal error`));
 				}
 
-				this.lineWriter.writeLine(colors.stack(event.err.summary));
-				this.lineWriter.writeLine(colors.errorStack(event.err.stack));
-				this.lineWriter.writeLine();
+				this.writeSerializedError(event.err);
 				this.lineWriter.writeLine();
 
 				break;
@@ -221,8 +219,7 @@ export default class Reporter {
 
 				this.write(colors.information(`${figures.warning} Could not parse ${this.relativeFile(event.testFile)} for line number selection`));
 				this.lineWriter.writeLine();
-				this.lineWriter.writeLine(colors.errorStack(event.err.stack));
-				this.lineWriter.writeLine();
+				this.writeSerializedError(event.err);
 				break;
 			}
 
@@ -268,7 +265,7 @@ export default class Reporter {
 				this.lineWriter.ensureEmptyLine();
 				this.lineWriter.writeLine(colors.error(`${figures.cross} Error in shared worker`));
 				this.lineWriter.writeLine();
-				this.writeErr(event);
+				this.writeSerializedError(event.err);
 
 				break;
 			}
@@ -279,7 +276,7 @@ export default class Reporter {
 				this.lineWriter.ensureEmptyLine();
 				this.lineWriter.writeLine(colors.title(`Uncaught exception in ${this.relativeFile(event.testFile)}`));
 				this.lineWriter.writeLine();
-				this.writeErr(event);
+				this.writeSerializedError(event.err);
 
 				break;
 			}
@@ -290,7 +287,7 @@ export default class Reporter {
 				this.lineWriter.ensureEmptyLine();
 				this.lineWriter.writeLine(colors.title(`Unhandled rejection in ${this.relativeFile(event.testFile)}`));
 				this.lineWriter.writeLine();
-				this.writeErr(event);
+				this.writeSerializedError(event.err);
 
 				break;
 			}
@@ -304,7 +301,7 @@ export default class Reporter {
 					if (event.err) {
 						this.lineWriter.writeLine(colors.error(`${figures.cross} ${this.relativeFile(event.testFile)} exited due to an error:`));
 						this.lineWriter.writeLine();
-						this.writeErr(event);
+						this.writeSerializedError(event.err);
 					} else if (event.nonZeroExitCode) {
 						this.lineWriter.writeLine(colors.error(`${figures.cross} ${this.relativeFile(event.testFile)} exited with a non-zero exit code: ${event.nonZeroExitCode}`));
 					} else {
@@ -341,7 +338,7 @@ export default class Reporter {
 				// we multiplex stdout and stderr into a single stream. However as
 				// long as stdStream is different from reportStream users can read
 				// their original output by redirecting the streams.
-				if (event.chunk[event.chunk.length - 1] !== 0x0A) {
+				if (event.chunk.at(-1) !== 0x0A) {
 					this.reportStream.write(os.EOL);
 				}
 
@@ -356,7 +353,7 @@ export default class Reporter {
 				// we multiplex stdout and stderr into a single stream. However as
 				// long as stdStream is different from reportStream users can read
 				// their original output by redirecting the streams.
-				if (event.chunk[event.chunk.length - 1] !== 0x0A) {
+				if (event.chunk.at(-1) !== 0x0A) {
 					this.reportStream.write(os.EOL);
 				}
 			}
@@ -366,6 +363,7 @@ export default class Reporter {
 	writePendingTests(evt) {
 		for (const [file, testsInFile] of evt.pendingTests) {
 			if (testsInFile.size === 0) {
+				this.lineWriter.writeLine(`Failed to exit when running ${this.relativeFile(file)}\n`);
 				continue;
 			}
 
@@ -390,7 +388,7 @@ export default class Reporter {
 			return this.lineWriter.writeLine(string);
 		}
 
-		string = string || '';
+		string ??= '';
 		if (string !== '') {
 			string += os.EOL;
 		}
@@ -427,16 +425,32 @@ export default class Reporter {
 		this.lineWriter.writeLine(string);
 	}
 
-	writeErr(event) {
-		if (event.err.name === 'TSError' && event.err.object && event.err.object.diagnosticText) {
-			this.lineWriter.writeLine(colors.errorStack(event.err.object.diagnosticText));
+	writeSerializedError(error) { // eslint-disable-line complexity
+		if (error.type === 'aggregate') {
+			for (const error_ of error.errors) {
+				this.writeSerializedError(error_);
+			}
+
+			return;
+		}
+
+		if (error.type === 'unknown') {
+			this.lineWriter.writeLine(error.formattedError);
 			this.lineWriter.writeLine();
 			return;
 		}
 
-		if (event.err.source) {
-			this.lineWriter.writeLine(colors.errorSource(`${this.relativeFile(event.err.source.file)}:${event.err.source.line}`));
-			const excerpt = codeExcerpt(event.err.source, {maxWidth: this.reportStream.columns - 2});
+		if (error.type === 'native' && error.name === 'TSError' && error.originalError.diagnosticText) {
+			this.lineWriter.writeLine(colors.errorStack(error.originalError.diagnosticText));
+			this.lineWriter.writeLine();
+			return;
+		}
+
+		const hasSource = error.source !== null;
+		if (hasSource) {
+			const {source} = error;
+			this.lineWriter.writeLine(colors.errorSource(`${this.relativeFile(source.file)}:${source.line}`));
+			const excerpt = codeExcerpt(source, {maxWidth: this.reportStream.columns - 2});
 			if (excerpt) {
 				this.lineWriter.writeLine();
 				this.lineWriter.writeLine(excerpt);
@@ -444,10 +458,47 @@ export default class Reporter {
 			}
 		}
 
-		if (event.err.avaAssertionError) {
-			const result = formatSerializedError(event.err);
+		let summary = '';
+		let printStack = true;
+		if (error.type === 'native') {
+			const lines = error.stack.split('\n');
+
+			// SyntaxError stacks may begin with the offending code. Write all stack
+			// lines up to and including one that begins with SyntaxError.
+			if (error.name === 'SyntaxError') {
+				for (const line of lines) {
+					summary += line + '\n';
+					if (line.startsWith('SyntaxError')) {
+						break;
+					}
+				}
+
+				printStack = summary === '';
+			} else {
+				// Handle multi-line error messages.
+				for (let index = 0; index < lines.length; index++) {
+					if (/^\s+at/.test(lines[index])) {
+						break;
+					}
+
+					const next = index + 1;
+					const end = next === lines.length || /^\s+at/.test(lines[next]);
+					summary += end ? lines[index] : lines[index] + '\n';
+				}
+			}
+
+			if (summary !== '') {
+				this.lineWriter.writeLine(summary.trim());
+				this.lineWriter.writeLine();
+			}
+		}
+
+		if (error.type === 'ava') {
+			const {formattedDetails, improperUsage, message} = error;
+
+			const result = formatSerializedError(formattedDetails, message);
 			if (result.printMessage) {
-				this.lineWriter.writeLine(event.err.message);
+				this.lineWriter.writeLine(message);
 				this.lineWriter.writeLine();
 			}
 
@@ -456,33 +507,29 @@ export default class Reporter {
 				this.lineWriter.writeLine();
 			}
 
-			const message = improperUsageMessage(event.err);
-			if (message) {
-				this.lineWriter.writeLine(message);
+			const usageMessage = improperUsageMessage(improperUsage);
+			if (usageMessage) {
+				this.lineWriter.writeLine(usageMessage);
 				this.lineWriter.writeLine();
 			}
-		} else if (event.err.nonErrorObject) {
-			this.lineWriter.writeLine(event.err.formatted);
-			this.lineWriter.writeLine();
-		} else {
-			this.lineWriter.writeLine(event.err.summary);
-			this.lineWriter.writeLine();
 		}
 
-		const formatted = this.formatErrorStack(event.err);
-		if (formatted.length > 0) {
-			this.lineWriter.writeLine(formatted.join('\n'));
-			this.lineWriter.writeLine();
+		if (printStack) {
+			const formattedStack = this.formatErrorStack(error.stack, hasSource);
+			if (formattedStack.length > 0) {
+				this.lineWriter.writeLine(formattedStack.join('\n'));
+				this.lineWriter.writeLine();
+			}
 		}
 	}
 
-	formatErrorStack(error) {
-		if (!error.stack) {
+	formatErrorStack(stack, hasSource) {
+		if (stack === '') {
 			return [];
 		}
 
-		if (error.shouldBeautifyStack) {
-			return beautifyStack(error.stack).map(line => {
+		if (hasSource) {
+			return beautifyStack(stack).map(line => {
 				if (nodeInternals.some(internal => internal.test(line))) {
 					return colors.errorStackInternal(`${figures.pointerSmall} ${line}`);
 				}
@@ -491,11 +538,11 @@ export default class Reporter {
 			});
 		}
 
-		return [error.stack];
+		return [colors.errorStack(stack)];
 	}
 
 	writeLogs(event, surroundLines) {
-		if (event.logs && event.logs.length > 0) {
+		if (event.logs?.length > 0) {
 			if (surroundLines) {
 				this.lineWriter.writeLine();
 			}
@@ -551,7 +598,7 @@ export default class Reporter {
 			this.lineWriter.writeLine();
 		}
 
-		this.writeErr(event);
+		this.writeSerializedError(event.err);
 	}
 
 	endRun() {// eslint-disable-line complexity
@@ -602,7 +649,7 @@ export default class Reporter {
 		this.lineWriter.writeLine();
 
 		if (this.failures.length > 0) {
-			const lastFailure = this.failures[this.failures.length - 1];
+			const lastFailure = this.failures.at(-1);
 			for (const event of this.failures) {
 				this.writeFailure(event);
 				if (event !== lastFailure) {

package/lib/reporters/format-serialized-error.js

@@ -1,14 +1,14 @@
-export default function formatSerializedError(error) {
-	const printMessage = error.values.length === 0
-		? Boolean(error.message)
-		: !error.values[0].label.startsWith(error.message);
+export default function formatSerializedError(formattedDetails, message) {
+	const printMessage = formattedDetails.length === 0
+		? Boolean(message)
+		: !formattedDetails[0].label.startsWith(message);
 
-	if (error.values.length === 0) {
+	if (formattedDetails.length === 0) {
 		return {formatted: null, printMessage};
 	}
 
 	let formatted = '';
-	for (const value of error.values) {
+	for (const value of formattedDetails) {
 		formatted += `${value.label}\n\n${value.formatted}\n\n`;
 	}
 

package/lib/reporters/improper-usage-messages.js

@@ -1,12 +1,12 @@
 import {chalk} from '../chalk.js';
 import pkg from '../pkg.cjs';
 
-export default function buildMessage(error) {
-	if (!error.improperUsage) {
+export default function buildMessage(improperUsage) {
+	if (!improperUsage) {
 		return null;
 	}
 
-	const {assertion} = error;
+	const {assertion} = improperUsage;
 	if (assertion === 'throws' || assertion === 'notThrows') {
 		return `Try wrapping the first argument to \`t.${assertion}()\` in a function:
 
@@ -18,7 +18,7 @@ Visit the following URL for more details:
 	}
 
 	if (assertion === 'snapshot') {
-		const {name, snapPath} = error.improperUsage;
+		const {name, snapPath} = improperUsage;
 
 		if (name === 'ChecksumError' || name === 'InvalidSnapshotError') {
 			return `The snapshot file is corrupted.
@@ -37,7 +37,7 @@ Please run AVA again with the ${chalk.cyan('--update-snapshots')} flag to upgrad
 		}
 
 		if (name === 'VersionMismatchError') {
-			const {snapVersion, expectedVersion} = error.improperUsage;
+			const {snapVersion, expectedVersion} = improperUsage;
 			const upgradeMessage = snapVersion < expectedVersion
 				? `Please run AVA again with the ${chalk.cyan('--update-snapshots')} flag to upgrade.`
 				: 'You should upgrade AVA.';

package/lib/reporters/tap.js

@@ -6,43 +6,42 @@ import plur from 'plur';
 import stripAnsi from 'strip-ansi';
 import * as supertap from 'supertap';
 
-import beautifyStack from './beautify-stack.js';
 import prefixTitle from './prefix-title.js';
 
-function dumpError(error) {
-	const object = {...error.object};
-	if (error.name) {
-		object.name = error.name;
+function dumpError({
+	assertion,
+	formattedDetails,
+	formattedError,
+	name,
+	originalError, // A structured clone, so some details are missing.
+	stack,
+	type,
+}, sanitizeStackOutput) {
+	if (type === 'unknown') {
+		return {
+			message: 'Non-native error',
+			formatted: stripAnsi(formattedError),
+		};
 	}
 
-	if (error.message) {
-		object.message = error.message;
-	}
-
-	if (error.avaAssertionError) {
-		if (error.assertion) {
-			object.assertion = error.assertion;
-		}
+	originalError.name = name; // Restore the original name.
 
-		if (error.operator) {
-			object.operator = error.operator;
+	if (type === 'ava') {
+		if (assertion) {
+			originalError.assertion = assertion;
 		}
 
-		if (error.values.length > 0) {
-			object.values = Object.fromEntries(error.values.map(({label, formatted}) => [stripAnsi(label), stripAnsi(formatted)]));
+		if (formattedDetails.length > 0) {
+			originalError.details = Object.fromEntries(formattedDetails.map(({label, formatted}) => [
+				stripAnsi(label),
+				stripAnsi(formatted),
+			]));
 		}
 	}
 
-	if (error.nonErrorObject) {
-		object.message = 'Non-error object';
-		object.formatted = stripAnsi(error.formatted);
-	}
-
-	if (error.stack) {
-		object.at = error.shouldBeautifyStack ? beautifyStack(error.stack).join('\n') : error.stack;
-	}
+	originalError.stack = sanitizeStackOutput?.(stack || originalError.stack) ?? (stack || originalError.stack);
 
-	return object;
+	return originalError;
 }
 
 export default class TapReporter {
@@ -52,6 +51,7 @@ export default class TapReporter {
 		this.extensions = options.extensions;
 		this.stdStream = options.stdStream;
 		this.reportStream = options.reportStream;
+		this.sanitizeStackOutput = options.sanitizeStackOutput;
 
 		this.crashCount = 0;
 		this.filesWithMissingAvaImports = new Set();
@@ -98,7 +98,7 @@ export default class TapReporter {
 	writeTest(evt, flags) {
 		this.reportStream.write(supertap.test(this.prefixTitle(evt.testFile, evt.title), {
 			comment: evt.logs,
-			error: evt.err ? dumpError(evt.err) : null,
+			error: evt.err ? dumpError(evt.err, this.sanitizeStackOutput) : null,
 			index: ++this.i,
 			passed: flags.passed,
 			skip: flags.skip,
@@ -108,9 +108,9 @@ export default class TapReporter {
 
 	writeCrash(evt, title) {
 		this.crashCount++;
-		this.reportStream.write(supertap.test(title || evt.err.summary || evt.type, {
+		this.reportStream.write(supertap.test(title ?? evt.err.stack?.split('\n')[0].trim() ?? evt.err.message ?? evt.type, {
 			comment: evt.logs,
-			error: evt.err ? dumpError(evt.err) : null,
+			error: evt.err ? dumpError(evt.err, this.sanitizeStackOutput) : null,
 			index: ++this.i,
 			passed: false,
 			skip: false,
@@ -122,7 +122,7 @@ export default class TapReporter {
 		this.reportStream.write(`# ${stripAnsi(title)}${os.EOL}`);
 		if (evt.logs) {
 			for (const log of evt.logs) {
-				const logLines = indentString(log, 4).replace(/^ {4}/gm, '#   ');
+				const logLines = indentString(log, 4).replaceAll(/^ {4}/gm, '#   ');
 				this.reportStream.write(`${logLines}${os.EOL}`);
 			}
 		}

package/lib/run-status.js

@@ -193,6 +193,10 @@ export default class RunStatus extends Emittery {
 
 			case 'worker-finished': {
 				stats.finishedWorkers++;
+				if (this.pendingTests.get(event.testFile)?.size === 0) {
+					this.pendingTests.delete(event.testFile);
+				}
+
 				break;
 			}
 
@@ -209,6 +213,11 @@ export default class RunStatus extends Emittery {
 		this.emit('stateChange', event);
 	}
 
+	end() {
+		this.emitStateChange({type: 'end'});
+		return this;
+	}
+
 	suggestExitCode(circumstances) {
 		if (this.emptyParallelRun) {
 			return 0;

package/lib/runner.js

@@ -17,12 +17,12 @@ export default class Runner extends Emittery {
 	constructor(options = {}) {
 		super();
 
-		this.experiments = options.experiments || {};
+		this.experiments = options.experiments ?? {};
 		this.failFast = options.failFast === true;
 		this.failWithoutAssertions = options.failWithoutAssertions !== false;
 		this.file = options.file;
 		this.checkSelectedByLineNumbers = options.checkSelectedByLineNumbers;
-		this.match = options.match || [];
+		this.match = options.match ?? [];
 		this.projectDir = options.projectDir;
 		this.recordNewSnapshots = options.recordNewSnapshots === true;
 		this.runOnlyExclusive = options.runOnlyExclusive === true;
@@ -151,7 +151,7 @@ export default class Runner extends Emittery {
 				}
 
 				const task = {
-					title: title.value || fallbackTitle,
+					title: title.value ?? fallbackTitle,
 					implementation,
 					args,
 					metadata: {...metadata},
@@ -209,7 +209,7 @@ export default class Runner extends Emittery {
 			updating: this.updateSnapshots,
 		});
 		if (snapshots.snapPath !== undefined) {
-			this.emit('dependency', snapshots.snapPath);
+			this.emit('accessed-snapshots', snapshots.snapPath);
 		}
 
 		this._snapshots = snapshots;
@@ -301,7 +301,7 @@ export default class Runner extends Emittery {
 			skipSnapshot: this.boundSkipSnapshot,
 			updateSnapshots: this.updateSnapshots,
 			metadata: task.metadata,
-			title: `${task.title}${titleSuffix || ''}`,
+			title: `${task.title}${titleSuffix ?? ''}`,
 			isHook: true,
 			testPassed,
 			notifyTimeoutUpdate: this.notifyTimeoutUpdate,
@@ -319,7 +319,7 @@ export default class Runner extends Emittery {
 				this.emit('stateChange', {
 					type: 'hook-failed',
 					title: result.title,
-					err: serializeError('Hook failure', true, result.error),
+					err: serializeError(result.error, {testFile: this.file}),
 					duration: result.duration,
 					logs: result.logs,
 				});
@@ -387,7 +387,7 @@ export default class Runner extends Emittery {
 				this.emit('stateChange', {
 					type: 'test-failed',
 					title: result.title,
-					err: serializeError('Test failure', true, result.error, this.file),
+					err: serializeError(result.error, {testFile: this.file}),
 					duration: result.duration,
 					knownFailing: result.metadata.failing,
 					logs: result.logs,

package/lib/scheduler.js

@@ -13,9 +13,22 @@ const scheduler = {
 			return;
 		}
 
+		const filename = path.join(cacheDir, FILENAME);
+		// Given that we're writing to a cache directory, consider this file
+		// temporary.
+		const temporaryFiles = [filename];
 		try {
-			writeFileAtomic.sync(path.join(cacheDir, FILENAME), JSON.stringify(runStatus.getFailedTestFiles()));
+			writeFileAtomic.sync(filename, JSON.stringify(runStatus.getFailedTestFiles()), {
+				tmpfileCreated(tmpfile) {
+					temporaryFiles.push(tmpfile);
+				},
+			});
 		} catch {}
+
+		return {
+			changedFiles: [],
+			temporaryFiles,
+		};
 	},
 
 	// Order test-files, so that files with failing tests come first