Add performance tracks to onboarding flow #8042

louwie17 · 2021-12-16T20:02:30Z

This adds one extra onboarding track for the business details free extensions step to add info about installation time.
Also adding one extra prop for the product types step as we sometime install WC Pay there.

Screenshots

cc @pmcpinto & @becdetat I added a new track storeprofiler_store_business_features_installed_and_activated for the install time props, see the example above. Does this look ok, or would you prefer to tag it on to one of the existing tracks. I decided on a new track mostly to keep thinks semi clean and allowing for easy removal if we decide we don't want it anymore.

Detailed test instructions:

Start a fresh site and enable the console log for tracks -> localStorage.setItem( 'debug', 'wc-admin:*' );
Walk through the onboarding flow and make sure you select all or some of the free extensions
Once that step is finished it should show a new track called -> storeprofiler_store_business_features_installed_and_activated
This should include the install time for each selected plugin, install time is put in several time slots 0-2sec, 3-5sec, etc...
Now delete the installed plugins and enable this plugin (which causes Jetpack or Google Listings and Ads to fail)
Go through the onboarding again, making sure to have Jetpack or Google Listings and Ads selected
Notice how the step fails now and the track is still triggered, this time with success set to false and a failed_extensions list.

pmcpinto · 2021-12-17T11:46:32Z

cc @pmcpinto & @becdetat I added a new track storeprofiler_store_business_features_installed_and_activated for the install time props, see the example above. Does this look ok, or would you prefer to tag it on to one of the existing tracks. I decided on a new track mostly to keep thinks semi clean and allowing for easy removal if we decide we don't want it anymore.

Adding a new track sounds good to me. When do you plan to release this? WC 6.0?

louwie17 · 2021-12-17T12:21:50Z

Adding a new track sounds good to me. When do you plan to release this? WC 6.0?

This would be part of 6.2 I believe, as it would be in WCA 3.1, given we already cut the RC version of 3.0.

joshuatf

Great work, @louwie17! Left a couple minor comments, but nothing really blocking depending on your thoughts on them.

joshuatf · 2021-12-20T21:19:44Z

client/profile-wizard/steps/business-details/flows/selective-bundle/index.js

@@ -59,27 +59,81 @@ export const filterBusinessExtensions = ( extensionInstallationOptions ) => {
 	);
 };

