Add support for WooCommerce Deposits when using Apple Pay and Google Pay

changelog/7907-support-deposit-express-pay

@@ -0,0 +1,4 @@
+Significance: patch
+Type: fix
+
+Added support for WooCommerce Deposits when using Apple Pay and Google Pay

client/checkout/woopay/express-button/use-express-checkout-product-handler.js

@@ -2,6 +2,7 @@
  * External dependencies
  */
 import validator from 'validator';
+import { applyFilters } from '@wordpress/hooks';
 
 const useExpressCheckoutProductHandler = ( api ) => {
 	const getAttributes = () => {
@@ -104,14 +105,23 @@ const useExpressCheckoutProductHandler = ( api ) => {
 		}
 
 		const addOnForm = document.querySelector( 'form.cart' );
+		let allowedFieldNames = applyFilters(
+			'wcpayPaymentRequestAllowedFieldNames',
+			[]
+		);
+		// Ensure allowedFieldNames is an array.
+		if ( ! Array.isArray( allowedFieldNames ) ) {
+			allowedFieldNames = [ allowedFieldNames ];
+		}
 
 		if ( addOnForm ) {
 			const formData = new FormData( addOnForm );
 
 			formData.forEach( ( value, name ) => {
 				if (
 					/^addon-/.test( name ) ||
-					/^wc_gc_giftcard_/.test( name )
+					/^wc_/.test( name ) ||
+					allowedFieldNames.includes( name )
 				) {
 					if ( /\[\]$/.test( name ) ) {
 						const fieldName = name.substring( 0, name.length - 2 );

client/payment-request/index.js

@@ -3,7 +3,7 @@
  * External dependencies
  */
 import { __ } from '@wordpress/i18n';
-import { doAction } from '@wordpress/hooks';
+import { applyFilters, doAction } from '@wordpress/hooks';
 import { debounce } from 'lodash';
 /**
  * Internal dependencies
@@ -189,8 +189,19 @@ jQuery( ( $ ) => {
 
 			// Add addons data to the POST body
 			const formData = $( 'form.cart' ).serializeArray();
+			let allowedFieldNames = applyFilters(
+				'wcpayPaymentRequestAllowedFieldNames',
+				[]
+			);
+			// Ensure allowedFieldNames is an array.
+			if ( ! Array.isArray( allowedFieldNames ) ) {
+				allowedFieldNames = [ allowedFieldNames ];
+			}
 			$.each( formData, ( i, field ) => {
-				if ( /^addon-/.test( field.name ) ) {
+				if (
+					allowedFieldNames.includes( field.name ) ||
+					/^(addon-|wc_)/.test( field.name )
+				) {
 					if ( /\[\]$/.test( field.name ) ) {
 						const fieldName = field.name.substring(
 							0,
@@ -302,13 +313,22 @@ jQuery( ( $ ) => {
 				0
 			);
 
+			// WC Deposits Support.
+			const depositObject = {};
+			if ( $( 'input[name=wc_deposit_option]' ).length ) {
+				depositObject.wc_deposit_option = $(
+					'input[name=wc_deposit_option]:checked'
+				).val();
+			}
+
 			const data = {
 				product_id: productId,
 				qty: $( '.quantity .qty' ).val(),
 				attributes: $( '.variations_form' ).length
 					? wcpayPaymentRequest.getAttributes().data
 					: [],
 				addon_value: addonValue,
+				...depositObject,
 			};
 
 			return api.paymentRequestGetSelectedProductData( data );
@@ -429,6 +449,14 @@ jQuery( ( $ ) => {
 				wcpayPaymentRequest.addToCart();
 			} );
 
+			// WooCommerce Deposits support.
+			// Trigger the "woocommerce_variation_has_changed" event when the deposit option is changed.
+			$( 'input[name=wc_deposit_option]' ).on( 'change', () => {
+				$( 'form:has(input[name=wc_deposit_option])' ).trigger(
+					'woocommerce_variation_has_changed'
+				);
+			} );
+
 			$( document.body ).on( 'woocommerce_variation_has_changed', () => {
 				wcpayPaymentRequest.blockPaymentRequestButton();
 

includes/class-wc-payments-payment-request-button-handler.php

@@ -202,18 +202,30 @@ public function get_button_height() {
 	 * Gets the product total price.
 	 *
 	 * @param object $product WC_Product_* object.
+	 * @param bool   $is_deposit Whether customer is paying a deposit.
 	 * @return mixed Total price.
 	 *
 	 * @throws Invalid_Price_Exception Whenever a product has no price.
 	 */
-	public function get_product_price( $product ) {
+	public function get_product_price( $product, ?bool $is_deposit = null ) {
 		// If prices should include tax, using tax inclusive price.
 		if ( $this->express_checkout_helper->cart_prices_include_tax() ) {
 			$base_price = wc_get_price_including_tax( $product );
 		} else {
 			$base_price = wc_get_price_excluding_tax( $product );
 		}
 
+		// If WooCommerce Deposits is active, we need to get the correct price for the product.
+		if ( class_exists( 'WC_Deposits_Product_Manager' ) && WC_Deposits_Product_Manager::deposits_enabled( $product->get_id() ) ) {
+			// If is_deposit is null, we use the default deposit type for the product.
+			if ( is_null( $is_deposit ) ) {
+				$is_deposit = 'deposit' === WC_Deposits_Product_Manager::get_deposit_type( $product->get_id() );
+			}
+			if ( $is_deposit ) {
+				$base_price = WC_Deposits_Product_Manager::get_deposit_amount( $product, 0, 'display', $base_price );
+			}
+		}
+
 		// Add subscription sign-up fees to product price.
 		$sign_up_fee        = 0;
 		$subscription_types = [
@@ -1050,6 +1062,7 @@ public function ajax_get_selected_product_data() {
 			$product      = wc_get_product( $product_id );
 			$variation_id = null;
 			$currency     = get_woocommerce_currency();
+			$is_deposit   = isset( $_POST['wc_deposit_option'] ) ? 'yes' === $_POST['wc_deposit_option'] : null;
 
 			if ( ! is_a( $product, 'WC_Product' ) ) {
 				/* translators: product ID */
@@ -1077,7 +1090,7 @@ public function ajax_get_selected_product_data() {
 				throw new Exception( sprintf( __( 'You cannot add that amount of "%1$s"; to the cart because there is not enough stock (%2$s remaining).', 'woocommerce-payments' ), $product->get_name(), wc_format_stock_quantity_for_display( $product->get_stock_quantity(), $product ) ) );
 			}
 
-			$price = $this->get_product_price( $product );
+			$price = $this->get_product_price( $product, $is_deposit );
 			$total = $qty * $price + $addon_value;
 
 			$quantity_label = 1 < $qty ? ' (x' . $qty . ')' : '';

tests/unit/helpers/class-wc-helper-deposit-product-manager.php

@@ -11,10 +11,25 @@
  * This helper class should ONLY be used for unit tests!.
  */
 class WC_Deposits_Product_Manager {
-	public static function get_deposit_type( WC_Product_Simple $product ) {
+	/**
+	 * @param WC_Product_Simple|int $product
+	 * @return mixed
+	 */
+	public static function get_deposit_type( $product ) {
+		if ( ! is_object( $product ) ) {
+			$product = apply_filters( 'test_deposit_get_product', wc_get_product( $product ) );
+		}
 		return $product->get_meta( '_wc_deposit_type' );
 	}
-	public static function deposits_enabled( WC_Product_Simple $product ) {
+
+	/**
+	 * @param WC_Product_Simple|int $product
+	 * @return bool
+	 */
+	public static function deposits_enabled( $product ) {
+		if ( ! is_object( $product ) ) {
+			$product = apply_filters( 'test_deposit_get_product', wc_get_product( $product ) );
+		}
 		return true === $product->get_meta( '_wc_deposits_enabled' );
 	}
 }

tests/unit/test-class-wc-payments-payment-request-button-handler.php

@@ -446,6 +446,12 @@ public function provide_get_product_tax_tests() {
 
 	public function test_get_product_price_includes_subscription_sign_up_fee() {
 		$mock_product = $this->create_mock_subscription( 'subscription' );
+		add_filter(
+			'test_deposit_get_product',
+			function() use ( $mock_product ) {
+				return $mock_product;
+			}
+		);
 
 		// We have a helper because we are not loading subscriptions.
 		WC_Subscriptions_Product::set_sign_up_fee( 10 );
@@ -458,6 +464,12 @@ public function test_get_product_price_includes_subscription_sign_up_fee() {
 
 	public function test_get_product_price_includes_variable_subscription_sign_up_fee() {
 		$mock_product = $this->create_mock_subscription( 'subscription_variation' );
+		add_filter(
+			'test_deposit_get_product',
+			function() use ( $mock_product ) {
+				return $mock_product;
+			}
+		);
 
 		// We have a helper because we are not loading subscriptions.
 		WC_Subscriptions_Product::set_sign_up_fee( 10 );
@@ -483,6 +495,12 @@ public function test_get_product_price_throws_exception_for_products_without_pri
 
 	public function test_get_product_price_throws_exception_for_a_non_numeric_signup_fee() {
 		$mock_product = $this->create_mock_subscription( 'subscription' );
+		add_filter(
+			'test_deposit_get_product',
+			function() use ( $mock_product ) {
+				return $mock_product;
+			}
+		);
 		WC_Subscriptions_Product::set_sign_up_fee( 'a' );
 
 		$this->expectException( WCPay\Exceptions\Invalid_Price_Exception::class );