diff --git a/.eslintignore b/.eslintignore
index e558812a35a..590187b9d5e 100644
--- a/.eslintignore
+++ b/.eslintignore
@@ -10,7 +10,3 @@ vendor/*
release/*
tests/e2e/docker*
tests/e2e/deps*
-
-# We'll delete the directory and its contents as part of https://github.com/Automattic/woocommerce-payments/issues/9722 .
-# ignoring it because we're temporariily cleaning it up.
-client/tokenized-payment-request
diff --git a/changelog/chore-remove-tokenized-payment-request-references b/changelog/chore-remove-tokenized-payment-request-references
new file mode 100644
index 00000000000..56dc3b0a0cc
--- /dev/null
+++ b/changelog/chore-remove-tokenized-payment-request-references
@@ -0,0 +1,5 @@
+Significance: patch
+Type: dev
+Comment: chore: remove tokeinzed payment request code
+
+
diff --git a/client/tokenized-payment-request/README.md b/client/tokenized-payment-request/README.md
deleted file mode 100644
index 2c92ba8d2ff..00000000000
--- a/client/tokenized-payment-request/README.md
+++ /dev/null
@@ -1,4 +0,0 @@
-# Tokenized Payment Request Button
-
-This directory contains the JS work done by the Heisenberg team to convert the PRBs to leverage the Store API.
-We'll delete the directory and its contents as part of https://github.com/Automattic/woocommerce-payments/issues/9722 .
diff --git a/client/tokenized-payment-request/blocks/apple-pay-preview.js b/client/tokenized-payment-request/blocks/apple-pay-preview.js
deleted file mode 100644
index 6b6f543ed05..00000000000
--- a/client/tokenized-payment-request/blocks/apple-pay-preview.js
+++ /dev/null
@@ -1,3 +0,0 @@
-/* eslint-disable max-len */
-export const applePayImage =
- "data:image/svg+xml,%3Csvg width='264' height='48' viewBox='0 0 264 48' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Crect width='264' height='48' rx='3' fill='black'/%3E%3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M125.114 16.6407C125.682 15.93 126.067 14.9756 125.966 14C125.135 14.0415 124.121 14.549 123.533 15.2602C123.006 15.8693 122.539 16.8641 122.661 17.7983C123.594 17.8797 124.526 17.3317 125.114 16.6407Z' fill='white'/%3E%3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M125.955 17.982C124.601 17.9011 123.448 18.7518 122.801 18.7518C122.154 18.7518 121.163 18.0224 120.092 18.0421C118.696 18.0629 117.402 18.8524 116.694 20.1079C115.238 22.6196 116.31 26.3453 117.726 28.3909C118.414 29.4028 119.242 30.5174 120.334 30.4769C121.366 30.4365 121.77 29.8087 123.024 29.8087C124.277 29.8087 124.641 30.4769 125.733 30.4567C126.865 30.4365 127.573 29.4443 128.261 28.4313C129.049 27.2779 129.373 26.1639 129.393 26.1027C129.373 26.0825 127.209 25.2515 127.189 22.7606C127.169 20.6751 128.888 19.6834 128.969 19.6217C127.998 18.1847 126.481 18.0224 125.955 17.982Z' fill='white'/%3E%3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M136.131 23.1804H138.834C140.886 23.1804 142.053 22.0752 142.053 20.1592C142.053 18.2432 140.886 17.1478 138.845 17.1478H136.131V23.1804ZM139.466 15.1582C142.411 15.1582 144.461 17.1903 144.461 20.1483C144.461 23.1172 142.369 25.1596 139.392 25.1596H136.131V30.3498H133.775V15.1582H139.466Z' fill='white'/%3E%3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M152.198 26.224V25.3712L149.579 25.5397C148.106 25.6341 147.339 26.182 147.339 27.14C147.339 28.0664 148.138 28.6667 149.39 28.6667C150.988 28.6667 152.198 27.6449 152.198 26.224ZM145.046 27.2032C145.046 25.2551 146.529 24.1395 149.263 23.971L152.198 23.7922V22.9498C152.198 21.7181 151.388 21.0442 149.947 21.0442C148.758 21.0442 147.896 21.6548 147.717 22.5916H145.592C145.656 20.6232 147.507 19.1914 150.01 19.1914C152.703 19.1914 154.459 20.602 154.459 22.7917V30.351H152.282V28.5298H152.229C151.609 29.719 150.241 30.4666 148.758 30.4666C146.571 30.4666 145.046 29.1612 145.046 27.2032Z' fill='white'/%3E%3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M156.461 34.4145V32.5934C156.608 32.6141 156.965 32.6354 157.155 32.6354C158.196 32.6354 158.785 32.1932 159.142 31.0564L159.353 30.3824L155.366 19.3281H157.827L160.604 28.298H160.657L163.434 19.3281H165.832L161.698 30.9402C160.752 33.6038 159.668 34.4778 157.376 34.4778C157.197 34.4778 156.618 34.4565 156.461 34.4145Z' fill='white'/%3E%3C/svg%3E%0A";
diff --git a/client/tokenized-payment-request/blocks/index.js b/client/tokenized-payment-request/blocks/index.js
deleted file mode 100644
index f6cb3461102..00000000000
--- a/client/tokenized-payment-request/blocks/index.js
+++ /dev/null
@@ -1,62 +0,0 @@
-/* global wcpayConfig, wcpayPaymentRequestParams */
-
-/**
- * Internal dependencies
- */
-import { PaymentRequestExpress } from './payment-request-express';
-import { applePayImage } from './apple-pay-preview';
-import { getConfig } from '../../utils/checkout';
-import {
- getPaymentRequest,
- transformCartDataForStoreAPI,
-} from '../frontend-utils';
-
-const PAYMENT_METHOD_NAME_PAYMENT_REQUEST =
- 'woocommerce_payments_tokenized_cart_payment_request';
-
-const ApplePayPreview = () => 
;
-
-const tokenizedCartPaymentRequestPaymentMethod = ( api ) => ( {
- name: PAYMENT_METHOD_NAME_PAYMENT_REQUEST,
- content: (
-
- ),
- edit: ,
- canMakePayment: ( cartData ) => {
- // If in the editor context, always return true to display the `edit` prop preview.
- // https://github.com/woocommerce/woocommerce-gutenberg-products-block/issues/4101.
- if ( getConfig( 'is_admin' ) ) {
- return true;
- }
-
- if ( typeof wcpayPaymentRequestParams === 'undefined' ) {
- return false;
- }
-
- if ( typeof wcpayConfig !== 'undefined' ) {
- return false;
- }
-
- return api.loadStripeForExpressCheckout().then( ( stripe ) => {
- // Create a payment request and check if we can make a payment to determine whether to
- // show the Payment Request Button or not. This is necessary because a browser might be
- // able to load the Stripe JS object, but not support Payment Requests.
- cartData = transformCartDataForStoreAPI( cartData, null );
- const pr = getPaymentRequest( {
- stripe,
- cartData,
- } );
-
- return pr.canMakePayment();
- } );
- },
- paymentMethodId: PAYMENT_METHOD_NAME_PAYMENT_REQUEST,
- supports: {
- features: getConfig( 'features' ),
- },
-} );
-
-export default tokenizedCartPaymentRequestPaymentMethod;
diff --git a/client/tokenized-payment-request/blocks/payment-request-express.js b/client/tokenized-payment-request/blocks/payment-request-express.js
deleted file mode 100644
index 3e852ae8486..00000000000
--- a/client/tokenized-payment-request/blocks/payment-request-express.js
+++ /dev/null
@@ -1,163 +0,0 @@
-/* global wcpayPaymentRequestParams */
-
-/**
- * External dependencies
- */
-import { Elements, PaymentRequestButtonElement } from '@stripe/react-stripe-js';
-import { recordUserEvent } from 'tracks';
-import { useEffect, useState } from 'react';
-
-/**
- * Internal dependencies
- */
-import { useInitialization } from './use-initialization';
-import { getPaymentRequestData } from '../frontend-utils';
-
-/**
- * PaymentRequestExpressComponent
- *
- * @param {Object} props Incoming props.
- *
- * @return {ReactNode} Payment Request button component.
- */
-const PaymentRequestExpressComponent = ( {
- api,
- billing,
- shippingData,
- setExpressPaymentError,
- onClick,
- onClose,
- onPaymentRequestAvailable,
- cartData,
-} ) => {
- // TODO: Don't display custom button when result.requestType
- // is `apple_pay` or `google_pay`.
- const {
- paymentRequest,
- // paymentRequestType,
- onButtonClick,
- } = useInitialization( {
- api,
- billing,
- shippingData,
- setExpressPaymentError,
- onClick,
- onClose,
- cartData,
- } );
-
- useEffect( () => {
- if ( paymentRequest ) {
- const orderAttribution = window?.wc_order_attribution;
- if ( orderAttribution ) {
- orderAttribution.setOrderTracking(
- orderAttribution.params.allowTracking
- );
- }
- }
- }, [ paymentRequest ] );
-
- const { type, theme, height } = getPaymentRequestData( 'button' );
-
- const paymentRequestButtonStyle = {
- paymentRequestButton: {
- type,
- theme,
- height: height + 'px',
- },
- };
-
- if ( ! paymentRequest ) {
- return null;
- }
-
- let paymentRequestType = '';
-
- // Check the availability of the Payment Request API first.
- paymentRequest.canMakePayment().then( ( result ) => {
- if ( ! result ) {
- return;
- }
-
- // Set the payment request type.
- if ( result.applePay ) {
- paymentRequestType = 'apple_pay';
- } else if ( result.googlePay ) {
- paymentRequestType = 'google_pay';
- }
- onPaymentRequestAvailable( paymentRequestType );
- } );
-
- const onPaymentRequestButtonClick = ( event ) => {
- onButtonClick( event, paymentRequest );
-
- const paymentRequestTypeEvents = {
- google_pay: 'gpay_button_click',
- apple_pay: 'applepay_button_click',
- };
-
- if ( paymentRequestTypeEvents.hasOwnProperty( paymentRequestType ) ) {
- const paymentRequestEvent =
- paymentRequestTypeEvents[ paymentRequestType ];
- recordUserEvent( paymentRequestEvent, {
- source: wcpayPaymentRequestParams?.button_context,
- } );
- }
- };
-
- return (
-
- );
-};
-
-/**
- * PaymentRequestExpress express payment method component.
- *
- * @param {Object} props PaymentMethodProps.
- *
- * @return {ReactNode} Stripe Elements component.
- */
-export const PaymentRequestExpress = ( props ) => {
- const { stripe } = props;
- const [ paymentRequestType, setPaymentRequestType ] = useState( false );
-
- const handlePaymentRequestAvailability = ( paymentType ) => {
- setPaymentRequestType( paymentType );
- };
-
- useEffect( () => {
- if ( paymentRequestType ) {
- const paymentRequestTypeEvents = {
- google_pay: 'gpay_button_load',
- apple_pay: 'applepay_button_load',
- };
-
- if (
- paymentRequestTypeEvents.hasOwnProperty( paymentRequestType )
- ) {
- const event = paymentRequestTypeEvents[ paymentRequestType ];
- recordUserEvent( event, {
- source: wcpayPaymentRequestParams?.button_context,
- } );
- }
- }
- }, [ paymentRequestType ] );
-
- return (
-
-
-
- );
-};
diff --git a/client/tokenized-payment-request/blocks/use-initialization.js b/client/tokenized-payment-request/blocks/use-initialization.js
deleted file mode 100644
index 360e2836eeb..00000000000
--- a/client/tokenized-payment-request/blocks/use-initialization.js
+++ /dev/null
@@ -1,172 +0,0 @@
-/**
- * External dependencies
- */
-import { useEffect, useState, useCallback } from '@wordpress/element';
-import { useStripe } from '@stripe/react-stripe-js';
-
-/**
- * Internal dependencies
- */
-import {
- shippingAddressChangeHandler,
- shippingOptionChangeHandler,
- paymentMethodHandler,
-} from '../event-handlers.js';
-
-import {
- getPaymentRequest,
- getPaymentRequestData,
- transformCartDataForStoreAPI,
- updatePaymentRequest,
- displayLoginConfirmationDialog,
-} from '../frontend-utils.js';
-
-export const useInitialization = ( {
- api,
- billing,
- shippingData,
- setExpressPaymentError,
- onClick,
- onClose,
- cartData,
-} ) => {
- cartData = transformCartDataForStoreAPI( null, {
- ...cartData,
- ...billing,
- ...shippingData,
- } );
-
- const stripe = useStripe();
-
- const [ paymentRequest, setPaymentRequest ] = useState( null );
- const [ isFinished, setIsFinished ] = useState( false );
- const [ paymentRequestType, setPaymentRequestType ] = useState( '' );
-
- // Create the initial paymentRequest object. Note, we can't do anything if stripe isn't available yet or we have zero total.
- useEffect( () => {
- if (
- ! stripe ||
- ! billing?.cartTotal?.value ||
- isFinished ||
- paymentRequest
- ) {
- return;
- }
-
- const pr = getPaymentRequest( {
- stripe,
- cartData,
- } );
-
- pr.canMakePayment().then( ( result ) => {
- if ( result ) {
- setPaymentRequest( pr );
- if ( result.applePay ) {
- setPaymentRequestType( 'apple_pay' );
- } else if ( result.googlePay ) {
- setPaymentRequestType( 'google_pay' );
- } else {
- setPaymentRequestType( 'payment_request_api' );
- }
- }
- } );
- }, [
- stripe,
- paymentRequest,
- billing?.cartTotal?.value,
- isFinished,
- shippingData?.needsShipping,
- billing?.cartTotalItems,
- cartData,
- ] );
-
- // It's not possible to update the `requestShipping` property in the `paymentRequest`
- // object, so when `needsShipping` changes, we need to reset the `paymentRequest` object.
- useEffect( () => {
- setPaymentRequest( null );
- }, [ shippingData.needsShipping ] );
-
- // When the payment button is clicked, update the request and show it.
- const onButtonClick = useCallback(
- ( evt, pr ) => {
- // If login is required, display redirect confirmation dialog.
- if ( getPaymentRequestData( 'login_confirmation' ) ) {
- evt.preventDefault();
- displayLoginConfirmationDialog( paymentRequestType );
- return;
- }
-
- setIsFinished( false );
- setExpressPaymentError( '' );
- updatePaymentRequest( {
- paymentRequest,
- cartData,
- } );
- onClick();
-
- // We must manually call payment request `show()` for custom buttons.
- if ( pr ) {
- pr.show();
- }
- },
- [
- setExpressPaymentError,
- paymentRequest,
- cartData,
- onClick,
- paymentRequestType,
- ]
- );
-
- // Whenever paymentRequest changes, hook in event listeners.
- useEffect( () => {
- const cancelHandler = () => {
- setIsFinished( false );
- setPaymentRequest( null );
- onClose();
- };
-
- const completePayment = ( redirectUrl ) => {
- setIsFinished( true );
- window.location = redirectUrl;
- };
-
- const abortPayment = ( paymentMethod, message ) => {
- paymentMethod.complete( 'fail' );
- setIsFinished( true );
- setExpressPaymentError( message );
- };
-
- paymentRequest?.on( 'shippingaddresschange', ( event ) =>
- shippingAddressChangeHandler( event )
- );
-
- paymentRequest?.on( 'shippingoptionchange', ( event ) =>
- shippingOptionChangeHandler( event )
- );
-
- paymentRequest?.on( 'paymentmethod', ( event ) =>
- paymentMethodHandler( api, completePayment, abortPayment, event )
- );
-
- paymentRequest?.on( 'cancel', cancelHandler );
-
- return () => {
- paymentRequest?.removeAllListeners();
- };
- }, [
- setExpressPaymentError,
- paymentRequest,
- api,
- setIsFinished,
- setPaymentRequest,
- onClose,
- cartData,
- ] );
-
- return {
- paymentRequest,
- onButtonClick,
- paymentRequestType,
- };
-};
diff --git a/client/tokenized-payment-request/button-ui.js b/client/tokenized-payment-request/button-ui.js
deleted file mode 100644
index b0ca818d213..00000000000
--- a/client/tokenized-payment-request/button-ui.js
+++ /dev/null
@@ -1,47 +0,0 @@
-/* global jQuery */
-
-let $wcpayPaymentRequestContainer = null;
-
-const paymentRequestButtonUi = {
- init: ( { $container } ) => {
- $wcpayPaymentRequestContainer = $container;
- },
-
- getElements: () => {
- return jQuery(
- '.wcpay-express-checkout-wrapper,#wcpay-express-checkout-button-separator'
- );
- },
-
- blockButton: () => {
- // check if element isn't already blocked before calling block() to avoid blinking overlay issues
- // blockUI.isBlocked is either undefined or 0 when element is not blocked
- if ( $wcpayPaymentRequestContainer.data( 'blockUI.isBlocked' ) ) {
- return;
- }
-
- $wcpayPaymentRequestContainer.block( { message: null } );
- },
-
- unblockButton: () => {
- paymentRequestButtonUi.show();
- $wcpayPaymentRequestContainer.unblock();
- },
-
- showButton: ( paymentRequestButton ) => {
- if ( $wcpayPaymentRequestContainer.length ) {
- paymentRequestButtonUi.show();
- paymentRequestButton.mount( '#wcpay-payment-request-button' );
- }
- },
-
- hide: () => {
- paymentRequestButtonUi.getElements().hide();
- },
-
- show: () => {
- paymentRequestButtonUi.getElements().show();
- },
-};
-
-export default paymentRequestButtonUi;
diff --git a/client/tokenized-payment-request/event-handlers.js b/client/tokenized-payment-request/event-handlers.js
deleted file mode 100644
index 872f51c86b3..00000000000
--- a/client/tokenized-payment-request/event-handlers.js
+++ /dev/null
@@ -1,178 +0,0 @@
-/**
- * External dependencies
- */
-import { applyFilters } from '@wordpress/hooks';
-
-/**
- * Internal dependencies
- */
-import {
- transformStripePaymentMethodForStoreApi,
- transformStripeShippingAddressForStoreApi,
-} from './transformers/stripe-to-wc';
-import {
- transformCartDataForDisplayItems,
- transformCartDataForShippingOptions,
- transformPrice,
-} from './transformers/wc-to-stripe';
-
-import {
- getPaymentRequestData,
- getErrorMessageFromNotice,
-} from './frontend-utils';
-
-import PaymentRequestCartApi from './cart-api';
-
-const cartApi = new PaymentRequestCartApi();
-
-export const shippingAddressChangeHandler = async ( event ) => {
- try {
- // Please note that the `event.shippingAddress` might not contain all the fields.
- // Some fields might not be present (like `line_1` or `line_2`) due to semi-anonymized data.
- const cartData = await cartApi.updateCustomer(
- transformStripeShippingAddressForStoreApi( event.shippingAddress )
- );
-
- const shippingOptions = transformCartDataForShippingOptions( cartData );
-
- // when no shipping options are returned, the API still returns a 200 status code.
- // We need to ensure that shipping options are present - otherwise the PRB dialog won't update correctly.
- if ( shippingOptions.length === 0 ) {
- event.updateWith( {
- // Possible statuses: https://docs.stripe.com/js/appendix/payment_response#payment_response_object-complete
- status: 'invalid_shipping_address',
- } );
-
- return;
- }
-
- event.updateWith( {
- // Possible statuses: https://docs.stripe.com/js/appendix/payment_response#payment_response_object-complete
- status: 'success',
- shippingOptions: transformCartDataForShippingOptions( cartData ),
- total: {
- label: getPaymentRequestData( 'total_label' ),
- amount: transformPrice(
- parseInt( cartData.totals.total_price, 10 ) -
- parseInt( cartData.totals.total_refund || 0, 10 ),
- cartData.totals
- ),
- },
- displayItems: transformCartDataForDisplayItems( cartData ),
- } );
- } catch ( error ) {
- // Possible statuses: https://docs.stripe.com/js/appendix/payment_response#payment_response_object-complete
- event.updateWith( {
- status: 'fail',
- } );
- }
-};
-
-export const shippingOptionChangeHandler = async ( event ) => {
- try {
- const cartData = await cartApi.selectShippingRate( {
- package_id: 0,
- rate_id: event.shippingOption.id,
- } );
-
- event.updateWith( {
- status: 'success',
- total: {
- label: getPaymentRequestData( 'total_label' ),
- amount: transformPrice(
- parseInt( cartData.totals.total_price, 10 ) -
- parseInt( cartData.totals.total_refund || 0, 10 ),
- cartData.totals
- ),
- },
- displayItems: transformCartDataForDisplayItems( cartData ),
- } );
- } catch ( error ) {
- event.updateWith( { status: 'fail' } );
- }
-};
-
-const paymentResponseHandler = async (
- api,
- response,
- completePayment,
- abortPayment,
- event
-) => {
- if ( response.payment_result.payment_status !== 'success' ) {
- return abortPayment(
- event,
- getErrorMessageFromNotice(
- response.message ||
- response.payment_result?.payment_details.find(
- ( detail ) => detail.key === 'errorMessage'
- )?.value
- )
- );
- }
-
- try {
- const confirmationRequest = api.confirmIntent(
- response.payment_result.redirect_url
- );
- // We need to call `complete` outside of `completePayment` to close the dialog for 3DS.
- event.complete( 'success' );
-
- // `true` means there is no intent to confirm.
- if ( confirmationRequest === true ) {
- completePayment( response.payment_result.redirect_url );
- } else {
- const redirectUrl = await confirmationRequest;
-
- completePayment( redirectUrl );
- }
- } catch ( error ) {
- abortPayment(
- event,
- getErrorMessageFromNotice(
- error.message ||
- error.payment_result?.payment_details.find(
- ( detail ) => detail.key === 'errorMessage'
- )?.value
- )
- );
- }
-};
-
-export const paymentMethodHandler = async (
- api,
- completePayment,
- abortPayment,
- event
-) => {
- try {
- // Kick off checkout processing step.
- const response = await cartApi.placeOrder( {
- // adding extension data as a separate action,
- // so that we make it harder for external plugins to modify or intercept checkout data.
- ...transformStripePaymentMethodForStoreApi( event ),
- extensions: applyFilters(
- 'wcpay.payment-request.cart-place-order-extension-data',
- {}
- ),
- } );
-
- paymentResponseHandler(
- api,
- response,
- completePayment,
- abortPayment,
- event
- );
- } catch ( error ) {
- abortPayment(
- event,
- getErrorMessageFromNotice(
- error.message ||
- error.payment_result?.payment_details.find(
- ( detail ) => detail.key === 'errorMessage'
- )?.value
- )
- );
- }
-};
diff --git a/client/tokenized-payment-request/frontend-utils.js b/client/tokenized-payment-request/frontend-utils.js
deleted file mode 100644
index c1dd1d4d46c..00000000000
--- a/client/tokenized-payment-request/frontend-utils.js
+++ /dev/null
@@ -1,257 +0,0 @@
-/* global wcpayPaymentRequestParams */
-
-/**
- * Internal dependencies
- */
-import {
- transformCartDataForDisplayItems,
- transformPrice,
-} from './transformers/wc-to-stripe';
-
-/**
- * Retrieves payment request data from global variable.
- *
- * @param {string} key The object property key.
- * @return {mixed} Value of the object prop or null.
- */
-export const getPaymentRequestData = ( key ) => {
- if (
- typeof wcpayPaymentRequestParams === 'object' &&
- wcpayPaymentRequestParams.hasOwnProperty( key )
- ) {
- return wcpayPaymentRequestParams[ key ];
- }
- return null;
-};
-
-/**
- * Returns a Stripe payment request object.
- *
- * @param {Object} config A configuration object for getting the payment request.
- * @return {Object} Payment Request options object
- */
-export const getPaymentRequest = ( { stripe, cartData, productData } ) => {
- // the country code defined here comes from the WC settings.
- // It might be interesting to ensure the country code coincides with the Stripe account's country,
- // as defined here: https://docs.stripe.com/js/payment_request/create
- let country = getPaymentRequestData( 'checkout' )?.country_code;
-
- // Puerto Rico (PR) is the only US territory/possession that's supported by Stripe.
- // Since it's considered a US state by Stripe, we need to do some special mapping.
- if ( country === 'PR' ) {
- country = 'US';
- }
-
- return stripe.paymentRequest( {
- country,
- requestPayerName: true,
- requestPayerEmail: true,
- requestPayerPhone: getPaymentRequestData( 'checkout' )
- ?.needs_payer_phone,
- ...( productData
- ? {
- // we can't just pass `productData`, and we need a little bit of massaging for older data.
- currency: productData.currency,
- total: productData.total,
- displayItems: productData.displayItems,
- requestShipping: productData.needs_shipping,
- }
- : {
- currency: cartData.totals.currency_code.toLowerCase(),
- total: {
- label: getPaymentRequestData( 'total_label' ),
- amount: transformPrice(
- parseInt( cartData.totals.total_price, 10 ) -
- parseInt(
- cartData.totals.total_refund || 0,
- 10
- ),
- cartData.totals
- ),
- },
- requestShipping:
- getPaymentRequestData( 'button_context' ) ===
- 'pay_for_order'
- ? false
- : cartData.needs_shipping,
- displayItems: transformCartDataForDisplayItems( cartData ),
- } ),
- } );
-};
-
-/**
- * Utility function for updating the Stripe PaymentRequest object
- *
- * @param {Object} update An object containing the things needed for the update.
- */
-export const updatePaymentRequest = ( { paymentRequest, cartData } ) => {
- paymentRequest.update( {
- total: {
- label: getPaymentRequestData( 'total_label' ),
- amount: transformPrice(
- parseInt( cartData.totals.total_price, 10 ) -
- parseInt( cartData.totals.total_refund || 0, 10 ),
- cartData.totals
- ),
- },
- displayItems: transformCartDataForDisplayItems( cartData ),
- } );
-};
-
-/**
- * Displays a `confirm` dialog which leads to a redirect.
- *
- * @param {string} paymentRequestType Can be either apple_pay, google_pay or payment_request_api.
- */
-export const displayLoginConfirmationDialog = ( paymentRequestType ) => {
- if ( ! getPaymentRequestData( 'login_confirmation' ) ) {
- return;
- }
-
- let message = getPaymentRequestData( 'login_confirmation' )?.message;
-
- // Replace dialog text with specific payment request type "Apple Pay" or "Google Pay".
- message = message.replace(
- /\*\*.*?\*\*/,
- paymentRequestType === 'apple_pay' ? 'Apple Pay' : 'Google Pay'
- );
-
- // Remove asterisks from string.
- message = message.replace( /\*\*/g, '' );
-
- if ( confirm( message ) ) {
- // Redirect to my account page.
- window.location.href = getPaymentRequestData(
- 'login_confirmation'
- )?.redirect_url;
- }
-};
-
-/**
- * Parses HTML error notice and returns single error message.
- *
- * @param {string} notice Error notice DOM HTML.
- * @return {string} Error message content
- */
-export const getErrorMessageFromNotice = ( notice ) => {
- const div = document.createElement( 'div' );
- div.innerHTML = notice.trim();
- return div.firstChild ? div.firstChild.textContent : '';
-};
-
-/**
- * Searches object for matching key and returns corresponding property value from matched item.
- *
- * @param {Object} obj Object to search for key.
- * @param {string} key Key to match in object.
- * @param {string} property Property in object to return correct value.
- * @return {int|null} Value to return
- */
-const getPropertyByKey = ( obj, key, property ) => {
- const foundItem = obj.find( ( item ) => item.key === key );
- return foundItem ? foundItem[ property ] : null;
-};
-
-/**
- * Transforms totals from cartDataContent into format expected by the Store API.
- *
- * @param {Object} cartDataContent cartData from content component
- * @return {Object} Cart totals object for Store API
- */
-const constructCartDataContentTotals = ( cartDataContent ) => {
- const totals = {
- total_items: getPropertyByKey(
- cartDataContent.cartTotalItems,
- 'total_items',
- 'value'
- )?.toString(),
- total_items_tax: getPropertyByKey(
- cartDataContent.cartTotalItems,
- 'total_tax',
- 'value'
- )?.toString(),
- total_fees: getPropertyByKey(
- cartDataContent.cartTotalItems,
- 'total_fees',
- 'value'
- )?.toString(),
- total_fees_tax: getPropertyByKey(
- cartDataContent.cartTotalItems,
- 'total_fees',
- 'valueWithTax'
- )?.toString(),
- total_discount: getPropertyByKey(
- cartDataContent.cartTotalItems,
- 'total_discount',
- 'value'
- )?.toString(),
- total_discount_tax: getPropertyByKey(
- cartDataContent.cartTotalItems,
- 'total_discount',
- 'valueWithTax'
- )?.toString(),
- total_shipping: getPropertyByKey(
- cartDataContent.cartTotalItems,
- 'total_shipping',
- 'value'
- )?.toString(),
- total_shipping_tax: getPropertyByKey(
- cartDataContent.cartTotalItems,
- 'total_shipping',
- 'valueWithTax'
- )?.toString(),
- total_price: cartDataContent.cartTotal.value.toString(),
- total_tax: getPropertyByKey(
- cartDataContent.cartTotalItems,
- 'total_tax',
- 'value'
- )?.toString(),
- currency_code: cartDataContent.currency.code,
- currency_symbol: cartDataContent.currency.symbol,
- currency_minor_unit: cartDataContent.currency.minorUnit,
- currency_decimal_separator: cartDataContent.currency.decimalSeparator,
- currency_thousand_separator: cartDataContent.currency.thousandSeparator,
- currency_prefix: cartDataContent.currency.prefix,
- currency_suffix: cartDataContent.currency.suffix,
- };
-
- return totals;
-};
-
-/**
- * Transforms the cartData object to the format expected by the Store API. cartData is coming to the blocks Payment Request method
- * in two different formats: from the canMakePayment function and from the content component. This function takes in either format
- * and transforms it into the format expected by the Store API.
- *
- * @param {Object|null} cartDataCanMakePayment cartData from canMakePayment function.
- * @param {Object|null} cartDataContent cartData from content component.
- * @return {Object} Cart totals object.
- */
-export const transformCartDataForStoreAPI = (
- cartDataCanMakePayment,
- cartDataContent
-) => {
- let mappedCartData = {};
-
- if ( cartDataCanMakePayment ) {
- mappedCartData = {
- ...cartDataCanMakePayment,
- items: cartDataCanMakePayment.cart.cartItems,
- totals: cartDataCanMakePayment.cartTotals,
- needs_shipping: cartDataCanMakePayment.cartNeedsShipping,
- shipping_rates: cartDataCanMakePayment.cart.shippingRates,
- };
- }
-
- if ( cartDataContent ) {
- mappedCartData = {
- items: cartDataContent.cartItems,
- totals: constructCartDataContentTotals( cartDataContent ),
- needs_shipping: cartDataContent.needsShipping,
- shipping_rates: cartDataContent.shippingRates,
- extensions: cartDataContent.extensions,
- };
- }
-
- return mappedCartData;
-};
diff --git a/client/tokenized-payment-request/index.js b/client/tokenized-payment-request/index.js
deleted file mode 100644
index f1797b725e2..00000000000
--- a/client/tokenized-payment-request/index.js
+++ /dev/null
@@ -1,90 +0,0 @@
-/* global jQuery */
-/**
- * External dependencies
- */
-import { applyFilters } from '@wordpress/hooks';
-
-/**
- * Internal dependencies
- */
-import { getUPEConfig } from 'wcpay/utils/checkout';
-import WCPayAPI from '../checkout/api';
-import PaymentRequestCartApi from './cart-api';
-import PaymentRequestOrderApi from './order-api';
-import WooPaymentsPaymentRequest from './payment-request';
-import paymentRequestButtonUi from './button-ui';
-import { getPaymentRequestData } from './frontend-utils';
-import './compatibility/wc-deposits';
-import './compatibility/wc-order-attribution';
-import './compatibility/wc-product-variations';
-
-import '../checkout/express-checkout-buttons.scss';
-
-jQuery( ( $ ) => {
- // Don't load if blocks checkout is being loaded.
- if (
- getPaymentRequestData( 'has_block' ) &&
- getPaymentRequestData( 'button_context' ) !== 'pay_for_order'
- ) {
- return;
- }
-
- const publishableKey = getPaymentRequestData( 'stripe' ).publishableKey;
-
- if ( ! publishableKey ) {
- // If no configuration is present, we can't do anything.
- return;
- }
-
- // initializing the UI's container.
- paymentRequestButtonUi.init( {
- $container: $( '#wcpay-payment-request-button' ),
- } );
-
- const api = new WCPayAPI(
- {
- publishableKey,
- accountId: getPaymentRequestData( 'stripe' ).accountId,
- locale: getPaymentRequestData( 'stripe' ).locale,
- },
- // A promise-based interface to jQuery.post.
- ( url, args ) => {
- return new Promise( ( resolve, reject ) => {
- $.post( url, args ).then( resolve ).fail( reject );
- } );
- }
- );
- let paymentRequestCartApi = new PaymentRequestCartApi();
- if ( getPaymentRequestData( 'button_context' ) === 'pay_for_order' ) {
- paymentRequestCartApi = new PaymentRequestOrderApi( {
- orderId: getUPEConfig( 'order_id' ),
- key: getUPEConfig( 'key' ),
- billingEmail: getUPEConfig( 'billing_email' ),
- } );
- }
-
- const wooPaymentsPaymentRequest = new WooPaymentsPaymentRequest( {
- wcpayApi: api,
- paymentRequestCartApi,
- productData: getPaymentRequestData( 'product' ) || undefined,
- } );
-
- wooPaymentsPaymentRequest.init();
-
- // When the cart is updated, the PRB is removed from the page and needs to be re-initialized.
- $( document.body ).on( 'updated_cart_totals', async () => {
- await applyFilters(
- 'wcpay.payment-request.update-button-data',
- Promise.resolve()
- );
- wooPaymentsPaymentRequest.init();
- } );
-
- // We need to refresh payment request data when total is updated.
- $( document.body ).on( 'updated_checkout', async () => {
- await applyFilters(
- 'wcpay.payment-request.update-button-data',
- Promise.resolve()
- );
- } );
-} );
diff --git a/client/tokenized-payment-request/payment-request.js b/client/tokenized-payment-request/payment-request.js
deleted file mode 100644
index 046769cfd7d..00000000000
--- a/client/tokenized-payment-request/payment-request.js
+++ /dev/null
@@ -1,478 +0,0 @@
-/* global jQuery */
-/**
- * External dependencies
- */
-import { __ } from '@wordpress/i18n';
-import {
- doAction,
- applyFilters,
- removeFilter,
- addFilter,
-} from '@wordpress/hooks';
-
-/**
- * Internal dependencies
- */
-import {
- setPaymentRequestBranding,
- trackPaymentRequestButtonClick,
- trackPaymentRequestButtonLoad,
-} from './tracking';
-import {
- transformStripePaymentMethodForStoreApi,
- transformStripeShippingAddressForStoreApi,
-} from './transformers/stripe-to-wc';
-import {
- transformCartDataForDisplayItems,
- transformCartDataForShippingOptions,
- transformPrice,
-} from './transformers/wc-to-stripe';
-import paymentRequestButtonUi from './button-ui';
-import {
- getPaymentRequest,
- displayLoginConfirmationDialog,
- getPaymentRequestData,
-} from './frontend-utils';
-import PaymentRequestCartApi from './cart-api';
-import debounce from './debounce';
-
-const noop = () => null;
-
-/**
- * Class to handle Stripe payment forms.
- */
-export default class WooPaymentsPaymentRequest {
- /**
- * Whether the payment was aborted by the customer.
- */
- isPaymentAborted = false;
-
- /**
- * Whether global listeners have been added.
- */
- areListenersInitialized = false;
-
- /**
- * The cart data represented if the product were to be added to the cart (or, on cart/checkout pages, the cart data itself).
- * This is useful on product pages to understand if shipping is needed.
- */
- cachedCartData = undefined;
-
- /**
- * API to interface with the cart.
- *
- * @type {PaymentRequestCartApi}
- */
- paymentRequestCartApi = undefined;
-
- /**
- * WCPayAPI instance.
- *
- * @type {WCPayAPI}
- */
- wcpayApi = undefined;
-
- /**
- * On page load for product pages, we might get some data from the backend (which might get overwritten later).
- */
- initialProductData = undefined;
-
- constructor( { wcpayApi, paymentRequestCartApi, productData } ) {
- this.wcpayApi = wcpayApi;
- this.paymentRequestCartApi = paymentRequestCartApi;
- this.initialProductData = productData;
- }
-
- /**
- * Starts the payment request
- */
- async startPaymentRequest() {
- // reference to this class' instance, to be used inside callbacks to avoid `this` misunderstandings.
- const _self = this;
- const stripe = await this.wcpayApi.getStripe();
- const paymentRequest = getPaymentRequest( {
- stripe,
- cartData: this.cachedCartData,
- productData: this.initialProductData,
- } );
-
- // Check the availability of the Payment Request API first.
- const paymentPermissionResult = await paymentRequest.canMakePayment();
- if ( ! paymentPermissionResult ) {
- doAction( 'wcpay.payment-request.availability', {
- paymentRequestType: null,
- } );
- return;
- }
-
- const buttonBranding = paymentPermissionResult.applePay
- ? 'apple_pay'
- : 'google_pay';
-
- doAction( 'wcpay.payment-request.availability', {
- paymentRequestType: buttonBranding,
- } );
-
- setPaymentRequestBranding( buttonBranding );
- trackPaymentRequestButtonLoad(
- getPaymentRequestData( 'button_context' )
- );
-
- // on product pages, we need to interact with an anonymous cart to checkout the product,
- // so that we don't affect the products in the main cart.
- // On cart, checkout, place order pages we instead use the cart itself.
- if ( getPaymentRequestData( 'button_context' ) === 'product' ) {
- this.paymentRequestCartApi.useSeparateCart();
- }
-
- const paymentRequestButton = stripe
- .elements()
- .create( 'paymentRequestButton', {
- paymentRequest: paymentRequest,
- style: {
- paymentRequestButton: {
- type: getPaymentRequestData( 'button' ).type,
- theme: getPaymentRequestData( 'button' ).theme,
- height: getPaymentRequestData( 'button' ).height + 'px',
- },
- },
- } );
- paymentRequestButtonUi.showButton( paymentRequestButton );
-
- if ( getPaymentRequestData( 'button_context' ) === 'pay_for_order' ) {
- paymentRequestButton.on( 'click', () => {
- trackPaymentRequestButtonClick( 'pay_for_order' );
- } );
- }
-
- if ( getPaymentRequestData( 'button_context' ) === 'product' ) {
- this.attachPaymentRequestButtonEventListeners();
- }
-
- removeFilter(
- 'wcpay.payment-request.update-button-data',
- 'automattic/wcpay/payment-request'
- );
- addFilter(
- 'wcpay.payment-request.update-button-data',
- 'automattic/wcpay/payment-request',
- async ( previousPromise ) => {
- // Wait for previous filters
- await previousPromise;
-
- const newCartData = await _self.getCartData();
- // checking if items needed shipping, before assigning new cart data.
- const didItemsNeedShipping =
- _self.initialProductData?.needs_shipping ||
- _self.cachedCartData?.needs_shipping;
-
- _self.cachedCartData = newCartData;
-
- /**
- * If the customer aborted the payment request, we need to re init the payment request button to ensure the shipping
- * options are re-fetched. If the customer didn't abort the payment request, and the product's shipping status is
- * consistent, we can simply update the payment request button with the new total and display items.
- */
- if (
- ! _self.isPaymentAborted &&
- didItemsNeedShipping === newCartData.needs_shipping
- ) {
- paymentRequest.update( {
- total: {
- label: getPaymentRequestData( 'total_label' ),
- amount: transformPrice(
- parseInt( newCartData.totals.total_price, 10 ) -
- parseInt(
- newCartData.totals.total_refund || 0,
- 10
- ),
- newCartData.totals
- ),
- },
- displayItems: transformCartDataForDisplayItems(
- newCartData
- ),
- } );
- } else {
- await _self.init();
- }
- }
- );
-
- if ( getPaymentRequestData( 'button_context' ) === 'product' ) {
- const $addToCartButton = jQuery( '.single_add_to_cart_button' );
-
- paymentRequestButton.on( 'click', ( event ) => {
- trackPaymentRequestButtonClick( 'product' );
-
- // If login is required for checkout, display redirect confirmation dialog.
- if ( getPaymentRequestData( 'login_confirmation' ) ) {
- event.preventDefault();
- displayLoginConfirmationDialog( buttonBranding );
- return;
- }
-
- // First check if product can be added to cart.
- if ( $addToCartButton.is( '.disabled' ) ) {
- event.preventDefault(); // Prevent showing payment request modal.
- if (
- $addToCartButton.is( '.wc-variation-is-unavailable' )
- ) {
- window.alert(
- window.wc_add_to_cart_variation_params
- ?.i18n_unavailable_text ||
- __(
- 'Sorry, this product is unavailable. Please choose a different combination.',
- 'woocommerce-payments'
- )
- );
- } else {
- window.alert(
- window?.wc_add_to_cart_variation_params
- ?.i18n_make_a_selection_text ||
- __(
- 'Please select some product options before adding this product to your cart.',
- 'woocommerce-payments'
- )
- );
- }
- return;
- }
-
- _self.paymentRequestCartApi.addProductToCart();
- } );
- }
-
- paymentRequest.on( 'cancel', () => {
- _self.isPaymentAborted = true;
-
- if ( getPaymentRequestData( 'button_context' ) === 'product' ) {
- // clearing the cart to avoid issues with products with low or limited availability
- // being held hostage by customers cancelling the PRB.
- _self.paymentRequestCartApi.emptyCart();
- }
- } );
-
- paymentRequest.on( 'shippingaddresschange', async ( event ) => {
- try {
- // Please note that the `event.shippingAddress` might not contain all the fields.
- // Some fields might not be present (like `line_1` or `line_2`) due to semi-anonymized data.
- const cartData = await _self.paymentRequestCartApi.updateCustomer(
- transformStripeShippingAddressForStoreApi(
- event.shippingAddress
- )
- );
-
- const shippingOptions = transformCartDataForShippingOptions(
- cartData
- );
-
- // when no shipping options are returned, the API still returns a 200 status code.
- // We need to ensure that shipping options are present - otherwise the PRB dialog won't update correctly.
- if ( shippingOptions.length === 0 ) {
- event.updateWith( {
- // Possible statuses: https://docs.stripe.com/js/appendix/payment_response#payment_response_object-complete
- status: 'invalid_shipping_address',
- } );
- _self.cachedCartData = cartData;
-
- return;
- }
-
- event.updateWith( {
- // Possible statuses: https://docs.stripe.com/js/appendix/payment_response#payment_response_object-complete
- status: 'success',
- shippingOptions,
- total: {
- label: getPaymentRequestData( 'total_label' ),
- amount: transformPrice(
- parseInt( cartData.totals.total_price, 10 ) -
- parseInt(
- cartData.totals.total_refund || 0,
- 10
- ),
- cartData.totals
- ),
- },
- displayItems: transformCartDataForDisplayItems( cartData ),
- } );
-
- _self.cachedCartData = cartData;
- } catch ( error ) {
- // Possible statuses: https://docs.stripe.com/js/appendix/payment_response#payment_response_object-complete
- event.updateWith( {
- status: 'fail',
- } );
- }
- } );
-
- paymentRequest.on( 'shippingoptionchange', async ( event ) => {
- try {
- const cartData = await _self.paymentRequestCartApi.selectShippingRate(
- { package_id: 0, rate_id: event.shippingOption.id }
- );
-
- event.updateWith( {
- status: 'success',
- total: {
- label: getPaymentRequestData( 'total_label' ),
- amount: transformPrice(
- parseInt( cartData.totals.total_price, 10 ) -
- parseInt(
- cartData.totals.total_refund || 0,
- 10
- ),
- cartData.totals
- ),
- },
- displayItems: transformCartDataForDisplayItems( cartData ),
- } );
- _self.cachedCartData = cartData;
- } catch ( error ) {
- event.updateWith( { status: 'fail' } );
- }
- } );
-
- paymentRequest.on( 'paymentmethod', async ( event ) => {
- // TODO: this works for PDPs - need to handle checkout scenarios for cart, checkout.
- try {
- const response = await _self.paymentRequestCartApi.placeOrder( {
- // adding extension data as a separate action,
- // so that we make it harder for external plugins to modify or intercept checkout data.
- ...transformStripePaymentMethodForStoreApi( event ),
- extensions: applyFilters(
- 'wcpay.payment-request.cart-place-order-extension-data',
- {}
- ),
- } );
-
- const confirmationRequest = _self.wcpayApi.confirmIntent(
- response.payment_result.redirect_url
- );
- // We need to call `complete` before redirecting to close the dialog for 3DS.
- event.complete( 'success' );
-
- let redirectUrl = '';
-
- // `true` means there is no intent to confirm.
- if ( confirmationRequest === true ) {
- redirectUrl = response.payment_result.redirect_url;
- } else {
- redirectUrl = await confirmationRequest;
- }
-
- jQuery.blockUI( {
- message: null,
- overlayCSS: {
- background: '#fff',
- opacity: 0.6,
- },
- } );
-
- window.location = redirectUrl;
- } catch ( error ) {
- const response = await error.json();
- event.complete( 'fail' );
-
- jQuery( '.woocommerce-error' ).remove();
-
- const $container = jQuery(
- '.woocommerce-notices-wrapper'
- ).first();
-
- // the error thrown could have different formats, depending if it was a Store API failure or an ajax failure.
- const errorMessage =
- response.message ||
- response.payment_result?.payment_details.find(
- ( detail ) => detail.key === 'errorMessage'
- )?.value;
- if ( $container.length ) {
- $container.append(
- jQuery( '' ).text(
- errorMessage
- )
- );
-
- jQuery( 'html, body' ).animate(
- {
- scrollTop: $container
- .find( '.woocommerce-error' )
- .offset().top,
- },
- 600
- );
- }
- }
- } );
- }
-
- attachPaymentRequestButtonEventListeners() {
- if ( this.areListenersInitialized ) {
- return;
- }
-
- this.areListenersInitialized = true;
- // Block the payment request button as soon as an "input" event is fired, to avoid sync issues
- // when the customer clicks on the button before the debounced event is processed.
- const $quantityInput = jQuery( '.quantity' );
- const handleQuantityChange = () => {
- paymentRequestButtonUi.blockButton();
- };
- $quantityInput.on( 'input', '.qty', handleQuantityChange );
- $quantityInput.on(
- 'input',
- '.qty',
- debounce( 250, async () => {
- await applyFilters(
- 'wcpay.payment-request.update-button-data',
- Promise.resolve()
- );
- paymentRequestButtonUi.unblockButton();
- } )
- );
- }
-
- async getCartData() {
- if ( getPaymentRequestData( 'button_context' ) !== 'product' ) {
- return await this.paymentRequestCartApi.getCart();
- }
-
- // creating a new cart and clearing it afterwards,
- // to avoid scenarios where the stock for a product with limited (or low) availability is added to the cart,
- // preventing other customers from purchasing.
- const temporaryCart = new PaymentRequestCartApi();
- temporaryCart.useSeparateCart();
-
- const cartData = await temporaryCart.addProductToCart();
-
- // no need to wait for the request to end, it can be done asynchronously.
- // using `.finally( noop )` to avoid annoying IDE warnings.
- temporaryCart.emptyCart().finally( noop );
-
- return cartData;
- }
-
- /**
- * Initialize event handlers and UI state
- */
- async init() {
- // on product pages, we should be able to have `initialProductData` from the backend - which saves us some AJAX calls.
- if ( ! this.cachedCartData && ! this.initialProductData ) {
- try {
- this.cachedCartData = await this.getCartData();
- } catch ( e ) {
- // if something fails here, we can likely fall back on the `initialProductData`.
- }
- }
-
- // once (and if) cart data has been fetched, we can safely clear cached product data.
- if ( this.cachedCartData ) {
- this.initialProductData = undefined;
- }
-
- await this.startPaymentRequest();
-
- // After initializing a new payment request, we need to reset the isPaymentAborted flag.
- this.isPaymentAborted = false;
- }
-}
diff --git a/client/tokenized-payment-request/test/payment-request.test.js b/client/tokenized-payment-request/test/payment-request.test.js
deleted file mode 100644
index 617384976e5..00000000000
--- a/client/tokenized-payment-request/test/payment-request.test.js
+++ /dev/null
@@ -1,158 +0,0 @@
-/**
- * External dependencies
- */
-import apiFetch from '@wordpress/api-fetch';
-import { addAction, applyFilters, doAction } from '@wordpress/hooks';
-
-/**
- * Internal dependencies
- */
-import PaymentRequestCartApi from '../cart-api';
-import WooPaymentsPaymentRequest from '../payment-request';
-import { trackPaymentRequestButtonLoad } from '../tracking';
-
-jest.mock( '@wordpress/api-fetch', () => jest.fn() );
-jest.mock( '../tracking', () => ( {
- setPaymentRequestBranding: () => null,
- trackPaymentRequestButtonClick: () => null,
- trackPaymentRequestButtonLoad: jest.fn(),
-} ) );
-
-jest.mock( '../button-ui', () => ( {
- showButton: () => null,
- blockButton: () => null,
- unblockButton: () => null,
-} ) );
-jest.mock( '../debounce', () => ( wait, func ) =>
- function () {
- func.apply( this, arguments );
- }
-);
-
-const jQueryMock = ( selector ) => {
- if ( typeof selector === 'function' ) {
- return selector( jQueryMock );
- }
-
- return {
- on: ( event, callbackOrSelector, callback2 ) =>
- addAction(
- `payment-request-test.jquery-event.${ selector }${
- typeof callbackOrSelector === 'string'
- ? `.${ callbackOrSelector }`
- : ''
- }.${ event }`,
- 'tests',
- typeof callbackOrSelector === 'string'
- ? callback2
- : callbackOrSelector
- ),
- val: () => null,
- is: () => null,
- remove: () => null,
- };
-};
-jQueryMock.blockUI = () => null;
-
-describe( 'WooPaymentsPaymentRequest', () => {
- let wcpayApi;
-
- beforeEach( () => {
- global.$ = jQueryMock;
- global.jQuery = jQueryMock;
- global.wcpayPaymentRequestParams = {
- nonce: {
- store_api_nonce: 'global_store_api_nonce',
- },
- button_context: 'cart',
- checkout: {
- needs_payer_phone: true,
- country_code: 'US',
- currency_code: 'usd',
- },
- total_label: 'wcpay.test (via WooCommerce)',
- button: { type: 'default', theme: 'dark', height: '48' },
- };
- wcpayApi = {
- getStripe: () => ( {
- paymentRequest: () => ( {
- update: () => null,
- canMakePayment: () => ( { googlePay: true } ),
- on: ( event, callback ) =>
- addAction(
- `payment-request-test.registered-action.${ event }`,
- 'tests',
- callback
- ),
- } ),
- elements: () => ( {
- create: () => ( { on: () => null } ),
- } ),
- } ),
- };
- } );
-
- afterEach( () => {
- jest.resetAllMocks();
- } );
-
- it( 'should initialize the Stripe payment request, fire initial tracking, and attach event listeners', async () => {
- const headers = new Headers();
- headers.append( 'Nonce', 'nonce-value' );
-
- apiFetch.mockResolvedValue( {
- headers: headers,
- json: () =>
- Promise.resolve( {
- needs_shipping: false,
- totals: {
- currency_code: 'USD',
- total_price: '20',
- total_tax: '0',
- total_shipping: '5',
- },
- items: [
- { name: 'Shirt', quantity: 1, prices: { price: '15' } },
- ],
- } ),
- } );
- const paymentRequestAvailabilityCallback = jest.fn();
- addAction(
- 'wcpay.payment-request.availability',
- 'test',
- paymentRequestAvailabilityCallback
- );
-
- const cartApi = new PaymentRequestCartApi();
- const paymentRequest = new WooPaymentsPaymentRequest( {
- wcpayApi: wcpayApi,
- paymentRequestCartApi: cartApi,
- } );
-
- expect( paymentRequestAvailabilityCallback ).not.toHaveBeenCalled();
- expect( trackPaymentRequestButtonLoad ).not.toHaveBeenCalled();
-
- await paymentRequest.init();
-
- expect( paymentRequestAvailabilityCallback ).toHaveBeenCalledTimes( 1 );
- expect( paymentRequestAvailabilityCallback ).toHaveBeenCalledWith(
- expect.objectContaining( { paymentRequestType: 'google_pay' } )
- );
- expect( trackPaymentRequestButtonLoad ).toHaveBeenCalledWith( 'cart' );
-
- await applyFilters(
- 'wcpay.payment-request.update-button-data',
- Promise.resolve()
- );
- expect( paymentRequestAvailabilityCallback ).toHaveBeenCalledTimes( 1 );
-
- // firing this should initialize the button again.
- doAction( 'payment-request-test.registered-action.cancel' );
-
- await applyFilters(
- 'wcpay.payment-request.update-button-data',
- Promise.resolve()
- );
- expect( paymentRequestAvailabilityCallback ).toHaveBeenCalledTimes( 2 );
- } );
-} );
diff --git a/client/tokenized-payment-request/tracking.js b/client/tokenized-payment-request/tracking.js
deleted file mode 100644
index 403160a80fe..00000000000
--- a/client/tokenized-payment-request/tracking.js
+++ /dev/null
@@ -1,36 +0,0 @@
-/**
- * External dependencies
- */
-import { debounce } from 'lodash';
-import { recordUserEvent } from 'tracks';
-
-let paymentRequestBranding;
-
-// Track the payment request button click event.
-export const trackPaymentRequestButtonClick = ( source ) => {
- const paymentRequestTypeEvents = {
- google_pay: 'gpay_button_click',
- apple_pay: 'applepay_button_click',
- };
-
- const event = paymentRequestTypeEvents[ paymentRequestBranding ];
- if ( ! event ) return;
-
- recordUserEvent( event, { source } );
-};
-
-// Track the payment request button load event.
-export const trackPaymentRequestButtonLoad = debounce( ( source ) => {
- const paymentRequestTypeEvents = {
- google_pay: 'gpay_button_load',
- apple_pay: 'applepay_button_load',
- };
-
- const event = paymentRequestTypeEvents[ paymentRequestBranding ];
- if ( ! event ) return;
-
- recordUserEvent( event, { source } );
-}, 1000 );
-
-export const setPaymentRequestBranding = ( branding ) =>
- ( paymentRequestBranding = branding );
diff --git a/client/tokenized-payment-request/transformers/stripe-to-wc.js b/client/tokenized-payment-request/transformers/stripe-to-wc.js
deleted file mode 100644
index e8902213c33..00000000000
--- a/client/tokenized-payment-request/transformers/stripe-to-wc.js
+++ /dev/null
@@ -1,103 +0,0 @@
-/**
- * Transform shipping address information from Stripe's address object to
- * the cart shipping address object shape.
- *
- * @param {Object} shippingAddress Stripe's shipping address item
- *
- * @return {Object} The shipping address in the shape expected by the cart.
- */
-export const transformStripeShippingAddressForStoreApi = (
- shippingAddress
-) => {
- return {
- shipping_address: {
- first_name:
- shippingAddress.recipient
- ?.split( ' ' )
- ?.slice( 0, 1 )
- ?.join( ' ' ) ?? '',
- last_name:
- shippingAddress.recipient
- ?.split( ' ' )
- ?.slice( 1 )
- ?.join( ' ' ) ?? '',
- company: shippingAddress.organization ?? '',
- address_1: shippingAddress.addressLine?.[ 0 ] ?? '',
- address_2: shippingAddress.addressLine?.[ 1 ] ?? '',
- city: shippingAddress.city ?? '',
- state: shippingAddress.region ?? '',
- country: shippingAddress.country ?? '',
- postcode: shippingAddress.postalCode?.replace( ' ', '' ) ?? '',
- },
- };
-};
-
-/**
- * Transform order data from Stripe's object to the expected format for WC.
- *
- * @param {Object} paymentData Stripe's order object.
- *
- * @return {Object} Order object in the format WooCommerce expects.
- */
-export const transformStripePaymentMethodForStoreApi = ( paymentData ) => {
- const name =
- ( paymentData.paymentMethod?.billing_details?.name ??
- paymentData.payerName ) ||
- '';
- const billing = paymentData.paymentMethod?.billing_details?.address ?? {};
- const shipping = paymentData.shippingAddress ?? {};
-
- const paymentRequestType =
- paymentData.walletName === 'applePay' ? 'apple_pay' : 'google_pay';
-
- const billingPhone =
- paymentData.paymentMethod?.billing_details?.phone ??
- paymentData.payerPhone?.replace( '/[() -]/g', '' ) ??
- '';
- return {
- customer_note: paymentData.order_comments,
- billing_address: {
- first_name: name.split( ' ' )?.slice( 0, 1 )?.join( ' ' ) ?? '',
- last_name: name.split( ' ' )?.slice( 1 )?.join( ' ' ) || '-',
- company: billing.organization ?? '',
- address_1: billing.line1 ?? '',
- address_2: billing.line2 ?? '',
- city: billing.city ?? '',
- state: billing.state ?? '',
- postcode: billing.postal_code ?? '',
- country: billing.country ?? '',
- email:
- paymentData.paymentMethod?.billing_details?.email ??
- paymentData.payerEmail ??
- '',
- phone: billingPhone,
- },
- // refreshing any shipping address data, now that the customer is placing the order.
- shipping_address: {
- ...transformStripeShippingAddressForStoreApi( shipping )
- .shipping_address,
- // adding the phone number, because it might be needed.
- // Stripe doesn't provide us with a different phone number for shipping, so we're going to use the same phone used for billing.
- phone: billingPhone,
- },
- payment_method: 'woocommerce_payments',
- payment_data: [
- {
- key: 'payment_method',
- value: 'card',
- },
- {
- key: 'payment_request_type',
- value: paymentRequestType,
- },
- {
- key: 'wcpay-fraud-prevention-token',
- value: window.wcpayFraudPreventionToken ?? '',
- },
- {
- key: 'wcpay-payment-method',
- value: paymentData.paymentMethod?.id,
- },
- ],
- };
-};
diff --git a/includes/class-wc-payments-payment-request-button-handler.php b/includes/class-wc-payments-payment-request-button-handler.php
deleted file mode 100644
index 82b33593008..00000000000
--- a/includes/class-wc-payments-payment-request-button-handler.php
+++ /dev/null
@@ -1,873 +0,0 @@
-account = $account;
- $this->gateway = $gateway;
- $this->express_checkout_helper = $express_checkout_helper;
- }
-
- /**
- * Initialize hooks.
- *
- * @return void
- */
- public function init() {
- // Checks if WCPay is enabled.
- if ( ! $this->gateway->is_enabled() ) {
- return;
- }
-
- if ( ! WC_Payments_Features::is_tokenized_cart_ece_enabled() ) {
- return;
- }
-
- // Checks if Payment Request is enabled.
- if ( 'yes' !== $this->gateway->get_option( 'payment_request' ) ) {
- return;
- }
-
- // Don't load for change payment method page.
- if ( isset( $_GET['change_payment_method'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification
- return;
- }
-
- add_action( 'template_redirect', [ $this, 'set_session' ] );
- add_action( 'template_redirect', [ $this, 'handle_payment_request_redirect' ] );
- add_action( 'wp_enqueue_scripts', [ $this, 'scripts' ] );
-
- add_filter( 'woocommerce_gateway_title', [ $this, 'filter_gateway_title' ], 10, 2 );
- 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 a filter for the value of `wcpay_is_apple_pay_enabled`.
- // This option does not get stored in the database at all, and this function
- // will be used to calculate it whenever the option value is retrieved instead.
- // It's used for displaying inbox notifications.
- add_filter( 'pre_option_wcpay_is_apple_pay_enabled', [ $this, 'get_option_is_apple_pay_enabled' ], 10, 1 );
- }
-
- /**
- * Checks whether authentication is required for checkout.
- *
- * @return bool
- */
- public function is_authentication_required() {
- // If guest checkout is disabled and account creation is not possible, authentication is required.
- if ( 'no' === get_option( 'woocommerce_enable_guest_checkout', 'yes' ) && ! $this->is_account_creation_possible() ) {
- return true;
- }
- // If cart contains subscription and account creation is not posible, authentication is required.
- if ( $this->has_subscription_product() && ! $this->is_account_creation_possible() ) {
- return true;
- }
-
- return false;
- }
-
- /**
- * Checks whether account creation is possible during checkout.
- *
- * @return bool
- */
- public function is_account_creation_possible() {
- $is_signup_from_checkout_allowed = 'yes' === get_option( 'woocommerce_enable_signup_and_login_from_checkout', 'no' );
-
- // If a subscription is being purchased, check if account creation is allowed for subscriptions.
- if ( ! $is_signup_from_checkout_allowed && $this->has_subscription_product() ) {
- $is_signup_from_checkout_allowed = 'yes' === get_option( 'woocommerce_enable_signup_from_checkout_for_subscriptions', 'no' );
- }
-
- // If automatically generate username/password are disabled, the Payment Request API
- // can't include any of those fields, so account creation is not possible.
- return (
- $is_signup_from_checkout_allowed &&
- 'yes' === get_option( 'woocommerce_registration_generate_username', 'yes' ) &&
- 'yes' === get_option( 'woocommerce_registration_generate_password', 'yes' )
- );
- }
-
- /**
- * Sets the WC customer session if one is not set.
- * This is needed so nonces can be verified by AJAX Request.
- *
- * @return void
- */
- public function set_session() {
- // Don't set session cookies on product pages to allow for caching when payment request
- // buttons are disabled. But keep cookies if there is already an active WC session in place.
- if (
- ! ( $this->express_checkout_helper->is_product() && $this->should_show_payment_request_button() )
- || ( isset( WC()->session ) && WC()->session->has_session() )
- ) {
- return;
- }
-
- WC()->session->set_customer_session_cookie( true );
- }
-
- /**
- * Handles payment request redirect when the redirect dialog "Continue" button is clicked.
- */
- public function handle_payment_request_redirect() {
- if (
- ! empty( $_GET['wcpay_payment_request_redirect_url'] )
- && ! empty( $_GET['_wpnonce'] )
- && wp_verify_nonce( $_GET['_wpnonce'], 'wcpay-set-redirect-url' ) // @codingStandardsIgnoreLine
- ) {
- $url = rawurldecode( esc_url_raw( wp_unslash( $_GET['wcpay_payment_request_redirect_url'] ) ) );
- // Sets a redirect URL cookie for 10 minutes, which we will redirect to after authentication.
- // Users will have a 10 minute timeout to login/create account, otherwise redirect URL expires.
- wc_setcookie( 'wcpay_payment_request_redirect_url', $url, time() + MINUTE_IN_SECONDS * 10 );
- // Redirects to "my-account" page.
- wp_safe_redirect( get_permalink( get_option( 'woocommerce_myaccount_page_id' ) ) );
- }
- }
-
- /**
- * The settings for the `button` attribute - they depend on the "grouped settings" flag value.
- *
- * @return array
- */
- public function get_button_settings() {
- $button_type = $this->gateway->get_option( 'payment_request_button_type' );
- $common_settings = $this->express_checkout_helper->get_common_button_settings();
- $payment_request_button_settings = [
- // Default format is en_US.
- 'locale' => apply_filters( 'wcpay_payment_request_button_locale', substr( get_locale(), 0, 2 ) ),
- 'branded_type' => 'default' === $button_type ? 'short' : 'long',
- ];
-
- return array_merge( $common_settings, $payment_request_button_settings );
- }
-
- /**
- * Gets the product total price.
- *
- * @param object $product WC_Product_* object.
- * @param bool $is_deposit Whether customer is paying a deposit.
- * @param int $deposit_plan_id The ID of the deposit plan.
- *
- * @return mixed Total price.
- *
- * @throws Invalid_Price_Exception Whenever a product has no price.
- */
- public function get_product_price( $product, ?bool $is_deposit = null, int $deposit_plan_id = 0 ) {
- // 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' ) && class_exists( 'WC_Deposits_Plans_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_selected_type( $product->get_id() );
- }
- if ( $is_deposit ) {
- $deposit_type = WC_Deposits_Product_Manager::get_deposit_type( $product->get_id() );
- $available_plan_ids = WC_Deposits_Plans_Manager::get_plan_ids_for_product( $product->get_id() );
- // Default to first (default) plan if no plan is specified.
- if ( 'plan' === $deposit_type && 0 === $deposit_plan_id && ! empty( $available_plan_ids ) ) {
- $deposit_plan_id = $available_plan_ids[0];
- }
-
- // Ensure the selected plan is available for the product.
- if ( 0 === $deposit_plan_id || in_array( $deposit_plan_id, $available_plan_ids, true ) ) {
- $base_price = WC_Deposits_Product_Manager::get_deposit_amount( $product, $deposit_plan_id, 'display', $base_price );
- }
- }
- }
-
- // Add subscription sign-up fees to product price.
- $sign_up_fee = 0;
- $subscription_types = [
- 'subscription',
- 'subscription_variation',
- ];
- if ( in_array( $product->get_type(), $subscription_types, true ) && class_exists( 'WC_Subscriptions_Product' ) ) {
- // When there is no sign-up fee, `get_sign_up_fee` falls back to an int 0.
- $sign_up_fee = WC_Subscriptions_Product::get_sign_up_fee( $product );
- }
-
- if ( ! is_numeric( $base_price ) || ! is_numeric( $sign_up_fee ) ) {
- $error_message = sprintf(
- // Translators: %d is the numeric ID of the product without a price.
- __( 'Express checkout does not support products without prices! Please add a price to product #%d', 'woocommerce-payments' ),
- (int) $product->get_id()
- );
- throw new Invalid_Price_Exception(
- esc_html( $error_message )
- );
- }
-
- return $base_price + $sign_up_fee;
- }
-
- /**
- * Gets the product data for the currently viewed page.
- *
- * @return mixed Returns false if not on a product page, the product information otherwise.
- */
- public function get_product_data() {
- if ( ! $this->express_checkout_helper->is_product() ) {
- return false;
- }
-
- /** @var WC_Product_Variable $product */ // phpcs:ignore
- $product = $this->express_checkout_helper->get_product();
- $currency = get_woocommerce_currency();
-
- if ( 'variable' === $product->get_type() || 'variable-subscription' === $product->get_type() ) {
- $variation_attributes = $product->get_variation_attributes();
- $attributes = [];
-
- foreach ( $variation_attributes as $attribute_name => $attribute_values ) {
- $attribute_key = 'attribute_' . sanitize_title( $attribute_name );
-
- // Passed value via GET takes precedence. Otherwise get the default value for given attribute.
- $attributes[ $attribute_key ] = isset( $_GET[ $attribute_key ] ) // phpcs:ignore WordPress.Security.NonceVerification
- ? wc_clean( wp_unslash( $_GET[ $attribute_key ] ) ) // phpcs:ignore WordPress.Security.NonceVerification
- : $product->get_variation_default_attribute( $attribute_name );
- }
-
- $data_store = WC_Data_Store::load( 'product' );
- $variation_id = $data_store->find_matching_product_variation( $product, $attributes );
-
- if ( ! empty( $variation_id ) ) {
- $product = wc_get_product( $variation_id );
- }
- }
-
- try {
- $price = $this->get_product_price( $product );
- } catch ( Invalid_Price_Exception $e ) {
- Logger::log( $e->getMessage() );
-
- return false;
- }
-
- $data = [];
- $items = [];
-
- $items[] = [
- 'label' => $product->get_name(),
- 'amount' => WC_Payments_Utils::prepare_amount( $price, $currency ),
- ];
-
- $total_tax = 0;
- foreach ( $this->get_taxes_like_cart( $product, $price ) as $tax ) {
- $total_tax += $tax;
-
- $items[] = [
- 'label' => __( 'Tax', 'woocommerce-payments' ),
- 'amount' => WC_Payments_Utils::prepare_amount( $tax, $currency ),
- 'pending' => 0 === $tax,
- ];
- }
-
- if ( wc_shipping_enabled() && 0 !== wc_get_shipping_method_count( true ) && $product->needs_shipping() ) {
- $items[] = [
- 'label' => __( 'Shipping', 'woocommerce-payments' ),
- 'amount' => 0,
- 'pending' => true,
- ];
-
- $data['shippingOptions'] = [
- 'id' => 'pending',
- 'label' => __( 'Pending', 'woocommerce-payments' ),
- 'detail' => '',
- 'amount' => 0,
- ];
- }
-
- $data['displayItems'] = $items;
- $data['total'] = [
- 'label' => apply_filters( 'wcpay_payment_request_total_label', $this->express_checkout_helper->get_total_label() ),
- 'amount' => WC_Payments_Utils::prepare_amount( $price + $total_tax, $currency ),
- 'pending' => true,
- ];
-
- $data['needs_shipping'] = ( wc_shipping_enabled() && 0 !== wc_get_shipping_method_count( true ) && $product->needs_shipping() );
- $data['currency'] = strtolower( $currency );
- $data['country_code'] = substr( get_option( 'woocommerce_default_country' ), 0, 2 );
-
- return apply_filters( 'wcpay_payment_request_product_data', $data, $product );
- }
-
- /**
- * Filters the gateway title to reflect Payment Request type
- *
- * @param string $title Gateway title.
- * @param string $id Gateway ID.
- */
- public function filter_gateway_title( $title, $id ) {
- if ( 'woocommerce_payments' !== $id || ! is_admin() ) {
- return $title;
- }
-
- $order = $this->get_current_order();
- $method_title = is_object( $order ) ? $order->get_payment_method_title() : '';
-
- if ( ! empty( $method_title ) ) {
- if (
- strpos( $method_title, 'Apple Pay' ) === 0
- || strpos( $method_title, 'Google Pay' ) === 0
- || strpos( $method_title, 'Payment Request' ) === 0
- ) {
- return $method_title;
- }
- }
-
- return $title;
- }
-
- /**
- * Used to get the order in admin edit page.
- *
- * @return WC_Order|WC_Order_Refund|bool
- */
- private function get_current_order() {
- global $theorder;
- global $post;
-
- if ( is_object( $theorder ) ) {
- return $theorder;
- }
-
- if ( is_object( $post ) ) {
- return wc_get_order( $post->ID );
- }
-
- return false;
- }
-
- /**
- * Normalizes postal code in case of redacted data from Apple Pay.
- *
- * @param string $postcode Postal code.
- * @param string $country Country.
- */
- public function get_normalized_postal_code( $postcode, $country ) {
- /**
- * Currently, Apple Pay truncates the UK and Canadian postal codes to the first 4 and 3 characters respectively
- * when passing it back from the shippingcontactselected object. This causes WC to invalidate
- * the postal code and not calculate shipping zones correctly.
- */
- if ( Country_Code::UNITED_KINGDOM === $country ) {
- // Replaces a redacted string with something like N1C0000.
- return str_pad( preg_replace( '/\s+/', '', $postcode ), 7, '0' );
- }
- if ( Country_Code::CANADA === $country ) {
- // Replaces a redacted string with something like H3B000.
- return str_pad( preg_replace( '/\s+/', '', $postcode ), 6, '0' );
- }
-
- return $postcode;
- }
-
- /**
- * Add needed order meta
- *
- * @param integer $order_id The order ID.
- *
- * @return void
- */
- public function add_order_meta( $order_id ) {
- if ( empty( $_POST['payment_request_type'] ) || ! isset( $_POST['payment_method'] ) || 'woocommerce_payments' !== $_POST['payment_method'] ) { // phpcs:ignore WordPress.Security.NonceVerification
- return;
- }
-
- $order = wc_get_order( $order_id );
-
- $payment_request_type = wc_clean( wp_unslash( $_POST['payment_request_type'] ) ); // phpcs:ignore WordPress.Security.NonceVerification
-
- $payment_method_titles = [
- 'apple_pay' => 'Apple Pay',
- 'google_pay' => 'Google Pay',
- ];
-
- $suffix = apply_filters( 'wcpay_payment_request_payment_method_title_suffix', 'WooPayments' );
- if ( ! empty( $suffix ) ) {
- $suffix = " ($suffix)";
- }
-
- $payment_method_title = isset( $payment_method_titles[ $payment_request_type ] ) ? $payment_method_titles[ $payment_request_type ] : 'Payment Request';
- $order->set_payment_method_title( $payment_method_title . $suffix );
- $order->save();
- }
-
- /**
- * Checks whether Payment Request Button should be available on this page.
- *
- * @return bool
- */
- public function should_show_payment_request_button() {
- // If account is not connected, then bail.
- if ( ! $this->account->is_stripe_connected() ) {
- return false;
- }
-
- // If no SSL, bail.
- if ( ! WC_Payments::mode()->is_test() && ! is_ssl() ) {
- Logger::log( 'Stripe Payment Request live mode requires SSL.' );
-
- return false;
- }
-
- // Page not supported.
- if ( ! $this->express_checkout_helper->is_product() && ! $this->express_checkout_helper->is_cart() && ! $this->express_checkout_helper->is_checkout() ) {
- return false;
- }
-
- // Product page, but not available in settings.
- if ( $this->express_checkout_helper->is_product() && ! $this->express_checkout_helper->is_available_at( 'product', self::BUTTON_LOCATIONS ) ) {
- return false;
- }
-
- // Checkout page, but not available in settings.
- if ( $this->express_checkout_helper->is_checkout() && ! $this->express_checkout_helper->is_available_at( 'checkout', self::BUTTON_LOCATIONS ) ) {
- return false;
- }
-
- // Cart page, but not available in settings.
- if ( $this->express_checkout_helper->is_cart() && ! $this->express_checkout_helper->is_available_at( 'cart', self::BUTTON_LOCATIONS ) ) {
- return false;
- }
-
- // Product page, but has unsupported product type.
- if ( $this->express_checkout_helper->is_product() && ! apply_filters( 'wcpay_payment_request_is_product_supported', $this->is_product_supported(), $this->express_checkout_helper->get_product() ) ) {
- Logger::log( 'Product page has unsupported product type ( Payment Request button disabled )' );
-
- return false;
- }
-
- // Cart has unsupported product type.
- if ( ( $this->express_checkout_helper->is_checkout() || $this->express_checkout_helper->is_cart() ) && ! $this->has_allowed_items_in_cart() ) {
- Logger::log( 'Items in the cart have unsupported product type ( Payment Request button disabled )' );
-
- return false;
- }
-
- // Order total doesn't matter for Pay for Order page. Thus, this page should always display payment buttons.
- if ( $this->express_checkout_helper->is_pay_for_order_page() ) {
- return true;
- }
-
- // Cart total is 0 or is on product page and product price is 0.
- // Exclude pay-for-order pages from this check.
- if (
- ( ! $this->express_checkout_helper->is_product() && ! $this->express_checkout_helper->is_pay_for_order_page() && 0.0 === (float) WC()->cart->get_total( 'edit' ) ) ||
- ( $this->express_checkout_helper->is_product() && 0.0 === (float) $this->express_checkout_helper->get_product()->get_price() )
-
- ) {
- Logger::log( 'Order price is 0 ( Payment Request button disabled )' );
-
- return false;
- }
-
- return true;
- }
-
- /**
- * Checks to make sure product type is supported.
- *
- * @return array
- */
- public function supported_product_types() {
- return apply_filters(
- 'wcpay_payment_request_supported_types',
- [
- 'simple',
- 'variable',
- 'variation',
- 'subscription',
- 'variable-subscription',
- 'subscription_variation',
- 'booking',
- 'bundle',
- 'composite',
- 'mix-and-match',
- ]
- );
- }
-
- /**
- * Checks the cart to see if all items are allowed to be used.
- *
- * @return boolean
- */
- public function has_allowed_items_in_cart() {
- // Pre Orders compatbility where we don't support charge upon release.
- if ( class_exists( 'WC_Pre_Orders_Cart' ) && WC_Pre_Orders_Cart::cart_contains_pre_order() && class_exists( 'WC_Pre_Orders_Product' ) && WC_Pre_Orders_Product::product_is_charged_upon_release( WC_Pre_Orders_Cart::get_pre_order_product() ) ) {
- return false;
- }
-
- foreach ( WC()->cart->get_cart() as $cart_item_key => $cart_item ) {
- $_product = apply_filters( 'woocommerce_cart_item_product', $cart_item['data'], $cart_item, $cart_item_key );
-
- if ( ! in_array( $_product->get_type(), $this->supported_product_types(), true ) ) {
- return false;
- }
-
- /**
- * Filter whether product supports Payment Request Button on cart page.
- *
- * @param boolean $is_supported Whether product supports Payment Request Button on cart page.
- * @param object $_product Product object.
- *
- * @since 6.9.0
- */
- if ( ! apply_filters( 'wcpay_payment_request_is_cart_supported', true, $_product ) ) {
- return false;
- }
-
- // Trial subscriptions with shipping are not supported.
- if ( class_exists( 'WC_Subscriptions_Product' ) && WC_Subscriptions_Product::is_subscription( $_product ) && $_product->needs_shipping() && WC_Subscriptions_Product::get_trial_length( $_product ) > 0 ) {
- return false;
- }
- }
-
- // We don't support multiple packages with Payment Request Buttons because we can't offer a good UX.
- $packages = WC()->cart->get_shipping_packages();
- if ( 1 < ( is_countable( $packages ) ? count( $packages ) : 0 ) ) {
- return false;
- }
-
- return true;
- }
-
- /**
- * Checks whether cart contains a subscription product or this is a subscription product page.
- *
- * @return boolean
- */
- public function has_subscription_product() {
- if ( ! class_exists( 'WC_Subscriptions_Product' ) ) {
- return false;
- }
-
- if ( $this->express_checkout_helper->is_product() ) {
- $product = $this->express_checkout_helper->get_product();
- if ( WC_Subscriptions_Product::is_subscription( $product ) ) {
- return true;
- }
- }
-
- if ( $this->express_checkout_helper->is_checkout() || $this->express_checkout_helper->is_cart() ) {
- if ( WC_Subscriptions_Cart::cart_contains_subscription() ) {
- return true;
- }
- }
-
- return false;
- }
-
- /**
- * Returns the login redirect URL.
- *
- * @param string $redirect Default redirect URL.
- *
- * @return string Redirect URL.
- */
- public function get_login_redirect_url( $redirect ) {
- $url = esc_url_raw( wp_unslash( $_COOKIE['wcpay_payment_request_redirect_url'] ?? '' ) );
-
- if ( empty( $url ) ) {
- return $redirect;
- }
- wc_setcookie( 'wcpay_payment_request_redirect_url', '' );
-
- return $url;
- }
-
- /**
- * Load public scripts and styles.
- */
- public function scripts() {
- // Don't load scripts if page is not supported.
- if ( ! $this->should_show_payment_request_button() ) {
- return;
- }
-
- $payment_request_params = [
- 'ajax_url' => admin_url( 'admin-ajax.php' ),
- 'stripe' => [
- 'publishableKey' => $this->account->get_publishable_key( WC_Payments::mode()->is_test() ),
- 'accountId' => $this->account->get_stripe_account_id(),
- 'locale' => WC_Payments_Utils::convert_to_stripe_locale( get_locale() ),
- ],
- 'nonce' => [
- 'get_cart_details' => wp_create_nonce( 'wcpay-get-cart-details' ),
- 'shipping' => wp_create_nonce( 'wcpay-payment-request-shipping' ),
- 'update_shipping' => wp_create_nonce( 'wcpay-update-shipping-method' ),
- 'checkout' => wp_create_nonce( 'woocommerce-process_checkout' ),
- 'add_to_cart' => wp_create_nonce( 'wcpay-add-to-cart' ),
- 'empty_cart' => wp_create_nonce( 'wcpay-empty-cart' ),
- 'get_selected_product_data' => wp_create_nonce( 'wcpay-get-selected-product-data' ),
- 'platform_tracker' => wp_create_nonce( 'platform_tracks_nonce' ),
- 'pay_for_order' => wp_create_nonce( 'pay_for_order' ),
- 'tokenized_cart_nonce' => wp_create_nonce( 'woopayments_tokenized_cart_nonce' ),
- 'tokenized_cart_session_nonce' => wp_create_nonce( 'woopayments_tokenized_cart_session_nonce' ),
- 'store_api_nonce' => wp_create_nonce( 'wc_store_api' ),
- ],
- 'checkout' => [
- 'currency_code' => strtolower( get_woocommerce_currency() ),
- 'currency_decimals' => WC_Payments::get_localization_service()->get_currency_format( get_woocommerce_currency() )['num_decimals'],
- 'country_code' => substr( get_option( 'woocommerce_default_country' ), 0, 2 ),
- 'needs_shipping' => WC()->cart->needs_shipping(),
- // Defaults to 'required' to match how core initializes this option.
- 'needs_payer_phone' => 'required' === get_option( 'woocommerce_checkout_phone_field', 'required' ),
- ],
- 'button' => $this->get_button_settings(),
- 'login_confirmation' => $this->get_login_confirmation_settings(),
- 'has_block' => has_block( 'woocommerce/cart' ) || has_block( 'woocommerce/checkout' ),
- 'product' => $this->get_product_data(),
- 'total_label' => $this->express_checkout_helper->get_total_label(),
- 'button_context' => $this->express_checkout_helper->get_button_context(),
- 'is_product_page' => $this->express_checkout_helper->is_product(),
- 'is_pay_for_order' => $this->express_checkout_helper->is_pay_for_order_page(),
- 'is_checkout_page' => $this->express_checkout_helper->is_checkout(),
- ];
-
- if ( WC_Payments_Features::is_tokenized_cart_ece_enabled() ) {
- WC_Payments::register_script_with_dependencies(
- 'WCPAY_PAYMENT_REQUEST',
- 'dist/tokenized-payment-request',
- [
- 'jquery',
- 'stripe',
- ]
- );
- WC_Payments_Utils::enqueue_style(
- 'WCPAY_PAYMENT_REQUEST',
- plugins_url( 'dist/tokenized-payment-request.css', WCPAY_PLUGIN_FILE ),
- [],
- WC_Payments::get_file_version( 'dist/tokenized-payment-request.css' )
- );
- }
-
- wp_localize_script( 'WCPAY_PAYMENT_REQUEST', 'wcpayPaymentRequestParams', $payment_request_params );
-
- wp_set_script_translations( 'WCPAY_PAYMENT_REQUEST', 'woocommerce-payments' );
-
- wp_enqueue_script( 'WCPAY_PAYMENT_REQUEST' );
-
- Fraud_Prevention_Service::maybe_append_fraud_prevention_token();
-
- $gateways = WC()->payment_gateways->get_available_payment_gateways();
- if ( isset( $gateways['woocommerce_payments'] ) ) {
- WC_Payments::get_wc_payments_checkout()->register_scripts();
- }
- }
-
- /**
- * Display the payment request button.
- */
- public function display_payment_request_button_html() {
- if ( ! $this->should_show_payment_request_button() ) {
- return;
- }
- ?>
-
-
-
- express_checkout_helper->get_product();
- if ( is_null( $product ) ) {
- return false;
- }
-
- if ( ! is_object( $product ) ) {
- return false;
- }
-
- if ( ! in_array( $product->get_type(), $this->supported_product_types(), true ) ) {
- return false;
- }
-
- // Trial subscriptions with shipping are not supported.
- if ( class_exists( 'WC_Subscriptions_Product' ) && $product->needs_shipping() && WC_Subscriptions_Product::get_trial_length( $product ) > 0 ) {
- return false;
- }
-
- // Pre Orders charge upon release not supported.
- if ( class_exists( 'WC_Pre_Orders_Product' ) && WC_Pre_Orders_Product::product_is_charged_upon_release( $product ) ) {
- return false;
- }
-
- // Composite products are not supported on the product page.
- if ( class_exists( 'WC_Composite_Products' ) && $product->is_type( 'composite' ) ) {
- return false;
- }
-
- // Mix and match products are not supported on the product page.
- if ( class_exists( 'WC_Mix_and_Match' ) && $product->is_type( 'mix-and-match' ) ) {
- return false;
- }
-
- if ( class_exists( 'WC_Product_Addons_Helper' ) ) {
- // File upload addon not supported.
- $product_addons = WC_Product_Addons_Helper::get_product_addons( $product->get_id() );
- foreach ( $product_addons as $addon ) {
- if ( 'file_upload' === $addon['type'] ) {
- return false;
- }
- }
- }
-
- return true;
- }
-
- /**
- * Determine wether 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->has_subscription_product() && wc_get_shipping_method_count( true, true ) === 0 ) {
- return false;
- }
-
- return $needs_shipping_address;
- }
-
- /**
- * Calculates whether Apple Pay is enabled for this store.
- * The option value is not stored in the database, and is calculated
- * using this function instead, and the values is returned by using the pre_option filter.
- *
- * The option value is retrieved for inbox notifications.
- *
- * @param mixed $value The value of the option.
- */
- public function get_option_is_apple_pay_enabled( $value ) {
- // Return a random value (1 or 2) if the account is live and payment request buttons are enabled.
- if (
- $this->gateway->is_enabled()
- && 'yes' === $this->gateway->get_option( 'payment_request' )
- && ! WC_Payments::mode()->is_dev()
- && $this->account->get_is_live()
- ) {
- $value = wp_rand( 1, 2 );
- }
-
- return $value;
- }
-
- /**
- * Settings array for the user authentication dialog and redirection.
- *
- * @return array|false
- */
- public function get_login_confirmation_settings() {
- if ( is_user_logged_in() || ! $this->is_authentication_required() ) {
- return false;
- }
-
- /* translators: The text encapsulated in `**` can be replaced with "Apple Pay" or "Google Pay". Please translate this text, but don't remove the `**`. */
- $message = __( 'To complete your transaction with **the selected payment method**, you must log in or create an account with our site.', 'woocommerce-payments' );
- $redirect_url = add_query_arg(
- [
- '_wpnonce' => wp_create_nonce( 'wcpay-set-redirect-url' ),
- 'wcpay_payment_request_redirect_url' => rawurlencode( home_url( add_query_arg( [] ) ) ),
- // Current URL to redirect to after login.
- ],
- home_url()
- );
-
- return [ // nosemgrep: audit.php.wp.security.xss.query-arg -- home_url passed in to add_query_arg.
- 'message' => $message,
- 'redirect_url' => $redirect_url,
- ];
- }
-
- /**
- * Calculates taxes as displayed on cart, based on a product and a particular price.
- *
- * @param WC_Product $product The product, for retrieval of tax classes.
- * @param float $price The price, which to calculate taxes for.
- *
- * @return array An array of final taxes.
- */
- private function get_taxes_like_cart( $product, $price ) {
- if ( ! wc_tax_enabled() || $this->express_checkout_helper->cart_prices_include_tax() ) {
- // Only proceed when taxes are enabled, but not included.
- return [];
- }
-
- // Follows the way `WC_Cart_Totals::get_item_tax_rates()` works.
- $tax_class = $product->get_tax_class();
- $rates = WC_Tax::get_rates( $tax_class );
- // No cart item, `woocommerce_cart_totals_get_item_tax_rates` can't be applied here.
-
- // Normally there should be a single tax, but `calc_tax` returns an array, let's use it.
- return WC_Tax::calc_tax( $price, $rates, false );
- }
-}
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
index 2a5164e8af3..d0692a8a2b8 100644
--- a/psalm-baseline.xml
+++ b/psalm-baseline.xml
@@ -24,13 +24,6 @@
WC_Pre_Orders_Product
-
-
- WC_Pre_Orders_Product
- WC_Subscriptions_Product
- WC_Subscriptions_Cart
-
-
WC_Subscriptions_Cart
diff --git a/tests/js/jest.config.js b/tests/js/jest.config.js
index b81f434b8c5..7a918a8d63c 100644
--- a/tests/js/jest.config.js
+++ b/tests/js/jest.config.js
@@ -45,8 +45,6 @@ module.exports = {
'/.*/build-module/',
'/docker/',
'/tests/e2e',
- // We'll delete the directory and its contents as part of https://github.com/Automattic/woocommerce-payments/issues/9722 .
- '/client/tokenized-payment-request',
],
transform: {
...tsjPreset.transform,
diff --git a/tests/unit/bootstrap.php b/tests/unit/bootstrap.php
index 99f99b071c2..89ef79bfb11 100755
--- a/tests/unit/bootstrap.php
+++ b/tests/unit/bootstrap.php
@@ -96,8 +96,6 @@ function () {
require_once $_plugin_dir . 'includes/admin/class-wc-rest-payments-customer-controller.php';
require_once $_plugin_dir . 'includes/admin/class-wc-rest-payments-refunds-controller.php';
- require_once $_plugin_dir . 'includes/class-wc-payments-payment-request-button-handler.php';
-
// Load currency helper class early to ensure its implementation is used over the one resolved during further test initialization.
require_once __DIR__ . '/helpers/class-wc-helper-site-currency.php';
diff --git a/tests/unit/test-class-wc-payments-payment-request-button-handler.php b/tests/unit/test-class-wc-payments-payment-request-button-handler.php
deleted file mode 100644
index b34299b76f6..00000000000
--- a/tests/unit/test-class-wc-payments-payment-request-button-handler.php
+++ /dev/null
@@ -1,650 +0,0 @@
- Country_Code::UNITED_STATES,
- 'state' => 'CA',
- 'postcode' => '94110',
- 'city' => 'San Francisco',
- 'address_1' => '60 29th Street',
- 'address_2' => '#343',
- ];
-
- /**
- * Mock WC_Payments_API_Client.
- *
- * @var WC_Payments_API_Client
- */
- private $mock_api_client;
-
- /**
- * Payment request instance.
- *
- * @var WC_Payments_Payment_Request_Button_Handler
- */
- private $pr;
-
- /**
- * WC_Payments_Account instance.
- *
- * @var WC_Payments_Account
- */
- private $mock_wcpay_account;
-
- /**
- * Test product to add to the cart
- * @var WC_Product_Simple
- */
- private $simple_product;
-
- /**
- * Test shipping zone.
- *
- * @var WC_Shipping_Zone
- */
- private $zone;
-
- /**
- * Flat rate shipping method instance id
- *
- * @var int
- */
- private $flat_rate_id;
-
- /**
- * Flat rate shipping method instance id
- *
- * @var int
- */
- private $local_pickup_id;
-
- /**
- * Used to get the settings.
- *
- * @var WC_Payment_Gateway_WCPay
- */
- private $mock_wcpay_gateway;
-
- /**
- * Express Checkout Helper instance.
- *
- * @var WC_Payments_Express_Checkout_Button_Helper
- */
- private $express_checkout_helper;
-
- /**
- * Sets up things all tests need.
- */
- public function set_up() {
- parent::set_up();
- add_filter( 'pre_option_woocommerce_tax_based_on', [ $this, '__return_base' ] );
-
- $this->mock_api_client = $this->getMockBuilder( 'WC_Payments_API_Client' )
- ->disableOriginalConstructor()
- ->setMethods(
- [
- 'get_account_data',
- 'is_server_connected',
- 'capture_intention',
- 'cancel_intention',
- 'get_payment_method',
- ]
- )
- ->getMock();
- $this->mock_api_client->expects( $this->any() )->method( 'is_server_connected' )->willReturn( true );
- $this->mock_wcpay_account = $this->createMock( WC_Payments_Account::class );
-
- $this->mock_wcpay_gateway = $this->make_wcpay_gateway();
-
- $this->express_checkout_helper = $this->getMockBuilder( WC_Payments_Express_Checkout_Button_Helper::class )
- ->setMethods(
- [
- 'is_product',
- 'get_product',
- ]
- )
- ->setConstructorArgs( [ $this->mock_wcpay_gateway, $this->mock_wcpay_account ] )
- ->getMock();
-
- $this->pr = new WC_Payments_Payment_Request_Button_Handler( $this->mock_wcpay_account, $this->mock_wcpay_gateway, $this->express_checkout_helper );
-
- $this->simple_product = WC_Helper_Product::create_simple_product();
-
- WC_Helper_Shipping::delete_simple_flat_rate();
- $zone = new WC_Shipping_Zone();
- $zone->set_zone_name( 'Worldwide' );
- $zone->set_zone_order( 1 );
- $zone->save();
-
- add_filter(
- 'woocommerce_find_rates',
- function () {
- return [
- 1 =>
- [
- 'rate' => 10.0,
- 'label' => 'Tax',
- 'shipping' => 'yes',
- 'compound' => 'no',
- ],
- ];
- },
- 50,
- 2
- );
-
- $this->flat_rate_id = $zone->add_shipping_method( 'flat_rate' );
- self::set_shipping_method_cost( $this->flat_rate_id, '5' );
-
- $this->local_pickup_id = $zone->add_shipping_method( 'local_pickup' );
- self::set_shipping_method_cost( $this->local_pickup_id, '1' );
-
- $this->zone = $zone;
-
- WC()->session->init();
- WC()->cart->add_to_cart( $this->simple_product->get_id(), 1 );
- WC()->cart->calculate_totals();
- }
-
- public function tear_down() {
- WC_Subscriptions_Cart::set_cart_contains_subscription( false );
- WC()->cart->empty_cart();
- WC()->session->cleanup_sessions();
- $this->zone->delete();
- delete_option( 'woocommerce_woocommerce_payments_settings' );
- remove_filter( 'pre_option_woocommerce_tax_based_on', [ $this, '__return_base' ] );
- remove_filter( 'pre_option_woocommerce_tax_display_cart', [ $this, '__return_excl' ] );
- remove_filter( 'pre_option_woocommerce_tax_display_cart', [ $this, '__return_incl' ] );
- remove_filter( 'pre_option_woocommerce_tax_display_shop', [ $this, '__return_excl' ] );
- remove_filter( 'pre_option_woocommerce_tax_display_shop', [ $this, '__return_incl' ] );
- remove_filter( 'pre_option_woocommerce_prices_include_tax', [ $this, '__return_yes' ] );
- remove_filter( 'pre_option_woocommerce_prices_include_tax', [ $this, '__return_no' ] );
- remove_filter( 'wc_tax_enabled', '__return_true' );
- remove_filter( 'wc_tax_enabled', '__return_false' );
- remove_filter( 'wc_shipping_enabled', '__return_false' );
- remove_all_filters( 'woocommerce_find_rates' );
-
- parent::tear_down();
- }
-
- public function __return_yes() {
- return 'yes';
- }
-
- public function __return_no() {
- return 'no';
- }
-
- public function __return_excl() {
- return 'excl';
- }
-
- public function __return_incl() {
- return 'incl';
- }
-
- public function __return_base() {
- return 'base';
- }
-
- /**
- * @return WC_Payment_Gateway_WCPay
- */
- private function make_wcpay_gateway() {
- $mock_customer_service = $this->createMock( WC_Payments_Customer_Service::class );
- $mock_token_service = $this->createMock( WC_Payments_Token_Service::class );
- $mock_action_scheduler_service = $this->createMock( WC_Payments_Action_Scheduler_Service::class );
- $mock_rate_limiter = $this->createMock( Session_Rate_Limiter::class );
- $mock_order_service = $this->createMock( WC_Payments_Order_Service::class );
- $mock_dpps = $this->createMock( Duplicate_Payment_Prevention_Service::class );
- $mock_payment_method = $this->createMock( CC_Payment_Method::class );
-
- return new WC_Payment_Gateway_WCPay(
- $this->mock_api_client,
- $this->mock_wcpay_account,
- $mock_customer_service,
- $mock_token_service,
- $mock_action_scheduler_service,
- $mock_payment_method,
- [ 'card' => $mock_payment_method ],
- $mock_order_service,
- $mock_dpps,
- $this->createMock( WC_Payments_Localization_Service::class ),
- $this->createMock( WC_Payments_Fraud_Service::class ),
- $this->createMock( Duplicates_Detection_Service::class ),
- $mock_rate_limiter
- );
- }
-
- /**
- * Sets shipping method cost
- *
- * @param string $instance_id Shipping method instance id
- * @param string $cost Shipping method cost in USD
- */
- private static function set_shipping_method_cost( $instance_id, $cost ) {
- $method = WC_Shipping_Zones::get_shipping_method( $instance_id );
- $option_key = $method->get_instance_option_key();
- $options = get_option( $option_key );
- $options['cost'] = $cost;
- update_option( $option_key, $options );
- }
-
- /**
- * Retrieves rate id by shipping method instance id.
- *
- * @param string $instance_id Shipping method instance id.
- *
- * @return string Shipping option instance rate id.
- */
- private static function get_shipping_option_rate_id( $instance_id ) {
- $method = WC_Shipping_Zones::get_shipping_method( $instance_id );
-
- return $method->get_rate_id();
- }
-
- public function test_multiple_packages_in_cart_not_allowed() {
- // Add fake packages to the cart.
- add_filter(
- 'woocommerce_cart_shipping_packages',
- function () {
- return [
- 'fake_package_1',
- 'fake_package_2',
- ];
- }
- );
- $this->mock_wcpay_gateway = $this->make_wcpay_gateway();
- $this->pr = new WC_Payments_Payment_Request_Button_Handler( $this->mock_wcpay_account, $this->mock_wcpay_gateway, $this->express_checkout_helper );
-
- $this->assertFalse( $this->pr->has_allowed_items_in_cart() );
- }
-
- public function test_get_product_price_returns_simple_price() {
- $this->assertEquals(
- $this->simple_product->get_price(),
- $this->pr->get_product_price( $this->simple_product )
- );
- }
-
- public function test_get_product_price_returns_deposit_amount() {
- $product_price = 10;
- $this->simple_product->set_price( $product_price );
-
- $this->assertEquals(
- $product_price,
- $this->pr->get_product_price( $this->simple_product, false ),
- 'When deposit is disabled, the regular price should be returned.'
- );
- $this->assertEquals(
- $product_price,
- $this->pr->get_product_price( $this->simple_product, true ),
- 'When deposit is enabled, but the product has no setting for deposit, the regular price should be returned.'
- );
-
- $this->simple_product->update_meta_data( '_wc_deposit_enabled', 'optional' );
- $this->simple_product->update_meta_data( '_wc_deposit_type', 'percent' );
- $this->simple_product->update_meta_data( '_wc_deposit_amount', 50 );
- $this->simple_product->save_meta_data();
-
- $this->assertEquals(
- $product_price,
- $this->pr->get_product_price( $this->simple_product, false ),
- 'When deposit is disabled, the regular price should be returned.'
- );
- $this->assertEquals(
- $product_price * 0.5,
- $this->pr->get_product_price( $this->simple_product, true ),
- 'When deposit is enabled, the deposit price should be returned.'
- );
-
- $this->simple_product->delete_meta_data( '_wc_deposit_amount' );
- $this->simple_product->delete_meta_data( '_wc_deposit_type' );
- $this->simple_product->delete_meta_data( '_wc_deposit_enabled' );
- $this->simple_product->save_meta_data();
- }
-
- public function test_get_product_price_returns_deposit_amount_default_values() {
- $product_price = 10;
- $this->simple_product->set_price( $product_price );
-
- $this->assertEquals(
- $product_price,
- $this->pr->get_product_price( $this->simple_product ),
- 'When deposit is disabled by default, the regular price should be returned.'
- );
-
- $this->simple_product->update_meta_data( '_wc_deposit_enabled', 'optional' );
- $this->simple_product->update_meta_data( '_wc_deposit_type', 'percent' );
- $this->simple_product->update_meta_data( '_wc_deposit_amount', 50 );
- $this->simple_product->update_meta_data( '_wc_deposit_selected_type', 'full' );
- $this->simple_product->save_meta_data();
-
- $this->assertEquals(
- $product_price,
- $this->pr->get_product_price( $this->simple_product ),
- 'When deposit is optional and disabled by default, the regular price should be returned.'
- );
-
- $this->simple_product->update_meta_data( '_wc_deposit_selected_type', 'deposit' );
- $this->simple_product->save_meta_data();
-
- $this->assertEquals(
- $product_price * 0.5,
- $this->pr->get_product_price( $this->simple_product ),
- 'When deposit is optional and selected by default, the deposit price should be returned.'
- );
- }
-
- /**
- * @dataProvider provide_get_product_tax_tests
- */
- public function test_get_product_price_returns_price_with_tax( $tax_enabled, $prices_include_tax, $tax_display_shop, $tax_display_cart, $product_price, $expected_price ) {
- $this->simple_product->set_price( $product_price );
- add_filter( 'wc_tax_enabled', $tax_enabled ? '__return_true' : '__return_false' ); // reset in tear_down.
- add_filter( 'pre_option_woocommerce_prices_include_tax', [ $this, "__return_$prices_include_tax" ] ); // reset in tear_down.
- add_filter( 'pre_option_woocommerce_tax_display_shop', [ $this, "__return_$tax_display_shop" ] ); // reset in tear_down.
- add_filter( 'pre_option_woocommerce_tax_display_cart', [ $this, "__return_$tax_display_cart" ] ); // reset in tear_down.
- WC()->cart->calculate_totals();
- $this->assertEquals(
- $expected_price,
- $this->pr->get_product_price( $this->simple_product )
- );
- }
-
- public function provide_get_product_tax_tests() {
- yield 'Tax Disabled, Price Display Unaffected' => [
- 'tax_enabled' => false,
- 'prices_include_tax' => 'no',
- 'tax_display_shop' => 'excl',
- 'tax_display_cart' => 'incl',
- 'product_price' => 10,
- 'expected_price' => 10,
- ];
-
- // base prices DO NOT include tax.
-
- yield 'Shop: Excl / Cart: Incl, Base Prices Don\'t Include Tax' => [
- 'tax_enabled' => true,
- 'prices_include_tax' => 'no',
- 'tax_display_shop' => 'excl',
- 'tax_display_cart' => 'incl',
- 'product_price' => 10,
- 'expected_price' => 11,
- ];
- yield 'Shop: Excl / Cart: Excl, Base Prices Don\'t Include Tax' => [
- 'tax_enabled' => true,
- 'prices_include_tax' => 'no',
- 'tax_display_shop' => 'excl',
- 'tax_display_cart' => 'excl',
- 'product_price' => 10,
- 'expected_price' => 10,
- ];
-
- yield 'Shop: Incl / Cart: Incl, Base Prices Don\'t Include Tax' => [
- 'tax_enabled' => true,
- 'prices_include_tax' => 'no',
- 'tax_display_shop' => 'incl',
- 'tax_display_cart' => 'incl',
- 'product_price' => 10,
- 'expected_price' => 11,
- ];
- yield 'Shop: Incl / Cart: Excl, Base Prices Don\'t Include Tax' => [
- 'tax_enabled' => true,
- 'prices_include_tax' => 'no',
- 'tax_display_shop' => 'incl',
- 'tax_display_cart' => 'excl',
- 'product_price' => 10,
- 'expected_price' => 10,
- ];
-
- // base prices include tax.
-
- yield 'Shop: Excl / Cart: Incl, Base Prices Include Tax' => [
- 'tax_enabled' => true,
- 'prices_include_tax' => 'yes',
- 'tax_display_shop' => 'excl',
- 'tax_display_cart' => 'incl',
- 'product_price' => 10,
- 'expected_price' => 10,
- ];
- yield 'Shop: Excl / Cart: Excl, Base Prices Include Tax' => [
- 'tax_enabled' => true,
- 'prices_include_tax' => 'yes',
- 'tax_display_shop' => 'excl',
- 'tax_display_cart' => 'excl',
- 'product_price' => 10,
- 'expected_price' => 9.090909,
- ];
-
- yield 'Shop: Incl / Cart: Incl, Base Prices Include Tax' => [
- 'tax_enabled' => true,
- 'prices_include_tax' => 'yes',
- 'tax_display_shop' => 'incl',
- 'tax_display_cart' => 'incl',
- 'product_price' => 10,
- 'expected_price' => 10,
- ];
- yield 'Shop: Incl / Cart: Excl, Base Prices Include Tax' => [
- 'tax_enabled' => true,
- 'prices_include_tax' => 'yes',
- 'tax_display_shop' => 'incl',
- 'tax_display_cart' => 'excl',
- 'product_price' => 10,
- 'expected_price' => 9.090909,
- ];
- }
-
- 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 );
-
- $this->assertEquals( 20, $this->pr->get_product_price( $mock_product ) );
-
- // Restore the sign-up fee after the test.
- WC_Subscriptions_Product::set_sign_up_fee( 0 );
-
- remove_all_filters( 'test_deposit_get_product' );
- }
-
- 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 );
-
- $this->assertEquals( 20, $this->pr->get_product_price( $mock_product ) );
-
- // Restore the sign-up fee after the test.
- WC_Subscriptions_Product::set_sign_up_fee( 0 );
-
- remove_all_filters( 'test_deposit_get_product' );
- }
-
- public function test_get_product_price_throws_exception_for_products_without_prices() {
- if ( version_compare( WC_VERSION, '6.9.0', '>=' ) ) {
- $this->markTestSkipped( 'This test is useless starting with WooCommerce 6.9.0' );
- return;
- }
-
- $this->simple_product->set_price( 'a' );
-
- $this->expectException( WCPay\Exceptions\Invalid_Price_Exception::class );
-
- $this->pr->get_product_price( $this->simple_product );
- }
-
- 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 );
- $this->pr->get_product_price( $mock_product );
-
- // Restore the sign-up fee after the test.
- WC_Subscriptions_Product::set_sign_up_fee( 0 );
-
- remove_all_filters( 'test_deposit_get_product' );
- }
-
- private function create_mock_subscription( $type ) {
- $mock_product = $this->createMock( WC_Subscriptions_Product::class );
-
- $mock_product
- ->expects( $this->once() )
- ->method( 'get_price' )
- ->willReturn( 10 );
-
- $mock_product
- ->expects( $this->once() )
- ->method( 'get_type' )
- ->willReturn( $type );
-
- return $mock_product;
- }
-
- /**
- * @dataProvider provide_get_product_tax_tests
- */
- public function test_get_product_data_returns_the_same_as_build_display_items_without_shipping( $tax_enabled, $prices_include_tax, $tax_display_shop, $tax_display_cart, $_product_price, $_expected_price ) {
- add_filter( 'wc_tax_enabled', $tax_enabled ? '__return_true' : '__return_false' ); // reset in tear_down.
- add_filter( 'pre_option_woocommerce_prices_include_tax', [ $this, "__return_$prices_include_tax" ] ); // reset in tear_down.
- add_filter( 'pre_option_woocommerce_tax_display_shop', [ $this, "__return_$tax_display_shop" ] ); // reset in tear_down.
- add_filter( 'pre_option_woocommerce_tax_display_cart', [ $this, "__return_$tax_display_cart" ] ); // reset in tear_down.
- add_filter( 'wc_shipping_enabled', '__return_false' ); // reset in tear_down.
- WC()->cart->calculate_totals();
- $build_display_items_result = $this->express_checkout_helper->build_display_items( true );
-
- $this->express_checkout_helper
- ->method( 'is_product' )
- ->willReturn( true );
-
- $this->express_checkout_helper
- ->method( 'get_product' )
- ->willReturn( $this->simple_product );
-
- $get_product_data_result = $this->pr->get_product_data();
-
- foreach ( $get_product_data_result['displayItems'] as $key => $display_item ) {
- if ( isset( $display_item['pending'] ) ) {
- unset( $get_product_data_result['displayItems'][ $key ]['pending'] );
- }
- }
-
- $this->assertEquals(
- $get_product_data_result['displayItems'],
- $build_display_items_result['displayItems'],
- 'Failed asserting displayItems are the same for get_product_data and build_display_items'
- );
- $this->assertEquals(
- $get_product_data_result['total']['amount'],
- $build_display_items_result['total']['amount'],
- 'Failed asserting total amount are the same for get_product_data and build_display_items'
- );
- }
-
- public function test_filter_cart_needs_shipping_address_returns_false() {
- sleep( 1 );
- $this->zone->delete_shipping_method( $this->flat_rate_id );
- $this->zone->delete_shipping_method( $this->local_pickup_id );
-
- WC_Subscriptions_Cart::set_cart_contains_subscription( true );
-
- $this->assertFalse( $this->pr->filter_cart_needs_shipping_address( true ) );
- }
-
- public function test_filter_cart_needs_shipping_address_returns_true() {
- WC_Subscriptions_Cart::set_cart_contains_subscription( true );
-
- $this->assertTrue( $this->pr->filter_cart_needs_shipping_address( true ) );
- }
-
- public function test_get_button_settings() {
- $this->express_checkout_helper
- ->method( 'is_product' )
- ->willReturn( true );
-
- $this->assertEquals(
- [
- 'type' => 'default',
- 'theme' => 'dark',
- 'height' => '48',
- 'locale' => 'en',
- 'branded_type' => 'short',
- 'radius' => '',
- ],
- $this->pr->get_button_settings()
- );
- }
-
- public function test_filter_gateway_title() {
- $order = $this->createMock( WC_Order::class );
- $order->method( 'get_payment_method_title' )->willReturn( 'Apple Pay' );
-
- global $theorder;
- $theorder = $order;
-
- $this->set_is_admin( true );
- $this->assertEquals( 'Apple Pay', $this->pr->filter_gateway_title( 'Original Title', 'woocommerce_payments' ) );
-
- $this->set_is_admin( false );
- $this->assertEquals( 'Original Title', $this->pr->filter_gateway_title( 'Original Title', 'woocommerce_payments' ) );
-
- $this->set_is_admin( true );
- $this->assertEquals( 'Original Title', $this->pr->filter_gateway_title( 'Original Title', 'another_gateway' ) );
- }
-
- /**
- * @param bool $is_admin
- */
- private function set_is_admin( bool $is_admin ) {
- global $current_screen;
-
- if ( ! $is_admin ) {
- $current_screen = null; // phpcs:ignore: WordPress.WP.GlobalVariablesOverride.Prohibited
- return;
- }
-
- // phpcs:ignore: WordPress.WP.GlobalVariablesOverride.Prohibited
- $current_screen = $this->getMockBuilder( \stdClass::class )
- ->setMethods( [ 'in_admin' ] )
- ->getMock();
-
- $current_screen->method( 'in_admin' )->willReturn( $is_admin );
- }
-}