Studio: Refactor `studio preview create` to adjust new site logic by bcotrim · Pull Request #2148 · Automattic/studio

bcotrim · 2025-11-27T18:13:12Z

Related issues

Fixes STU-991

Proposed Changes

studio preview create now requires the target folder to be an existing Studio site, failing with a helpful error if not
Removed newSites concept from app and cli entirely

Testing Instructions

npm start
Create a Studio site and remove it without deleting files
Close Studio
node dist/cli/main.js preview --path <new site folder>
Verify it fails.
Verify studio preview create <existing-site-folder> works correctly for existing Studio sites

Pre-merge Checklist

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

github-actions · 2025-11-27T18:46:39Z

📊 Performance Test Results

Comparing 72ea508 vs trunk

site-editor

Metric	trunk	`72ea508`	Diff	Change
load	9347.00 ms	11657.00 ms	+2310.00 ms	🔴 24.7%

site-startup

Metric	trunk	`72ea508`	Diff	Change
siteCreation	16049.00 ms	14082.00 ms	-1967.00 ms	🟢 -12.3%
siteStartup	7041.00 ms	6972.00 ms	-69.00 ms	🟢 -1.0%

Results are median values from multiple test runs.

Legend: 🟢 Improvement (faster) | 🔴 Regression (slower) | ⚪ No change

fredrikekelund

Such a relief to clean this upp! I left a couple of comments. The most substantial one relates to the user-data-updated event listener in src/hooks/use-site-details.tsx.

fredrikekelund · 2025-11-28T07:35:07Z

cli/commands/preview/create.ts

