Dashboard: Prevent console warnings when toggling on some Jetpack settings

coder-karen commented 1 week ago

Fixes https://github.com/Automattic/jetpack/issues/40086

Proposed changes:

isModuleActivated requires a module name, and the way it was being used in order to determine a value for the checked property within ToggleControl, nothing was being passed in. As such, it was returning undefined on any toggle change (I tested with all toggles to confirm). The best option would be to remove it, which is done here.
This helps prevent a console warning when toggling on some Jetpack settings.

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

https://github.com/Automattic/jetpack/issues/40086

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

No.

Testing instructions:

You may need script debug enabled to see the console warnings: define( 'SCRIPT_DEBUG', true ); in wp-config.php.

To replicate the issue:

On a test site, open up the Jetpack Settings page. Not all toggles result in the warning, but the Sharing buttons toggle on the Sharing page does: /wp-admin/admin.php?page=jetpack#/sharing.
Open up the browser console, and enable Sharing buttons via the toggle.
You should see a console warning related to A component is changing an uncontrolled input to be controlled..

To test the fix:

Apply this PR, and follow the same steps as above. There should be no warnings in the browser console.

github-actions[bot] commented 1 week ago

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/jetpack-settings-react-warning branch.

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

bin/jetpack-downloader test jetpack fix/jetpack-settings-react-warning

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[bot] commented 1 week ago

Thank you for your PR!

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

:white_check_mark: Include a description of your PR changes.
:white_check_mark: Add a "[Status]" label (In Progress, Needs Team Review, ...).
:white_check_mark: Add testing instructions.
:white_check_mark: Specify whether this PR includes any changes to data or privacy.
:white_check_mark: 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 :robot:

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:

Ensure all required checks appearing at the bottom of this PR are passing.
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.
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 none scheduled (scheduled code freeze on undefined).

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

Automattic / jetpack