Add order lock for legacy redirect payments (#3442)

* add order lock during legacy redirect payments

* address feedback

* unlock before retry

* add changelog entry

Author: Mayisha

changelog.txt

@@ -30,6 +30,7 @@
 * Fix - Resolved an issue which caused the WeChat Pay payment icon to not be displayed on shortcode checkout pages.
 * Fix - Set order payment method title to the customizable title setting rather than the default label.
 * Fix - Update Cash App payments to avoid confirming on creation, resolving issues with generic payment failures in live mode.
+* Tweak - Add order lock for redirect payments.
 
 = 8.7.0 - 2024-09-16 =
 * Add - Introduces a new promotional surface to encourage merchants with the legacy checkout experience and APMs enabled to use the new checkout experience.

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

@@ -82,6 +82,11 @@ public function process_redirect_payment( $order_id, $retry = true, $previous_er
 
 			WC_Stripe_Logger::log( "Info: (Redirect) Begin processing payment for order $order_id for the amount of {$order->get_total()}" );
 
+			// Lock the order or return if the order is already locked.
+			if ( $this->lock_order_payment( $order ) ) {
+				return;
+			}
+
 			/**
 			 * First check if the source is chargeable at this time. If not,
 			 * webhook will take care of it later.
@@ -142,6 +147,9 @@ public function process_redirect_payment( $order_id, $retry = true, $previous_er
 
 				// We want to retry.
 				if ( $this->is_retryable_error( $response->error ) ) {
+					// Unlock the order before retrying.
+					$this->unlock_order_payment( $order );
+
 					if ( $retry ) {
 						// Don't do anymore retries after this.
 						if ( 5 <= $this->retry_interval ) {
@@ -187,10 +195,16 @@ public function process_redirect_payment( $order_id, $retry = true, $previous_er
 			/* translators: error message */
 			$order->update_status( 'failed', sprintf( __( 'Stripe payment failed: %s', 'woocommerce-gateway-stripe' ), $e->getLocalizedMessage() ) );
 
+			// Unlock the order.
+			$this->unlock_order_payment( $order );
+
 			wc_add_notice( $e->getLocalizedMessage(), 'error' );
 			wp_safe_redirect( wc_get_checkout_url() );
 			exit;
 		}
+
+		// Unlock the order.
+		$this->unlock_order_payment( $order );
 	}
 
 	/**

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

@@ -220,6 +220,10 @@ public function process_webhook_payment( $notification, $retry = true ) {
 
 		$is_pending_receiver = ( 'receiver' === $notification->data->object->flow );
 
+		if ( $this->lock_order_payment( $order ) ) {
+			return;
+		}
+
 		try {
 			if ( $order->has_status( [ 'processing', 'completed' ] ) ) {
 				return;
@@ -264,6 +268,9 @@ public function process_webhook_payment( $notification, $retry = true ) {
 
 				// We want to retry.
 				if ( $this->is_retryable_error( $response->error ) ) {
+					// Unlock the order before retrying.
+					$this->unlock_order_payment( $order );
+
 					if ( $retry ) {
 						// Don't do anymore retries after this.
 						if ( 5 <= $this->retry_interval ) {
@@ -315,6 +322,8 @@ public function process_webhook_payment( $notification, $retry = true ) {
 				$this->send_failed_order_email( $order_id );
 			}
 		}
+
+		$this->unlock_order_payment( $order );
 	}
 
 	/**

readme.txt

@@ -158,5 +158,6 @@ If you get stuck, you can ask for help in the Plugin Forum.
 * Fix - Resolved an issue which caused the WeChat Pay payment icon to not be displayed on shortcode checkout pages.
 * Fix - Set order payment method title to the customizable title setting rather than the default label.
 * Fix - Update Cash App payments to avoid confirming on creation, resolving issues with generic payment failures in live mode.
+* Tweak - Add order lock for redirect payments.
 
 [See changelog for all versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).