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 Sync: Add 'jetpack_package_versions' to Sync option whitelist #35409

Merged
merged 5 commits into from
Feb 5, 2024

Conversation

fgiannar
Copy link
Contributor

@fgiannar fgiannar commented Feb 2, 2024

Adds jetpack_package_versions option to Sync options' whitelist.
Note that since this is a Connection dependant option, there is a fallback in place in order to update the option on WPCOM via a REST request, in case Sync is not present or enabled.

Proposed changes

Sync package:

  • Automattic\Jetpack\Sync\Defaults: Add jetpack_package_versions to Sync options whitelist
  • Automattic\Jetpack\Sync\Data_Settings: Add jetpack_package_versions to the minimum set of Sync options required by Sync itself

Connection package:

  • Automattic\Jetpack\Connection\Package_Version_Tracker: Update update_package_versions_option method to only update the jetpack_package_version option on WPCOM via a REST request if Sync is not present or enabled

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?

No

Testing instructions:

D136887-code

@fgiannar fgiannar self-assigned this Feb 2, 2024
@github-actions github-actions bot added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests labels Feb 2, 2024
Copy link
Contributor

github-actions bot commented Feb 2, 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 update/jetpack-package-versions-add-to-sync branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-package-versions-add-to-sync
    

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

Copy link
Contributor

github-actions bot commented Feb 2, 2024

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

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

@fgiannar fgiannar added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Feb 2, 2024
@darssen
Copy link
Contributor

darssen commented Feb 2, 2024

Thanks for working on this @fgiannar.

I reviewed and approved the WPCOM side of it.

I was able to test with the instructions and things worked well for me for my local and a new JN site.

The code in this PR looks also fine as far as I can tell but I'd like someone else more familiar with the connection part to take a look and approve.

Copy link
Contributor

@sergeymitr sergeymitr left a comment

Choose a reason for hiding this comment

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

I tested different scenarios, everything works like a charm 👍
Disabling Sync did make it switch to the endpoint, so the fallback also works great.

@sergeymitr sergeymitr added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Feb 2, 2024
@fgiannar fgiannar added this to the jetpack/13.1 milestone Feb 5, 2024
@fgiannar fgiannar merged commit 65706e8 into trunk Feb 5, 2024
67 of 68 checks passed
@fgiannar fgiannar deleted the update/jetpack-package-versions-add-to-sync branch February 5, 2024 07:02
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Feb 5, 2024
spsiddarthan pushed a commit that referenced this pull request Feb 15, 2024
…#35409)

* Jetpack Sync: Add jetpack_package_versions to Sync options
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Connection [Package] Sync [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants