Ensure ava/plugin works in a CJS environment

Refactor and deploy some tricks so that ava/plugin is usable in a CJS environment, even if the rest of AVA's internals become ESM.

entrypoints/plugin.cjs

@@ -1,2 +1,2 @@
 'use strict';
-module.exports = require('../lib/worker/plugin');
+module.exports = require('../lib/worker/plugin.cjs');

lib/runner.js

@@ -7,6 +7,7 @@ const parseTestArgs = require('./parse-test-args');
 const snapshotManager = require('./snapshot-manager');
 const serializeError = require('./serialize-error');
 const Runnable = require('./test');
+const {waitForReady} = require('./worker/state.cjs');
 
 class Runner extends Emittery {
 	constructor(options = {}) {
@@ -53,7 +54,7 @@ class Runner extends Emittery {
 			serial: [],
 			todo: []
 		};
-		this.waitForReady = [];
+		this.waitForReady = waitForReady;
 
 		const uniqueTestTitles = new Set();
 		this.registerUniqueTitle = title => {

lib/test.js

@@ -3,7 +3,7 @@ const concordance = require('concordance');
 const isPromise = require('is-promise');
 const plur = require('plur');
 const assert = require('./assert');
-const nowAndTimers = require('./now-and-timers');
+const nowAndTimers = require('./now-and-timers.cjs');
 const parseTestArgs = require('./parse-test-args');
 const concordanceOptions = require('./concordance-options').default;
 

lib/worker/base.js

@@ -1,43 +1,27 @@
 'use strict';
 const {pathToFileURL} = require('url');
-const path = require('path');
 const currentlyUnhandled = require('currently-unhandled')();
-const {isRunningInThread, isRunningInChildProcess} = require('./utils');
+const {isRunningInThread, isRunningInChildProcess} = require('./utils.cjs');
 
-// Check if the test is being run without AVA cli
-if (!isRunningInChildProcess && !isRunningInThread) {
-	const chalk = require('chalk'); // Use default Chalk instance.
-	if (process.argv[1]) {
-		const fp = path.relative('.', process.argv[1]);
-
-		console.log();
-		console.error(`Test files must be run with the AVA CLI:\n\n    ${chalk.grey.dim('$')} ${chalk.cyan('ava ' + fp)}\n`);
-
-		process.exit(1);
-	} else {
-		throw new Error('The ’ava’ module can only be imported in test files');
-	}
-}
-
-const channel = require('./channel');
+const channel = require('./channel.cjs');
 
 const run = async options => {
-	require('./options').set(options);
+	require('./options.cjs').set(options);
 	require('../chalk').set(options.chalkOptions);
 
 	if (options.chalkOptions.level > 0) {
 		const {stdout, stderr} = process;
 		global.console = Object.assign(global.console, new console.Console({stdout, stderr, colorMode: true}));
 	}
 
-	const nowAndTimers = require('../now-and-timers');
+	const nowAndTimers = require('../now-and-timers.cjs');
 	const providerManager = require('../provider-manager');
 	const Runner = require('../runner');
 	const serializeError = require('../serialize-error');
 	const dependencyTracking = require('./dependency-tracker');
 	const lineNumberSelection = require('./line-numbers');
 
-	const sharedWorkerTeardowns = [];
+	const {sharedWorkerTeardowns} = require('./state.cjs');
 
 	async function exit(code) {
 		if (!process.exitCode) {
@@ -140,19 +124,6 @@ const run = async options => {
 		return runner;
 	};
 
-	exports.registerSharedWorker = (filename, initialData, teardown) => {
-		const {channel: sharedWorkerChannel, forceUnref, ready} = channel.registerSharedWorker(filename, initialData);
-		runner.waitForReady.push(ready);
-		sharedWorkerTeardowns.push(async () => {
-			try {
-				await teardown();
-			} finally {
-				forceUnref();
-			}
-		});
-		return sharedWorkerChannel;
-	};
-
 	// Store value to prevent required modules from modifying it.
 	const testPath = options.file;
 

lib/worker/channel.js → lib/worker/channel.cjs

@@ -4,9 +4,9 @@ const {MessageChannel} = require('worker_threads');
 
 const pEvent = require('p-event');
 
-const timers = require('../now-and-timers');
-const {get: getOptions} = require('./options');
-const {isRunningInChildProcess, isRunningInThread} = require('./utils');
+const timers = require('../now-and-timers.cjs');
+const {get: getOptions} = require('./options.cjs');
+const {isRunningInChildProcess, isRunningInThread} = require('./utils.cjs');
 
 const selectAvaMessage = type => message => message.ava && message.ava.type === type;
 

lib/worker/dependency-tracker.js

@@ -1,6 +1,6 @@
 /* eslint-disable node/no-deprecated-api */
 'use strict';
-const channel = require('./channel');
+const channel = require('./channel.cjs');
 
 const seenDependencies = new Set();
 let newDependencies = [];

lib/worker/guard-environment.cjs

@@ -0,0 +1,18 @@
+'use strict';
+const path = require('path');
+const {isRunningInThread, isRunningInChildProcess} = require('./utils.cjs');
+
+// Check if the test is being run without AVA cli
+if (!isRunningInChildProcess && !isRunningInThread) {
+	const chalk = require('chalk'); // Use default Chalk instance.
+	if (process.argv[1]) {
+		const fp = path.relative('.', process.argv[1]);
+
+		console.log();
+		console.error(`Test files must be run with the AVA CLI:\n\n    ${chalk.grey.dim('$')} ${chalk.cyan('ava ' + fp)}\n`);
+
+		process.exit(1); // eslint-disable-line unicorn/no-process-exit
+	} else {
+		throw new Error('The ’ava’ module can only be imported in test files');
+	}
+}

lib/worker/main.js

@@ -1,3 +1,5 @@
 'use strict';
+require('./guard-environment.cjs'); // eslint-disable-line import/no-unassigned-import
+
 const runner = require('./base').getRunner();
 module.exports = runner.chain;

lib/worker/plugin.js → lib/worker/plugin.cjs

@@ -1,12 +1,23 @@
 const pkg = require('../../package.json');
-const baseWorker = require('./base');
-const options = require('./options');
+const {registerSharedWorker: register} = require('./channel.cjs');
+const options = require('./options.cjs');
+const {sharedWorkerTeardowns, waitForReady} = require('./state.cjs');
+
+require('./guard-environment.cjs'); // eslint-disable-line import/no-unassigned-import
 
 const workers = new Map();
 const workerTeardownFns = new WeakMap();
 
 function createSharedWorker(filename, initialData, teardown) {
-	const channel = baseWorker.registerSharedWorker(filename, initialData, teardown);
+	const {channel, forceUnref, ready} = register(filename, initialData, teardown);
+	waitForReady.push(ready);
+	sharedWorkerTeardowns.push(async () => {
+		try {
+			await teardown();
+		} finally {
+			forceUnref();
+		}
+	});
 
 	class ReceivedMessage {
 		constructor(id, data) {

lib/worker/state.cjs

@@ -0,0 +1,3 @@
+'use strict';
+exports.sharedWorkerTeardowns = [];
+exports.waitForReady = [];

test-tap/assert.js

@@ -1,6 +1,6 @@
 'use strict';
 require('../lib/chalk').set();
-require('../lib/worker/options').set({chalkOptions: {level: 0}});
+require('../lib/worker/options.cjs').set({chalkOptions: {level: 0}});
 
 const path = require('path');
 const stripAnsi = require('strip-ansi');

test-tap/hooks.js

@@ -1,6 +1,6 @@
 'use strict';
 require('../lib/chalk').set();
-require('../lib/worker/options').set({});
+require('../lib/worker/options.cjs').set({});
 
 const {test} = require('tap');
 const Runner = require('../lib/runner');

test-tap/promise.js

@@ -1,6 +1,6 @@
 'use strict';
 require('../lib/chalk').set({level: 0});
-require('../lib/worker/options').set({});
+require('../lib/worker/options.cjs').set({});
 
 const {test} = require('tap');
 const Test = require('../lib/test');

test-tap/runner.js

@@ -1,6 +1,6 @@
 'use strict';
 require('../lib/chalk').set();
-require('../lib/worker/options').set({});
+require('../lib/worker/options.cjs').set({});
 
 const delay = require('delay');
 const {test} = require('tap');

test-tap/serialize-error.js

@@ -1,6 +1,6 @@
 'use strict';
 require('../lib/chalk').set();
-require('../lib/worker/options').set({});
+require('../lib/worker/options.cjs').set({});
 
 const {test} = require('tap');
 const avaAssert = require('../lib/assert');

test-tap/test-try-commit.js

@@ -1,6 +1,6 @@
 'use strict';
 require('../lib/chalk').set();
-require('../lib/worker/options').set({chalkOptions: {level: 0}});
+require('../lib/worker/options.cjs').set({chalkOptions: {level: 0}});
 
 const {test} = require('tap');
 const delay = require('delay');

test-tap/test.js

@@ -1,6 +1,6 @@
 'use strict';
 require('../lib/chalk').set({level: 0});
-require('../lib/worker/options').set({});
+require('../lib/worker/options.cjs').set({});
 
 const path = require('path');
 const {test} = require('tap');

test-tap/try-snapshot.js

@@ -1,6 +1,6 @@
 'use strict';
 require('../lib/chalk').set();
-require('../lib/worker/options').set({chalkOptions: {level: 0}});
+require('../lib/worker/options.cjs').set({chalkOptions: {level: 0}});
 
 const path = require('path');
 const {test} = require('tap');

test-tap/watcher.js

@@ -8,7 +8,7 @@ const proxyquire = require('proxyquire');
 const sinon = require('sinon');
 const {test} = require('tap');
 const {normalizeGlobs} = require('../lib/globs');
-const {setImmediate} = require('../lib/now-and-timers');
+const {setImmediate} = require('../lib/now-and-timers.cjs');
 
 require('../lib/chalk').set({});
 

test/snapshot-regenerate-report/test.js

@@ -5,7 +5,7 @@ const fs = require('fs').promises;
 const path = require('path');
 
 require('../../lib/chalk').set({level: 0});
-require('../../lib/worker/options').set({});
+require('../../lib/worker/options.cjs').set({});
 const {load} = require('../../lib/snapshot-manager');
 
 test('snapshot report can be regenerated from .snap file', async t => {