Use spawnSync to ensure args with spaces are passed properly

Author: westonruter

tools/local-env/scripts/docker.js

@@ -2,7 +2,7 @@
 
 const dotenv       = require( 'dotenv' );
 const dotenvExpand = require( 'dotenv-expand' );
-const { execSync } = require( 'child_process' );
+const { spawnSync } = require( 'child_process' );
 const local_env_utils = require( './utils' );
 
 dotenvExpand.expand( dotenv.config() );
@@ -17,7 +17,15 @@ if (process.argv.includes('--coverage-html')) {
 // This try-catch prevents the superfluous Node.js debugging information from being shown if the command fails.
 try {
 	// Execute any Docker compose command passed to this script.
-	execSync( 'docker compose ' + composeFiles + ' ' + process.argv.slice( 2 ).join( ' ' ), { stdio: 'inherit' } );
+	spawnSync(
+		'docker',
+		[
+			'compose',
+			...composeFiles.map( ( composeFile ) => [ '-f', composeFile ] ).flat(),
+			...process.argv.slice( 2 )
+		],
+		{ stdio: 'inherit' }
+	);
 } catch ( error ) {
 	process.exit( 1 );
 }

tools/local-env/scripts/start.js

@@ -2,7 +2,7 @@
 
 const dotenv       = require( 'dotenv' );
 const dotenvExpand = require( 'dotenv-expand' );
-const { execSync } = require( 'child_process' );
+const { execSync, spawnSync } = require( 'child_process' );
 const local_env_utils = require( './utils' );
 const { constants, copyFile } = require( 'node:fs' );
 
@@ -34,15 +34,34 @@ const containers = [ 'wordpress-develop', 'cli' ];
 if ( process.env.LOCAL_PHP_MEMCACHED === 'true' ) {
 	containers.push( 'memcached' );
 }
-execSync( `docker compose ${composeFiles} up --quiet-pull -d ${containers.join( ' ' )}`, { stdio: 'inherit' } );
+
+spawnSync(
+	'docker',
+	[
+		'compose',
+		...composeFiles.map( ( composeFile ) => [ '-f', composeFile ] ).flat(),
+		'up',
+		'--quiet-pull',
+		'-d',
+		...containers,
+	],
+	{ stdio: 'inherit' }
+);
 
 // If Docker Toolbox is being used, we need to manually forward LOCAL_PORT to the Docker VM.
 if ( process.env.DOCKER_TOOLBOX_INSTALL_PATH ) {
 	// VBoxManage is added to the PATH on every platform except Windows.
 	const vboxmanage = process.env.VBOX_MSI_INSTALL_PATH ? `${ process.env.VBOX_MSI_INSTALL_PATH }/VBoxManage` : 'VBoxManage';
 
 	// Check if the port forwarding is already configured for this port.
-	const vminfoBuffer = execSync( `"${ vboxmanage }" showvminfo "${ process.env.DOCKER_MACHINE_NAME }" --machinereadable` );
+	const vminfoBuffer = spawnSync(
+		vboxmanage,
+		[
+			'showvminfo',
+			process.env.DOCKER_MACHINE_NAME,
+			'--machinereadable'
+		]
+	).stdout;
 	const vminfo = vminfoBuffer.toString().split( /[\r\n]+/ );
 
 	vminfo.forEach( ( info ) => {
@@ -56,10 +75,29 @@ if ( process.env.DOCKER_TOOLBOX_INSTALL_PATH ) {
 
 		// Delete rules that are using the port we need.
 		if ( rule[ 3 ] === process.env.LOCAL_PORT || rule[ 5 ] === process.env.LOCAL_PORT ) {
-			execSync( `"${ vboxmanage }" controlvm "${ process.env.DOCKER_MACHINE_NAME }" natpf1 delete ${ rule[ 0 ] }`, { stdio: 'inherit' } );
+			spawnSync(
+				vboxmanage,
+				[
+					'controlvm',
+					process.env.DOCKER_MACHINE_NAME,
+					'natpf1',
+					'delete',
+					rule[ 0 ]
+				],
+				{ stdio: 'inherit' }
+			);
 		}
 	} );
 
 	// Add our port forwarding rule.
-	execSync( `"${ vboxmanage }" controlvm "${ process.env.DOCKER_MACHINE_NAME }" natpf1 "tcp-port${ process.env.LOCAL_PORT },tcp,127.0.0.1,${ process.env.LOCAL_PORT },,${ process.env.LOCAL_PORT }"`, { stdio: 'inherit' } );
+	spawnSync(
+		vboxmanage,
+		[
+			'controlvm',
+			process.env.DOCKER_MACHINE_NAME,
+			'natpf1',
+			`tcp-port${ process.env.LOCAL_PORT },tcp,127.0.0.1,${ process.env.LOCAL_PORT },,${ process.env.LOCAL_PORT }`
+		],
+		{ stdio: 'inherit' }
+	);
 }

tools/local-env/scripts/utils.js

@@ -12,12 +12,14 @@ const local_env_utils = {
 	 *
 	 * When PHP 7.2 or 7.3 is used in combination with MySQL 8.4, an override file will also be returned to ensure
 	 * that the mysql_native_password plugin authentication plugin is on and available for use.
+	 *
+	 * @return {string[]} Compose files.
 	 */
 	get_compose_files: function() {
-		var composeFiles = '-f docker-compose.yml';
+		const composeFiles = [ 'docker-compose.yml' ];
 
 		if ( existsSync( 'docker-compose.override.yml' ) ) {
-			composeFiles = composeFiles + ' -f docker-compose.override.yml';
+			composeFiles.push( 'docker-compose.override.yml' );
 		}
 
 		if ( process.env.LOCAL_DB_TYPE !== 'mysql' ) {
@@ -30,7 +32,7 @@ const local_env_utils = {
 
 		// PHP 7.2/7.3 in combination with MySQL 8.4 requires additional configuration to function properly.
 		if ( process.env.LOCAL_DB_VERSION === '8.4' ) {
-			composeFiles = composeFiles + ' -f tools/local-env/old-php-mysql-84.override.yml';
+			composeFiles.push( 'tools/local-env/old-php-mysql-84.override.yml' );
 		}
 
 		return composeFiles;