Add wpcom.user.id to Sentry errors

apps/studio/src/components/auth-provider.tsx

@@ -7,6 +7,7 @@ import { useIpcListener } from 'src/hooks/use-ipc-listener';
 import { useOffline } from 'src/hooks/use-offline';
 import { getIpcApi } from 'src/lib/get-ipc-api';
 import { isInvalidTokenError } from 'src/lib/is-invalid-oauth-token-error';
+import { setSentryWpcomUserIdRenderer } from 'src/lib/renderer-sentry-utils';
 import { useI18nLocale } from 'src/stores';
 import { setWpcomClient } from 'src/stores/wpcom-api';
 import type { WPCOM } from 'wpcom/types';
@@ -55,6 +56,7 @@ const AuthProvider: React.FC< AuthProviderProps > = ( { children } ) => {
 			setClient( undefined );
 			setWpcomClient( undefined );
 			setUser( undefined );
+			setSentryWpcomUserIdRenderer( undefined );
 		} catch ( err ) {
 			console.error( 'Failed to handle invalid token:', err );
 			Sentry.captureException( err );
@@ -85,6 +87,7 @@ const AuthProvider: React.FC< AuthProviderProps > = ( { children } ) => {
 			setClient( undefined );
 			setWpcomClient( undefined );
 			setUser( undefined );
+			setSentryWpcomUserIdRenderer( undefined );
 			return;
 		}
 
@@ -98,6 +101,7 @@ const AuthProvider: React.FC< AuthProviderProps > = ( { children } ) => {
 			email: token.email,
 			displayName: token.displayName || '',
 		} );
