Add error handling for onboarding form #42753

CodeyGuyDylan · 2025-03-27T20:21:59Z

Resolves MARTECH-17

Proposed changes:

Rework loading states to be synced between email and social button components
Add ErrorMessage component for both Social buttons and email input to use separately
Handle all possible known errors to show contextual errors when they occur
Hide the Jetpack login button as we will not have support ready for that in this release

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

P2: p1HpG7-wiG-p2

Does this pull request change what data or activity we track or use?

No

Testing instructions:

To test the error states, it's easier to test this on your local environment

Checkout this branch locally
Go to /wp-admin/admin.php?page=my-jetpack#/onboarding
Try typing [email protected] in the email input box and submitting the form. You should see an error for an invalid email
Make sure you can edit the email and that the error goes away once you do (until you submit an invalid email again)
Also make sure that the social buttons are still clickable when the email validation error is active
Now, go to projects/packages/my-jetpack/_inc/hooks/use-oauth-connection/index.ts line 93 and insert the following code above the site registration function

throw new Error( 'test' );

Try to submit an email or click any of the social buttons and ensure that it does not work and throws the relevant error
Lastly, go to projects/packages/connection/src/class-rest-connector.php line 1155 and insert the following code

return new WP_Error(
	'test_error',
	'This is a test error',
	array( 'status' => 400 )
);

Try to submit the form and and ensure that the error after the API fails makes sense for each service

github-actions · 2025-03-27T20:22:55Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack), and enable the add/error-handling-for-onboarding-form branch.
To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack add/error-handling-for-onboarding-form

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

github-actions · 2025-03-27T20:22:57Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
🔴 Add a "[Status]" label (In Progress, Needs Review, ...).
🔴 Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
You can use GitHub's Reviewers functionality to request a review.
When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

jp-launch-control · 2025-03-27T20:43:46Z

Code Coverage Summary

Coverage changed in 5 files.

File	Coverage	Δ%	Δ Uncovered
projects/packages/my-jetpack/_inc/hooks/use-oauth-connection/index.ts	0/56 (0.00%)	0.00%	23 💔
projects/packages/my-jetpack/_inc/components/onboarding-screen/connection-form/connection-form.tsx	0/26 (0.00%)	0.00%	17 💔
projects/packages/my-jetpack/_inc/utils/side-load-tracks.ts	0/18 (0.00%)	0.00%	2 ❤️‍🩹
projects/packages/my-jetpack/_inc/components/onboarding-screen/connection-form/email-input.tsx	0/20 (0.00%)	0.00%	-1 💚
projects/packages/my-jetpack/_inc/components/onboarding-screen/connection-form/social-button.tsx	0/15 (0.00%)	0.00%	-2 💚

1 file is newly checked for coverage.

File	Coverage
projects/packages/my-jetpack/_inc/components/onboarding-screen/connection-form/error-message.tsx	0/10 (0.00%) 💔

Full summary · PHP report · JS report

_{Coverage check overridden by

Coverage tests to be added later
Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR
.}

elliottprogrammer

Tested and all works great, just as described!

I did however run into one case that was missed by the react code, and therefore the browser form validation appeared in it's place -See screenshot:

I think maybe we should either cover this case, or disable browser auto-validation.

Other than that, just a couple small nit-picks down in the code comments.

elliottprogrammer · 2025-03-27T22:32:53Z

...ects/packages/my-jetpack/_inc/components/onboarding-screen/connection-form/error-message.tsx

+		return null;
+	}
+
+	const getMessage = () => {


This function will cause this component to always re-render, regardless whether the content changes or not. We can wrap it with a useCallback hook to prevent this.
However, I'm not sure how much it necessarily matters in this case, but it may be safe just to wrap it in useCallback anyway. 🤷‍♂️

elliottprogrammer · 2025-03-27T22:36:03Z

...cts/packages/my-jetpack/_inc/components/onboarding-screen/connection-form/styles.module.scss

@@ -154,8 +147,19 @@
 	}
 }

