Subscriptions: add "Send as email" toggle by simison · Pull Request #34592 · Automattic/jetpack

simison · 2023-12-12T13:25:33Z

Resolves Automattic/wp-calypso#44263
Resolves #10876

Adds "Send as email" toggle:

(FYI Below screenshots are outdated)

Proposed changes:

Adds a toggle to disable email sending post-by-post basis.
Register the meta, and sync the setting to WP.com

The feature pre-existed before Gutenberg, so the backend was already handled in Jetpack.

Previously the toggle was "negated", i.e. checking it to "not send email". Clearer UX is to do something when toggle is enabled, hence the meta and toggle handling seem a bit backwards.

TODO: PR needs some minor work in pre/post-publish panel copies and to check if post was published previously.

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?

Testing instructions:

Create a new post
In post settings, leave toggle enabled and publish the post.
Note pre-publish panel toggle — you can try change it, go back to post panel, etc.
Note copy at pre-publish panel.
Post gets sent as an email
The toggle should be disabled now and in truthy setting (the email was already sent)
Create another post, leave toggle disabled and publish the post
Note copy at pre-publish panel.
No email was sent
The toggle should be disabled now and in falsy setting (no way to send email now that post was published)

github-actions · 2023-12-12T13:26:24Z

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 add/dont-email-to-subs-toggle branch.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack add/dont-email-to-subs-toggle

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 · 2023-12-12T13:26:44Z

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 January 9, 2024 (scheduled code freeze on January 8, 2024).

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

simison · 2023-12-12T13:27:40Z

projects/plugins/jetpack/extensions/shared/memberships/settings.js

This setting felt flaky, so commented it out. If it doesn't work, we can remove for now and add back in separate PR.

jeherve

This works well for me, but I don't know if the wording for that setting is clear enough. At first, I thought the toggle was related to the preview email below:

Maybe there should be a separator between the 2?
Maybe the parts that do not apply anymore get removed when you toggle off the email?

What if instead of a toggle, we had a "none" option as a radio, something like this?

simison · 2023-12-12T17:33:00Z

@jeherve thanks! Yep, we're working still on the wording and structure of the pre-publish and post-publish panels for this 👍 It definitely needs some adjustments.

simison · 2023-12-12T17:35:01Z

What if instead of a toggle, we had a "none" option as a radio, something like this?

That panel controls access, which is somewhat separate from whom we send the emails, albeit very related. I.e. the access also affects how you see blog posts, posts in the Reader, etc. Hence the setting should be separate.

simison · 2023-12-13T09:27:00Z

projects/plugins/jetpack/extensions/blocks/subscriptions/subscriptions.php

Note that this was old meta field I'm re-using for backwards compatibility, but it was never registered like this:

https://github.com/search?q=repo%3AAutomattic%2Fjetpack%20_jetpack_dont_email_post_to_subs&type=code

lezama

Tested and works great and everything makes much more sense than before.

Feel free to keep polishing but Approving in case you want to merge 😄

simison · 2023-12-15T12:51:06Z

projects/plugins/jetpack/extensions/blocks/subscriptions/panel.js

+	const showMisconfigurationWarning = getShowMisconfigurationWarning( postVisibility, accessLevel );

