Refactor, improve and test extension validation

Support periods in extensions.

Author: novemberborn

api.js

@@ -3,11 +3,11 @@ const path = require('path');
 const fs = require('fs');
 const os = require('os');
 const commonPathPrefix = require('common-path-prefix');
+const escapeStringRegexp = require('escape-string-regexp');
 const uniqueTempDir = require('unique-temp-dir');
 const isCi = require('is-ci');
 const resolveCwd = require('resolve-cwd');
 const debounce = require('lodash.debounce');
-const difference = require('lodash.difference');
 const Bluebird = require('bluebird');
 const getPort = require('get-port');
 const arrify = require('arrify');
@@ -39,30 +39,8 @@ class Api extends Emittery {
 		this.options = Object.assign({match: []}, options);
 		this.options.require = resolveModules(this.options.require);
 
-		const {babelConfig, extensions: doNotCompileExtensions = []} = this.options;
-		const {extensions: babelExtensions = []} = babelConfig || {};
-
-		if (babelConfig) {
-			if (babelExtensions.length === 0) {
-				if (doNotCompileExtensions.includes('js')) {
-					throw new Error(`Cannot specify generic 'js' extension without disabling AVA's Babel usage`);
-				}
-
-				babelExtensions.push('js');
-			}
-		} else if (doNotCompileExtensions.length === 0) {
-			doNotCompileExtensions.push('js');
-		}
-
-		// Combine all extensions possible for testing. Removing duplicate extensions.
-		this._allExtensions = [...new Set([...doNotCompileExtensions, ...babelExtensions])];
-		if (this._allExtensions.length !== doNotCompileExtensions.length + babelExtensions.length) {
-			const notRepeated = difference(doNotCompileExtensions, babelExtensions);
-			const duplicates = this._allExtensions.filter(ext => !notRepeated.includes(ext));
-			throw new Error(`Unexpected duplicate extensions in options: ${duplicates.join(', ')}`);
-		}
-
-		this._doNotCompileExtensions = new Set(doNotCompileExtensions);
+		this._allExtensions = this.options.extensions.all;
+		this._regexpFullExtensions = new RegExp(`\\.(${this.options.extensions.full.map(ext => escapeStringRegexp(ext)).join('|')})$`);
 		this._precompiler = null;
 	}
 
