Studio CLI: Fix Windows E2E tests

cli/commands/site/list.ts

@@ -126,6 +126,9 @@ export async function runCommand( format: 'table' | 'json', watch: boolean ): Pr
 				},
 				{ debounceMs: 500 }
 			);
+
+			process.on( 'SIGINT', disconnect );
+			process.on( 'SIGTERM', disconnect );
 		}
 	} finally {
 		if ( ! watch ) {

cli/commands/wp.ts

@@ -26,6 +26,9 @@ export async function runCommand(
 	const useCustomPhpVersion = options.phpVersion && options.phpVersion !== site.phpVersion;
 
 	if ( ! useCustomPhpVersion ) {
+		process.on( 'SIGINT', disconnect );
+		process.on( 'SIGTERM', disconnect );
+
 		try {
 			await connect();
 
@@ -40,6 +43,9 @@ export async function runCommand(
 		}
 	}
 
+	process.on( 'SIGINT', () => process.exit( 1 ) );
+	process.on( 'SIGTERM', () => process.exit( 1 ) );
+
 	// …If not, instantiate a new Playground instance
 	const [ response, closeWpCliServer ] = await runWpCliCommand(
 		siteFolder,

cli/index.ts

@@ -4,6 +4,7 @@ import { bumpAggregatedUniqueStat, AppdataProvider, LastBumpStatsData } from 'co
 import { suppressPunycodeWarning } from 'common/lib/suppress-punycode-warning';
 import { StatsGroup, StatsMetric } from 'common/types/stats';
 import yargs from 'yargs';
+import { disconnect } from 'cli/lib/pm2-manager';
 import { registerCommand as registerAuthLoginCommand } from 'cli/commands/auth/login';
 import { registerCommand as registerAuthLogoutCommand } from 'cli/commands/auth/logout';
 import { registerCommand as registerAuthStatusCommand } from 'cli/commands/auth/status';
@@ -28,6 +29,23 @@ import { version } from '../package.json';
 
 suppressPunycodeWarning();
 
+// Handle shutdown message from parent process (Electron app).
+// On Windows, child.kill() doesn't send SIGTERM, so we use IPC to notify
+// the CLI to clean up (e.g., disconnect from PM2) before terminating.
+// Only add this listener when running with IPC channel (from Electron app).
+if ( process.send ) {
+	process.on( 'message', ( message: unknown ) => {
+		if ( message && typeof message === 'object' && 'type' in message && message.type === 'shutdown' ) {
+			disconnect();
+			process.exit( 0 );
+		}
+	} );
+	// Allow the process to exit naturally when the main work is done,
+	// even though we have a message listener. The IPC channel will be
+	// cleaned up when the parent terminates.
+	process.channel?.unref();
+}
+
 const cliAppdataProvider: AppdataProvider< LastBumpStatsData > = {
 	load: readAppdata,
 	lock: lockAppdata,

cli/lib/wordpress-server-manager.ts

@@ -34,11 +34,8 @@ const SITE_PROCESS_PREFIX = 'studio-site-';
 // Get an abort signal that's triggered on SIGINT/SIGTERM. This is useful for aborting and cleaning
 // up async operations.
 const abortController = new AbortController();
-function handleProcessTermination() {
-	abortController.abort();
-}
-process.on( 'SIGINT', handleProcessTermination );
-process.on( 'SIGTERM', handleProcessTermination );
+process.on( 'SIGINT', () => abortController.abort() );
+process.on( 'SIGTERM', () => abortController.abort() );
 
 function getProcessName( siteId: string ): string {
 	return `${ SITE_PROCESS_PREFIX }${ siteId }`;

e2e/blueprints.test.ts

@@ -18,7 +18,7 @@ test.describe( 'Blueprints', () => {
 		await onboarding.closeWhatsNew();
 
 		const siteContent = new SiteContent( session.mainWindow, DEFAULT_SITE_NAME );
-		await expect( siteContent.siteNameHeading ).toBeVisible( { timeout: 120_000 } );
+		await expect( siteContent.siteNameHeading ).toBeVisible( { timeout: 200_000 } );
 	} );
 
 	test.afterAll( async () => {
@@ -49,7 +49,7 @@ test.describe( 'Blueprints', () => {
 
 		// Wait for site to be created and running
 		const siteContent = new SiteContent( session.mainWindow, siteName );
-		await expect( siteContent.runningButton ).toBeAttached( { timeout: 120_000 } );
+		await expect( siteContent.runningButton ).toBeAttached( { timeout: 300_000 } );
 
 		// Navigate to Settings tab to get admin URL
 		const settingsTab = await siteContent.navigateToTab( 'Settings' );
@@ -85,7 +85,7 @@ test.describe( 'Blueprints', () => {
 
 		// Wait for site to be created and running
 		const siteContent = new SiteContent( session.mainWindow, siteName );
-		await expect( siteContent.runningButton ).toBeAttached( { timeout: 120_000 } );
+		await expect( siteContent.runningButton ).toBeAttached( { timeout: 300_000 } );
 
 		// Navigate to Settings tab to get admin URL
 		const settingsTab = await siteContent.navigateToTab( 'Settings' );
@@ -123,7 +123,7 @@ test.describe( 'Blueprints', () => {
 
 		// Wait for site to be created and running
 		const siteContent = new SiteContent( session.mainWindow, siteName );
-		await expect( siteContent.runningButton ).toBeAttached( { timeout: 120_000 } );
+		await expect( siteContent.runningButton ).toBeAttached( { timeout: 300_000 } );
 
 		// Navigate to Settings tab to get admin URL
 		const settingsTab = await siteContent.navigateToTab( 'Settings' );
@@ -159,7 +159,7 @@ test.describe( 'Blueprints', () => {
 
 		// Wait for site to be created and running
 		const siteContent = new SiteContent( session.mainWindow, siteName );
-		await expect( siteContent.runningButton ).toBeAttached( { timeout: 120_000 } );
+		await expect( siteContent.runningButton ).toBeAttached( { timeout: 300_000 } );
 
 		// Navigate to Settings tab to get admin URL
 		const settingsTab = await siteContent.navigateToTab( 'Settings' );
@@ -197,7 +197,7 @@ test.describe( 'Blueprints', () => {
 
 		// Wait for site to be created and running
 		const siteContent = new SiteContent( session.mainWindow, siteName );
-		await expect( siteContent.runningButton ).toBeAttached( { timeout: 120_000 } );
+		await expect( siteContent.runningButton ).toBeAttached( { timeout: 300_000 } );
 
 		// Navigate to Settings tab to verify site is accessible
 		const settingsTab = await siteContent.navigateToTab( 'Settings' );
@@ -236,7 +236,7 @@ test.describe( 'Blueprints', () => {
 
 		// Wait for site to be created and running
 		const siteContent = new SiteContent( session.mainWindow, siteName );
-		await expect( siteContent.runningButton ).toBeAttached( { timeout: 120_000 } );
+		await expect( siteContent.runningButton ).toBeAttached( { timeout: 300_000 } );
 
 		// Navigate to Settings tab to verify site is accessible
 		const settingsTab = await siteContent.navigateToTab( 'Settings' );

e2e/e2e-helpers.ts

@@ -39,40 +39,43 @@ export class E2ESession {
 		};
 		await fs.writeFile( appdataPath, JSON.stringify( initialAppdata, null, 2 ) );
 
-		// find the latest build in the out directory
-		const latestBuild = findLatestBuild();
+		await this.launchFirstWindow( testEnv );
+	}
 
-		// parse the packaged Electron app and find paths and other info
-		const appInfo = parseElectronApp( latestBuild );
-		let executablePath = appInfo.executable;
-		if ( appInfo.platform === 'win32' ) {
-			// `parseElectronApp` function obtains the executable path by finding the first executable from the build folder.
-			// We need to ensure that the executable is the Studio app.
-			executablePath = executablePath.replace( 'Squirrel.exe', 'Studio.exe' );
+	// Close the app but keep the data for persistence testing
+	async restart() {
+		await this.closeApp();
+		await this.launchFirstWindow();
+	}
+
+	private async closeApp() {
+		console.log( 'closeApp: starting' );
+		if ( ! this.electronApp ) {
+			console.log( 'closeApp: no electronApp' );
+			return;
 		}
 
-		this.electronApp = await electron.launch( {
-			args: [ appInfo.main ], // main file from package.json
-			executablePath, // path to the Electron executable
-			env: {
-				...process.env,
-				...testEnv,
-				E2E: 'true', // allow app to determine whether it's running as an end-to-end test
-				E2E_APP_DATA_PATH: this.appDataPath,
-				E2E_HOME_PATH: this.homePath,
-			},
-			timeout: 60_000,
+		const childProcess = this.electronApp.process();
+		console.log( 'closeApp: calling electronApp.close() for pid', childProcess.pid );
+		// Cap `ElectronApplication::close` call at 5s to prevent timeout issues on Windows
+		await new Promise( ( resolve, reject ) => {
+			Promise.race( [
+				this.electronApp.close(),
+				new Promise( ( resolve ) => setTimeout( resolve, 5000 ) ),
+			] )
+				.then( resolve )
+				.catch( reject );
 		} );
-		this.mainWindow = await this.electronApp.firstWindow( { timeout: 60_000 } );
+		console.log( 'closeApp: close() returned' );
 	}
 
-	// Close the app but keep the data for persistence testing
-	async restart() {
-		await this.electronApp?.close();
+	private async launchFirstWindow( testEnv: NodeJS.ProcessEnv = {} ) {
 		const latestBuild = findLatestBuild();
 		const appInfo = parseElectronApp( latestBuild );
 		let executablePath = appInfo.executable;
 		if ( appInfo.platform === 'win32' ) {
+			// `parseElectronApp` function obtains the executable path by finding the first executable from
+			// the build folder. We need to ensure that the executable is the Studio app.
 			executablePath = executablePath.replace( 'Squirrel.exe', 'Studio.exe' );
 		}
 
@@ -81,6 +84,7 @@ export class E2ESession {
 			executablePath,
 			env: {
 				...process.env,
+				...testEnv,
 				E2E: 'true',
 				E2E_APP_DATA_PATH: this.appDataPath,
 				E2E_HOME_PATH: this.homePath,
@@ -91,8 +95,11 @@ export class E2ESession {
 	}
 
 	async cleanup() {
-		await this.electronApp?.close();
-		// Clean up temporary folder to hold application data
-		fs.rmSync( this.sessionPath, { recursive: true, force: true } );
+		await this.closeApp();
+
+		// Removing the `sessionPath` directory has proven to be difficult, especially on Windows. Since
+		// session paths are unique, the WordPress installations are relatively small, and the E2E tests
+		// primarily run in ephemeral CI workers, we've decided to fix this issue by simply not removing
+		// the `sessionPath` directory.
 	}
 }

e2e/fixtures/blueprints/activate-plugin.json

@@ -4,7 +4,7 @@
 	"steps": [
 		{
 			"step": "installPlugin",
-			"pluginZipFile": {
+			"pluginData": {
 				"resource": "wordpress.org/plugins",
 				"slug": "hello-dolly"
 			}
@@ -14,4 +14,4 @@
 			"pluginPath": "hello-dolly/hello.php"
 		}
 	]
-}
+}

e2e/fixtures/blueprints/activate-theme.json

@@ -4,7 +4,7 @@
 	"steps": [
 		{
 			"step": "installTheme",
-			"themeZipFile": {
+			"themeData": {
 				"resource": "wordpress.org/themes",
 				"slug": "twentytwentyone"
 			}
@@ -14,4 +14,4 @@
 			"themeFolderName": "twentytwentyone"
 		}
 	]
-}
+}

e2e/fixtures/blueprints/install-plugin.json

@@ -4,10 +4,10 @@
 	"steps": [
 		{
 			"step": "installPlugin",
-			"pluginZipFile": {
+			"pluginData": {
 				"resource": "wordpress.org/plugins",
 				"slug": "akismet"
 			}
 		}
 	]
-}
+}

e2e/fixtures/blueprints/install-theme.json

@@ -4,10 +4,10 @@
 	"steps": [
 		{
 			"step": "installTheme",
-			"themeZipFile": {
+			"themeData": {
 				"resource": "wordpress.org/themes",
 				"slug": "twentytwentytwo"
 			}
 		}
 	]
-}
+}

e2e/localization.test.ts

@@ -139,7 +139,7 @@ test.describe( 'Localization', () => {
 
 		// Wait for site to be created
 		const siteContent = new SiteContent( session.mainWindow, siteName );
-		await expect( siteContent.runningButton ).toBeAttached( { timeout: 120_000 } );
+		await expect( siteContent.runningButton ).toBeAttached( { timeout: 200_000 } );
 
 		const settingsTabButton = session.mainWindow.getByRole( 'tab', { name: /Settings|設定/i } );
 		await settingsTabButton.click();

e2e/site-navigation.test.ts

@@ -49,7 +49,7 @@ test.describe( 'Site Navigation', () => {
 
 		// Wait for default site to be ready and get URLs
 		const siteContent = new SiteContent( session.mainWindow, siteName );
-		await expect( siteContent.siteNameHeading ).toBeVisible( { timeout: 120_000 } );
+		await expect( siteContent.runningButton ).toBeAttached( { timeout: 120_000 } );
 
 		// Get site URLs for tests
 		const settingsTab = await siteContent.navigateToTab( 'Settings' );