-			{ shouldLoadSubscriptionPlaceholder && (
+	const isSendEmailEnabled = useSelect( select => {


In a follow-up, I'd like this in a re-usable React hook.

simison · 2023-12-15T12:54:06Z

projects/plugins/jetpack/extensions/shared/memberships/settings.js

+				return (
+					<ToggleControl
+						checked={ isSendEmailEnabled }
+						disabled={ isPostPublished || ! canEdit }


In a follow-up we should check if the post was published already previously and set the toggle disabled. Prior art:

jetpack/projects/plugins/jetpack/modules/subscriptions.php

Lines 1047 to 1062 in 2f325ae

/**

* Save a flag when a post was ever published.

*

* It saves the post meta when the post was published and becomes a draft.

* Then this meta is used to hide subscription messaging in Publish panel.

*

* @param string $new_status Tthe "new" post status of the transition when saved.

* @param string $old_status The "old" post status of the transition when saved.

* @param object $post obj The post object.

*/

public function maybe_set_first_published_status( $new_status, $old_status, $post ) {

$was_post_ever_published = get_post_meta( $post->ID, '_jetpack_post_was_ever_published', true );

if ( ! $was_post_ever_published && 'publish' === $old_status && 'draft' === $new_status ) {

update_post_meta( $post->ID, '_jetpack_post_was_ever_published', true );

}

}

jetpack/projects/plugins/jetpack/extensions/blocks/subscriptions/panel.js

Lines 110 to 114 in 2f325ae

// Subscriptions will not be triggered for a post that was already published in the past.

const shouldLoadSubscriptionPlaceholder = useSelect( select => {

const meta = select( editorStore ).getEditedPostAttribute( 'meta' );

return ! isModuleActive && ! isLoadingModules && ! meta?.jetpack_post_was_ever_published;

} );

I tried it briefly but it felt flaky, so better in separate PR.

simison added the [Status] Needs Review This PR is ready for review. label Dec 12, 2023

simison changed the title ~~Add/dont email to subs toggle~~ Subscriptions: add "Send as email" toggle Dec 12, 2023

github-actions bot added [Block] Subscribe [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Dec 12, 2023

simison requested review from jeherve and lezama and removed request for lezama December 12, 2023 13:26

simison commented Dec 12, 2023

View reviewed changes

jeherve reviewed Dec 12, 2023

View reviewed changes

simison added the [Status] In Progress label Dec 12, 2023

lezama force-pushed the add/dont-email-to-subs-toggle branch 2 times, most recently from 58863bb to 79cc12d Compare December 13, 2023 00:15

simison commented Dec 13, 2023

View reviewed changes

simison mentioned this pull request Dec 13, 2023

Subscriptions: add a filter to control email sending for posts #34321

Closed

3 tasks

simison force-pushed the add/dont-email-to-subs-toggle branch from 3e521ed to 042218b Compare December 13, 2023 14:14

lezama mentioned this pull request Dec 15, 2023

Subscriptions: add "Send as email" toggle – REBASED #34658

Closed

3 tasks

lezama force-pushed the add/dont-email-to-subs-toggle branch from f4fb279 to fbaf854 Compare December 15, 2023 00:48

Subscriptions: adds toggle to disable email sending

d43f61f

simison force-pushed the add/dont-email-to-subs-toggle branch from fbaf854 to d43f61f Compare December 15, 2023 09:29

Show correct copy post-publish

e32542f

lezama previously approved these changes Dec 15, 2023

View reviewed changes

Unbold heading access copy in the panel

1000775

simison dismissed lezama’s stale review via 1000775 December 15, 2023 12:45

simison commented Dec 15, 2023

View reviewed changes

simison enabled auto-merge (squash) December 15, 2023 12:57

lezama approved these changes Dec 15, 2023

View reviewed changes

simison merged commit 4c9a552 into trunk Dec 15, 2023

simison deleted the add/dont-email-to-subs-toggle branch December 15, 2023 13:00

github-actions bot removed [Status] Needs Review This PR is ready for review. [Status] In Progress labels Dec 15, 2023

github-actions bot added this to the jetpack/13.0 milestone Dec 15, 2023

jeherve added the [Status] UI Changes Add this to PRs that change the UI so documentation can be updated. label Dec 18, 2023

This was referenced Dec 19, 2023

Subscriptions: disable toggle to send post as email when post was published once in the past #34711

Closed

Newsletter prepublish panel: update toggle appearance #34724

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Subscriptions: add "Send as email" toggle#34592

Subscriptions: add "Send as email" toggle#34592
simison merged 3 commits intotrunkfrom
add/dont-email-to-subs-toggle

simison commented Dec 12, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Dec 12, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Dec 12, 2023

Uh oh!

simison Dec 12, 2023

Uh oh!

jeherve left a comment

Uh oh!

simison commented Dec 12, 2023

Uh oh!

simison commented Dec 12, 2023

Uh oh!

simison Dec 13, 2023

Uh oh!

lezama left a comment

Uh oh!

simison Dec 15, 2023

Uh oh!

simison Dec 15, 2023 •

edited

Loading

Uh oh!

simison Dec 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	/**
	* Save a flag when a post was ever published.
	*
	* It saves the post meta when the post was published and becomes a draft.
	* Then this meta is used to hide subscription messaging in Publish panel.
	*
	* @param string $new_status Tthe "new" post status of the transition when saved.
	* @param string $old_status The "old" post status of the transition when saved.
	* @param object $post obj The post object.
	*/
	public function maybe_set_first_published_status( $new_status, $old_status, $post ) {
	$was_post_ever_published = get_post_meta( $post->ID, '_jetpack_post_was_ever_published', true );
	if ( ! $was_post_ever_published && 'publish' === $old_status && 'draft' === $new_status ) {
	update_post_meta( $post->ID, '_jetpack_post_was_ever_published', true );
	}
	}

	// Subscriptions will not be triggered for a post that was already published in the past.
	const shouldLoadSubscriptionPlaceholder = useSelect( select => {
	const meta = select( editorStore ).getEditedPostAttribute( 'meta' );
	return ! isModuleActive && ! isLoadingModules && ! meta?.jetpack_post_was_ever_published;
	} );

Conversation

simison commented Dec 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

Uh oh!

github-actions bot commented Dec 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 12, 2023

Uh oh!

simison Dec 12, 2023

Choose a reason for hiding this comment

Uh oh!

jeherve left a comment

Choose a reason for hiding this comment

Uh oh!

simison commented Dec 12, 2023

Uh oh!

simison commented Dec 12, 2023

Uh oh!

simison Dec 13, 2023

Choose a reason for hiding this comment

Uh oh!

lezama left a comment

Choose a reason for hiding this comment

Uh oh!

simison Dec 15, 2023

Choose a reason for hiding this comment

Uh oh!

simison Dec 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

simison Dec 19, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

simison commented Dec 12, 2023 •

edited

Loading

github-actions bot commented Dec 12, 2023 •

edited

Loading

simison Dec 15, 2023 •

edited

Loading