@wordpress/env 10.38.1-next.v.0 → 11.0.0

package/lib/commands/clean.js

@@ -2,14 +2,14 @@
 /**
  * External dependencies
  */
-const { v2: dockerCompose } = require( 'docker-compose' );
+const path = require( 'path' );
 
 /**
  * Internal dependencies
  */
-const initConfig = require( '../init-config' );
-const { configureWordPress, resetDatabase } = require( '../wordpress' );
 const { executeLifecycleScript } = require( '../execute-lifecycle-script' );
+const { loadConfig } = require( '../config' );
+const { getRuntime, detectRuntime } = require( '../runtime' );
 
 /**
  * @typedef {import('../wordpress').WPEnvironment} WPEnvironment
@@ -17,57 +17,35 @@ const { executeLifecycleScript } = require( '../execute-lifecycle-script' );
  */
 
 /**
- * Wipes the development server's database, the tests server's database, or both.
+ * @deprecated Use `reset` instead.
+ *
+ * Resets the development server's database, the tests server's database, or both.
  *
  * @param {Object}                 options
- * @param {WPEnvironmentSelection} options.environment The environment to clean. Either 'development', 'tests', or 'all'.
+ * @param {WPEnvironmentSelection} options.environment The environment to reset. Either 'development', 'tests', or 'all'.
  * @param {Object}                 options.spinner     A CLI spinner which indicates progress.
  * @param {boolean}                options.scripts     Indicates whether or not lifecycle scripts should be executed.
  * @param {boolean}                options.debug       True if debug mode is enabled.
+ * @param {string|null}            options.config      Path to a custom .wp-env.json configuration file.
  */
 module.exports = async function clean( {
 	environment,
 	spinner,
 	scripts,
 	debug,
+	config: customConfigPath,
 } ) {
-	const config = await initConfig( { spinner, debug } );
-
-	const description = `${ environment } environment${
-		environment === 'all' ? 's' : ''
-	}`;
-	spinner.text = `Cleaning ${ description }.`;
-
-	const tasks = [];
-
-	// Start the database first to avoid race conditions where all tasks create
-	// different docker networks with the same name.
-	await dockerCompose.upOne( 'mysql', {
-		config: config.dockerComposeConfigPath,
-		log: config.debug,
-	} );
+	spinner.warn( 'The `clean` command is deprecated. Use `reset` instead.' );
 
-	if ( environment === 'all' || environment === 'development' ) {
-		tasks.push(
-			resetDatabase( 'development', config )
-				.then( () => configureWordPress( 'development', config ) )
-				.catch( () => {} )
-		);
-	}
-
-	if ( environment === 'all' || environment === 'tests' ) {
-		tasks.push(
-			resetDatabase( 'tests', config )
-				.then( () => configureWordPress( 'tests', config ) )
-				.catch( () => {} )
-		);
-	}
+	const config = await loadConfig( path.resolve( '.' ), customConfigPath );
+	const runtime = getRuntime(
+		await detectRuntime( config.workDirectoryPath )
+	);
 
-	await Promise.all( tasks );
+	await runtime.clean( config, { environment, spinner, debug } );
 
+	// Execute afterClean for backwards compatibility.
 	if ( scripts ) {
 		await executeLifecycleScript( 'afterClean', config, spinner );
 	}
-
-	spinner.text = `Cleaned ${ description }.`;
 };

package/lib/commands/cleanup.js

