Merge pull request #3518 from woocommerce/PCP-4951-fix-contacts-race-condition-in-block

Fix contacts race condition in block

Author: Dinamiko

modules/ppcp-wc-gateway/src/Gateway/PayPalGateway.php

@@ -61,6 +61,10 @@ class PayPalGateway extends \WC_Payment_Gateway {
 	public const THREE_D_AUTH_RESULT_META_KEY  = '_ppcp_paypal_3DS_auth_result';
 	public const FRAUD_RESULT_META_KEY         = '_ppcp_paypal_fraud_result';
 
+	// Used by the Contact Module integration.
+	public const CONTACT_EMAIL_META_KEY = '_ppcp_paypal_contact_email';
+	public const CONTACT_PHONE_META_KEY = '_ppcp_paypal_contact_phone';
+
 	// Used by the Contact Module integration to store the original details.
 	public const ORIGINAL_EMAIL_META_KEY = '_ppcp_paypal_billing_email';
 	public const ORIGINAL_PHONE_META_KEY = '_ppcp_paypal_billing_phone';

modules/ppcp-wc-gateway/src/Processor/OrderMetaTrait.php

@@ -66,16 +66,10 @@ public function add_paypal_meta(
 	}
 
 	/**
-	 * Swaps out the billing details with the custom contact details provided by PayPal via the
-	 * "Contact Module" integration.
-	 *
-	 * The contact module can provide a custom email and phone number via the shipping details;
-	 * Though it's part of the shipping object, these two properties are intended to be treated
-	 * as primary contact details.
+	 * Adds the custom contact details provided by PayPal via the "Contact Module" integration.
 	 *
 	 * @param WC_Order $wc_order The WooCommerce order to update.
 	 * @param Order    $order    The PayPal order which provides the details.
-	 * @return void
 	 */
 	private function add_contact_details_to_wc_order( WC_Order $wc_order, Order $order ): void {
 		$shipping_details = $this->get_shipping_details( $order );
@@ -87,25 +81,33 @@ private function add_contact_details_to_wc_order( WC_Order $wc_order, Order $ord
 		$contact_email = $shipping_details->email_address();
 		$contact_phone = $shipping_details->phone_number();
 
+		$added = false;
+
 		if ( $contact_email && is_email( $contact_email ) ) {
 			$billing_email = $wc_order->get_billing_email();
 
 			if ( $billing_email && $billing_email !== $contact_email ) {
+				$wc_order->update_meta_data( PayPalGateway::CONTACT_EMAIL_META_KEY, $contact_email );
 				$wc_order->update_meta_data( PayPalGateway::ORIGINAL_EMAIL_META_KEY, $billing_email );
-			}
 
-			$wc_order->set_billing_email( $contact_email );
+				$added = true;
+			}
 		}
 
 		if ( $contact_phone ) {
 			$billing_phone        = $wc_order->get_billing_phone();
 			$contact_phone_number = $contact_phone->national_number();
 
 			if ( $billing_phone && $billing_phone !== $contact_phone_number ) {
+				$wc_order->update_meta_data( PayPalGateway::CONTACT_PHONE_META_KEY, $contact_phone_number );
 				$wc_order->update_meta_data( PayPalGateway::ORIGINAL_PHONE_META_KEY, $billing_phone );
+
+				$added = true;
 			}
+		}
 
-			$wc_order->set_billing_phone( $contact_phone_number );
+		if ( $added ) {
+			do_action( 'woocommerce_paypal_payments_contacts_added', $wc_order, $order );
 		}
 	}
 

modules/ppcp-wc-gateway/src/WCGatewayModule.php

@@ -93,6 +93,7 @@ public function extensions(): array {
 	public function run( ContainerInterface $c ): bool {
 		$this->register_payment_gateways( $c );
 		$this->register_order_functionality( $c );
+		$this->register_contact_handlers();
 		$this->register_columns( $c );
 		$this->register_checkout_paypal_address_preset( $c );
 		$this->register_wc_tasks( $c );
@@ -1035,6 +1036,43 @@ private function is_order_paid_by_paypal( $order ): bool {
 		return false === strpos( $order->get_payment_method_title(), '(via PayPal)' );
 	}
 
+	/**
+	 * Overwrite WC order email/phone.
+	 *
+	 * The contact module can provide a custom email and phone number.
+	 * These two properties are intended to be treated as primary contact details.
+	 */
+	private function register_contact_handlers(): void {
+		$set_order_contacts = function ( WC_Order $wc_order ): void {
+			$email = $wc_order->get_meta( PayPalGateway::CONTACT_EMAIL_META_KEY );
+			$phone = $wc_order->get_meta( PayPalGateway::CONTACT_PHONE_META_KEY );
+
+			if ( $email && is_email( $email ) ) {
+				$wc_order->set_billing_email( $email );
+			}
+			if ( $phone && is_string( $phone ) ) {
+				$wc_order->set_billing_phone( $phone );
+			}
+		};
+
+		add_action(
+			'woocommerce_paypal_payments_contacts_added',
+			function ( WC_Order $wc_order ) use ( $set_order_contacts ): void {
+				$set_order_contacts( $wc_order );
+			}
+		);
+		// There is a race condition in express block checkout, the contacts set in woocommerce_paypal_payments_contacts_added
+		// may get reverted by another ajax WC request. So we set them again after that.
+		add_action(
+			'woocommerce_store_api_cart_update_order_from_request',
+			function ( WC_Order $wc_order ) use ( $set_order_contacts ): void {
+				// This hook fires for all methods, but we do not do anything if the meta is not set
+				// so probably no need to add additional checks.
+				$set_order_contacts( $wc_order );
+			}
+		);
+	}
+
 	/**
 	 * Inserts custom fields into the order-detail view.
 	 *