Upgrade hullabaloo-config-manager

* Adds support for .babelrc.js files
* By default use 'test' environment rather than 'development'

Author: novemberborn

lib/babel-config.js

@@ -31,7 +31,7 @@ function validate(conf) {
 const SOURCE = '(AVA) Base Babel config';
 const AVA_DIR = path.join(__dirname, '..');
 
-function verifyExistingOptions(verifierFile, baseConfig, cache) {
+function verifyExistingOptions(verifierFile, baseConfig, cache, envName) {
 	return new Promise((resolve, reject) => {
 		try {
 			resolve(fs.readFileSync(verifierFile));
@@ -54,7 +54,7 @@ function verifyExistingOptions(verifierFile, baseConfig, cache) {
 			if (baseConfig.extends) {
 				fixedSourceHashes.set(baseConfig.extends.source, baseConfig.extends.hash);
 			}
-			return verifier.verifyCurrentEnv({sources: fixedSourceHashes}, cache)
+			return verifier.verifyEnv(envName, {sources: fixedSourceHashes}, cache)
 				.then(result => {
 					if (!result.cacheKeys) {
 						return null;
@@ -69,26 +69,33 @@ function verifyExistingOptions(verifierFile, baseConfig, cache) {
 		});
 }
 
-function resolveOptions(baseConfig, cache, optionsFile, verifierFile) {
-	return configManager.fromConfig(baseConfig, {cache})
+function resolveOptions(baseConfig, cache, envName, optionsFile, verifierFile) { // eslint-disable-line max-params
+	return configManager.fromConfig(baseConfig, {cache, expectedEnvNames: [envName]})
 		.then(result => {
 			fs.writeFileSync(optionsFile, result.generateModule());
 
 			return result.createVerifier()
 				.then(verifier => {
 					fs.writeFileSync(verifierFile, verifier.toBuffer());
-					return verifier.cacheKeysForCurrentEnv();
+					return verifier.cacheKeysForEnv(envName);
 				});
 		});
 }
 
 function build(projectDir, cacheDir, userOptions, powerAssert) {
+	// Note that Babel ignores empty string values, even for NODE_ENV. Here
+	// default to 'test' unless NODE_ENV is defined, in which case fall back to
+	// Babel's default of 'development' if it's empty.
+	const envName = process.env.BABEL_ENV || ('NODE_ENV' in process.env ? process.env.NODE_ENV : 'test') || 'development';
+
 	// Compute a seed based on the Node.js version and the project directory.
 	// Dependency hashes may vary based on the Node.js version, e.g. with the
 	// @ava/stage-4 Babel preset. Sources and dependencies paths are absolute in
 	// the generated module and verifier state. Those paths wouldn't necessarily
 	// be valid if the project directory changes.
-	const seed = md5Hex([process.versions.node, projectDir]);
+	// Also include `envName`, so options can be cached even if users change
+	// BABEL_ENV or NODE_ENV between runs.
+	const seed = md5Hex([process.versions.node, projectDir, envName]);
 
 	// Ensure cacheDir exists
 	makeDir.sync(cacheDir);
@@ -117,8 +124,8 @@ function build(projectDir, cacheDir, userOptions, powerAssert) {
 
 	const baseConfig = configManager.createConfig({
 		dir: AVA_DIR, // Presets are resolved relative to this directory
+		fileType: 'JSON',
 		hash: md5Hex(JSON.stringify(baseOptions)),
-		json5: false,
 		options: baseOptions,
 		source: SOURCE
 	});
@@ -135,19 +142,24 @@ function build(projectDir, cacheDir, userOptions, powerAssert) {
 	}
 
 	const cache = configManager.prepareCache();
-	return verifyExistingOptions(verifierFile, baseConfig, cache)
+	return verifyExistingOptions(verifierFile, baseConfig, cache, envName)
 		.then(cacheKeys => {
 			if (cacheKeys) {
 				return cacheKeys;
 			}
 
-			return resolveOptions(baseConfig, cache, optionsFile, verifierFile);
+			return resolveOptions(baseConfig, cache, envName, optionsFile, verifierFile);
 		})
-		.then(cacheKeys => ({
-			getOptions: require(optionsFile).getOptions,
-			// Include the seed in the cache keys used to store compilation results.
-			cacheKeys: Object.assign({seed}, cacheKeys)
-		}));
+		.then(cacheKeys => {
+			const getOptions = require(optionsFile).getOptions;
+			return {
+				getOptions() {
+					return getOptions(envName, cache);
+				},
+				// Include the seed in the cache keys used to store compilation results.
+				cacheKeys: Object.assign({seed}, cacheKeys)
+			};
+		});
 }
 
 module.exports = {

test/babel-config.js

@@ -1,4 +1,5 @@
 'use strict';
+const assert = require('assert');
 const fs = require('fs');
 const path = require('path');
 const test = require('tap').test;
@@ -22,6 +23,19 @@ function withNodeVersion(version, run) {
 	return promise;
 }
 
+function withNodeEnv(value, run) {
+	assert(!('NODE_ENV' in process.env));
+	process.env.NODE_ENV = value;
+	const reset = () => {
+		delete process.env.NODE_ENV;
+	};
+	const promise = new Promise(resolve => {
+		resolve(run());
+	});
+	promise.then(reset, reset);
+	return promise;
+}
+
 test('uses default presets when userOptions is "default"', t => {
 	const userOptions = 'default';
 	const powerAssert = true;
@@ -33,13 +47,9 @@ test('uses default presets when userOptions is "default"', t => {
 			const options = result.getOptions();
 
 			t.false(options.babelrc);
-			t.same(options.presets, [
-				require.resolve('@ava/babel-preset-stage-4'),
-				[
-					require.resolve('@ava/babel-preset-transform-test-files'),
-					{powerAssert}
-				]
-			]);
+			t.is(options.presets[0][0].wrapped, require('@ava/babel-preset-stage-4'));
+			t.is(options.presets[1][0].wrapped, require('@ava/babel-preset-transform-test-files'));
+			t.same(options.presets[1][1], {powerAssert});
 		});
 });
 
@@ -54,39 +64,68 @@ test('uses options from babelrc when userOptions is "inherit"', t => {
 			const options = result.getOptions();
 
 			t.false(options.babelrc);
-			t.same(options.plugins, [require.resolve(fixture('babel-plugin-test-doubler'))]);
-			t.same(options.presets, [
-				require.resolve('@ava/babel-preset-stage-4'),
-				[
-					require.resolve('@ava/babel-preset-transform-test-files'),
-					{powerAssert}
-				]
-			]);
+			t.is(options.plugins[0][0].wrapped, require(fixture('babel-plugin-test-doubler')));
+			t.is(options.presets[0][0].wrapped, require('@ava/babel-preset-stage-4'));
+			t.is(options.presets[1][0].wrapped, require('@ava/babel-preset-transform-test-files'));
+			t.same(options.presets[1][1], {powerAssert});
 		});
 });
 
 test('uses userOptions for babel options when userOptions is an object', t => {
-	const custom = require.resolve(fixture('empty'));
+	const customFile = require.resolve(fixture('babel-noop-plugin-or-preset'));
+	const custom = require(fixture('babel-noop-plugin-or-preset'));
 	const userOptions = {
-		presets: [custom],
-		plugins: [custom]
+		plugins: [customFile],
+		presets: [customFile]
 	};
 	const powerAssert = true;
 
 	const projectDir = uniqueTempDir();
 	const cacheDir = path.join(projectDir, 'cache');
+	return babelConfigHelper.build(projectDir, cacheDir, userOptions, powerAssert)
+		.then(result => {
+			const options = result.getOptions();
+			t.false(options.babelrc);
+			t.is(options.plugins[0][0].wrapped, custom);
+			t.is(options.presets[0][0].wrapped, custom);
+			t.is(options.presets[1][0].wrapped, require('@ava/babel-preset-transform-test-files'));
+			t.same(options.presets[1][1], {powerAssert});
+		});
+});
+
+test('uses "development" environment if NODE_ENV is the empty string', t => {
+	const userOptions = 'inherit';
+	const powerAssert = true;
+
+	const projectDir = fixture('babelrc');
+	const cacheDir = path.join(uniqueTempDir(), 'cache');
+	return withNodeEnv('', () => babelConfigHelper.build(projectDir, cacheDir, userOptions, powerAssert))
+		.then(result => {
+			const options = result.getOptions();
+
+			t.false(options.babelrc);
+			t.is(options.plugins[0][0].wrapped, require(fixture('babel-plugin-test-capitalizer')));
+			t.is(options.presets[0][0].wrapped, require('@ava/babel-preset-stage-4'));
+			t.is(options.presets[1][0].wrapped, require('@ava/babel-preset-transform-test-files'));
+			t.same(options.presets[1][1], {powerAssert});
+		});
+});
+
+test('supports .babelrc.js files', t => {
+	const userOptions = 'inherit';
+	const powerAssert = true;
+
+	const projectDir = fixture('babelrc-js');
+	const cacheDir = path.join(uniqueTempDir(), 'cache');
 	return babelConfigHelper.build(projectDir, cacheDir, userOptions, powerAssert)
 		.then(result => {
 			const options = result.getOptions();
 
 			t.false(options.babelrc);
-			t.same(options.presets, userOptions.presets.concat([
-				[
-					require.resolve('@ava/babel-preset-transform-test-files'),
-					{powerAssert}
-				]
-			]));
-			t.same(options.plugins, userOptions.plugins);
+			t.is(options.plugins[0][0].wrapped, require(fixture('babel-plugin-test-doubler')));
+			t.is(options.presets[0][0].wrapped, require('@ava/babel-preset-stage-4'));
+			t.is(options.presets[1][0].wrapped, require('@ava/babel-preset-transform-test-files'));
+			t.same(options.presets[1][1], {powerAssert});
 		});
 });
 
@@ -97,9 +136,7 @@ test('adds babel-plugin-syntax-object-rest-spread for node versions > 8.3.0', t
 	return withNodeVersion('9.0.0', () => babelConfigHelper.build(projectDir, cacheDir, 'default', true))
 		.then(result => {
 			const options = result.getOptions();
-			t.same(options.plugins, [
-				require.resolve('@babel/plugin-syntax-object-rest-spread')
-			]);
+			t.is(options.plugins[0][0].wrapped, require('@babel/plugin-syntax-object-rest-spread').default);
 		});
 });
 
@@ -110,9 +147,7 @@ test('adds babel-plugin-syntax-object-rest-spread for node versions == 8.3.0', t
 	return withNodeVersion('8.3.0', () => babelConfigHelper.build(projectDir, cacheDir, 'default', true))
 		.then(result => {
 			const options = result.getOptions();
-			t.same(options.plugins, [
-				require.resolve('@babel/plugin-syntax-object-rest-spread')
-			]);
+			t.is(options.plugins[0][0].wrapped, require('@babel/plugin-syntax-object-rest-spread').default);
 		});
 });
 
@@ -123,7 +158,7 @@ test('does not add babel-plugin-syntax-object-rest-spread for node versions < 8.
 	return withNodeVersion('8.2.0', () => babelConfigHelper.build(projectDir, cacheDir, 'default', true))
 		.then(result => {
 			const options = result.getOptions();
-			t.same(options.plugins, []);
+			t.true(!options.plugins);
 		});
 });
 
@@ -138,13 +173,7 @@ test('should disable power-assert when powerAssert is false', t => {
 			const options = result.getOptions();
 
 			t.false(options.babelrc);
-			t.same(options.presets, [
-				require.resolve('@ava/babel-preset-stage-4'),
-				[
-					require.resolve('@ava/babel-preset-transform-test-files'),
-					{powerAssert}
-				]
-			]);
+			t.same(options.presets[1][1], {powerAssert});
 		});
 });
 
@@ -204,7 +233,7 @@ test('updates cached verifier if dependency hashes change', t => {
 	const depFile = path.join(projectDir, 'plugin.js');
 
 	makeDir.sync(cacheDir);
-	fs.writeFileSync(depFile, 'foo');
+	fs.writeFileSync(depFile, 'module.exports = () => ({})');
 
 	const userOptions = {
 		plugins: ['./plugin.js']

test/fixture/babel-noop-plugin-or-preset.js

@@ -0,0 +1 @@
+module.exports = () => ({});

test/fixture/babelrc-js/.babelrc.js

@@ -0,0 +1,7 @@
+module.exports = api => {
+	api.cache.forever();
+	return {
+		'plugins': ['../babel-plugin-test-doubler'],
+	  'presets': ['@ava/stage-4']
+	};
+};

test/fixture/babelrc-js/package.json

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

test/fixture/babelrc-js/test.js

@@ -0,0 +1,11 @@
+import test from '../../../';
+
+const fixture = [1, 2];
+
+test('foo', t => {
+	// Using destructuring to ensure it transpiles on Node.js 4
+	// since that is a Node.js 6 feature
+	const [one, two] = fixture;
+	t.is(one, 1);
+	t.is(two, 2);
+});

test/fixture/babelrc/.babelrc

@@ -1,4 +1,11 @@
 {
   "presets": ["@ava/stage-4"],
-  "plugins": ["../babel-plugin-test-doubler"]
+	"env": {
+		"development": {
+			"plugins": ["../babel-plugin-test-capitalizer"]
+		},
+		"test": {
+			"plugins": ["../babel-plugin-test-doubler"],
+		}
+	}
 }