Closes #6278: Do not add URLs to the wpr_rocket_cache table if Preloa…

…d is disabled (#6305) Co-authored-by: Rémy Perona <[email protected]>
wp-media · Mar 15, 2024 · 0a13971 · 0a13971
1 parent eb98fec
commit 0a13971
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 4 deletions.
diff --git a/inc/Engine/Preload/Subscriber.php b/inc/Engine/Preload/Subscriber.php
@@ -190,6 +190,10 @@ public function update_cache_row() {
 			return;
 		}
 
+		if ( (bool) ! $this->options->get( 'manual_preload', true ) ) {
+			return; // Bail out if preload is disabled.
+		}
+
 		$url = home_url( add_query_arg( [], $wp->request ) );
 
 		$detected = $this->mobile_detect->isMobile() && ! $this->mobile_detect->isTablet() ? 'mobile' : 'desktop';
@@ -239,6 +243,10 @@ public function delete_url_on_not_found() {
 	public function on_permalink_changed() {
 		$this->query->remove_all();
 		$this->queue->cancel_pending_jobs();
+		if ( ! $this->options->get( 'manual_preload', false ) ) {
+			return;
+		}
+
 		$this->queue->add_job_preload_job_load_initial_sitemap_async();
 	}
 
@@ -273,7 +281,9 @@ public function on_deactivation() {
 	 * @return void
 	 */
 	public function clean_url( string $url ) {
-
+		if ( ! $this->options->get( 'manual_preload', 0 ) ) {
+			return;
+		}
 		$this->clear_cache->partial_clean( [ $url ] );
 	}
 
@@ -297,6 +307,10 @@ public function clean_full_cache() {
 	 * @return void
 	 */
 	public function clean_partial_cache( $object, array $urls, $lang ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.objectFound
+		if ( ! $this->options->get( 'manual_preload', false ) ) {
+			return;
+		}
+
 		// Add Homepage URL to $purge_urls for preload.
 		$urls[] = get_rocket_i18n_home_url( $lang );
 
@@ -311,6 +325,9 @@ public function clean_partial_cache( $object, array $urls, $lang ) { // phpcs:ig
 	 * @return void
 	 */
 	public function clean_urls( array $urls ) {
+		if ( ! $this->options->get( 'manual_preload', 0 ) ) {
+			return;
+		}
 
 		$this->clear_cache->partial_clean( $urls );
 	}
@@ -466,7 +483,6 @@ public function add_preload_excluded_uri( $regexes ): array {
 	 * @return void
 	 */
 	public function remove_private_post( string $new_status, string $old_status, $post ) {
-
 		if ( $new_status === $old_status ) {
 			return;
 		}

diff --git a/tests/Fixtures/inc/Engine/Preload/Subscriber/updateCacheRow.php b/tests/Fixtures/inc/Engine/Preload/Subscriber/updateCacheRow.php
@@ -3,6 +3,7 @@
 	'testCallActionWhenPreloaded' => [
 		'config' => [
 			'regexes' => [],
+			'manual_preload' => true,
 			'links' => [
 				[
 					'url' => 'http://example.org',
@@ -25,6 +26,7 @@
 	'testNoCallActionWhenNotPreloaded' => [
 		'config' => [
 			'regexes' => [],
+			'manual_preload' => true,
 			'links' => [
 				[
 					'url' => 'http://example.org',
@@ -49,6 +51,7 @@
 			'regexes' => [
 				'(.*)example.org(.*)'
 			],
+			'manual_preload' => true,
 			'links' => [
 				[
 					'url' => 'http://example.org',
@@ -66,5 +69,23 @@
 				],
 			]
 		]
-	]
+	],
+	'testShouldBailOutWHenPreloadDisabled' => [
+		'config' => [
+			'regexes' => [],
+			'manual_preload' => false,
+			'links' => [
+			],
+			'is_preloaded' => false,
+		],
+		'expected' => [
+			'url' => 'http://example.org',
+			'exists' => false,
+			'links' => [
+				[
+					'url' => 'http://example.org',
+				],
+			],
+		],
+	],
 ];
diff --git a/tests/Integration/inc/Engine/Preload/Subscriber/updateCacheRow.php b/tests/Integration/inc/Engine/Preload/Subscriber/updateCacheRow.php
@@ -22,6 +22,7 @@ public function set_up()
 	{
 		parent::set_up();
 		add_filter('rocket_preload_exclude_urls', [$this, 'excluded']);
+		add_filter('pre_get_rocket_option_manual_preload', [$this, 'manual_preload']);
 	}
 
 	public static function tear_down_after_class()
@@ -33,6 +34,7 @@ public static function tear_down_after_class()
 	public function tear_down()
 	{
 		remove_filter('rocket_preload_exclude_urls', [$this, 'excluded']);
+		remove_filter('pre_get_rocket_option_manual_preload', [$this, 'rucss']);
 		parent::tear_down();
 	}
 
@@ -48,6 +50,7 @@ public function testShouldDoAsExpected($config, $expected) {
 
 		do_action('rocket_after_process_buffer');
 
+
 		if($config['is_preloaded']) {
 			$this->assertGreaterThan( 0, did_action('rocket_preload_completed') );
 		}
@@ -64,4 +67,8 @@ public function providerTestData() {
 	public function excluded($regexes): array {
 		return array_merge($regexes, $this->config['regexes']);
 	}
+
+	public function manual_preload() {
+		return $this->config['manual_preload'];
+	}
 }
diff --git a/tests/Integration/inc/ThirdParty/Plugins/Smush/isSmushIframesLazyloadActive.php b/tests/Integration/inc/ThirdParty/Plugins/Smush/isSmushIframesLazyloadActive.php
@@ -7,6 +7,7 @@
  * @group ThirdParty
  * @group Smush
  * @group WithSmush
+ * @requires PHP >= 7.4
  */
 class Test_IsSmushIframesLazyloadActive extends SmushSubscriberTestCase {
 	/**

diff --git a/tests/Integration/inc/ThirdParty/Plugins/Smush/isSmushLazyloadActive.php b/tests/Integration/inc/ThirdParty/Plugins/Smush/isSmushLazyloadActive.php
@@ -7,6 +7,7 @@
  * @group ThirdParty
  * @group Smush
  * @group WithSmush
+ * @requires PHP >= 7.4
  */
 class Test_IsSmushLazyloadActive extends SmushSubscriberTestCase {
 	/**

diff --git a/tests/Integration/inc/ThirdParty/Plugins/Smush/maybeDeactivateRocketLazyload.php b/tests/Integration/inc/ThirdParty/Plugins/Smush/maybeDeactivateRocketLazyload.php
@@ -7,6 +7,7 @@
  * @group ThirdParty
  * @group Smush
  * @group WithSmush
+ * @requires PHP >= 7.4
  */
 class Test_MaybeDeactivateRocketLazyload extends SmushSubscriberTestCase {
 	private $option_hook_prefix = 'pre_get_rocket_option_';

diff --git a/tests/Unit/inc/Engine/Preload/Subscriber/onPermalinkChanged.php b/tests/Unit/inc/Engine/Preload/Subscriber/onPermalinkChanged.php
@@ -38,7 +38,7 @@ protected function setUp(): void
 	}
 
 	public function testShouldDoAsExpected() {
-		$this->queue->expects()->add_job_preload_job_load_initial_sitemap_async();
+		$this->options->expects()->get('manual_preload', false)->andReturn(false);
 		$this->query->expects(self::once())->method('remove_all');
 		$this->queue->expects()->cancel_pending_jobs();
 		$this->subscriber->on_permalink_changed();