Logged-in Performance Profiler:Add additional track events #95636

vykes-mac · 2024-10-24T00:45:46Z

Related to https://github.com/Automattic/dotcom-forge/issues/9065

Proposed Changes

This relates to this comment pdKhl6-4fl-p2#comment-7548

Add additional track events

Why are these changes being made?

To add more points of analytics

Testing Instructions

In your console run localStorage.setItem( 'debug', 'calypso:analytics*' );
Verify the track events are being fired for both logged-in and logged-out versions

Pre-merge Checklist

Has the general commit checklist been followed? (PCYsg-hS-p2)
Have you written new tests for your changes?
Have you tested the feature in Simple (P9HQHe-k8-p2), Atomic (P9HQHe-jW-p2), and self-hosted Jetpack sites (PCYsg-g6b-p2)?
Have you checked for TypeScript, React or other console errors?
Have you used memoizing on expensive computations? More info in Memoizing with create-selector and Using memoizing selectors and Our Approach to Data
Have we added the "[Status] String Freeze" label as soon as any new strings were ready for translation (p4TIVU-5Jq-p2)?
For changes affecting Jetpack: Have we added the "[Status] Needs Privacy Updates" label if this pull request changes what data or activity we track or use (p4TIVU-aUh-p2)?

github-actions · 2024-10-24T00:46:01Z

Calypso Live (direct link)

	https://calypso.live?image=registry.a8c.com/calypso/app:build-122723

Jetpack Cloud live (direct link)

	https://calypso.live?image=registry.a8c.com/calypso/app:build-122723&env=jetpack

Automattic for Agencies live (direct link)

	https://calypso.live?image=registry.a8c.com/calypso/app:build-122723&env=a8c-for-agencies

matticbot · 2024-10-24T00:51:16Z

Here is how your PR affects size of JS and CSS bundles shipped to the user's browser:

Sections (~192 bytes added 📈 [gzipped])

name                  parsed_size           gzip_size
site-performance           +820 B  (+0.0%)     +192 B  (+0.0%)
performance-profiler       +490 B  (+0.1%)     +115 B  (+0.1%)

Sections contain code specific for a given set of routes. Is downloaded and parsed only when a particular route is navigated to.

Legend

What is parsed and gzip size?

Parsed Size: Uncompressed size of the JS and CSS files. This much code needs to be parsed and stored in memory.
Gzip Size: Compressed size of the JS and CSS files. This much data needs to be downloaded over network.

Generated by performance advisor bot at iscalypsofastyet.com.

matticbot · 2024-10-24T00:55:34Z

This PR modifies the release build for the following Calypso Apps:

For info about this notification, see here: PCYsg-OT6-p2

notifications
wpcom-block-editor

To test WordPress.com changes, run install-plugin.sh $pluginSlug add/additional_tracks on your sandbox.

p-jackson · 2024-10-24T04:50:04Z

client/performance-profiler/utils/profiler-version.ts

@@ -0,0 +1,2 @@
+export const profilerVersion = () =>
+	window.location.pathname.includes( '/sites/performance/' ) ? 'logged-in' : 'logged-out';


If we ever changed the the page URLs and forgot to update this function we wouldn't want to inadvertently record data that looks correct but is actually bogus. It ruin all the stats up till the point we discovered the issue. Same thing for if we ever added this component to a whole other page.

I think it's better not to assume that there's only two possible profiler versions.

Suggested change

window.location.pathname.includes( '/sites/performance/' ) ? 'logged-in' : 'logged-out';

if ( window.location.pathname.includes( '/sites/performance/' ) ) {

return 'logged-in';

} else if ( window.location.pathname.includes( '/speed-test-tool' ) ) {

return 'logged-out';

}

return 'unknown';

That is true, best to be exhaustive with the expected options here.

p-jackson · 2024-10-24T04:54:44Z

client/performance-profiler/components/status-section/index.tsx

@@ -39,6 +41,12 @@ export const StatusSection = ( props: StatusSectionProps ) => {
 		good: translate( 'Excellent' ),
 	}[ status ];

+	const recordRecommendationsClickEvent = ( filter = 'all' ) =>


