ava 3.12.0 → 3.15.0

package/eslint-plugin-helper.js

@@ -1,26 +1,25 @@
 'use strict';
-const normalizeExtensions = require('./lib/extensions');
+let isMainThread = true;
+let supportsWorkers = false;
+try {
+	({isMainThread} = require('worker_threads'));
+	supportsWorkers = true;
+} catch {}
+
 const {classify, hasExtension, isHelperish, matches, normalizeFileForMatching, normalizeGlobs, normalizePatterns} = require('./lib/globs');
-const loadConfig = require('./lib/load-config');
-const providerManager = require('./lib/provider-manager');
 
-const configCache = new Map();
-const helperCache = new Map();
+let resolveGlobs;
+let resolveGlobsSync;
 
-function load(projectDir, overrides) {
-	const cacheKey = `${JSON.stringify(overrides)}\n${projectDir}`;
-	if (helperCache.has(cacheKey)) {
-		return helperCache.get(cacheKey);
-	}
+if (!supportsWorkers || !isMainThread) {
+	const normalizeExtensions = require('./lib/extensions');
+	const {loadConfig, loadConfigSync} = require('./lib/load-config');
+	const providerManager = require('./lib/provider-manager');
 
-	let conf;
-	let providers;
-	if (configCache.has(projectDir)) {
-		({conf, providers} = configCache.get(projectDir));
-	} else {
-		conf = loadConfig({resolveFrom: projectDir});
+	const configCache = new Map();
 
-		providers = [];
+	const collectProviders = ({conf, projectDir}) => {
+		const providers = [];
 		if (Reflect.has(conf, 'babel')) {
 			const {level, main} = providerManager.babel(projectDir);
 			providers.push({
@@ -39,12 +38,125 @@ function load(projectDir, overrides) {
 			});
 		}
 
-		configCache.set(projectDir, {conf, providers});
+		return providers;
+	};
+
+	const buildGlobs = ({conf, providers, projectDir, overrideExtensions, overrideFiles}) => {
+		const extensions = overrideExtensions ?
+			normalizeExtensions(overrideExtensions) :
+			normalizeExtensions(conf.extensions, providers);
+
+		return {
+			cwd: projectDir,
+			...normalizeGlobs({
+				extensions,
+				files: overrideFiles ? overrideFiles : conf.files,
+				providers
+			})
+		};
+	};
+
+	resolveGlobsSync = (projectDir, overrideExtensions, overrideFiles) => {
+		if (!configCache.has(projectDir)) {
+			const conf = loadConfigSync({resolveFrom: projectDir});
+			const providers = collectProviders({conf, projectDir});
+			configCache.set(projectDir, {conf, providers});
+		}
+
+		const {conf, providers} = configCache.get(projectDir);
+		return buildGlobs({conf, providers, projectDir, overrideExtensions, overrideFiles});
+	};
+
+	resolveGlobs = async (projectDir, overrideExtensions, overrideFiles) => {
+		if (!configCache.has(projectDir)) {
+			configCache.set(projectDir, loadConfig({resolveFrom: projectDir}).then(conf => { // eslint-disable-line promise/prefer-await-to-then
+				const providers = collectProviders({conf, projectDir});
+				return {conf, providers};
+			}));
+		}
+
+		const {conf, providers} = await configCache.get(projectDir);
+		return buildGlobs({conf, providers, projectDir, overrideExtensions, overrideFiles});
+	};
+}
+
+if (supportsWorkers) {
+	const v8 = require('v8');
+
+	const MAX_DATA_LENGTH_EXCLUSIVE = 100 * 1024; // Allocate 100 KiB to exchange globs.
+
+	if (isMainThread) {
+		const {Worker} = require('worker_threads');
+		let data;
+		let sync;
+		let worker;
+
+		resolveGlobsSync = (projectDir, overrideExtensions, overrideFiles) => {
+			if (worker === undefined) {
+				const dataBuffer = new SharedArrayBuffer(MAX_DATA_LENGTH_EXCLUSIVE);
+				data = new Uint8Array(dataBuffer);
+
+				const syncBuffer = new SharedArrayBuffer(4);
+				sync = new Int32Array(syncBuffer);
+
+				worker = new Worker(__filename, {
+					workerData: {
+						dataBuffer,
+						syncBuffer,
+						firstMessage: {projectDir, overrideExtensions, overrideFiles}
+					}
+				});
+				worker.unref();
+			} else {
+				worker.postMessage({projectDir, overrideExtensions, overrideFiles});
+			}
+
+			Atomics.wait(sync, 0, 0);
+
+			const byteLength = Atomics.exchange(sync, 0, 0);
+			if (byteLength === MAX_DATA_LENGTH_EXCLUSIVE) {
+				throw new Error('Globs are over 100 KiB and cannot be resolved');
+			}
+
+			const globsOrError = v8.deserialize(data.slice(0, byteLength));
+			if (globsOrError instanceof Error) {
+				throw globsOrError;
+			}
+
+			return globsOrError;
+		};
+	} else {
+		const {parentPort, workerData} = require('worker_threads');
+		const data = new Uint8Array(workerData.dataBuffer);
+		const sync = new Int32Array(workerData.syncBuffer);
+
+		const handleMessage = async ({projectDir, overrideExtensions, overrideFiles}) => {
+			let encoded;
+			try {
+				const globs = await resolveGlobs(projectDir, overrideExtensions, overrideFiles);
+				encoded = v8.serialize(globs);
+			} catch (error) {
+				encoded = v8.serialize(error);
+			}
+
+			const byteLength = encoded.length < MAX_DATA_LENGTH_EXCLUSIVE ? encoded.copy(data) : MAX_DATA_LENGTH_EXCLUSIVE;
+			Atomics.store(sync, 0, byteLength);
+			Atomics.notify(sync, 0);
+		};
+
+		parentPort.on('message', handleMessage);
+		handleMessage(workerData.firstMessage);
+		delete workerData.firstMessage;
 	}
+}
+
+const helperCache = new Map();
 
-	const extensions = overrides && overrides.extensions ?
-		normalizeExtensions(overrides.extensions) :
-		normalizeExtensions(conf.extensions, providers);
+function load(projectDir, overrides) {
+	const cacheKey = `${JSON.stringify(overrides)}\n${projectDir}`;
+	if (helperCache.has(cacheKey)) {
+		return helperCache.get(cacheKey);
+	}
 
 	let helperPatterns = [];
 	if (overrides && overrides.helpers !== undefined) {
@@ -55,14 +167,7 @@ function load(projectDir, overrides) {
 		helperPatterns = normalizePatterns(overrides.helpers);
 	}
 
-	const globs = {
-		cwd: projectDir,
-		...normalizeGlobs({
-			extensions,
-			files: overrides && overrides.files ? overrides.files : conf.files,
-			providers
-		})
-	};
+	const globs = resolveGlobsSync(projectDir, overrides && overrides.extensions, overrides && overrides.files);
 
 	const classifyForESLint = file => {
 		const {isTest} = classify(file, globs);

package/lib/api.js

@@ -17,6 +17,7 @@ const RunStatus = require('./run-status');
 const fork = require('./fork');
 const serializeError = require('./serialize-error');
 const {getApplicableLineNumbers} = require('./line-numbers');
+const sharedWorkers = require('./plugin-support/shared-workers');
 
 function resolveModules(modules) {
 	return arrify(modules).map(name => {
@@ -110,21 +111,15 @@ class Api extends Emittery {
 			}
 		};
 
-		let cacheDir;
 		let testFiles;
 		try {
-			cacheDir = this._createCacheDir();
 			testFiles = await globs.findTests({cwd: this.options.projectDir, ...apiOptions.globs});
 			if (selectedFiles.length === 0) {
-				if (filter.length === 0) {
-					selectedFiles = testFiles;
-				} else {
-					selectedFiles = globs.applyTestFileFilter({
-						cwd: this.options.projectDir,
-						filter: filter.map(({pattern}) => pattern),
-						testFiles
-					});
-				}
+				selectedFiles = filter.length === 0 ? testFiles : globs.applyTestFileFilter({
+					cwd: this.options.projectDir,
+					filter: filter.map(({pattern}) => pattern),
+					testFiles
+				});
 			}
 		} catch (error) {
 			selectedFiles = [];
@@ -192,7 +187,7 @@ class Api extends Emittery {
 
 			const {providers = []} = this.options;
 			const providerStates = (await Promise.all(providers.map(async ({type, main}) => {
-				const state = await main.compile({cacheDir, files: testFiles});
+				const state = await main.compile({cacheDir: this._createCacheDir(), files: testFiles});
 				return state === null ? null : {type, state};
 			}))).filter(state => state !== null);
 
@@ -206,6 +201,8 @@ class Api extends Emittery {
 				concurrency = 1;
 			}
 
+			const deregisteredSharedWorkers = [];
+
 			// Try and run each file, limited by `concurrency`.
 			await pMap(selectedFiles, async file => {
 				// No new files should be run once a test has timed out or failed,
@@ -231,6 +228,7 @@ class Api extends Emittery {
 
 				const worker = fork(file, options, apiOptions.nodeArguments);
 				runStatus.observeWorker(worker, file, {selectingLines: lineNumbers.length > 0});
+				deregisteredSharedWorkers.push(sharedWorkers.observeWorkerProcess(worker, runStatus));
 
 				pendingWorkers.add(worker);
 				worker.promise.then(() => {
@@ -238,8 +236,11 @@ class Api extends Emittery {
 				});
 				restartTimer();
 
-				return worker.promise;
+				await worker.promise;
 			}, {concurrency, stopOnError: false});
+
+			// Allow shared workers to clean up before the run ends.
+			await Promise.all(deregisteredSharedWorkers);
 		} catch (error) {
 			if (error && error.name === 'AggregateError') {
 				for (const err of error) {

package/lib/assert.js

@@ -87,8 +87,16 @@ function getErrorWithLongStackTrace() {
 	return err;
 }
 
-function validateExpectations(assertion, expectations, numberArgs) { // eslint-disable-line complexity
+function validateExpectations(assertion, expectations, numberArgs, experiments) { // eslint-disable-line complexity
 	if (numberArgs === 1 || expectations === null || expectations === undefined) {
+		if (experiments.disableNullExpectations && expectations === null) {
+			throw new AssertionError({
+				assertion,
+				message: `The second argument to \`t.${assertion}()\` must be an expectation object or \`undefined\``,
+				values: [formatWithLabel('Called with:', expectations)]
+			});
+		}
+
 		expectations = {};
 	} else if (
 		typeof expectations === 'function' ||
@@ -465,7 +473,7 @@ class Assertions {
 			}
 
 			try {
-				expectations = validateExpectations('throws', expectations, args.length);
+				expectations = validateExpectations('throws', expectations, args.length, experiments);
 			} catch (error) {
 				fail(error);
 				return;
@@ -531,7 +539,7 @@ class Assertions {
 			}
 
 			try {
-				expectations = validateExpectations('throwsAsync', expectations, args.length);
+				expectations = validateExpectations('throwsAsync', expectations, args.length, experiments);
 			} catch (error) {
 				fail(error);
 				return Promise.resolve();

package/lib/cli.js

@@ -7,7 +7,7 @@ const arrify = require('arrify');
 const yargs = require('yargs');
 const readPkg = require('read-pkg');
 const isCi = require('./is-ci');
-const loadConfig = require('./load-config');
+const {loadConfig} = require('./load-config');
 
 function exit(message) {
 	console.error(`\n  ${require('./chalk').get().red(figures.cross)} ${message}`);
@@ -83,7 +83,7 @@ exports.run = async () => { // eslint-disable-line complexity
 	let confError = null;
 	try {
 		const {argv: {config: configFile}} = yargs.help(false);
-		conf = loadConfig({configFile});
+		conf = await loadConfig({configFile});
 	} catch (error) {
 		confError = error;
 	}
@@ -409,35 +409,33 @@ exports.run = async () => { // eslint-disable-line complexity
 		workerArgv: argv['--']
 	});
 
-	let reporter;
-	if (combined.tap && !combined.watch && debug === null) {
-		reporter = new TapReporter({
-			projectDir,
-			reportStream: process.stdout,
-			stdStream: process.stderr
-		});
-	} else {
-		reporter = new DefaultReporter({
-			projectDir,
-			reportStream: process.stdout,
-			stdStream: process.stderr,
-			watching: combined.watch,
-			verbose: debug !== null || combined.verbose || isCi || !process.stdout.isTTY
-		});
-	}
+	const reporter = combined.tap && !combined.watch && debug === null ? new TapReporter({
+		projectDir,
+		reportStream: process.stdout,
+		stdStream: process.stderr
+	}) : new DefaultReporter({
+		projectDir,
+		reportStream: process.stdout,
+		stdStream: process.stderr,
+		watching: combined.watch,
+		verbose: debug !== null || combined.verbose || isCi || !process.stdout.isTTY
+	});
 
 	api.on('run', plan => {
 		reporter.startRun(plan);
 
 		if (process.env.AVA_EMIT_RUN_STATUS_OVER_IPC === 'I\'ll find a payphone baby / Take some time to talk to you') {
-			if (process.versions.node >= '12.17.0') {
+			const {controlFlow} = require('./ipc-flow-control');
+			const bufferedSend = controlFlow(process);
+
+			if (process.versions.node >= '12.16.0') {
 				plan.status.on('stateChange', evt => {
-					process.send(evt);
+					bufferedSend(evt);
 				});
 			} else {
 				const v8 = require('v8');
 				plan.status.on('stateChange', evt => {
-					process.send([...v8.serialize(evt)]);
+					bufferedSend([...v8.serialize(evt)]);
 				});
 			}
 		}

package/lib/concordance-options.js

@@ -1,5 +1,5 @@
 'use strict';
-const util = require('util');
+const util = require('util'); // eslint-disable-line unicorn/import-style
 const ansiStyles = require('ansi-styles');
 const stripAnsi = require('strip-ansi');
 const cloneDeepWith = require('lodash/cloneDeepWith');

package/lib/fork.js

@@ -12,16 +12,57 @@ if (fs.realpathSync(__filename) !== __filename) {
 // In case the test file imports a different AVA install,
 // the presence of this variable allows it to require this one instead
 const AVA_PATH = path.resolve(__dirname, '..');
+const WORKER_PATH = require.resolve('./worker/subprocess');
+
+class SharedWorkerChannel extends Emittery {
+	constructor({channelId, filename, initialData}, sendToFork) {
+		super();
+
+		this.id = channelId;
+		this.filename = filename;
+		this.initialData = initialData;
+		this.sendToFork = sendToFork;
+	}
+
+	signalReady() {
+		this.sendToFork({
+			type: 'shared-worker-ready',
+			channelId: this.id
+		});
+	}
+
+	signalError() {
+		this.sendToFork({
+			type: 'shared-worker-error',
+			channelId: this.id
+		});
+	}
 
-const workerPath = require.resolve('./worker/subprocess');
+	emitMessage({messageId, replyTo, serializedData}) {
+		this.emit('message', {
+			messageId,
+			replyTo,
+			serializedData
+		});
+	}
+
+	forwardMessageToFork({messageId, replyTo, serializedData}) {
+		this.sendToFork({
+			type: 'shared-worker-message',
+			channelId: this.id,
+			messageId,
+			replyTo,
+			serializedData
+		});
+	}
+}
 
-const useAdvanced = process.versions.node >= '12.17.0';
-// FIXME: Fix this in api.js or cli.js.
-const serializeOptions = useAdvanced ?
-	options => JSON.parse(JSON.stringify(options)) : // Use JSON serialization to remove non-clonable values.
-	options => options;
+let forkCounter = 0;
 
 module.exports = (file, options, execArgv = process.execArgv) => {
+	const forkId = `fork/${++forkCounter}`;
+	const sharedWorkerChannels = new Map();
+
 	let finished = false;
 
 	const emitter = new Emittery();
@@ -32,17 +73,17 @@ module.exports = (file, options, execArgv = process.execArgv) => {
 	};
 
 	options = {
-		file,
 		baseDir: process.cwd(),
+		file,
+		forkId,
 		...options
 	};
 
-	const subprocess = childProcess.fork(workerPath, options.workerArgv, {
+	const subprocess = childProcess.fork(WORKER_PATH, options.workerArgv, {
 		cwd: options.projectDir,
 		silent: true,
 		env: {NODE_ENV: 'test', ...process.env, ...options.environmentVariables, AVA_PATH},
-		execArgv,
-		serialization: useAdvanced ? 'advanced' : 'json'
+		execArgv
 	});
 
 	subprocess.stdout.on('data', chunk => {
@@ -73,15 +114,25 @@ module.exports = (file, options, execArgv = process.execArgv) => {
 				return;
 			}
 
-			if (message.ava.type === 'ready-for-options') {
-				send({type: 'options', options: serializeOptions(options)});
-				return;
-			}
-
-			if (message.ava.type === 'ping') {
-				send({type: 'pong'});
-			} else {
-				emitStateChange(message.ava);
+			switch (message.ava.type) {
+				case 'ready-for-options':
+					send({type: 'options', options});
+					break;
+				case 'shared-worker-connect': {
+					const channel = new SharedWorkerChannel(message.ava, send);
+					sharedWorkerChannels.set(channel.id, channel);
+					emitter.emit('connectSharedWorker', channel);
+					break;
+				}
+
+				case 'shared-worker-message':
+					sharedWorkerChannels.get(message.ava.channelId).emitMessage(message.ava);
+					break;
+				case 'ping':
+					send({type: 'pong'});
+					break;
+				default:
+					emitStateChange(message.ava);
 			}
 		});
 
@@ -106,6 +157,10 @@ module.exports = (file, options, execArgv = process.execArgv) => {
 	});
 
 	return {
+		file,
+		forkId,
+		promise,
+
 		exit() {
 			forcedExit = true;
 			subprocess.kill();
@@ -115,11 +170,12 @@ module.exports = (file, options, execArgv = process.execArgv) => {
 			send({type: 'peer-failed'});
 		},
 
-		onStateChange(listener) {
-			return emitter.on('stateChange', listener);
+		onConnectSharedWorker(listener) {
+			return emitter.on('connectSharedWorker', listener);
 		},
 
-		file,
-		promise
+		onStateChange(listener) {
+			return emitter.on('stateChange', listener);
+		}
 	};
 };

package/lib/globs.js

@@ -82,11 +82,7 @@ function normalizeGlobs({extensions, files: filePatterns, ignoredByWatcher: igno
 		filePatterns = defaultTestPatterns;
 	}
 
-	if (ignoredByWatcherPatterns) {
-		ignoredByWatcherPatterns = [...defaultIgnoredByWatcherPatterns, ...normalizePatterns(ignoredByWatcherPatterns)];
-	} else {
-		ignoredByWatcherPatterns = [...defaultIgnoredByWatcherPatterns];
-	}
+	ignoredByWatcherPatterns = ignoredByWatcherPatterns ? [...defaultIgnoredByWatcherPatterns, ...normalizePatterns(ignoredByWatcherPatterns)] : [...defaultIgnoredByWatcherPatterns];
 
 	for (const {level, main} of providers) {
 		if (level >= providerManager.levels.pathRewrites) {

package/lib/ipc-flow-control.js

@@ -1,40 +1,37 @@
-// Manage how quickly messages are delivered to the channel. In theory, we
-// should be able to call `send()` until it returns `false` but this leads to
-// crashes with advanced serialization, see
-// <https://github.com/nodejs/node/issues/34797>.
-//
-// Even if that's fixed (and the Node.js versions with the fixes are the
-// minimally supported versions) we need flow control based on `send()`'s return
-// value.
-
-const nowAndTimers = require('./now-and-timers');
-
 function controlFlow(channel) {
-	let sending = false;
+	let errored = false;
+	let deliverImmediately = true;
 
-	const buffer = [];
-	const deliverNext = () => {
-		if (!channel.connected) {
-			buffer.length = 0;
+	const backlog = [];
+	const deliverNext = error => {
+		if (error !== null) {
+			errored = true;
 		}
 
-		if (buffer.length === 0) {
-			sending = false;
-			return;
+		if (errored || !channel.connected) {
+			backlog.length = 0; // Free memory.
+			return; // We can't send.
+		}
+
+		let ok = true;
+		while (ok && backlog.length > 0) { // Stop sending after backpressure.
+			ok = channel.send(backlog.shift(), deliverNext);
 		}
 
-		channel.send(buffer.shift(), deliverNext);
+		// Re-enable immediate delivery if there is no backpressure and the backlog
+		// has been cleared.
+		deliverImmediately = ok && backlog.length === 0;
 	};
 
 	return message => {
-		if (!channel.connected) {
+		if (errored || !channel.connected) {
 			return;
 		}
 
-		buffer.push(message);
-		if (!sending) {
-			sending = true;
-			nowAndTimers.setImmediate(deliverNext);
+		if (deliverImmediately) {
+			deliverImmediately = channel.send(message, deliverNext);
+		} else {
+			backlog.push(message);
 		}
 	};
 }