Studio CLI: Fix Windows E2E tests (#2299)

* Abort async operations on SIGTERM/SIGINT

* Also send abort message to child server

* Only create AbortController when topic is not `abort`

* Fix

* More fixes

* Tweaks

* Fix unit tests

* Fix types

* Remove `this.sessionPath` files individually

To help us diagnose which specific files or directories are causing trouble

* Stop running servers in a detached process

* Revert "Remove `this.sessionPath` files individually"

This reverts commit 8786163.

* Retry

* Increase timeouts

* Fix deprecated blueprint syntax

* Increase timeout

* Try adding a small delay

* Kill `site list --watch` on SIGINT

* Create main window after creating site watcher

* Try using async fs method for cleanup

* Try rimraf (which has advanced retry strategies)

* New approach: don't remove `sessionPath` dir

* Unused import

* Force close app

* disconnect from pm2 in response to SIGTERM

* Revert user data watcher changes from #2313

* Wait for running button

* Use Electron's will-quit event in `execute-command.ts`

* SIGINT and SIGTERM listeners in `wp` command

* More SIGINT and SIGTERM listeners in `wp` command

* Temporarily skip blueprints test

* Revert "Temporarily skip blueprints test"

This reverts commit 0d16ae5.

* Try with force kill again

* Logging

* New approach to waiting for app close

* Logging again

* Try to make all child processes detached

* Experiment

* Revert "Experiment"

This reverts commit 3596bac.

* Revert "Try to make all child processes detached"

This reverts commit f99f4b0.

* Try a 5s timeout for closing the app

* Experiment with removing stopAllServersOnQuit

* shutdown message

* Revert "shutdown message"

This reverts commit 9d56d0c.

* Revert E2ESession::closeApp implementation

* Temporarily skip app.test.ts

* Temporarily skip blueprints.test.ts

* Revert "Temporarily skip app.test.ts"

This reverts commit 8307750.

* Revert "Temporarily skip blueprints.test.ts"

This reverts commit 9d78492.

* Add logging to Playwright source code

* pidtree

* More playwright logging

* More logging and await pidtree

* pidtree after close

* Remove stdio listeners

* Fix pidtree logging after close

* destroy stdio streams on exit

* Disconnect IPC

* Try teardown workaround

* Log pid and result in will-quit handler

* Unregister will-quit handlers

* Bring back logging

* Stop all servers on quit

* Undo all Windows hacks in E2ESession

* Bring back tree-kill

* Log stop-all pid and pidtree

* Catch errors from tree-kill

* Remove pidtree

* No IPC channel in stopAllServersOnQuit

* Update playwright-core patch to test theory

* Fix patch

* `spawn` over `fork`

* Temporarily remove `stopAllServersOnQuit`

* Never call `electronApp.close` on Windows

* Restore `e2e/e2e-helpers.ts`

* Reinstate `stopAllServersOnQuit`

* Revert `spawn` and IPC channel theory

* Fix unit tests

* Remove playwright-core patch

* Remove tree-kill dependency

* Remove `started` event

* More lenient child process cleanup

* Revert "Remove `started` event"

This reverts commit b42fa0b.

* Destroy stdio streams again

* Explicitly disconnect IPC

* Clean up `E2ESession`

* Always call `killRemainingProcesses`

* Reset test timeouts

* No `detached` option

* Reset more test timings

* Only prevent `will-quit` when applicable

* fix e2e test

* Children connect to pm2 daemon in sequence

* Fix unit tests

* Kill pm2 daemon in `site stop --all` command

* Fix stop command unit test, async disconnect, `process.exit`

* Remove stray `console.info` calls

* Undo all hacks in `E2ESession`

* Restore `E2ESession`, but don't kill children

* Increase timeout

* Don't log child pids

* Experimental: detach `site stop --all` again

* Clean up session files again

* Let's give rimraf one more try

* Experiment with removing `child.disconnect()` call

* Don't destroy stdio streams on exit

* Always run `site stop --all` command if pending update

* Notify Studio if user runs `site stop --all`

* Fix `package-lock.json` diff

* Fix and document "stop sites on exit" logic

* Speed up `site stop --all`

* Fix logic

* Revert "Experimental: detach `site stop --all` again"

This reverts commit 01ae1c4.

* String tweaks

---------

Co-authored-by: bcotrim <bernardo.cotrim@a8c.com>

Author: fredrikekelund

cli/commands/site/create.ts

@@ -336,7 +336,7 @@ export async function runCommand(
 		logger.reportKeyValuePair( 'id', siteDetails.id );
 		logger.reportKeyValuePair( 'running', String( siteDetails.running ) );
 	} finally {
-		disconnect();
+		await disconnect();
 	}
 }
 

cli/commands/site/delete.ts

