Resolve renewal failures for subscription orders with the UPE

changelog/fix-upe-subscriptions-schisms

@@ -0,0 +1,4 @@
+Significance: patch
+Type: fix
+
+Fixes subscription renewals with the UPE enabled.

includes/class-payment-information.php

@@ -31,14 +31,14 @@ class Payment_Information {
 	/**
 	 * The order object.
 	 *
-	 * @var \WC_Order/NULL
+	 * @var ?\WC_Order
 	 */
 	private $order;
 
 	/**
 	 * The payment token used for this payment.
 	 *
-	 * @var \WC_Payment_Token/NULL
+	 * @var ?\WC_Payment_Token
 	 */
 	private $token;
 
@@ -52,14 +52,14 @@ class Payment_Information {
 	/**
 	 * Indicates whether the payment is merchant-initiated (true) or customer-initiated (false).
 	 *
-	 * @var Payment_Initiated_By
+	 * @var ?Payment_Initiated_By
 	 */
 	private $payment_initiated_by;
 
 	/**
 	 * Indicates whether the payment will be only authorized (true) or captured immediately (false).
 	 *
-	 * @var Payment_Capture_Type
+	 * @var ?Payment_Capture_Type
 	 */
 	private $manual_capture;
 
@@ -175,9 +175,9 @@ public function get_payment_method(): string {
 	/**
 	 * Returns the order object.
 	 *
-	 * @return \WC_Order The order object.
+	 * @return ?\WC_Order The order object.
 	 */
-	public function get_order(): \WC_Order {
+	public function get_order(): ?\WC_Order {
 		return $this->order;
 	}
 
@@ -188,9 +188,9 @@ public function get_order(): \WC_Order {
 	 * since the return type is nullable, as per
 	 * https://www.php.net/manual/en/functions.returning-values.php#functions.returning-values.type-declaration
 	 *
-	 * @return \WC_Payment_Token/NULL The payment token.
+	 * @return ?\WC_Payment_Token The payment token.
 	 */
-	public function get_payment_token(): \WC_Payment_Token {
+	public function get_payment_token(): ?\WC_Payment_Token {
 		return $this->token;
 	}
 

includes/class-wc-payment-gateway-wcpay.php

@@ -1084,7 +1084,7 @@ public function process_payment_for_order( $cart, $payment_information, $schedul
 				throw new Exception( WC_Payments_Utils::get_filtered_error_message( $e ) );
 			}
 
-			$payment_methods = $this->get_payment_methods_from_request();
+			$payment_methods = $this->get_payment_method_types( $payment_information );
 			// The sanitize_user call here is deliberate: it seems the most appropriate sanitization function
 			// for a string that will only contain latin alphanumeric characters and underscores.
 			// phpcs:ignore WordPress.Security.NonceVerification.Missing
@@ -1231,7 +1231,7 @@ public function process_payment_for_order( $cart, $payment_information, $schedul
 					Payment_Method::CARD === $this->get_selected_stripe_payment_type_id() &&
 					in_array( Payment_Method::LINK, $this->get_upe_enabled_payment_method_ids(), true )
 					) {
-					$request->set_payment_method_types( $this->get_payment_methods_from_request() );
+					$request->set_payment_method_types( $this->get_payment_method_types( $payment_information ) );
 					$request->set_mandate_data( $this->get_mandate_data() );
 				}
 
@@ -1375,28 +1375,52 @@ public function process_payment_for_order( $cart, $payment_information, $schedul
 	 */
 	public function get_payment_method_to_use_for_intent() {
 		if ( WC_Payments_Features::is_upe_deferred_intent_enabled() ) {
-			return $this->get_payment_methods_from_request()[0];
+			$request_payment_method = sanitize_text_field( wp_unslash( $_POST['payment_method'] ?? '' ) ); // phpcs:ignore WordPress.Security.NonceVerification
+			return $this->get_payment_methods_from_gateway_id( $request_payment_method )[0];
 		}
 	}
 
 	/**
-	 * Get the payment methods used in the request.
+	 * Get payment method types to attach to intention request.
 	 *
+	 * @param Payment_Information $payment_information Payment information object for transaction.
 	 * @return array List of payment methods.
 	 */
-	private function get_payment_methods_from_request() {
-		$upe_payment_method = sanitize_text_field( wp_unslash( $_POST['payment_method'] ?? '' ) ); // phpcs:ignore WordPress.Security.NonceVerification
+	public function get_payment_method_types( $payment_information ) {
+		$request_payment_method = sanitize_text_field( wp_unslash( $_POST['payment_method'] ?? '' ) ); // phpcs:ignore WordPress.Security.NonceVerification
+		$token                  = $payment_information->get_payment_token();
+
+		if ( ! empty( $request_payment_method ) ) {
+			$payment_methods = $this->get_payment_methods_from_gateway_id( $request_payment_method );
+		} elseif ( ! is_null( $token ) ) {
+			$order           = $payment_information->get_order();
+			$order_id        = is_a( $order, 'WC_Order' ) ? $order->get_id() : null;
+			$payment_methods = $this->get_payment_methods_from_gateway_id( $token->get_gateway_id(), $order_id );
+		} else {
+			$payment_methods = WC_Payments::get_gateway()->get_payment_method_ids_enabled_at_checkout( null, true );
+		}
+
+		return $payment_methods;
+	}
 
-		if ( ! empty( $upe_payment_method ) && 'woocommerce_payments' !== $upe_payment_method ) {
-			$payment_methods = [ str_replace( 'woocommerce_payments_', '', $upe_payment_method ) ];
+	/**
+	 * Get the payment methods used in the request.
+	 *
+	 * @param string $gateway_id ID of processing payment gateway.
+	 * @param int    $order_id ID of related order, if applicable.
+	 * @return array List of payment methods.
+	 */
+	public function get_payment_methods_from_gateway_id( $gateway_id, $order_id = null ) {
+		if ( 'woocommerce_payments' !== $gateway_id ) {
+			$payment_methods = [ str_replace( 'woocommerce_payments_', '', $gateway_id ) ];
 		} elseif ( WC_Payments_Features::is_upe_split_enabled() || WC_Payments_Features::is_upe_deferred_intent_enabled() ) {
 			$payment_methods = [ 'card' ];
 			if ( WC_Payments_Features::is_upe_deferred_intent_enabled() &&
 				in_array( Payment_Method::LINK, $this->get_upe_enabled_payment_method_ids(), true ) ) {
 				$payment_methods[] = Payment_Method::LINK;
 			}
 		} else {
-			$payment_methods = WC_Payments::get_gateway()->get_payment_method_ids_enabled_at_checkout( null, true );
+			$payment_methods = WC_Payments::get_gateway()->get_payment_method_ids_enabled_at_checkout( $order_id, true );
 		}
 
 		return $payment_methods;

tests/unit/payment-methods/test-class-upe-payment-gateway.php

@@ -280,6 +280,7 @@ public function set_up() {
 		// so that get_payment_method_from_request() does not throw error.
 		$_POST = [
 			'wcpay-payment-method' => 'pm_mock',
+			'payment_method'       => UPE_Payment_Gateway::GATEWAY_ID,
 		];
 	}
 
@@ -834,7 +835,6 @@ public function test_create_setup_intent_no_customer() {
 
 	public function test_process_payment_returns_correct_redirect_url() {
 		$order                         = WC_Helper_Order::create_order();
-		$order_id                      = $order->get_id();
 		$_POST['wc_payment_intent_id'] = 'pi_mock';
 
 		$payment_intent = WC_Helper_Intention::create_intention( [ 'status' => Payment_Intent_Status::PROCESSING ] );
@@ -859,7 +859,6 @@ public function test_process_payment_returns_correct_redirect_url() {
 
 	public function test_process_payment_passes_save_payment_method_to_store() {
 		$order                         = WC_Helper_Order::create_order();
-		$order_id                      = $order->get_id();
 		$gateway_id                    = UPE_Payment_Gateway::GATEWAY_ID;
 		$save_payment_param            = "wc-$gateway_id-new-payment-method";
 		$_POST[ $save_payment_param ]  = 'yes';
@@ -919,11 +918,12 @@ public function test_process_payment_returns_correct_redirect_when_using_saved_p
 
 		$this->set_cart_contains_subscription_items( false );
 
-		$result = $this->mock_upe_gateway->process_payment( $order->get_id() );
-
 		$this->mock_upe_gateway
 			->expects( $this->never() )
 			->method( 'manage_customer_details_for_order' );
+
+		$result = $this->mock_upe_gateway->process_payment( $order->get_id() );
+
 		$this->assertEquals( 'success', $result['result'] );
 		$this->assertMatchesRegularExpression( '/key=mock_order_key/', $result['redirect'] );
 	}