Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

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

Merged
merged 3 commits into from
Nov 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions patterns/banner.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
Expand Down
2 changes: 0 additions & 2 deletions patterns/discount-banner-with-image.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>
Expand Down
3 changes: 0 additions & 3 deletions patterns/discount-banner.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>

Expand Down
2 changes: 0 additions & 2 deletions patterns/featured-category-cover-image.php
Original file line number Diff line number Diff line change
Expand Up @@ -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' );

Expand Down
2 changes: 0 additions & 2 deletions patterns/featured-category-focus.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>
Expand Down
2 changes: 0 additions & 2 deletions patterns/featured-category-triple.php
Original file line number Diff line number Diff line change
Expand Up @@ -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' );
Expand Down
2 changes: 0 additions & 2 deletions patterns/featured-products-fresh-and-tasty.php
Original file line number Diff line number Diff line change
Expand Up @@ -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' );
Expand Down
3 changes: 0 additions & 3 deletions patterns/hero-product-3-split.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
Expand Down
2 changes: 0 additions & 2 deletions patterns/hero-product-chessboard.php
Original file line number Diff line number Diff line change
Expand Up @@ -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' );
Expand Down
2 changes: 0 additions & 2 deletions patterns/hero-product-split.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>
Expand Down
3 changes: 0 additions & 3 deletions patterns/just-arrived-full-hero.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
Expand Down
2 changes: 0 additions & 2 deletions patterns/product-collection-3-columns.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>

Expand Down
2 changes: 0 additions & 2 deletions patterns/product-collection-4-columns.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>

Expand Down
2 changes: 0 additions & 2 deletions patterns/product-collection-5-columns.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>

Expand Down
5 changes: 2 additions & 3 deletions patterns/product-collection-banner.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>
Expand Down
1 change: 0 additions & 1 deletion patterns/product-collections-featured-collection.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>
Expand Down
2 changes: 0 additions & 2 deletions patterns/product-collections-featured-collections.php
Original file line number Diff line number Diff line change
Expand Up @@ -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' );
Expand Down
1 change: 0 additions & 1 deletion patterns/product-collections-newest-arrivals.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
Expand Down
2 changes: 0 additions & 2 deletions patterns/product-featured-2-columns.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
Expand Down
3 changes: 0 additions & 3 deletions patterns/product-hero-2-col-2-row.php
Original file line number Diff line number Diff line change
Expand Up @@ -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' );

Expand Down
3 changes: 0 additions & 3 deletions patterns/product-query-product-gallery.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>
Expand Down
1 change: 0 additions & 1 deletion patterns/shop-by-price.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
Expand Down
2 changes: 0 additions & 2 deletions patterns/small-discount-banner-with-image.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
?>
Expand Down
2 changes: 0 additions & 2 deletions patterns/social-follow-us-in-social-media.php
Original file line number Diff line number Diff line change
Expand Up @@ -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' );
Expand Down
2 changes: 0 additions & 2 deletions patterns/store-info-alt-image-and-text.php
Original file line number Diff line number Diff line change
Expand Up @@ -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' );
Expand Down
2 changes: 0 additions & 2 deletions patterns/testimonials-3-columns.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
Expand Down
2 changes: 0 additions & 2 deletions patterns/testimonials-single.php
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ?? '';
Expand Down
38 changes: 38 additions & 0 deletions src/BlockPatterns.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -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 );

Expand Down Expand Up @@ -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();
}
albarin marked this conversation as resolved.
Show resolved Hide resolved
include $file;
$pattern_data['content'] = ob_get_clean();

if ( ! $pattern_data['content'] ) {
continue;
}
Expand Down Expand Up @@ -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;
}
}
2 changes: 1 addition & 1 deletion src/Patterns/PatternsHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -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();

Expand Down