Use recommended order currency API for multicurrency subscription renewal | switch | resubscribe (#4228)

* use recommended `WC_Order::get_currency()` for getting renewal currency:
- previously used raw `get_post_meta()`
- this is no longer recommended, and could break on stores using
(forthcoming) custom order tables

* add changelog

* convert id to order/subscription object before calling get_currency:
- fix logic issue in previous commit

* fix fatal error on resubscribe – get subscription from ID

* fix override_selected_currency test for renewal case:
- Make a real order with non-default currency - integration test style.
- Enhance mock_wcs_cart_contains_renewal so test can customise
  product and renewal order ids.
- Mock the real order instead of hacking post meta (legacy implementation detail).
- Fix up all uses of mock_wcs_cart_contains_renewal() for new signature.

* Repair multicurrency sub switch unit test:
- Rename / update comment to clarify test scope.
- Mock up a real order (aka subscription) with custom currency.
- Mock that order idea in $_GET request params.

* repair multicurrency subs switch in cart unit test:
- use WC_Order for mock subscription
- mock subscription and cart APIs as needed

* refactor mock_wcs_get_order_type_cart_items so can pass a real order id

* repair multicurrency sub resubscribe unit test:
- parameterise wcs_get_order_type_cart_items so can use real order id
- mock sub (order) and wcs_get_subscription to return mocked sub
- it's fine right

* remove a bunch of extraneous whitespace / php linter fixes

* remove extraneous whitespace / php linter fixes

* add local wrapper for wcs_get_subscription() – attempt psalm fix:
- ERROR: UndefinedFunction
$switch_subscription = wcs_get_subscription( $switch_cart_item['subscription_switch']['subscription_id'] );

* fix mismatched param name in docblock for get_subscription wrapper

* remove incorrect return type (array) from get_subscription test helper +
+ clarify true type in docblock comment

* remove whitespace offending the linter

* rename subscription variable – it's resubscribe not switch

Co-authored-by: Rua Haszard <[email protected]>

Author: haszari

changelog/fix-4152-subscribe-renew-multicurrency-order-meta-api

@@ -0,0 +1,4 @@
+Significance: minor
+Type: fix
+
+Use high-level order currency API for multicurrency subscription renewal orders (get_post_meta is not recommended for orders).

includes/multi-currency/Compatibility/WooCommerceSubscriptions.php

@@ -148,7 +148,8 @@ public function override_selected_currency( $return ) {
 
 		$subscription_renewal = $this->cart_contains_renewal();
 		if ( $subscription_renewal ) {
-			return get_post_meta( $subscription_renewal['subscription_renewal']['renewal_order_id'], '_order_currency', true );
+			$order = wc_get_order( $subscription_renewal['subscription_renewal']['renewal_order_id'] );
+			return $order ? $order->get_currency() : $return;
 		}
 
 		$switch_id = $this->get_subscription_switch_id_from_superglobal();
@@ -158,13 +159,15 @@ public function override_selected_currency( $return ) {
 
 		$switch_cart_items = $this->get_subscription_switch_cart_items();
 		if ( 0 < count( $switch_cart_items ) ) {
-			$switch_cart_item = array_shift( $switch_cart_items );
-			return get_post_meta( $switch_cart_item['subscription_switch']['subscription_id'], '_order_currency', true );
+			$switch_cart_item    = array_shift( $switch_cart_items );
+			$switch_subscription = $this->get_subscription( $switch_cart_item['subscription_switch']['subscription_id'] );
+			return $switch_subscription ? $switch_subscription->get_currency() : $return;
 		}
 
 		$subscription_resubscribe = $this->cart_contains_resubscribe();
 		if ( $subscription_resubscribe ) {
-			return get_post_meta( $subscription_resubscribe['subscription_resubscribe']['subscription_id'], '_order_currency', true );
+			$subscription = $this->get_subscription( $subscription_resubscribe['subscription_resubscribe']['subscription_id'] );
+			return $subscription ? $subscription->get_currency() : $return;
 		}
 
 		return $return;
@@ -293,6 +296,21 @@ private function get_subscription_switch_cart_items(): array {
 		return wcs_get_order_type_cart_items( 'switch' );
 	}
 
+	/**
+	 * Getter for subscription objects.
+	 *
+	 * @param  mixed $the_subscription Post object or post ID of the order.
+	 * @return mixed The subscription object, or false if it cannot be found.
+	 *               Note: this is WC_Subscription|bool in normal use, but in tests
+	 *               we use WC_Order to simulate a subscription (hence `mixed`).
+	 */
+	private function get_subscription( $the_subscription ) {
+		if ( ! function_exists( 'wcs_get_subscription' ) ) {
+			return false;
+		}
+		return wcs_get_subscription( $the_subscription );
+	}
+
 	/**
 	 * Checks $_GET superglobal for a switch id and returns it if found.
 	 *