ava 5.3.1 → 6.0.0

package/lib/worker/base.js

@@ -1,9 +1,12 @@
+import {mkdir} from 'node:fs/promises';
 import {createRequire} from 'node:module';
+import {join as joinPath, resolve as resolvePath} from 'node:path';
 import process from 'node:process';
 import {pathToFileURL} from 'node:url';
 import {workerData} from 'node:worker_threads';
 
 import setUpCurrentlyUnhandled from 'currently-unhandled';
+import writeFileAtomic from 'write-file-atomic';
 
 import {set as setChalk} from '../chalk.js';
 import nowAndTimers from '../now-and-timers.cjs';
@@ -12,7 +15,6 @@ import Runner from '../runner.js';
 import serializeError from '../serialize-error.js';
 
 import channel from './channel.cjs';
-import dependencyTracking from './dependency-tracker.js';
 import lineNumberSelection from './line-numbers.js';
 import {set as setOptions} from './options.cjs';
 import {flags, refs, sharedWorkerTeardowns} from './state.cjs';
@@ -21,37 +23,26 @@ import {isRunningInThread, isRunningInChildProcess} from './utils.cjs';
 const currentlyUnhandled = setUpCurrentlyUnhandled();
 let runner;
 
+let forcingExit = false;
+
+const forceExit = () => {
+	forcingExit = true;
+	process.exit(1);
+};
+
 // Override process.exit with an undetectable replacement
 // to report when it is called from a test (which it should never be).
