Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: newsletter toggle in editor sidebar has a visually broken active state #41036

Merged
merged 2 commits into from
Jan 16, 2025

Conversation

zaerl
Copy link
Contributor

@zaerl zaerl commented Jan 14, 2025

Fixes Automattic/wp-calypso#97139

The ToggleGroupControl component seems unhappy with a false value set in a ToggleGroupControlOption child component. Despite the value is false (and so the right value), the useAnimatedOffsetRect component does not calculate valid CSS variables used for animation but instead generates a:

--selected-top: 0;
--selected-right: 0;
--selected-bottom: 0;
--selected-left: 0;
--selected-width: 0;
--selected-height: 0;

They should be similar to:

--selected-top: 4;
--selected-right: 4;
--selected-bottom: 4;
--selected-left: 124;
--selected-width: 120;
--selected-height: 32;

Once changed to two strings, it is working. I checked other places where the component is used, and it is working in the same way.

I don't consider this a Gutenberg bug but simply the component that does not accept falsy booleans, and I vote not to open a Gutenberg issue.

Registrazione.schermo.2025-01-14.alle.15.48.12.mov

Proposed changes:

  • Replace true/false values with "post-and-email"/"post-only" strings
  • Change toggleSendEmail and isSendEmailEnabled to accept the new values

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:

  • You need a Jetpack plan with included the newletter
  • If the newsletter is not active, go to /wp-admin/admin.php?page=jetpack#newsletter and switch on "Let visitors subscribe to this site and receive emails when you publish a post"
  • If you don't have active subscribers, go to https://cloud.jetpack.com/subscribers, select the site, and import one of your emails used for testing.

Then you'll need to do two examples.

  • Create a new post, add a title and some content
  • Click "Publish" on top right
  • Make sure that you can click the "Post & email / Post only" component

Submit the post with the selected "Post & email" and be sure to receive an email with the new post. Create another post with "Post only" selected, submit it, and be sure not to receive any email.

Copy link
Contributor

github-actions bot commented Jan 14, 2025

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 fix/broken-newsletter-toggle branch.

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

    bin/jetpack-downloader test jetpack fix/broken-newsletter-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 github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Jan 14, 2025
Copy link
Contributor

github-actions bot commented Jan 14, 2025

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 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 🤖


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.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Jetpack plugin:

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

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for February 4, 2025 (scheduled code freeze on undefined).

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

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 14, 2025
@zaerl zaerl requested review from simison and p-jackson January 14, 2025 15:01
@zaerl zaerl self-assigned this Jan 14, 2025
@p-jackson p-jackson added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Status] Needs Team Review and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Jan 16, 2025
Copy link
Member

@p-jackson p-jackson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -315,7 +315,7 @@ export function NewsletterEmailDocumentSettings() {
const isSendEmailEnabled = useSelect( select => {
const meta = select( editorStore ).getEditedPostAttribute( 'meta' );
// Meta value is negated, "don't send", but toggle is truthy when enabled "send"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure whether this comment is still necessary. Now that the toggle control value is a string, the code is more self-documenting IMO.

@zaerl zaerl merged commit 265b067 into trunk Jan 16, 2025
65 checks passed
@zaerl zaerl deleted the fix/broken-newsletter-toggle branch January 16, 2025 06:53
@github-actions github-actions bot added this to the jetpack/14.3 milestone Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Newsletter toggle in editor sidebar has a visually broken active state
2 participants