Studio: Refactor Studio to depend on the CLI for starting sites by bcotrim · Pull Request #2172 · Automattic/studio

bcotrim · 2025-12-02T19:18:41Z

Related issues

Fixes STU-1019

Proposed Changes

Add --watch to studio site list
Add watcher to Studio to listen to site status changes
Implemented createCliServerProcess so Studio can start and stop sites using Studio CLI

Testing Instructions

npm install
npm start
Start a new site using Studio
Confirm site is running
Stop site using Studio
Confirm site is not running
Confirm studio site list returns the correct status for the site
Start site using Studio CLI
Confirm Studio shows the site as running
Stop the site using Studio CLI
Confirm Studio shows the site as stopped

Pre-merge Checklist

Have you checked for TypeScript, React or other console errors?

fredrikekelund

Great work, @bcotrim! 👍 Very satisfying to see this come together. It's working nicely in my testing so far.

I left a couple of smaller comments.

I'd also be interested to hear your perspective of this site list --watch approach vs watching the config file for changes and using some mechanism (a version of the studio site status command, perhaps) to check the site status when latestCliPid changes. I don't really have a strong opinion there, but it would be good to have a documented reason for going one way or the other.

fredrikekelund · 2025-12-04T14:45:04Z

cli/commands/site/list.ts