-const {apply} = Reflect;
-const realExit = process.exit;
-
-async function exit(code, forceSync = false) {
-	dependencyTracking.flush();
-	const flushing = channel.flush();
-	if (!forceSync) {
-		await flushing;
+const handleProcessExit = (target, thisArg, args) => {
+	if (!forcingExit) {
+		const error = new Error('Unexpected process.exit()');
+		Error.captureStackTrace(error, handleProcessExit);
+		channel.send({type: 'process-exit', stack: error.stack});
 	}
 
-	apply(realExit, process, [code]);
-}
-
-const handleProcessExit = (fn, receiver, args) => {
-	const error = new Error('Unexpected process.exit()');
-	Error.captureStackTrace(error, handleProcessExit);
-	const {stack} = serializeError('', true, error);
-	channel.send({type: 'process-exit', stack});
-
-	// Make sure to extract the code only from `args` rather than e.g. `Array.prototype`.
-	// This level of paranoia is usually unwarranted, but we're dealing with test code
-	// that has already colored outside the lines.
-	const code = args.length > 0 ? args[0] : undefined;
-
-	// Force a synchronous exit as guaranteed by the real process.exit().
-	exit(code, true);
+	target.apply(thisArg, args);
 };
 
-process.exit = new Proxy(realExit, {
+process.exit = new Proxy(process.exit, {
 	apply: handleProcessExit,
 });
 
@@ -71,7 +62,7 @@ const run = async options => {
 			lineNumbers: options.lineNumbers,
 		});
 	} catch (error) {
-		channel.send({type: 'line-number-selection-error', err: serializeError('Line number selection error', false, error, options.file)});
+		channel.send({type: 'line-number-selection-error', err: serializeError(error)});
 		checkSelectedByLineNumbers = () => false;
 	}
 
@@ -96,12 +87,12 @@ const run = async options => {
 		runner.interrupt();
 	});
 
-	runner.on('dependency', dependencyTracking.track);
+	runner.on('accessed-snapshots', filename => channel.send({type: 'accessed-snapshots', filename}));
 	runner.on('stateChange', state => channel.send(state));
 
 	runner.on('error', error => {
-		channel.send({type: 'internal-error', err: serializeError('Internal runner error', false, error, runner.file)});
-		exit(1);
+		channel.send({type: 'internal-error', err: serializeError(error)});
+		forceExit();
 	});
 
 	runner.on('finish', async () => {
@@ -111,31 +102,36 @@ const run = async options => {
 				channel.send({type: 'touched-files', files: touchedFiles});
 			}
 		} catch (error) {
-			channel.send({type: 'internal-error', err: serializeError('Internal runner error', false, error, runner.file)});
-			exit(1);
+			channel.send({type: 'internal-error', err: serializeError(error)});
+			forceExit();
 			return;
 		}
 
 		try {
 			await Promise.all(sharedWorkerTeardowns.map(fn => fn()));
 		} catch (error) {
-			channel.send({type: 'uncaught-exception', err: serializeError('Shared worker teardown error', false, error, runner.file)});
-			exit(1);
+			channel.send({type: 'uncaught-exception', err: serializeError(error)});
+			forceExit();
 			return;
 		}
 
 		nowAndTimers.setImmediate(() => {
-			for (const rejection of currentlyUnhandled()) {
-				channel.send({type: 'unhandled-rejection', err: serializeError('Unhandled rejection', true, rejection.reason, runner.file)});
+			const unhandled = currentlyUnhandled();
+			if (unhandled.length === 0) {
+				return;
 			}
 
-			exit(0);
+			for (const rejection of unhandled) {
+				channel.send({type: 'unhandled-rejection', err: serializeError(rejection.reason, {testFile: options.file})});
+			}
+
+			forceExit();
 		});
 	});
 
 	process.on('uncaughtException', error => {
-		channel.send({type: 'uncaught-exception', err: serializeError('Uncaught exception', true, error, runner.file)});
-		exit(1);
+		channel.send({type: 'uncaught-exception', err: serializeError(error, {testFile: options.file})});
+		forceExit();
 	});
 
 	// Store value to prevent required modules from modifying it.
@@ -149,9 +145,9 @@ const run = async options => {
 	// require configuration the *compiled* helper will be loaded.
 	const {projectDir, providerStates = []} = options;
 	const providers = [];
-	await Promise.all(providerStates.map(async ({type, state}) => {
+	await Promise.all(providerStates.map(async ({type, state, protocol}) => {
 		if (type === 'typescript') {
-			const provider = await providerManager.typescript(projectDir);
+			const provider = await providerManager.typescript(projectDir, {protocol});
 			providers.push(provider.worker({extensionsToLoadAsModules, state}));
 		}
 	}));
@@ -174,16 +170,59 @@ const run = async options => {
 		return require(ref);
 	};
 
-	try {
-		for await (const ref of (options.require || [])) {
-			await load(ref);
+	const loadRequiredModule = async ref => {
+		// If the provider can load the module, assume it's a local file and not a
+		// dependency.
+		for (const provider of providers) {
+			if (provider.canLoad(ref)) {
+				return provider.load(ref, {requireFn: require});
+			}
 		}
 
-		// Install dependency tracker after the require configuration has been evaluated
-		// to make sure we also track dependencies with custom require hooks
-		dependencyTracking.install(require.extensions, testPath);
+		// Try to load the module as a file, relative to the project directory.
+		// Match load() behavior.
+		const fullPath = resolvePath(projectDir, ref);
+		try {
+			for (const extension of extensionsToLoadAsModules) {
+				if (fullPath.endsWith(`.${extension}`)) {
+					return await import(pathToFileURL(fullPath)); // eslint-disable-line no-await-in-loop
+				}
+			}
+
+			return require(fullPath);
+		} catch (error) {
+			// If the module could not be found, assume it's not a file but a dependency.
+			if (error.code === 'ERR_MODULE_NOT_FOUND' || error.code === 'MODULE_NOT_FOUND') {
+				return importFromProject(ref);
+			}
+
+			throw error;
+		}
+	};
+
+	let importFromProject = async ref => {
+		// Do not use the cacheDir since it's not guaranteed to be inside node_modules.
+		const avaCacheDir = joinPath(projectDir, 'node_modules', '.cache', 'ava');
+		await mkdir(avaCacheDir, {recursive: true});
+		const stubPath = joinPath(avaCacheDir, 'import-from-project.mjs');
+		await writeFileAtomic(stubPath, 'export const importFromProject = ref => import(ref);\n');
+		({importFromProject} = await import(pathToFileURL(stubPath)));
+		return importFromProject(ref);
+	};
+
+	try {
+		for await (const [ref, ...args] of (options.require ?? [])) {
+			const loadedModule = await loadRequiredModule(ref);
+
+			if (typeof loadedModule === 'function') { // CJS module
+				await loadedModule(...args);
+			} else if (typeof loadedModule.default === 'function') { // ES module, or exports.default from CJS
+				const {default: fn} = loadedModule;
+				await fn(...args);
+			}
+		}
 
-		if (options.debug && options.debug.port !== undefined && options.debug.host !== undefined) {
+		if (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 {default: inspector} = await import('node:inspector');
@@ -205,11 +244,11 @@ const run = async options => {
 			channel.unref();
 		} else {
 			channel.send({type: 'missing-ava-import'});
-			exit(1);
+			forceExit();
 		}
 	} catch (error) {
-		channel.send({type: 'uncaught-exception', err: serializeError('Uncaught exception', true, error, runner.file)});
-		exit(1);
+		channel.send({type: 'uncaught-exception', err: serializeError(error, {testFile: options.file})});
+		forceExit();
 	}
 };
 

package/lib/worker/channel.cjs

@@ -7,42 +7,14 @@ const timers = require('../now-and-timers.cjs');
 
 const {isRunningInChildProcess, isRunningInThread} = require('./utils.cjs');
 
-let pEvent = async (emitter, event, options) => {
-	// We need to import p-event, but import() is asynchronous. Buffer any events
-	// emitted in the meantime. Don't handle errors.
-	const buffer = [];
-	const addToBuffer = (...args) => buffer.push(args);
-	emitter.on(event, addToBuffer);
-
-	try {
-		({pEvent} = await import('p-event'));
-	} finally {
-		emitter.off(event, addToBuffer);
-	}
-
-	if (buffer.length === 0) {
-		return pEvent(emitter, event, options);
-	}
-
-	// Now replay buffered events.
-	const replayEmitter = new events.EventEmitter();
-	const promise = pEvent(replayEmitter, event, options);
-	for (const args of buffer) {
-		replayEmitter.emit(event, ...args);
-	}
-
-	const replay = (...args) => replayEmitter.emit(event, ...args);
-	emitter.on(event, replay);
-
-	try {
-		return await promise;
-	} finally {
-		emitter.off(event, replay);
+const selectAvaMessage = async (channel, type) => {
+	for await (const [message] of events.on(channel, 'message')) {
+		if (message.ava?.type === type) {
+			return message;
+		}
 	}
 };
 
-const selectAvaMessage = type => message => message.ava && message.ava.type === type;
-
 class RefCounter {
 	constructor() {
 		this.count = 0;
@@ -133,27 +105,11 @@ if (isRunningInChildProcess) {
 // Node.js. In order to keep track, explicitly reference before attaching.
 handle.ref();
 
-exports.options = pEvent(handle.channel, 'message', selectAvaMessage('options')).then(message => message.ava.options); // eslint-disable-line unicorn/prefer-top-level-await
-exports.peerFailed = pEvent(handle.channel, 'message', selectAvaMessage('peer-failed'));
+exports.options = selectAvaMessage(handle.channel, 'options').then(message => message.ava.options);
+exports.peerFailed = selectAvaMessage(handle.channel, 'peer-failed');
 exports.send = handle.send.bind(handle);
 exports.unref = handle.unref.bind(handle);
 
-let pendingPings = Promise.resolve();
-async function flush() {
-	handle.ref();
-	const promise = pendingPings.then(async () => {
-		handle.send({type: 'ping'});
-		await pEvent(handle.channel, 'message', selectAvaMessage('pong'));
-		if (promise === pendingPings) {
-			handle.unref();
-		}
-	});
-	pendingPings = promise;
-	await promise;
-}
-
-exports.flush = flush;
-
 let channelCounter = 0;
 let messageCounter = 0;
 
@@ -202,7 +158,7 @@ function registerSharedWorker(filename, initialData) {
 	// The attaching of message listeners will cause the port to be referenced by
 	// Node.js. In order to keep track, explicitly reference before attaching.
 	sharedWorkerHandle.ref();
-	const ready = pEvent(ourPort, 'message', ({type}) => type === 'ready').then(() => {
+	const ready = selectAvaMessage(ourPort, 'ready').then(() => {
 		currentlyAvailable = error === null;
 	}).finally(() => {
 		// Once ready, it's up to user code to subscribe to messages, which (see
@@ -214,7 +170,7 @@ function registerSharedWorker(filename, initialData) {
 
 	// Errors are received over the test worker channel, not the message port
 	// dedicated to the shared worker.
-	pEvent(channelEmitter, 'shared-worker-error').then(() => {
+	events.once(channelEmitter, 'shared-worker-error').then(() => {
 		unsubscribe();
 		sharedWorkerHandle.forceUnref();
 		error = new Error('The shared worker is no longer available');

package/license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ava",
-	"version": "5.3.1",
+	"version": "6.0.0",
 	"description": "Node.js test runner that lets you develop with confidence.",
 	"license": "MIT",
 	"repository": "avajs/ava",
@@ -11,7 +11,7 @@
 	"exports": {
 		".": {
 			"import": {
-				"types": "./entrypoints/main.d.ts",
+				"types": "./entrypoints/main.d.mts",
 				"default": "./entrypoints/main.mjs"
 			},
 			"require": {
@@ -22,22 +22,24 @@
 		"./eslint-plugin-helper": "./entrypoints/eslint-plugin-helper.cjs",
 		"./plugin": {
 			"import": {
-				"types": "./entrypoints/plugin.d.ts",
+				"types": "./entrypoints/plugin.d.mts",
 				"default": "./entrypoints/plugin.mjs"
 			},
 			"require": {
 				"types": "./entrypoints/plugin.d.cts",
 				"default": "./entrypoints/plugin.cjs"
 			}
+		},
+		"./internal": {
+			"types": "./entrypoints/internal.d.mts"
 		}
 	},
 	"type": "module",
 	"engines": {
-		"node": ">=14.19 <15 || >=16.15 <17 || >=18"
+		"node": "^18.18 || ^20.8 || ^21"
 	},
 	"scripts": {
-		"cover": "c8 --report=none test-ava && c8 --report=none --no-clean tap && c8 report",
-		"test": "xo && tsc --noEmit && npm run -s cover"
+		"test": "./scripts/test.sh"
 	},
 	"files": [
 		"entrypoints",
@@ -81,45 +83,42 @@
 		"typescript"
 	],
 	"dependencies": {
-		"acorn": "^8.8.2",
-		"acorn-walk": "^8.2.0",
+		"@vercel/nft": "^0.24.4",
+		"acorn": "^8.11.2",
+		"acorn-walk": "^8.3.0",
 		"ansi-styles": "^6.2.1",
 		"arrgv": "^1.0.2",
 		"arrify": "^3.0.0",
-		"callsites": "^4.0.0",
-		"cbor": "^8.1.0",
-		"chalk": "^5.2.0",
-		"chokidar": "^3.5.3",
+		"callsites": "^4.1.0",
+		"cbor": "^9.0.1",
+		"chalk": "^5.3.0",
 		"chunkd": "^2.0.1",
-		"ci-info": "^3.8.0",
+		"ci-info": "^4.0.0",
 		"ci-parallel-vars": "^1.0.1",
-		"clean-yaml-object": "^0.1.0",
-		"cli-truncate": "^3.1.0",
+		"cli-truncate": "^4.0.0",
 		"code-excerpt": "^4.0.0",
 		"common-path-prefix": "^3.0.0",
 		"concordance": "^5.0.4",
 		"currently-unhandled": "^0.4.1",
 		"debug": "^4.3.4",
 		"emittery": "^1.0.1",
-		"figures": "^5.0.0",
-		"globby": "^13.1.4",
+		"figures": "^6.0.1",
+		"globby": "^14.0.0",
 		"ignore-by-default": "^2.1.0",
 		"indent-string": "^5.0.0",
-		"is-error": "^2.2.2",
 		"is-plain-object": "^5.0.0",
 		"is-promise": "^4.0.0",
 		"matcher": "^5.0.0",
-		"mem": "^9.0.2",
+		"memoize": "^10.0.0",
 		"ms": "^2.1.3",
-		"p-event": "^5.0.1",
-		"p-map": "^5.5.0",
-		"picomatch": "^2.3.1",
-		"pkg-conf": "^4.0.0",
+		"p-map": "^6.0.0",
+		"package-config": "^5.0.0",
+		"picomatch": "^3.0.1",
 		"plur": "^5.1.0",
 		"pretty-ms": "^8.0.0",
 		"resolve-cwd": "^3.0.0",
 		"stack-utils": "^2.0.6",
-		"strip-ansi": "^7.0.1",
+		"strip-ansi": "^7.1.0",
 		"supertap": "^3.0.1",
 		"temp-dir": "^3.0.0",
 		"write-file-atomic": "^5.0.1",
@@ -127,24 +126,19 @@
 	},
 	"devDependencies": {
 		"@ava/test": "github:avajs/test",
-		"@ava/typescript": "^4.0.0",
-		"@sindresorhus/tsconfig": "^3.0.1",
+		"@ava/typescript": "^4.1.0",
+		"@sindresorhus/tsconfig": "^5.0.0",
+		"@types/node": "^20.10.3",
 		"ansi-escapes": "^6.2.0",
-		"c8": "^7.13.0",
-		"delay": "^5.0.0",
-		"execa": "^7.1.1",
-		"expect": "^29.5.0",
-		"fs-extra": "^11.1.1",
-		"get-stream": "^6.0.1",
-		"replace-string": "^4.0.0",
-		"sinon": "^15.1.0",
-		"tap": "^16.3.4",
-		"temp-write": "^5.0.0",
-		"tempy": "^3.0.0",
-		"touch": "^3.1.0",
-		"tsd": "^0.28.1",
-		"typescript": "^4.9.5",
-		"xo": "^0.54.2",
+		"c8": "^8.0.1",
+		"execa": "^8.0.1",
+		"expect": "^29.7.0",
+		"sinon": "^17.0.1",
+		"tap": "^18.6.1",
+		"tempy": "^3.1.0",
+		"tsd": "^0.29.0",
+		"typescript": "~5.3.2",
+		"xo": "^0.56.0",
 		"zen-observable": "^0.10.0"
 	},
 	"peerDependencies": {
@@ -156,6 +150,6 @@
 		}
 	},
 	"volta": {
-		"node": "20.2.0"
+		"node": "20.10.0"
 	}
 }

package/readme.md

@@ -1,10 +1,12 @@
-[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine/)
+*[Please support our friend Vadim Demedes and the people in Ukraine.](https://stand-with-ukraine.pp.ua/)*
+
+---
 
 # <img src="media/header.png" title="AVA" alt="AVA logo" width="530">
 
-AVA is a test runner for Node.js with a concise API, detailed error output, embrace of new language features and process isolation that lets you develop with confidence 🚀
+AVA is a test runner for Node.js with a concise API, detailed error output, embrace of new language features and htread isolation that lets you develop with confidence 🚀
 
-Follow the [AVA Twitter account](https://twitter.com/ava__js) for updates.
+Watch this repository and follow the [Discussions](https://github.com/avajs/ava/discussions) for updates.
 
 Read our [contributing guide](.github/CONTRIBUTING.md) if you're looking to contribute (issues / PRs / etc).
 
@@ -23,7 +25,7 @@ Translations: [Español](https://github.com/avajs/ava-docs/blob/main/es_ES/readm
 - No implicit globals
 - Includes TypeScript definitions
 - [Magic assert](#magic-assert)
-- [Isolated environment for each test file](./docs/01-writing-tests.md#process-isolation)
+- [Isolated environment for each test file](./docs/01-writing-tests.md#test-isolation)
 - [Promise support](./docs/01-writing-tests.md#promise-support)
 - [Async function support](./docs/01-writing-tests.md#async-function-support)
 - [Observable support](./docs/01-writing-tests.md#observable-support)
@@ -166,14 +168,6 @@ We have a growing list of [common pitfalls](docs/08-common-pitfalls.md) you may
 
 ## FAQ
 
-### Why not `mocha`, `tape`, `tap`?
-
-Mocha requires you to use implicit globals like `describe` and `it` with the default interface (which most people use). It's not very opinionated and executes tests serially without process isolation, making it slow.
-
-Tape and tap are pretty good. AVA is highly inspired by their syntax. They too execute tests serially. Their default [TAP](https://testanything.org) output isn't very user-friendly though so you always end up using an external tap reporter.
-
-In contrast AVA is highly opinionated and runs tests concurrently, with a separate process for each test file. Its default reporter is easy on the eyes and yet AVA still supports TAP output through a CLI flag.
-
 ### How is the name written and pronounced?
 
 AVA, not Ava or ava. Pronounced [`/ˈeɪvə/`](media/pronunciation.m4a?raw=true): Ay (f**a**ce, m**a**de) V (**v**ie, ha**v**e) A (comm**a**, **a**go)