CLI: Refine site stop --all implementation (#2374)

* Moved logic inside stop command and added flag

* Simplify `site stop --all` implementation

* Use `site stop --all` from Studio

* Fix tests

* Address review comments

---------

Co-authored-by: Volodymyr Makukha <[email protected]>

Author: fredrikekelund

cli/commands/site/stop-all.ts

@@ -1,6 +1,12 @@
-import { __ } from '@wordpress/i18n';
+import { __, _n, sprintf } from '@wordpress/i18n';
 import { SiteCommandLoggerAction as LoggerAction } from 'common/logger-actions';
-import { clearSiteLatestCliPid, getSiteByFolder, updateSiteAutoStart } from 'cli/lib/appdata';
+import {
+	clearSiteLatestCliPid,
+	getSiteByFolder,
+	readAppdata,
+	updateSiteAutoStart,
+	type SiteData,
+} from 'cli/lib/appdata';
 import { connect, disconnect } from 'cli/lib/pm2-manager';
 import { stopProxyIfNoSitesNeedIt } from 'cli/lib/site-utils';
 import { isServerRunning, stopWordPressServer } from 'cli/lib/wordpress-server-manager';
@@ -9,27 +15,112 @@ import { StudioArgv } from 'cli/types';
 
 const logger = new Logger< LoggerAction >();
 
-export async function runCommand( siteFolder: string, autoStart: boolean ): Promise< void > {
-	try {
-		const site = await getSiteByFolder( siteFolder );
+export enum Mode {
+	STOP_SINGLE_SITE,
+	STOP_ALL_SITES,
+}
 
+export async function runCommand(
+	target: Mode.STOP_SINGLE_SITE,
+	siteFolder: string,
+	autoStart: boolean
+): Promise< void >;
+export async function runCommand(
+	target: Mode.STOP_ALL_SITES,
+	siteFolder: undefined,
+	autoStart: boolean
+): Promise< void >;
+export async function runCommand(
+	target: Mode,
+	siteFolder: string | undefined,
+	autoStart: boolean
+): Promise< void > {
+	try {
 		await connect();
 
-		const runningProcess = await isServerRunning( site.id );
-		if ( ! runningProcess ) {
-			logger.reportSuccess( __( 'WordPress site is not running' ) );
-			return;
+		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 site is not running' ) );
+				return;
+			}
+
+			logger.reportStart( LoggerAction.STOP_SITE, __( 'Stopping WordPress site…' ) );
+		} else {
+			const appdata = await readAppdata();
+
+			for ( const site of appdata.sites ) {
+				const runningProcess = await isServerRunning( site.id );
+
+				if ( runningProcess ) {
+					sitesToTarget.push( site );
+				}
+			}
+
+			if ( ! sitesToTarget.length ) {
+				logger.reportSuccess( __( 'No sites are currently running' ) );
+				return;
+			}
+
+			logger.reportStart( LoggerAction.STOP_ALL_SITES, __( 'Stopping all WordPress sites...' ) );
+		}
+
+		const stoppedSiteIds: string[] = [];
+
+		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 ) )
+				);
+			}
 		}
 
-		logger.reportStart( LoggerAction.STOP_SITE, __( 'Stopping WordPress site…' ) );
 		try {
-			await stopWordPressServer( site.id );
-			await clearSiteLatestCliPid( site.id );
-			await updateSiteAutoStart( site.id, autoStart );
-			logger.reportSuccess( __( 'WordPress site stopped' ) );
-			await stopProxyIfNoSitesNeedIt( site.id, logger );
+			await stopProxyIfNoSitesNeedIt( stoppedSiteIds, logger );
 		} catch ( error ) {
-			throw new LoggerError( __( 'Failed to stop WordPress server' ), 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
+					),
+					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
+				)
+			);
 		}
 	} finally {
 		disconnect();
@@ -39,23 +130,36 @@ export async function runCommand( siteFolder: string, autoStart: boolean ): Prom
 export const registerCommand = ( yargs: StudioArgv ) => {
 	return yargs.command( {
 		command: 'stop',
-		describe: __( 'Stop local site' ),
+		describe: __( 'Stop local site(s)' ),
 		builder: ( yargs ) => {
-			return yargs.option( 'auto-start', {
-				type: 'boolean',
-				describe: __( 'Set auto-start flag for the site' ),
-				default: false,
-				hidden: true,
-			} );
+			return yargs
+				.option( 'all', {
+					type: 'boolean',
+					describe: __( 'Stop all local sites' ),
+					default: false,
+				} )
+				.option( 'auto-start', {
+					type: 'boolean',
+					describe: __( 'Set auto-start flag for the site(s)' ),
+					default: false,
+					hidden: true,
+				} );
 		},
 		handler: async ( argv ) => {
 			try {
-				await runCommand( argv.path, argv.autoStart );
+				if ( argv.all ) {
+					await runCommand( Mode.STOP_ALL_SITES, undefined, argv.autoStart );
+				} else {
+					await runCommand( Mode.STOP_SINGLE_SITE, argv.path, argv.autoStart );
+				}
 			} catch ( error ) {
 				if ( error instanceof LoggerError ) {
 					logger.reportError( error );
 				} else {
-					const loggerError = new LoggerError( __( 'Failed to stop site' ), error );
+					const loggerError = new LoggerError(
+						argv.all ? __( 'Failed to stop sites' ) : __( 'Failed to stop site' ),
+						error
+					);
 					logger.reportError( loggerError );
 				}
 			}