fix/16611: Trim value before validation in Form Component #16861

tienifr · 2023-04-02T05:18:05Z

Details

We should trim the value before validation in Form Component. This PR does that

Fixed Issues

$ #16611
PROPOSAL: #16611 (comment)

Tests

Navigate to Settings -> Profile -> Personal details > Legal name
Enter one or more spaces to field First/ Last Name and click outside input (or click save).
Verify that the error appears with the message "This field is required"

Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

Navigate to Settings -> Profile -> Personal details > Legal name
Enter one or more spaces to field First/ Last Name and save.
Verify that the error appears with the message "This field is required"

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-04-02.at.11.43.40.mov

Mobile Web - Chrome

Screen.Recording.2023-04-02.at.11.44.44.mov

Mobile Web - Safari

Screen.Recording.2023-04-02.at.12.35.32.mov

Desktop

Screen.Recording.2023-04-02.at.11.46.53.mov

iOS

Screen.Recording.2023-04-02.at.11.44.12.mov

Android

Screen-Recording-2023-04-02-at-12.28.38.mp4

MelvinBot · 2023-04-02T05:18:12Z

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

MelvinBot · 2023-04-02T05:33:18Z

@jasperhuangg @rushatgabhane 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]

rushatgabhane · 2023-04-02T05:38:18Z

src/components/Form.js

        FormActions.setErrors(this.props.formID, null);
        FormActions.setErrorFields(this.props.formID, null);

        // Run any validations passed as a prop
-        const validationErrors = this.props.validate(values);
+        const validationErrors = this.props.validate(trimmedValues);


Will the errors for non-string values will still be validated?

@rushatgabhane I am checking if it is a string value, it will be trimmed. So that non-string values will not be trimmed but it still is validated as before.
We can replace _.isString(inputValue) into !_.isEmpty(inputValue) then it will check for both string and non-string values
But I don't see any values are non-string in Form

But I don't see any values are non-string in Form

agree with you. but then there's a reason you're checking if the value is string before trimming.

Form is a generic component so I think we should handle non string values as well.

rushatgabhane · 2023-04-02T06:09:05Z

src/components/Form.js

