Fix currency change for manual subscription renewal. (#5404)

* Fix currency change for manual subscription renewal.

* Add tests for new renewal check, also allow continued checks if false is returned.

* Add changelog

* Fix property assignment type

* Update running filters property

Author: jessepearson

changelog/fix-5356-currency-change-for-manual-subscription-renewal

@@ -0,0 +1,4 @@
+Significance: patch
+Type: fix
+
+Fix ability to change currency when a subscription renewal is in the cart.

includes/multi-currency/Compatibility/WooCommerceSubscriptions.php

@@ -9,7 +9,6 @@
 
 use WC_Payments_Features;
 use WCPay\MultiCurrency\MultiCurrency;
-use WCPay\MultiCurrency\Utils;
 
 /**
  * Class that controls Multi Currency Compatibility with WooCommerce Subscriptions Plugin and WCPay Subscriptions.
@@ -23,6 +22,13 @@ class WooCommerceSubscriptions extends BaseCompatibility {
 	 */
 	public $switch_cart_item = '';
 
+	/**
+	 * If we are running through our filters.
+	 *
+	 * @var bool
+	 */
+	private $running_override_selected_currency_filters = false;
+
 	/**
 	 * Init the class.
 	 *
@@ -142,7 +148,7 @@ public function maybe_disable_mixed_cart( $value ) {
 	 */
 	public function override_selected_currency( $return ) {
 		// If it's not false, return it.
-		if ( $return ) {
+		if ( $return || $this->running_override_selected_currency_filters ) {
 			return $return;
 		}
 
@@ -152,6 +158,16 @@ public function override_selected_currency( $return ) {
 			return $order ? $order->get_currency() : $return;
 		}
 
+		// The running_override_selected_currency_filters property has been added here due to if it isn't, it will create an infinite loop of calls.
+		if ( WC()->session->get( 'order_awaiting_payment' ) ) {
+			$this->running_override_selected_currency_filters = true;
+			$order = wc_get_order( WC()->session->get( 'order_awaiting_payment' ) );
+			$this->running_override_selected_currency_filters = false;
+			if ( $order && $this->order_contains_renewal( $order ) ) {
+				return $order->get_currency();
+			}
+		}
+
 		$switch_id = $this->get_subscription_switch_id_from_superglobal();
 		if ( $switch_id ) {
 			return get_post_meta( $switch_id, '_order_currency', true );
@@ -284,6 +300,20 @@ private function cart_contains_renewal() {
 		return wcs_cart_contains_renewal();
 	}
 
+	/**
+	 * Checks an order  to see if it contains a subscription product renewal.
+	 *
+	 * @param object $order Order object.
+	 *
+	 * @return bool The cart item containing the renewal as an array, else false.
+	 */
+	private function order_contains_renewal( $order ): bool {
+		if ( ! function_exists( 'wcs_order_contains_renewal' ) ) {
+			return false;
+		}
+		return wcs_order_contains_renewal( $order );
+	}
+
 	/**
 	 * Gets the subscription switch items out of the cart.
 	 *

tests/unit/helpers/class-wc-helper-subscriptions.php

@@ -76,6 +76,13 @@ function wcs_get_subscriptions( $args ) {
 	return ( WC_Subscriptions::$wcs_get_subscriptions )( $args );
 }
 
+function wcs_order_contains_renewal() {
+	if ( ! WC_Subscriptions::$wcs_order_contains_renewal ) {
+		return;
+	}
+	return ( WC_Subscriptions::$wcs_order_contains_renewal )();
+}
+
 /**
  * Class WC_Subscriptions.
  *
@@ -159,6 +166,13 @@ class WC_Subscriptions {
 	 */
 	public static $wcs_create_renewal_order = null;
 
+	/**
+	 * wcs_order_contains_renewal mock.
+	 *
+	 * @var function
+	 */
+	public static $wcs_order_contains_renewal = null;
+
 	public static function set_wcs_order_contains_subscription( $function ) {
 		self::$wcs_order_contains_subscription = $function;
 	}
@@ -198,4 +212,8 @@ public static function wcs_cart_contains_resubscribe( $function ) {
 	public static function wcs_create_renewal_order( $function ) {
 		self::$wcs_create_renewal_order = $function;
 	}
+
+	public static function wcs_order_contains_renewal( $function ) {
+		self::$wcs_order_contains_renewal = $function;
+	}
 }

tests/unit/multi-currency/compatibility/test-class-woocommerce-subscriptions.php

@@ -272,12 +272,42 @@ public function test_override_selected_currency_return_currency_code_when_renewa
 		$order->set_currency( 'JPY' );
 		$order->save();
 
-		// Mock that order as the renewal in the cart.
+		// Mock that order has the renewal in the cart.
 		$this->mock_wcs_cart_contains_renewal( 42, $order->get_id() );
 
 		$this->assertSame( 'JPY', $this->woocommerce_subscriptions->override_selected_currency( false ) );
 	}
 
+	// Returns order currency code when order awaiting payment has renewal in it.
+	public function test_override_selected_currency_returns_order_currency_code_when_order_awaiting_payment_has_renewal() {
+		// Set up an order with a non-default currency.
+		$order = WC_Helper_Order::create_order();
+		$order->set_currency( 'JPY' );
+		$order->save();
+		WC()->session->set( 'order_awaiting_payment', $order->get_id() );
+
+		// Mock that order has the renewal in the cart.
+		$this->mock_wcs_cart_contains_renewal( false );
+		$this->mock_wcs_order_contains_renewal( true );
+
+		$this->assertSame( 'JPY', $this->woocommerce_subscriptions->override_selected_currency( false ) );
+	}
+
+	// Returns false when order awaiting payment does not have a renewal in it.
+	public function test_override_selected_currency_return_false_when_order_awaiting_payment_has_no_renewal() {
+		// Set up an order with a non-default currency.
+		$order = WC_Helper_Order::create_order();
+		$order->set_currency( 'JPY' );
+		$order->save();
+		WC()->session->set( 'order_awaiting_payment', $order->get_id() );
+
+		// Mock that order  renewal in the cart.
+		$this->mock_wcs_cart_contains_renewal( false );
+		$this->mock_wcs_order_contains_renewal( false );
+
+		$this->assertFalse( $this->woocommerce_subscriptions->override_selected_currency( false ) );
+	}
+
 	// Test correct currency when shopper clicks upgrade/downgrade button in My Account – "switch".
 	public function test_override_selected_currency_return_currency_code_for_switch_request() {
 		// Reset/clear any previous mocked state.
@@ -628,4 +658,12 @@ function () use ( $subscription_id ) {
 			}
 		);
 	}
+
+	private function mock_wcs_order_contains_renewal( $renewal = false ) {
+		WC_Subscriptions::wcs_order_contains_renewal(
+			function () use ( $renewal ) {
+				return $renewal;
+			}
+		);
+	}
 }