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

Sitemap: Make sitemap storing more efficient by not querying the full post content before saving #39572

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

Conversation

oskosk
Copy link
Contributor

@oskosk oskosk commented Sep 28, 2024

This update tries to remediate a problem where the persistent object cache gets big with data that we will not use in the end.

We just need to get the id of the current sitemap post and if it exists, we update it.

Before, we were using get_post() and this polluted the cache running into OOM situations

In p9F6qB-g4Y-p2#comment-62552 it's noted that the current behavior is not efficient.

Note: this PR may need a follow-up cause there's further investigation in p9F6qB-g4Y-p2#comment-62583

Proposed changes:

  • Introduced functionget_current_sitemap_post_id()
  • Updates store_sitemap_data() to use get_current_sitemap_post_id().

Jetpack product discussion

p9F6qB-g4Y-p2#comment-62552

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

No

Testing instructions:

  • On a connected site (Launch one with Jurassic Ninja and this branch), confirm the sitemap functionality is enabled under Jetpack → Settings → Traffic.
  • checkout this branch git checkout update/sitemap-store-more-efficiently
  • Navigate to your sitemap (typically at /sitemap.xml), and click the first one.
  • Verify that all current content types (posts, pages, etc.) are correctly listed in the sitemap.

@oskosk oskosk added [Status] In Progress [Focus] Performance [Type] Bug When a feature is broken and / or not performing as intended labels Sep 28, 2024
Copy link
Contributor

github-actions bot commented Sep 28, 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/sitemap-store-more-efficiently branch.

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

    bin/jetpack-downloader test jetpack update/sitemap-store-more-efficiently
    

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 [Feature] Sitemaps [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Sep 28, 2024
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!


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 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.

…ntent when storing the sitemap

This update tries to remediate a problem where the persistent object cache gets huge
with data that we will not use in the end.
We just need to get the id of the current sitemap post and if it exists, we update it.

Before, we were using get_post and this polluted the cache running into OOM situations
@oskosk oskosk changed the title Sitemap: Make sitemap storing more efficient but not querying the full post co… Sitemap: Make sitemap storing more efficient but not querying the full post content when storing the sitemap Sep 28, 2024
@oskosk oskosk changed the title Sitemap: Make sitemap storing more efficient but not querying the full post content when storing the sitemap Sitemap: Make sitemap storing more efficient by not querying the full post content before saving Sep 28, 2024
@oskosk oskosk force-pushed the update/sitemap-store-more-efficiently branch from cc2349f to a98842e Compare September 28, 2024 14:58
@oskosk oskosk added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Type] Bug When a feature is broken and / or not performing as intended labels Sep 28, 2024
@oskosk oskosk self-assigned this Sep 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Sitemaps [Focus] Performance [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] Needs Review To request a review from Crew. Label will be renamed soon.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant