jetpack icon indicating copy to clipboard operation
jetpack copied to clipboard

Jetpack Sync: Switch 'jetpack_connection_active_plugins' to a callable

Open fgiannar opened this issue 1 year ago • 2 comments

Do not merge till the WPCOM counterpart diff is merged: D153988-code

Start syncing jetpack_connection_active_plugins as a callable. This approach will address edge cases where the site option would not pick up the change therefore the corresponding option on WPCOM would end up out-of-sync. Since callables are checked every time we send remote Sync actions to WPCOM, we are expecting that switching to a callable will ensure the option is more aligned. Checkout the linked product discussion below for full context and research.

Proposed changes:

  • Automattic\Jetpack\Sync\Defaults: Add jetpack_connection_active_plugins to callable whitelist and remove from options whitelist
  • Automattic\Jetpack\Sync\Data_Settings: Add jetpack_connection_active_plugins to the callables we always sync, no matter the consumer configuration and remove from the options we always sync.
  • Automattic\Jetpack\Sync\Functions: Introduce get_jetpack_connection_active_plugins method for fetching the active plugins that are using the Jetpack Connection

Other information:

  • [x] Have you written new tests for your changes, if applicable?
  • [x] 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

p9dueE-8gv-p2

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

No

Testing instructions:

Important: make sure to test with the WPCOM counterpart diff applied: D153988-code

We want to test various combinations of standalone Jetpack products and activation/deactivation flows:

  • Jetpack plugin, Backups, Protect, WooCommerce, WooCommerce Payments etc
  • Activate/deactivate various plugins in the list above and ensure the option is up-to-date on WPCOM
  • Make sure to test with a case where the first/last active plugin is WooCommerce (uses only the Jetpack Connection and not Jetpack Sync) and ensure the option is still up-to-date on WPCOM.
  • Test deactivating/activating plugins via cli with/without --skip-plugins. When activating/deactivating using the --skip-plugins option, make sure the callable will get sent to WPCOM with the next batch of Sync actions.

fgiannar avatar Jul 01 '24 11:07 fgiannar

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/sync-make-jetpack_connection_active_plugins-callable 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 update/sync-make-jetpack_connection_active_plugins-callable
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/sync-make-jetpack_connection_active_plugins-callable
    

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] avatar Jul 01 '24 11:07 github-actions[bot]

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.


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.

github-actions[bot] avatar Jul 01 '24 11:07 github-actions[bot]