Add multi-worker support to the beta features menu. (#2058)

* Add multi-worker support to the beta features menu.

* Making linter happy.

* Remove "experimental" from multi-worker description because it is already in the beta menu

* Fix types

* Fix tests

---------

Co-authored-by: Fredrik Rombach Ekelund <fredrik.rombach.ekelund@automattic.com>

Author: griffbrad

src/ipc-types.d.ts

@@ -86,6 +86,7 @@ interface FeatureFlags {
 
 interface BetaFeatures {
 	studioSitesCli: boolean;
+	multiWorkerSupport: boolean;
 	createSiteFromRemote: boolean;
 }
 

src/lib/beta-features.ts

@@ -14,6 +14,12 @@ const BETA_FEATURES_DEFINITION: Record< keyof BetaFeatures, BetaFeatureDefinitio
 		default: false,
 		description: '"studio site" command to manage local sites from terminal',
 	},
+	multiWorkerSupport: {
+		label: 'Multi-Worker Support',
+		key: 'multiWorkerSupport',
+		default: false,
+		description: 'Enable multi-worker PHP processing for faster performance',
+	},
 	createSiteFromRemote: {
 		label: 'Site creation from existing remote site',
 		key: 'createSiteFromRemote',

src/lib/wordpress-provider/playground-cli/playground-cli-provider.ts

@@ -6,6 +6,7 @@ import { WordPressInstallMode } from '@wp-playground/wordpress';
 import { recursiveCopyDirectory, pathExists, isWordPressDirectory } from 'common/lib/fs-utils';
 import { DEFAULT_LOCALE } from 'common/lib/locale';
 import { isOnline } from 'common/lib/network-utils';
+import { getBetaFeatures } from 'src/lib/beta-features';
 import { getPreferredSiteLanguage } from 'src/lib/site-language';
 import { keepSqliteIntegrationUpdated } from 'src/lib/sqlite-versions';
 import { isValidWordPressVersion } from 'src/lib/wordpress-version-utils';
@@ -26,6 +27,7 @@ export interface PlaygroundCliOptions {
 	autoMount: boolean;
 	wordpressInstallMode: WordPressInstallMode;
 	blueprint?: Blueprint;
+	enableMultiWorker?: boolean;
 }
 
 export const PLAYGROUND_CLI_PROVIDER_NAME = 'playground-cli';
@@ -64,6 +66,13 @@ export class PlaygroundCliProvider implements WordPressProvider {
 		const phpVersion = options.phpVersion || '8.3';
 		const hasWordPress = isWordPressDirectory( options.path );
 
+		// Get beta features to check if multi-worker support is enabled
+		const betaFeatures = await getBetaFeatures();
+
+		if ( betaFeatures.multiWorkerSupport ) {
+			console.log( '[PlaygroundCliProvider] Multi-worker support is enabled via beta features' );
+		}
+
 		const playgroundOptions: PlaygroundCliOptions = {
 			port,
 			phpVersion,
@@ -73,6 +82,7 @@ export class PlaygroundCliProvider implements WordPressProvider {
 				? 'install-from-existing-files-if-needed'
 				: 'download-and-install',
 			blueprint: options.blueprint,
+			enableMultiWorker: betaFeatures.multiWorkerSupport,
 		};
 
 		const serverOptions: WordPressServerOptions = {

src/lib/wordpress-provider/playground-cli/playground-server-process-child.ts

@@ -1,3 +1,4 @@
+import { cpus } from 'os';
 import { SupportedPHPVersion, PHPRunOptions } from '@php-wasm/universal';
 import { __ } from '@wordpress/i18n';
 import { runCLI, RunCLIArgs, RunCLIServer } from '@wp-playground/cli';
@@ -186,6 +187,7 @@ async function startServer(
 		const defaultConstants = {
 			WP_SQLITE_AST_DRIVER: true,
 		};
+
 		const mounts = [
 			{
 				hostPath: options.documentRoot,
@@ -201,7 +203,7 @@ async function startServer(
 			},
 		];
 
-		const args: RunCLIArgs = {
+		const args: RunCLIArgs & { command: 'server' } = {
 			command: 'server',
 			internalCookieStore: false,
 			login: false,
@@ -214,6 +216,15 @@ async function startServer(
 			wordpressInstallMode: options.wordpressInstallMode,
 		};
 
+		// Enable multi-worker support if beta feature is enabled
+		if ( options.enableMultiWorker ) {
+			const workerCount = Math.max( 1, cpus().length - 1 );
+			console.log(
+				`[playground-cli] Enabling experimental multi-worker support with ${ workerCount } workers (CPU cores - 1)`
+			);
+			args.experimentalMultiWorker = workerCount;
+		}
+
 		if ( options.phpVersion ) {
 			args.php = options.phpVersion as SupportedPHPVersion;
 		}
@@ -232,8 +243,11 @@ async function startServer(
 
 		server = await runCLI( args );
 
-		if ( ! server ) {
-			throw new Error( 'Could not start server' );
+		// Log actual worker count for verification
+		if ( options.enableMultiWorker ) {
+			console.log(
+				`[playground-cli] Server started with ${ server.workerThreadCount } worker thread(s)`
+			);
 		}
 
 		if ( serverOptions.adminPassword ) {

src/stores/beta-features-slice.ts

@@ -11,6 +11,7 @@ const initialState: BetaFeaturesState = {
 	features: {
 		studioSitesCli: false,
 		createSiteFromRemote: false,
+		multiWorkerSupport: false,
 	},
 	loading: false,
 };