From 469223fa54ed5929d9e65775bf97b56b88a3c10b Mon Sep 17 00:00:00 2001
From: Mike Jolley <mike.jolley@me.com>
Date: Mon, 20 Dec 2021 12:16:41 +0000
Subject: [PATCH] Remove validateOnMount in favour of validation on state
 change (https://github.com/woocommerce/woocommerce-blocks/pull/5381)

* Remove validateOnMount in favour of validation on state change.

* Use useEffect

* test
---
 .../cart-checkout/totals/coupon/index.tsx     |  1 -
 .../text-input/validated-text-input.tsx       | 49 +++++++++----------
 2 files changed, 23 insertions(+), 27 deletions(-)

diff --git a/plugins/woocommerce-blocks/assets/js/base/components/cart-checkout/totals/coupon/index.tsx b/plugins/woocommerce-blocks/assets/js/base/components/cart-checkout/totals/coupon/index.tsx
index 2e9b23d5cc8..87b6d29ed41 100644
--- a/plugins/woocommerce-blocks/assets/js/base/components/cart-checkout/totals/coupon/index.tsx
+++ b/plugins/woocommerce-blocks/assets/js/base/components/cart-checkout/totals/coupon/index.tsx
@@ -104,7 +104,6 @@ export const TotalsCoupon = ( {
 							onChange={ ( newCouponValue ) => {
 								setCouponValue( newCouponValue );
 							} }
-							validateOnMount={ false }
 							focusOnMount={ true }
 							showError={ false }
 						/>
diff --git a/plugins/woocommerce-blocks/assets/js/base/components/text-input/validated-text-input.tsx b/plugins/woocommerce-blocks/assets/js/base/components/text-input/validated-text-input.tsx
index 042d92d71fa..536fed53c05 100644
--- a/plugins/woocommerce-blocks/assets/js/base/components/text-input/validated-text-input.tsx
+++ b/plugins/woocommerce-blocks/assets/js/base/components/text-input/validated-text-input.tsx
@@ -34,11 +34,11 @@ type ValidatedTextInputProps = (
 	className?: string;
 	ariaDescribedBy?: string;
 	errorId?: string;
-	validateOnMount?: boolean;
 	focusOnMount?: boolean;
 	showError?: boolean;
 	errorMessage?: string;
 	onChange: ( newValue: string ) => void;
+	value: string;
 };
 
 const ValidatedTextInput = ( {
@@ -47,11 +47,11 @@ const ValidatedTextInput = ( {
 	id,
 	ariaDescribedBy,
 	errorId,
-	validateOnMount = true,
 	focusOnMount = false,
 	onChange,
 	showError = true,
 	errorMessage: passedErrorMessage = '',
+	value = '',
 	...rest
 }: ValidatedTextInputProps ) => {
 	const [ isPristine, setIsPristine ] = useState( true );
@@ -96,34 +96,31 @@ const ValidatedTextInput = ( {
 	);
 
 	/**
-	 * Runs validation on change if the current element is not in focus. This is because autofilled elements do not
-	 * trigger the blur() event.
+	 * Focus on mount
+	 *
+	 * If the input is in pristine state, focus the element.
 	 */
-	const maybeValidateOnChange = useCallback( () => {
+	useEffect( () => {
+		if ( isPristine && focusOnMount ) {
+			inputRef.current?.focus();
+		}
+		setIsPristine( false );
+	}, [ focusOnMount, isPristine, setIsPristine ] );
+
+	/**
+	 * Value Validation
+	 *
+	 * Runs validation on state change if the current element is not in focus. This is because autofilled elements do not
+	 * trigger the blur() event, and so values can be validated in the background if the state changes elsewhere.
+	 */
+	useEffect( () => {
 		if (
-			inputRef.current?.ownerDocument.activeElement !== inputRef.current
+			inputRef.current?.ownerDocument?.activeElement !== inputRef.current
 		) {
 			validateInput( true );
 		}
-	}, [ validateInput ] );
-
-	useEffect( () => {
-		if ( isPristine ) {
-			if ( focusOnMount ) {
-				inputRef.current?.focus();
-			}
-			setIsPristine( false );
-		}
-	}, [ focusOnMount, isPristine, setIsPristine ] );
-
-	useEffect( () => {
-		if ( isPristine ) {
-			if ( validateOnMount ) {
-				validateInput();
-			}
-			setIsPristine( false );
-		}
-	}, [ isPristine, setIsPristine, validateOnMount, validateInput ] );
+		// We need to track value even if it is not directly used so we know when it changes.
+	}, [ value, validateInput ] );
 
 	// Remove validation errors when unmounted.
 	useEffect( () => {
@@ -170,9 +167,9 @@ const ValidatedTextInput = ( {
 			onChange={ ( val ) => {
 				hideValidationError( errorIdString );
 				onChange( val );
-				maybeValidateOnChange();
 			} }
 			ariaDescribedBy={ describedBy }
+			value={ value }
 			{ ...rest }
 		/>
 	);