Newsletter: Add "From" name customization #37362

enejb · 2024-05-13T21:32:24Z

Fixes #37354

Proposed changes:

This PR adds the Jetpack side of the reply to name fields. Which will let users define what the newsletters name is set to by default this setting is set to the blog name or WordPress .com if the blogname is not set.

New setting when
Default state

my site is called Enej Dev jetpack.

After typing in some content before save.

Related .com PR D148558-code

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:

load this branch
Visit /wp-admin/admin.php?page=jetpack&enable-newsletter-from-name=true#/newsletter on your jetpack site.
Save the option. (Notice that without enable-newsletter-from-name=true query parameter "feature" flag the option is not available.
Notice that saving works and the option is still there as expected when you refresh the page.

github-actions · 2024-05-13T21:33:12Z

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/newsletter-reply-name branch.
- For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

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

bin/jetpack-downloader test jetpack add/newsletter-reply-name

bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/newsletter-reply-name

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-05-13T21:33:22Z

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 June 4, 2024 (scheduled code freeze on June 3, 2024).

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

simison · 2024-05-14T08:13:17Z

This PR adds the Jetpack side of the reply to name fields.

This should be From name:

simison · 2024-05-14T08:15:58Z

@crisbusquets thoughts on having the site's actual name (i.e. the default value for From) in the input:

as input's greyed out placeholder, or
as actual value in the input, but not save it in the database if it matches the site name. If site name gets changed elsewhere, the value also gets changed until they write something custom in the input.

crisbusquets · 2024-05-14T08:28:30Z

@crisbusquets thoughts on having the site's actual name (i.e. the default value for From) in the input:

as input's greyed out placeholder, or

as actual value in the input, but not save it in the database if it matches the site name. If site name gets changed elsewhere, the value also gets changed until they write something custom in the input.

I like it. This way users will know "where the name comes from".

simison · 2024-05-14T08:31:49Z

Yes but we'd need to pick one or the other way, or combined both. :-) Placeholder is at least good to have because empty should default to site name.

enejb · 2024-05-14T17:25:00Z

I like the idea of using the placeholder idea. Will implemnt that and see how that works.

jeherve · 2024-05-15T06:55:48Z

projects/plugins/jetpack/_inc/client/newsletter/email-settings.jsx

+const urlParams = new URLSearchParams( window.location.search );
+const isNewsletterReplyToNameEnabled = urlParams.get( 'enable-newsletter-sender-name' ) === 'true';
+
+const { blogname } = window?.JP_CONNECTION_INITIAL_STATE ? window.JP_CONNECTION_INITIAL_STATE : {};


Instead of relying on the Connection initial state, it may be best to rely on the Jetpack Dashboard initial state, defined here:

jetpack/projects/plugins/jetpack/_inc/lib/admin-pages/class-jetpack-redux-state-helper.php

Line 50 in 8debc85

public static function get_initial_state() {

You'll find that the blogname option is already available there:

jetpack/projects/plugins/jetpack/_inc/lib/admin-pages/class-jetpack-redux-state-helper.php

Line 157 in 8debc85

'siteTitle' => (string) htmlspecialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),

It's available for you to use via this reducer:

jetpack/projects/plugins/jetpack/_inc/client/state/initial-state/reducer.js

Lines 73 to 75 in d4b22e8

export function getSiteTitle( state ) {

return get( state.jetpack.initialState, 'siteTitle', '' );

}

Relying on that will save you from having to make any changes to the Connection package this time around.

crisbusquets · 2024-05-15T07:11:56Z

Here's the Figma:

34772-pb/

simison · 2024-05-15T07:38:11Z

Would adding some copy or example line help people understand this is the "name" part, so that they won't start entering emails here? The line would update with the value in the input.

Might be non-issue too.

crisbusquets · 2024-05-15T07:42:54Z

Would adding some copy or example line help people understand this is the "name" part, so that they won't start entering emails here? The line would update with the value in the input.
Might be non-issue too.

I like the idea, but would we be able to dynamically update it if they later change the 'reply-to' email?

simison · 2024-05-15T08:05:00Z

would we be able to dynamically update it if they later change the 'reply-to' email?

Yep! I think the help-line should update as you type.

enejb · 2024-05-15T20:27:46Z

This is what I have at the moment. And the value changes as you update the from name and the reply to.

projects/plugins/jetpack/_inc/client/newsletter/email-settings.jsx

projects/plugins/jetpack/_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php

lezama · 2024-05-22T19:44:04Z

projects/plugins/jetpack/json-endpoints/class.wpcom-json-api-site-settings-endpoint.php

@@ -1038,6 +1038,11 @@ function ( &$value ) {
 					update_option( 'jetpack_subscriptions_reply_to', (string) $to_set_value );
 					$updated[ $key ] = (bool) $value;
 					break;
+				case 'jetpack_subscriptions_from_name':
+					$to_set_value = sanitize_text_field( $value );


wondering if sanitizing on saving could return a weird output then when sanitizing on output

…bscriptions_reply_to_name

enejb added the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label May 13, 2024

enejb requested a review from a team May 13, 2024 21:32

enejb self-assigned this May 13, 2024

github-actions bot added [Feature] WPCOM API [Package] Sync [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests Admin Page React-powered dashboard under the Jetpack menu labels May 13, 2024

enejb force-pushed the add/newsletter-reply-name branch from 2056014 to 5ff3a51 Compare May 13, 2024 21:36

enejb added this to the jetpack/13.5 milestone May 13, 2024

enejb changed the title ~~Newsletter: Add reply to name~~ Newsletter: Add "From" name customization May 14, 2024

github-actions bot added the [Package] Connection label May 14, 2024

jeherve added [Status] In Progress and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels May 15, 2024

jeherve reviewed May 15, 2024

View reviewed changes

simison reviewed May 16, 2024

View reviewed changes

projects/plugins/jetpack/_inc/client/newsletter/email-settings.jsx Outdated Show resolved Hide resolved

simison reviewed May 16, 2024

View reviewed changes

projects/plugins/jetpack/_inc/client/newsletter/email-settings.jsx Outdated Show resolved Hide resolved

simison reviewed May 16, 2024

View reviewed changes

projects/plugins/jetpack/_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php Show resolved Hide resolved

enejb force-pushed the add/newsletter-reply-name branch from cfdaf22 to 5034f51 Compare May 21, 2024 23:18

lezama reviewed May 22, 2024

View reviewed changes

lezama previously approved these changes May 22, 2024

View reviewed changes

enejb enabled auto-merge (squash) May 22, 2024 19:48

enejb added 12 commits May 22, 2024 13:15

Add jetpack_subscriptions_reply_to_name to endpoints and sync

ff289ce

Add Reply to Name to Newsletter settings admin

aff6770

Add feature flag

4201d72

changelog

5be3ae5

Update to use jetpack_subscriptions_sender_name instead of jetpack_su…

9ac72a9

…bscriptions_reply_to_name

Update the JS side.

1ca5ef2

Fix small screen wrapping

aa11038

changelog

eb01bfc

Rename ReplyToName to FromName

40ad183

Undo change to connection package.

1a66635

Add example below the form name

94c8516

Fix typo and use sprintf

61dd6a4

enejb force-pushed the add/newsletter-reply-name branch from 5034f51 to 61dd6a4 Compare May 22, 2024 20:16

Fix typo

316fa40

enejb dismissed lezama’s stale review via 316fa40 May 22, 2024 20:24

fix version

0075a0c

lezama approved these changes May 22, 2024

View reviewed changes

enejb merged commit ebd793c into trunk May 22, 2024
73 of 74 checks passed

enejb deleted the add/newsletter-reply-name branch May 22, 2024 22:13

github-actions bot removed the [Status] In Progress label May 22, 2024

This was referenced May 23, 2024

Subscription emails: custom "from" name — release by removing feature flag #37502

Merged

Add: Add sender from name newsletter setting Automattic/wp-calypso#91216

Merged

crisbusquets mentioned this pull request May 30, 2024

Newsletter: visual bug on "Form" name input #37641

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Newsletter: Add "From" name customization #37362

Newsletter: Add "From" name customization #37362

enejb commented May 13, 2024 •

edited

Loading

github-actions bot commented May 13, 2024 •

edited

Loading

github-actions bot commented May 13, 2024

simison commented May 14, 2024

simison commented May 14, 2024 •

edited

Loading

crisbusquets commented May 14, 2024

simison commented May 14, 2024 •

edited

Loading

enejb commented May 14, 2024

jeherve May 15, 2024

crisbusquets commented May 15, 2024 •

edited

Loading

simison commented May 15, 2024 •

edited

Loading

crisbusquets commented May 15, 2024

simison commented May 15, 2024

enejb commented May 15, 2024

lezama May 22, 2024

	export function getSiteTitle( state ) {
	return get( state.jetpack.initialState, 'siteTitle', '' );
	}

Newsletter: Add "From" name customization #37362

Newsletter: Add "From" name customization #37362

Conversation

enejb commented May 13, 2024 • 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 May 13, 2024 • edited Loading

github-actions bot commented May 13, 2024

simison commented May 14, 2024

simison commented May 14, 2024 • edited Loading

crisbusquets commented May 14, 2024

simison commented May 14, 2024 • edited Loading

enejb commented May 14, 2024

jeherve May 15, 2024

Choose a reason for hiding this comment

crisbusquets commented May 15, 2024 • edited Loading

simison commented May 15, 2024 • edited Loading

crisbusquets commented May 15, 2024

simison commented May 15, 2024

enejb commented May 15, 2024

lezama May 22, 2024

Choose a reason for hiding this comment

enejb commented May 13, 2024 •

edited

Loading

github-actions bot commented May 13, 2024 •

edited

Loading

simison commented May 14, 2024 •

edited

Loading

simison commented May 14, 2024 •

edited

Loading

crisbusquets commented May 15, 2024 •

edited

Loading

simison commented May 15, 2024 •

edited

Loading