User invitation: Mail the newly added user with WPCom invite #35234

renancarvalho · 2024-01-24T20:46:29Z

Fixes Automattic/wp-calypso#86737 and Automattic/wp-calypso#86738
This is part of the pdDR7T-1ja-p2

Proposed changes:

Currently, when adding a new user to a site via wp-admin, it only creates the user in the site context (locally) therefore these users a not mapped as WPCom users.
This PR:

improves it by intercepting the core email functionality and sending an invitation to the user via email. Once accepted, the user will not only be a local user but a WPCom user.
It informs the site owner that the invite will be sent.

Testing instructions:

Pull this branch
Sync the changes with your atomic site sync jetpack rsync
Navigate to your atomic site {YOUR_SITE}/wp-admin/user-new.php
You should see this message informing about the email invitation

- When adding a new user, the user should get an email invite

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

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

github-actions · 2024-01-24T20:47:16Z

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 WordPress.com Simple 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, and enable the improve_invite_form branch.
To test on Simple, run the following command on your sandbox:
```
bin/jetpack-downloader test jetpack improve_invite_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 · 2024-01-24T20:47:29Z

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 Team Review, ...).
✅ 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 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen daily.
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for February 6, 2024 (scheduled code freeze on February 5, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

projects/plugins/jetpack/modules/sso.php

alshakero

Pretty clean! We just have to handle errors very gracefully.

projects/plugins/jetpack/modules/sso.php

alshakero · 2024-01-25T11:58:45Z

projects/plugins/jetpack/modules/sso.php

+		Client::wpcom_json_api_request_as_user(
+			$url,
+			'2', // Api version
+			array(
+				'method' => 'POST',
+			),
+			array(
+				'invitees' => array(
+					array(
+						'email_or_username' => $email,
+						'role'              => $role,
+					),
+				),
+			)
+		);
+		// returning false prevents the user to be notified by the core email.
+		return false;


We should investigate some error handling. We may want to block adding a user unless the invite works because otherwise the user won't be able to log in any way.

projects/plugins/jetpack/modules/sso.php

escapemanuele · 2024-01-25T14:24:07Z

@crisbusquets, visually the only change here is the banner before the button.

We need to inform the site owner that, when creating the user, an invitation to join WPcom will be sent. Do you have any idea regarding copy or design? 😄

crisbusquets · 2024-01-26T13:10:22Z

@crisbusquets, visually the only change here is the banner before the button.

We need to inform the site owner that, when creating the user, an invitation to join WPcom will be sent. Do you have any idea regarding copy or design? 😄

The alert is fine: it's blue = informative.

Is it possible to place the alert at the top (above the first form input)? Can we make it the same width as the content?
About the copy, what about: New users will receive an invite to join WordPress.com.

If we can't place the alert at the top, This user will receive an invite to join WordPress.com

Do we have a Support Page where we can explain why they'll receive an invite?

renancarvalho · 2024-01-26T14:26:59Z

@crisbusquets, visually the only change here is the banner before the button.
We need to inform the site owner that, when creating the user, an invitation to join WPcom will be sent. Do you have any idea regarding copy or design? 😄

The alert is fine: it's blue = informative.

Is it possible to place the alert at the top (above the first form input)? Can we make it the same width as the content? About the copy, what about: New users will receive an invite to join WordPress.com.

If we can't place the alert at the top, This user will receive an invite to join WordPress.com

Do we have a Support Page where we can explain why they'll receive an invite?

Addressed @crisbusquets 🙇

alshakero · 2024-01-26T14:41:57Z

Do we have a Support Page where we can explain why they'll receive an invite?

Not exactly, but we have a general article here. Maybe we can make the message more encouraging like

"This user will receive an invitation to join WordPress.com, and they will be able to log in using Secure Sign On".

crisbusquets · 2024-01-26T14:47:12Z

Not exactly, but we have a general article here. Maybe we can make a message more encouraging like

"This user will receive an invitation to join WordPress.com, and they will be able to log in using Secure Sign On".

Got it!

What about this? To reinforce the security part:
New users will receive an invite to join WordPress.com, so they can log in securely using [Secure Sign On].

alshakero

This looks terrific now. Besides the notice width (should be limited to 550px), this looks great to me.

alshakero

Very close. Left a few comments.

alshakero · 2024-01-26T21:22:21Z

projects/plugins/jetpack/modules/sso.php

+		wp_enqueue_style( 'jetpack-sso-admin-create-user', plugins_url( 'modules/sso/jetpack-sso-admin-create-user.css', JETPACK__PLUGIN_FILE ), array(), time() );
+
+		wp_admin_notice(
+			__( 'New users will receive an invite to join WordPress.com, so they can log in securely using [Secure Sign On].', 'jetpack' ),


Secure Sign On should be a link to SSO.

Ahh, I misunderstood that, added the link 👍

alshakero · 2024-01-26T21:23:24Z

projects/plugins/jetpack/modules/sso.php

@@ -55,6 +55,12 @@ private function __construct() {
 		add_action( 'jetpack_site_before_disconnected', array( static::class, 'disconnect' ) );
 		add_action( 'wp_login', array( 'Jetpack_SSO', 'clear_cookies_after_login' ) );

+		// If the user has no errors on creation, send an invite to WordPress.com.
+		add_filter( 'user_profile_update_errors', array( $this, 'send_wpcom_mail_user_invite' ), 10, 3 );
+		// Don't send core invitation email when adding a new user via the admin.


Suggested change

// Don't send core invitation email when adding a new user via the admin.

// Don't send core invitation email when SSO is activated. They will get an email from WP.com.

alshakero · 2024-01-26T21:25:50Z

projects/plugins/jetpack/modules/sso/jetpack-sso-admin-create-user.css

+/* Select the second-to-last tr in the table */
+#createuser .form-table tr:nth-last-child(2) {
+	display: none;
+}


I would do this and change the code comment, currently the comment just compiles the code to the reader, it should explain the reasoning.

Suggested change

/* Select the second-to-last tr in the table */

#createuser .form-table tr:nth-last-child(2) {

display: none;

}

/* Hide the checkbox to send WP core invitation emails when SSO is on */

#createuser .form-table tr:has( #send_user_notification ) {

display: none;

}

escapemanuele · 2024-01-29T10:45:42Z

projects/plugins/jetpack/modules/sso.php

+		$message = sprintf(
+			'%s<a class="%s" rel="noopener noreferrer" target="_blank" href="%s">%s</a>',
+			__( 'New users will receive an invite to join WordPress.com, so they can log in securely using', 'jetpack' ),
+			'jetpack-sso-admin-create-user-invite-message-link-sso',
+			esc_url( 'https://jetpack.com/support/sso/' ),
+			__( 'Secure Sign On.', 'jetpack' )
+		);


This is working great, a few notes:

Let's use %1$s, %2$s, %3$s instead, to have more clarity.

After that let's add the * translators: %1$s is the message, %2$2 is ....

escapemanuele

Works great, what an improvement! LGTM

alshakero · 2024-01-29T13:38:01Z

projects/plugins/jetpack/modules/sso.php

+			__( 'New users will receive an invite to join WordPress.com, so they can log in securely using %s', 'jetpack' ),
+			sprintf(
+				'<a class="jetpack-sso-admin-create-user-invite-message-link-sso" rel="noopener noreferrer" target="_blank" href="%s">%s</a>',
+				'https://jetpack.com/support/sso/',
+				__( 'Secure Sign On.', 'jetpack' )
+			)


Sadly, this is still incorrect.

And there is no variables here at all, you can remove sprintf and put everything inside one call of __().

renancarvalho added 3 commits January 24, 2024 21:42

Initial implementation of email invitation

b4ad76f

Initial implementation of email invitation

468a62e

changelog

c2c9d1e

github-actions bot added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Jan 24, 2024

Finishing api call

0afde6d

renancarvalho self-assigned this Jan 25, 2024

Update improve_invite_form

9e805f2

renancarvalho changed the title ~~User invitation: Mail the newly added user~~ User invitation: Mail the newly added user with WPCom invite Jan 25, 2024

renancarvalho commented Jan 25, 2024

View reviewed changes

projects/plugins/jetpack/modules/sso.php Outdated Show resolved Hide resolved

Update changelog

871b50d

renancarvalho marked this pull request as ready for review January 25, 2024 10:55

alshakero requested changes Jan 25, 2024

View reviewed changes

alshakero reviewed Jan 25, 2024

View reviewed changes

projects/plugins/jetpack/modules/sso.php Outdated Show resolved Hide resolved

escapemanuele requested a review from crisbusquets January 25, 2024 14:24

renancarvalho added 2 commits January 26, 2024 13:45

Improve user role param

7174dcf

Handle errors

c4891d3

Use notice to render message

a3a82ff

renancarvalho changed the base branch from trunk to add/sso-improvements January 26, 2024 14:46

alshakero approved these changes Jan 26, 2024

View reviewed changes

Add admin create user stylesheets

a0b248d

github-actions bot added the [Feature] SSO label Jan 26, 2024

Merge branch 'add/sso-improvements' into improve_invite_form

8ec6cab

alshakero requested changes Jan 26, 2024

View reviewed changes

renancarvalho added 3 commits January 27, 2024 09:25

Hide unnecessary TR

f08d7f4

Add link to sso page

4bd8644

Fix translation

1c3e8bc

escapemanuele reviewed Jan 29, 2024

View reviewed changes

escapemanuele self-requested a review January 29, 2024 10:56

escapemanuele approved these changes Jan 29, 2024

View reviewed changes

renancarvalho merged commit b1b8a02 into add/sso-improvements Jan 29, 2024
50 checks passed

renancarvalho deleted the improve_invite_form branch January 29, 2024 11:11

github-actions bot removed the [Status] In Progress label Jan 29, 2024

alshakero reviewed Jan 29, 2024

View reviewed changes

alshakero mentioned this pull request Feb 5, 2024

SSO improvements main PR #35277

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User invitation: Mail the newly added user with WPCom invite #35234

User invitation: Mail the newly added user with WPCom invite #35234

renancarvalho commented Jan 24, 2024 •

edited by escapemanuele

Loading

github-actions bot commented Jan 24, 2024 •

edited

Loading

github-actions bot commented Jan 24, 2024

alshakero left a comment

alshakero Jan 25, 2024

escapemanuele commented Jan 25, 2024

crisbusquets commented Jan 26, 2024

renancarvalho commented Jan 26, 2024

alshakero commented Jan 26, 2024 •

edited

Loading

crisbusquets commented Jan 26, 2024

alshakero left a comment

alshakero left a comment

alshakero Jan 26, 2024 •

edited

Loading

renancarvalho Jan 27, 2024

alshakero Jan 26, 2024

alshakero Jan 26, 2024 •

edited

Loading

escapemanuele Jan 29, 2024

escapemanuele left a comment

alshakero Jan 29, 2024 •

edited

Loading

	// Don't send core invitation email when adding a new user via the admin.
	// Don't send core invitation email when SSO is activated. They will get an email from WP.com.

User invitation: Mail the newly added user with WPCom invite #35234

User invitation: Mail the newly added user with WPCom invite #35234

Conversation

renancarvalho commented Jan 24, 2024 • edited by escapemanuele Loading

Proposed changes:

Testing instructions:

Other information:

Jetpack product discussion

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

github-actions bot commented Jan 24, 2024 • edited Loading

github-actions bot commented Jan 24, 2024

alshakero left a comment

Choose a reason for hiding this comment

alshakero Jan 25, 2024

Choose a reason for hiding this comment

escapemanuele commented Jan 25, 2024

crisbusquets commented Jan 26, 2024

renancarvalho commented Jan 26, 2024

alshakero commented Jan 26, 2024 • edited Loading

crisbusquets commented Jan 26, 2024

alshakero left a comment

Choose a reason for hiding this comment

alshakero left a comment

Choose a reason for hiding this comment

alshakero Jan 26, 2024 • edited Loading

Choose a reason for hiding this comment

renancarvalho Jan 27, 2024

Choose a reason for hiding this comment

alshakero Jan 26, 2024

Choose a reason for hiding this comment

alshakero Jan 26, 2024 • edited Loading

Choose a reason for hiding this comment

escapemanuele Jan 29, 2024

Choose a reason for hiding this comment

escapemanuele left a comment

Choose a reason for hiding this comment

alshakero Jan 29, 2024 • edited Loading

Choose a reason for hiding this comment

renancarvalho commented Jan 24, 2024 •

edited by escapemanuele

Loading

github-actions bot commented Jan 24, 2024 •

edited

Loading

alshakero commented Jan 26, 2024 •

edited

Loading

alshakero Jan 26, 2024 •

edited

Loading

alshakero Jan 26, 2024 •

edited

Loading

alshakero Jan 29, 2024 •

edited

Loading