Separate telemetry handling between CLI and the app

AGENTS.md

@@ -50,7 +50,7 @@ WordPress Studio - Electron desktop app for managing local WordPress sites. Buil
 
 ## Build & Distribution
 
-**Build**: CLI (`vite build --config apps/cli/vite.config.ts`) → Electron (`electron-vite build --config apps/studio/electron.vite.config.ts`) → Package (`electron-forge make --config apps/studio/forge.config.ts`)
+**Build**: CLI (`vite build --config apps/cli/vite.config.dev.ts`) → Electron (`electron-vite build --config apps/studio/electron.vite.config.ts`) → Package (`electron-forge make --config apps/studio/forge.config.ts`)
 **Platforms**: macOS (x64/ARM64 DMG), Windows (x64/ARM64 MSIX), Linux (DEB)
 **Bundling**: Rollup (main), Vite (renderer with code splitting), ASAR (resources)
 

apps/cli/globals.d.ts

@@ -1,3 +1,5 @@
-declare const __ENABLE_STUDIO_AI__: boolean;
 declare const __ENABLE_AGENT_SUITE__: boolean;
+declare const __ENABLE_CLI_TELEMETRY__: boolean;
+declare const __ENABLE_STUDIO_AI__: boolean;
+declare const __IS_PACKAGED_FOR_NPM__: boolean;
 declare const __STUDIO_CLI_VERSION__: string;

apps/cli/index.ts

@@ -1,34 +1,17 @@
 import path from 'node:path';
-import {
-	bumpAggregatedUniqueStat,
-	AppdataProvider,
-	LastBumpStatsData,
-} from '@studio/common/lib/bump-stat';
 import { suppressPunycodeWarning } from '@studio/common/lib/suppress-punycode-warning';
-import { StatsGroup, StatsMetric } from '@studio/common/types/stats';
 import { __ } from '@wordpress/i18n';
 import yargs from 'yargs';
-import { readAppdata, lockAppdata, unlockAppdata, saveAppdata } from 'cli/lib/appdata';
+import { bumpAggregatedUniqueStat, getPlatformMetric } from 'cli/lib/bump-stat';
 import { loadTranslations } from 'cli/lib/i18n';
+import { StatsGroup, StatsMetric } from 'cli/lib/types/bump-stats';
 import { untildify } from 'cli/lib/utils';
 import { StudioArgv } from 'cli/types';
 
 const version = __STUDIO_CLI_VERSION__;
 
 suppressPunycodeWarning();
 
-const cliAppdataProvider: AppdataProvider< LastBumpStatsData > = {
-	load: readAppdata,
-	lock: lockAppdata,
-	unlock: unlockAppdata,
-	save: async ( data ) => {
-		// Cast is safe: data comes from readAppdata() which returns the full UserData type.
-		// The lock/unlock is already handled by the caller (updateLastBump in /common/lib/bump-stat.ts)
-		// eslint-disable-next-line studio/require-lock-before-save
-		await saveAppdata( data as never );
-	},
-};
-
 async function main() {
 	const yargsLocale = await loadTranslations();
 
@@ -52,14 +35,27 @@ async function main() {
 			},
 		} )
 		.middleware( async ( argv ) => {
-			if ( ! argv.avoidTelemetry ) {
+			if ( __ENABLE_CLI_TELEMETRY__ && ! argv.avoidTelemetry ) {
 				try {
 					await bumpAggregatedUniqueStat(
 						StatsGroup.STUDIO_CLI_USAGE_UNIQUE,
 						StatsMetric.SUCCESS,
-						'weekly',
-						cliAppdataProvider
+						'weekly'
 					);
+
+					if ( __IS_PACKAGED_FOR_NPM__ ) {
+						await bumpAggregatedUniqueStat(
+							StatsGroup.STUDIO_CLI_WEEKLY_UNIQUE_NPM,
+							getPlatformMetric(),
+							'weekly'
+						);
+					} else {
+						await bumpAggregatedUniqueStat(
+							StatsGroup.STUDIO_CLI_WEEKLY_UNIQUE_APP,
+							getPlatformMetric(),
+							'weekly'
+						);
+					}
 				} catch ( error ) {
 					console.error( 'Failed to bump stat:', error );
 				}

apps/cli/lib/appdata.ts

@@ -7,7 +7,6 @@ import { lockFileAsync, unlockFileAsync } from '@studio/common/lib/lockfile';
 import { getAuthenticationUrl } from '@studio/common/lib/oauth';
 import { siteDetailsSchema } from '@studio/common/lib/site-events';
 import { snapshotSchema } from '@studio/common/types/snapshot';
-import { StatsMetric } from '@studio/common/types/stats';
 import { __, sprintf } from '@wordpress/i18n';
 import { readFile, writeFile } from 'atomically';
 import { z } from 'zod';
@@ -44,9 +43,7 @@ const userDataSchema = z
 			} )
 			.loose()
 			.optional(),
-		lastBumpStats: z
-			.record( z.string(), z.partialRecord( z.enum( StatsMetric ), z.number() ) )
-			.optional(),
+		lastBumpStats: z.record( z.string(), z.record( z.string(), z.number() ) ).optional(),
 		betaFeatures: betaFeaturesSchema.optional(),
 	} )
 	.loose();

