Fix Form useEffect #20091

luacmartins · 2023-06-02T19:43:29Z

Details

We need to skip Form validation on initial render to align with the old bahavior of componentDidUpdate. This prevents a bug in the following scenario:

Submit form
Form unmounts and ReimbursementAccountLoadingIndicator mounts
There's a server error so ReimbursementAccountLoadingIndicator unmounts and Form remounts with the error
We run useEffect in the inital render, calling onValidate
onValidate runs, which in turn calls FormActions.setErrors and FormActions.setErrorFields immediately clearing server errors.

We still want to clear errors on validation, so the solution is to align the call to useEffect with the behavior of componentDidMount by using a ref to keep track of Form's initial render.

Fixed Issues

$ #19923

Tests

In device A, create a Workspace + > New workspace
Navigate to Settings > Workspaces > Bank account
Select Connect online with Plaid
Select Chase
Enter user_good and pass_good as the credentials
Select the Savings account
Verify you're redirected to the enter back account details manually (this is a special case for the Chase bank account selection)
Enter routing number: 011401533 and account number: 1111222233334444
Submit the form
Verify that you see the error: `Your account number should end with 1111
Now delete the value in the Routing number input and click outside of the input
Verify that you see an error
In device B, log into the same account
Change the default language, Settings > Preferences
Verify that the error in device A was translated

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

chrome.mov

Mobile Web - Safari

safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-06-02T19:43:32Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2023-06-02T19:59:22Z

@rushatgabhane @MonilBhavsar One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

luacmartins · 2023-06-06T17:13:52Z

Bump for review

MonilBhavsar

Code looks good to me!
@rushatgabhane would like to get your help in review and checklist

rushatgabhane · 2023-06-07T18:51:25Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

rushatgabhane · 2023-06-07T19:11:53Z

src/components/Form.js

+        // eslint-disable-next-line react-hooks/exhaustive-deps -- we just want to revalidate the form on update if the preferred locale changed on another device so that errors get translated
+    }, [props.preferredLocale]);
+
+    const errorMessage = useMemo(() => {
        const latestErrorMessage = ErrorUtils.getLatestErrorMessage(props.formState);
        return props.formState.error || (typeof latestErrorMessage === 'string' ? latestErrorMessage : '');


NAB: I think there's a typo here? There is no such field called formState.error

It's formState.errors, right? (notice the "s")

https://github.com/Expensify/App/pull/20091/files#diff-a54e851a201173befe09914aee40247c3825f28fa4ff3f01eeaa500be75c5dc8R46

Yea, you're right. Fixed!

rushatgabhane · 2023-06-07T20:06:26Z

Uncaught Error: Objects are not valid as a React child (found: object with keys {1686168201895101, 1686168201532000}). If you meant to render a collection of children, use an array instead.

@luacmartins the app crash when I clicked submit in step 11
platform: desktop

rushatgabhane · 2023-06-07T20:11:11Z

It's consistently reproducible.

Screen.Recording.2023-06-08.at.01.39.18.mov

luacmartins · 2023-06-07T20:17:28Z

Oh interesting. I did not see that while testing. Let me take a look

rushatgabhane · 2023-06-07T20:20:58Z

I think it's because of the last commit. The errorMessage can now be an object.

For FormAlertWithSubmitButton, we are passing an object to the prop message instead of a string.

luacmartins · 2023-06-07T21:15:24Z

Yea, it's the last commit that's causing it. We can actually remove that entirely, since we pass props.formState to ErrorUtils.getLatestErrorMessage in the line above and that returns the lastErrorMessage.

rushatgabhane

Should we dismiss the server error when the focused input is changed? I think no because the user didn't fix the server error, and the error message disappeared making it harder to fix the error.
I'm able to submit the form without accepting the Terms of Service.

Screen.Recording.2023-06-08.at.08.42.48.mov

MonilBhavsar · 2023-06-08T11:01:13Z

Oops, nice find 👍

Should we dismiss the server error when the focused input is changed?

I would also say, no

luacmartins · 2023-06-08T23:16:58Z

I'll get back to this tomorrow

luacmartins · 2023-06-12T23:39:23Z

I think this is expected. We validate the form onChange which is also triggered when clicking away from an input. The alternative would be to not clear server errors until the user submits again, which is a bit odd because the user would still see the error even if they fixed the issue.
This is actually a regression from this PR. We were setting the state of CheckboxWithLabel based on the isChecked prop in useEffect which was always false even though the actual state value in Form was true. I put up a fix.

luacmartins · 2023-06-12T23:40:08Z

Updated!

luacmartins · 2023-06-13T18:46:35Z

Bumping for reviews!

luacmartins · 2023-06-14T20:17:24Z

Bump for reviews!

MonilBhavsar · 2023-06-15T07:04:57Z

@rushatgabhane could you please review first

rushatgabhane

@MonilBhavsar LGTM

melvin-bot · 2023-06-16T08:16:35Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #19923... Please reach out for help on Slack if no one gets assigned!

OSBotify · 2023-06-16T15:19:05Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-06-16T18:50:22Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.29-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-06-21T02:17:52Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.29-11 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

luacmartins added 2 commits June 2, 2023 13:27

update useeffect

9eb074f

update getErrorMessage

2b03ffd

luacmartins self-assigned this Jun 2, 2023

luacmartins marked this pull request as ready for review June 2, 2023 19:58

luacmartins requested a review from a team as a code owner June 2, 2023 19:58

melvin-bot bot requested review from MonilBhavsar and rushatgabhane and removed request for a team June 2, 2023 19:59

MonilBhavsar reviewed Jun 7, 2023

View reviewed changes

rushatgabhane reviewed Jun 7, 2023

View reviewed changes

fix typo

9ddf468

Merge branch 'main' into cmartins-fixFormMount

1344b5b

rm duplicated formState.errors

98da014

rushatgabhane suggested changes Jun 8, 2023

View reviewed changes

luacmartins mentioned this pull request Jun 12, 2023

Form refactor bankaccountstep #10900

Merged

luacmartins added 3 commits June 12, 2023 17:32

fix checkbox state

3496d35

resolve conflict

80a74eb

rm unused import

85e7101

luacmartins requested review from MonilBhavsar and rushatgabhane June 12, 2023 23:40

rushatgabhane approved these changes Jun 16, 2023

View reviewed changes

MonilBhavsar approved these changes Jun 16, 2023

View reviewed changes

luacmartins merged commit 7032b5d into main Jun 16, 2023

luacmartins deleted the cmartins-fixFormMount branch June 16, 2023 15:15

OSBotify mentioned this pull request Jun 16, 2023

Deploy Checklist: New Expensify 2023-06-16 #20928

Closed

bernhardoj mentioned this pull request Jun 17, 2023

The "I accept the Expensify Terms of Service" checkbox not checked when retuning from step 2 #20871

Closed

6 tasks

luacmartins mentioned this pull request Jun 19, 2023

Connect Bank Account - Checkbox is checked after returning to previous stage #20950

Closed

6 tasks

NikkiWines mentioned this pull request Jun 19, 2023

Migrate Checkbox.js to function component #20193

Merged

57 tasks

hungvu193 mentioned this pull request Jun 20, 2023

Bank Account – The form in "Additional information" appears, while checkbox is unchecked. #20942

Closed

6 tasks

melvin-bot bot mentioned this pull request Jun 21, 2023

[HOLD for payment 2023-06-28] IOS - Bank account- Error message nor displayed for incorrect validation code/ incorrect account number #19923

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Form useEffect #20091

Fix Form useEffect #20091

luacmartins commented Jun 2, 2023 •

edited

Loading

melvin-bot bot commented Jun 2, 2023

melvin-bot bot commented Jun 2, 2023

luacmartins commented Jun 6, 2023

MonilBhavsar left a comment

rushatgabhane commented Jun 7, 2023 •

edited

Loading

rushatgabhane Jun 7, 2023

luacmartins Jun 7, 2023

rushatgabhane commented Jun 7, 2023 •

edited

Loading

rushatgabhane commented Jun 7, 2023

luacmartins commented Jun 7, 2023

rushatgabhane commented Jun 7, 2023 •

edited

Loading

luacmartins commented Jun 7, 2023

rushatgabhane left a comment •

edited

Loading

MonilBhavsar commented Jun 8, 2023

luacmartins commented Jun 8, 2023

luacmartins commented Jun 12, 2023

luacmartins commented Jun 12, 2023

luacmartins commented Jun 13, 2023

luacmartins commented Jun 14, 2023

MonilBhavsar commented Jun 15, 2023

rushatgabhane left a comment

melvin-bot bot commented Jun 16, 2023

OSBotify commented Jun 16, 2023

OSBotify commented Jun 16, 2023

OSBotify commented Jun 21, 2023

Fix Form useEffect #20091

Fix Form useEffect #20091

Conversation

luacmartins commented Jun 2, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 2, 2023

melvin-bot bot commented Jun 2, 2023

luacmartins commented Jun 6, 2023

MonilBhavsar left a comment

Choose a reason for hiding this comment

rushatgabhane commented Jun 7, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane Jun 7, 2023

Choose a reason for hiding this comment

luacmartins Jun 7, 2023

Choose a reason for hiding this comment

rushatgabhane commented Jun 7, 2023 • edited Loading

rushatgabhane commented Jun 7, 2023

luacmartins commented Jun 7, 2023

rushatgabhane commented Jun 7, 2023 • edited Loading

luacmartins commented Jun 7, 2023

rushatgabhane left a comment • edited Loading

Choose a reason for hiding this comment

MonilBhavsar commented Jun 8, 2023

luacmartins commented Jun 8, 2023

luacmartins commented Jun 12, 2023

luacmartins commented Jun 12, 2023

luacmartins commented Jun 13, 2023

luacmartins commented Jun 14, 2023

MonilBhavsar commented Jun 15, 2023

rushatgabhane left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 16, 2023

OSBotify commented Jun 16, 2023

OSBotify commented Jun 16, 2023

OSBotify commented Jun 21, 2023

luacmartins commented Jun 2, 2023 •

edited

Loading

rushatgabhane commented Jun 7, 2023 •

edited

Loading

rushatgabhane commented Jun 7, 2023 •

edited

Loading

rushatgabhane commented Jun 7, 2023 •

edited

Loading

rushatgabhane left a comment •

edited

Loading