Fix UPE payment webhook race condition (#2540)

* Fix race condition when paying via UPE

Both the webhook processing and the UPE redirect processing call the
`process_response` function which marks the payment as completed. This
will cause the UPE redirect processing to fail due to the order status
if the webhook is processed before the customer is redirected, e.g.
when the customer is on a slow network connection.

This commit fixes that by adding metadata to the order that the webhook
controller can check for before processing the webhook.

Author: reykjalin

changelog.txt

@@ -2,6 +2,7 @@
 
 = 7.1.0 - 2023-xx-xx =
 * Fix - Replace some post meta methods with equivalent methods compatible with HPOS.
+* Fix - Rare cases of payment processing failing when webhooks arrive before customer is redirected when UPE is enabled will no longer occur.
 
 = 7.0.2 - 2023-01-11 =
 * Fix - Expand charges object from incoming webhooks using Stripe API version 2022-11-15.

includes/class-wc-stripe-webhook-handler.php

@@ -871,6 +871,14 @@ public function process_payment_intent_success( $notification ) {
 
 				WC_Stripe_Logger::log( "Stripe PaymentIntent $intent->id succeeded for order $order_id" );
 
+				// TODO: This is a stop-gap to fix a critical issue, see
+				// https://github.com/woocommerce/woocommerce-gateway-stripe/issues/2536. It would
+				// be better if we removed the need for additional meta data in favor of refactoring
+				// this part of the payment processing.
+				if ( $order->get_meta( '_stripe_upe_waiting_for_redirect' ) ?? false ) {
+					return;
+				}
+
 				do_action( 'wc_gateway_stripe_process_payment', $charge, $order );
 
 				// Process valid response.

includes/payment-methods/class-wc-stripe-upe-payment-gateway.php

@@ -575,6 +575,13 @@ public function process_payment( $order_id, $retry = true, $force_save_source =
 				WC_Stripe_Helper::add_payment_intent_to_order( $payment_intent_id, $order );
 				$order->update_status( 'pending', __( 'Awaiting payment.', 'woocommerce-gateway-stripe' ) );
 				$order->update_meta_data( '_stripe_upe_payment_type', $selected_upe_payment_type );
+
+				// TODO: This is a stop-gap to fix a critical issue, see
+				// https://github.com/woocommerce/woocommerce-gateway-stripe/issues/2536. It would
+				// be better if we removed the need for additional meta data in favor of refactoring
+				// this part of the payment processing.
+				$order->update_meta_data( '_stripe_upe_waiting_for_redirect', true );
+
 				$order->save();
 
 				$this->stripe_request(
@@ -943,6 +950,13 @@ public function process_order_for_confirmed_intent( $order, $intent_id, $save_pa
 		$this->save_intent_to_order( $order, $intent );
 		$this->set_payment_method_title_for_order( $order, $payment_method_type );
 		$order->update_meta_data( '_stripe_upe_redirect_processed', true );
+
+		// TODO: This is a stop-gap to fix a critical issue, see
+		// https://github.com/woocommerce/woocommerce-gateway-stripe/issues/2536. It would
+		// be better if we removed the need for additional meta data in favor of refactoring
+		// this part of the payment processing.
+		$order->delete_meta_data( '_stripe_upe_waiting_for_redirect' );
+
 		$order->save();
 	}
 

tests/phpunit/test-class-wc-stripe-upe-payment-gateway.php

@@ -239,6 +239,7 @@ public function test_process_payment_returns_valid_response() {
 
 		$order->update_meta_data( '_stripe_intent_id', $payment_intent_id );
 		$order->update_meta_data( '_stripe_upe_payment_type', '' );
+		$order->update_meta_data( '_stripe_upe_waiting_for_redirect', true );
 		$order->save();
 
 		list( $amount, $description, $metadata ) = $this->get_order_details( $order );
@@ -1038,6 +1039,7 @@ public function test_if_order_has_subscription_payment_method_will_be_saved() {
 
 		$order->update_meta_data( '_stripe_intent_id', $payment_intent_id );
 		$order->update_meta_data( '_stripe_upe_payment_type', '' );
+		$order->update_meta_data( '_stripe_upe_waiting_for_redirect', true );
 		$order->save();
 
 		list( $amount, $description, $metadata ) = $this->get_order_details( $order );