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

Connection: Unset jetpack conection active plugins from sync callable checksum when sync is not active #39098

Conversation

darssen
Copy link
Contributor

@darssen darssen commented Aug 27, 2024

Fixes https://github.com/Automattic/vulcan/issues/469

Proposed changes:

  • Ensure we unset ``$jetpack_callables_sync_checksum['jetpack_connection_active_plugins'] if the jetpack_connection_active_plugins option gets changed in wpcom via the no sync fallback. This way we ensure that if/when sync gets re-enabled we send the callable no matter.

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/vulcan/issues/469

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

Testing instructions:

Check steps in https://github.com/Automattic/vulcan/issues/469 and check that we get now consistent values.

@darssen darssen added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Package] Sync [Package] Connection labels Aug 27, 2024
@darssen darssen requested a review from a team August 27, 2024 13:54
@darssen darssen self-assigned this Aug 27, 2024
Copy link
Contributor

github-actions bot commented Aug 27, 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/sync-unset-jetpack-conection-active-plugins-callable-checksum-when-fallback-wpcom 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-unset-jetpack-conection-active-plugins-callable-checksum-when-fallback-wpcom
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/sync-unset-jetpack-conection-active-plugins-callable-checksum-when-fallback-wpcom
    

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

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.


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!

@darssen darssen added [Status] In Progress and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Aug 27, 2024
@darssen darssen requested a review from sergeymitr August 27, 2024 18:44
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.

Hi @darssen 👋
The checksum value got removed, and the plugin list got synced as expected 👍

It took a few minutes though for Sync to get it synced, and the site is empty.
Is it likely to increase on huge sites which are constantly syncing something, might it end up in the end of the queue?
Or for example a site that activates Jetpack for the first time, and has a lot to sync.

We could try adding additional check, and run self::update_active_plugins_wpcom_no_sync_fallback() if Sync is active, but jetpack_connection_active_plugins checksum is missing.
That way we'll know that the site underwent the "no-sync -> has-sync" plugin activation, and there's no shame in sending some critical data right away.

projects/packages/connection/src/class-plugin-storage.php Outdated Show resolved Hide resolved
@darssen
Copy link
Contributor Author

darssen commented Aug 28, 2024

It took a few minutes though for Sync to get it synced, and the site is empty.
Is it likely to increase on huge sites which are constantly syncing something, might it end up in the end of the queue?
Or for example a site that activates Jetpack for the first time, and has a lot to sync.

The problem with callable is that they normally are only sent when there is other information that needs to be synced too. So if when testing you just waited for it, it would take a little bit more time. Adding a post right away for example should speed up the process.
Regarding initial sync, Full Sync and Incremental go through different routes.

We could try adding additional check, and run self::update_active_plugins_wpcom_no_sync_fallback() if Sync is active, but jetpack_connection_active_plugins checksum is missing.
That way we'll know that the site underwent the "no-sync -> has-sync" plugin activation, and there's no shame in sending some critical data right away.

Since this is a fallback and the initial issue is a bit of an edge case, unless we observe there is an actual problem with the delay I would keep things as they are.

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.

That all sounds great.
I think we're good to merge it then 👍

@sergeymitr sergeymitr added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] In Progress labels Aug 28, 2024
@darssen darssen merged commit 84631d5 into trunk Aug 28, 2024
74 checks passed
@darssen darssen deleted the update/sync-unset-jetpack-conection-active-plugins-callable-checksum-when-fallback-wpcom branch August 28, 2024 15:16
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Aug 28, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
… checksum when sync is not active (#39098)

* Remove the checksum for active plugins, so it gets recalculated when sync gets activated.

* changelog

* Version bump

* Version bump

* Update projects/packages/connection/src/class-plugin-storage.php

Co-authored-by: Sergey Mitroshin <[email protected]>

---------

Co-authored-by: Sergey Mitroshin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants