Miscellaneous tasks on ECE (#3551)

* replace visible instances of 'source' with 'payment method' in the subscription edit page * pass locale to ece * fix js error * filter 'cart_needs_shipping_address' for subscriptions * fix test * add changelog
woocommerce · Nov 10, 2024 · d77461f · d77461f
1 parent eb0f1f8
commit d77461f
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 10 deletions.
diff --git a/changelog.txt b/changelog.txt
@@ -22,6 +22,8 @@
 * Tweak - Remove the subscription order notes added each time a source wasn't migrated.
 * Tweak - Update ECE default button type.
 * Fix - Fix position of ECE button on shortcode cart page.
+* Fix - Call ECE specific 'paymentFailed' function only when payment request fails.
+* Fix - Fix issue in purchasing subscriptions when the store has no shipping options.
 
 = 8.8.2 - 2024-11-07 =
 * Fix - Prevent marking renewal orders as processing/completed multiple times due to handling the Stripe webhook in parallel.

diff --git a/client/blocks/express-checkout/express-checkout-container.js b/client/blocks/express-checkout/express-checkout-container.js
@@ -1,7 +1,11 @@
 import React from 'react';
 import { Elements } from '@stripe/react-stripe-js';
 import ExpressCheckoutComponent from './express-checkout-component';
-import { getPaymentMethodTypesForExpressMethod } from 'wcstripe/express-checkout/utils';
+import {
+	getExpressCheckoutButtonAppearance,
+	getExpressCheckoutData,
+	getPaymentMethodTypesForExpressMethod,
+} from 'wcstripe/express-checkout/utils';
 
 export const ExpressCheckoutContainer = ( props ) => {
 	const { stripe, billing, expressPaymentMethod } = props;
@@ -13,6 +17,8 @@ export const ExpressCheckoutContainer = ( props ) => {
 		paymentMethodTypes: getPaymentMethodTypesForExpressMethod(
 			expressPaymentMethod
 		),
+		appearance: getExpressCheckoutButtonAppearance(),
+		locale: getExpressCheckoutData( 'stripe' )?.locale ?? 'en',
 	};
 
 	return (

diff --git a/client/blocks/express-checkout/hooks.js b/client/blocks/express-checkout/hooks.js
@@ -39,8 +39,10 @@ export const useExpressCheckout = ( {
 		window.location = redirectUrl;
 	};
 
-	const abortPayment = ( onConfirmEvent, message ) => {
-		onConfirmEvent.paymentFailed( { reason: 'fail' } );
+	const abortPayment = ( onConfirmEvent, message, isOrderError = false ) => {
+		if ( ! isOrderError ) {
+			onConfirmEvent.paymentFailed( { reason: 'fail' } );
+		}
 		setExpressPaymentError( message );
 		onAbortPaymentHandler( onConfirmEvent, message );
 	};

diff --git a/client/entrypoints/express-checkout/index.js b/client/entrypoints/express-checkout/index.js
@@ -132,6 +132,7 @@ jQuery( function ( $ ) {
 				currency: options.currency,
 				paymentMethodCreation: 'manual',
 				appearance: getExpressCheckoutButtonAppearance(),
+				locale: getExpressCheckoutData( 'stripe' )?.locale ?? 'en',
 				paymentMethodTypes: getExpressPaymentMethodTypes(),
 			} );
 
@@ -289,6 +290,7 @@ jQuery( function ( $ ) {
 					currency: getExpressCheckoutData( 'checkout' )
 						.currency_code,
 					appearance: getExpressCheckoutButtonAppearance(),
+					locale: getExpressCheckoutData( 'stripe' )?.locale ?? 'en',
 					displayItems,
 					order,
 				} );
@@ -466,9 +468,12 @@ jQuery( function ( $ ) {
 		 *
 		 * @param {PaymentResponse} payment Payment response instance.
 		 * @param {string} message Error message to display.
+		 * @param {boolean} isOrderError Whether the error is related to the order creation.
 		 */
-		abortPayment: ( payment, message ) => {
-			payment.paymentFailed( { reason: 'fail' } );
+		abortPayment: ( payment, message, isOrderError = false ) => {
+			if ( ! isOrderError ) {
+				payment.paymentFailed( { reason: 'fail' } );
+			}
 			onAbortPaymentHandler( payment, message );
 
 			displayExpressCheckoutNotice( message, 'error' );

diff --git a/client/express-checkout/__tests__/event-handler.test.js b/client/express-checkout/__tests__/event-handler.test.js
@@ -340,7 +340,8 @@ describe( 'Express checkout event handlers', () => {
 			);
 			expect( abortPayment ).toHaveBeenCalledWith(
 				event,
-				'Order creation error'
+				'Order creation error',
+				true
 			);
 			expect( completePayment ).not.toHaveBeenCalled();
 		} );
@@ -467,7 +468,8 @@ describe( 'Express checkout event handlers', () => {
 			);
 			expect( abortPayment ).toHaveBeenCalledWith(
 				event,
-				'Order creation error'
+				'Order creation error',
+				true
 			);
 			expect( completePayment ).not.toHaveBeenCalled();
 		} );

diff --git a/client/express-checkout/event-handler.js b/client/express-checkout/event-handler.js
@@ -92,7 +92,8 @@ export const onConfirmHandler = async (
 		if ( orderResponse.result !== 'success' ) {
 			return abortPayment(
 				event,
-				getErrorMessageFromNotice( orderResponse.messages )
+				getErrorMessageFromNotice( orderResponse.messages ),
+				true
 			);
 		}
 

diff --git a/includes/compat/trait-wc-stripe-subscriptions.php b/includes/compat/trait-wc-stripe-subscriptions.php
@@ -682,7 +682,7 @@ public function add_subscription_payment_meta( $payment_meta, $subscription ) {
 				],
 				'_stripe_source_id'   => [
 					'value' => $source_id,
-					'label' => 'Stripe Source ID',
+					'label' => 'Stripe Payment Method ID',
 				],
 			],
 		];
@@ -720,7 +720,7 @@ public function validate_subscription_payment_meta( $payment_method_id, $payment
 					&& 0 !== strpos( $payment_meta['post_meta']['_stripe_source_id']['value'], 'pm_' )
 				)
 			) {
-				throw new Exception( __( 'Invalid source ID. A valid source "Stripe Source ID" must begin with "src_", "pm_", or "card_".', 'woocommerce-gateway-stripe' ) );
+				throw new Exception( __( 'Invalid payment method ID. A valid "Stripe Payment Method ID" must begin with "src_", "pm_", or "card_".', 'woocommerce-gateway-stripe' ) );
 			}
 		}
 	}

diff --git a/includes/payment-methods/class-wc-stripe-express-checkout-element.php b/includes/payment-methods/class-wc-stripe-express-checkout-element.php
@@ -99,6 +99,7 @@ public function init() {
 		add_action( 'woocommerce_checkout_order_processed', [ $this, 'add_order_meta' ], 10, 2 );
 		add_filter( 'woocommerce_login_redirect', [ $this, 'get_login_redirect_url' ], 10, 3 );
 		add_filter( 'woocommerce_registration_redirect', [ $this, 'get_login_redirect_url' ], 10, 3 );
+		add_filter( 'woocommerce_cart_needs_shipping_address', [ $this, 'filter_cart_needs_shipping_address' ], 11, 1 );
 
 		add_action( 'before_woocommerce_pay_form', [ $this, 'localize_pay_for_order_page_scripts' ] );
 	}
@@ -415,4 +416,17 @@ public function display_express_checkout_button_separator_html() {
 		<p id="wc-stripe-express-checkout-button-separator" style="margin-top:1.5em;text-align:center;display:none;">&mdash; <?php esc_html_e( 'OR', 'woocommerce-gateway-stripe' ); ?> &mdash;</p>
 		<?php
 	}
+
+	/**
+	 * Determine whether to filter the cart needs shipping address.
+	 *
+	 * @param boolean $needs_shipping_address Whether the cart needs a shipping address.
+	 */
+	public function filter_cart_needs_shipping_address( $needs_shipping_address ) {
+		if ( $this->express_checkout_helper->has_subscription_product() && wc_get_shipping_method_count( true, true ) === 0 ) {
+			return false;
+		}
+
+		return $needs_shipping_address;
+	}
 }
diff --git a/readme.txt b/readme.txt
@@ -132,5 +132,7 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 * Tweak - Remove the subscription order notes added each time a source wasn't migrated.
 * Tweak - Update ECE default button type.
 * Fix - Fix position of ECE button on shortcode cart page.
+* Fix - Call ECE specific 'paymentFailed' function only when payment request fails.
+* Fix - Fix issue in purchasing subscriptions when the store has no shipping options.
 
 [See changelog for all versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).