[HOLD for payment 2023-09-18] [$1000] Bank account - Inconsistency bug: Checking ToS box before filling fields throws error in mweb but not in android app

[lanitochka17]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Action Performed:

1. Login to staging new dot
2. Go to workspaces and select Bank account
3. Click on connect manually and check the ToS box before filling the routing and bank account number fields
4. Observe that an error is thrown
5. Login to android app and repeat steps 2-3
6. Observe that no error is thrown when checking and unchecking ToS box before filling routing and bank account number fields

Expected Result:

Error throwing should be consistent across platforms

Actual Result:

Inconsistent error throwing

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: 1.3.57-5

Reproducible in staging?: Yes

Reproducible in production?: Yes

If this was caught during regression testing, add the test name, ID and link from TestRail:

Email or phone of affected tester (no customers):

Logs: https://stackoverflow.com/c/expensify/questions/4856

Notes/Photos/Videos: Any additional supporting documentation

2023_08_17_02_11_16.mp4

0-02-01-e8ae26ce3bdcff366b1f530ea91e5fefc62c674d40979ebceefdc66bdab510cf_93b629adf30472ab.1.mp4

Expensify/Expensify Issue URL:

Issue reported by: @SofoniasN

Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1692271454788889

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01feabe39f1c833087
• Upwork Job ID: 1696317266455986176
• Last Price Increase: 2023-08-29
• Automatic offers:
• tamdao | Contributor | 26491662
• sofoniasN | Reporter | 26491663

[melvin-bot]

