Migrate HTTPS certificates to ~/.studio/certificates

apps/cli/lib/certificate-manager.ts

@@ -4,10 +4,10 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { domainToASCII } from 'node:url';
 import { promisify } from 'node:util';
+import { getCertificatesPath } from '@studio/common/lib/config-paths';
 import sudo from '@vscode/sudo-prompt';
 import { __ } from '@wordpress/i18n';
 import forge from 'node-forge';
-import { getAppdataDirectory } from 'cli/lib/server-files';
 
 const execFilePromise = promisify( execFile );
 
@@ -67,7 +67,7 @@ function createNameConstraintsExtension( domains: string[] ) {
 const CA_NAME = 'WordPress Studio CA';
 const CA_CERT_VALIDITY_DAYS = 3650; // 10 years
 const SITE_CERT_VALIDITY_DAYS = 825; // a little over 2 years
-const CERT_DIRECTORY = path.join( getAppdataDirectory(), 'certificates' );
+const CERT_DIRECTORY = getCertificatesPath();
 const CA_CERT_PATH = path.join( CERT_DIRECTORY, 'studio-ca.crt' );
 const CA_KEY_PATH = path.join( CERT_DIRECTORY, 'studio-ca.key' );
 

apps/studio/src/ipc-handlers.ts

@@ -203,12 +203,12 @@ export async function installWordPressSkills(
 export async function getWordPressSkillsStatusAllSites(
 	_event: IpcMainInvokeEvent
 ): Promise< SkillStatus[] > {
-	const { sites } = await loadUserData();
+	const sites = SiteServer.getAll();
 	if ( ! sites.length ) {
 		return BUNDLED_SKILLS.map( ( skill ) => ( { ...skill, installed: false } ) );
 	}
 	const allSiteStatuses = await Promise.all(
-		sites.map( ( site ) => getSkillsStatus( site.path ) )
+		sites.map( ( site ) => getSkillsStatus( site.details.path ) )
 	);
 	return BUNDLED_SKILLS.map( ( skill ) => ( {
 		...skill,
@@ -222,14 +222,14 @@ export async function installWordPressSkillsToAllSites(
 	_event: IpcMainInvokeEvent,
 	options?: { skillId?: string; overwrite?: boolean }
 ): Promise< void > {
-	const { sites } = await loadUserData();
+	const sites = SiteServer.getAll();
 	const overwrite = options?.overwrite ?? false;
 	const bundledPath = getAiInstructionsPath();
 	const tasks = sites.flatMap( ( site ) =>
 		options?.skillId
-			? [ installSkillToSite( site.path, bundledPath, options.skillId, overwrite ) ]
+			? [ installSkillToSite( site.details.path, bundledPath, options.skillId, overwrite ) ]
 			: BUNDLED_SKILLS.map( ( skill ) =>
-					installSkillToSite( site.path, bundledPath, skill.id, overwrite )
+					installSkillToSite( site.details.path, bundledPath, skill.id, overwrite )
 			  )
 	);
 	const results = await Promise.allSettled( tasks );
@@ -244,8 +244,8 @@ export async function removeWordPressSkillFromAllSites(
 	_event: IpcMainInvokeEvent,
 	skillId: string
 ): Promise< void > {
-	const { sites } = await loadUserData();
-	const tasks = sites.map( ( site ) => removeSkillFromSite( site.path, skillId ) );
+	const sites = SiteServer.getAll();
+	const tasks = sites.map( ( site ) => removeSkillFromSite( site.details.path, skillId ) );
 	const results = await Promise.allSettled( tasks );
 	results.forEach( ( result ) => {
 		if ( result.status === 'rejected' ) {

apps/studio/src/lib/certificate-manager.ts

@@ -4,14 +4,13 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { promisify } from 'node:util';
 import * as Sentry from '@sentry/electron/main';
+import { getCertificatesPath } from '@studio/common/lib/config-paths';
 import sudo from '@vscode/sudo-prompt';
-import { getUserDataCertificatesPath } from 'src/storage/paths';
 
 const execFilePromise = promisify( execFile );
 
 // Certificate configuration
-const CERT_DIRECTORY = getUserDataCertificatesPath();
-const CA_CERT_PATH = path.join( CERT_DIRECTORY, 'studio-ca.crt' );
+const CA_CERT_PATH = path.join( getCertificatesPath(), 'studio-ca.crt' );
 
 export async function openCertificate() {
 	shell.showItemInFolder( CA_CERT_PATH );

apps/studio/src/lib/import-export/tests/import/import-manager.test.ts

@@ -10,12 +10,6 @@ import { BackupContents, BackupArchiveInfo } from 'src/lib/import-export/import/
 import { Validator } from 'src/lib/import-export/import/validators/validator';
 import type { Stats } from 'fs';
 
-vi.mock( 'src/storage/paths', () => ( {
-	getResourcesPath: vi.fn().mockReturnValue( '/path/to/app/appData/App Name' ),
-	getUserDataCertificatesPath: vi
-		.fn()
-		.mockReturnValue( '/path/to/app/appData/App Name/certificates' ),
-} ) );
 vi.mock( 'src/lib/import-export/import/handlers/backup-handler-factory' );
 vi.mock( 'fs/promises', () => ( {
 	default: {

apps/studio/src/migrations/03-copy-https-certs-to-well-known.ts

@@ -0,0 +1,30 @@
+/**
+ * Migrates the `certificates` directory from the platform-specific Electron location to a
+ * well-known location at `~/.studio/certificates`.
+ *
+ * The old directory is intentionally not deleted. It'll be cleaned up in a future migration.
+ */
+
+import fs from 'node:fs';
+import { getCertificatesPath } from '@studio/common/lib/config-paths';
+import { getOldUserDataCertificatesPath } from 'src/storage/paths';
+import type { Migration } from '@studio/common/lib/migration';
+
+const NEW_CERT_DIR = getCertificatesPath();
+const OLD_CERT_DIR = getOldUserDataCertificatesPath();
+
+export const copyHttpsCertsToWellKnown: Migration = {
+	needsToRun: async () => {
+		return fs.existsSync( OLD_CERT_DIR ) && ! fs.existsSync( NEW_CERT_DIR );
+	},
+	run: async () => {
+		await fs.promises.mkdir( NEW_CERT_DIR, { recursive: true } );
+
+		if ( fs.existsSync( OLD_CERT_DIR ) ) {
+			await fs.promises.cp( OLD_CERT_DIR, NEW_CERT_DIR, {
+				recursive: true,
+				verbatimSymlinks: true,
+			} );
+		}
+	},
+};

apps/studio/src/migrations/index.ts

@@ -1,10 +1,12 @@
 import { migrateFromWpNowFolder } from './00-migrate-from-wp-now-folder';
 import { renameLaunchUniquesStat } from './01-rename-launch-uniques-stat';
 import { migrateAppConfig } from './02-migrate-to-split-config';
+import { copyHttpsCertsToWellKnown } from './03-copy-https-certs-to-well-known';
 import type { Migration } from '@studio/common/lib/migration';
 
 export const migrations: Migration[] = [
 	migrateAppConfig,
 	migrateFromWpNowFolder,
 	renameLaunchUniquesStat,
+	copyHttpsCertsToWellKnown,
 ];

apps/studio/src/storage/paths.ts

@@ -26,7 +26,7 @@ export function getServerFilesPath(): string {
 	return path.join( getAppDataPath(), getAppName(), 'server-files' );
 }
 
-export function getUserDataCertificatesPath(): string {
+export function getOldUserDataCertificatesPath(): string {
 	return path.join( getAppDataPath(), getAppName(), 'certificates' );
 }
 

apps/studio/src/tests/index.test.ts

@@ -34,16 +34,6 @@ vi.mock( 'atomically', () => ( {
 	readFile: vi.fn().mockResolvedValue( Buffer.from( JSON.stringify( { sites: [] } ) ) ),
 	writeFile: vi.fn(),
 } ) );
-vi.mock( 'src/storage/paths', () => ( {
-	getResourcesPath: vi.fn().mockReturnValue( '/mock/resources' ),
-	getUserDataFilePath: vi.fn().mockReturnValue( '/mock/userdata.json' ),
-	getUserDataCertificatesPath: vi.fn().mockReturnValue( '/mock/certificates' ),
-	getServerFilesPath: vi.fn().mockReturnValue( '/mock/server/files' ),
-	getCliPath: vi.fn().mockReturnValue( '/mock/cli/path' ),
-	getBundledNodeBinaryPath: vi.fn().mockReturnValue( '/mock/node/binary' ),
-	getSiteThumbnailPath: vi.fn().mockReturnValue( '/mock/thumbnail.png' ),
-	DEFAULT_SITE_PATH: '/mock/default/site/path',
-} ) );
 vi.mock( 'src/modules/cli/lib/execute-command', () => {
 	const mockEventEmitter = {
 		on: vi.fn().mockImplementation( ( event: string, callback: ( ...args: any[] ) => void ) => {

apps/studio/src/tests/ipc-handlers.test.ts

@@ -27,16 +27,6 @@ vi.mock( '@sentry/electron/main', () => ( {
 	captureException: vi.fn(),
 	captureMessage: vi.fn(),
 } ) );
-vi.mock( 'src/storage/paths', () => ( {
-	getResourcesPath: vi.fn().mockReturnValue( '/mock/resources' ),
-	getUserDataFilePath: vi.fn().mockReturnValue( '/mock/userdata.json' ),
-	getUserDataCertificatesPath: vi.fn().mockReturnValue( '/mock/certificates' ),
-	getServerFilesPath: vi.fn().mockReturnValue( '/mock/server/files' ),
-	getCliPath: vi.fn().mockReturnValue( '/mock/cli/path' ),
-	getBundledNodeBinaryPath: vi.fn().mockReturnValue( '/mock/node/binary' ),
-	getSiteThumbnailPath: vi.fn().mockReturnValue( '/mock/thumbnail.png' ),
-	DEFAULT_SITE_PATH: '/mock/default/site/path',
-} ) );
 vi.mock( 'src/site-server' );
 vi.mock( 'src/lib/wordpress-setup', () => ( {
 	setupWordPressFilesOnly: vi.fn().mockResolvedValue( undefined ),

apps/studio/src/tests/main-window.test.ts

@@ -15,16 +15,6 @@ vi.mock( 'atomically' );
 vi.mock( 'src/lib/app-globals', () => ( {
 	saveWindowBounds: vi.fn(),
 } ) );
-vi.mock( 'src/storage/paths', () => ( {
-	getResourcesPath: vi.fn().mockReturnValue( '/mock/resources' ),
-	getUserDataFilePath: vi.fn().mockReturnValue( '/mock/userdata.json' ),
-	getUserDataCertificatesPath: vi.fn().mockReturnValue( '/mock/certificates' ),
-	getServerFilesPath: vi.fn().mockReturnValue( '/mock/server/files' ),
-	getCliPath: vi.fn().mockReturnValue( '/mock/cli/path' ),
-	getBundledNodeBinaryPath: vi.fn().mockReturnValue( '/mock/node/binary' ),
-	getSiteThumbnailPath: vi.fn().mockReturnValue( '/mock/thumbnail.png' ),
-	DEFAULT_SITE_PATH: '/mock/default/site/path',
-} ) );
 
 // Create a simpler mock that tracks event handlers
 const mockEventHandlers = new Map< string, ( ( ...args: any[] ) => void )[] >();

apps/studio/src/tests/open-file-in-ide.test.ts

@@ -35,16 +35,6 @@ vi.mock( '@sentry/electron/main', () => ( {
 	captureException: vi.fn(),
 	captureMessage: vi.fn(),
 } ) );
-vi.mock( 'src/storage/paths', () => ( {
-	getResourcesPath: vi.fn().mockReturnValue( '/mock/resources' ),
-	getUserDataFilePath: vi.fn().mockReturnValue( '/mock/userdata.json' ),
-	getUserDataCertificatesPath: vi.fn().mockReturnValue( '/mock/certificates' ),
-	getServerFilesPath: vi.fn().mockReturnValue( '/mock/server/files' ),
-	getCliPath: vi.fn().mockReturnValue( '/mock/cli/path' ),
-	getBundledNodeBinaryPath: vi.fn().mockReturnValue( '/mock/node/binary' ),
-	getSiteThumbnailPath: vi.fn().mockReturnValue( '/mock/thumbnail.png' ),
-	DEFAULT_SITE_PATH: '/mock/default/site/path',
-} ) );
 vi.mock( 'src/site-server' );
 vi.mock( 'src/lib/is-installed' );
 vi.mock( 'src/lib/shell-open-external-wrapper' );

apps/studio/vitest.setup.ts

@@ -166,13 +166,18 @@ vi.mock( 'electron', () => {
 	};
 } );
 
-vi.mock( 'src/storage/paths', () => ( {
+vi.mock( import( './src/storage/paths' ), () => ( {
 	getResourcesPath: vi.fn().mockReturnValue( '/mock/resources' ),
 	getUserDataFilePath: vi.fn().mockReturnValue( '/mock/userdata.json' ),
-	getUserDataCertificatesPath: vi.fn().mockReturnValue( '/mock/certificates' ),
+	getUserDataLockFilePath: vi.fn().mockReturnValue( '/mock/userdata.json.lock' ),
+	getOldUserDataCertificatesPath: vi.fn().mockReturnValue( '/mock/certificates' ),
+	getServerFilesPath: vi.fn().mockReturnValue( '/mock/server/files' ),
+	getCliPath: vi.fn().mockReturnValue( '/mock/cli/path' ),
+	getBundledNodeBinaryPath: vi.fn().mockReturnValue( '/mock/node/binary' ),
+	getSiteThumbnailPath: vi.fn().mockReturnValue( '/mock/thumbnail.png' ),
+	DEFAULT_SITE_PATH: '/mock/default/site/path',
 } ) );
 
-
 vi.mock( 'lockfile', () => {
 	const lock = vi.fn( ( file, options, callback ) => callback( null ) );
 	const unlock = vi.fn( ( file, callback ) => callback( null ) );

eslint.config.mjs

@@ -74,7 +74,10 @@ export default defineConfig(
 			],
 			'import-x/no-named-as-default-member': 'off',
 			// @wp-playground/blueprints ships blueprint-schema-validator outside its package.json exports map
-			'import-x/no-unresolved': [ 'error', { ignore: [ '@wp-playground/blueprints/blueprint-schema-validator' ] } ],
+			'import-x/no-unresolved': [
+				'error',
+				{ ignore: [ '@wp-playground/blueprints/blueprint-schema-validator' ] },
+			],
 			'import-x/order': [
 				'error',
 				{

tools/common/lib/config-paths.ts

@@ -27,3 +27,7 @@ export function getCliConfigPath(): string {
 	}
 	return path.join( getConfigDirectory(), 'cli.json' );
 }
+
+export function getCertificatesPath(): string {
+	return path.join( getConfigDirectory(), 'certificates' );
+}