Patch: Fix subscription renewals exceptions by reverting billing addr…

…ess related PRs (#8689) Co-authored-by: Timur Karimov <[email protected]> Co-authored-by: Timur Karimov <[email protected]> Co-authored-by: Daniel Mallory <[email protected]> Co-authored-by: Daniel Mallory <[email protected]>
Automattic · Apr 22, 2024 · 37e4d9f · 37e4d9f
1 parent f9419e1
commit 37e4d9f
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 193 deletions.
diff --git a/changelog/fix-subscription-renewal b/changelog/fix-subscription-renewal
@@ -0,0 +1,4 @@
+Significance: patch
+Type: fix
+
+Fix subscription renewals exceptions
diff --git a/changelog/remove-deprecated-param-from-asset-data-registry b/changelog/remove-deprecated-param-from-asset-data-registry
@@ -0,0 +1,4 @@
+Significance: minor
+Type: dev
+
+Remove deprecated param from asset data registry interface.
diff --git a/includes/class-wc-payment-gateway-wcpay.php b/includes/class-wc-payment-gateway-wcpay.php
@@ -1402,6 +1402,19 @@ public function process_payment_for_order( $cart, $payment_information, $schedul
 		];
 		list( $user, $customer_id ) = $this->manage_customer_details_for_order( $order, $customer_details_options );
 
+		// Update saved payment method async to include billing details, if missing.
+		if ( $payment_information->is_using_saved_payment_method() ) {
+			$this->action_scheduler_service->schedule_job(
+				time(),
+				self::UPDATE_SAVED_PAYMENT_METHOD,
+				[
+					'payment_method' => $payment_information->get_payment_method(),
+					'order_id'       => $order->get_id(),
+					'is_test_mode'   => WC_Payments::mode()->is_test(),
+				]
+			);
+		}
+
 		$intent_failed  = false;
 		$payment_needed = $amount > 0;
 
@@ -1419,16 +1432,6 @@ public function process_payment_for_order( $cart, $payment_information, $schedul
 				// We need to make sure the saved payment method is saved to the order so we can
 				// charge the payment method for a future payment.
 				$this->add_token_to_order( $order, $payment_information->get_payment_token() );
-				// If we are not hitting the API for the intent, we need to update the saved payment method ourselves.
-				$this->action_scheduler_service->schedule_job(
-					time(),
-					self::UPDATE_SAVED_PAYMENT_METHOD,
-					[
-						'payment_method' => $payment_information->get_payment_method(),
-						'order_id'       => $order->get_id(),
-						'is_test_mode'   => WC_Payments::mode()->is_test(),
-					]
-				);
 			}
 
 			if ( $is_changing_payment_method_for_subscription && $payment_information->is_using_saved_payment_method() ) {
@@ -1511,16 +1514,6 @@ public function process_payment_for_order( $cart, $payment_information, $schedul
 				$request->set_payment_methods( $payment_methods );
 				$request->set_cvc_confirmation( $payment_information->get_cvc_confirmation() );
 				$request->set_hook_args( $payment_information );
-				if ( $payment_information->is_using_saved_payment_method() ) {
-					$billing_details = WC_Payments_Utils::get_billing_details_from_order( $order, $payment_information->is_merchant_initiated() );
-
-					$is_legacy_card_object = strpos( $payment_information->get_payment_method() ?? '', 'card_' ) === 0;
-
-					// Not updating billing details for legacy card objects because they have a different structure and are no longer supported.
-					if ( ! empty( $billing_details ) && ! $is_legacy_card_object ) {
-						$request->set_payment_method_update_data( [ 'billing_details' => $billing_details ] );
-					}
-				}
 				// Add specific payment method parameters to the request.
 				$this->modify_create_intent_parameters_when_processing_payment( $request, $payment_information, $order );
 

diff --git a/includes/class-wc-payments-utils.php b/includes/class-wc-payments-utils.php
@@ -338,62 +338,29 @@ public static function map_search_orders_to_charge_ids( $search ) {
 	}
 
 	/**
-	 * Extract the billing details from the WC order.
-	 * It only returns the fields that are present in the billing section of the checkout.
+	 * Extract the billing details from the WC order
 	 *
 	 * @param WC_Order $order Order to extract the billing details from.
-	 * @param bool     $legacy Whether to use the legacy way of loading straight from the order.
-	 * @todo The $legacy flag is just a patch for the current approach, fixing the linked issue.
-	 * @see https://github.com/Automattic/woocommerce-payments/issues/8678
 	 *
 	 * @return array
 	 */
-	public static function get_billing_details_from_order( $order, $legacy = true ) {
-		if ( $legacy ) {
-			$billing_details = [
-				'address' => [
-					'city'        => $order->get_billing_city(),
-					'country'     => $order->get_billing_country(),
-					'line1'       => $order->get_billing_address_1(),
-					'line2'       => $order->get_billing_address_2(),
-					'postal_code' => $order->get_billing_postcode(),
-					'state'       => $order->get_billing_state(),
-				],
-				'email'   => $order->get_billing_email(),
-				'name'    => trim( $order->get_formatted_billing_full_name() ),
-				'phone'   => $order->get_billing_phone(),
-			];
-
-			return array_filter( $billing_details );
-		}
-
-		$billing_fields       = array_keys( WC()->checkout()->get_checkout_fields( 'billing' ) );
-		$address_field_to_key = [
-			'billing_city'      => 'city',
-			'billing_country'   => 'country',
-			'billing_address_1' => 'line1',
-			'billing_address_2' => 'line2',
-			'billing_postcode'  => 'postal_code',
-			'billing_state'     => 'state',
+	public static function get_billing_details_from_order( $order ) {
+		$billing_details = [
+			'address' => [
+				'city'        => $order->get_billing_city(),
+				'country'     => $order->get_billing_country(),
+				'line1'       => $order->get_billing_address_1(),
+				'line2'       => $order->get_billing_address_2(),
+				'postal_code' => $order->get_billing_postcode(),
+				'state'       => $order->get_billing_state(),
+			],
+			'email'   => $order->get_billing_email(),
+			'name'    => trim( $order->get_formatted_billing_full_name() ),
+			'phone'   => $order->get_billing_phone(),
 		];
-		$field_to_key         = [
-			'billing_email' => 'email',
-			'billing_phone' => 'phone',
-		];
-		$billing_details      = [ 'address' => [] ];
-		foreach ( $billing_fields as $field ) {
-			if ( isset( $address_field_to_key[ $field ] ) ) {
-				$billing_details['address'][ $address_field_to_key[ $field ] ] = $order->{"get_{$field}"}();
-			} elseif ( isset( $field_to_key[ $field ] ) ) {
-				$billing_details[ $field_to_key[ $field ] ] = $order->{"get_{$field}"}();
-			}
-		}
-
-		if ( in_array( 'billing_first_name', $billing_fields, true ) && in_array( 'billing_last_name', $billing_fields, true ) ) {
-			$billing_details['name'] = trim( $order->get_formatted_billing_full_name() );
-		}
 
-		return $billing_details;
+		$billing_details['address'] = array_filter( $billing_details['address'] );
+		return array_filter( $billing_details );
 	}
 
 	/**

diff --git a/includes/core/server/request/class-create-and-confirm-intention.php b/includes/core/server/request/class-create-and-confirm-intention.php
@@ -20,7 +20,6 @@ class Create_And_Confirm_Intention extends Create_Intention {
 		'amount',
 		'currency',
 		'payment_method',
-		'payment_method_update_data',
 		'return_url',
 	];
 
@@ -91,17 +90,6 @@ public function set_payment_methods( array $payment_methods ) {
 		$this->set_param( 'payment_method_types', $payment_methods );
 	}
 
-	/**
-	 * Payment method update data setter.
-	 *
-	 * @param array $payment_method_update_data Data to update on payment method.
-	 *
-	 * @return void
-	 */
-	public function set_payment_method_update_data( array $payment_method_update_data ) {
-		$this->set_param( 'payment_method_update_data', $payment_method_update_data );
-	}
-
 	/**
 	 * CVC confirmation setter.
 	 *

diff --git a/tests/unit/core/service/test-class-wc-payments-customer-service-api.php b/tests/unit/core/service/test-class-wc-payments-customer-service-api.php
@@ -342,7 +342,6 @@ function ( $data ): bool {
 								'city'        => $order->get_billing_city(),
 								'country'     => $order->get_billing_country(),
 								'line1'       => $order->get_billing_address_1(),
-								'line2'       => $order->get_billing_address_2(),
 								'postal_code' => $order->get_billing_postcode(),
 								'state'       => $order->get_billing_state(),
 							],

diff --git a/tests/unit/test-class-wc-payment-gateway-wcpay-process-payment.php b/tests/unit/test-class-wc-payment-gateway-wcpay-process-payment.php
@@ -1209,8 +1209,17 @@ public function test_updates_payment_method_billing_details() {
 			->willReturn( $intent );
 
 		$this->mock_action_scheduler_service
-			->expects( $this->never() )
-			->method( 'schedule_job' );
+			->expects( $this->once() )
+			->method( 'schedule_job' )
+			->with(
+				$this->anything(),
+				WC_Payment_Gateway_WCPay::UPDATE_SAVED_PAYMENT_METHOD,
+				[
+					'payment_method' => 'pm_mock',
+					'order_id'       => $order_id,
+					'is_test_mode'   => false,
+				]
+			);
 
 		$this->mock_wcpay_gateway->process_payment( $order_id );
 	}

diff --git a/tests/unit/test-class-wc-payment-gateway-wcpay.php b/tests/unit/test-class-wc-payment-gateway-wcpay.php
@@ -257,18 +257,6 @@ public function set_up() {
 			->method( 'get_payment_metadata' )
 			->willReturn( [] );
 		wcpay_get_test_container()->replace( OrderService::class, $mock_order_service );
-		$checkout_fields                  = [
-			'billing' => [
-				'billing_company'   => '',
-				'billing_country'   => '',
-				'billing_address_1' => '',
-				'billing_address_2' => '',
-				'billing_city'      => '',
-				'billing_state'     => '',
-				'billing_phone'     => '',
-			],
-		];
-		WC()->checkout()->checkout_fields = $checkout_fields;
 	}
 
 	/**
@@ -304,7 +292,6 @@ public function tear_down() {
 		}
 
 		wcpay_get_test_container()->reset_all_replacements();
-		WC()->checkout()->checkout_fields = null;
 	}
 
 	public function test_process_redirect_payment_intent_processing() {
@@ -2442,72 +2429,6 @@ public function test_process_payment_for_order_not_from_request() {
 		$this->card_gateway->process_payment_for_order( WC()->cart, $pi );
 	}
 
-	public function test_no_billing_details_update_for_legacy_card_object() {
-		$legacy_card = 'card_mock';
-
-		// There is no payment method data within the request. This is the case e.g. for the automatic subscription renewals.
-		$_POST['payment_method'] = '';
-
-		$token = WC_Helper_Token::create_token( $legacy_card );
-
-		$order = WC_Helper_Order::create_order();
-		$order->set_currency( 'USD' );
-		$order->set_total( 100 );
-		$order->add_payment_token( $token );
-		$order->save();
-
-		$pi             = new Payment_Information( $legacy_card, $order, null, $token, null, null, null, '', 'card' );
-		$payment_intent = WC_Helper_Intention::create_intention(
-			[
-				'status' => 'success',
-			]
-		);
-
-		$request = $this->mock_wcpay_request( Create_And_Confirm_Intention::class );
-
-		$request->expects( $this->once() )
-			->method( 'format_response' )
-			->will( $this->returnValue( $payment_intent ) );
-
-		$request->expects( $this->never() )
-			->method( 'set_payment_method_update_data' );
-
-		$this->card_gateway->process_payment_for_order( WC()->cart, $pi );
-	}
-
-	public function test_billing_details_update_if_not_empty() {
-		// There is no payment method data within the request. This is the case e.g. for the automatic subscription renewals.
-		$_POST['payment_method'] = '';
-
-		$token = WC_Helper_Token::create_token( 'pm_mock' );
-
-		$expected_upe_payment_method = 'card';
-		$order                       = WC_Helper_Order::create_order();
-		$order->set_currency( 'USD' );
-		$order->set_total( 100 );
-		$order->add_payment_token( $token );
-		$order->save();
-
-		$pi = new Payment_Information( 'pm_mock', $order, null, $token, null, null, null, '', 'card' );
-
-		$payment_intent = WC_Helper_Intention::create_intention(
-			[
-				'status' => 'success',
-			]
-		);
-
-		$request = $this->mock_wcpay_request( Create_And_Confirm_Intention::class );
-
-		$request->expects( $this->once() )
-			->method( 'format_response' )
-			->will( $this->returnValue( $payment_intent ) );
-
-		$request->expects( $this->once() )
-			->method( 'set_payment_method_update_data' );
-
-		$this->card_gateway->process_payment_for_order( WC()->cart, $pi );
-	}
-
 	public function test_process_payment_for_order_rejects_with_cached_minimum_amount() {
 		set_transient( 'wcpay_minimum_amount_usd', '50', DAY_IN_SECONDS );
 

diff --git a/tests/unit/test-class-wc-payments-customer-service.php b/tests/unit/test-class-wc-payments-customer-service.php
@@ -484,39 +484,10 @@ public function test_update_payment_method_with_billing_details_from_order() {
 				[
 					'billing_details' => [
 						'address' => [
+							'city'        => 'WooCity',
 							'country'     => Country_Code::UNITED_STATES,
 							'line1'       => 'WooAddress',
-							'line2'       => '',
-							'city'        => 'WooCity',
-							'state'       => 'NY',
 							'postal_code' => '12345',
-						],
-						'phone'   => '555-32123',
-						'email'   => '[email protected]',
-						'name'    => 'Jeroen Sormani',
-					],
-				]
-			);
-
-		$order = WC_Helper_Order::create_order();
-
-		$this->customer_service->update_payment_method_with_billing_details_from_order( 'pm_mock', $order );
-	}
-
-	public function test_update_payment_method_with_billing_details_from_checkout_fields() {
-		$this->mock_api_client
-			->expects( $this->once() )
-			->method( 'update_payment_method' )
-			->with(
-				'pm_mock',
-				[
-					'billing_details' => [
-						'address' => [
-							'postal_code' => '12345',
-							'city'        => 'WooCity',
-							'country'     => 'US',
-							'line1'       => 'WooAddress',
-							'line2'       => '',
 							'state'       => 'NY',
 						],
 						'email'   => '[email protected]',