wp-env: Migrate to Compose V2

Update docker-compose package to 0.24.1 Use v2 as dockerCompose command Fixes #51249
WordPress · Dec 5, 2023 · f25bb2b · f25bb2b
1 parent 743e0b6
commit f25bb2b
Show file tree

Hide file tree

Showing 13 changed files with 57 additions and 28 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/env/CHANGELOG.md b/packages/env/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Breaking Change
+
+- Update Docker usage to `docker compose` V2 following [deprecation](https://docs.docker.com/compose/migrate/) of `docker-compose` V1.
+
 ## 8.13.0 (2023-11-29)
 
 ## 8.12.0 (2023-11-16)

diff --git a/packages/env/lib/cli.js b/packages/env/lib/cli.js
@@ -58,10 +58,10 @@ const withSpinner =
 					'err' in error &&
 					'out' in error
 				) {
-					// Error is a docker-compose error. That means something docker-related failed.
+					// Error is a docker compose error. That means something docker-related failed.
 					// https://github.com/PDMLab/docker-compose/blob/HEAD/src/index.ts
 					spinner.fail(
-						'Error while running docker-compose command.'
+						'Error while running docker compose command.'
 					);
 					if ( error.out ) {
 						process.stdout.write( error.out );

diff --git a/packages/env/lib/commands/clean.js b/packages/env/lib/commands/clean.js
@@ -2,7 +2,7 @@
 /**
  * External dependencies
  */
-const dockerCompose = require( 'docker-compose' );
+const { v2: dockerCompose } = require( 'docker-compose' );
 
 /**
  * Internal dependencies

diff --git a/packages/env/lib/commands/destroy.js b/packages/env/lib/commands/destroy.js
@@ -2,7 +2,7 @@
 /**
  * External dependencies
  */
-const dockerCompose = require( 'docker-compose' );
+const { v2: dockerCompose } = require( 'docker-compose' );
 const util = require( 'util' );
 const fs = require( 'fs' ).promises;
 const path = require( 'path' );

diff --git a/packages/env/lib/commands/logs.js b/packages/env/lib/commands/logs.js
@@ -2,7 +2,7 @@
 /**
  * External dependencies
  */
-const dockerCompose = require( 'docker-compose' );
+const { v2: dockerCompose } = require( 'docker-compose' );
 
 /**
  * Internal dependencies

diff --git a/packages/env/lib/commands/run.js b/packages/env/lib/commands/run.js
@@ -78,6 +78,7 @@ function spawnCommandDirectly( config, container, command, envCwd, spinner ) {
 	);
 
 	const composeCommand = [
+		'compose',
 		'-f',
 		config.dockerComposeConfigPath,
 		'exec',
@@ -98,7 +99,7 @@ function spawnCommandDirectly( config, container, command, envCwd, spinner ) {
 		// cannot use it to spawn an interactive command. Thus, we run docker-
 		// compose on the CLI directly.
 		const childProc = spawn(
-			'docker-compose',
+			'docker',
 			composeCommand,
 			{ stdio: 'inherit' },
 			spinner

diff --git a/packages/env/lib/commands/start.js b/packages/env/lib/commands/start.js
@@ -2,7 +2,7 @@
 /**
  * External dependencies
  */
-const dockerCompose = require( 'docker-compose' );
+const { v2: dockerCompose } = require( 'docker-compose' );
 const util = require( 'util' );
 const path = require( 'path' );
 const fs = require( 'fs' ).promises;

diff --git a/packages/env/lib/commands/stop.js b/packages/env/lib/commands/stop.js
@@ -2,7 +2,7 @@
 /**
  * External dependencies
  */
-const dockerCompose = require( 'docker-compose' );
+const { v2: dockerCompose } = require( 'docker-compose' );
 
 /**
  * Internal dependencies

diff --git a/packages/env/lib/test/cli.js b/packages/env/lib/test/cli.js
@@ -138,7 +138,7 @@ describe( 'env cli', () => {
 		await env.start.mock.results[ 0 ].value.catch( () => {} );
 
 		expect( spinner.fail ).toHaveBeenCalledWith(
-			'Error while running docker-compose command.'
+			'Error while running docker compose command.'
 		);
 		expect( process.stderr.write ).toHaveBeenCalledWith( 'failure error' );
 		expect( process.exit ).toHaveBeenCalledWith( 1 );

diff --git a/packages/env/lib/wordpress.js b/packages/env/lib/wordpress.js
@@ -2,7 +2,7 @@
 /**
  * External dependencies
  */
-const dockerCompose = require( 'docker-compose' );
+const { v2: dockerCompose } = require( 'docker-compose' );
 const util = require( 'util' );
 const fs = require( 'fs' ).promises;
 const path = require( 'path' );

diff --git a/packages/env/package.json b/packages/env/package.json
@@ -34,7 +34,7 @@
 	"dependencies": {
 		"chalk": "^4.0.0",
 		"copy-dir": "^1.3.0",
-		"docker-compose": "^0.22.2",
+		"docker-compose": "^0.24.3",
 		"extract-zip": "^1.6.7",
 		"got": "^11.8.5",
 		"inquirer": "^7.1.0",

diff --git a/test/unit/jest.config.js b/test/unit/jest.config.js
@@ -39,6 +39,10 @@ module.exports = {
 	transform: {
 		'^.+\\.[jt]sx?$': '<rootDir>/test/unit/scripts/babel-transformer.js',
 	},
+	transformIgnorePatterns: [
+		'/node_modules/(?!(docker-compose|yaml)/)',
+		'\\.pnp\\.[^\\/]+$',
+	],
 	snapshotSerializers: [
 		'@emotion/jest/serializer',
 		'snapshot-diff/serializer',