Merge branch 'trunk' into stu-830-add-support-for-blueprints-definesiteurl

Author: bcotrim

RELEASE-NOTES.txt

@@ -1,6 +1,16 @@
 Unreleased
 ==========
 
+1.7.3
+=====
+* Added Zed and Antigravity editor support #2497
+* Fixed incorrect WordPress version warning when applying Blueprints #2494
+* Fixed an issue where deleting multiple sites at once could fail #2492
+* Fixed tab selection after site deletion #2468
+* Fixed sites failing to start when Studio is installed in a path containing spaces #2495
+* CLI: Fixed --skip-site-details argument for starting a site that is already running #2510
+* Updated multiple dependencies, including WordPress Element, WordPress Date, and Node.js types
+
 1.7.2
 =====
 * Added pause/resume functionality for the push process #2379

cli/commands/site/create.ts

@@ -15,7 +15,13 @@ import {
 	validateBlueprintData,
 } from 'common/lib/blueprint-validation';
 import { getDomainNameValidationError } from 'common/lib/domains';
-import { arePathsEqual, isEmptyDir, isWordPressDirectory, pathExists } from 'common/lib/fs-utils';
+import {
+	arePathsEqual,
+	isEmptyDir,
+	isWordPressDirectory,
+	pathExists,
+	recursiveCopyDirectory,
+} from 'common/lib/fs-utils';
 import { DEFAULT_LOCALE } from 'common/lib/locale';
 import { isOnline } from 'common/lib/network-utils';
 import { createPassword } from 'common/lib/passwords';
@@ -27,7 +33,6 @@ import {
 	isWordPressVersionAtLeast,
 } from 'common/lib/wordpress-version-utils';
 import { SiteCommandLoggerAction as LoggerAction } from 'common/logger-actions';
