[CYS] Reduce the number of times the patterns dictionary is accessed (#…

…11733) * Load content and images on registration if the patterns is in the dictionary * Stop getting the content from each pattern * Add comment with explanation about the change
woocommerce · Nov 13, 2023 · 0101524 · 0101524
1 parent 7f97119
commit 0101524
Show file tree

Hide file tree

Showing 30 changed files with 41 additions and 59 deletions.
diff --git a/patterns/banner.php b/patterns/banner.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/banner' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/banner' );
 
 $banner_title       = $content['titles'][0]['default'] ?? '';
 $banner_button      = $content['buttons'][0]['default'] ?? '';

diff --git a/patterns/discount-banner-with-image.php b/patterns/discount-banner-with-image.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/discount-banner-with-image' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/discount-banner-with-image' );
 
 $description = $content['descriptions'][0]['default'] ?? '';
 ?>

diff --git a/patterns/discount-banner.php b/patterns/discount-banner.php
@@ -5,9 +5,6 @@
  * Categories: WooCommerce
  */
 
-use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-
-$content     = PatternsHelper::get_pattern_content( 'woocommerce-blocks/discount-banner' );
 $description = $content['descriptions'][0]['default'] ?? '';
 ?>
 

diff --git a/patterns/featured-category-cover-image.php b/patterns/featured-category-cover-image.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/featured-category-cover-image' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/featured-category-cover-image' );
 
 $image1 = PatternsHelper::get_image_url( $images, 0, 'images/pattern-placeholders/shop-jeans.png' );
 

diff --git a/patterns/featured-category-focus.php b/patterns/featured-category-focus.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/featured-category-focus' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/featured-category-focus' );
 
 $category_title = $content['titles'][0]['default'] ?? '';
 ?>

diff --git a/patterns/featured-category-triple.php b/patterns/featured-category-triple.php
@@ -6,9 +6,7 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/featured-category-triple' );
 
-$images = PatternsHelper::get_pattern_images( 'woocommerce-blocks/featured-category-triple' );
 $image1 = PatternsHelper::get_image_url( $images, 0, 'images/pattern-placeholders/sweet-restaurant-celebration-food-chocolate-cupcake.png' );
 $image2 = PatternsHelper::get_image_url( $images, 1, 'images/pattern-placeholders/dish-meal-food-breakfast-dessert-eat.png' );
 $image3 = PatternsHelper::get_image_url( $images, 2, 'images/pattern-placeholders/dish-food-baking-dessert-bread-bakery.png' );

diff --git a/patterns/featured-products-fresh-and-tasty.php b/patterns/featured-products-fresh-and-tasty.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/featured-products-fresh-and-tasty' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/featured-products-fresh-and-tasty' );
 
 $image1 = PatternsHelper::get_image_url( $images, 0, 'images/pattern-placeholders/sweet-organic-lemons.png' );
 $image2 = PatternsHelper::get_image_url( $images, 1, 'images/pattern-placeholders/fresh-organic-tomatoes.png' );

diff --git a/patterns/hero-product-3-split.php b/patterns/hero-product-3-split.php
@@ -7,9 +7,6 @@
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
 
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/hero-product-3-split' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/hero-product-3-split' );
-
 $main_title   = $content['titles'][0]['default'] ?? '';
 $first_title  = $content['titles'][1]['default'] ?? '';
 $second_title = $content['titles'][2]['default'] ?? '';

diff --git a/patterns/hero-product-chessboard.php b/patterns/hero-product-chessboard.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/hero-product-chessboard' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/hero-product-chessboard' );
 
 $image1 = PatternsHelper::get_image_url( $images, 0, 'images/pattern-placeholders/sweet-restaurant-celebration-food-chocolate-cupcake.png' );
 $image2 = PatternsHelper::get_image_url( $images, 1, 'images/pattern-placeholders/dish-meal-food-breakfast-dessert-eat.png' );

diff --git a/patterns/hero-product-split.php b/patterns/hero-product-split.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/hero-product-split' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/hero-product-split' );
 
 $hero_title = $content['titles'][0]['default'] ?? '';
 ?>

diff --git a/patterns/just-arrived-full-hero.php b/patterns/just-arrived-full-hero.php
@@ -7,9 +7,6 @@
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
 
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/just-arrived-full-hero' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/just-arrived-full-hero' );
-
 $pattern_title       = $content['titles'][0]['default'] ?? '';
 $pattern_description = $content['descriptions'][0]['default'] ?? '';
 $pattern_button      = $content['buttons'][0]['default'] ?? '';

diff --git a/patterns/product-collection-3-columns.php b/patterns/product-collection-3-columns.php
@@ -6,8 +6,6 @@
  */
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
 
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/product-collection-3-columns' );
-
 $products_title = $content['titles'][0]['default'] ?? '';
 ?>
 

