@wordpress/env 6.0.0 → 7.0.0

package/lib/config/config.js

@@ -1,353 +0,0 @@
-'use strict';
-/**
- * External dependencies
- */
-const fs = require( 'fs' ).promises;
-const path = require( 'path' );
-const os = require( 'os' );
-
-/**
- * Internal dependencies
- */
-const detectDirectoryType = require( './detect-directory-type' );
-const { validateConfig, ValidationError } = require( './validate-config' );
-const readRawConfigFile = require( './read-raw-config-file' );
-const parseConfig = require( './parse-config' );
-const { includeTestsPath, parseSourceString } = parseConfig;
-const addOrReplacePort = require( './add-or-replace-port' );
-const md5 = require( '../md5' );
-
-/**
- * wp-env configuration.
- *
- * @typedef WPConfig
- * @property {string}                           name                    Name of the environment.
- * @property {string}                           configDirectoryPath     Path to the .wp-env.json file.
- * @property {string}                           workDirectoryPath       Path to the work directory located in ~/.wp-env.
- * @property {string}                           dockerComposeConfigPath Path to the docker-compose.yml file.
- * @property {boolean}                          detectedLocalConfig     If true, wp-env detected local config and used it.
- * @property {Object.<string, WPServiceConfig>} env                     Specific config for different environments.
- * @property {boolean}                          debug                   True if debug mode is enabled.
- */
-
-/**
- * Base-level config for any particular environment. (development/tests/etc)
- *
- * @typedef WPServiceConfig
- * @property {WPSource}                  coreSource    The WordPress installation to load in the environment.
- * @property {WPSource[]}                pluginSources Plugins to load in the environment.
- * @property {WPSource[]}                themeSources  Themes to load in the environment.
- * @property {number}                    port          The port to use.
- * @property {Object}                    config        Mapping of wp-config.php constants to their desired values.
- * @property {Object.<string, WPSource>} mappings      Mapping of WordPress directories to local directories which should be mounted.
- * @property {string}                    phpVersion    Version of PHP to use in the environments, of the format 0.0.
- */
-
-/**
- * A WordPress installation, plugin or theme to be loaded into the environment.
- *
- * @typedef WPSource
- * @property {'local'|'git'|'zip'} type     The source type.
- * @property {string}              path     The path to the WordPress installation, plugin or theme.
- * @property {?string}             url      The URL to the source download if the source type is not local.
- * @property {?string}             ref      The git ref for the source if the source type is 'git'.
- * @property {string}              basename Name that identifies the WordPress installation, plugin or theme.
- */
-
-/**
- * Reads, parses, and validates the given .wp-env.json file into a wp-env config
- * object for internal use.
- *
- * @param {string} configPath Path to the .wp-env.json file.
- *
- * @return {WPConfig} A parsed and validated wp-env config object.
- */
-module.exports = async function readConfig( configPath ) {
-	const configDirectoryPath = path.dirname( configPath );
-	const workDirectoryPath = path.resolve(
-		await getHomeDirectory(),
-		md5( configPath )
-	);
-
-	// The specified base configuration from .wp-env.json or from the local
-	// source type which was automatically detected.
-	const baseConfig =
-		( await readRawConfigFile( '.wp-env.json', configPath ) ) ||
-		( await getDefaultBaseConfig( configPath ) );
-
-	// Overriden .wp-env.json on a per-user case.
-	const overrideConfig =
-		( await readRawConfigFile(
-			'.wp-env.override.json',
-			configPath.replace( /\.wp-env\.json$/, '.wp-env.override.json' )
-		) ) || {};
-
-	const detectedLocalConfig =
-		Object.keys( { ...baseConfig, ...overrideConfig } ).length > 0;
-
-	// Default configuration which is overridden by .wp-env.json files.
-	const defaultConfiguration = {
-		core: null, // Indicates that the latest stable version should ultimately be used.
-		phpVersion: null,
-		plugins: [],
-		themes: [],
-		port: 8888,
-		mappings: {},
-		config: {
-			WP_DEBUG: true,
-			SCRIPT_DEBUG: true,
-			WP_ENVIRONMENT_TYPE: 'local',
-			WP_PHP_BINARY: 'php',
-			WP_TESTS_EMAIL: 'admin@example.org',
-			WP_TESTS_TITLE: 'Test Blog',
-			WP_TESTS_DOMAIN: 'localhost',
-			WP_SITEURL: 'http://localhost',
-			WP_HOME: 'http://localhost',
-		},
-		env: {
-			development: {}, // No overrides needed, but it should exist.
-			tests: {
-				config: { WP_DEBUG: false, SCRIPT_DEBUG: false },
-				port: 8889,
-			},
-		},
-	};
-
-	// A quick validation before merging on a service by service level allows us
-	// to check the root configuration options and provide more helpful errors.
-	validateConfig(
-		mergeWpServiceConfigs( [
-			defaultConfiguration,
-			baseConfig,
-			overrideConfig,
-		] )
-	);
-
-	// A unique array of the environments specified in the config options.
-	// Needed so that we can override settings per-environment, rather than
-	// overwriting each environment key.
-	const getEnvKeys = ( config ) => Object.keys( config.env || {} );
-	const allEnvs = [
-		...new Set( [
-			...getEnvKeys( defaultConfiguration ),
-			...getEnvKeys( baseConfig ),
-			...getEnvKeys( overrideConfig ),
-		] ),
-	];
-
-	// Returns a pair with the root config options and the specific environment config options.
-	const getEnvConfig = ( config, envName ) => [
-		config,
-		config.env && config.env[ envName ] ? config.env[ envName ] : {},
-	];
-
-	// Merge each of the specified environment-level overrides.
-	const allPorts = new Set(); // Keep track of unique ports for validation.
-	const env = {};
-	for ( const envName of allEnvs ) {
-		env[ envName ] = await parseConfig(
-			validateConfig(
-				mergeWpServiceConfigs( [
-					...getEnvConfig( defaultConfiguration, envName ),
-					...getEnvConfig( baseConfig, envName ),
-					...getEnvConfig( overrideConfig, envName ),
-				] ),
-				envName
-			),
-			{ workDirectoryPath }
-		);
-		allPorts.add( env[ envName ].port );
-	}
-
-	if ( allPorts.size !== allEnvs.length ) {
-		throw new ValidationError(
-			'Invalid .wp-env.json: Each port value must be unique.'
-		);
-	}
-
-	return withOverrides( {
-		name: path.basename( configDirectoryPath ),
-		dockerComposeConfigPath: path.resolve(
-			workDirectoryPath,
-			'docker-compose.yml'
-		),
-		configDirectoryPath,
-		workDirectoryPath,
-		detectedLocalConfig,
-		env,
-	} );
-};
-
-/**
- * Deep-merges the values in the given service environment. This allows us to
- * merge the wp-config.php values instead of overwriting them. Note that this
- * merges configs before they have been validated, so the passed config shape
- * will not match the WPServiceConfig type.
- *
- * @param {Object[]} configs Array of raw service config objects to merge.
- *
- * @return {Object} The merged configuration object.
- */
-function mergeWpServiceConfigs( configs ) {
-	// Returns an array of nested values in the config object. For example,
-	// an array of all the wp-config objects.
-	const mergeNestedObjs = ( key ) =>
-		Object.assign(
-			{},
-			...configs.map( ( config ) => {
-				if ( ! config[ key ] ) {
-					return {};
-				} else if ( typeof config[ key ] === 'object' ) {
-					return config[ key ];
-				}
-				throw new ValidationError(
-					`Invalid .wp-env.json: "${ key }" must be an object.`
-				);
-			} )
-		);
-
-	const mergedConfig = {
-		...Object.assign( {}, ...configs ),
-		config: mergeNestedObjs( 'config' ),
-		mappings: mergeNestedObjs( 'mappings' ),
-	};
-
-	delete mergedConfig.env;
-	return mergedConfig;
-}
-
-/**
- * Detects basic config options to use if the .wp-env.json config file does not
- * exist. For example, if the local directory contains a plugin, that will be
- * added to the default plugin sources.
- *
- * @param {string} configPath A path to the config file for the source to detect.
- * @return {Object} Basic config options for the detected source type. Empty
- *                  object if no config detected.
- */
-async function getDefaultBaseConfig( configPath ) {
-	const configDirectoryPath = path.dirname( configPath );
-	const type = await detectDirectoryType( configDirectoryPath );
-
-	if ( type === 'core' ) {
-		return { core: '.' };
-	} else if ( type === 'plugin' ) {
-		return { plugins: [ '.' ] };
-	} else if ( type === 'theme' ) {
-		return { themes: [ '.' ] };
-	}
-
-	return {};
-}
-
-/**
- * Overrides keys in the config object with set environment variables or options
- * which should be merged.
- *
- * @param {WPConfig} config fully parsed configuration object.
- * @return {WPConfig} configuration object with overrides applied.
- */
-function withOverrides( config ) {
-	const workDirectoryPath = config.workDirectoryPath;
-	// Override port numbers with environment variables.
-	config.env.development.port =
-		getNumberFromEnvVariable( 'WP_ENV_PORT' ) ||
-		config.env.development.port;
-	config.env.tests.port =
-		getNumberFromEnvVariable( 'WP_ENV_TESTS_PORT' ) ||
-		config.env.tests.port;
-
-	// Override WordPress core with environment variable.
-	if ( process.env.WP_ENV_CORE ) {
-		const coreSource = includeTestsPath(
-			parseSourceString( process.env.WP_ENV_CORE, { workDirectoryPath } ),
-			{ workDirectoryPath }
-		);
-		config.env.development.coreSource = coreSource;
-		config.env.tests.coreSource = coreSource;
-	}
-
-	// Override PHP version with environment variable.
-	config.env.development.phpVersion =
-		process.env.WP_ENV_PHP_VERSION || config.env.development.phpVersion;
-	config.env.tests.phpVersion =
-		process.env.WP_ENV_PHP_VERSION || config.env.tests.phpVersion;
-
-	// Some of our configuration options need to have the port added to them.
-	const addConfigPort = ( configKey ) => {
-		// Don't replace the port if one is set in WP_HOME.
-		const replace = configKey !== 'WP_HOME';
-
-		config.env.development.config[ configKey ] = addOrReplacePort(
-			config.env.development.config[ configKey ],
-			config.env.development.port,
-			replace
-		);
-		config.env.tests.config[ configKey ] = addOrReplacePort(
-			config.env.tests.config[ configKey ],
-			config.env.tests.port,
-			replace
-		);
-	};
-	addConfigPort( 'WP_TESTS_DOMAIN' );
-	addConfigPort( 'WP_SITEURL' );
-	addConfigPort( 'WP_HOME' );
-
-	return config;
-}
-
-/**
- * Parses an environment variable which should be a number.
- *
- * Throws an error if the variable cannot be parsed to a number.
- * Returns null if the environment variable has not been specified.
- *
- * @param {string} varName The environment variable to check (e.g. WP_ENV_PORT).
- * @return {null|number} The number. Null if it does not exist.
- */
-function getNumberFromEnvVariable( varName ) {
-	// Allow use of the default if it does not exist.
-	if ( ! process.env[ varName ] ) {
-		return null;
-	}
-
-	const maybeNumber = parseInt( process.env[ varName ] );
-
-	// Throw an error if it is not parseable as a number.
-	if ( isNaN( maybeNumber ) ) {
-		throw new ValidationError(
-			`Invalid environment variable: ${ varName } must be a number.`
-		);
-	}
-
-	return maybeNumber;
-}
-
-/**
- * Gets the `wp-env` home directory in which generated files are created.
- *
- * By default: '~/.wp-env/'. On Linux with snap packages: '~/wp-env/'. Can be
- * overridden with the WP_ENV_HOME environment variable.
- *
- * @return {Promise<string>} The absolute path to the `wp-env` home directory.
- */
-async function getHomeDirectory() {
-	// Allow user to override download location.
-	if ( process.env.WP_ENV_HOME ) {
-		return path.resolve( process.env.WP_ENV_HOME );
-	}
-
-	/**
-	 * Installing docker with Snap Packages on Linux is common, but does not
-	 * support hidden directories. Therefore we use a public directory when
-	 * snap packages exist.
-	 *
-	 * @see https://github.com/WordPress/gutenberg/issues/20180#issuecomment-587046325
-	 */
-	return path.resolve(
-		os.homedir(),
-		!! ( await fs.stat( '/snap' ).catch( () => false ) )
-			? 'wp-env'
-			: '.wp-env'
-	);
-}