@@ -65,14 +65,14 @@ export async function runCommand(
 	deleteFiles: boolean = false
 ): Promise< void > {
 	try {
-		logger.reportStart( LoggerAction.LOAD_SITES, __( 'Loading site…' ) );
-		const site = await getSiteByFolder( siteFolder );
-		logger.reportSuccess( __( 'Site loaded' ) );
-
 		logger.reportStart( LoggerAction.START_DAEMON, __( 'Starting process daemon…' ) );
 		await connect();
 		logger.reportSuccess( __( 'Process daemon started' ) );
 
+		logger.reportStart( LoggerAction.LOAD_SITES, __( 'Loading site…' ) );
+		const site = await getSiteByFolder( siteFolder );
+		logger.reportSuccess( __( 'Site loaded' ) );
+
 		const runningProcess = await isServerRunning( site.id );
 		if ( runningProcess ) {
 			logger.reportStart( LoggerAction.STOP_SITE, __( 'Stopping WordPress server…' ) );
@@ -126,7 +126,7 @@ export async function runCommand(
 			logger.reportSuccess( __( 'Site files deleted' ) );
 		}
 	} finally {
-		disconnect();
+		await disconnect();
 	}
 }
 

cli/commands/site/list.ts

@@ -2,7 +2,7 @@ import { __, _n, sprintf } from '@wordpress/i18n';
 import Table from 'cli-table3';
 import { SiteCommandLoggerAction as LoggerAction } from 'common/logger-actions';
 import { getSiteUrl, readAppdata, type SiteData } from 'cli/lib/appdata';
-import { connect, disconnect } from 'cli/lib/pm2-manager';
+import { connect, disconnect, subscribePm2KillEvent } from 'cli/lib/pm2-manager';
 import { getColumnWidths, getPrettyPath } from 'cli/lib/utils';
 import { isServerRunning, subscribeSiteEvents } from 'cli/lib/wordpress-server-manager';
 import { Logger, LoggerError } from 'cli/logger';
@@ -126,10 +126,24 @@ export async function runCommand( format: 'table' | 'json', watch: boolean ): Pr
 				},
 				{ debounceMs: 500 }
 			);
+
+			await subscribePm2KillEvent( () => {
+				for ( const site of sitesData ) {
+					const payload = {
+						siteId: site.id,
+						status: 'stopped',
+						url: site.url,
+					};
+					logger.reportKeyValuePair( 'site-status', JSON.stringify( payload ) );
+				}
+			} );
+
+			process.on( 'SIGINT', disconnect );
+			process.on( 'SIGTERM', disconnect );
 		}
 	} finally {
 		if ( ! watch ) {
-			disconnect();
+			await disconnect();
 		}
 	}
 }

cli/commands/site/set.ts

@@ -246,7 +246,7 @@ export async function runCommand(
 
 		return { usedWpCli: wpChanged };
 	} finally {
-		disconnect();
+		await disconnect();
 	}
 }
 

cli/commands/site/start.ts

@@ -16,14 +16,14 @@ export async function runCommand(
 	skipLogDetails = false
 ): Promise< void > {
 	try {
-		logger.reportStart( LoggerAction.LOAD_SITES, __( 'Loading site…' ) );
-		const site = await getSiteByFolder( sitePath );
-		logger.reportSuccess( __( 'Site loaded' ) );
-
 		logger.reportStart( LoggerAction.START_DAEMON, __( 'Starting process daemon…' ) );
 		await connect();
 		logger.reportSuccess( __( 'Process daemon started' ) );
 
+		logger.reportStart( LoggerAction.LOAD_SITES, __( 'Loading site…' ) );
+		const site = await getSiteByFolder( sitePath );
+		logger.reportSuccess( __( 'Site loaded' ) );
+
 		const runningProcess = await isServerRunning( site.id );
 		if ( runningProcess ) {
 			logger.reportSuccess( __( 'WordPress server is already running' ) );
@@ -67,7 +67,7 @@ export async function runCommand(
 			throw new LoggerError( __( 'Failed to start WordPress server' ), error );
 		}
 	} finally {
-		disconnect();
+		await disconnect();
 	}
 }
 

cli/commands/site/status.ts

@@ -13,12 +13,14 @@ const logger = new Logger< LoggerAction >();
 
 export async function runCommand( siteFolder: string, format: 'table' | 'json' ): Promise< void > {
 	try {
+		logger.reportStart( LoggerAction.START_DAEMON, __( 'Starting process daemon…' ) );
+		await connect();
+		logger.reportSuccess( __( 'Process daemon started' ) );
+
 		logger.reportStart( LoggerAction.LOAD_SITES, __( 'Loading site…' ) );
 		const site = await getSiteByFolder( siteFolder );
 		logger.reportSuccess( __( 'Site loaded' ) );
 
-		await connect();
-
 		const isOnline = Boolean( await isServerRunning( site.id ) );
 		const status = isOnline ? `🟢 ${ __( 'Online' ) }` : `🔴 ${ __( 'Offline' ) }`;
 		const siteUrl = getSiteUrl( site );
@@ -74,7 +76,7 @@ export async function runCommand( siteFolder: string, format: 'table' | 'json' )
 			console.log( JSON.stringify( logData, null, 2 ) );
 		}
 	} finally {
-		disconnect();
+		await disconnect();
 	}
 }
 

cli/commands/site/stop.ts