diff --git a/patterns/product-collection-4-columns.php b/patterns/product-collection-4-columns.php
@@ -6,8 +6,6 @@
  */
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
 
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/product-collection-4-columns' );
-
 $products_title = $content['titles'][0]['default'] ?? '';
 ?>
 

diff --git a/patterns/product-collection-5-columns.php b/patterns/product-collection-5-columns.php
@@ -6,8 +6,6 @@
  */
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
 
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/product-collection-5-columns' );
-
 $products_title = $content['titles'][0]['default'] ?? '';
 ?>
 

diff --git a/patterns/product-collection-banner.php b/patterns/product-collection-banner.php
@@ -6,9 +6,8 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/product-collection-banner' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/product-collection-banner' );
-$image   = PatternsHelper::get_image_url( $images, 0, 'images/pattern-placeholders/beach-landscape-sea-coast-nature-person.jpg' );
+
+$image = PatternsHelper::get_image_url( $images, 0, 'images/pattern-placeholders/beach-landscape-sea-coast-nature-person.jpg' );
 
 $first_title       = $content['titles'][0]['default'] ?? '';
 $first_description = $content['descriptions'][0]['default'] ?? '';

diff --git a/patterns/product-collection-featured-products-5-columns.php b/patterns/product-collection-featured-products-5-columns.php
@@ -6,7 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/product-collection-featured-products-5-columns' );
 
 $collection_title = $content['titles'][0]['default'] ?? '';
 ?>

diff --git a/patterns/product-collections-featured-collection.php b/patterns/product-collections-featured-collection.php
@@ -7,7 +7,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/product-collections-featured-collection' );
 
 $collection_title = $content['titles'][0]['default'] ?? '';
 ?>

diff --git a/patterns/product-collections-featured-collections.php b/patterns/product-collections-featured-collections.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/product-collections-featured-collections' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/product-collections-featured-collections' );
 
 $image1 = PatternsHelper::get_image_url( $images, 0, 'images/pattern-placeholders/technology-white-camera-photography-vintage-photographer.png' );
 $image2 = PatternsHelper::get_image_url( $images, 1, 'images/pattern-placeholders/leather-guitar-typewriter-red-gadget-sofa.png' );

diff --git a/patterns/product-collections-newest-arrivals.php b/patterns/product-collections-newest-arrivals.php
@@ -7,7 +7,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/product-collections-newest-arrivals' );
 
 $first_title  = $content['titles'][0]['default'] ?? '';
 $first_button = $content['buttons'][0]['default'] ?? '';

diff --git a/patterns/product-featured-2-columns.php b/patterns/product-featured-2-columns.php
@@ -5,8 +5,6 @@
  * Categories: WooCommerce
  */
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/featured-products-2-cols' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/featured-products-2-cols' );
 
 $first_title       = $content['titles'][0]['default'] ?? '';
 $first_description = $content['descriptions'][0]['default'] ?? '';

diff --git a/patterns/product-hero-2-col-2-row.php b/patterns/product-hero-2-col-2-row.php
@@ -7,9 +7,6 @@
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
 
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/product-hero-2-col-2-row' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/product-hero-2-col-2-row' );
-
 $image1 = PatternsHelper::get_image_url( $images, 0, 'images/pattern-placeholders/man-person-winter-photography-statue-coat.png' );
 $image2 = PatternsHelper::get_image_url( $images, 1, 'images/pattern-placeholders/pattern-fashion-clothing-outerwear-wool-scarf.png' );
 

diff --git a/patterns/product-query-product-gallery.php b/patterns/product-query-product-gallery.php
@@ -5,9 +5,6 @@
  * Categories: WooCommerce
  * Block Types: core/query/woocommerce/product-query
  */
-use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/product-query-product-gallery' );
 
 $gallery_title = $content['titles'][0]['default'] ?? '';
 ?>

diff --git a/patterns/shop-by-price.php b/patterns/shop-by-price.php
@@ -6,7 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/shop-by-price' );
 
 $first_title  = $content['titles'][0]['default'] ?? '';
 $second_title = $content['titles'][1]['default'] ?? '';

diff --git a/patterns/small-discount-banner-with-image.php b/patterns/small-discount-banner-with-image.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/small-discount-banner-with-image' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/small-discount-banner-with-image' );
 
 $banner_title = $content['titles'][0]['default'] ?? '';
 ?>

diff --git a/patterns/social-follow-us-in-social-media.php b/patterns/social-follow-us-in-social-media.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/social-follow-us-in-social-media' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/social-follow-us-in-social-media' );
 
 $image1 = PatternsHelper::get_image_url( $images, 0, 'images/pattern-placeholders/office.png' );
 $image2 = PatternsHelper::get_image_url( $images, 1, 'images/pattern-placeholders/living-room.png' );

