Disable ECE for incompatible tax scenarios (#3493)

* Disable ECE for incompatible tax scenarios

* Add changelog and readme entries

* Add unit test

Author: annemirasol

changelog.txt

@@ -1,6 +1,7 @@
 *** Changelog ***
 
 = 8.8.0 - xxxx-xx-xx =
+* Tweak - Disable ECE when cart has virtual products and tax is based on customer billing or shipping address.
 * Fix - Fix the usage of coupons and the total shipping amount when using the Express Checkout Element on the shortcode checkout.
 * Fix - Fixes some JS console errors when making a purchase with the Stripe Express Checkout Element on the shortcode checkout.
 * Fix - Updates the display logic for the OAuth re-connect promotional surface to follow the latest changes made to the connection settings object.

includes/payment-methods/class-wc-stripe-express-checkout-helper.php

@@ -551,9 +551,35 @@ public function should_show_express_checkout_button() {
 			}
 		}
 
+		// Hide if cart/product doesn't require shipping and tax is based on billing or shipping address.
+		if (
+			(
+				( is_product() && ! $this->product_needs_shipping( $this->get_product() ) ) ||
+				( ( is_cart() || is_checkout() ) && ! WC()->cart->needs_shipping() )
+			) &&
+			in_array( get_option( 'woocommerce_tax_based_on' ), [ 'billing', 'shipping' ], true )
+		) {
+			return false;
+		}
+
 		return true;
 	}
 
+	/**
+	 * Check if the passed product needs to be shipped.
+	 *
+	 * @param WC_Product $product The product to check.
+	 *
+	 * @return bool Returns true if the product requires shipping; otherwise, returns false.
+	 */
+	public function product_needs_shipping( WC_Product $product ) {
+		if ( ! $product ) {
+			return false;
+		}
+
+		return wc_shipping_enabled() && 0 !== wc_get_shipping_method_count( true ) && $product->needs_shipping();
+	}
+
 	/**
 	 * Returns true if express checkout buttons are enabled on the cart page, false
 	 * otherwise.

readme.txt

@@ -129,6 +129,7 @@ If you get stuck, you can ask for help in the Plugin Forum.
 == Changelog ==
 
 = 8.8.0 - xxxx-xx-xx =
+* Tweak - Disable ECE when cart has virtual products and tax is based on customer billing or shipping address.
 * Fix - Fix the usage of coupons and the total shipping amount when using the Express Checkout Element on the shortcode checkout.
 * Fix - Fixes some JS console errors when making a purchase with the Stripe Express Checkout Element on the shortcode checkout.
 * Fix - Updates the display logic for the OAuth re-connect promotional surface to follow the latest changes made to the connection settings object.

tests/phpunit/test-wc-stripe-express-checkout-helper.php

@@ -0,0 +1,70 @@
+<?php
+
+/**
+ * These tests make assertions against class WC_Stripe_Express_Checkout_Helper.
+ *
+ * @package WooCommerce_Stripe/Tests/WC_Stripe_Express_Checkout_Helper
+ */
+
+/**
+ * WC_Stripe_Express_Checkout_Helper class.
+ */
+class WC_Stripe_Express_Checkout_Helper_Test extends WP_UnitTestCase {
+	public function set_up() {
+		parent::set_up();
+
+		$stripe_settings                         = WC_Stripe_Helper::get_stripe_settings();
+		$stripe_settings['enabled']              = 'yes';
+		$stripe_settings['testmode']             = 'yes';
+		$stripe_settings['test_publishable_key'] = 'pk_test_key';
+		$stripe_settings['test_secret_key']      = 'sk_test_key';
+		WC_Stripe_Helper::update_main_stripe_settings( $stripe_settings );
+	}
+
+	/**
+	 * Test should_show_express_checkout_button, tax logic.
+	 */
+	public function test_hides_ece_if_cannot_compute_taxes() {
+		$wc_stripe_ece_helper_mock = $this->createPartialMock(
+			WC_Stripe_Express_Checkout_Helper::class,
+			[
+				'is_product',
+				'allowed_items_in_cart',
+				'should_show_ece_on_cart_page',
+				'should_show_ece_on_checkout_page',
+			]
+		);
+		$wc_stripe_ece_helper_mock->expects( $this->any() )->method( 'is_product' )->willReturn( false );
+		$wc_stripe_ece_helper_mock->expects( $this->any() )->method( 'allowed_items_in_cart' )->willReturn( true );
+		$wc_stripe_ece_helper_mock->expects( $this->any() )->method( 'should_show_ece_on_cart_page' )->willReturn( true );
+		$wc_stripe_ece_helper_mock->expects( $this->any() )->method( 'should_show_ece_on_checkout_page' )->willReturn( true );
+		$wc_stripe_ece_helper_mock->testmode = true;
+		if ( ! defined( 'WOOCOMMERCE_CHECKOUT' ) ) {
+			define( 'WOOCOMMERCE_CHECKOUT', true );
+		}
+
+		// Create virtual product and add to cart.
+		$virtual_product = WC_Helper_Product::create_simple_product();
+		$virtual_product->set_virtual( true );
+		$virtual_product->save();
+
+		WC()->session->init();
+		WC()->cart->add_to_cart( $virtual_product->get_id(), 1 );
+
+		// Hide if cart has virtual product and tax is based on shipping or billing address.
+		update_option( 'woocommerce_tax_based_on', 'billing' );
+		$this->assertFalse( $wc_stripe_ece_helper_mock->should_show_express_checkout_button() );
+
+		update_option( 'woocommerce_tax_based_on', 'shipping' );
+		$this->assertFalse( $wc_stripe_ece_helper_mock->should_show_express_checkout_button() );
+
+		// Do not hide if taxes are not based on customer billing or shipping address.
+		update_option( 'woocommerce_tax_based_on', 'base' );
+		$this->assertTrue( $wc_stripe_ece_helper_mock->should_show_express_checkout_button() );
+
+		// Do not hide if cart requires shipping.
+		$shippable_product = WC_Helper_Product::create_simple_product();
+		WC()->cart->add_to_cart( $shippable_product->get_id(), 1 );
+		$this->assertTrue( $wc_stripe_ece_helper_mock->should_show_express_checkout_button() );
+	}
+}