Boost: Add filter on cache parameters so caching is more flexible

projects/plugins/boost/app/modules/optimizations/page-cache/pre-wordpress/Boost_Cache.php

@@ -59,6 +59,11 @@ class Boost_Cache {
 	 */
 	private $do_cache = false;
 
+	/**
+	 * @var string - The cookies that were removed from the cache parameters.
+	 */
+	private $removed_cookies = '';
+
 	/**
 	 * @param ?Storage\Storage $storage - Optionally provide a Storage subclass to handle actually storing and retrieving cached content. Defaults to a new instance of File_Storage.
 	 */
@@ -81,6 +86,7 @@ public function init_actions() {
 		add_action( 'wp_trash_post', array( $this, 'delete_on_post_trash' ), 10, 2 );
 		add_filter( 'wp_php_error_message', array( $this, 'disable_caching_on_error' ) );
 		add_filter( 'init', array( $this, 'init_do_cache' ) );
+		add_filter( 'jetpack_boost_cache_parameters', array( $this, 'ignore_cookies' ) );
 	}
 
 	/**
@@ -141,7 +147,8 @@ public function serve_cached() {
 
 		if ( is_string( $cached ) ) {
 			$this->send_header( 'X-Jetpack-Boost-Cache: hit' );
-			Logger::debug( 'Serving cached page' );
+			$removed_cookies_message = $this->removed_cookies === '' ? '' : " and removed cookies: {$this->removed_cookies}";
+			Logger::debug( 'Serving cached page' . $removed_cookies_message );
 			echo $cached; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
 			die();
 		}
@@ -198,7 +205,8 @@ public function ob_callback( $buffer ) {
 			if ( $result instanceof Boost_Cache_Error ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedIf
 				Logger::debug( 'Error writing cache file: ' . $result->get_error_message() );
 			} else {
-				Logger::debug( 'Cache file created' );
+				$removed_cookies_message = $this->removed_cookies === '' ? '' : " and removed cookies: {$this->removed_cookies}";
+				Logger::debug( 'Cache file created' . $removed_cookies_message );
 			}
 		}
 
@@ -473,6 +481,57 @@ public function invalidate_cache( $action = Filesystem_Utils::REBUILD_ALL ) {
 		return $this->invalidate_cache_for_url( home_url(), $action );
 	}
 
+	/**
+	 * Ignore certain cookies in the cache parameters so cached pages can be served to these visitors.
+	 *
+	 * @param array $parameters - The parameters with the cookies array to filter.
+	 * @return array - The parameters with cookies removed.
+	 */
+	public function ignore_cookies( $parameters ) {
+		static $params = false;
+
+		if ( $params ) {
+				return $params;
+		}
+
+		// JETPACK_BOOST_IGNORE_COOKIES is a comma-separated list of cookies to ignore.
+		if ( defined( 'JETPACK_BOOST_IGNORE_COOKIES' ) ) {
+			$cookies = explode( ',', constant( 'JETPACK_BOOST_IGNORE_COOKIES' ) );
+			$cookies = array_map( 'trim', $cookies );
+		} else {
+			$cookies = array();
+		}
+
+		/**
+		 * Filters the browser cookies so cached pages can be served to these visitors.
+		 *
+		 * @since $$next-version$$
+		 *
+		 * @param array $cookies An array of cookie names to remove from the cookie list.
+		 */
+		$cookies = apply_filters(
+			'jetpack_boost_ignore_cookies',
+			array_merge(
+				$cookies,
+				array( 'cf_clearance', 'cf_chl_rc_i', 'cf_chl_rc_ni', 'cf_chl_rc_m', '_cfuvid', '__cfruid', '__cfwaitingroom', 'cf_ob_info', 'cf_use_ob', '__cfseq', '__cf_bm', '__cflb', 'sbsj_' )
+			)
+		);
+
+		foreach ( $cookies as $cookie ) {
+			if ( isset( $parameters['cookies'][ $cookie ] ) ) {
+				unset( $parameters['cookies'][ $cookie ] );
+				$this->removed_cookies .= $cookie . ',';
+			}
+		}
+		if ( $this->removed_cookies !== '' ) {
+			$this->removed_cookies = rtrim( $this->removed_cookies, ',' );
+		}
+
+		$params = $parameters;
+
+		return $parameters;
+	}
+
 	public function disable_caching_on_error( $message ) {
 		if ( ! defined( 'DONOTCACHEPAGE' ) ) {
 			define( 'DONOTCACHEPAGE', true );

projects/plugins/boost/app/modules/optimizations/page-cache/pre-wordpress/Request.php

@@ -53,7 +53,7 @@ public function get_uri() {
 	}
 
 	public function get_parameters() {
-		return $this->request_parameters;
+		return apply_filters( 'jetpack_boost_cache_parameters', $this->request_parameters );
 	}
 
 	/**
@@ -84,7 +84,8 @@ public function is_url_excluded( $request_uri = '' ) {
 		}
 
 		// Check if the query parameters `jb-disable-modules` or `jb-generate-critical-css` exist.
-		$query_params = isset( $this->request_parameters['get'] ) ? $this->request_parameters['get'] : array();
+		$request_parameters = $this->get_parameters();
+		$query_params       = isset( $request_parameters['get'] ) ? $request_parameters['get'] : array();
 		if ( isset( $query_params ) &&
 			( isset( $query_params['jb-disable-modules'] ) || isset( $query_params['jb-generate-critical-css'] ) )
 		) {

projects/plugins/boost/changelog/update-boost-cookie_filter

@@ -0,0 +1,4 @@
+Significance: minor
+Type: added
+
+Cache: filter cookies so they do not cause a cache miss.