Refactor form component #27025

kowczarz · 2023-09-08T13:34:09Z

Details

Fixed Issues

$ #25397
PROPOSAL: #25397 (comment)

Tests

Login to the account
Navigate to Settings > Profile > Display name
Edit name/surname, check if illegal characters like ; causes errors
There are no error, ensure if you can update name
Check if name was changed

Verify that no errors appear in the JS console

Offline tests

Ensure you're already logged into the account
Navigate to Settings > Profile > Display name
Edit name/surname, check if illegal characters like ; causes errors
There are no error, ensure if you can update name
Check if name was changed

QA Steps

Login to the account
Navigate to Settings > Profile > Display name
Edit name/surname, check if illegal characters like ; causes errors
There are no error, ensure if you can update name
Check if name was changed

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

android.web.mov

Mobile Web - Safari

ios.web.mp4

Desktop

desktop.mov

iOS

ios.native.mp4

Android

android.native.mov

…onent

melvin-bot · 2023-09-11T13:54:34Z

@thesahindia Please 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]

src/hooks/useForm/FormProvider.js

src/hooks/useForm/FormWrapper.js

src/hooks/useForm/FormProvider.js

Co-authored-by: Carlos Martins <luacmartins@gmail.com>

…onent

luacmartins

Looking good. Thanks for the changes. Just one comment left from my end.

src/hooks/useForm/FormProvider.js

…onent

kowczarz · 2023-09-14T10:37:19Z

@thesahindia could you please check the PR as well?

…onent

thesahindia · 2023-09-21T22:01:04Z

Tested well! But it looks like we still have one console error.

Screen.Recording.2023-09-22.at.3.26.34.AM.mov

kowczarz · 2023-09-22T08:15:27Z

@luacmartins @thesahindia FIY: from Monday I will be OOO for a week, so if we won't finish today we will need to wait one more week.

luacmartins · 2023-09-22T08:25:18Z

@kowczarz did you get a chance to look at the console error @thesahindia pointed out here

kowczarz · 2023-09-22T08:27:15Z

Tested well! But it looks like we still have one console error.

@thesahindia that's not connecteed with my PR. The root of the problem is in our fork of react-native-web library https://github.com/Expensify/react-native-web/blob/master/packages/react-native-web/src/exports/render/index.js#L46C18-L46C18

thesahindia · 2023-09-22T17:45:40Z

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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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

Screen.Recording.2023-09-16.at.2.29.47.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-09-22.at.11.11.27.PM.mov

Mobile Web - Safari

Screen.Recording.2023-09-22.at.3.24.29.AM.mov

Desktop

Screen.Recording.2023-09-22.at.11.07.42.PM.mov

iOS

Screen.Recording.2023-09-22.at.3.24.29.AM.mov

Android

Screen.Recording.2023-09-22.at.11.09.14.PM.mov

thesahindia

LGTM!

luacmartins

LGTM! Thanks for working on this!

OSBotify · 2023-09-25T00:56:13Z

✋ 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-09-25T10:04:39Z

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

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

parasharrajat · 2023-09-26T06:53:59Z

src/pages/settings/Profile/DisplayNamePage.js

+                    <InputWrapper
+                        InputComponent={TextInput}


This works. But wouldn't it prevent prop intellisense.

As soon as we will introduce TypeScript (migration is in progress) it certainly won't be a problem, because we can create a simple generic that will handle the props properly.

OSBotify · 2023-09-28T18:47:00Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

parasharrajat · 2023-10-07T08:05:39Z

src/components/Form/FormProvider.js

+                {...rest}
+                onSubmit={submit}
+                inputRefs={inputRefs}
+                errors={errors}


We forgot to pass a prop enabledWhenOffline which caused #28148

rayane-djouah · 2024-07-29T13:20:01Z

src/components/Form/FormWrapper.js

+                        containerStyles={[styles.mh0, styles.mt5, styles.flex1]}
+                        enabledWhenOffline={enabledWhenOffline}
+                        isSubmitActionDangerous={isSubmitActionDangerous}
+                        disablePressOnEnter


@kowczarz @thesahindia Is there any reason for using disablePressOnEnter here? Does this fix any bug?

kowczarz added 11 commits August 25, 2023 14:50

Prepare POC

593df79

POC of Form using custom input components

32beaaf

Cleanup input wrapper

51b1ab3

Remove redundant testing component

620b48c

Cleanup form wrapper

1296a97

Merge remote-tracking branch 'expensify/main' into refactor-form-comp…

9a07c15

…onent

Cleanup DisplayNamePage

59652ce

Cleanup FormProvider

0491bc3

Merge remote-tracking branch 'expensify/main' into refactor-form-comp…

5a379f0

…onent

Fix lint

74f69a5

Cleanup

b6c8a62

kowczarz force-pushed the refactor-form-component branch from d8a81a7 to b6c8a62 Compare September 11, 2023 13:49