+.error-message {
+	color: var(--jp-red-50, #d63638);
+	font-size: 14px;


Should we use var( --font-body-small ); here, in place of 14px?

elliottprogrammer · 2025-03-27T22:37:37Z

...cts/packages/my-jetpack/_inc/components/onboarding-screen/connection-form/styles.module.scss

+.error-message {
+	color: var(--jp-red-50, #d63638);
+	font-size: 14px;
+	line-height: 20px;


This could maybe be var( ----font-title-small );

elliottprogrammer

Nice! Works awesome!
LGTM! 👍

* Add tracks after site connection during onboarding flow * Sideload tracks in the onboarding flow after site connection * Reload the recordEvent function if isSiteConnected changes * Override site connection value on event * Fix typo

elliottprogrammer

LGTM! 👍

github-actions bot added [Package] My Jetpack [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Mar 27, 2025

elliottprogrammer reviewed Mar 27, 2025

View reviewed changes

elliottprogrammer previously approved these changes Mar 27, 2025

View reviewed changes

CodeyGuyDylan dismissed elliottprogrammer’s stale review via 329c2b1 March 27, 2025 23:05

CodeyGuyDylan added 7 commits March 27, 2025 18:23

Add error handling to onboarding form

2c6b7d5

changelog

5d0e684

Remove Jetpack app login option

5ac8534

Adjust name of regular email login service

4473c13

Remove unused ref

b97fc98

Handle nitpicks

1ccc58e

Add/tracks for onboarding flow (#42755)

ad8d7c4

* Add tracks after site connection during onboarding flow * Sideload tracks in the onboarding flow after site connection * Reload the recordEvent function if isSiteConnected changes * Override site connection value on event * Fix typo

CodeyGuyDylan force-pushed the add/error-handling-for-onboarding-form branch from 329c2b1 to ad8d7c4 Compare March 27, 2025 23:23

CodeyGuyDylan requested a review from elliottprogrammer March 27, 2025 23:30

elliottprogrammer approved these changes Mar 27, 2025

View reviewed changes

CodeyGuyDylan added Coverage tests to be added later Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR [Action] PR Is Up To Date and removed [Action] PR Is Up To Date labels Mar 27, 2025

grzegorz-cp merged commit 4e1769f into trunk Mar 28, 2025
86 checks passed

grzegorz-cp deleted the add/error-handling-for-onboarding-form branch March 28, 2025 13:59

github-actions bot removed the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Mar 28, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add error handling for onboarding form #42753

Add error handling for onboarding form #42753

CodeyGuyDylan commented Mar 27, 2025 •

edited

Loading

github-actions bot commented Mar 27, 2025 •

edited

Loading

github-actions bot commented Mar 27, 2025

jp-launch-control bot commented Mar 27, 2025 •

edited

Loading

elliottprogrammer left a comment

elliottprogrammer Mar 27, 2025

elliottprogrammer Mar 27, 2025

elliottprogrammer Mar 27, 2025

elliottprogrammer left a comment

elliottprogrammer left a comment

Add error handling for onboarding form #42753

Add error handling for onboarding form #42753

Conversation

CodeyGuyDylan commented Mar 27, 2025 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

github-actions bot commented Mar 27, 2025 • edited Loading

github-actions bot commented Mar 27, 2025

jp-launch-control bot commented Mar 27, 2025 • edited Loading

Code Coverage Summary

elliottprogrammer left a comment

Choose a reason for hiding this comment

elliottprogrammer Mar 27, 2025

Choose a reason for hiding this comment

elliottprogrammer Mar 27, 2025

Choose a reason for hiding this comment

elliottprogrammer Mar 27, 2025

Choose a reason for hiding this comment

elliottprogrammer left a comment

Choose a reason for hiding this comment

elliottprogrammer left a comment

Choose a reason for hiding this comment

CodeyGuyDylan commented Mar 27, 2025 •

edited

Loading

github-actions bot commented Mar 27, 2025 •

edited

Loading

jp-launch-control bot commented Mar 27, 2025 •

edited

Loading