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

My Jetpack: optimize repeated requests for failed WPCOM requests #39218

Merged
merged 2 commits into from
Sep 6, 2024

Conversation

sergeymitr
Copy link
Contributor

@sergeymitr sergeymitr commented Sep 4, 2024

Proposed changes:

My Jetpack will keep sending repeated requests to the same endpoints for each product if:

  • Connection is broken or WPCOM is unavailable
  • and there's no data cached for for those endpoints.

The PR will temporarily store API errors so there wouldn't be repeated API requests during the same PHP execution flow.
That brings down the number of WPCOM requests from about 300 to about a dozen.

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

pdWQjU-Sf-p2

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

No.

Testing instructions:

Don't checkout the branch, but do checkout the trunk (Bleeding Edge) for Jetpack.

You will need a clean site with no cache.
The easiest way to achieve that without waiting for it to expire is to create a new JN site and randomize the tokens instead of properly connecting Jetpack.

  1. Go to "Jetpack Debug", activate "Broken Token".
  2. Go to Broken Token and click "Set invalid blog token", "Set invalid user token (current user)", "Set current user as primary user" and "Randomize blog ID". That will make Jetpack think the site is connected.
  3. Use Jetpack Debug to activate the "WPCOM API Request Tracker".
  4. Visit "Jetpack -> My Jetpack". The page will take some time to load. Check the number of requests in the top right corner, it should be about 300.
  5. Checkout the branch.
  6. Reload My Jetpack. It should load considerably faster, and the tracker should show about 10-15 API requests.
  7. Confirm My Jetpack displays more or less fine, considering that connection is broken.
  8. Disconnect Jetpack, connect again. Check My Jetpack and Jetpack Dashboard, confirm they work fine.

Copy link
Contributor

github-actions bot commented Sep 4, 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 fix/my-jetpack-repeated-requests branch.

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

    bin/jetpack-downloader test jetpack fix/my-jetpack-repeated-requests
    

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 [Package] My Jetpack [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Sep 4, 2024
Copy link
Contributor

github-actions bot commented Sep 4, 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 daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for October 1, 2024 (scheduled code freeze on September 30, 2024).

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

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

This tests well for me - it also removes the logged error that was occurring on trunk with the test instructions (Trying to access array offset on value of type bool in jetpack-my-jetpack/src/class-wpcom-products.php on line 58.).

@sergeymitr sergeymitr merged commit 6256ffb into trunk Sep 6, 2024
76 of 77 checks passed
@sergeymitr sergeymitr deleted the fix/my-jetpack-repeated-requests branch September 6, 2024 12:30
@github-actions github-actions bot added this to the jetpack/13.9 milestone Sep 6, 2024
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Sep 6, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
)

Temporarily store API errors so there wouldn't be repeated API requests.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Focus] Performance [Package] My Jetpack [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