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

Fix/my jetpack red bubble cache #41131

Open
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

jboland88
Copy link
Contributor

Proposed changes:

This diff adds caching around the red-bubble alerts used in My Jetpack.
It also adds a short transient to prevent multiple api calls for checking site features.

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)?

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

No.

Testing instructions:

  • Get a Jetpack test site with the ability to apply this patch (locally or via the beta plugin)
  • Before applying the patch, run your test site on the latest trunk code.
  • Open your WordPress dashboard page. Using the query monitor plugin, observe the HTTP API calls made from PHP when loading the WP dashboard. Notice that there are several API calls originating from the My Jetpack package. Note that the call to the "features" endpoint is repeated several times.
    Screenshot 2025-01-16 at 10 42 43 AM
  • Now, apply this patch, reload the dashboard a page a couple times (they first load will store the transient)
  • Observe again the HTTP requests coming from PHP while on the dashboard. There should be no requests originating from My Jetpack
    Screenshot 2025-01-16 at 10 43 55 AM
  • Now, navigate to My Jetpack by clicking on "Jetpack" in the left-hand menu.
  • Using the query monitor plugin, confirm that the API requests are still running while on the My Jetpack page (this is to collect the most recent data, though ideally, these requests should be moved to be async in this context in a later PR).
    Screenshot 2025-01-16 at 10 44 48 AM
  • Confirm that there are no duplicate requests being made on the My Jetpack page from PHP in the Query Monitor output

Copy link
Contributor

github-actions bot commented Jan 16, 2025

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-red-bubble-cache branch.

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

    bin/jetpack-downloader test jetpack fix/my-jetpack-red-bubble-cache
    

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 Jan 16, 2025

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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!

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 16, 2025
@jboland88 jboland88 added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jan 16, 2025
@github-actions github-actions bot added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Jan 16, 2025
@jboland88 jboland88 added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jan 16, 2025
Copy link
Contributor

@CodeyGuyDylan CodeyGuyDylan left a comment

Choose a reason for hiding this comment

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

When testing without this patch, I don't know why but I couldn't get the repeat features calls to show up for me at all. Or any features call outside of My Jetpack for that matter.

However, I did see the purchases query run outside of My Jetpack, and after adding this patch I no longer saw any so that's a good sign that it's working. LGTM!

// check for stored alerts
$stored_alerts = get_transient( self::MY_JETPACK_RED_BUBBLE_TRANSIENT_KEY );
// Cache bypass for red bubbles should only happen on the My Jetpack page
if ( $stored_alerts !== false && ! ( $bypass_cache ) ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a nitpick but are the parenthesis around $bypass_cache necessary?

Copy link
Contributor

@elliottprogrammer elliottprogrammer left a comment

Choose a reason for hiding this comment

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

Tested, this works great, as described. Thanks for working on this @jboland88!
I believe this is a nice reasonable solution, for now, and as you already stated in the testing instruction, we can improve/iterate upon this in a future PR(s).
LGTM! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] My Jetpack [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants