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: Move 'jetpack_plugins_updated' action to shutdown #39717

Merged

Conversation

fgiannar
Copy link
Contributor

@fgiannar fgiannar commented Oct 10, 2024

Moves the jetpack_plugins_updated action to shutdown to decrease its associated lag.

As of the latest WordPress core release, 6.6.1 we noticed a notable increase in Sync’s queue lag (90p). Further analysis revealed that the jetpack_plugins_updated action was the one contributing to this increase.
More specifically, this change in core introduced an extra step in plugin auto-updates, making it now possible to roll back a plugin auto-update with a fatal error.
However, the check itself for a Fatal error will perform a loopback request in order to scrape the home page.
The jetpack_plugins_updated is triggered by the upgrader_process_complete action.
Sync lag is defined as the time between adding an action to Sync's queue and sending that action to WPCOM.
In this case, since the auto-update is triggered via cron, the Sync lag for the jetpack_plugins_updated action is essentially the time between firing the upgrader_process_complete action and the shutdown action.
With core introducing the aforementioned loopback request on auto-updates Sync's lag for the jetpack_plugins_updated action was significantly increased.
And this also affected the 90p of our overall Sync Lag KPI.

In this PR, we attempt to fix this issue by simply moving jetpack_plugins_updated action to shutdown to decrease its associated lag.

Noting that we also attempted to fix this in the past via #39296

Proposed changes:

  • Automattic\Jetpack\Sync\Modules\Plugins: Move jetpack_plugins_updated action to shutdown. To make this possible we introduced two extra private class properties: state and updated_plugins in order to store the data associated with this action.

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

pf5801-17n-p2

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

No

Testing instructions:

Pre-requisites: A JP connected site with the WP Rollback and WP Crontrol plugins active. You'll need to enable sandbox access and input your sandbox domain in Settings -> Jetpack Constants -> JETPACK__SANDBOX_DOMAIN

  • Rollback a plugin to a previous version via the WP Rollback plugin
  • For the same plugin that you rolled back make sure to enable auto-updates
  • To speed things up go Tools->Cron Events and trigger the wp_version_check hook (Triggers plugin auto-updates, normally runs twice per day)
  • Monitor the action in your sandbox and ensure the corresponding arguments are exactly the same on trunk/feature branch
  • Confirm the Sync lag of the jetpack_plugins_updated action on the feature branch is much smaller.
  • Repeat the process for more than one plugins (by rolling back and enabling auto-updates) and confirm the same
  • Finally, manually update a few plugins and confirm that the behaviour is the same as with trunk

Test assuming WP_Automatic_Updater detected an error and is doing a plugin roll-back:
In order to test this locally I modified WP_Automatic_Updater to return true in has_fatal_error here.
In this case, without the branch we'd see two jetpack_plugins_updated actions, both exactly the same.
With the PR, we'll see only one.

Copy link
Contributor

github-actions bot commented Oct 10, 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.


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!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for November 5, 2024 (scheduled code freeze on November 4, 2024).

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

Copy link
Contributor

github-actions bot commented Oct 10, 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-sync-delay-jetpack_plugins_updated-hook 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/jetpack-sync-delay-jetpack_plugins_updated-hook
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/jetpack-sync-delay-jetpack_plugins_updated-hook
    

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 [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests labels Oct 10, 2024
@fgiannar fgiannar requested a review from a team October 10, 2024 09:36
@fgiannar fgiannar requested a review from darssen October 10, 2024 09:36
coder-karen
coder-karen previously approved these changes Oct 10, 2024
Copy link
Contributor

@coder-karen coder-karen left a comment

Choose a reason for hiding this comment

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

Followed the testing instructions and saw the expected behaviour. Nice work with the tests too.

darssen
darssen previously approved these changes Oct 10, 2024
Copy link
Contributor

@darssen darssen 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 working on this one. Tests well for me as described. 🚢

Co-authored-by: Karen Attfield <karenlattfield@gmail.com>
@fgiannar fgiannar dismissed stale reviews from darssen and coder-karen via 0b2f8bf October 11, 2024 04:56
@fgiannar fgiannar merged commit eabf17c into trunk Oct 11, 2024
73 checks passed
@fgiannar fgiannar deleted the update/jetpack-sync-delay-jetpack_plugins_updated-hook branch October 11, 2024 05:39
@github-actions github-actions bot added this to the jetpack/14.0 milestone Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[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