+					choices: [ 'table', 'json' ],
+					default: 'table',
+					description: __( 'Output format' ),
+				} )
+				.option( 'watch', {
+					type: 'boolean',
+					default: false,
+					description: __( 'Watch for site status changes and update the list in real-time' ),
+				} );
 		},
 		handler: async ( argv ) => {
 			try {
-				await runCommand( argv.format as 'table' | 'json' );
+				await runCommand( argv.format as 'table' | 'json', argv.watch as boolean );


choices: [ 'table', 'json' ] as const, default: 'table' as const, description: __( 'Output format' ), } ) .option( 'watch', { type: 'boolean', default: false, description: __( 'Watch for site status changes and update the list in real-time' ), } ); }, handler: async ( argv ) => { try { await runCommand( argv.format, argv.watch );

Kind of a nitpick, but that's how we get yargs to provide the correct types for the options.

fredrikekelund · 2025-12-04T15:01:23Z

src/index.ts

@@ -391,8 +392,8 @@ async function appBoot() {

 	app.on( 'quit', () => {
 		void stopAllServersOnQuit();


This will kill all running processes, regardless of whether they were started from the CLI or from the app. We could just accept this behavior, but @nightnei also had a pretty good idea to display a simple modal before quitting the app that says "Do you want to stop the running sites? Yes / Leave them runing"

I like that idea! I would add a "remember my decision" checkbox. I think that provides enough tools for our users to adjust their experience as it work best for them. We can always revisit in the future.
Should I handle that change in this PR or as part of STU-1078 ?

I created STU-1112 to tackle this separately

fredrikekelund · 2025-12-04T15:05:27Z

src/ipc-handlers.ts

+	// CLI-managed sites don't have PHP instance, return cached theme details for Now
+	// ToDo: Implement logic to fetch theme details using mu-plugin?
+	if ( ! server.server.php ) {
+		return server.details.themeDetails;
+	}


Once we have WP-CLI support, we might also consider using the wp eval command

fredrikekelund · 2025-12-04T15:21:20Z

src/modules/cli/lib/execute-command.ts

+export function executeCliCommand(
+	args: string[],
+	options: ExecuteCliCommandOptions = {}
+): CliCommandEventEmitter {


Suggested change

): CliCommandEventEmitter {

): [CliCommandEventEmitter, ChildProcess] {

Optional, but we could return the child process instance from this function, too. It would save us from the dance of having to set the kill function on the EventEmitter

fredrikekelund

It looks like the e2e/blueprints.test.ts tests are still failing, but I guess that's expected so long as we're in this intermittent state of using the Studio CLI to start sites, but still using Playground CLI to create sites.

Other than that, this looks good! 👍 I left a couple of comments. No huge blockers. The biggest one is probably to remove pm2ProcessMessageSchema in favor of childMessagePm2Schema

fredrikekelund · 2025-12-08T09:19:26Z

cli/logger.ts

+	/**
+	 * Get the underlying ora spinner instance.
+	 * Useful for sharing with other modules that need to update progress.
+	 */
+	public get spinner(): Ora {
+		return this._spinner;
 	}


This seems like a leftover, right? We could probably change the _spinner prop back to spinner

fredrikekelund · 2025-12-08T09:21:44Z

cli/lib/pm2-manager.ts

+	const bus = await getPm2Bus();
+
+	const messageHandler = ( packet: unknown ) => {
+		const result = pm2ProcessMessageSchema.safeParse( packet );


Suggested change

const result = pm2ProcessMessageSchema.safeParse( packet );

const result = childMessagePm2Schema.safeParse( packet );

Let's reuse childMessagePm2Schema here. We can update the schema definition to also include data.process.name

fredrikekelund · 2025-12-08T09:23:18Z

cli/lib/types/wordpress-server-ipc.ts

+// Zod schema for PM2 process messages (IPC messages from child processes)
+export const pm2ProcessMessageSchema = z.object( {
+	process: z.object( {
+		name: z.string(),
+		pm_id: z.number(),
+	} ),
+	raw: z
+		.object( {
+			topic: z.string(),
+		} )
+		.passthrough(),
+} );
+export type Pm2ProcessMessage = z.infer< typeof pm2ProcessMessageSchema >;


Suggested change

// Zod schema for PM2 process messages (IPC messages from child processes)

export const pm2ProcessMessageSchema = z.object( {

process: z.object( {

name: z.string(),

pm_id: z.number(),

} ),

raw: z

.object( {

topic: z.string(),

} )

.passthrough(),

} );

export type Pm2ProcessMessage = z.infer< typeof pm2ProcessMessageSchema >;

Let's remove this per my suggestion in cli/lib/pm2-manager.ts

fredrikekelund · 2025-12-08T09:23:35Z

cli/lib/types/wordpress-server-ipc.ts

+	} ),
+	event: z.string(),
+} );
+export type Pm2ProcessEvent = z.infer< typeof pm2ProcessEventSchema >;


Suggested change

export type Pm2ProcessEvent = z.infer< typeof pm2ProcessEventSchema >;

We're only using the schema, so let's remove the inferred type.

fredrikekelund · 2025-12-08T09:32:51Z

src/index.ts

@@ -391,8 +392,8 @@ async function appBoot() {

 	app.on( 'quit', () => {
 		void stopAllServersOnQuit();


I created STU-1112 to tackle this separately

fredrikekelund · 2025-12-08T09:33:39Z

src/modules/cli/lib/execute-command.ts

 };

-class CliCommandEventEmitter extends EventEmitter {
+export class CliCommandEventEmitter extends EventEmitter {


Suggested change

export class CliCommandEventEmitter extends EventEmitter {

class CliCommandEventEmitter extends EventEmitter {

No need to export this class, AFAICT

fredrikekelund · 2025-12-08T09:34:23Z

src/site-server.ts

+	 * When true, file watchers should ignore site events to prevent interference
+	 * with the ongoing operation.
+	 */
+	hasOngoingOperation = false;


fredrikekelund · 2025-12-08T09:45:02Z

cli/lib/wordpress-server-manager.ts

-		wpVersion?: string;
-		blueprint?: unknown;
-	}
+	logger: Logger< string >,


I don't think we need to address this in the current PR, but the pattern of passing in a logger instance seems to confuse responsibilities. I suggest following up later (maybe after the project launch) by refactoring this file to export a WordPressServerManager class that extends EventEmitter, and emitting the appropriate events (progress, success, error) as part of the startup flow.

nightnei

LGTM and works as expected 👍
I also tested the case when we do something in CLI (when Studio is closed) and then start the Studio, and all sites appears in Studio as started/stopped correctly 👍

bcotrim · 2025-12-09T10:35:39Z

@fredrikekelund @nightnei thanks for the reviews!

It looks like the e2e/blueprints.test.ts tests are still failing, but I guess that's expected so long as we're in this intermittent state of using the Studio CLI to start sites, but still using Playground CLI to create sites.

Yes, I think it will be easier to address once we have the full implementation

bcotrim requested a review from fredrikekelund December 2, 2025 19:18

bcotrim self-assigned this Dec 2, 2025

bcotrim force-pushed the stu-1019-studio-refactor-studio-to-depend-on-the-cli-for-starting branch from 034011f to e882445 Compare December 3, 2025 19:25

bcotrim requested a review from a team December 3, 2025 19:28

bcotrim marked this pull request as ready for review December 3, 2025 19:31

bcotrim force-pushed the stu-1019-studio-refactor-studio-to-depend-on-the-cli-for-starting branch from e882445 to d0e4359 Compare December 4, 2025 14:47

fredrikekelund reviewed Dec 4, 2025

View reviewed changes

bcotrim changed the base branch from trunk to dev/studio-cli-i2 December 5, 2025 12:25

bcotrim added 18 commits December 5, 2025 18:59

studio site list --watch

cd99490

studio updates site servers with cli events

9ac4e56

handle studio start/stop site

3e73b69

fix: gracefully terminate site watcher on app quit

0680ea1

remove duplicate debounce code

0a969c2

fix race condition

0882941

remove src/lib/proxy-server

f1af4d3

fix unit tests

c5ed591

fix lint

ba5c5fd

adjust list yargs types and watcher return type

d854965

fix CLI build

93c2a23

fix e2e tests

7d72190

canSend logger check

f94d18a

wordpress server child - multi worker and message logs

b72ba03

implement CliServerProcess as class

eb2d332

adjust hasOngoingOperation site server flag

4a4b691

add zod parsing

f4021ab

move playground cli message format logic to common folder

dd0994d

bcotrim force-pushed the stu-1019-studio-refactor-studio-to-depend-on-the-cli-for-starting branch from 5a0ae52 to dd0994d Compare December 5, 2025 19:04

fredrikekelund approved these changes Dec 8, 2025

View reviewed changes

nightnei approved these changes Dec 8, 2025

View reviewed changes

address pr feedback

86ed84c

bcotrim merged commit 8a5bf00 into dev/studio-cli-i2 Dec 9, 2025
3 of 5 checks passed

bcotrim deleted the stu-1019-studio-refactor-studio-to-depend-on-the-cli-for-starting branch December 9, 2025 12:51

fredrikekelund mentioned this pull request Jan 5, 2026

Sync site list when CLI creates sites while app is running #2313

Merged

1 task

		@@ -391,8 +392,8 @@ async function appBoot() {

		app.on( 'quit', () => {
		void stopAllServersOnQuit();

	): CliCommandEventEmitter {
	): [CliCommandEventEmitter, ChildProcess] {

	const result = pm2ProcessMessageSchema.safeParse( packet );
	const result = childMessagePm2Schema.safeParse( packet );

	export class CliCommandEventEmitter extends EventEmitter {
	class CliCommandEventEmitter extends EventEmitter {

Conversation

bcotrim commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related issues

Proposed Changes

Testing Instructions

Pre-merge Checklist

Uh oh!

fredrikekelund left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fredrikekelund left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nightnei left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bcotrim commented Dec 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bcotrim commented Dec 2, 2025 •

edited

Loading

nightnei left a comment •

edited

Loading