@@ -21,6 +21,7 @@ export async function runCommand( siteFolder: string ): Promise< void > {
 	try {
 		logger.reportStart( LoggerAction.VALIDATE, __( 'Validating…' ) );
 		validateSiteFolder( siteFolder );


Suggested change

validateSiteFolder( siteFolder );

I think this can be removed. No need to validate the directory type when creating a site if we also use getSiteByFolder to ensure the current directory is added to Studio.

fredrikekelund · 2025-11-28T07:39:41Z

cli/commands/preview/tests/create.test.ts

Let's remove the validateSiteFolder mocking from here, too.

fredrikekelund · 2025-11-28T07:41:23Z

cli/commands/preview/update.ts

We should remove the validateSiteFolder call in runCommand here as well and replace it with a getSiteByFolder call.

fredrikekelund · 2025-11-28T07:42:09Z

cli/commands/preview/tests/update.test.ts

Same thing here about removing the validateSiteFolder mocking.

fredrikekelund · 2025-11-28T08:02:32Z

src/hooks/use-site-details.tsx

@@ -427,7 +426,7 @@ export function SiteDetailsProvider( { children }: SiteDetailsProviderProps ) {

 	useEffect( () => {
 		const unsubscribe = window.ipcListener.subscribe( 'user-data-updated', async ( _, payload ) => {


Could we remove this event listener altogether now..? This might be a useful starting point for picking up latestCliPid changes, but all the logic around addingSiteIds seems to ultimately relate to newSites, which makes me think that we could clean up this file further.

I think it is related to the add site workflow from Studio, not the newSites workflow.
Since we will need to revist this code when we work on having Studio depending on Studio CLI for site management, I suggest adjusting this file at that time.
What do you think?

This was originally implemented by you in #1272 (d38ad87 in response to #1272 (review)). @ivan-ottinger then updated this listener in #1710 to fix a bug where sites would disappear from the sidebar while being created.

The current logic has no purpose, really. If I attempt to summarize it, this listener will:

Trigger any time the appdata file changes

Load the list of sites from appdata, instantiating each of them as SiteServer

Proceed if appdata.sites is truthy (which it always is, because it's an array)

If there's no site currently being added by Studio, return early

If there IS a site currently being added to Studio, recreate the data state by adding the temporary site to the list of sites from appdata

We should remove this.

fredrikekelund

Thanks for the changes, @bcotrim, this looks good now 👍

I identified two remaining issues: that we were still using validateSiteFolder in the preview list command, and that the user-data-updated should be removed after all. Since I was planning to land this today (while you're AFK), I went ahead and pushed fixes for both of those.

sejas

I noticed an issue when creating a new site. I created a Linear issue STU-1071, and I'm working on a quick fix.

trunk-hans-on-wordpress-is-running.mp4

sejas · 2025-12-01T20:17:48Z

src/hooks/use-site-details.tsx

-	useEffect( () => {
-		const unsubscribe = window.ipcListener.subscribe( 'user-data-updated', async ( _, payload ) => {
-			if ( ! fastDeepEqual( payload.newSites, payload.sites ) ) {
-				const updatedSites = await getIpcApi().getSiteDetails();
-				setData( ( prevData ) => {
-					const tempSite = prevData.find( ( site ) => addingSiteIds.includes( site.id ) );
-
-					if ( ! tempSite ) {
-						return updatedSites;
-					}
-
-					const tempSiteExists = updatedSites.some( ( site ) => site.id === tempSite.id );
-
-					if ( ! tempSiteExists ) {
-						return sortSites( [ ...updatedSites, tempSite ] );
-					}
-
-					return updatedSites;
-				} );
-			}
-		} );
-
-		return () => {
-			unsubscribe();
-		};
-	}, [ addingSiteIds ] );


I think this listener is necessary. The site creation in Studio app is currently broken without it.

Quickfix PR #2161

Follow-up in #2164

…n flow (#2161) - Quick fix site creation. Before this PR the site creation got stuck and never updated the UI. - The issue was introduced in #2148 - That's the reason most of e2e tests were failing, and also the Performance CI, as it always failed on trunk.

bcotrim self-assigned this Nov 27, 2025

bcotrim requested review from a team and fredrikekelund November 27, 2025 18:22

fredrikekelund reviewed Nov 28, 2025

View reviewed changes

bcotrim force-pushed the stu-991-studio-refactor-studio-preview-create-to-adjust-new-site branch from 7afdc43 to 14a6e98 Compare November 28, 2025 16:10

bcotrim added 3 commits November 28, 2025 16:35

Studio: Refactor studio preview create to adjust new site logic

290c172

fix lint

4598c9c

remove unnecessary validateSiteFolder calls

a1d9e92

bcotrim force-pushed the stu-991-studio-refactor-studio-preview-create-to-adjust-new-site branch from 14a6e98 to a1d9e92 Compare November 28, 2025 16:43

bcotrim requested a review from fredrikekelund November 28, 2025 16:50

fredrikekelund added 2 commits December 1, 2025 13:24

Remove validateSiteFolder altogether

2ea91cb

Remove user-data-updated listener

3c70ab8

fredrikekelund approved these changes Dec 1, 2025

View reviewed changes

fredrikekelund merged commit c535fba into trunk Dec 1, 2025
7 of 9 checks passed

fredrikekelund deleted the stu-991-studio-refactor-studio-preview-create-to-adjust-new-site branch December 1, 2025 12:54

sejas reviewed Dec 1, 2025

View reviewed changes

sejas mentioned this pull request Dec 1, 2025

Introduce back the user-data-updated listener to quick fix the site creation #2161

Merged

1 task

fredrikekelund mentioned this pull request Dec 2, 2025

Remove user-data-updated listener in useSiteDetails #2164

Merged

1 task

sejas mentioned this pull request Dec 30, 2025

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

Merged

1 task

		@@ -427,7 +426,7 @@ export function SiteDetailsProvider( { children }: SiteDetailsProviderProps ) {

		useEffect( () => {
		const unsubscribe = window.ipcListener.subscribe( 'user-data-updated', async ( _, payload ) => {

Conversation

bcotrim commented Nov 27, 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!

github-actions bot commented Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Performance Test Results

site-editor

site-startup

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!

fredrikekelund left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sejas 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bcotrim commented Nov 27, 2025 •

edited

Loading

github-actions bot commented Nov 27, 2025 •

edited

Loading