Merge pull request #11776 from google/enhancement/11722-ga-event-analytics-setup

techanvil · web-flow · commit 7756790a801a · 2025-11-25T10:51:34.000Z
[11722] Add GA event tracking for the Analytics setup screen.
diff --git a/assets/js/components/setup/ModuleSetup.js b/assets/js/components/setup/ModuleSetup.js
@@ -41,20 +41,25 @@ import { deleteItem } from '@/js/googlesitekit/api/cache';
 import { trackEvent } from '@/js/util';
 import { useFeature } from '@/js/hooks/useFeature';
 import useQueryArg from '@/js/hooks/useQueryArg';
+import useViewContext from '@/js/hooks/useViewContext';
 import HelpMenu from '@/js/components/help/HelpMenu';
 import { Cell, Grid, Row } from '@/js/material-components';
 import Header from '@/js/components/Header';
 import ModuleSetupFooter from './ModuleSetupFooter';
 import ExitSetup from '@/js/components/setup/ExitSetup';
 import ProgressIndicator from '@/js/components/ProgressIndicator';
-import useViewContext from '@/js/hooks/useViewContext';
 
 export default function ModuleSetup( { moduleSlug } ) {
 	const viewContext = useViewContext();
-
 	const { navigateTo } = useDispatch( CORE_LOCATION );
 	const setupFlowRefreshEnabled = useFeature( 'setupFlowRefresh' );
 	const [ showProgress ] = useQueryArg( 'showProgress' );
+
+	const isInitialSetupFlow =
+		setupFlowRefreshEnabled &&
+		moduleSlug === MODULE_SLUG_ANALYTICS_4 &&
+		showProgress === 'true';
+
 	const module = useSelect( ( select ) =>
 		select( CORE_MODULES ).getModule( moduleSlug )
 	);
@@ -73,11 +78,18 @@ export default function ModuleSetup( { moduleSlug } ) {
 		async ( redirectURL ) => {
 			await deleteItem( 'module_setup' );
 
-			await trackEvent(
-				'moduleSetup',
-				'complete_module_setup',
-				moduleSlug
-			);
+			if ( isInitialSetupFlow ) {
+				await trackEvent(
+					`${ viewContext }_setup`,
+					'setup_flow_v3_complete_analytics_step'
+				);
+			} else {
+				await trackEvent(
+					'moduleSetup',
+					'complete_module_setup',
+					moduleSlug
+				);
+			}
 
 			if ( redirectURL ) {
 				navigateTo( redirectURL );
@@ -95,7 +107,7 @@ export default function ModuleSetup( { moduleSlug } ) {
 			);
 			navigateTo( adminURL );
 		},
-		[ registry, navigateTo, moduleSlug ]
+		[ registry, navigateTo, moduleSlug, viewContext, isInitialSetupFlow ]
 	);
 
 	const onCompleteSetup = module?.onCompleteSetup;
@@ -109,6 +121,15 @@ export default function ModuleSetup( { moduleSlug } ) {
 	}, [ moduleSlug ] );
 
 	useMount( () => {
+		if ( isInitialSetupFlow ) {
+			trackEvent(
+				`${ viewContext }_setup`,
+				'setup_flow_v3_view_analytics_step'
+			);
+
+			return;
+		}
+
 		trackEvent( 'moduleSetup', 'view_module_setup', moduleSlug );
 	} );
 
@@ -118,11 +139,6 @@ export default function ModuleSetup( { moduleSlug } ) {
 
 	const { SetupComponent } = module;
 
-	const isInitialSetupFlow =
-		setupFlowRefreshEnabled &&
-		moduleSlug === MODULE_SLUG_ANALYTICS_4 &&
-		showProgress === 'true';
-
 	return (
 		<Fragment>
 			<Header
diff --git a/assets/js/components/setup/ModuleSetup.test.js b/assets/js/components/setup/ModuleSetup.test.js
@@ -57,6 +57,7 @@ describe( 'ModuleSetup', () => {
 	} );
 
 	afterEach( () => {
+		mockTrackEvent.mockClear();
 		jest.resetAllMocks();
 	} );
 
@@ -202,6 +203,15 @@ describe( 'ModuleSetup', () => {
 
 				expect( mockTrackEvent ).toHaveBeenCalledTimes( 1 );
 			} );
+
+			it( 'tracks only the initial setup analytics view event', () => {
+				expect( mockTrackEvent ).toHaveBeenCalledWith(
+					`${ VIEW_CONTEXT_MODULE_SETUP }_setup`,
+					'setup_flow_v3_view_analytics_step'
+				);
+
+				expect( mockTrackEvent ).toHaveBeenCalledTimes( 1 );
+			} );
 		} );
 
 		describe( 'not initial setup flow', () => {
@@ -257,6 +267,16 @@ describe( 'ModuleSetup', () => {
 			it( 'should match the snapshot', () => {
 				expect( container ).toMatchSnapshot();
 			} );
+
+			it( 'tracks only the generic module setup view event', () => {
+				expect( mockTrackEvent ).toHaveBeenCalledWith(
+					'moduleSetup',
+					'view_module_setup',
+					MODULE_SLUG_ANALYTICS_4
+				);
+
+				expect( mockTrackEvent ).toHaveBeenCalledTimes( 1 );
+			} );
 		} );
 	} );
 
diff --git a/assets/js/modules/analytics-4/components/common/AccountCreate/index.js b/assets/js/modules/analytics-4/components/common/AccountCreate/index.js
@@ -155,6 +155,7 @@ export default function AccountCreate( { className } ) {
 	}, [ hasAccountCreateForm, siteName, siteURL, timezone, setValues ] );
 
 	const showProgress = getQueryArg( location.href, 'showProgress' );