Maybe this is just a personal preference thing, but a required function argument feels better here. The function caller knows best which filter is active when it's clicked.

Suggested change

const recordRecommendationsClickEvent = ( filter = 'all' ) =>

const recordRecommendationsClickEvent = ( filter: string ) =>

p-jackson · 2024-10-24T05:25:47Z

client/hosting/performance/site-performance.tsx

@@ -300,7 +302,9 @@ export const SitePerformance = () => {
 			disabled={ disableControls }
 			onChange={ ( page_id ) => {
 				const url = new URL( window.location.href );
-
+				recordTracksEvent( 'calypso_performance_profiler_page_selector_change', {
+					page: pages.find( ( page ) => page.value === page_id )?.label ?? '/',


How useful is it to record the page title? It's not really aggregatable data.
I feel like a is_home event prop would make more sense than the raw page title which we can't really do anything with in the tracks tool.

And I think we should add the version prop here too.

I was recording the page_id at first but that didn't seem to be useful either.

vykes-mac added 4 commits October 23, 2024 18:02

add page selector track events

5170797

add track events to core webvitals recommendations link

c56fedc

add version flag to insight track events

762b3e2

add track events for launch site and prepare launch CTA

5026432

adjust event names

a70266f

vykes-mac self-assigned this Oct 24, 2024

vykes-mac added Logged-in Performance Profiler i1 Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change. labels Oct 24, 2024

vykes-mac requested a review from a team October 24, 2024 00:48

matticbot added the [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. label Oct 24, 2024

vykes-mac requested review from p-jackson and WBerredo October 24, 2024 00:48

p-jackson reviewed Oct 24, 2024

View reviewed changes

vykes-mac added 2 commits October 24, 2024 14:36

make profiler version exhaustive for available options

70a341d

add profiler version to selector change event

87e1ba1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Logged-in Performance Profiler:Add additional track events #95636

Logged-in Performance Profiler:Add additional track events #95636

vykes-mac commented Oct 24, 2024

github-actions bot commented Oct 24, 2024 •

edited by matticbot

Loading

matticbot commented Oct 24, 2024 •

edited

Loading

matticbot commented Oct 24, 2024

p-jackson Oct 24, 2024

vykes-mac Oct 24, 2024

p-jackson Oct 24, 2024

p-jackson Oct 24, 2024

p-jackson Oct 24, 2024

vykes-mac Oct 24, 2024

		@@ -0,0 +1,2 @@
		export const profilerVersion = () =>
		window.location.pathname.includes( '/sites/performance/' ) ? 'logged-in' : 'logged-out';

-	window.location.pathname.includes( '/sites/performance/' ) ? 'logged-in' : 'logged-out';
+	if ( window.location.pathname.includes( '/sites/performance/' ) ) {
+		return 'logged-in';
+	} else if ( window.location.pathname.includes( '/speed-test-tool' ) ) {
+		return 'logged-out';
+	}
+	return 'unknown';

	const recordRecommendationsClickEvent = ( filter = 'all' ) =>
	const recordRecommendationsClickEvent = ( filter: string ) =>

Logged-in Performance Profiler:Add additional track events #95636

Are you sure you want to change the base?

Logged-in Performance Profiler:Add additional track events #95636

Conversation

vykes-mac commented Oct 24, 2024

Proposed Changes

Why are these changes being made?

Testing Instructions

Pre-merge Checklist

github-actions bot commented Oct 24, 2024 • edited by matticbot Loading

matticbot commented Oct 24, 2024 • edited Loading

matticbot commented Oct 24, 2024

p-jackson Oct 24, 2024

Choose a reason for hiding this comment

vykes-mac Oct 24, 2024

Choose a reason for hiding this comment

p-jackson Oct 24, 2024

Choose a reason for hiding this comment

p-jackson Oct 24, 2024

Choose a reason for hiding this comment

p-jackson Oct 24, 2024

Choose a reason for hiding this comment

vykes-mac Oct 24, 2024

Choose a reason for hiding this comment

github-actions bot commented Oct 24, 2024 •

edited by matticbot

Loading

matticbot commented Oct 24, 2024 •

edited

Loading