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

Jetpack settings page: Removing defaultProps from SearchableModules component #38546

Merged
merged 3 commits into from
Jul 26, 2024

Conversation

coder-karen
Copy link
Contributor

@coder-karen coder-karen commented Jul 25, 2024

Fixes #38539

Proposed changes:

  • This PR removes the defaultProps and propTypes from the SearchableModules component, adding defaults to the one property when defining that property.
  • This prevents a console warning - Warning: Connect(SettingsForm): Support for defaultProps will be removed from memo components in a future major release. Use JavaScript default parameters instead - due to the legacy usage of defaultProps.
  • Ultimately the issue was that the SearchableModules component was a function component, despite wrapping a class, so the defaultProps usage was missed on an earlier sweep of function component defaultProps usage.

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

#38539

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

No.

Testing instructions:

To replicate the issue:

  • First make sure you have script debug enabled (define ( 'SCRIPT_DEBUG, 'true'); in wp-config.php)
  • Then, testing locally on trunk or using a Jurassic Ninja site and the Beta tester plugin using bleeding edge Jetpack, visit the settings page - /wp-admin/admin.php?page=jetpack#/settings.
  • You should see the above console error.

To test the fix:

  • Apply this PR, and visit the settings page again. The console warning should be gone. The search function should work as it did before.

@coder-karen coder-karen added [Status] In Progress Admin Page React-powered dashboard under the Jetpack menu labels Jul 25, 2024
@coder-karen coder-karen self-assigned this Jul 25, 2024
Copy link
Contributor

github-actions bot commented Jul 25, 2024

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/defaultprops-connect-settings-form-warnings branch.

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

    bin/jetpack-downloader test jetpack fix/defaultprops-connect-settings-form-warnings
    

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 Jul 25, 2024
Copy link
Contributor

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 August 6, 2024 (scheduled code freeze on August 5, 2024).

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

@coder-karen coder-karen marked this pull request as ready for review July 25, 2024 16:03
@coder-karen coder-karen added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Jul 25, 2024
@coder-karen coder-karen requested a review from a team July 25, 2024 16:27
Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

Looks reasonable.

@coder-karen coder-karen merged commit 4ab6cdb into trunk Jul 26, 2024
59 checks passed
@coder-karen coder-karen deleted the fix/defaultprops-connect-settings-form-warnings branch July 26, 2024 08:44
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jul 26, 2024
@github-actions github-actions bot added this to the jetpack/13.7 milestone Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Page React-powered dashboard under the Jetpack menu [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

React 19 Compatibility: Resolve Connect(SettingsForm) defaultProps warning
2 participants