@@ -3,11 +3,14 @@ import { SiteCommandLoggerAction as LoggerAction } from 'common/logger-actions';
 import {
 	clearSiteLatestCliPid,
 	getSiteByFolder,
+	lockAppdata,
 	readAppdata,
+	saveAppdata,
+	unlockAppdata,
 	updateSiteAutoStart,
 	type SiteData,
 } from 'cli/lib/appdata';
-import { connect, disconnect } from 'cli/lib/pm2-manager';
+import { connect, disconnect, killDaemonAndAllChildren } from 'cli/lib/pm2-manager';
 import { stopProxyIfNoSitesNeedIt } from 'cli/lib/site-utils';
 import { isServerRunning, stopWordPressServer } from 'cli/lib/wordpress-server-manager';
 import { Logger, LoggerError } from 'cli/logger';
@@ -38,92 +41,76 @@ export async function runCommand(
 	try {
 		await connect();
 
-		const sitesToTarget: SiteData[] = [];
-
 		if ( target === Mode.STOP_SINGLE_SITE && siteFolder ) {
 			const site = await getSiteByFolder( siteFolder );
-			sitesToTarget.push( site );
-
 			const runningProcess = await isServerRunning( site.id );
 			if ( ! runningProcess ) {
 				logger.reportSuccess( __( 'WordPress server is not running' ) );
 				return;
 			}
 
-			logger.reportStart( LoggerAction.STOP_SITE, __( 'Stopping WordPress server…' ) );
+			logger.reportStart( LoggerAction.STOP_SITE, __( 'Stopping WordPress servers…' ) );
+
+			try {
+				await stopWordPressServer( site.id );
+				await clearSiteLatestCliPid( site.id );
+				await updateSiteAutoStart( site.id, autoStart );
+				logger.reportSuccess( __( 'WordPress server stopped' ) );
+				await stopProxyIfNoSitesNeedIt( site.id, logger );
+			} catch ( error ) {
+				throw new LoggerError( __( 'Failed to stop WordPress server' ), error );
+			}
 		} else {
 			const appdata = await readAppdata();
+			const runningSites: SiteData[] = [];
 
 			for ( const site of appdata.sites ) {
 				const runningProcess = await isServerRunning( site.id );
 
 				if ( runningProcess ) {
-					sitesToTarget.push( site );
+					runningSites.push( site );
 				}
 			}
 
-			if ( ! sitesToTarget.length ) {
+			if ( ! runningSites.length ) {
 				logger.reportSuccess( __( 'No sites are currently running' ) );
 				return;
 			}
 
-			logger.reportStart( LoggerAction.STOP_ALL_SITES, __( 'Stopping all WordPress sites...' ) );
-		}
-
-		const stoppedSiteIds: string[] = [];
+			logger.reportStart( LoggerAction.STOP_ALL_SITES, __( 'Stopping all WordPress servers…' ) );
+			await killDaemonAndAllChildren();
 
-		for ( const site of sitesToTarget ) {
 			try {
-				logger.reportProgress(
-					sprintf(
-						__( 'Stopping site "%s" (%d/%d)…' ),
-						site.name,
-						stoppedSiteIds.length + 1,
-						sitesToTarget.length
-					)
-				);
-				await stopWordPressServer( site.id );
-				await clearSiteLatestCliPid( site.id );
-				await updateSiteAutoStart( site.id, autoStart );
-
-				stoppedSiteIds.push( site.id );
-			} catch ( error ) {
-				logger.reportError(
-					new LoggerError( sprintf( __( 'Failed to stop site %s' ), site.name ) )
-				);
+				await lockAppdata();
+				const appdata = await readAppdata();
+				for ( const site of appdata.sites ) {
+					if ( runningSites.find( ( r ) => r.id === site.id ) ) {
+						delete site.latestCliPid;
+						site.autoStart = autoStart;
+					}
+				}
+				await saveAppdata( appdata );
+			} finally {
+				await unlockAppdata();
 			}
-		}
-
-		try {
-			await stopProxyIfNoSitesNeedIt( stoppedSiteIds, logger );
-		} catch ( error ) {
-			throw new LoggerError( __( 'Failed to stop proxy server' ), error );
-		}
 
-		if ( stoppedSiteIds.length === sitesToTarget.length ) {
 			logger.reportSuccess(
 				sprintf(
 					_n(
 						'Successfully stopped %d site',
 						'Successfully stopped %d sites',
-						sitesToTarget.length
+						runningSites.length
 					),
-					sitesToTarget.length
-				)
-			);
-		} else if ( stoppedSiteIds.length === 0 && sitesToTarget.length === 0 ) {
-			throw new LoggerError( __( 'Failed to stop site' ) );
-		} else {
-			throw new LoggerError(
-				sprintf(
-					_n( 'Stopped %d site out of %d', 'Stopped %d sites out of %d', stoppedSiteIds.length ),
-					stoppedSiteIds.length,
-					sitesToTarget.length
+					runningSites.length
 				)
 			);
+
+			// Calling `pm2.killDaemon` requires us to forcefully exit the process. pm2 does the same
+			// thing internally in its CLI.
+			process.exit( 0 );
 		}
 	} finally {
-		disconnect();
+		await disconnect();
 	}
 }