@@ -171,14 +171,16 @@ class Form extends React.Component {
     * @returns {Object} - An object containing the errors for each inputID, e.g. {inputID1: error1, inputID2: error2}
     */
    validate(values) {
+        const trimmedValues = {};
+        _.each(values, (inputValue, inputID) => _.isString(inputValue) && (trimmedValues[inputID] = inputValue.trim()));


won't this crash the app when we're trimming an empty string?

emptyString = ''
isString(emptyString) is true
emptyString.trim() ---> crash 💥

Oh wait me, I need to check again

@rushatgabhane
I don't see that emptyString.trim() ---> crash 💥, emptyString.trim() = ""
The crash app can be caused from some boolean fields
In the first commit, I added the condition _.isString(inputValue) to avoid the crash
And I just updated _.isString(inputValue) into !_.isEmpty(inputValue) So it also resolved this problem because _.isEmpty(boolean) === true

@rushatgabhane Bump

@tienifr ah i see there's a misunderstanding

here is what i mean
allValues = [...trimmedStringValues, ...nonTrimmedNonStringValues]

vs what we're doing right now -
allValues = [...trimmedStringValues]

I'm not suggesting that we should trim non-string values.

We're completely dropping non-string values. I'm suggesting that we don't drop them, pass them as they are

@rushatgabhane Oh, my bad 😄 Just updated

@rushatgabhane bump

@rushatgabhane Could you help to take a look at this PR? It is given an approval

jasperhuangg

looks good and tests well :D

jasperhuangg · 2023-04-05T15:41:38Z

@rushatgabhane Friendly bump, I think this is ready to go, do you mind completing the reviewer checklist and approving when you get the chance?

rushatgabhane · 2023-04-06T08:04:01Z

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 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 correct English and 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 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-04-06T08:17:52Z

@jasperhuangg LGTM as well

tienifr · 2023-04-07T02:34:54Z

@jasperhuangg Friendly bump, This PR is ready to merge

MelvinBot · 2023-04-07T02:35:46Z

@jasperhuangg looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

jasperhuangg · 2023-04-07T02:36:37Z

PR reviewer checklist was clearly completed above, not an emergency.

OSBotify · 2023-04-07T02:40:36Z

✋ 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-04-07T23:02:07Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.2.97-0 🚀

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

OSBotify · 2023-04-10T18:27:41Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.2.97-2 🚀

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

fix: trim value before validating

df0cbee

tienifr marked this pull request as ready for review April 2, 2023 05:33

tienifr requested a review from a team as a code owner April 2, 2023 05:33

melvin-bot bot requested review from jasperhuangg and rushatgabhane and removed request for a team April 2, 2023 05:33

tienifr mentioned this pull request Apr 2, 2023

[HOLD for payment 2023-04-17] [$1000] Profile - Personal Details- Able to save Fist and Last name fields with One space #16611

Closed

6 tasks

rushatgabhane reviewed Apr 2, 2023

View reviewed changes

tienifr added 3 commits April 2, 2023 13:17

fix: should trim non-string value

76344b0

fix: only trim string value

65b4986

fix: rename

e5aad43

jasperhuangg approved these changes Apr 3, 2023

View reviewed changes

rushatgabhane approved these changes Apr 6, 2023

View reviewed changes

jasperhuangg merged commit 64f4a78 into Expensify:main Apr 7, 2023

melvin-bot bot added the Emergency label Apr 7, 2023

jasperhuangg removed the Emergency label Apr 7, 2023

OSBotify mentioned this pull request Apr 7, 2023

Deploy Checklist: New Expensify 2023-04-07 #17160

Closed

23 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix/16611: Trim value before validation in Form Component #16861

fix/16611: Trim value before validation in Form Component #16861

tienifr commented Apr 2, 2023 •

edited

Loading

MelvinBot commented Apr 2, 2023

MelvinBot commented Apr 2, 2023

rushatgabhane Apr 2, 2023

tienifr Apr 2, 2023

rushatgabhane Apr 2, 2023

rushatgabhane Apr 2, 2023 •

edited

Loading

This comment was marked as outdated.

tienifr Apr 2, 2023

tienifr Apr 2, 2023 •

edited

Loading

tienifr Apr 3, 2023

rushatgabhane Apr 3, 2023 •

edited

Loading

rushatgabhane Apr 3, 2023 •

edited

Loading

tienifr Apr 3, 2023

tienifr Apr 4, 2023

tienifr Apr 4, 2023

jasperhuangg left a comment

jasperhuangg commented Apr 5, 2023

rushatgabhane commented Apr 6, 2023 •

edited

Loading

rushatgabhane commented Apr 6, 2023

tienifr commented Apr 7, 2023

MelvinBot commented Apr 7, 2023

jasperhuangg commented Apr 7, 2023

OSBotify commented Apr 7, 2023

OSBotify commented Apr 7, 2023

OSBotify commented Apr 10, 2023

fix/16611: Trim value before validation in Form Component #16861

fix/16611: Trim value before validation in Form Component #16861

Conversation

tienifr commented Apr 2, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 2, 2023

MelvinBot commented Apr 2, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rushatgabhane Apr 2, 2023 • edited Loading

Choose a reason for hiding this comment

This comment was marked as outdated.

Choose a reason for hiding this comment

tienifr Apr 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rushatgabhane Apr 3, 2023 • edited Loading

Choose a reason for hiding this comment

rushatgabhane Apr 3, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasperhuangg left a comment

Choose a reason for hiding this comment

jasperhuangg commented Apr 5, 2023

rushatgabhane commented Apr 6, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane commented Apr 6, 2023

tienifr commented Apr 7, 2023

MelvinBot commented Apr 7, 2023

jasperhuangg commented Apr 7, 2023

OSBotify commented Apr 7, 2023

OSBotify commented Apr 7, 2023

OSBotify commented Apr 10, 2023

tienifr commented Apr 2, 2023 •

edited

Loading

rushatgabhane Apr 2, 2023 •

edited

Loading

tienifr Apr 2, 2023 •

edited

Loading

rushatgabhane Apr 3, 2023 •

edited

Loading

rushatgabhane Apr 3, 2023 •

edited

Loading

rushatgabhane commented Apr 6, 2023 •

edited

Loading