+	const isInitialSetupFlow = !! showProgress && setupFlowRefreshEnabled;
 
 	const handleSubmit = useCallback( async () => {
 		const scopes = [];
@@ -192,11 +193,19 @@ export default function AccountCreate( { className } ) {
 		}
 
 		setValues( FORM_ACCOUNT_CREATE, { autoSubmit: false } );
-		await trackEvent(
-			`${ viewContext }_analytics`,
-			'create_account',
-			'proxy'
-		);
+
+		if ( isInitialSetupFlow ) {
+			await trackEvent(
+				`${ viewContext }_setup`,
+				'setup_flow_v3_create_analytics_account'
+			);
+		} else {
+			await trackEvent(
+				`${ viewContext }_analytics`,
+				'create_account',
+				'proxy'
+			);
+		}
 
 		const { error } = await createAccount( {
 			showProgress: showProgress === 'true',
@@ -210,10 +219,11 @@ export default function AccountCreate( { className } ) {
 		hasEditScope,
 		hasGTMScope,
 		setValues,
-		viewContext,
+		isInitialSetupFlow,
 		createAccount,
 		showProgress,
 		setPermissionScopeError,
+		viewContext,
 		setConversionTrackingEnabled,
 		saveConversionTrackingSettings,
 	] );
@@ -242,8 +252,6 @@ export default function AccountCreate( { className } ) {
 		return <ProgressBar />;
 	}
 
-	const isInitialSetupFlow = !! showProgress && setupFlowRefreshEnabled;
-
 	return (
 		<div className={ className }>
 			<StoreErrorNotices
diff --git a/assets/js/modules/analytics-4/components/common/AccountCreate/index.test.js b/assets/js/modules/analytics-4/components/common/AccountCreate/index.test.js
@@ -20,6 +20,7 @@
  * Internal dependencies
  */
 import {
+	cleanup,
 	createTestRegistry,
 	fireEvent,
 	muteFetch,
@@ -42,9 +43,14 @@ import { MODULE_SLUG_ANALYTICS_4 } from '@/js/modules/analytics-4/constants';
 import { createCacheKey } from '@/js/googlesitekit/api';
 import { getKeys, setItem } from '@/js/googlesitekit/api/cache';
 import AccountCreate from '.';
+import * as tracking from '@/js/util/tracking';
+import { VIEW_CONTEXT_MODULE_SETUP } from '@/js/googlesitekit/constants';
 import { CORE_SITE } from '@/js/googlesitekit/datastore/site/constants';
 import { MODULE_SLUG_SEARCH_CONSOLE } from '@/js/modules/search-console/constants';
 
+const mockTrackEvent = jest.spyOn( tracking, 'trackEvent' );
+mockTrackEvent.mockImplementation( () => Promise.resolve() );
+
 const REGEX_REST_CONVERSION_TRACKING_SETTINGS = new RegExp(
 	'^/google-site-kit/v1/core/site/data/conversion-tracking'
 );
@@ -312,5 +318,64 @@ describe( 'AccountCreate', () => {
 				REGEX_REST_CONVERSION_TRACKING_SETTINGS
 			);
 		} );
+
+		describe( 'event tracking', () => {
+			beforeEach( () => {
+				mockTrackEvent.mockClear();
+				cleanup();
+			} );
+
+			it( 'should track the `setup_flow_v3_create_analytics_account` event when creating an account during the initial setup flow', async () => {
+				global.location.href =
+					'http://example.com/wp-admin/admin.php?page=googlesitekit-dashboard&slug=analytics-4&reAuth=true&showProgress=true';
+
+				( { getByRole, waitForRegistry, rerender } = render(
+					<AccountCreate />,
+					{
+						registry,
+						viewContext: VIEW_CONTEXT_MODULE_SETUP,
+						features: [ 'setupFlowRefresh' ],
+					}
+				) );
+
+				fireEvent.click(
+					getByRole( 'button', { name: 'Create Account' } )
+				);
+
+				await waitForRegistry();
+
+				expect( mockTrackEvent ).toHaveBeenCalledWith(
+					`${ VIEW_CONTEXT_MODULE_SETUP }_setup`,
+					'setup_flow_v3_create_analytics_account'
+				);
+
+				expect( mockTrackEvent ).toHaveBeenCalledTimes( 1 );
+			} );
+
+			it( 'should track the `create_account` event when creating an account after the initial setup', async () => {
+				global.location.href =
+					'http://example.com/wp-admin/admin.php?page=googlesitekit-dashboard&slug=analytics-4&reAuth=true';
+				( { getByRole, waitForRegistry, rerender } = render(
+					<AccountCreate />,
+					{
+						registry,
+						viewContext: VIEW_CONTEXT_MODULE_SETUP,
+					}
+				) );
+
+				fireEvent.click(
+					getByRole( 'button', { name: 'Create Account' } )
+				);
+
+				await waitForRegistry();
+
+				expect( mockTrackEvent ).toHaveBeenCalledWith(
+					`${ VIEW_CONTEXT_MODULE_SETUP }_analytics`,
+					'create_account',
+					'proxy'
+				);
+				expect( mockTrackEvent ).toHaveBeenCalledTimes( 1 );
+			} );
+		} );
 	} );
 } );