apps/cli/lib/bump-stat.ts

@@ -0,0 +1,50 @@
+import {
+	__bumpAggregatedUniqueStat,
+	__bumpStat,
+	AggregateInterval,
+	LastBumpStatsProvider,
+} from '@studio/common/lib/bump-stat';
+import { lockAppdata, readAppdata, saveAppdata, unlockAppdata } from 'cli/lib/appdata';
+import { StatsGroup, StatsMetric } from 'cli/lib/types/bump-stats';
+
+const lastBumpStatsProvider: LastBumpStatsProvider = {
+	load: async () => {
+		const { lastBumpStats } = await readAppdata();
+		return lastBumpStats ?? {};
+	},
+	lock: lockAppdata,
+	unlock: unlockAppdata,
+	save: async ( lastBumpStats ) => {
+		const appdata = await readAppdata();
+		appdata.lastBumpStats = lastBumpStats;
+		// Locking is handled in `@studio/common/lib/bump-stat`
+		// eslint-disable-next-line studio/require-lock-before-save
+		await saveAppdata( appdata );
+	},
+};
+
+export function bumpStat( group: StatsGroup, stat: StatsMetric, bumpInDev = false ) {
+	return __bumpStat( group, stat, bumpInDev );
+}
+
+export async function bumpAggregatedUniqueStat(
+	group: StatsGroup,
+	stat: StatsMetric,
+	aggregateBy: AggregateInterval,
+	bumpInDev = false
+) {
+	return __bumpAggregatedUniqueStat( group, stat, aggregateBy, lastBumpStatsProvider, bumpInDev );
+}
+
+export function getPlatformMetric(): StatsMetric {
+	switch ( process.platform ) {
+		case 'darwin':
+			return StatsMetric.DARWIN;
+		case 'linux':
+			return StatsMetric.LINUX;
+		case 'win32':
+			return StatsMetric.WINDOWS;
+		default:
+			return StatsMetric.UNKNOWN_PLATFORM;
+	}
+}

apps/cli/lib/tests/appdata.test.ts

