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

React Data Sync Client: Add ReactQuery dev tools #41357

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

LiamSarsfield
Copy link
Contributor

@LiamSarsfield LiamSarsfield commented Jan 28, 2025

Proposed changes:

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

N/A

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

No

Testing instructions:

  1. Check out the branch locally, and ensure the Jetpack mono repo has been rebuilt after checking out.
  2. Within Jetpack Boost's Settings page (/wp-admin/admin.php?page=jetpack-boost), there should be a new icon on the bottom right, per attached demo.
Screen.Recording.2025-01-28.at.15.31.24.mov

Copy link
Contributor

github-actions bot commented Jan 28, 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 add/react-data-sync-client/react-query-devtools 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/react-data-sync-client/react-query-devtools
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/react-data-sync-client/react-query-devtools
    

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

@dilirity dilirity added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] In Progress [JS Package] React Data Sync Client labels Jan 28, 2025
@github-actions github-actions bot added the RNA label Jan 28, 2025
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 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!

@LiamSarsfield LiamSarsfield requested a review from a team January 28, 2025 13:48
@LiamSarsfield LiamSarsfield marked this pull request as ready for review January 28, 2025 15:36
@donnchawp donnchawp requested a review from dilirity January 28, 2025 16:16
@haqadn haqadn changed the title Add/react-data-sync-client/react-query-devtools React Data Sync Client: Add ReactQuery dev tools Jan 28, 2025
haqadn
haqadn previously approved these changes Jan 28, 2025
Copy link
Contributor

@haqadn haqadn left a comment

Choose a reason for hiding this comment

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

Thanks for adding this! Tested locally, and it works!

I checked the final directory size to ensure it doesn't increase the bundle. Strangely, it is 6KB lite compared to the trunk branch. So, I am a bit confused. 🤔

This branch Screenshot 2025-01-28 at 5 43 05 PM
Trunk Screenshot 2025-01-28 at 5 43 09 PM

dilirity
dilirity previously approved these changes Jan 29, 2025
Copy link
Member

@dilirity dilirity left a comment

Choose a reason for hiding this comment

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

:shipit:

@LiamSarsfield LiamSarsfield added this to the boost/next milestone Jan 29, 2025
Copy link
Contributor

github-actions bot commented Jan 29, 2025

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

@LiamSarsfield
Copy link
Contributor Author

I checked the final directory size to ensure it doesn't increase the bundle. Strangely, it is 6KB lite compared to the trunk branch. So, I am a bit confused. 🤔

That is indeed strange @haqadn, React Query Dev Tools shouldn't have any impact on the production build assets.
I ran jetpack build plugins/boost --production and the result of du -sk ./projects/plugins/boost/app/assets/dist is the same for both this branch and trunk (after deleting dist and rebuilding).
This branch:
Screenshot 2025-01-29 at 15 16 17
Trunk (as of this comment):
Screenshot 2025-01-29 at 15 17 28

The only theory I can think of is this branch may not have had the latest changes of trunk, where latest changes within trunk may have impacted the overall plugin size from another merged branch.

@LiamSarsfield LiamSarsfield dismissed stale reviews from haqadn and dilirity via 5d6a5d3 January 29, 2025 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[JS Package] React Data Sync Client RNA [Status] In Progress [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants