Merge branch 'trunk' of github.com:Automattic/studio into stu-363-user-settings-return-the-list-of-installed-editors

Author: gcsecsey

Diff for: cli/index.ts

@@ -1,10 +1,12 @@
 import { __ } from '@wordpress/i18n';
 import { Command, Option } from 'commander';
+import { StatsGroup, StatsMetric } from 'src/lib/bump-stats/types';
 import { registerCommand as registerPreviewCreateCommand } from 'cli/commands/preview/create';
 import { registerCommand as registerPreviewDeleteCommand } from 'cli/commands/preview/delete';
 import { registerCommand as registerPreviewListCommand } from 'cli/commands/preview/list';
 import { registerCommand as registerPreviewUpdateCommand } from 'cli/commands/preview/update';
 import { loadTranslations } from 'cli/lib/i18n';
+import { bumpAggregatedUniqueStat } from 'cli/lib/stats';
 import { version } from 'cli/package.json';
 
 async function main() {
@@ -16,6 +18,9 @@ async function main() {
 		.name( 'studio' )
 		.description( __( 'Studio by WordPress.com CLI' ) )
 		.version( version )
+		.hook( 'preAction', () => {
+			bumpAggregatedUniqueStat( StatsGroup.STUDIO_CLI_USAGE_UNIQUE, StatsMetric.SUCCESS, 'weekly' );
+		} )
 		.addOption(
 			new Option( '--output-format [format]', __( 'Specify a non-standard output format' ) )
 				.argParser( ( value: string ) => {

Diff for: cli/lib/appdata.ts

@@ -2,6 +2,7 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import { __ } from '@wordpress/i18n';
+import { StatsGroup, StatsMetric } from 'src/lib/bump-stats/types';
 import { z } from 'zod';
 import { LoggerError } from 'cli/logger';
 
@@ -34,6 +35,9 @@ const userDataSchema = z
 			} )
 			.passthrough()
 			.optional(),
+		lastBumpStats: z
+			.record( z.nativeEnum( StatsGroup ), z.record( z.nativeEnum( StatsMetric ), z.number() ) )
+			.optional(),
 	} )
 	.passthrough();
 

Diff for: cli/lib/stats.ts

@@ -0,0 +1,78 @@
+import { isSameDay, isSameMonth, isSameWeek } from 'date-fns';
+import fetch from 'node-fetch';
+import { AggregateInterval, StatsGroup, StatsMetric } from 'src/lib/bump-stats/types';
+import { readAppdata, saveAppdata } from './appdata';
+
+// Bumps a stat if it hasn't been bumped within the current aggregate interval.
+// This allows us to approximate a 1-count-per-user stat without recording which
+// user the event came from (bump stats are anonymous).
+//
+// We don't want to block the thread to record the stat, so this function doesn't
+// await promises before returning.
+export async function bumpAggregatedUniqueStat(
+	group: StatsGroup,
+	stat: StatsMetric,
+	aggregateBy: AggregateInterval,
+	bumpInDev = false
+) {
+	const lastBump = await getLastBump( group, stat );
+
+	if ( lastBump === null ) {
+		bumpStat( group, stat, bumpInDev );
+		await updateLastBump( group, stat );
+		return;
+	}
+
+	const now = Date.now();
+
+	if ( aggregateBy === 'daily' && isSameDay( lastBump, now ) ) {
+		return;
+	}
+	if ( aggregateBy === 'weekly' && isSameWeek( lastBump, now ) ) {
+		return;
+	}
+	if ( aggregateBy === 'monthly' && isSameMonth( lastBump, now ) ) {
+		return;
+	}
+
+	const didBump = bumpStat( group, stat, bumpInDev );
+	if ( didBump ) {
+		await updateLastBump( group, stat );
+	}
+}
+
+// Returns true if we attempted to bump the stat
+export function bumpStat( group: StatsGroup, stat: StatsMetric, bumpInDev = false ) {
+	if ( process.env.NODE_ENV === 'development' && ! bumpInDev ) {
+		console.info( `Would have bumped stat: ${ group }=${ stat }` );
+		return false;
+	}
+
+	// Fire and forget POST request
+	fetch( 'https://public-api.wordpress.com/wpcom/v2/studio-app/bump-stat', {
+		method: 'POST',
+		headers: {
+			'Content-Type': 'application/json',
+		},
+		body: JSON.stringify( { group, stat } ),
+	} ).catch( () => {
+		// A failed request typically indicates a network issue, which we don't need to report
+	} );
+
+	return true;
+}
+
+// Returns UTC timestamp of the last time the stat was bumped, or null if it has never been bumped.
+async function getLastBump( group: StatsGroup, stat: StatsMetric ): Promise< number | null > {
+	const { lastBumpStats } = await readAppdata();
+	return lastBumpStats?.[ group ]?.[ stat ] ?? null;
+}
+
+// Store this moment as the last time we bumped the state, in UTC time.
+async function updateLastBump( group: StatsGroup, stat: StatsMetric ) {
+	const data = await readAppdata();
+	data.lastBumpStats ??= {};
+	data.lastBumpStats[ group ] ??= {};
+	( data.lastBumpStats[ group ] as Record< StatsMetric, number > )[ stat ] = Date.now();
+	await saveAppdata( data );
+}

Diff for: src/index.ts

@@ -15,7 +15,8 @@ import { PROTOCOL_PREFIX } from 'src/constants';
 import * as ipcHandlers from 'src/ipc-handlers';
 import { hasActiveSyncOperations } from 'src/lib/active-sync-operations';
 import { bumpAggregatedUniqueStat, bumpStat } from 'src/lib/bump-stats';
-import { getPlatformMetric, StatsGroup } from 'src/lib/bump-stats/types';
+import { getPlatformMetric } from 'src/lib/bump-stats/lib';
+import { StatsGroup } from 'src/lib/bump-stats/types';
 import {
 	listenCLICommands,
 	getCLIDataForMainInstance,
@@ -30,9 +31,11 @@ import { getSentryReleaseInfo } from 'src/lib/sentry-release';
 import { setupLogging } from 'src/logging';
 import { createMainWindow, getMainWindow } from 'src/main-window';
 import {
-	migrateFromWpNowFolder,
 	needsToMigrateFromWpNowFolder,
+	migrateFromWpNowFolder,
 } from 'src/migrations/migrate-from-wp-now-folder';
+import { migrateAllDatabasesInSitu } from 'src/migrations/move-databases-in-situ';
+import { removeSitesWithEmptyDirectories } from 'src/migrations/remove-sites-with-empty-dirs';
 import { installCLIOnWindows } from 'src/modules/cli/lib/install-windows';
 import { setupWPServerFiles, updateWPServerFiles } from 'src/setup-wp-server-files';
 import { stopAllServersOnQuit } from 'src/site-server';
@@ -76,6 +79,19 @@ if ( gotTheLock && ! isInInstaller ) {
 	}
 }
 
+async function setupSentryUserId() {
+	const userData = await loadUserData();
+
+	if ( ! userData.sentryUserId ) {
+		userData.sentryUserId = crypto.randomUUID();
+		console.log( Date.now(), 'Saving sentry user ID', userData.sentryUserId );
+		await saveUserData( userData );
+	}
+
+	console.log( 'Setting Sentry user ID:', userData.sentryUserId );
+	Sentry.setUser( { id: userData.sentryUserId } );
+}
+
 async function appBoot() {
 	app.setName( packageJson.productName );
 
@@ -255,22 +271,19 @@ async function appBoot() {
 			await migrateFromWpNowFolder();
 		}
 
-		const userData = await loadUserData();
+		await setupSentryUserId();
 
-		if ( ! userData.sentryUserId ) {
-			userData.sentryUserId = crypto.randomUUID();
-			await saveUserData( userData );
-		}
+		await removeSitesWithEmptyDirectories();
 
-		console.log( 'Setting Sentry user ID:', userData.sentryUserId );
-		Sentry.setUser( { id: userData.sentryUserId } );
+		await migrateAllDatabasesInSitu();
 
 		createMainWindow();
 
 		// Handle CLI commands
 		listenCLICommands();
 		executeCLICommand();
 
+		const userData = await loadUserData();
 		// Bump stats for the first time the app runs - this is when no lastBumpStats are available
 		if ( ! userData.lastBumpStats ) {
 			bumpStat( StatsGroup.STUDIO_APP_LAUNCH, getPlatformMetric( process.platform ) );

Diff for: src/ipc-handlers.ts

@@ -21,7 +21,8 @@ import { ARCHIVER_OPTIONS, MAIN_MIN_WIDTH, SIDEBAR_WIDTH } from 'src/constants';
 import { sendIpcEventToRendererWithWindow } from 'src/ipc-utils';
 import { ACTIVE_SYNC_OPERATIONS } from 'src/lib/active-sync-operations';
 import { bumpStat } from 'src/lib/bump-stats';
-import { getImporterMetric, StatsGroup, StatsMetric } from 'src/lib/bump-stats/types';
+import { getImporterMetric } from 'src/lib/bump-stats/lib';
+import { StatsGroup, StatsMetric } from 'src/lib/bump-stats/types';
 import { calculateDirectorySize } from 'src/lib/calculate-directory-size';
 import { download } from 'src/lib/download';
 import { isEmptyDir, pathExists, isWordPressDirectory, sanitizeFolderName } from 'src/lib/fs-utils';

Diff for: src/lib/bump-stats/lib.ts

@@ -0,0 +1,38 @@
+import { StatsMetric } from 'src/lib/bump-stats/types';
+import {
+	JetpackImporter,
+	LocalImporter,
+	PlaygroundImporter,
+	SQLImporter,
+	WpressImporter,
+} from 'src/lib/import-export/import/importers';
+
+export function getPlatformMetric( platform: typeof process.platform ): StatsMetric {
+	switch ( platform ) {
+		case 'darwin':
+			return StatsMetric.DARWIN;
+		case 'linux':
+			return StatsMetric.LINUX;
+		case 'win32':
+			return StatsMetric.WINDOWS;
+		default:
+			return StatsMetric.UNKNOWN_PLATFORM;
+	}
+}
+
+export function getImporterMetric( importer?: string ): StatsMetric {
+	switch ( importer ) {
+		case JetpackImporter.name:
+			return StatsMetric.JETPACK_IMPORTER;
+		case LocalImporter.name:
+			return StatsMetric.LOCAL_IMPORTER;
+		case SQLImporter.name:
+			return StatsMetric.SQL_IMPORTER;
+		case PlaygroundImporter.name:
+			return StatsMetric.PLAYGROUND_IMPORTER;
+		case WpressImporter.name:
+			return StatsMetric.WPRESS_IMPORTER;
+		default:
+			return StatsMetric.UNKNOWN_IMPORTER;
+	}
+}

Diff for: src/lib/bump-stats/types.ts

@@ -1,17 +1,12 @@
-import {
-	JetpackImporter,
-	LocalImporter,
-	PlaygroundImporter,
-	SQLImporter,
-	WpressImporter,
-} from 'src/lib/import-export/import/importers';
-
 export enum StatsGroup {
+	// Studio app
 	STUDIO_APP_LAUNCH = 'studio-app-launch-first',
 	STUDIO_APP_LAUNCH_TOTAL = 'studio-app-launch-total',
 	STUDIO_APP_LAUNCH_UNIQUE = 'local-environment-launch-uniques',
 	STUDIO_IMPORT = 'studio-app-import',
 	STUDIO_EXPORT = 'studio-app-export',
+	// Studio CLI
+	STUDIO_CLI_USAGE_UNIQUE = 'studio-cli-usage-unique',
 }
 
 export enum StatsMetric {
@@ -35,33 +30,3 @@ export enum StatsMetric {
 }
 
 export type AggregateInterval = 'daily' | 'weekly' | 'monthly';
-
-export function getPlatformMetric( platform: typeof process.platform ): StatsMetric {
-	switch ( platform ) {
-		case 'darwin':
-			return StatsMetric.DARWIN;
-		case 'linux':
-			return StatsMetric.LINUX;
-		case 'win32':
-			return StatsMetric.WINDOWS;
-		default:
-			return StatsMetric.UNKNOWN_PLATFORM;
-	}
-}
-
-export function getImporterMetric( importer?: string ): StatsMetric {
-	switch ( importer ) {
-		case JetpackImporter.name:
-			return StatsMetric.JETPACK_IMPORTER;
-		case LocalImporter.name:
-			return StatsMetric.LOCAL_IMPORTER;
-		case SQLImporter.name:
-			return StatsMetric.SQL_IMPORTER;
-		case PlaygroundImporter.name:
-			return StatsMetric.PLAYGROUND_IMPORTER;
-		case WpressImporter.name:
-			return StatsMetric.WPRESS_IMPORTER;
-		default:
-			return StatsMetric.UNKNOWN_IMPORTER;
-	}
-}

Diff for: src/main-window.ts

@@ -7,13 +7,9 @@ import {
 	WINDOWS_TITLEBAR_HEIGHT,
 } from 'src/constants';
 import { sendIpcEventToRendererWithWindow } from 'src/ipc-utils';
-import { isEmptyDir } from 'src/lib/fs-utils';
 import { portFinder } from 'src/lib/port-finder';
-import { keepSqliteIntegrationUpdated } from 'src/lib/sqlite-versions';
 import { removeMenu } from 'src/menu';
-import { UserData } from 'src/storage/storage-types';
 import { loadUserData, saveUserData } from 'src/storage/user-data';
-import { moveDatabasesInSitu } from 'vendor/wp-now/src';
 
 // This allows TypeScript to pick up the magic constants that's auto-generated by Forge's Webpack
 // plugin that tells the Electron app where to look for the Webpack-bundled app code (depending on
@@ -38,21 +34,6 @@ function initializePortFinder( sites: SiteDetails[] ) {
 	} );
 }
 
-async function removeSitesWithEmptyDirectories( userData: UserData ) {
-	const sitesWithNonEmptyDirectories: SiteDetails[] = [];
-	const storedSites = userData.sites || [];
-	for ( const site of storedSites ) {
-		if ( ! site.path ) {
-			continue;
-		}
-		const directoryIsEmpty = await isEmptyDir( site.path );
-		if ( ! directoryIsEmpty ) {
-			sitesWithNonEmptyDirectories.push( site );
-		}
-	}
-	saveUserData( { ...userData, sites: sitesWithNonEmptyDirectories } );
-}
-
 export function createMainWindow(): BrowserWindow {
 	if ( mainWindow && ! mainWindow.isDestroyed() ) {
 		return mainWindow;
@@ -78,12 +59,6 @@ export function createMainWindow(): BrowserWindow {
 		const { devToolsOpen, sites } = userData;
 		setupDevTools( mainWindow, devToolsOpen );
 		initializePortFinder( sites );
-		removeSitesWithEmptyDirectories( userData );
-		for ( const site of sites ) {
-			moveDatabasesInSitu( site.path ).then( () => {
-				keepSqliteIntegrationUpdated( site.path );
-			} );
-		}
 	} );
 
 	mainWindow.webContents.on( 'devtools-opened', async () => {

Diff for: src/migrations/move-databases-in-situ.ts

@@ -0,0 +1,41 @@
+import path from 'node:path';
+import fs from 'fs-extra';
+import { keepSqliteIntegrationUpdated } from 'src/lib/sqlite-versions';
+import { loadUserData } from 'src/storage/user-data';
+import getWpNowConfig from 'vendor/wp-now/src/config';
+import { SQLITE_FILENAME } from 'vendor/wp-now/src/constants';
+import getSqlitePath from 'vendor/wp-now/src/get-sqlite-path';
+
+async function moveDatabasesInSitu( projectPath: string ) {
+	const dbPhpPath = path.join( projectPath, 'wp-content', 'db.php' );
+	const hasDbPhpInSitu = fs.existsSync( dbPhpPath ) && fs.lstatSync( dbPhpPath ).isFile();
+
+	const { wpContentPath } = await getWpNowConfig( { path: projectPath } );
+	if (
+		wpContentPath &&
+		fs.existsSync( path.join( wpContentPath, 'database' ) ) &&
+		! hasDbPhpInSitu
+	) {
+		// Do not mount but move the files to projectPath once
+		const databasePath = path.join( projectPath, 'wp-content', 'database' );
+		fs.rmdirSync( databasePath );
+		fs.moveSync( path.join( wpContentPath, 'database' ), databasePath );
+
+		const sqlitePath = path.join( projectPath, 'wp-content', 'plugins', SQLITE_FILENAME );
+		fs.rmdirSync( sqlitePath );
+		fs.copySync( path.join( getSqlitePath() ), sqlitePath );
+
+		fs.rmdirSync( dbPhpPath );
+		fs.copySync( path.join( getSqlitePath(), 'db.copy' ), dbPhpPath );
+		fs.rmSync( wpContentPath, { recursive: true, force: true } );
+	}
+}
+
+export async function migrateAllDatabasesInSitu() {
+	const userData = await loadUserData();
+	for ( const site of userData.sites ) {
+		moveDatabasesInSitu( site.path ).then( () => {
+			keepSqliteIntegrationUpdated( site.path );
+		} );
+	}
+}