Boost: Implement Cache Preloading - Version One #41988

LiamSarsfield · 2025-02-24T12:39:40Z

Fixes

#42111

Proposed changes:

Adds a Cache Preloading system for Cornerstone Pages
Introduces a new submodule Cache_Preload.php to handle cache preloading logic (Submodule of Page Cache)
Updates cache invalidation process to trigger preloading for cornerstone pages when they're invalidated
Improves the structure of the invalidate method in File_Storage.php with better action handling

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

pc9hqz-3nV-p2

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

N/A

Testing instructions:

1. Saving Cornerstone Pages list, Clearing Page Cache

Instructions

Before Applying Branch

Go to Boost Settings page.
Ensure Boost Premium is on the WordPress site.
Enable Optimize CSS Loading (Cloud CSS).
Enable Cache Site Pages (Page Cache).
Add at least 2 valid Cornerstone Pages.
Clear Page Cache.
Within the WordPress site, head to ./wp-content/boost-cache/cache/(domain)
Verify that no page caching files are present.
Head to one of the valid Cornerstone Pages added in Incognito.
Verify that page caching is generated for that Cornerstone Page visited.
Clear Page Cache.
Within the WordPress site, head to ./wp-content/boost-cache/cache/(domain)
Verify that no page caching files are present.

After Applying Branch

Go to Boost Settings page.
Add a third valid page to the Cornerstone Pages list
Wait 2 seconds, refresh the page (to ensure Preloading occurs)
Within the WordPress site, head to ./wp-content/boost-cache/cache/(domain)
You should now see that 3 caching files have been generated automagically ✨
Clear the Page Cache
Wait 2 seconds, refresh the page (to ensure Preloading occurs within the Cron)
You should now see that 3 caching files have been generated automagically again ✨

2. Updating Cornerstone Page

Instructions

Before Applying Branch

Go to Boost Settings page.
Ensure Boost Premium is on the WordPress site.
Enable Optimize CSS Loading (Cloud CSS).
Enable Cache Site Pages (Page Cache).
Add at least 2 valid Cornerstone Pages.
Clear Page Cache.
Within the WordPress site, head to ./wp-content/boost-cache/cache/(domain)
Verify that no page caching files are present.
Edit one of the posts/pages you added to the Cornerstone Page list.
Within the WordPress site, head to ./wp-content/boost-cache/cache/(domain)
Verify that the page you edited is not cached.

After Applying Branch

Go to Boost Settings page.
Clear Page Cache.
Edit one of the posts/pages you added to the Cornerstone Page list.
Wait 2 seconds, refresh the post edit page (to ensure Preloading occurs within the Cron).
Within the WordPress site, head to ./wp-content/boost-cache/cache/(domain)
You should now see that specific page's caching file generated automagically ✨

Co-authored-by: Peter Petrov <[email protected]>

github-actions · 2025-02-24T12:40:45Z

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

Ensure all required checks appearing at the bottom of this PR are passing.
Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
You can use GitHub's Reviewers functionality to request a review.
When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

Boost plugin:

No scheduled milestone found for this plugin.

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

jp-launch-control · 2025-02-24T12:44:01Z

Code Coverage Summary

Cannot generate coverage summary while tests are failing. 🤐

Please fix the tests, or re-run the Code coverage job if it was something being flaky.

Full summary · PHP report · JS report

_{Coverage check overridden by

Coverage tests to be added later
Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR
.}

…date mechanism - Refactor preload mechanism to support dynamic post scheduling - Add method to handle post updates and schedule preloading for cornerstone pages - Implement more flexible preload post tracking using WordPress options - Improve error handling during page preloading

- Add new method `is_cornerstone_page_by_url()` in Cornerstone_Utils to check cornerstone pages by URL - Modify `is_cornerstone_page()` to use the new URL-based method - Update Cache_Preload to handle cache invalidation and preloading of cornerstone pages - Add action hook for successful cache invalidation - Improve method names and add comments for clarity

@SInCE

- Enhance `handle_cache_invalidation()` method to support different cache invalidation types - Add support for full cache deletion by preloading all Cornerstone Pages - Improve documentation with detailed comments and @SInCE tags - Update method signature to include invalidation type parameter - Refactor cache preloading logic for more robust handling of cache events

LiamSarsfield · 2025-02-27T17:23:52Z

projects/plugins/boost/app/modules/optimizations/page-cache/Cache_Preload.php

