ava 3.9.0 → 3.11.1

package/index.d.ts

@@ -130,7 +130,7 @@ export interface DeepEqualAssertion {
 
 export interface LikeAssertion {
 	/** Assert that `value` is like `selector`. */
-	(value: any, selector: Record<string, unknown>, message?: string): void;
+	(value: any, selector: Record<string, any>, message?: string): void;
 
 	/** Skip this assertion. */
 	skip(value: any, selector: any, message?: string): void;
@@ -353,7 +353,7 @@ export interface TimeoutFn {
 	 * Set a timeout for the test, in milliseconds. The test will fail if the timeout is exceeded.
 	 * The timeout is reset each time an assertion is made.
 	 */
-	(ms: number): void;
+	(ms: number, message?: string): void;
 }
 
 export interface TeardownFn {

package/lib/api.js

@@ -147,7 +147,7 @@ class Api extends Emittery {
 				runStatus = new RunStatus(selectedFiles.length, null);
 			}
 
-			const debugWithoutSpecificFile = Boolean(this.options.debug) && selectedFiles.length !== 1;
+			const debugWithoutSpecificFile = Boolean(this.options.debug) && !this.options.debug.active && selectedFiles.length !== 1;
 
 			await this.emit('run', {
 				bailWithoutReporting: debugWithoutSpecificFile,

package/lib/assert.js

@@ -64,6 +64,21 @@ class AssertionError extends Error {
 }
 exports.AssertionError = AssertionError;
 
+function checkAssertionMessage(assertion, message) {
+	if (typeof message === 'undefined' || typeof message === 'string') {
+		return true;
+	}
+
+	return new AssertionError({
+		assertion,
+		improperUsage: true,
+		message: 'The assertion message must be a string',
+		values: [formatWithLabel('Called with:', message)]
+	});
+}
+
+exports.checkAssertionMessage = checkAssertionMessage;
+
 function getErrorWithLongStackTrace() {
 	const limitBefore = Error.stackTraceLimit;
 	Error.stackTraceLimit = Infinity;
@@ -243,7 +258,8 @@ class Assertions {
 		skip = notImplemented,
 		compareWithSnapshot = notImplemented,
 		powerAssert,
-		experiments = {}
+		experiments = {},
+		disableSnapshots = false
 	} = {}) {
 		const withSkip = assertionFn => {
 			assertionFn.skip = skip;
@@ -268,22 +284,16 @@ class Assertions {
 		});
 
 		const checkMessage = (assertion, message, powerAssert = false) => {
-			if (typeof message === 'undefined' || typeof message === 'string') {
-				return true;
+			const result = checkAssertionMessage(assertion, message);
+			if (result === true) {
+				return this.true;
 			}
 
-			const error = new AssertionError({
-				assertion,
-				improperUsage: true,
-				message: 'The assertion message must be a string',
-				values: [formatWithLabel('Called with:', message)]
-			});
-
 			if (powerAssert) {
-				throw error;
+				throw result;
 			}
 
-			fail(error);
+			fail(result);
 			return false;
 		};
 
@@ -389,15 +399,6 @@ class Assertions {
 		});
 
 		this.like = withSkip((actual, selector, message) => {
-			if (!experiments.likeAssertion) {
-				fail(new AssertionError({
-					assertion: 'like',
-					improperUsage: true,
-					message: 'You must enable the `likeAssertion` experiment in order to use `t.like()`'
-				}));
-				return;
-			}
-
 			if (!checkMessage('like', message)) {
 				return;
 			}
@@ -690,6 +691,15 @@ class Assertions {
 		});
 
 		this.snapshot = withSkip((expected, ...rest) => {
+			if (disableSnapshots && experiments.disableSnapshotsInHooks) {
+				fail(new AssertionError({
+					assertion: 'snapshot',
+					message: '`t.snapshot()` can only be used in tests',
+					improperUsage: true
+				}));
+				return;
+			}
+
 			let message;
 			let snapshotOptions;
 			if (rest.length > 1) {

package/lib/cli.js

@@ -88,7 +88,19 @@ exports.run = async () => { // eslint-disable-line complexity
 		confError = error;
 	}
 
-	let debug = null;
+	// Enter debug mode if the main process is being inspected. This assumes the
+	// worker processes are automatically inspected, too. It is not necessary to
+	// run AVA with the debug command, though it's allowed.
+	const activeInspector = require('inspector').url() !== undefined; // eslint-disable-line node/no-unsupported-features/node-builtins
+	let debug = activeInspector ?
+		{
+			active: true,
+			break: false,
+			files: [],
+			host: undefined,
+			port: undefined
+		} : null;
+
 	let resetCache = false;
 	const {argv} = yargs
 		.parserConfiguration({
@@ -122,7 +134,11 @@ exports.run = async () => { // eslint-disable-line complexity
 			array: true,
 			describe: 'Glob patterns to select what test files to run. Leave empty if you want AVA to run all test files instead. Add a colon and specify line numbers of specific tests to run',
 			type: 'string'
-		}))
+		}), argv => {
+			if (activeInspector) {
+				debug.files = argv.pattern || [];
+			}
+		})
 		.command(
 			'debug [<pattern>...]',
 			'Activate Node.js inspector and run a single test file',
@@ -148,6 +164,7 @@ exports.run = async () => { // eslint-disable-line complexity
 			}),
 			argv => {
 				debug = {
+					active: activeInspector,
 					break: argv.break === true,
 					files: argv.pattern,
 					host: argv.host,
@@ -182,6 +199,10 @@ exports.run = async () => { // eslint-disable-line complexity
 	const chalkOptions = {level: combined.color === false ? 0 : require('chalk').level};
 	const chalk = require('./chalk').set(chalkOptions);
 
+	if (combined.updateSnapshots && combined.match) {
+		exit('Snapshots cannot be updated when matching specific tests.');
+	}
+
 	if (confError) {
 		if (confError.parent) {
 			exit(`${confError.message}\n\n${chalk.gray((confError.parent && confError.parent.stack) || confError.parent)}`);
@@ -356,6 +377,9 @@ exports.run = async () => { // eslint-disable-line complexity
 			pattern: normalizePattern(path.relative(projectDir, path.resolve(process.cwd(), pattern))),
 			...rest
 		}));
+	if (combined.updateSnapshots && filter.some(condition => condition.lineNumbers !== null)) {
+		exit('Snapshots cannot be updated when selecting specific tests by their line number.');
+	}
 
 	const api = new Api({
 		cacheEnabled: combined.cache !== false,
@@ -437,14 +461,14 @@ exports.run = async () => { // eslint-disable-line complexity
 	} else {
 		let debugWithoutSpecificFile = false;
 		api.on('run', plan => {
-			if (plan.debug && plan.files.length !== 1) {
+			if (debug !== null && plan.files.length !== 1) {
 				debugWithoutSpecificFile = true;
 			}
 		});
 
 		const runStatus = await api.run({filter});
 
-		if (debugWithoutSpecificFile) {
+		if (debugWithoutSpecificFile && !debug.active) {
 			exit('Provide the path to the test file you wish to debug');
 			return;
 		}

package/lib/load-config.js

@@ -7,7 +7,7 @@ const pkgConf = require('pkg-conf');
 
 const NO_SUCH_FILE = Symbol('no ava.config.js file');
 const MISSING_DEFAULT_EXPORT = Symbol('missing default export');
-const EXPERIMENTS = new Set(['likeAssertion', 'reverseTeardowns']);
+const EXPERIMENTS = new Set(['disableSnapshotsInHooks', 'reverseTeardowns']);
 
 // *Very* rudimentary support for loading ava.config.js files containing an `export default` statement.
 const evaluateJsConfig = configFile => {

package/lib/reporters/default.js

@@ -18,7 +18,6 @@ const colors = require('./colors');
 const formatSerializedError = require('./format-serialized-error');
 const improperUsageMessages = require('./improper-usage-messages');
 const prefixTitle = require('./prefix-title');
-const whileCorked = require('./while-corked');
 
 const nodeInternals = require('stack-utils').nodeInternals();
 
@@ -97,6 +96,48 @@ class LineWriterWithSpinner extends LineWriter {
 	}
 }
 
+function manageCorking(stream) {
+	let corked = false;
+	const cork = () => {
+		corked = true;
+		stream.cork();
+	};
+
+	const uncork = () => {
+		corked = false;
+		stream.uncork();
+	};
+
+	return {
+		decorateFlushingWriter(fn) {
+			return function (...args) {
+				if (corked) {
+					stream.uncork();
+				}
+
+				try {
+					return fn.apply(this, args);
+				} finally {
+					if (corked) {
+						stream.cork();
+					}
+				}
+			};
+		},
+
+		decorateWriter(fn) {
+			return function (...args) {
+				cork();
+				try {
+					return fn.apply(this, args);
+				} finally {
+					uncork();
+				}
+			};
+		}
+	};
+}
+
 class Reporter {
 	constructor({
 		verbose,
@@ -112,13 +153,16 @@ class Reporter {
 		this.stdStream = stdStream;
 		this.watching = watching;
 		this.relativeFile = file => path.relative(projectDir, file);
-		this.consumeStateChange = whileCorked(this.reportStream, this.consumeStateChange);
+
+		const {decorateWriter, decorateFlushingWriter} = manageCorking(this.reportStream);
+		this.consumeStateChange = decorateWriter(this.consumeStateChange);
+		this.endRun = decorateWriter(this.endRun);
 
 		if (this.verbose) {
 			this.durationThreshold = durationThreshold || 100;
 			this.spinner = null;
+			this.clearSpinner = () => {};
 			this.lineWriter = new LineWriter(this.reportStream);
-			this.endRun = whileCorked(this.reportStream, this.endRun);
 		} else {
 			this.spinner = ora({
 				isEnabled: true,
@@ -128,8 +172,8 @@ class Reporter {
 				spinner: spinner || (process.platform === 'win32' ? 'line' : 'dots'),
 				stream: reportStream
 			});
+			this.clearSpinner = decorateFlushingWriter(this.spinner.clear.bind(this.spinner));
 			this.lineWriter = new LineWriterWithSpinner(this.reportStream, this.spinner);
-			this.endRun = whileCorked(this.reportStream, whileCorked(this.lineWriter, this.endRun));
 		}
 
 		this.reset();
@@ -153,6 +197,7 @@ class Reporter {
 		this.lineNumberErrors = [];
 		this.uncaughtExceptions = [];
 		this.unhandledRejections = [];
+		this.unsavedSnapshots = [];
 
 		this.previousFailures = 0;
 
@@ -295,6 +340,10 @@ class Reporter {
 				break;
 			}
 
+			case 'snapshot-error':
+				this.unsavedSnapshots.push(event);
+				break;
+
 			case 'uncaught-exception': {
 				this.uncaughtExceptions.push(event);
 
@@ -357,9 +406,7 @@ class Reporter {
 
 			case 'worker-stderr': {
 				// Forcibly clear the spinner, writing the chunk corrupts the TTY.
-				if (this.spinner !== null) {
-					this.spinner.clear();
-				}
+				this.clearSpinner();
 
 				this.stdStream.write(event.chunk);
 				// If the chunk does not end with a linebreak, *forcibly* write one to
@@ -381,9 +428,7 @@ class Reporter {
 
 			case 'worker-stdout': {
 				// Forcibly clear the spinner, writing the chunk corrupts the TTY.
-				if (this.spinner !== null) {
-					this.spinner.clear();
-				}
+				this.clearSpinner();
 
 				this.stdStream.write(event.chunk);
 				// If the chunk does not end with a linebreak, *forcibly* write one to
@@ -749,6 +794,16 @@ class Reporter {
 			}
 		}
 
+		if (this.unsavedSnapshots.length > 0) {
+			this.lineWriter.writeLine(colors.title('Could not update snapshots for the following test files:'));
+			this.lineWriter.writeLine();
+			for (const event of this.unsavedSnapshots) {
+				this.lineWriter.writeLine(`${figures.warning} ${this.relativeFile(event.testFile)}`);
+			}
+
+			this.lineWriter.writeLine();
+		}
+
 		if (this.failFastEnabled && (this.stats.remainingTests > 0 || this.stats.files > this.stats.finishedWorkers)) {
 			let remaining = '';
 			if (this.stats.remainingTests > 0) {

package/lib/reporters/tap.js

@@ -158,6 +158,9 @@ class TapReporter {
 					this.writeTest(evt, {passed: false, todo: true, skip: false});
 				}
 
+				break;
+			case 'snapshot-error':
+				this.writeComment(evt, {title: 'Could not update snapshots'});
 				break;
 			case 'stats':
 				this.stats = evt.stats;

package/lib/runner.js

@@ -23,6 +23,7 @@ class Runner extends Emittery {
 		this.recordNewSnapshots = options.recordNewSnapshots === true;
 		this.runOnlyExclusive = options.runOnlyExclusive === true;
 		this.serial = options.serial === true;
+		this.skippingTests = false;
 		this.snapshotDir = options.snapshotDir;
 		this.updateSnapshots = options.updateSnapshots;
 
@@ -147,6 +148,10 @@ class Runner extends Emittery {
 							task.metadata.exclusive = matcher([title], this.match).length === 1;
 						}
 
+						if (task.metadata.skipped) {
+							this.skippingTests = true;
+						}
+
 						if (task.metadata.exclusive) {
 							this.runOnlyExclusive = true;
 						}
@@ -182,7 +187,7 @@ class Runner extends Emittery {
 				fixedLocation: this.snapshotDir,
 				projectDir: this.projectDir,
 				recordNewSnapshots: this.recordNewSnapshots,
-				updating: this.updateSnapshots
+				updating: this.updateSnapshots && !this.runOnlyExclusive && !this.skippingTests
 			});
 			this.emit('dependency', this.snapshots.snapPath);
 		}
@@ -191,8 +196,12 @@ class Runner extends Emittery {
 	}
 
 	saveSnapshotState() {
+		if (this.updateSnapshots && (this.runOnlyExclusive || this.skippingTests)) {
+			return {cannotSave: true};
+		}
+
 		if (this.snapshots) {
-			return this.snapshots.save();
+			return {touchedFiles: this.snapshots.save()};
 		}
 
 		if (this.updateSnapshots) {
@@ -201,7 +210,7 @@ class Runner extends Emittery {
 			// were skipped. Perhaps emit a warning if this occurs?
 		}
 
-		return null;
+		return {};
 	}
 
 	onRun(runnable) {

package/lib/test.js

@@ -40,7 +40,8 @@ class ExecutionContext extends assert.Assertions {
 				return test.compareWithSnapshot(options);
 			},
 			powerAssert: test.powerAssert,
-			experiments: test.experiments
+			experiments: test.experiments,
+			disableSnapshots: test.isHook === true
 		});
 		testMap.set(this, test);
 
@@ -65,8 +66,8 @@ class ExecutionContext extends assert.Assertions {
 
 		this.plan.skip = () => {};
 
-		this.timeout = ms => {
-			test.timeout(ms);
+		this.timeout = (ms, message) => {
+			test.timeout(ms, message);
 		};
 
 		this.teardown = callback => {
@@ -74,6 +75,12 @@ class ExecutionContext extends assert.Assertions {
 		};
 
 		this.try = async (...attemptArgs) => {
+			if (test.isHook) {
+				const error = new Error('`t.try()` can only be used in tests');
+				test.saveFirstError(error);
+				throw error;
+			}
+
 			const {args, buildTitle, implementations, receivedImplementationArray} = parseTestArgs(attemptArgs);
 
 			if (implementations.length === 0) {
@@ -431,7 +438,14 @@ class Test {
 		this.planError = planError;
 	}
 
-	timeout(ms) {
+	timeout(ms, message) {
+		const result = assert.checkAssertionMessage('timeout', message);
+		if (result !== true) {
+			this.saveFirstError(result);
+			// Allow the timeout to be set even when the message is invalid.
+			message = '';
+		}
+
 		if (this.finishing) {
 			return;
 		}
@@ -439,7 +453,7 @@ class Test {
 		this.clearTimeout();
 		this.timeoutMs = ms;
 		this.timeoutTimer = nowAndTimers.setTimeout(() => {
-			this.saveFirstError(new Error('Test timeout exceeded'));
+			this.saveFirstError(new Error(message || 'Test timeout exceeded'));
 
 			if (this.finishDueToTimeout) {
 				this.finishDueToTimeout();

package/lib/worker/subprocess.js

@@ -91,8 +91,10 @@ ipc.options.then(async options => {
 
 	runner.on('finish', () => {
 		try {
-			const touchedFiles = runner.saveSnapshotState();
-			if (touchedFiles) {
+			const {cannotSave, touchedFiles} = runner.saveSnapshotState();
+			if (cannotSave) {
+				ipc.send({type: 'snapshot-error'});
+			} else if (touchedFiles) {
 				ipc.send({type: 'touched-files', files: touchedFiles});
 			}
 		} catch (error) {
@@ -203,8 +205,14 @@ ipc.options.then(async options => {
 		// to make sure we also track dependencies with custom require hooks
 		dependencyTracking.install(testPath);
 
-		if (options.debug) {
-			require('inspector').open(options.debug.port, options.debug.host, true); // eslint-disable-line node/no-unsupported-features/node-builtins
+		if (options.debug && options.debug.port !== undefined && options.debug.host !== undefined) {
+			// If an inspector was active when the main process started, and is
+			// already active for the worker process, do not open a new one.
+			const inspector = require('inspector'); // eslint-disable-line node/no-unsupported-features/node-builtins
+			if (!options.debug.active || inspector.url() === undefined) {
+				inspector.open(options.debug.port, options.debug.host, true);
+			}
+
 			if (options.debug.break) {
 				debugger; // eslint-disable-line no-debugger
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ava",
-	"version": "3.9.0",
+	"version": "3.11.1",
 	"description": "Node.js test runner that lets you develop with confidence.",
 	"license": "MIT",
 	"repository": "avajs/ava",
@@ -57,27 +57,27 @@
 	"dependencies": {
 		"@concordance/react": "^2.0.0",
 		"acorn": "^7.3.1",
-		"acorn-walk": "^7.1.1",
+		"acorn-walk": "^7.2.0",
 		"ansi-styles": "^4.2.1",
 		"arrgv": "^1.0.2",
 		"arrify": "^2.0.1",
 		"callsites": "^3.1.0",
 		"chalk": "^4.1.0",
-		"chokidar": "^3.4.0",
+		"chokidar": "^3.4.1",
 		"chunkd": "^2.0.1",
 		"ci-info": "^2.0.0",
-		"ci-parallel-vars": "^1.0.0",
+		"ci-parallel-vars": "^1.0.1",
 		"clean-yaml-object": "^0.1.0",
 		"cli-cursor": "^3.1.0",
 		"cli-truncate": "^2.1.0",
-		"code-excerpt": "^2.1.1",
+		"code-excerpt": "^3.0.0",
 		"common-path-prefix": "^3.0.0",
 		"concordance": "^5.0.0",
 		"convert-source-map": "^1.7.0",
 		"currently-unhandled": "^0.4.1",
 		"debug": "^4.1.1",
 		"del": "^5.1.0",
-		"emittery": "^0.7.0",
+		"emittery": "^0.7.1",
 		"equal-length": "^1.0.0",
 		"figures": "^3.2.0",
 		"globby": "^11.0.1",
@@ -85,14 +85,14 @@
 		"import-local": "^3.0.2",
 		"indent-string": "^4.0.0",
 		"is-error": "^2.2.2",
-		"is-plain-object": "^3.0.0",
+		"is-plain-object": "^4.1.1",
 		"is-promise": "^4.0.0",
-		"lodash": "^4.17.15",
+		"lodash": "^4.17.19",
 		"matcher": "^3.0.0",
 		"md5-hex": "^3.0.1",
 		"mem": "^6.1.0",
 		"ms": "^2.1.2",
-		"ora": "^4.0.4",
+		"ora": "^4.0.5",
 		"p-map": "^4.0.0",
 		"picomatch": "^2.2.2",
 		"pkg-conf": "^3.1.0",
@@ -109,18 +109,18 @@
 		"trim-off-newlines": "^1.0.1",
 		"update-notifier": "^4.1.0",
 		"write-file-atomic": "^3.0.3",
-		"yargs": "^15.3.1"
+		"yargs": "^15.4.1"
 	},
 	"devDependencies": {
 		"@ava/babel": "^1.0.1",
 		"@ava/test": "github:avajs/test",
-		"@babel/plugin-proposal-do-expressions": "^7.10.1",
+		"@babel/plugin-proposal-do-expressions": "^7.10.4",
 		"@sinonjs/fake-timers": "^6.0.1",
 		"ansi-escapes": "^4.3.1",
-		"c8": "^7.2.0",
-		"delay": "^4.3.0",
+		"c8": "^7.2.1",
+		"delay": "^4.4.0",
 		"esm": "^3.2.25",
-		"execa": "^4.0.2",
+		"execa": "^4.0.3",
 		"get-stream": "^5.1.0",
 		"p-event": "^4.2.0",
 		"proxyquire": "^2.1.3",
@@ -129,13 +129,13 @@
 		"replace-string": "^3.1.0",
 		"sinon": "^9.0.2",
 		"source-map-fixtures": "^2.1.0",
-		"tap": "^14.10.7",
+		"tap": "^14.10.8",
 		"temp-write": "^4.0.0",
-		"tempy": "^0.5.0",
+		"tempy": "^0.6.0",
 		"touch": "^3.1.0",
-		"tsd": "^0.11.0",
-		"typescript": "^3.9.5",
-		"xo": "^0.32.0",
+		"tsd": "^0.13.1",
+		"typescript": "^3.9.7",
+		"xo": "^0.32.1",
 		"zen-observable": "^0.8.15"
 	}
 }

package/lib/reporters/while-corked.js

@@ -1,13 +0,0 @@
-'use strict';
-function whileCorked(stream, fn) {
-	return function (...args) {
-		stream.cork();
-		try {
-			fn.apply(this, args);
-		} finally {
-			stream.uncork();
-		}
-	};
-}
-
-module.exports = whileCorked;