@@ -2,7 +2,6 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import { arePathsEqual } from '@studio/common/lib/fs-utils';
-import { StatsMetric } from '@studio/common/types/stats';
 import { readFile, writeFile } from 'atomically';
 import { vi } from 'vitest';
 import {
@@ -12,6 +11,7 @@ import {
 	lockAppdata,
 	unlockAppdata,
 } from 'cli/lib/appdata';
+import { StatsMetric } from 'cli/lib/types/bump-stats';
 
 vi.mock( 'fs', () => ( {
 	default: {

apps/cli/lib/types/bump-stats.ts

@@ -0,0 +1,15 @@
+export enum StatsGroup {
+	STUDIO_CLI_USAGE_UNIQUE = 'studio-cli-usage-unique',
+	STUDIO_CLI_WEEKLY_UNIQUE_NPM = 'studio-cli-weekly-unq-npm',
+	STUDIO_CLI_WEEKLY_UNIQUE_APP = 'studio-cli-weekly-unq-app',
+}
+
+export enum StatsMetric {
+	SUCCESS = 'success',
+	FAILURE = 'failure',
+	// Platforms
+	DARWIN = 'darwin',
+	LINUX = 'linux',
+	WINDOWS = 'win32',
+	UNKNOWN_PLATFORM = 'unknown-platform',
+}

apps/cli/package.json

@@ -50,11 +50,12 @@
 		"zod": "^4.3.6"
 	},
 	"scripts": {
-		"build": "vite build --config ./vite.config.ts",
+		"build": "vite build --config ./vite.config.dev.ts",
+		"build:prod": "vite build --config ./vite.config.prod.ts",
 		"build:npm": "vite build --config ./vite.config.npm.ts",
 		"install:bundle": "npm install --omit=dev --no-package-lock --no-progress --install-links --no-workspaces && patch-package && node ../../scripts/remove-fs-ext-other-platform-binaries.mjs",
-		"package": "npm run install:bundle && npm run build",
-		"watch": "vite build --config ./vite.config.ts --watch",
+		"package": "npm run install:bundle && npm run build:prod",
+		"watch": "vite build --config ./vite.config.dev.ts --watch",
 		"prepublishOnly": "npm run build:npm",
 		"postinstall": "node scripts/postinstall-npm.mjs"
 	},

apps/cli/vite.config.base.ts

@@ -65,8 +65,8 @@ export const baseConfig = defineConfig( {
 		mainFields: [ 'main' ],
 	},
 	define: {
-		__STUDIO_CLI_VERSION__: JSON.stringify( packageJson.version ),
 		__ENABLE_STUDIO_AI__: true,
 		__ENABLE_AGENT_SUITE__: true,
+		__STUDIO_CLI_VERSION__: JSON.stringify( packageJson.version ),
 	},
 } );

apps/cli/vite.config.dev.ts

@@ -0,0 +1,12 @@
+import { defineConfig, mergeConfig } from 'vite';
+import { baseConfig } from './vite.config.base';
+
+export default mergeConfig(
+	baseConfig,
+	defineConfig( {
+		define: {
+			__IS_PACKAGED_FOR_NPM__: false,
+			__ENABLE_CLI_TELEMETRY__: false,
+		},
+	} )
+);

apps/cli/vite.config.npm.ts

@@ -14,8 +14,10 @@ export default mergeConfig(
 			},
 		},
 		define: {
-			__ENABLE_STUDIO_AI__: false,
 			__ENABLE_AGENT_SUITE__: false,
+			__ENABLE_CLI_TELEMETRY__: true,
+			__ENABLE_STUDIO_AI__: false,
+			__IS_PACKAGED_FOR_NPM__: true,
 		},
 	} )
 );

apps/cli/vite.config.ts → apps/cli/vite.config.prod.ts

@@ -3,13 +3,13 @@ import { resolve } from 'path';
 import { sync as globSync } from 'glob';
 import { defineConfig, mergeConfig } from 'vite';
 import { viteStaticCopy } from 'vite-plugin-static-copy';
-import { baseConfig } from './vite.config.base';
+import devConfig from './vite.config.dev';
 
 const cliNodeModulesPath = resolve( __dirname, 'node_modules' );
 const distCliNodeModulesPath = resolve( __dirname, 'dist/cli/node_modules' );
 
 export default mergeConfig(
-	baseConfig,
+	devConfig,
 	defineConfig( {
 		plugins: [
 			...( existsSync( cliNodeModulesPath )
@@ -43,5 +43,8 @@ export default mergeConfig(
 				  ]
 				: [] ),
 		],
+		define: {
+			__ENABLE_CLI_TELEMETRY__: true,
+		},
 	} )
 );

apps/studio/src/index.ts

@@ -13,14 +13,7 @@ import path from 'path';
 import { pathToFileURL } from 'url';
 import * as Sentry from '@sentry/electron/main';
 import { PROTOCOL_PREFIX } from '@studio/common/constants';
-import {
-	bumpStat,
-	bumpAggregatedUniqueStat,
-	AppdataProvider,
-	LastBumpStatsData,
-} from '@studio/common/lib/bump-stat';
 import { suppressPunycodeWarning } from '@studio/common/lib/suppress-punycode-warning';
