@automattic/newspack-blocks 4.2.1 → 4.2.2

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [4.2.2](https://github.com/Automattic/newspack-blocks/compare/v4.2.1...v4.2.2) (2024-10-11)
+
+
+### Bug Fixes
+
+* **block-caching:** only serve from cache if all blocks are cached ([#1899](https://github.com/Automattic/newspack-blocks/issues/1899)) ([fb64d0c](https://github.com/Automattic/newspack-blocks/commit/fb64d0ca4ffc2f16870bcc51db83f090054a5d26))
+
 ## [4.2.1](https://github.com/Automattic/newspack-blocks/compare/v4.2.0...v4.2.1) (2024-10-09)
 
 

package/includes/class-newspack-blocks-caching.php

@@ -12,11 +12,31 @@ class Newspack_Blocks_Caching {
 
 	const CACHE_GROUP = 'newspack_blocks';
 
+	/**
+	 * Store the cache status for all blocks for this request.
+	 *
+	 * @var bool
+	 */
+	private static $can_serve_all_blocks_from_cache = true;
+
+	/**
+	 * Store the current block index. This will be incremented with each cache reading,
+	 * in order to add specificity to the cache key. The cache key consists of the
+	 * hashed block attributes – which may be duplicated on a page – and a unique index.
+	 * With index only, replacing the block would *not* invalidate cache, which is undesired.
+	 * With hashed block attributes only, duplicated block configurations would result in
+	 * duplication of rendered posts.
+	 *
+	 * @var int
+	 */
+	private static $current_block_index = 0;
+
 	/**
 	 * Add hooks and filters.
 	 */
 	public static function init() {
 		if ( defined( 'NEWSPACK_BLOCKS_CACHE_BLOCKS' ) && NEWSPACK_BLOCKS_CACHE_BLOCKS ) {
+			add_action( 'template_redirect', [ __CLASS__, 'check_all_blocks_cache_status' ] );
 			add_filter( 'pre_render_block', [ __CLASS__, 'maybe_serve_cached_block' ], 10, 2 );
 			add_filter( 'render_block', [ __CLASS__, 'maybe_cache_block' ], 9999, 2 );
 
@@ -27,18 +47,65 @@ class Newspack_Blocks_Caching {
 	}
 
 	/**
-	 * Determine whether a block should be cached.
+	 * Traverse all blocks on a page to check their cache status.
+	 * This has to happen before any blocks are rendered.
+	 */
+	public static function check_all_blocks_cache_status() {
+		if ( is_singular() ) {
+			$post = get_post();
+			if ( $post && property_exists( $post, 'post_content' ) ) {
+				self::check_block_cache_status( parse_blocks( $post->post_content ) );
+				// Reset the index after initial checks.
+				self::$current_block_index = 0;
+			}
+		}
+	}
+
+	/**
+	 * Check if a block can be cached, recursively.
 	 *
-	 * @param array $block_data Parsed block data.
-	 * @return bool True if block should be cached. False otherwise.
+	 * @param array $blocks Array of block data.
 	 */
-	protected static function should_cache_block( $block_data ) {
+	private static function check_block_cache_status( $blocks ) {
+		$cacheable_block_names = self::get_cacheable_blocks_names();
+		foreach ( $blocks as $block_data ) {
+			// Special treatment for reusable blocks, which are blocks stored in the posts table.
+			if ( $block_data['blockName'] === 'core/block' ) {
+				$reusable_block_post = get_post( $block_data['attrs']['ref'] );
+				if ( $reusable_block_post && property_exists( $reusable_block_post, 'post_content' ) ) {
+					self::check_block_cache_status( parse_blocks( $reusable_block_post->post_content ) );
+				}
+			}
+			if ( in_array( $block_data['blockName'], $cacheable_block_names, true ) ) {
+				if ( ! self::get_cached_block_data( $block_data ) ) {
+					self::$can_serve_all_blocks_from_cache = false;
+				}
+			}
+			if ( ! empty( $block_data['innerBlocks'] ) ) {
+				self::check_block_cache_status( $block_data['innerBlocks'] );
+			}
+		}
+	}
+
+	/**
+	 * Get cacheable blocks' names.
+	 */
+	public static function get_cacheable_blocks_names() {
 		$cacheable_blocks = [
 			'newspack-blocks/homepage-articles',
 			'newspack-blocks/carousel',
 		];
-		$cacheable_blocks = apply_filters( 'newspack_blocks_cacheable_blocks', $cacheable_blocks );
-		return in_array( $block_data['blockName'], $cacheable_blocks, true );
+		return apply_filters( 'newspack_blocks_cacheable_blocks', $cacheable_blocks );
+	}
+
+	/**
+	 * Determine whether a block should be cached.
+	 *
+	 * @param array $block_data Parsed block data.
+	 * @return bool True if block should be cached. False otherwise.
+	 */
+	protected static function should_cache_block( $block_data ) {
+		return in_array( $block_data['blockName'], self::get_cacheable_blocks_names(), true );
 	}
 
 	/**
@@ -49,7 +116,8 @@ class Newspack_Blocks_Caching {
 	 */
 	protected static function get_cache_key( $block_data ) {
 		$block_attributes = $block_data['attrs'];
-		$cache_key        = 'np_cached_block_' . md5( wp_json_encode( $block_attributes ) );
+		$cache_key        = 'np_cached_block_' . md5( wp_json_encode( $block_attributes ) ) . '_' . self::$current_block_index;
+		self::$current_block_index++;
 		return $cache_key;
 	}
 
@@ -92,15 +160,13 @@ class Newspack_Blocks_Caching {
 	}
 
 	/**
-	 * Serve a cached block if a valid one exists.
+	 * Is the block available in the cache?
 	 *
-	 * @param string|null $block_html Block HTML. If you return something non-null here it will short-circuit block rendering.
-	 * @param array       $block_data Parsed block data.
-	 * @return string|null Block markup if served from cache. Default (usually null), otherwise.
+	 * @param array $block_data Parsed block data.
 	 */
-	public static function maybe_serve_cached_block( $block_html, $block_data ) {
+	public static function get_cached_block_data( $block_data ) {
 		if ( ! self::should_cache_block( $block_data ) ) {
-			return $block_html;
+			return false;
 		}
 
 		$cache_key   = self::get_cache_key( $block_data );
@@ -110,7 +176,7 @@ class Newspack_Blocks_Caching {
 		$cached_data = wp_cache_get( $cache_key, $cache_group );
 		if ( ! is_array( $cached_data ) || ! isset( $cached_data['timestamp_generated'], $cached_data['cached_content'] ) || empty( $cached_data['cached_content'] ) ) {
 			self::debug_log( sprintf( 'Cached data not found for item %s in group %s', $cache_key, $cache_group ) );
-			return $block_html;
+			return false;
 		}
 
 		// Double-check to make sure cached data is still valid.
@@ -119,10 +185,30 @@ class Newspack_Blocks_Caching {
 				Newspack\Logger::log( sprintf( 'Flushing cache for item %s in group %s because it expired', $cache_key, $cache_group ) );
 			}
 			wp_cache_delete( $cache_key, $cache_group );
-			return $block_html;
+			return false;
 		}
+		self::debug_log( sprintf( 'Found cached block: item %s in group %s', $cache_key, $cache_group ) );
+		return $cached_data;
+	}
 
-		self::debug_log( sprintf( 'Serving cached block: item %s in group %s', $cache_key, $cache_group ) );
+	/**
+	 * Serve a cached block if a valid one exists.
+	 *
+	 * @param string|null $block_html Block HTML. If you return something non-null here it will short-circuit block rendering.
+	 * @param array       $block_data Parsed block data.
+	 * @return string|null Block markup if served from cache. Default (usually null), otherwise.
+	 */
+	public static function maybe_serve_cached_block( $block_html, $block_data ) {
+		if ( ! self::should_cache_block( $block_data ) ) {
+			return $block_html;
+		}
+		if ( ! self::$can_serve_all_blocks_from_cache ) {
+			return $block_html;
+		}
+		$cached_data = self::get_cached_block_data( $block_data );
+		if ( ! $cached_data ) {
+			return $block_html;
+		}
 
 		Newspack_Blocks::enqueue_view_assets( 'homepage-articles' );
 

package/newspack-blocks.php

@@ -7,7 +7,7 @@
  * Author URI:      https://newspack.com/
  * Text Domain:     newspack-blocks
  * Domain Path:     /languages
- * Version:         4.2.1
+ * Version:         4.2.2
  *
  * @package         Newspack_Blocks
  */
@@ -15,7 +15,7 @@
 define( 'NEWSPACK_BLOCKS__PLUGIN_FILE', __FILE__ );
 define( 'NEWSPACK_BLOCKS__BLOCKS_DIRECTORY', 'dist/' );
 define( 'NEWSPACK_BLOCKS__PLUGIN_DIR', plugin_dir_path( NEWSPACK_BLOCKS__PLUGIN_FILE ) );
-define( 'NEWSPACK_BLOCKS__VERSION', '4.2.1' );
+define( 'NEWSPACK_BLOCKS__VERSION', '4.2.2' );
 
 require_once NEWSPACK_BLOCKS__PLUGIN_DIR . 'includes/class-newspack-blocks.php';
 require_once NEWSPACK_BLOCKS__PLUGIN_DIR . 'includes/class-newspack-blocks-api.php';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/newspack-blocks",
-	"version": "4.2.1",
+	"version": "4.2.2",
 	"author": "Automattic",
 	"devDependencies": {
 		"@rushstack/eslint-patch": "^1.10.4",

package/vendor/autoload.php

@@ -22,4 +22,4 @@ if (PHP_VERSION_ID < 50600) {
 
 require_once __DIR__ . '/composer/autoload_real.php';
 
-return ComposerAutoloaderInit8b6b14905fc0a9c5eacbb4c428bdc56e::getLoader();
+return ComposerAutoloaderInit0bb7139426d46ba9e60aab1249f589e1::getLoader();

package/vendor/composer/autoload_real.php

@@ -2,7 +2,7 @@
 
 // autoload_real.php @generated by Composer
 
-class ComposerAutoloaderInit8b6b14905fc0a9c5eacbb4c428bdc56e
+class ComposerAutoloaderInit0bb7139426d46ba9e60aab1249f589e1
 {
     private static $loader;
 
@@ -22,12 +22,12 @@ class ComposerAutoloaderInit8b6b14905fc0a9c5eacbb4c428bdc56e
             return self::$loader;
         }
 
-        spl_autoload_register(array('ComposerAutoloaderInit8b6b14905fc0a9c5eacbb4c428bdc56e', 'loadClassLoader'), true, true);
+        spl_autoload_register(array('ComposerAutoloaderInit0bb7139426d46ba9e60aab1249f589e1', 'loadClassLoader'), true, true);
         self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
-        spl_autoload_unregister(array('ComposerAutoloaderInit8b6b14905fc0a9c5eacbb4c428bdc56e', 'loadClassLoader'));
+        spl_autoload_unregister(array('ComposerAutoloaderInit0bb7139426d46ba9e60aab1249f589e1', 'loadClassLoader'));
 
         require __DIR__ . '/autoload_static.php';
-        call_user_func(\Composer\Autoload\ComposerStaticInit8b6b14905fc0a9c5eacbb4c428bdc56e::getInitializer($loader));
+        call_user_func(\Composer\Autoload\ComposerStaticInit0bb7139426d46ba9e60aab1249f589e1::getInitializer($loader));
 
         $loader->register(true);
 

package/vendor/composer/autoload_static.php

@@ -4,7 +4,7 @@
 
 namespace Composer\Autoload;
 
-class ComposerStaticInit8b6b14905fc0a9c5eacbb4c428bdc56e
+class ComposerStaticInit0bb7139426d46ba9e60aab1249f589e1
 {
     public static $classMap = array (
         'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php',
@@ -13,7 +13,7 @@ class ComposerStaticInit8b6b14905fc0a9c5eacbb4c428bdc56e
     public static function getInitializer(ClassLoader $loader)
     {
         return \Closure::bind(function () use ($loader) {
-            $loader->classMap = ComposerStaticInit8b6b14905fc0a9c5eacbb4c428bdc56e::$classMap;
+            $loader->classMap = ComposerStaticInit0bb7139426d46ba9e60aab1249f589e1::$classMap;
 
         }, null, ClassLoader::class);
     }

package/vendor/composer/installed.php

@@ -3,7 +3,7 @@
         'name' => 'automattic/newspack-blocks',
         'pretty_version' => 'dev-trunk',
         'version' => 'dev-trunk',
-        'reference' => 'd7d934ab198a89d9e299daabb4cdf51d0f4bec2d',
+        'reference' => 'fb64d0ca4ffc2f16870bcc51db83f090054a5d26',
         'type' => 'wordpress-plugin',
         'install_path' => __DIR__ . '/../../',
         'aliases' => array(),
@@ -13,7 +13,7 @@
         'automattic/newspack-blocks' => array(
             'pretty_version' => 'dev-trunk',
             'version' => 'dev-trunk',
-            'reference' => 'd7d934ab198a89d9e299daabb4cdf51d0f4bec2d',
+            'reference' => 'fb64d0ca4ffc2f16870bcc51db83f090054a5d26',
             'type' => 'wordpress-plugin',
             'install_path' => __DIR__ . '/../../',
             'aliases' => array(),