kowczarz marked this pull request as ready for review September 11, 2023 13:54

kowczarz requested a review from a team as a code owner September 11, 2023 13:54

melvin-bot bot requested review from thesahindia and removed request for a team September 11, 2023 13:54

kowczarz mentioned this pull request Sep 12, 2023

[HOLD for payment 2024-01-18] [HOLD for payment 2023-10-23] Refactor Form to a custom hook #25397

Closed

luacmartins self-requested a review September 12, 2023 15:17

luacmartins reviewed Sep 13, 2023

View reviewed changes

kowczarz and others added 4 commits September 13, 2023 11:59

Apply suggestions from code review

43d8080

Co-authored-by: Carlos Martins <luacmartins@gmail.com>

Merge remote-tracking branch 'expensify/main' into refactor-form-comp…

e186a32

…onent

Code review changes

01a455f

Code review changes

9f28189

kowczarz requested a review from luacmartins September 13, 2023 16:34

luacmartins reviewed Sep 14, 2023

View reviewed changes

src/hooks/useForm/FormProvider.js Outdated Show resolved Hide resolved

src/hooks/useForm/FormProvider.js Outdated Show resolved Hide resolved

kowczarz added 2 commits September 14, 2023 10:45

Code style fixes

7ee8ee3

Merge remote-tracking branch 'expensify/main' into refactor-form-comp…

b82c26d

…onent

kowczarz requested a review from luacmartins September 15, 2023 08:26

kowczarz force-pushed the refactor-form-component branch from db20f09 to ce80fef Compare September 21, 2023 12:56

kowczarz added 4 commits September 21, 2023 15:07

Merge remote-tracking branch 'expensify/main' into refactor-form-comp…

1592692

…onent

Cleanup

6cba7be

Fix wrong default props

ff8653f

Fix prettier

073af5d

luacmartins approved these changes Sep 22, 2023

View reviewed changes

thesahindia approved these changes Sep 22, 2023

View reviewed changes

melvin-bot bot requested a review from luacmartins September 22, 2023 17:48

luacmartins approved these changes Sep 25, 2023

View reviewed changes

luacmartins merged commit e969d77 into Expensify:main Sep 25, 2023
13 checks passed

luacmartins assigned kowczarz Sep 25, 2023

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

This was referenced Sep 25, 2023

[HOLD for payment 2023-10-10] [$500] Profile - User is able to save display name with semicolon despite the error #28147

Closed

[HOLD for payment 2023-10-09] [$500] Profile - Save button is disabled in Display name page in offline mode #28148

Closed

parasharrajat reviewed Sep 26, 2023

View reviewed changes

fedirjh mentioned this pull request Sep 29, 2023

[ON HOLD][$2000] Android - Workspace is still selectable even after 'Create room' button has been pressed #21577

Closed

6 tasks

kosmydel mentioned this pull request Oct 3, 2023

Handle invisible characters in forms #27414

Merged

94 tasks

parasharrajat reviewed Oct 7, 2023

View reviewed changes

kowczarz mentioned this pull request Oct 11, 2023

Improve new form validation #28821

Merged

59 tasks

rayane-djouah reviewed Jul 29, 2024

View reviewed changes

rayane-djouah mentioned this pull request Jul 29, 2024

allow press on enter on limit amount page #46177

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor form component #27025

Refactor form component #27025

kowczarz commented Sep 8, 2023 •

edited

Loading

melvin-bot bot commented Sep 11, 2023

luacmartins left a comment

kowczarz commented Sep 14, 2023

thesahindia commented Sep 21, 2023

kowczarz commented Sep 22, 2023

luacmartins commented Sep 22, 2023

kowczarz commented Sep 22, 2023

thesahindia commented Sep 22, 2023

thesahindia left a comment

luacmartins left a comment

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

parasharrajat Sep 26, 2023

kowczarz Oct 2, 2023

OSBotify commented Sep 28, 2023

parasharrajat Oct 7, 2023

rayane-djouah Jul 29, 2024

Refactor form component #27025

Refactor form component #27025

Conversation

kowczarz commented Sep 8, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 11, 2023

luacmartins left a comment

Choose a reason for hiding this comment

kowczarz commented Sep 14, 2023

thesahindia commented Sep 21, 2023

kowczarz commented Sep 22, 2023

luacmartins commented Sep 22, 2023

kowczarz commented Sep 22, 2023

thesahindia commented Sep 22, 2023

Reviewer Checklist

Screenshots/Videos

thesahindia left a comment

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

parasharrajat Sep 26, 2023

Choose a reason for hiding this comment

kowczarz Oct 2, 2023

Choose a reason for hiding this comment

OSBotify commented Sep 28, 2023

parasharrajat Oct 7, 2023

Choose a reason for hiding this comment

rayane-djouah Jul 29, 2024

Choose a reason for hiding this comment

kowczarz commented Sep 8, 2023 •

edited

Loading