+const timeBoxes = [


Timebox is an interesting name. Not super opinionated on this, but maybe timeFrames?

Done here: 8ca96a0

joshuatf · 2021-12-20T21:20:27Z

client/profile-wizard/steps/business-details/flows/selective-bundle/index.js

+	{ name: '10-15s', max: 15 },
+	{ name: '>15s' },
+];
+function getTimebox( timeInMs ) {


A couple quick tests around this would be really awesome.

Good point, I added them here: 8ca96a0

Could optionally also rename to getTimeFrame to keep these consisten.

joshuatf · 2021-12-20T21:22:14Z

client/profile-wizard/steps/business-details/flows/selective-bundle/index.js

+	const key =
+		fieldKey === 'woocommerce-payments'
+			? 'wcpay'
+			: `${ fieldKey.replace( /-/g, '_' ) }`.split( ':', 1 )[ 0 ];


We're doing this enough that it may warrant a shared util or some sanitization on the backend even before hitting components, but not a blocker for this PR.

Done here, thanks for the suggestion: cbf184d

joshuatf · 2021-12-20T21:23:07Z

src/API/Plugins.php

+			$upgrader                = new \Plugin_Upgrader( new \Automatic_Upgrader_Skin() );
+			$result                  = $upgrader->install( $api->download_link );
+			$results[ $plugin ]      = $result;
+			$install_time[ $plugin ] = round( ( microtime( true ) - $start_time ) * 1000 );


louwie17 · 2021-12-21T19:02:40Z

@joshuatf thanks for the review, I updated this PR with your feedback, it should be ready for a re-review.

joshuatf

Hey @louwie17- thanks for the changes!

Had a couple more thoughts on this that I left below.

joshuatf · 2021-12-27T19:56:38Z

client/profile-wizard/steps/business-details/test/index.js

@@ -45,7 +46,7 @@ describe( 'BusinessDetails', () => {
 				jetpack: false,
 				'google-listings-and-ads': true,
 				'mailchimp-for-woocommerce': false,
-				'woocommerce-payments': true,
+				'woocommerce-payments:us': true,


Good thinking 👍

joshuatf · 2021-12-27T19:57:39Z

client/profile-wizard/steps/business-details/flows/selective-bundle/index.js

+	{ name: '10-15s', max: 15 },
+	{ name: '>15s' },
+];
+function getTimebox( timeInMs ) {


Could optionally also rename to getTimeFrame to keep these consisten.

joshuatf · 2021-12-27T19:58:48Z

client/utils/plugins.ts

@@ -0,0 +1,12 @@
+export function getPluginSlug( id: string ): string {


Very nice sharing this as utils!

I think it would be great to handle this entirely server-side at some point, but this is a great short-term solution.

joshuatf · 2021-12-27T20:10:04Z

client/profile-wizard/steps/business-details/flows/selective-bundle/index.js

+	for ( let [ fieldKey ] of Object.entries( extensionInstallationOptions ) ) {
+		fieldKey = getPluginSlug( fieldKey );
+		const key = getPluginTrackKey( fieldKey );
+		if (


I believe this condition is not passing for me. I'm not getting installation data or times in the latest version.

@joshuatf is this because these plugins were already installed and just needed to be activated?
This condition is triggered for me, when an installation is required (this does depend on changes in the data package, so maybe that didn't get updated?)

That was with plugins completely removed. I can try again later today and rebuild all packages to see if that makes a difference.

joshuatf · 2021-12-27T20:10:55Z

client/profile-wizard/steps/business-details/flows/selective-bundle/index.js

+	{ name: '2-5s', max: 5 },
+	{ name: '5-10s', max: 10 },
+	{ name: '10-15s', max: 15 },
+	{ name: '>15s' },


Sorry for not mentioning this earlier, but I wonder if these timeframes should be stretched out a bit. I think 99% of first-time installers are going to be in the 15s+ range. cc @pmcpinto @becdetat

I added several more time frames all the way up to >60s, I would be quite concerned if we hit the >60s often (I could even stop at >30s)

joshuatf · 2021-12-27T20:12:20Z

client/profile-wizard/steps/business-details/flows/selective-bundle/index.js

+						);
+
+						recordEvent(
+							'storeprofiler_store_business_features_installed_and_activated',


Just noting that Google and WCPay will always be listed here with the current logic, even when they are already installed/activated. Not sure if that will be misleading with the data since the timeframes will be shorter.

I updated the logic, so we don't call the install and activate hook when all the selected extensions are already activated and installed. This will prevent the above scenario. The changes for this are here: 6e47c4c

louwie17 · 2022-01-10T18:34:32Z

@joshuatf this will be ready for a re-review whenever you have time, or of-course anyone else on @woocommerce/mothra .

joshuatf

Thanks for the changes, @louwie17!

This looks good and is testing well in my environments. Most seemed to come in between 20-40s so i think the timeframes are adequate coverage.

…min#8042) * Add payment_setup track for WooCommerce Payments * Add timing props to tracks in onboarding when installing extensions * Update extension key logic * Add changelog * Add tests for extension installation data for tracks * Add util function for plugin slug parsing * Only install and activate plugins that are not already active

probot-autolabeler bot added the Packages label Dec 16, 2021

github-actions bot added needs changelog entry and removed needs changelog entry labels Dec 16, 2021

louwie17 added the status: needs review label Dec 16, 2021

louwie17 requested a review from a team December 17, 2021 12:59

joshuatf reviewed Dec 20, 2021

View reviewed changes

joshuatf added needs: author feedback The issue/PR needs a response from any of the parties involved in the issue. and removed status: needs review labels Dec 20, 2021

louwie17 force-pushed the add/7919_performance_tracks branch from 355843c to cbf184d Compare December 21, 2021 18:54

louwie17 added status: needs review and removed needs: author feedback The issue/PR needs a response from any of the parties involved in the issue. labels Dec 21, 2021

joshuatf reviewed Dec 27, 2021

View reviewed changes

joshuatf added needs: author feedback The issue/PR needs a response from any of the parties involved in the issue. and removed status: needs review labels Dec 27, 2021

louwie17 force-pushed the add/7919_performance_tracks branch from cbf184d to 6e47c4c Compare January 10, 2022 18:29

louwie17 added status: needs review and removed needs: author feedback The issue/PR needs a response from any of the parties involved in the issue. labels Jan 10, 2022

Add payment_setup track for WooCommerce Payments

9692e00

joshuatf approved these changes Jan 11, 2022

View reviewed changes

joshuatf added status: ready to merge and removed status: needs review labels Jan 11, 2022

louwie17 added 5 commits January 24, 2022 11:42

Merge branch 'main' of https://github.com/woocommerce/woocommerce-admin

050ebed

Add timing props to tracks in onboarding when installing extensions

4158006

Update extension key logic

c130ed2

Add changelog

352602e

Add tests for extension installation data for tracks

5707b28

louwie17 added 2 commits January 24, 2022 11:45

Add util function for plugin slug parsing

e786022

Only install and activate plugins that are not already active

3b6b370

louwie17 force-pushed the add/7919_performance_tracks branch from 6e47c4c to 3b6b370 Compare January 24, 2022 15:46

louwie17 merged commit 1d0a3cd into main Jan 24, 2022

louwie17 deleted the add/7919_performance_tracks branch January 24, 2022 16:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add performance tracks to onboarding flow #8042

Add performance tracks to onboarding flow #8042

louwie17 commented Dec 16, 2021 •

edited

Loading

pmcpinto commented Dec 17, 2021

louwie17 commented Dec 17, 2021

joshuatf left a comment

joshuatf Dec 20, 2021

louwie17 Dec 21, 2021

joshuatf Dec 20, 2021

louwie17 Dec 21, 2021

joshuatf Dec 27, 2021

joshuatf Dec 20, 2021

louwie17 Dec 21, 2021

joshuatf Dec 20, 2021

louwie17 commented Dec 21, 2021

joshuatf left a comment

joshuatf Dec 27, 2021

joshuatf Dec 27, 2021

joshuatf Dec 27, 2021

joshuatf Dec 27, 2021

louwie17 Jan 6, 2022

joshuatf Jan 6, 2022

joshuatf Dec 27, 2021

louwie17 Jan 10, 2022

joshuatf Dec 27, 2021

louwie17 Jan 10, 2022

louwie17 commented Jan 10, 2022

joshuatf left a comment

		@@ -0,0 +1,12 @@
		export function getPluginSlug( id: string ): string {

Add performance tracks to onboarding flow #8042

Add performance tracks to onboarding flow #8042

Conversation

louwie17 commented Dec 16, 2021 • edited Loading

Screenshots

Detailed test instructions:

pmcpinto commented Dec 17, 2021

louwie17 commented Dec 17, 2021

joshuatf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

louwie17 commented Dec 21, 2021

joshuatf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

louwie17 commented Jan 10, 2022

joshuatf left a comment

Choose a reason for hiding this comment

louwie17 commented Dec 16, 2021 •

edited

Loading