@@ -0,0 +1,79 @@
+'use strict';
+/**
+ * External dependencies
+ */
+const fs = require( 'fs' ).promises;
+const path = require( 'path' );
+const { confirm } = require( '@inquirer/prompts' );
+
+/**
+ * Internal dependencies
+ */
+const { loadConfig } = require( '../config' );
+const { executeLifecycleScript } = require( '../execute-lifecycle-script' );
+const { getRuntime, detectRuntime } = require( '../runtime' );
+
+/**
+ * Cleanup the development server.
+ *
+ * Removes Docker containers, volumes, networks, and local files,
+ * but preserves Docker images for faster re-starts.
+ *
+ * @param {Object}      options
+ * @param {Object}      options.spinner A CLI spinner which indicates progress.
+ * @param {boolean}     options.scripts Indicates whether or not lifecycle scripts should be executed.
+ * @param {boolean}     options.force   If true, skips the confirmation prompt.
+ * @param {boolean}     options.debug   True if debug mode is enabled.
+ * @param {string|null} options.config  Path to a custom .wp-env.json configuration file.
+ */
+module.exports = async function cleanup( {
+	spinner,
+	scripts,
+	force,
+	debug,
+	config: customConfigPath,
+} ) {
+	const config = await loadConfig( path.resolve( '.' ), customConfigPath );
+
+	try {
+		await fs.readdir( config.workDirectoryPath );
+	} catch {
+		spinner.text = 'Could not find any files to remove.';
+		return;
+	}
+
+	const runtime = getRuntime(
+		await detectRuntime( config.workDirectoryPath )
+	);
+
+	spinner.info( runtime.getCleanupWarningMessage() );
+
+	let yesDelete = force;
+	if ( ! force ) {
+		try {
+			yesDelete = await confirm( {
+				message: 'Are you sure you want to continue?',
+				default: false,
+			} );
+		} catch ( error ) {
+			if ( error.name === 'ExitPromptError' ) {
+				console.log( 'Cancelled.' );
+				process.exit( 1 );
+			}
+			throw error;
+		}
+	}
+
+	spinner.start();
+
+	if ( ! yesDelete ) {
+		spinner.text = 'Cancelled.';
+		return;
+	}
+
+	await runtime.cleanup( config, { spinner, debug } );
+
+	if ( scripts ) {
+		await executeLifecycleScript( 'afterCleanup', config, spinner );
+	}
+};

package/lib/commands/destroy.js

@@ -2,32 +2,35 @@
 /**
  * External dependencies
  */
-const { v2: dockerCompose } = require( 'docker-compose' );
 const fs = require( 'fs' ).promises;
 const path = require( 'path' );
 const { confirm } = require( '@inquirer/prompts' );
 
-/**
- * Promisified dependencies
- */
-const { rimraf } = require( 'rimraf' );
-
 /**
  * Internal dependencies
  */
 const { loadConfig } = require( '../config' );
 const { executeLifecycleScript } = require( '../execute-lifecycle-script' );
+const { getRuntime, detectRuntime } = require( '../runtime' );
 
 /**
  * Destroy the development server.
  *
- * @param {Object}  options
- * @param {Object}  options.spinner A CLI spinner which indicates progress.
- * @param {boolean} options.scripts Indicates whether or not lifecycle scripts should be executed.
- * @param {boolean} options.debug   True if debug mode is enabled.
+ * @param {Object}      options
+ * @param {Object}      options.spinner A CLI spinner which indicates progress.
+ * @param {boolean}     options.scripts Indicates whether or not lifecycle scripts should be executed.
+ * @param {boolean}     options.force   If true, skips the confirmation prompt.
+ * @param {boolean}     options.debug   True if debug mode is enabled.
+ * @param {string|null} options.config  Path to a custom .wp-env.json configuration file.
  */