+		// Clear the preload posts so they're not preloaded again.
+		$this->set_posts_to_preload( array() );
+
+		foreach ( $posts as $post ) {


I wonder if we should limit how many pages/posts are being preloaded here within the cron to prevent potentially overloading the site. Theoritically the limit of URLs should only be 10 as that's our current Cornerstone Page limit.
We could only preload 10 URLs at a time, and then schedule another cron job after 2 seconds to repeat the same.
Not sure if it's worth doing now, or wait until Version 2.

I implemented this now with batching, as seen below:

jetpack/projects/plugins/boost/app/modules/optimizations/page-cache/Cache_Preload.php

Lines 145 to 172 in cc070a2

/**

* Prepares the next batch of URLs to preload.

*

* Takes the full list of posts to preload, extracts the first batch,

* updates the preload queue, and schedules the next run if needed.

*

* @since $$next-version$$

* @param array $posts Full list of posts to preload.

* @return array The batch of posts to process now.

*/

private function prepare_next_batch( $posts ) {

// Process in batches of 10 to reduce server load

$batches = array_chunk( $posts, 10 );

$current_batch = array_shift( $batches );

// Calculate remaining posts

$remaining = $this->flatten_batches( $batches );

// Update the preload queue

$this->set_posts_to_preload( $remaining );

// Schedule the next batch if needed

if ( ! empty( $remaining ) ) {

$this->schedule_preload_cronjob();

}

return $current_batch;

}

- Refactor page preloading to process URLs in batches of 10 - Add batch processing to reduce server load and improve reliability - Enhance error handling with detailed logging for preload failures - Improve HTTP response validation during page preloading - Add methods to manage batch processing and track remaining URLs

- Create new test suite for Cache_Preload class in Jetpack Boost - Implement comprehensive test coverage for cache preloading methods - Test scenarios including cornerstone page preloading, cache invalidation, and scheduling - Verify interactions with WordPress core functions and utility classes - Ensure robust testing of preload scheduling, post update handling, and cache management

- Refactor test cases to use direct method calls instead of partial mocks - Replace Mockery-based mocking with explicit WordPress function expectations - Improve test coverage by directly testing Cache_Preload class methods - Simplify test setup and reduce complexity of test assertions - Ensure consistent testing approach for cache preloading functionality

- Enhance page preloading by adding cache-control headers

LiamSarsfield and others added 2 commits February 24, 2025 12:37

Page Cache: Add support for submodules with Cache Preload

e6659c3

Co-authored-by: Peter Petrov <[email protected]>

changelog

d20c076

github-actions bot added [Boost Feature] Page Cache [Plugin] Boost A feature to speed up the site and improve performance. [Status] In Progress labels Feb 24, 2025

github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Feb 24, 2025

dilirity added [Type] Feature Development of a new feature and removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Feb 24, 2025

LiamSarsfield self-assigned this Feb 27, 2025

LiamSarsfield added this to the boost/3.10.0 milestone Feb 27, 2025

Merge branch 'trunk' into add/boost/cache-preloading-cornerstone-pages

3c00b3b

LiamSarsfield marked this pull request as ready for review February 27, 2025 11:32

LiamSarsfield marked this pull request as draft February 27, 2025 11:32

LiamSarsfield changed the title ~~Add/boost/cache-preloading-cornerstone-pages~~ Boost: Implement Cache Preloading - Version One Feb 27, 2025

LiamSarsfield linked an issue Feb 27, 2025 that may be closed by this pull request

Boost: Cache Preloading - Version One, Cornerstone Pages #42111

Open

LiamSarsfield commented Feb 27, 2025

View reviewed changes

LiamSarsfield added 2 commits February 28, 2025 14:39

github-actions bot added the [Tests] Includes Tests label Feb 28, 2025

LiamSarsfield added the Coverage tests to be added later Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR label Feb 28, 2025

Boost: Add Cache-Busting Headers to Page Preload Requests

69e5a40

- Enhance page preloading by adding cache-control headers

LiamSarsfield removed this from the boost/3.10.0 milestone Mar 4, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Boost: Implement Cache Preloading - Version One #41988

Boost: Implement Cache Preloading - Version One #41988

LiamSarsfield commented Feb 24, 2025 •

edited

Loading

github-actions bot commented Feb 24, 2025 •

edited

Loading

jp-launch-control bot commented Feb 24, 2025 •

edited

Loading

LiamSarsfield Feb 27, 2025

LiamSarsfield Feb 28, 2025

	/**
	* Prepares the next batch of URLs to preload.
	*
	* Takes the full list of posts to preload, extracts the first batch,
	* updates the preload queue, and schedules the next run if needed.
	*
	* @since $$next-version$$
	* @param array $posts Full list of posts to preload.
	* @return array The batch of posts to process now.
	*/
	private function prepare_next_batch( $posts ) {
	// Process in batches of 10 to reduce server load
	$batches = array_chunk( $posts, 10 );
	$current_batch = array_shift( $batches );

	// Calculate remaining posts
	$remaining = $this->flatten_batches( $batches );

	// Update the preload queue
	$this->set_posts_to_preload( $remaining );

	// Schedule the next batch if needed
	if ( ! empty( $remaining ) ) {
	$this->schedule_preload_cronjob();
	}

	return $current_batch;
	}

Boost: Implement Cache Preloading - Version One #41988

Are you sure you want to change the base?

Boost: Implement Cache Preloading - Version One #41988

Conversation

LiamSarsfield commented Feb 24, 2025 • edited Loading

Fixes

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

1. Saving Cornerstone Pages list, Clearing Page Cache

Before Applying Branch

After Applying Branch

2. Updating Cornerstone Page

Before Applying Branch

github-actions bot commented Feb 24, 2025 • edited Loading

jp-launch-control bot commented Feb 24, 2025 • edited Loading

Code Coverage Summary

LiamSarsfield Feb 27, 2025

Choose a reason for hiding this comment

LiamSarsfield Feb 28, 2025

Choose a reason for hiding this comment

LiamSarsfield commented Feb 24, 2025 •

edited

Loading

github-actions bot commented Feb 24, 2025 •

edited

Loading

jp-launch-control bot commented Feb 24, 2025 •

edited

Loading