From 6eb9d6a83d82eed889fdb7edb0cb51f24c41f911 Mon Sep 17 00:00:00 2001
From: Thomas Roberts <5656702+opr@users.noreply.github.com>
Date: Wed, 23 Oct 2024 15:50:13 +0100
Subject: [PATCH] Fix product count display on mini cart first render (#52124)

Co-authored-by: Alex Florisca <alex.florisca@automattic.com>
---
 .../changelog/fix-mini-cart-button-setting    |  4 +
 .../src/Blocks/BlockTypes/MiniCart.php        |  9 +-
 .../php/src/Blocks/BlockTypes/MiniCart.php    | 88 +++++++++++++++++++
 3 files changed, 100 insertions(+), 1 deletion(-)
 create mode 100644 plugins/woocommerce/changelog/fix-mini-cart-button-setting
 create mode 100644 plugins/woocommerce/tests/php/src/Blocks/BlockTypes/MiniCart.php

diff --git a/plugins/woocommerce/changelog/fix-mini-cart-button-setting b/plugins/woocommerce/changelog/fix-mini-cart-button-setting
new file mode 100644
index 00000000000..7699e69a488
--- /dev/null
+++ b/plugins/woocommerce/changelog/fix-mini-cart-button-setting
@@ -0,0 +1,4 @@
+Significance: patch
+Type: fix
+
+Set server-side render of Mini-Cart icon to correctly show/hide the count based on block setting
diff --git a/plugins/woocommerce/src/Blocks/BlockTypes/MiniCart.php b/plugins/woocommerce/src/Blocks/BlockTypes/MiniCart.php
index 44cc0431f31..453526516f2 100644
--- a/plugins/woocommerce/src/Blocks/BlockTypes/MiniCart.php
+++ b/plugins/woocommerce/src/Blocks/BlockTypes/MiniCart.php
@@ -422,10 +422,17 @@ class MiniCart extends AbstractBlock {
 		$product_count_color = array_key_exists( 'productCountColor', $attributes ) ? esc_attr( $attributes['productCountColor']['color'] ) : '';
 		$icon                = MiniCartUtils::get_svg_icon( $attributes['miniCartIcon'] ?? '', $icon_color );
 
+		$product_count_visibility = isset( $attributes['productCountVisibility'] ) ? $attributes['productCountVisibility'] : 'greater_than_zero';
+		$show_product_count       = 'always' === $product_count_visibility;
+		if ( 'greater_than_zero' === $product_count_visibility ) {
+			$cart               = $this->get_cart_instance();
+			$show_product_count = $cart && $cart->get_cart_contents_count() > 0;
+		}
+
 		$button_html = $this->get_cart_price_markup( $attributes ) . '
 		<span class="wc-block-mini-cart__quantity-badge">
 			' . $icon . '
-			<span class="wc-block-mini-cart__badge" style="background:' . $product_count_color . '"></span>
+			' . ( $show_product_count ? '<span class="wc-block-mini-cart__badge" style="background:' . $product_count_color . '"></span>' : '' ) . '
 		</span>';
 
 		if ( is_cart() || is_checkout() ) {
diff --git a/plugins/woocommerce/tests/php/src/Blocks/BlockTypes/MiniCart.php b/plugins/woocommerce/tests/php/src/Blocks/BlockTypes/MiniCart.php
new file mode 100644
index 00000000000..b1c28678aec
--- /dev/null
+++ b/plugins/woocommerce/tests/php/src/Blocks/BlockTypes/MiniCart.php
@@ -0,0 +1,88 @@
+<?php
+declare( strict_types = 1 );
+namespace Automattic\WooCommerce\Tests\Blocks\BlockTypes;
+
+use Automattic\WooCommerce\Tests\Blocks\Helpers\FixtureData;
+
+/**
+ * Tests for the Checkout block type
+ *
+ * @since $VID:$
+ */
+class MiniCart extends \WP_UnitTestCase {
+
+	/**
+	 * Setup test product data. Called before every test.
+	 */
+	public function setUp(): void {
+		parent::setUp();
+
+		$fixtures       = new FixtureData();
+		$this->products = array(
+			$fixtures->get_simple_product(
+				array(
+					'name'          => 'Test Product 1',
+					'stock_status'  => 'instock',
+					'regular_price' => 10,
+					'weight'        => 10,
+				)
+			),
+		);
+		wc_empty_cart();
+		add_filter( 'woocommerce_is_rest_api_request', '__return_false', 1 );
+	}
+
+	/**
+	 * Tear down test. Called after every test.
+	 * @return void
+	 */
+	protected function tearDown(): void {
+		parent::tearDown();
+		remove_filter( 'woocommerce_is_rest_api_request', '__return_false', 1 );
+	}
+
+	/**
+	 * Checks the output of the MiniCart block is correct based on the productCountVisibility attribute when cart is empty.
+	 * @return void
+	 */
+	public function test_product_count_visibility_with_empty_cart() {
+
+		// Test badge is shown when "always" is selected.
+		$block  = parse_blocks( '<!-- wp:woocommerce/mini-cart {"productCountVisibility":"always"} /-->' );
+		$output = render_block( $block[0] );
+		$this->assertStringContainsString( '<span class="wc-block-mini-cart__badge"', $output );
+
+		// Tests badge is not shown, because product count is not greater than zero when "greater_than_zero" is selected.
+		$block  = parse_blocks( '<!-- wp:woocommerce/mini-cart {"productCountVisibility":"greater_than_zero"} /-->' );
+		$output = render_block( $block[0] );
+		$this->assertStringNotContainsString( '<span class="wc-block-mini-cart__badge"', $output );
+
+		// Tests badge is not shown when "never" is selected.
+		$block  = parse_blocks( '<!-- wp:woocommerce/mini-cart {"productCountVisibility":"never"} /-->' );
+		$output = render_block( $block[0] );
+		$this->assertStringNotContainsString( '<span class="wc-block-mini-cart__badge"', $output );
+	}
+
+	/**
+	 * Checks the output of the MiniCart block is correct based on the productCountVisibility attribute when cart has products.
+	 * @return void
+	 */
+	public function test_product_count_visibility_with_products_in_cart() {
+		WC()->cart->add_to_cart( $this->products[0]->get_id(), 2 );
+
+		// Tests badge is shown with items in cart when "always" is selected.
+		$block  = parse_blocks( '<!-- wp:woocommerce/mini-cart {"productCountVisibility":"always"} /-->' );
+		$output = render_block( $block[0] );
+		$this->assertStringContainsString( '<span class="wc-block-mini-cart__badge"', $output );
+
+		// Tests badge *is* shown, because product count is greater than zero when "greater_than_zero" is selected.
+		$block  = parse_blocks( '<!-- wp:woocommerce/mini-cart {"productCountVisibility":"greater_than_zero"} /-->' );
+		$output = render_block( $block[0] );
+		$this->assertStringContainsString( '<span class="wc-block-mini-cart__badge"', $output );
+
+		// Tests badge is not shown with items in cart when "never" is selected.
+		$block  = parse_blocks( '<!-- wp:woocommerce/mini-cart {"productCountVisibility":"never"} /-->' );
+		$output = render_block( $block[0] );
+		$this->assertStringNotContainsString( '<span class="wc-block-mini-cart__badge"', $output );
+	}
+}