@@ -162,10 +140,10 @@ class Api extends Emittery {
 									map: [...files, ...helpers].reduce((acc, file) => {
 										try {
 											const realpath = fs.realpathSync(file);
-											const ext = path.extname(realpath).slice(1);
-											const cachePath = this._doNotCompileExtensions.has(ext) ?
-												precompilation.precompileEnhancementsOnly(realpath) :
-												precompilation.precompileFull(realpath);
+											const filename = path.basename(realpath);
+											const cachePath = this._regexpFullExtensions.test(filename) ?
+												precompilation.precompileFull(realpath) :
+												precompilation.precompileEnhancementsOnly(realpath);
 											if (cachePath) {
 												acc[realpath] = cachePath;
 											}
@@ -254,7 +232,7 @@ class Api extends Emittery {
 			filename => {
 				throw new Error(`Cannot apply full precompilation, possible bad usage: ${filename}`);
 			};
-		const precompileEnhancementsOnly = compileEnhancements && this._doNotCompileExtensions.size > 0 ?
+		const precompileEnhancementsOnly = compileEnhancements && this.options.extensions.enhancementsOnly.length > 0 ?
 			babelPipeline.build(projectDir, cacheDir, null, compileEnhancements) :
 			filename => {
 				throw new Error(`Cannot apply enhancement-only precompilation, possible bad usage: ${filename}`);

lib/cli.js

@@ -149,6 +149,7 @@ exports.run = () => { // eslint-disable-line complexity
 	const TapReporter = require('./reporters/tap');
 	const Watcher = require('./watcher');
 	const babelPipeline = require('./babel-pipeline');
+	const normalizeExtensions = require('./extensions');
 
 	let babelConfig = null;
 	try {
@@ -157,6 +158,13 @@ exports.run = () => { // eslint-disable-line complexity
 		exit(err.message);
 	}
 
+	let extensions;
+	try {
+		extensions = normalizeExtensions(conf.extensions || [], babelConfig);
+	} catch (err) {
+		exit(err.message);
+	}
+
 	// Copy resultant cli.flags into conf for use with Api and elsewhere
 	Object.assign(conf, cli.flags);
 
@@ -168,7 +176,7 @@ exports.run = () => { // eslint-disable-line complexity
 		require: arrify(conf.require),
 		cacheEnabled: conf.cache !== false,
 		compileEnhancements: conf.compileEnhancements !== false,
-		extensions: conf.extensions,
+		extensions,
 		match,
 		babelConfig,
 		resolveTestsFrom: cli.input.length === 0 ? projectDir : process.cwd(),

lib/extensions.js

@@ -0,0 +1,40 @@
+module.exports = (enhancementsOnly, babelConfig) => {
+	const {extensions: full = []} = babelConfig || {};
+
+	// Combine all extensions possible for testing. Remove duplicate extensions.
+	const duplicates = [];
+	const seen = new Set();
+	for (const ext of [...enhancementsOnly, ...full]) {
+		if (seen.has(ext)) {
+			duplicates.push(ext);
+		} else {
+			seen.add(ext);
+		}
+	}
+
+	// Decide if and where to add the default `js` extension. Keep in mind it's not
+	// added if extensions have been explicitly given.
+	if (!seen.has('js')) {
+		if (babelConfig && full.length === 0) {
+			seen.add('js');
+			full.push('js');
+		}
+		if (!babelConfig && enhancementsOnly.length === 0) {
+			seen.add('js');
+			enhancementsOnly.push('js');
+		}
+	} else if (babelConfig && full.length === 0) {
+		// If Babel is not disabled, and has the default extensions (or, explicitly,
+		// no configured extensions), thes the `js` extension must have come from
+		// the `enhancementsOnly` value. That's not allowed since it'd be a
+		// roundabout way of disabling Babel.
+		throw new Error(`Cannot specify generic 'js' extension without disabling AVA's Babel usage.`);
+	}
+
+	if (duplicates.length > 0) {
+		throw new Error(`Unexpected duplicate extensions in options: '${duplicates.join('\', \'')}'.`);
+	}
+
+	const all = [...seen];
+	return {all, enhancementsOnly, full};
+};

package.json

@@ -91,6 +91,7 @@
 		"emittery": "^0.3.0",
 		"empower-core": "^0.6.1",
 		"equal-length": "^1.0.0",
+		"escape-string-regexp": "^1.0.5",
 		"figures": "^2.0.0",
 		"get-port": "^3.2.0",
 		"globby": "^7.1.1",

test/api.js

@@ -30,6 +30,7 @@ function apiCreator(options) {
 	options = options || {};
 	options.babelConfig = babelPipeline.validate(options.babelConfig);
 	options.concurrency = 2;
+	options.extensions = options.extensions || {all: ['js'], enhancementsOnly: [], full: ['js']};
 	options.projectDir = options.projectDir || ROOT_DIR;
 	options.resolveTestsFrom = options.resolveTestsFrom || options.projectDir;
 	const instance = new Api(options);
@@ -941,34 +942,6 @@ test('babel.testOptions with extends still merges plugins with .babelrc', t => {
 		});
 });
 
-test('precompiles tests when babelConfig.extensions is defined', t => {
-	t.plan(3);
-
-	const api = apiCreator({
-		babelConfig: {
-			extensions: [],
-			testOptions: {
-				babelrc: true
-			}
-		},
-		cacheEnabled: false,
-		projectDir: path.join(__dirname, 'fixture/babelrc')
-	});
-
-	api.on('run', plan => {
-		plan.status.on('stateChange', evt => {
-			if (evt.type === 'test-passed') {
-				t.ok(evt.title === 'foo' || evt.title === 'repeated test: foo');
-			}
-		});
-	});
-
-	return api.run()
-		.then(runStatus => {
-			t.is(runStatus.stats.passedTests, 2);
-		});
-});
-
 test('extended config can disable ava/stage-4', t => {
 	t.plan(1);
 
@@ -1041,6 +1014,38 @@ test('uses "development" Babel environment if NODE_ENV is the empty string', t =
 		});
 });
 
+test('full extensions take precedence over enhancements-only', t => {
+	t.plan(2);
+
+	const api = apiCreator({
+		babelConfig: {
+			testOptions: {
+				plugins: [testCapitalizerPlugin]
+			}
+		},
+		extensions: {
+			all: ['foo.bar', 'bar'],
+			enhancementsOnly: ['bar'],
+			full: ['foo.bar']
+		},
+		cacheEnabled: false,
+		projectDir: path.join(__dirname, 'fixture/extensions')
+	});
+
+	api.on('run', plan => {
+		plan.status.on('stateChange', evt => {
+			if (evt.type === 'test-passed') {
+				t.ok(evt.title === 'FOO');
+			}
+		});
+	});
+
+	return api.run()
+		.then(runStatus => {
+			t.is(runStatus.stats.passedTests, 1);
+		});
+});
+
 test('using --match with matching tests will only report those passing tests', t => {
 	t.plan(3);
 

test/cli.js

@@ -89,6 +89,38 @@ for (const which of [
 	});
 }
 
+test('errors if top-level extensions include "js" without babel=false', t => {
+	execCli(['es2015.js'], {dirname: `fixture/invalid-extensions/top-level`}, (err, stdout, stderr) => {
+		t.ok(err);
+
+		let expectedOutput = '\n';
+		expectedOutput += figures.cross + ' Cannot specify generic \'js\' extension without disabling AVA\'s Babel usage.';
+		expectedOutput += '\n';
+
+		t.is(stderr, expectedOutput);
+		t.end();
+	});
+});
+
+for (const [where, which, msg = '\'js\', \'jsx\''] of [
+	['top-level', 'top-level-duplicates'],
+	['babel', 'babel-duplicates'],
+	['top-level and babel', 'shared-duplicates', '\'jsx\'']
+]) {
+	test(`errors if ${where} extensions include duplicates`, t => {
+		execCli(['es2015.js'], {dirname: `fixture/invalid-extensions/${which}`}, (err, stdout, stderr) => {
+			t.ok(err);
+
+			let expectedOutput = '\n';
+			expectedOutput += figures.cross + ` Unexpected duplicate extensions in options: ${msg}.`;
+			expectedOutput += '\n';
+
+			t.is(stderr, expectedOutput);
+			t.end();
+		});
+	});
+}
+
 test('enabling long stack traces will provide detailed debug information', t => {
 	execCli('fixture/long-stack-trace', (err, stdout, stderr) => {
 		t.ok(err);

test/fixture/extensions/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "application-name",
+  "version": "0.0.1"
+}

test/fixture/extensions/test.foo.bar

@@ -0,0 +1,11 @@
+import test from '../../..';
+
+const one = {one: 1};
+const two = {two: 2};
+
+test('foo', t => {
+	// Using object rest/spread to ensure it transpiles on Node.js 6, since this
+	// is a Node.js 8 feature
+	const actual = {...one, ...two};
+	t.deepEqual(actual, {one: 1, two: 2});
+});

test/fixture/invalid-extensions/babel-duplicates/package.json

@@ -0,0 +1,7 @@
+{
+	"ava": {
+		"babel": {
+			"extensions": ["js", "js", "jsx", "jsx"]
+		}
+	}
+}

test/fixture/invalid-extensions/shared-duplicates/package.json

@@ -0,0 +1,8 @@
+{
+	"ava": {
+		"babel": {
+			"extensions": ["js", "jsx"]
+		},
+		"extensions": ["jsx"]
+	}
+}

test/fixture/invalid-extensions/top-level-duplicates/package.json

@@ -0,0 +1,6 @@
+{
+	"ava": {
+		"babel": false,
+		"extensions": ["js", "js", "jsx", "jsx"]
+	}
+}

test/fixture/invalid-extensions/top-level/package.json

@@ -0,0 +1,5 @@
+{
+	"ava": {
+		"extensions": ["js"]
+	}
+}

test/helper/report.js

@@ -79,6 +79,11 @@ const run = (type, reporter) => {
 	const projectDir = path.join(__dirname, '../fixture/report', type.toLowerCase());
 
 	const api = createApi({
+		extensions: {
+			all: ['js'],
+			enhancementsOnly: [],
+			full: ['js']
+		},
 		failFast: type === 'failFast' || type === 'failFast2',
 		failWithoutAssertions: false,
 		serial: type === 'failFast' || type === 'failFast2',