diff --git a/patterns/store-info-alt-image-and-text.php b/patterns/store-info-alt-image-and-text.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/alt-image-and-text' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/alt-image-and-text' );
 
 $image1 = PatternsHelper::get_image_url( $images, 0, 'images/pattern-placeholders/crafting-pots.png' );
 $image2 = PatternsHelper::get_image_url( $images, 1, 'images/pattern-placeholders/hand-made-pots.png' );

diff --git a/patterns/testimonials-3-columns.php b/patterns/testimonials-3-columns.php
@@ -7,8 +7,6 @@
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
 
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/testimonials-3-columns' );
-
 $main_header        = $content['titles'][0]['default'] ?? '';
 $first_review       = $content['titles'][1]['default'] ?? '';
 $second_review      = $content['titles'][2]['default'] ?? '';

diff --git a/patterns/testimonials-single.php b/patterns/testimonials-single.php
@@ -6,8 +6,6 @@
  */
 
 use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
-$content = PatternsHelper::get_pattern_content( 'woocommerce-blocks/testimonials-single' );
-$images  = PatternsHelper::get_pattern_images( 'woocommerce-blocks/testimonials-single' );
 
 $testimonials_title = $content['titles'][0]['default'] ?? '';
 $description        = $content['descriptions'][0]['default'] ?? '';

diff --git a/src/BlockPatterns.php b/src/BlockPatterns.php
@@ -4,6 +4,7 @@
 use Automattic\WooCommerce\Blocks\AI\Connection;
 use Automattic\WooCommerce\Blocks\Images\Pexels;
 use Automattic\WooCommerce\Blocks\Domain\Package;
+use Automattic\WooCommerce\Blocks\Patterns\PatternsHelper;
 use Automattic\WooCommerce\Blocks\Patterns\PatternUpdater;
 use Automattic\WooCommerce\Blocks\Patterns\ProductUpdater;
 
@@ -129,6 +130,8 @@ public function register_block_patterns() {
 			return;
 		}
 
+		$dictionary = PatternsHelper::get_patterns_dictionary();
+
 		foreach ( $files as $file ) {
 			$pattern_data = get_file_data( $file, $default_headers );
 
@@ -226,10 +229,27 @@ public function register_block_patterns() {
 				$pattern_data['description'] = translate_with_gettext_context( $pattern_data['description'], 'Pattern description', 'woo-gutenberg-products-block' );
 			}
 
+			$pattern_data_from_dictionary = $this->get_pattern_from_dictionary( $dictionary, $pattern_data['slug'] );
+
 			// The actual pattern content is the output of the file.
 			ob_start();
+
+			/*
+				For patterns that can have AI-generated content, we need to get its content from the dictionary and pass
+				it to the pattern file through the "$content" and "$images" variables.
+				This is to avoid having to access the dictionary for each pattern when it's registered or inserted.
+				Before the "$content" and "$images" variables were populated in each pattern. Since the pattern
+				registration happens in the init hook, the dictionary was being access one for each pattern and
+				for each page load. This way we only do it once on registration.
+				For more context: https://github.com/woocommerce/woocommerce-blocks/pull/11733
+			*/
+			if ( ! is_null( $pattern_data_from_dictionary ) ) {
+				$content = $pattern_data_from_dictionary['content'];
+				$images  = $pattern_data_from_dictionary['images'] ?? array();
+			}
 			include $file;
 			$pattern_data['content'] = ob_get_clean();
+
 			if ( ! $pattern_data['content'] ) {
 				continue;
 			}
@@ -354,4 +374,22 @@ public function update_patterns_content( $value ) {
 
 		return true;
 	}
+
+	/**
+	 * Filter the patterns dictionary to get the pattern data corresponding to the pattern slug.
+	 *
+	 * @param array  $dictionary The patterns dictionary.
+	 * @param string $slug The pattern slug.
+	 *
+	 * @return array|null
+	 */
+	private function get_pattern_from_dictionary( $dictionary, $slug ) {
+		foreach ( $dictionary as $pattern_dictionary ) {
+			if ( $pattern_dictionary['slug'] === $slug ) {
+				return $pattern_dictionary;
+			}
+		}
+
+		return null;
+	}
 }
diff --git a/src/Patterns/PatternsHelper.php b/src/Patterns/PatternsHelper.php
@@ -124,7 +124,7 @@ public static function upsert_patterns_ai_data_post( $patterns_dictionary ) {
 	 *
 	 * @return mixed|WP_Error|null
 	 */
-	private static function get_patterns_dictionary( $pattern_slug = null ) {
+	public static function get_patterns_dictionary( $pattern_slug = null ) {
 
 		$patterns_ai_data_post = self::get_patterns_ai_data_post();