-import { StatsGroup } from '@studio/common/types/stats';
 import { __, _n, sprintf } from '@wordpress/i18n';
 import {
 	installExtension,
@@ -33,7 +26,12 @@ import {
 	hasActiveSyncOperations,
 	hasUploadingPushOperations,
 } from 'src/lib/active-sync-operations';
-import { getPlatformMetric } from 'src/lib/bump-stats/lib';
+import {
+	bumpStat,
+	bumpAggregatedUniqueStat,
+	getPlatformMetric,
+	StatsGroup,
+} from 'src/lib/bump-stats';
 import { handleDeeplink } from 'src/lib/deeplink';
 import { getUserLocaleWithFallback } from 'src/lib/locale-node';
 import { getSentryReleaseInfo } from 'src/lib/sentry-release';
@@ -89,20 +87,6 @@ if ( ! process.env.IS_DEV_BUILD ) {
 
 suppressPunycodeWarning();
 
-const appAppdataProvider: AppdataProvider< LastBumpStatsData > = {
-	load: loadUserData,
-	lock: lockAppdata,
-	unlock: unlockAppdata,
-	save: async ( data ) => {
-		// Cast is safe: data comes from loadUserData() which returns the full UserData type.
-		// The lock/unlock is already handled by the caller (updateLastBump in /common/lib/bump-stat.ts)
-		// eslint-disable-next-line studio/require-lock-before-save
-		await saveUserData( data as never );
-	},
-};
-
-// Handle creating/removing shortcuts on Windows when installing/uninstalling.
-
 const isInInstaller = require( 'electron-squirrel-startup' );
 
 // Ensure we're the only instance of the app running
@@ -345,24 +329,22 @@ async function appBoot() {
 		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 ) );
+			bumpStat( StatsGroup.STUDIO_APP_LAUNCH, getPlatformMetric() );
 		}
 
 		// Bump a stat on each app launch, approximates total app launches
-		bumpStat( StatsGroup.STUDIO_APP_LAUNCH_TOTAL, getPlatformMetric( process.platform ) );
+		bumpStat( StatsGroup.STUDIO_APP_LAUNCH_TOTAL, getPlatformMetric() );
 		// Bump stat for unique weekly app launch, approximates weekly active users
 		bumpAggregatedUniqueStat(
 			StatsGroup.STUDIO_APP_LAUNCH_UNIQUE,
-			getPlatformMetric( process.platform ),
-			'weekly',
-			appAppdataProvider
+			getPlatformMetric(),
+			'weekly'
 		).catch( ( err ) => Sentry.captureException( err ) );
 		// Bump stat for unique monthly app launch, approximates monthly active users
 		bumpAggregatedUniqueStat(
 			StatsGroup.STUDIO_APP_LAUNCH_UNIQUE_MONTHLY,
-			getPlatformMetric( process.platform ),
-			'monthly',
-			appAppdataProvider
+			getPlatformMetric(),
+			'monthly'
 		).catch( ( err ) => Sentry.captureException( err ) );
 
 		await updateWindowsCliVersionedPathIfNeeded();

apps/studio/src/ipc-handlers.ts

@@ -18,7 +18,6 @@ import os from 'os';
 import nodePath from 'path';
 import * as Sentry from '@sentry/electron/main';
 import { validateBlueprintData } from '@studio/common/lib/blueprint-validation';
-import { bumpStat } from '@studio/common/lib/bump-stat';
 import { parseCliError, errorMessageContains } from '@studio/common/lib/cli-error';
 import {
 	calculateDirectorySizeForArchive,
@@ -37,12 +36,17 @@ import { portFinder } from '@studio/common/lib/port-finder';
 import { sanitizeFolderName } from '@studio/common/lib/sanitize-folder-name';
 import { isWordPressDevVersion } from '@studio/common/lib/wordpress-version-utils';
 import { Snapshot } from '@studio/common/types/snapshot';
-import { StatsGroup, StatsMetric } from '@studio/common/types/stats';
 import { __, sprintf, LocaleData, defaultI18n } from '@wordpress/i18n';
 import { MACOS_TRAFFIC_LIGHT_POSITION, MAIN_MIN_WIDTH, SIDEBAR_WIDTH } from 'src/constants';
 import { sendIpcEventToRendererWithWindow } from 'src/ipc-utils';
 import { getBetaFeatures as getBetaFeaturesFromLib } from 'src/lib/beta-features';
-import { getImporterMetric, getBlueprintMetric } from 'src/lib/bump-stats/lib';
+import {
+	bumpStat,
+	getImporterMetric,
+	getBlueprintMetric,
+	StatsGroup,
+	StatsMetric,
+} from 'src/lib/bump-stats';
 import {
 	openCertificate as openCertificateDialog,
 	isRootCATrusted,