Triggered auto assignment to @strepanier03 (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead - Closed as a feature request
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • Web - Clicking ToS before filling fields in connect bank account throws an error #22402
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[akinwale]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Checking the ToS box before filling fields throws an error in MWeb but not in android app

What is the root cause of that problem?

On mobile web, checking the ToS box causes the blur event for the text input field to fire which triggers validation. On native platforms, this is not the case.

What changes do you think we should make in order to solve the problem?

Either of Solution 1 or 2 has to be selected for implementation.

Solution 1
On mobile web, the default behaviour when a checkbox is clicked is to blur the text input which causes the form validation to trigger since shouldValidateOnBlur is true by default. Add the following props to the Form component in BankAccountManualStep to disable validation when the text input is blurred or when the checkbox is changed (to match the behaviour on native platforms).

shouldValidateOnBlur={false}
shouldValidateOnChange={false}

Solution 2
On native platforms, blur the text input when the checkbox is tapped or clicked. This can be achieved with the following steps.

1. In the BankAccountManualStep component, add a useRef hook for the routing number text input.

const routingNumberInputRef = useRef(null);

and set the ref for the TextInput.

<TextInput
    ...
    ref={(el) => routingNumberInputRef.current = el}
    inputID="routingNumber"

2. Add an event handler, onCheckboxPress

const onCheckboxPress = () => {
    if (routingNumberInputRef.current) {
        routingNumberInputRef.current.blur();
    }
};

and set it as the onPress prop for the CheckboxWithLabel component.

3. Update the CheckboxWithLabel component to support the onPress prop (add the corresponding prop type and update the toggleCheckbox method).

const toggleCheckbox = (e) => {
    if (props.onPress) {
        props.onPress(e);
    }
    const newState = !isChecked;
    props.onInputChange(newState);
    setIsChecked(newState);
};

and change the onPress props:

<Checkbox
    ...
    onPress={(e) => toggleCheckbox(e)}
    ....
/>
<PressableWithFeedback
    ...
    onPress={(e) => toggleCheckbox(e)}
    ...
/>

4. Update the handleSpaceKey and firePressHandlerOnClick methods in the Checkbox component to pass the event parameter to the corresponding onPress calls. This is optional, but recommended for the sake of completeness.

Solution 3
Based on previous implementations of preventing loss of focus for a text input when a click is executed outside, add a preventDefault call for the checkbox press event and then programmatically change the value of the checkbox using a state variable. However, after testing, this doesn't seem to be working on web platforms in this scenario.

What alternative solutions did you explore? (Optional)

None.

[tamdao]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Bank account - Inconsistency bug: Checking ToS box before filling fields throws error in mweb but not in android app

What is the root cause of that problem?

The root cause of this issue is value change for the input not trigger blur event. In this case the input is checkbox.

What alternative solutions did you explore?

Update the childrenWrapperWithProps function in Form component

App/src/components/Form.js

Lines 219 to 357 in c029dc5

	const childrenWrapperWithProps = useCallback(
	(childNodes) => {
	const childrenElements = React.Children.map(childNodes, (child) => {
	// Just render the child if it is not a valid React element, e.g. text within a <Text> component
	if (!React.isValidElement(child)) {
	return child;
	}
	// Depth first traversal of the render tree as the input element is likely to be the last node
	if (child.props.children) {
	return React.cloneElement(child, {
	children: childrenWrapperWithProps(child.props.children),
	});
	}
	// Look for any inputs nested in a custom component, e.g AddressForm or IdentityForm
	if (_.isFunction(child.type)) {
	const childNode = new child.type(child.props);
	// If the custom component has a render method, use it to get the nested children
	const nestedChildren = _.isFunction(childNode.render) ? childNode.render() : childNode;
	// Render the custom component if it's a valid React element
	// If the custom component has nested children, Loop over them and supply From props
	if (React.isValidElement(nestedChildren) || lodashGet(nestedChildren, 'props.children')) {
	return childrenWrapperWithProps(nestedChildren);
	}
	// Just render the child if it's custom component not a valid React element, or if it hasn't children
	return child;
	}
	// We check if the child has the inputID prop.
	// We don't want to pass form props to non form components, e.g. View, Text, etc
	if (!child.props.inputID) {
	return child;
	}
	// We clone the child passing down all form props
	const inputID = child.props.inputID;
	let defaultValue;
	// We need to make sure that checkboxes have correct
	// value assigned from the list of draft values
	// https://github.com/Expensify/App/issues/16885#issuecomment-1520846065
	if (_.isBoolean(props.draftValues[inputID])) {
	defaultValue = props.draftValues[inputID];
	} else {
	defaultValue = props.draftValues[inputID] || child.props.defaultValue;
	}
	// We want to initialize the input value if it's undefined
	if (_.isUndefined(inputValues[inputID])) {
	inputValues[inputID] = defaultValue || '';
	}
	// We force the form to set the input value from the defaultValue props if there is a saved valid value
	if (child.props.shouldUseDefaultValue) {
	inputValues[inputID] = child.props.defaultValue;
	}
	if (!_.isUndefined(child.props.value)) {
	inputValues[inputID] = child.props.value;
	}
	const errorFields = lodashGet(props.formState, 'errorFields', {});
	const fieldErrorMessage =
	_.chain(errorFields[inputID])
	.keys()
	.sortBy()
	.reverse()
	.map((key) => errorFields[inputID][key])
	.first()
	.value() || '';
	return React.cloneElement(child, {
	ref: (node) => {
	inputRefs.current[inputID] = node;
	const {ref} = child;
	if (_.isFunction(ref)) {
	ref(node);
	}
	},
	value: inputValues[inputID],
	// As the text input is controlled, we never set the defaultValue prop
	// as this is already happening by the value prop.
	defaultValue: undefined,
	errorText: errors[inputID] || fieldErrorMessage,
	onBlur: (event) => {
	// Only run validation when user proactively blurs the input.
	if (Visibility.isVisible() && Visibility.hasFocus()) {
	// We delay the validation in order to prevent Checkbox loss of focus when
	// the user are focusing a TextInput and proceeds to toggle a CheckBox in
	// web and mobile web platforms.
	setTimeout(() => {
	setTouchedInput(inputID);
	if (props.shouldValidateOnBlur) {
	onValidate(inputValues);
	}
	}, 200);
	}
	if (_.isFunction(child.props.onBlur)) {
	child.props.onBlur(event);
	}
	},
	onTouched: () => {
	setTouchedInput(inputID);
	},
	onInputChange: (value, key) => {
	const inputKey = key || inputID;
	setInputValues((prevState) => {
	const newState = {
	...prevState,
	[inputKey]: value,
	};
	if (props.shouldValidateOnChange) {
	onValidate(newState);
	}
	return newState;
	});
	if (child.props.shouldSaveDraft) {
	FormActions.setDraftValues(props.formID, {[inputKey]: value});
	}
	if (child.props.onValueChange) {
	child.props.onValueChange(value, inputKey);
	}
	},
	});
	});
	return childrenElements;
	},
	[errors, inputRefs, inputValues, onValidate, props.draftValues, props.formID, props.formState, setTouchedInput, props.shouldValidateOnBlur, props.shouldValidateOnChange],
	);

Add new ref

const focusedInput = useRef(null);

Update childrenWrapperWithProps logic to add onFocus function:

... line 307
onFocus: (event) => {
    focusedInput.current = inputID;
    if (_.isFunction(child.props.onFocus)) {
        child.props.onFocus(event);
    }
},
onBlur: ....

and update the onInputChange function (line 336) to check the changed value is focused input or not

const inputKey = key || inputID;

if (focusedInput.current && focusedInput.current !== inputKey) {
    setTouchedInput(focusedInput.current);
}

I have tested this change and it works well.

[melvin-bot]

📣 @tamdao! 📣
Hey, it seems we don’t have your contributor details yet! You'll only have to do this once, and this is how we'll hire you on Upwork.
Please follow these steps:

1. Get the email address used to login to your Expensify account. If you don't already have an Expensify account, create one here. If you have multiple accounts (e.g. one for testing), please use your main account email.
2. Get the link to your Upwork profile. It's necessary because we only pay via Upwork. You can access it by logging in, and then clicking on your name. It'll look like this. If you don't already have an account, sign up for one here.
3. Copy the format below and paste it in a comment on this issue. Replace the placeholder text with your actual details.
   
   Format:

Contributor details
Your Expensify account email: <REPLACE EMAIL HERE>
Upwork Profile Link: <REPLACE LINK HERE>

[tamdao]

Contributor details
Your Expensify account email: daotam4536@gmail.com
Upwork Profile Link: https://www.upwork.com/freelancers/~0133d983376a3d0d3d

[melvin-bot]

✅ Contributor details stored successfully. Thank you for contributing to Expensify!

[strepanier03]

This was previously reported and the GH closed as a feature request, not a bug.

[strepanier03]

I'm going to move this to external so that we have consistency between devices.

Note that on m/web AND android/native, the error happens if you enter an account number before the routing number. I think the easiest solution is to populate the error when the TOS checkbox or accounting number is entered before the routing number. That way both devices would be just as picky about the order.