-import fse from 'fs-extra';
 import {
 	lockAppdata,
 	readAppdata,
@@ -55,6 +60,7 @@ const logger = new Logger< LoggerAction >();
 
 type CreateCommandOptions = {
 	name?: string;
+	siteId?: string;
 	wpVersion: string;
 	phpVersion: ( typeof ALLOWED_PHP_VERSIONS )[ number ];
 	customDomain?: string;
@@ -156,7 +162,7 @@ export async function runCommand(
 			}
 
 			logger.reportStart( LoggerAction.SETUP_WORDPRESS, __( 'Copying bundled WordPress…' ) );
-			await fse.copy( bundledWPPath, sitePath );
+			await recursiveCopyDirectory( bundledWPPath, sitePath );
 			logger.reportSuccess( __( 'WordPress files copied' ) );
 		} else if ( ! isOnlineStatus ) {
 			throw new LoggerError(
@@ -178,7 +184,7 @@ export async function runCommand(
 		logger.reportSuccess( sprintf( __( 'Port assigned: %d' ), port ) );
 
 		const siteName = options.name || path.basename( sitePath );
-		const siteId = crypto.randomUUID();
+		const siteId = options.siteId || crypto.randomUUID();
 		const adminPassword = createPassword();
 
 		const setupSteps: StepDefinition[] = [];
@@ -364,6 +370,15 @@ function readBlueprint( blueprintPath: string ) {
 	}
 }
 
+function coerceSiteId( value: string ) {
+	// Validate UUID format (8-4-4-4-12 hex characters)
+	const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+	if ( ! uuidRegex.test( value ) ) {
+		throw new ValidationError( 'id', value, __( 'Must be a valid UUID' ) );
+	}
+	return value;
+}
+
 function coerceWpVersion( value: string ) {
 	if ( ! isValidWordPressVersion( value ) ) {
 		throw new ValidationError(
@@ -392,6 +407,12 @@ export const registerCommand = ( yargs: StudioArgv ) => {
 		describe: __( 'Create a new site' ),
 		builder: ( yargs ) => {
 			return yargs
+				.option( 'id', {
+					type: 'string',
+					describe: __( 'Site ID (UUID format, used internally by Studio app)' ),
+					hidden: true,
+					coerce: coerceSiteId,
+				} )
 				.option( 'name', {
 					type: 'string',
 					describe: __( 'Site name' ),
@@ -440,6 +461,7 @@ export const registerCommand = ( yargs: StudioArgv ) => {
 		handler: async ( argv ) => {
 			const config: CreateCommandOptions = {
 				name: argv.name,
+				siteId: argv.id,
 				wpVersion: argv.wp,
 				phpVersion: argv.php,
 				customDomain: argv.domain,

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

@@ -4,7 +4,13 @@ import {
 	filterUnsupportedBlueprintFeatures,
 	validateBlueprintData,
 } from 'common/lib/blueprint-validation';
-import { isEmptyDir, isWordPressDirectory, pathExists, arePathsEqual } from 'common/lib/fs-utils';
+import {
+	isEmptyDir,
+	isWordPressDirectory,
+	pathExists,
+	arePathsEqual,
+	recursiveCopyDirectory,
+} from 'common/lib/fs-utils';
 import { isOnline } from 'common/lib/network-utils';
 import { portFinder } from 'common/lib/port-finder';
 import { vi, type MockInstance } from 'vitest';
@@ -28,11 +34,6 @@ import { runCommand } from '../create';
 
 vi.mock( 'common/lib/fs-utils' );
 vi.mock( 'common/lib/network-utils' );
-vi.mock( 'fs-extra', () => ( {
-	default: {
-		copy: vi.fn().mockResolvedValue( undefined ),
-	},
-} ) );
 vi.mock( 'common/lib/port-finder', () => ( {
 	portFinder: {
 		addUnavailablePort: vi.fn(),
@@ -133,6 +134,7 @@ describe( 'CLI: studio site create', () => {
 		vi.mocked( isEmptyDir ).mockResolvedValue( true );
 		vi.mocked( isWordPressDirectory ).mockReturnValue( false );
 		vi.mocked( arePathsEqual ).mockImplementation( ( a, b ) => a === b );
+		vi.mocked( recursiveCopyDirectory ).mockResolvedValue( undefined );
 		vi.mocked( portFinder.getOpenPort ).mockResolvedValue( mockPort );
 		vi.mocked( readAppdata, { partial: true } ).mockResolvedValue( {
 			sites: [ ...mockAppdata.sites ],

common/lib/fs-utils.ts

@@ -77,6 +77,26 @@ export async function pathExists( path: string ): Promise< boolean > {
 	}
 }
 
+export async function recursiveCopyDirectory(
+	source: string,
+	destination: string
+): Promise< void > {
+	await fsPromises.mkdir( destination, { recursive: true } );
+
+	const entries = await fsPromises.readdir( source, { withFileTypes: true } );
+
+	for ( const entry of entries ) {
+		const sourcePath = path.join( source, entry.name );
+		const destinationPath = path.join( destination, entry.name );
+
+		if ( entry.isDirectory() ) {
+			await recursiveCopyDirectory( sourcePath, destinationPath );
+		} else if ( entry.isFile() ) {
+			await fsPromises.copyFile( sourcePath, destinationPath );
+		}
+	}
+}
+
 export async function isEmptyDir( directory: string ): Promise< boolean > {
 	const stats = await fsPromises.stat( directory );
 	if ( ! stats.isDirectory() ) {

package-lock.json

@@ -3,7 +3,7 @@
 	"author": "Automattic Inc.",
 	"private": true,
 	"productName": "Studio",
-	"version": "1.7.3-beta1",
+	"version": "1.7.3",
 	"description": "Local WordPress development environment using Playgrounds",
 	"license": "GPL-2.0-or-later",
 	"main": "dist/main/index.js",

package.json

@@ -14,6 +14,7 @@ import {
 import fs from 'fs';
 import fsPromises from 'fs/promises';
 import https from 'node:https';
+import os from 'os';
 import nodePath from 'path';
 import * as Sentry from '@sentry/electron/main';
 import { __, sprintf, LocaleData, defaultI18n } from '@wordpress/i18n';
@@ -122,6 +123,38 @@ export {
 	showUserSettings,
 } from 'src/modules/user-settings/lib/ipc-handlers';
 
+const DEBUG_LOG_MAX_LINES = 50;
+const PM2_HOME = nodePath.join( os.homedir(), '.studio', 'pm2' );
+
+function readLastLines( filePath: string, maxLines: number ): string[] | undefined {
+	try {
+		if ( ! fs.existsSync( filePath ) ) {
+			return undefined;
+		}
+		const content = fs.readFileSync( filePath, 'utf-8' );
+		const lines = content.split( '\n' ).filter( ( line ) => line.trim() );
+		return lines.slice( -maxLines );
+	} catch {
+		return undefined;
+	}
+}
+
+function readWordPressDebugLog( sitePath: string ): string[] | undefined {
+	const debugLogPath = nodePath.join( sitePath, 'wp-content', 'debug.log' );
+	return readLastLines( debugLogPath, DEBUG_LOG_MAX_LINES );
+}
+
+function readPm2Logs( siteId: string ): { stdout?: string[]; stderr?: string[] } {
+	const logsDir = nodePath.join( PM2_HOME, 'logs' );
+	const stdoutPath = nodePath.join( logsDir, `studio-site-${ siteId }-out.log` );
+	const stderrPath = nodePath.join( logsDir, `studio-site-${ siteId }-error.log` );
+
+	return {
+		stdout: readLastLines( stdoutPath, DEBUG_LOG_MAX_LINES ),
+		stderr: readLastLines( stderrPath, DEBUG_LOG_MAX_LINES ),
+	};
+}
+
 function mergeSiteDetailsWithRunningDetails( sites: SiteDetails[] ): SiteDetails[] {
 	return sites.map( ( site ) => {
 		const server = SiteServer.get( site.id );
@@ -221,12 +254,14 @@ export async function createSite(
 		wpVersion,
 		customDomain,
 		enableHttps,
-		siteId,
+		siteId: providedSiteId,
 		blueprint,
 		phpVersion,
 		noStart = false,
 	} = config;
 
+	const siteId = providedSiteId || crypto.randomUUID();
+
 	const metric = getBlueprintMetric( blueprint?.slug );
 	bumpStat( StatsGroup.STUDIO_SITE_CREATE, metric );
 
@@ -273,6 +308,19 @@ export async function createSite(
 			contexts.startup = cliError.cliArgs;
 		}
 
+		const debugLog = readWordPressDebugLog( path );
+		if ( debugLog && debugLog.length > 0 ) {
+			contexts.debugLog = { entries: debugLog };
+		}
+
+		const pm2Logs = readPm2Logs( siteId );
+		if ( pm2Logs.stdout && pm2Logs.stdout.length > 0 ) {
+			contexts.playgroundLogs = { entries: pm2Logs.stdout };
+		}
+		if ( pm2Logs.stderr && pm2Logs.stderr.length > 0 ) {
+			contexts.playgroundErrors = { entries: pm2Logs.stderr };
+		}
+
 		Sentry.captureException( error, {
 			tags: {
 				provider: 'cli',
@@ -388,6 +436,19 @@ export async function startServer( event: IpcMainInvokeEvent, id: string ): Prom
 			contexts.startup = cliError.cliArgs;
 		}
 
+		const debugLog = readWordPressDebugLog( server.details.path );
+		if ( debugLog && debugLog.length > 0 ) {
+			contexts.debugLog = { entries: debugLog };
+		}
+
+		const pm2Logs = readPm2Logs( id );
+		if ( pm2Logs.stdout && pm2Logs.stdout.length > 0 ) {
+			contexts.playgroundLogs = { entries: pm2Logs.stdout };
+		}
+		if ( pm2Logs.stderr && pm2Logs.stderr.length > 0 ) {
+			contexts.playgroundErrors = { entries: pm2Logs.stderr };
+		}
+
 		Sentry.captureException( error, {
 			tags: {
 				provider: 'cli',

src/ipc-handlers.ts

@@ -4,8 +4,7 @@
  */
 
 import nodePath from 'path';
-import fs from 'fs-extra';
-import { pathExists } from 'common/lib/fs-utils';
+import { pathExists, recursiveCopyDirectory } from 'common/lib/fs-utils';
 import { getResourcesPath } from 'src/storage/paths';
 
 /**
@@ -19,5 +18,5 @@ export async function setupWordPressFilesOnly( path: string ): Promise< void > {
 		throw new Error( 'Bundled WordPress files not found. Please reinstall WordPress Studio.' );
 	}
 
-	await fs.copy( bundledWPPath, path );
+	await recursiveCopyDirectory( bundledWPPath, path );
 }

src/lib/wordpress-setup.ts

@@ -1,6 +1,7 @@
 import path from 'path';
 import fs from 'fs-extra';
 import semver from 'semver';
+import { recursiveCopyDirectory } from 'common/lib/fs-utils';
 import { downloadWordPress } from 'src/lib/download-utils';
 import { getWordPressVersionPath } from 'src/lib/server-files-paths';
 
@@ -67,7 +68,10 @@ export async function updateLatestWordPressVersion() {
 		const latestVersion = await getLatestWordPressVersion();
 		if ( installedVersion && latestVersion !== 'latest' && installedVersion !== latestVersion ) {
 			// We keep a copy of the latest installed version instead of removing it.
-			await fs.copy( latestVersionPath, getWordPressVersionPath( installedVersion ) );
+			await recursiveCopyDirectory(
+				latestVersionPath,
+				getWordPressVersionPath( installedVersion )
+			);
 			shouldOverwrite = true;
 		}
 	}

src/lib/wp-versions.ts

@@ -1,7 +1,6 @@
 import { app } from 'electron';
 import path from 'path';
-import fs from 'fs-extra';
-import { pathExists } from 'common/lib/fs-utils';
+import { pathExists, recursiveCopyDirectory } from 'common/lib/fs-utils';
 import { getServerFilesPath } from 'src/storage/paths';
 import { loadUserData } from 'src/storage/user-data';
 
@@ -27,5 +26,5 @@ export async function needsToMigrateFromWpNowFolder() {
 }
 
 export async function migrateFromWpNowFolder() {
-	await fs.copy( wpNowPath, getServerFilesPath() );
+	await recursiveCopyDirectory( wpNowPath, getServerFilesPath() );
 }