+		setSentryWpcomUserIdRenderer( token.id );
 	} );
 
 	const logout = useCallback( async () => {
@@ -124,6 +128,7 @@ const AuthProvider: React.FC< AuthProviderProps > = ( { children } ) => {
 			setClient( undefined );
 			setWpcomClient( undefined );
 			setUser( undefined );
+			setSentryWpcomUserIdRenderer( undefined );
 		} catch ( err ) {
 			console.error( err );
 			Sentry.captureException( err );
@@ -150,6 +155,7 @@ const AuthProvider: React.FC< AuthProviderProps > = ( { children } ) => {
 					email: token.email,
 					displayName: token.displayName || '',
 				} );
+				setSentryWpcomUserIdRenderer( token.id );
 			} catch ( err ) {
 				console.error( err );
 				Sentry.captureException( err );

apps/studio/src/index.ts

@@ -14,6 +14,7 @@ import { pathToFileURL } from 'url';
 import * as Sentry from '@sentry/electron/main';
 import { PROTOCOL_PREFIX } from '@studio/common/constants';
 import { runMigrations } from '@studio/common/lib/migration';
+import { getCurrentUserId } from '@studio/common/lib/shared-config';
 import { suppressPunycodeWarning } from '@studio/common/lib/suppress-punycode-warning';
 import { __, _n, sprintf } from '@wordpress/i18n';
 import {
@@ -36,6 +37,7 @@ import {
 import { handleDeeplink } from 'src/lib/deeplink';
 import { getUserLocaleWithFallback } from 'src/lib/locale-node';
 import { getSentryReleaseInfo } from 'src/lib/sentry-release';
+import { setSentryWpcomUserIdMain } from 'src/lib/main-sentry-utils';
 import { startUserDataWatcher, stopUserDataWatcher } from 'src/lib/user-data-watcher';
 import { setupLogging } from 'src/logging';
 import { createMainWindow, getMainWindow } from 'src/main-window';
@@ -110,6 +112,9 @@ async function setupSentryUserId() {
 	} finally {
 		await unlockAppdata();
 	}
+
+	const wpcomUserId = await getCurrentUserId();
+	setSentryWpcomUserIdMain( wpcomUserId ?? undefined );
 }
 
 // This is a workaround to ensure that the extension background workers are started

apps/studio/src/ipc-handlers.ts

@@ -62,6 +62,7 @@ import { defaultImporterOptions, importBackup } from 'src/lib/import-export/impo
 import { BackupArchiveInfo } from 'src/lib/import-export/import/types';
 import { getUserLocaleWithFallback } from 'src/lib/locale-node';
 import * as oauthClient from 'src/lib/oauth';
+import { setSentryWpcomUserIdMain } from 'src/lib/main-sentry-utils';
 import { getAiInstructionsPath } from 'src/lib/server-files-paths';
 import { shellOpenExternalWrapper } from 'src/lib/shell-open-external-wrapper';
 import { keepSqliteIntegrationUpdated } from 'src/lib/sqlite-versions';
@@ -764,6 +765,7 @@ export async function isAuthenticated() {
 }
 
 export async function clearAuthenticationToken() {
+	setSentryWpcomUserIdMain( undefined );
 	return await updateSharedConfig( { authToken: undefined } );
 }
 

apps/studio/src/lib/deeplink/handlers/auth.ts

@@ -4,6 +4,7 @@ import wpcomFactory from '@studio/common/lib/wpcom-factory';
 import wpcomXhrRequest from '@studio/common/lib/wpcom-xhr-request-factory';
 import { z } from 'zod';
 import { sendIpcEventToRenderer } from 'src/ipc-utils';
+import { setSentryWpcomUserIdMain } from 'src/lib/main-sentry-utils';
 
 const meResponseSchema = z.object( {
 	ID: z.number(),
@@ -54,6 +55,7 @@ export async function handleAuthDeeplink( urlObject: URL ): Promise< void > {
 	try {
 		const authResult = await handleAuthCallback( hash );
 		await updateSharedConfig( { authToken: authResult } );
+		setSentryWpcomUserIdMain( authResult.id );
 		void sendIpcEventToRenderer( 'auth-updated', { token: authResult } );
 	} catch ( error ) {
 		Sentry.captureException( error );

apps/studio/src/lib/main-sentry-utils.ts

@@ -0,0 +1,5 @@
+import * as Sentry from '@sentry/electron/main';
+
+export function setSentryWpcomUserIdMain( id: number | undefined ) {
+	Sentry.setTag( 'wpcom.user.id', id );
+}

apps/studio/src/lib/renderer-sentry-utils.ts

@@ -0,0 +1,5 @@
+import * as Sentry from '@sentry/electron/renderer';
+
+export function setSentryWpcomUserIdRenderer( id: number | undefined ) {
+	Sentry.setTag( 'wpcom.user.id', id );
+}

apps/studio/src/tests/execute-wp-cli.test.ts

@@ -11,6 +11,7 @@ vi.mock( 'src/constants', () => ( {
 } ) );
 vi.mock( '@sentry/electron/main', () => ( {
 	captureException: vi.fn(),
+	setTag: vi.fn(),
 } ) );
 import { executeCliCommand } from 'src/modules/cli/lib/execute-command';
 import type { CliCommandResult } from 'src/modules/cli/lib/execute-command';

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

@@ -15,6 +15,7 @@ vi.mock( '@sentry/electron/main', () => ( {
 	captureException: vi.fn(),
 	captureMessage: vi.fn(),
 	setUser: vi.fn(),
+	setTag: vi.fn(),
 } ) );
 vi.mock( import( 'src/lib/bump-stats' ), async ( importOriginal ) => {
 	const actual = await importOriginal();

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

@@ -26,6 +26,7 @@ vi.mock( '@studio/common/lib/fs-utils' );
 vi.mock( '@sentry/electron/main', () => ( {
 	captureException: vi.fn(),
 	captureMessage: vi.fn(),
+	setTag: vi.fn(),
 } ) );
 vi.mock( 'src/site-server' );
 vi.mock( 'src/lib/wordpress-setup', () => ( {

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

@@ -34,6 +34,7 @@ vi.mock( '@studio/common/lib/fs-utils', () => ( {
 vi.mock( '@sentry/electron/main', () => ( {
 	captureException: vi.fn(),
 	captureMessage: vi.fn(),
+	setTag: vi.fn(),
 } ) );
 vi.mock( 'src/site-server' );
 vi.mock( 'src/lib/is-installed' );

apps/studio/vitest.setup.ts

@@ -128,6 +128,7 @@ global.ResizeObserver = require( 'resize-observer-polyfill' );
 vi.mock( '@sentry/electron/main', () => ( {
 	captureException: vi.fn(),
 	captureMessage: vi.fn(),
+	setTag: vi.fn(),
 } ) );
 
 vi.mock( 'electron', () => {