Merged in feature/MAW-855-import-code-into-aws (pull request #2)

code import from pantheon

* code import from pantheon

wp/wp-content/plugins/woocommerce/packages/woocommerce-blocks/assets/js/extensions/jetpack/woocommerce-analytics/constants.ts

@@ -0,0 +1,2 @@
+export const namespace = 'jetpack-woocommerce-analytics';
+export const actionPrefix = 'experimental__woocommerce_blocks';

wp/wp-content/plugins/woocommerce/packages/woocommerce-blocks/assets/js/extensions/jetpack/woocommerce-analytics/index.ts

@@ -0,0 +1,185 @@
+/**
+ * External dependencies
+ */
+import { Cart, isObject, objectHasProp } from '@woocommerce/types';
+import { select } from '@wordpress/data';
+import { getSetting } from '@woocommerce/settings';
+
+/**
+ * Internal dependencies
+ */
+import { STORE_KEY as CART_STORE_KEY } from '../../../data/cart/constants';
+
+declare global {
+	interface Window {
+		// eslint-disable-next-line @typescript-eslint/naming-convention
+		_wca: {
+			// eslint-disable-next-line @typescript-eslint/ban-types
+			push: ( properties: Record< string, unknown > ) => void;
+		};
+	}
+}
+
+interface StorePageDetails {
+	id: number;
+	title: string;
+	permalink: string;
+}
+
+interface StorePages {
+	checkout: StorePageDetails;
+	cart: StorePageDetails;
+	myaccount: StorePageDetails;
+	privacy: StorePageDetails;
+	shop: StorePageDetails;
+	terms: StorePageDetails;
+}
+
+/**
+ * Check if the _wca object is valid and has a push property that is a function.
+ *
+ * @param  wca {unknown} Object that might be a Jetpack WooCommerce Analytics object.
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+const isValidWCA = (
+	wca: unknown
+): wca is { push: ( properties: Record< string, unknown > ) => void } => {
+	if ( ! isObject( wca ) || ! objectHasProp( wca, 'push' ) ) {
+		return false;
+	}
+	return typeof wca.push === 'function';
+};
+
+const registerActions = (): void => {
+	if ( ! isValidWCA( window._wca ) ) {
+		// eslint-disable-next-line no-useless-return
+		return;
+	}
+
+	// We will register actions here in a later PR.
+};
+
+document.addEventListener( 'DOMContentLoaded', () => {
+	registerActions();
+} );
+
+export const cleanUrl = ( link: string ) => {
+	const url = link.split( '?' )[ 0 ];
+	if ( url.charAt( url.length - 1 ) !== '/' ) {
+		return url + '/';
+	}
+	return url;
+};
+
+const maybeTrackCheckoutPageView = ( cart: Cart ) => {
+	const storePages = getSetting< StorePages >( 'storePages', {} );
+	if ( ! objectHasProp( storePages, 'checkout' ) ) {
+		return;
+	}
+
+	if (
+		cleanUrl( storePages?.checkout?.permalink ) !==
+		cleanUrl( window.location.href )
+	) {
+		return;
+	}
+
+	if ( ! isValidWCA( window._wca ) ) {
+		return;
+	}
+
+	const checkoutData = getSetting< Record< string, unknown > >(
+		'wc-blocks-jetpack-woocommerce-analytics_cart_checkout_info',
+		{}
+	);
+
+	window._wca.push( {
+		_en: 'woocommerceanalytics_checkout_view',
+		products_count: cart.items.length,
+		order_value: cart.totals.total_price,
+		products: JSON.stringify(
+			cart.items.map( ( item ) => {
+				return {
+					pp: item.totals.line_total,
+					pq: item.quantity,
+					pi: item.id,
+					pn: item.name,
+				};
+			} )
+		),
+		...checkoutData,
+	} );
+};
+
+const maybeTrackCartPageView = ( cart: Cart ) => {
+	const storePages = getSetting< StorePages >( 'storePages', {} );
+	if ( ! objectHasProp( storePages, 'cart' ) ) {
+		return;
+	}
+
+	if (
+		cleanUrl( storePages?.cart?.permalink ) !==
+		cleanUrl( window.location.href )
+	) {
+		return;
+	}
+
+	if ( ! isValidWCA( window._wca ) ) {
+		return;
+	}
+
+	const checkoutData = getSetting< Record< string, unknown > >(
+		'wc-blocks-jetpack-woocommerce-analytics_cart_checkout_info',
+		{}
+	);
+
+	window._wca.push( {
+		_en: 'woocommerceanalytics_cart_view',
+		products_count: cart.items.length,
+		order_value: cart.totals.total_price,
+		products: JSON.stringify(
+			cart.items.map( ( item ) => {
+				return {
+					pp: item.totals.line_total,
+					pq: item.quantity,
+					pi: item.id,
+					pn: item.name,
+					pt: item.type,
+				};
+			} )
+		),
+		...checkoutData,
+	} );
+};
+
+const maybeTrackOrderReceivedPageView = () => {
+	const orderReceivedProps = getSetting(
+		'wc-blocks-jetpack-woocommerce-analytics_order_received_properties',
+		false
+	);
+
+	if ( ! orderReceivedProps || ! isValidWCA( window._wca ) ) {
+		return;
+	}
+
+	window._wca.push( {
+		_en: 'woocommerceanalytics_order_confirmation_view',
+		...orderReceivedProps,
+	} );
+};
+
+document.addEventListener( 'DOMContentLoaded', () => {
+	const store = select( CART_STORE_KEY );
+
+	// If the store doesn't load, we aren't on a cart/checkout block page, so maybe it's order received page.
+	if ( ! store ) {
+		maybeTrackOrderReceivedPageView();
+		return;
+	}
+
+	const hasCartLoaded = store.hasFinishedResolution( 'getCartTotals' );
+	if ( hasCartLoaded ) {
+		maybeTrackCartPageView( store.getCartData() );
+		maybeTrackCheckoutPageView( store.getCartData() );
+	}
+} );

wp/wp-content/plugins/woocommerce/packages/woocommerce-blocks/assets/js/extensions/jetpack/woocommerce-analytics/test/index.ts

@@ -0,0 +1,21 @@
+/**
+ * Internal dependencies
+ */
+import { cleanUrl } from '../index';
+
+describe( 'WooCommerce Analytics', () => {
+	describe( 'cleanUrl', () => {
+		it( 'returns a clean URL with a trailing slash', () => {
+			expect( cleanUrl( 'https://test.com?test=1' ) ).toEqual(
+				'https://test.com/'
+			);
+			expect( cleanUrl( '' ) ).toEqual( '/' );
+			expect( cleanUrl( 'https://test.com/' ) ).toEqual(
+				'https://test.com/'
+			);
+			expect( cleanUrl( 'https://test.com' ) ).toEqual(
+				'https://test.com/'
+			);
+		} );
+	} );
+} );

wp/wp-content/plugins/woocommerce/packages/woocommerce-blocks/assets/js/extensions/payment-methods/bacs/index.js

@@ -3,7 +3,7 @@
  */
 import { registerPaymentMethod } from '@woocommerce/blocks-registry';
 import { __ } from '@wordpress/i18n';
-import { getSetting } from '@woocommerce/settings';
+import { getPaymentMethodData } from '@woocommerce/settings';
 import { decodeEntities } from '@wordpress/html-entities';
 
 /**
@@ -11,12 +11,12 @@ import { decodeEntities } from '@wordpress/html-entities';
  */
 import { PAYMENT_METHOD_NAME } from './constants';
 
-const settings = getSetting( 'bacs_data', {} );
+const settings = getPaymentMethodData( 'bacs', {} );
 const defaultLabel = __(
 	'Direct bank transfer',
 	'woocommerce'
 );
-const label = decodeEntities( settings.title ) || defaultLabel;
+const label = decodeEntities( settings?.title || '' ) || defaultLabel;
 
 /**
  * Content component

wp/wp-content/plugins/woocommerce/packages/woocommerce-blocks/assets/js/extensions/payment-methods/cheque/index.js

@@ -3,7 +3,7 @@
  */
 import { registerPaymentMethod } from '@woocommerce/blocks-registry';
 import { __ } from '@wordpress/i18n';
-import { getSetting } from '@woocommerce/settings';
+import { getPaymentMethodData } from '@woocommerce/settings';
 import { decodeEntities } from '@wordpress/html-entities';
 
 /**
@@ -11,9 +11,9 @@ import { decodeEntities } from '@wordpress/html-entities';
  */
 import { PAYMENT_METHOD_NAME } from './constants';
 
-const settings = getSetting( 'cheque_data', {} );
+const settings = getPaymentMethodData( 'cheque', {} );
 const defaultLabel = __( 'Check payment', 'woocommerce' );
-const label = decodeEntities( settings.title ) || defaultLabel;
+const label = decodeEntities( settings?.title || '' ) || defaultLabel;
 
 /**
  * Content component

wp/wp-content/plugins/woocommerce/packages/woocommerce-blocks/assets/js/extensions/payment-methods/cod/index.js

@@ -3,7 +3,7 @@
  */
 import { registerPaymentMethod } from '@woocommerce/blocks-registry';
 import { __ } from '@wordpress/i18n';
-import { getSetting } from '@woocommerce/settings';
+import { getPaymentMethodData } from '@woocommerce/settings';
 import { decodeEntities } from '@wordpress/html-entities';
 
 /**
@@ -11,9 +11,9 @@ import { decodeEntities } from '@wordpress/html-entities';
  */
 import { PAYMENT_METHOD_NAME } from './constants';
 
-const settings = getSetting( 'cod_data', {} );
+const settings = getPaymentMethodData( 'cod', {} );
 const defaultLabel = __( 'Cash on delivery', 'woocommerce' );
-const label = decodeEntities( settings.title ) || defaultLabel;
+const label = decodeEntities( settings?.title || '' ) || defaultLabel;
 
 /**
  * Content component

wp/wp-content/plugins/woocommerce/packages/woocommerce-blocks/assets/js/extensions/payment-methods/paypal/index.js

@@ -3,7 +3,7 @@
  */
 import { registerPaymentMethod } from '@woocommerce/blocks-registry';
 import { __ } from '@wordpress/i18n';
-import { getSetting, WC_ASSET_URL } from '@woocommerce/settings';
+import { getPaymentMethodData, WC_ASSET_URL } from '@woocommerce/settings';
 import { decodeEntities } from '@wordpress/html-entities';
 
 /**
@@ -11,7 +11,7 @@ import { decodeEntities } from '@wordpress/html-entities';
  */
 import { PAYMENT_METHOD_NAME } from './constants';
 
-const settings = getSetting( 'paypal_data', {} );
+const settings = getPaymentMethodData( 'paypal', {} );
 
 /**
  * Content component
@@ -38,7 +38,7 @@ const paypalPaymentMethod = {
 	edit: <Content />,
 	canMakePayment: () => true,
 	ariaLabel: decodeEntities(
-		settings.title ||
+		settings?.title ||
 			__( 'Payment via PayPal', 'woocommerce' )
 	),
 	supports: {

wp/wp-content/plugins/woocommerce/packages/woocommerce-blocks/assets/js/extensions/shipping-methods/pickup-location/location-settings.tsx

@@ -30,7 +30,7 @@ const LocationSettingsDescription = () => (
 				'woo-gutenberg-products-block'
 			) }
 		</p>
-		<ExternalLink href="https://woocommerce.com/document/local-pickup/">
+		<ExternalLink href="https://woocommerce.com/document/woocommerce-blocks-local-pickup/">
 			{ __( 'Learn more', 'woo-gutenberg-products-block' ) }
 		</ExternalLink>
 	</>