Merge pull request #465 from newfold-labs/fix/cache-exclusion-invalid-option

Delete broken cache exclusion on a site when refreshed

Author: arunshenoy99

includes/Cache/CacheExclusion.php

@@ -3,7 +3,7 @@
 
 use NewfoldLabs\WP\ModuleLoader\Container;
 
-use function NewfoldLabs\WP\Module\Performance\get_default_cache_exclusions;
+use function NewfoldLabs\WP\Module\Performance\get_cache_exclusion;
 
 /**
  * Cache Exclusion Class
@@ -60,6 +60,6 @@ public function __construct( Container $container ) {
 	 * @return array
 	 */
 	public function add_to_runtime( $sdk ) {
-		return array_merge( $sdk, array( 'cacheExclusion' => get_option( self::OPTION_CACHE_EXCLUSION, get_default_cache_exclusions() ) ) );
+		return array_merge( $sdk, array( 'cacheExclusion' => get_cache_exclusion() ) );
 	}
 }

includes/Cache/Types/Browser.php

@@ -9,6 +9,7 @@
 use NewfoldLabs\WP\Module\Htaccess\Api as HtaccessApi;
 use NewfoldLabs\WP\Module\Performance\Cache\Types\Fragments\BrowserCacheFragment;
 
+use function NewfoldLabs\WP\Module\Performance\get_cache_exclusion;
 use function NewfoldLabs\WP\Module\Performance\get_cache_level;
 
 /**
@@ -109,7 +110,7 @@ public static function addRules( $cache_level ) {
 
 		// Build exclusion pattern (same logic as before).
 		$exclusion_pattern = '';
-		$cache_exclusion   = get_option( CacheExclusion::OPTION_CACHE_EXCLUSION, '' );
+		$cache_exclusion   = get_cache_exclusion();
 
 		if ( is_string( $cache_exclusion ) && '' !== $cache_exclusion ) {
 			$parts             = array_map( 'trim', explode( ',', sanitize_text_field( $cache_exclusion ) ) );

includes/Cache/Types/File.php

@@ -11,6 +11,7 @@
 use NewfoldLabs\WP\Module\Htaccess\Api as HtaccessApi;
 use wpscholar\Url;
 
+use function NewfoldLabs\WP\Module\Performance\get_cache_exclusion;
 use function NewfoldLabs\WP\Module\Performance\get_cache_level;
 use function NewfoldLabs\WP\Module\Performance\remove_directory;
 use function NewfoldLabs\WP\Module\Performance\should_cache_pages;
@@ -109,7 +110,7 @@ public static function addRules() {
 
 		// Build optional exclusion pattern (pipe-separated).
 		$exclusion_pattern = '';
-		$cache_exclusion   = get_option( CacheExclusion::OPTION_CACHE_EXCLUSION, '' );
+		$cache_exclusion   = get_cache_exclusion();
 
 		if ( is_string( $cache_exclusion ) && '' !== $cache_exclusion ) {
 			$parts             = array_map( 'trim', explode( ',', sanitize_text_field( $cache_exclusion ) ) );
@@ -286,7 +287,7 @@ public function shouldCache() {
 	 */
 	protected function exclusions() {
 		$default                = array( 'cart', 'checkout', 'wp-admin', '@', '%', ':', ';', '&', '=', '.', rest_get_url_prefix() );
-		$cache_exclusion_option = array_map( 'trim', explode( ',', (string) get_option( CacheExclusion::OPTION_CACHE_EXCLUSION ) ) );
+		$cache_exclusion_option = array_map( 'trim', explode( ',', (string) get_cache_exclusion() ) );
 		return array_merge( $default, array_filter( $cache_exclusion_option ) );
 	}
 

includes/functions.php

@@ -7,9 +7,12 @@
 use NewfoldLabs\WP\Module\Performance\Cache\CacheExclusion;
 
 /**
- * Return defaul exclusions.
+ * Return default cache exclusions (comma-separated string).
  *
- * @return array
+ * Must stay compatible with CacheExclusion::CACHE_EXCLUSION_VALIDATE_REGEX (a-z0-9,- only)
+ * so that get_cache_exclusion() validation and .htaccess fragment content remain valid.
+ *
+ * @return string
  */
 function get_default_cache_exclusions() {
 	return join( ',', array( 'cart', 'checkout', 'wp-admin', rest_get_url_prefix() ) );
@@ -27,10 +30,22 @@ function get_cache_level() {
 /**
  * Get the cache exclusion.
  *
- * @return int Cache exclusion.
+ * If the stored value is invalid (non-empty but contains disallowed characters), the option is deleted
+ * and the default exclusions are returned. Empty string is valid (exclude no paths).
+ *
+ * @return string Comma-separated exclusion slugs (e.g. cart,checkout,wp-admin,wp-json).
  */
 function get_cache_exclusion() {
-	return get_option( CacheExclusion::OPTION_CACHE_EXCLUSION, get_default_cache_exclusions() );
+	$value      = get_option( CacheExclusion::OPTION_CACHE_EXCLUSION, get_default_cache_exclusions() );
+	$normalized = CacheExclusion::normalize( $value );
+
+	// Invalid: non-empty and does not match allowed characters (a-z0-9,-). Empty is valid (exclude nothing).
+	if ( '' !== $normalized && ! preg_match( CacheExclusion::CACHE_EXCLUSION_VALIDATE_REGEX, $normalized ) ) {
+		delete_option( CacheExclusion::OPTION_CACHE_EXCLUSION );
+		return get_default_cache_exclusions();
+	}
+
+	return $value;
 }
 
 /**

tests/phpunit/includes/CacheExclusionTest.php

@@ -118,6 +118,31 @@ public function test_update_cache_exclusion_option_invalid() {
 			$this->assertSame( 400, $response->get_status() );
 			$this->assertFalse( $response->get_data()['result'] );
 		}
+
+		/**
+		 * Test that get_cache_exclusion() deletes invalid option and returns default.
+		 */
+		public function test_get_cache_exclusion_deletes_invalid_option_and_returns_default() {
+			$invalid_value = 'cart,checkout,wp-admin,wp-json https://example.com/admin/';
+			$option_name   = \NewfoldLabs\WP\Module\Performance\Cache\CacheExclusion::OPTION_CACHE_EXCLUSION;
+			$default       = 'cart,checkout,wp-admin,wp-json';
+
+			WP_Mock::userFunction( 'get_option' )
+				->with( $option_name, $default )
+				->andReturn( $invalid_value );
+
+			WP_Mock::userFunction( 'delete_option' )
+				->with( $option_name )
+				->once()
+				->andReturn( true );
+
+			WP_Mock::userFunction( 'rest_get_url_prefix' )
+				->andReturn( 'wp-json' );
+
+			$result = \NewfoldLabs\WP\Module\Performance\get_cache_exclusion();
+
+			$this->assertSame( $default, $result );
+		}
 	}
 }
 // phpcs:enable