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

Add/transient to cache backup api calls #41608

Merged
merged 4 commits into from
Feb 7, 2025

Conversation

CodeyGuyDylan
Copy link
Contributor

@CodeyGuyDylan CodeyGuyDylan commented Feb 6, 2025

Proposed changes:

Currently we are making 2 API calls to WPCOM for the backup card (if a backup plan is active) on every page load

  • Cache Backup API calls in My Jetpack to avoid calling them on every page load
  • Cache for 5 minutes if there was an error with their last backup, that way they can check to see if it was fixed if they try troubleshooting it
  • Cache for 1 hour if the previous backup was successful so that, if there is a backup with an error, they'll know about it within an hour if they go to My Jetpack

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

N/A

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

No

Testing instructions:

  1. Checkout this branch via the Jetpack Beta plugin or your local dev environment (local environment is preferred here so you can delete the transient if you need to)
  2. If you go to My Jetpack before the backup has errors, you'll have to delete the transient. You can do this by putting the following line of code above this line
delete_transient( self::BACKUP_STATUS_TRANSIENT_KEY );
  1. Connect your site and user account
  2. Purchase a VaultPress Backup plan for your site
  3. Go to /wp-admin/admin.php?page=jetpack-backup and trigger a backup
  4. Right after doing that, disconnect your site so that the backup will fail
  5. Go to My Jetpack and ensure you see the error
    image
  6. Open up the query monitor and see that a request to /rewind and /rewind/backup were made
    Screenshot 2025-02-06 at 11 22 04 AM
  7. Refresh the page, and ensure those requests were not made again (as long as you didn't wait 5 minutes to refresh)
  8. If you'd like, you can re-trigger the backup to ensure it was successful, wait 5 minutes from the last time you went to My Jetpack and ensure the request is made again, and the error is gone
    image

If you'd like to check the transient values, you can run this locally and add the following line to projects/packages/my-jetpack/src/products/class-backup.php line 249

l( $previous_backup_status );

Copy link
Contributor

github-actions bot commented Feb 6, 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 Feb 6, 2025
Copy link
Contributor

github-actions bot commented Feb 6, 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 add/transient-to-cache-backup-api-calls branch.

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

    bin/jetpack-downloader test jetpack add/transient-to-cache-backup-api-calls
    

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 Feb 6, 2025

Code Coverage Summary

No summary data is avilable for parent commit 4f69df2, cannot calculate coverage changes. 😴

If that commit is a feature branch rather than a trunk commit, this is expected. Otherwise, you might try re-running the Tests / Publish coverage data job on this PR once the corresponding job on the trunk commit has succeeded.

Full summary · PHP report · JS report

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.

  • Cache for 5 minutes if there was an error with their last backup, that way they can check to see if it was fixed if they try troubleshooting it
  • Cache for 1 hour if the previous backup was successful so that, if there is a backup with an error, they'll know about it within an hour if they go to My Jetpack

Ok yes, this ⬆️ seems reasonable. 👍

Tested, works as described. Looks all good, except for an unused and unnecessary variable constant that was left in class-initializer.php that should be removed.
LGTM! 👍

@@ -65,6 +65,7 @@ class Initializer {
const VIDEOPRESS_STATS_KEY = 'my-jetpack-videopress-stats';
const VIDEOPRESS_PERIOD_KEY = 'my-jetpack-videopress-period';
const MY_JETPACK_RED_BUBBLE_TRANSIENT_KEY = 'my-jetpack-red-bubble-transient';
const BACKUP_STATUS_TRANSIENT_KEY = 'my-jetpack-backup-status';
Copy link
Contributor

Choose a reason for hiding this comment

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

This constant is unused in this file. Was it left here in this file unintentionally?
I believe it should be removed. 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ooh nice catch, thanks I'll remove that!

@CodeyGuyDylan CodeyGuyDylan merged commit b7813eb into trunk Feb 7, 2025
76 of 78 checks passed
@CodeyGuyDylan CodeyGuyDylan deleted the add/transient-to-cache-backup-api-calls branch February 7, 2025 16:20
@github-actions github-actions bot removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Feb 7, 2025
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