package/lib/config/test/__snapshots__/config.js.snap

@@ -1,83 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`readConfig config file should match snapshot 1`] = `
-{
-  "configDirectoryPath": ".",
-  "detectedLocalConfig": true,
-  "env": {
-    "development": {
-      "config": {
-        "SCRIPT_DEBUG": true,
-        "TEST": 100,
-        "TEST_VAL1": 1,
-        "TEST_VAL2": "hello",
-        "TEST_VAL3": false,
-        "WP_DEBUG": true,
-        "WP_ENVIRONMENT_TYPE": "local",
-        "WP_HOME": "http://localhost:2000",
-        "WP_PHP_BINARY": "php",
-        "WP_SITEURL": "http://localhost:2000",
-        "WP_TESTS_DOMAIN": "localhost:2000",
-        "WP_TESTS_EMAIL": "admin@example.org",
-        "WP_TESTS_TITLE": "Test Blog",
-      },
-      "mappings": {},
-      "phpVersion": null,
-      "pluginSources": [],
-      "port": 2000,
-      "themeSources": [],
-    },
-    "tests": {
-      "config": {
-        "SCRIPT_DEBUG": false,
-        "TEST": 200,
-        "TEST_VAL1": 1,
-        "TEST_VAL2": "hello",
-        "TEST_VAL3": false,
-        "WP_DEBUG": false,
-        "WP_ENVIRONMENT_TYPE": "local",
-        "WP_HOME": "http://localhost:1000",
-        "WP_PHP_BINARY": "php",
-        "WP_SITEURL": "http://localhost:1000",
-        "WP_TESTS_DOMAIN": "localhost:1000",
-        "WP_TESTS_EMAIL": "admin@example.org",
-        "WP_TESTS_TITLE": "Test Blog",
-      },
-      "mappings": {},
-      "phpVersion": null,
-      "pluginSources": [],
-      "port": 1000,
-      "themeSources": [],
-    },
-  },
-  "name": ".",
-}
-`;
-
-exports[`readConfig wp config values should use default config values 1`] = `
-{
-  "SCRIPT_DEBUG": false,
-  "WP_DEBUG": false,
-  "WP_ENVIRONMENT_TYPE": "local",
-  "WP_HOME": "http://localhost:8889",
-  "WP_PHP_BINARY": "php",
-  "WP_SITEURL": "http://localhost:8889",
-  "WP_TESTS_DOMAIN": "localhost:8889",
-  "WP_TESTS_EMAIL": "admin@example.org",
-  "WP_TESTS_TITLE": "Test Blog",
-}
-`;
-
-exports[`readConfig wp config values should use default config values 2`] = `
-{
-  "SCRIPT_DEBUG": true,
-  "WP_DEBUG": true,
-  "WP_ENVIRONMENT_TYPE": "local",
-  "WP_HOME": "http://localhost:8888",
-  "WP_PHP_BINARY": "php",
-  "WP_SITEURL": "http://localhost:8888",
-  "WP_TESTS_DOMAIN": "localhost:8888",
-  "WP_TESTS_EMAIL": "admin@example.org",
-  "WP_TESTS_TITLE": "Test Blog",
-}
-`;