-module.exports = async function destroy( { spinner, scripts, debug } ) {
-	const config = await loadConfig( path.resolve( '.' ) );
+module.exports = async function destroy( {
+	spinner,
+	scripts,
+	force,
+	debug,
+	config: customConfigPath,
+} ) {
+	const config = await loadConfig( path.resolve( '.' ), customConfigPath );
 
 	try {
 		await fs.readdir( config.workDirectoryPath );
@@ -36,22 +39,26 @@ module.exports = async function destroy( { spinner, scripts, debug } ) {
 		return;
 	}
 
-	spinner.info(
-		'WARNING! This will remove Docker containers, volumes, networks, and images associated with the WordPress instance.'
+	const runtime = getRuntime(
+		await detectRuntime( config.workDirectoryPath )
 	);
 
-	let yesDelete = false;
-	try {
-		yesDelete = await confirm( {
-			message: 'Are you sure you want to continue?',
-			default: false,
-		} );
-	} catch ( error ) {
-		if ( error.name === 'ExitPromptError' ) {
-			console.log( 'Cancelled.' );
-			process.exit( 1 );
+	spinner.info( runtime.getDestroyWarningMessage() );
+
+	let yesDelete = force;
+	if ( ! force ) {
+		try {
+			yesDelete = await confirm( {
+				message: 'Are you sure you want to continue?',
+				default: false,
+			} );
+		} catch ( error ) {
+			if ( error.name === 'ExitPromptError' ) {
+				console.log( 'Cancelled.' );
+				process.exit( 1 );
+			}
+			throw error;
 		}
-		throw error;
 	}
 
 	spinner.start();
@@ -61,24 +68,9 @@ module.exports = async function destroy( { spinner, scripts, debug } ) {
 		return;
 	}
 
-	spinner.text = 'Removing docker images, volumes, and networks.';
-
-	await dockerCompose.down( {
-		config: config.dockerComposeConfigPath,
-		commandOptions: [ '--volumes', '--remove-orphans', '--rmi', 'all' ],
-		log: debug,
-	} );
-
-	spinner.text = 'Removing local files.';
-	// Note: there is a race condition where docker compose actually hasn't finished
-	// by this point, which causes rimraf to fail. We need to wait at least 2.5-5s,
-	// but using 10s in case it's dependant on the machine.
-	await new Promise( ( resolve ) => setTimeout( resolve, 10000 ) );
-	await rimraf( config.workDirectoryPath );
+	await runtime.destroy( config, { spinner, debug } );
 
 	if ( scripts ) {
 		await executeLifecycleScript( 'afterDestroy', config, spinner );
 	}
-
-	spinner.text = 'Removed WordPress environment.';
 };

package/lib/commands/index.js

@@ -4,18 +4,22 @@
  */
 const start = require( './start' );
 const stop = require( './stop' );
+const reset = require( './reset' );
 const clean = require( './clean' );
 const run = require( './run' );
 const destroy = require( './destroy' );
+const cleanup = require( './cleanup' );
 const logs = require( './logs' );
-const installPath = require( './install-path' );
+const status = require( './status' );
 
 module.exports = {
 	start,
 	stop,
+	reset,
 	clean,
 	run,
 	destroy,
+	cleanup,
 	logs,
-	installPath,
+	status,
 };

package/lib/commands/logs.js

@@ -2,76 +2,34 @@
 /**
  * External dependencies
  */
-const { v2: dockerCompose } = require( 'docker-compose' );
+const path = require( 'path' );
 
 /**
  * Internal dependencies
  */
-const initConfig = require( '../init-config' );
+const { loadConfig } = require( '../config' );
+const { getRuntime, detectRuntime } = require( '../runtime' );
 
 /**
  * Displays the Docker & PHP logs on the given environment.
  *
- * @param {Object}  options
- * @param {Object}  options.environment The environment to run the command in (develop or tests).
- * @param {Object}  options.watch       If true, follow along with log output.
- * @param {Object}  options.spinner     A CLI spinner which indicates progress.
- * @param {boolean} options.debug       True if debug mode is enabled.
+ * @param {Object}      options
+ * @param {Object}      options.environment The environment to run the command in (develop or tests).
+ * @param {Object}      options.watch       If true, follow along with log output.
+ * @param {Object}      options.spinner     A CLI spinner which indicates progress.
+ * @param {boolean}     options.debug       True if debug mode is enabled.
+ * @param {string|null} options.config      Path to a custom .wp-env.json configuration file.
  */
-module.exports = async function logs( { environment, watch, spinner, debug } ) {
-	const config = await initConfig( { spinner, debug } );
-
-	// If we show text while watching the logs, it will continue showing up every
-	// few lines in the logs as they happen, which isn't a good look. So only
-	// show the message if we are not watching the logs.
-	if ( ! watch ) {
-		spinner.text = `Showing logs for the ${ environment } environment.`;
-	}
-
-	const servicesToWatch =
-		environment === 'all'
-			? [ 'tests-wordpress', 'wordpress' ]
-			: [ environment === 'tests' ? 'tests-wordpress' : 'wordpress' ];
-
-	const output = await Promise.all( [
-		...servicesToWatch.map( ( service ) =>
-			dockerCompose.logs( service, {
-				config: config.dockerComposeConfigPath,
-				log: watch, // Must log inline if we are watching the log output.
-				commandOptions: watch ? [ '--follow' ] : [],
-			} )
-		),
-	] );
-
-	// Combine the results from each docker output.
-	const result = output.reduce(
-		( acc, current ) => {
-			if ( current.out ) {
-				acc.out = acc.out.concat( current.out );
-			}
-			if ( current.err ) {
-				acc.err = acc.err.concat( current.err );
-			}
-			if ( current.exitCode !== 0 ) {
-				acc.hasNon0ExitCode = true;
-			}
-			return acc;
-		},
-		{ out: '', err: '', hasNon0ExitCode: false }
+module.exports = async function logs( {
+	environment,
+	watch,
+	spinner,
+	debug,
+	config: customConfigPath,
+} ) {
+	const config = await loadConfig( path.resolve( '.' ), customConfigPath );
+	const runtime = getRuntime(
+		await detectRuntime( config.workDirectoryPath )
 	);
-
-	if ( result.out.length ) {
-		console.log(
-			process.stdout.isTTY ? `\n\n${ result.out }\n\n` : result.out
-		);
-	} else if ( result.err.length ) {
-		console.error(
-			process.stdout.isTTY ? `\n\n${ result.err }\n\n` : result.err
-		);
-		if ( result.hasNon0ExitCode ) {
-			throw result.err;
-		}
-	}
-
-	spinner.text = 'Finished showing logs.';
+	await runtime.logs( config, { environment, watch, spinner, debug } );
 };

package/lib/commands/reset.js

@@ -0,0 +1,46 @@
+'use strict';
+/**
+ * External dependencies
+ */
+const path = require( 'path' );
+
+/**
+ * Internal dependencies
+ */
+const { executeLifecycleScript } = require( '../execute-lifecycle-script' );
+const { loadConfig } = require( '../config' );
+const { getRuntime, detectRuntime } = require( '../runtime' );
+
+/**
+ * @typedef {import('../wordpress').WPEnvironment} WPEnvironment
+ * @typedef {import('../wordpress').WPEnvironmentSelection} WPEnvironmentSelection
+ */
+
+/**
+ * Resets the development server's database, the tests server's database, or both.
+ *
+ * @param {Object}                 options
+ * @param {WPEnvironmentSelection} options.environment The environment to reset. Either 'development', 'tests', or 'all'.
+ * @param {Object}                 options.spinner     A CLI spinner which indicates progress.
+ * @param {boolean}                options.scripts     Indicates whether or not lifecycle scripts should be executed.
+ * @param {boolean}                options.debug       True if debug mode is enabled.
+ * @param {string|null}            options.config      Path to a custom .wp-env.json configuration file.
+ */
+module.exports = async function reset( {
+	environment,
+	spinner,
+	scripts,
+	debug,
+	config: customConfigPath,
+} ) {
+	const config = await loadConfig( path.resolve( '.' ), customConfigPath );
+	const runtime = getRuntime(
+		await detectRuntime( config.workDirectoryPath )
+	);
+
+	await runtime.clean( config, { environment, spinner, debug } );
+
+	if ( scripts ) {
+		await executeLifecycleScript( 'afterReset', config, spinner );
+	}
+};

package/lib/commands/run.js

@@ -2,29 +2,25 @@
 /**
  * External dependencies
  */
-const { spawn } = require( 'child_process' );
 const path = require( 'path' );
 
 /**
  * Internal dependencies
  */
-const initConfig = require( '../init-config' );
-const getHostUser = require( '../get-host-user' );
-
-/**
- * @typedef {import('../config').WPConfig} WPConfig
- */
+const { loadConfig } = require( '../config' );
+const { getRuntime, detectRuntime } = require( '../runtime' );
 
 /**
  * Runs an arbitrary command on the given Docker container.
  *
- * @param {Object}   options
- * @param {string}   options.container The Docker container to run the command on.
- * @param {string[]} options.command   The command to run.
- * @param {string[]} options.'--'      Any arguments that were passed after a double dash.
- * @param {string}   options.envCwd    The working directory for the command to be executed from.
- * @param {Object}   options.spinner   A CLI spinner which indicates progress.
- * @param {boolean}  options.debug     True if debug mode is enabled.
+ * @param {Object}      options
+ * @param {string}      options.container The Docker container to run the command on.
+ * @param {string[]}    options.command   The command to run.
+ * @param {string[]}    options.'--'      Any arguments that were passed after a double dash.
+ * @param {string}      options.envCwd    The working directory for the command to be executed from.
+ * @param {Object}      options.spinner   A CLI spinner which indicates progress.
+ * @param {boolean}     options.debug     True if debug mode is enabled.
+ * @param {string|null} options.config    Path to a custom .wp-env.json configuration file.
  */
 module.exports = async function run( {
 	container,
@@ -33,8 +29,12 @@ module.exports = async function run( {
 	envCwd,
 	spinner,
 	debug,
+	config: customConfigPath,
 } ) {
-	const config = await initConfig( { spinner, debug } );
+	const config = await loadConfig( path.resolve( '.' ), customConfigPath );
+	const runtime = getRuntime(
+		await detectRuntime( config.workDirectoryPath )
+	);
 
 	// Include any double dashed arguments in the command so that we can pass them to Docker.
 	// This lets users pass options that the command defines without them being parsed.
@@ -42,106 +42,5 @@ module.exports = async function run( {
 		command.push( ...doubleDashedArgs );
 	}
 
-	// Shows a contextual tip for the given command.
-	const joinedCommand = command.join( ' ' );
-	showCommandTips( joinedCommand, container, spinner );
-
-	await spawnCommandDirectly( config, container, command, envCwd, spinner );
-
-	spinner.text = `Ran \`${ joinedCommand }\` in '${ container }'.`;
+	await runtime.run( config, { container, command, envCwd, spinner, debug } );
 };
-
-/**
- * Runs an arbitrary command on the given Docker container.
- *
- * @param {WPConfig} config    The wp-env configuration.
- * @param {string}   container The Docker container to run the command on.
- * @param {string[]} command   The command to run.
- * @param {string}   envCwd    The working directory for the command to be executed from.
- * @param {Object}   spinner   A CLI spinner which indicates progress.
- */
-function spawnCommandDirectly( config, container, command, envCwd, spinner ) {
-	// Both the `wordpress` and `tests-wordpress` containers have the host's
-	// user so that they can maintain ownership parity with the host OS.
-	// We should run any commands as that user so that they are able
-	// to interact with the files mounted from the host.
-	const hostUser = getHostUser();
-
-	// Since Docker requires absolute paths, we should resolve the input to a POSIX path.
-	// This is needed because Windows resolves relative paths from the C: drive.
-	envCwd = path.posix.resolve(
-		// Not all containers have the same starting working directory.
-		container === 'mysql' || container === 'tests-mysql'
-			? '/'
-			: '/var/www/html',
-		// Remove spaces and single quotes from both ends of the path.
-		// This is needed because Windows treats single quotes as a literal character.
-		envCwd.trim().replace( /^'|'$/g, '' )
-	);
-
-	const composeCommand = [
-		'compose',
-		'-f',
-		config.dockerComposeConfigPath,
-		'exec',
-		'-w',
-		envCwd,
-		'--user',
-		hostUser.fullUser,
-	];
-
-	if ( ! process.stdout.isTTY ) {
-		composeCommand.push( '-T' );
-	}
-
-	composeCommand.push( container, ...command );
-
-	return new Promise( ( resolve, reject ) => {
-		// Note: since the npm docker-compose package uses the -T option, we
-		// cannot use it to spawn an interactive command. Thus, we run docker-
-		// compose on the CLI directly.
-		const childProc = spawn(
-			'docker',
-			composeCommand,
-			{ stdio: 'inherit' },
-			spinner
-		);
-		childProc.on( 'error', reject );
-		childProc.on( 'exit', ( code ) => {
-			// Code 130 is set if the user tries to exit with ctrl-c before using
-			// ctrl-d (so it is not an error which should fail the script.)
-			if ( code === 0 || code === 130 ) {
-				resolve();
-			} else {
-				reject( `Command failed with exit code ${ code }` );
-			}
-		} );
-	} );
-}
-
-/**
- * This shows a contextual tip for the command being run. Certain commands (like
- * bash) may have weird behavior (exit with ctrl-d instead of ctrl-c or ctrl-z),
- * so we want the user to have that information without having to ask someone.
- *
- * @param {string} joinedCommand The command for which to show a tip joined by spaces.
- * @param {string} container     The container the command will be run on.
- * @param {Object} spinner       A spinner object to show progress.
- */
-function showCommandTips( joinedCommand, container, spinner ) {
-	if ( ! joinedCommand.length ) {
-		return;
-	}
-
-	const tip = `Starting '${ joinedCommand }' on the ${ container } container. ${ ( () => {
-		switch ( joinedCommand ) {
-			case 'bash':
-				return 'Exit bash with ctrl-d.';
-			case 'wp shell':
-				return 'Exit the WordPress shell with ctrl-c.';
-			default:
-				return '';
-		}
-	} )() }\n`;
-	spinner.info( tip );
-}