[Fix #16696] Rewrite BaseTextInput to function component

[hannojg]

Details

Previously the BaseTextInput component would control its own internal state for the input's value. Meaning when the value prop changed, it would re-render another time as in componentDidUpdate the internal value state got updated with a consecutive setState call.

It was discussed that the most future proof fix for this is to refactor to a function component and to use the value prop directly.

Fixed Issues

$ #16205
$ #16696
PROPOSAL: #16696 (comment)

Tests

• Verify that no errors appear in the JS console
• Verify the bug is fixed (note: the bug happens on android as well. It's fixed for android as well, however, you will only be able to notice its fixed when used together with this not yet merged PR. For now its enough to validate that its fixed on iOS)
  • Open the app authenticated
  • Press the Plus FAB button
  • Open "request money"
  • Enter a number
  • Select text, notice how the selection context menu stays
• Verify that every input throughout the app is still working as expected

Offline tests

This change doesn't work with any network features, so no separate offline tests are needed.

QA Steps

Same as tests.

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
  • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

chrome.mov

safari.mov

Mobile Web - Chrome

mWeb-AndroidChrome.mov

Mobile Web - Safari

safari.mov

Desktop

desktop.mov

iOS

ios.mp4

Android

android.mov

[melvin-bot]

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

[melvin-bot]

@mountiny @narefyev91 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]

[mountiny]

@narefyev91 lets make sure to test the app thoroughly not only based on the tests steps due to the importance of this component. Mentions might be a good thing to look at

[narefyev91]

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

web2.mov

web1.mov

Mobile Web - Chrome

android-web2.mov

android-web1.mov

Mobile Web - Safari

ios-web2.mov

ios-web1.mov

Desktop

desktop2.mov

desktop1.mov

iOS

ios2.mov

ios1.mov

Android

Screen.Recording.2023-06-07.at.14.03.49.mov

Screen.Recording.2023-06-07.at.13.55.36.mov

[narefyev91]

@hannojg something strange happened with native android, sometimes cursor jumped in not correct position - when typing fast, and i could not see highlight menu most of the times..... and when you get it, you can only move highlighter area on one position

Screen.Recording.2023-06-07.at.13.55.36.mov

Screen.Recording.2023-06-07.at.14.03.49.mov

[hannojg]

Hey @narefyev91 thanks for the testing!

I think the issues you are encountering on android are due to the fact, that your environment doesn't include the native fixes from Expensify/react-native#55 yet (i double tested it, and with the native fix i can't reproduce the issues).
Right now these changes haven't landed in the expensify app repo yet, but i think they will next week.

I think those bugs have been also there before this changes, however, i am not entirely sure. Do you guys feel it makes sense to put the PR on hold until the native fix has landed?

[narefyev91]

Hey @narefyev91 thanks for the testing!

I think the issues you are encountering on android are due to the fact, that your environment doesn't include the native fixes fromhttps://github.com/Expensify/react-native/pull/55 yet (i double tested it, and with the native fix i can't reproduce the issues). Right now these changes haven't landed in the expensify app repo yet, but i think they will next week.

I think those bugs have been also there before this changes, however, i am not entirely sure. Do you guys feel it makes sense to put the PR on hold until the native fix has landed?

If we have already those bugs before - and current implementation is not introduce something new for other platforms (which is true) - i think we can not hold this - there are several tickets that may be unblocked/moving forward with new functional implementation - i will say that we can merge this one, but let's have @mountiny get last word here.
I will also not check that test pass for Android - to be sure for QA team that we do not introduce new regressions

[mountiny]

Thanks, due to SNH Conference and this being such important component, I will wait with merging this for next week! Thanks so much for thorough review and testing.

[parasharrajat]

Meanwhile, we are waiting. @mountiny Do you think I should also be assigned to the issue for payment? This component's complexity was high thus more testing work.

[s77rt]

@parasharrajat I'm assigned in #16696 but I didn't review this PR since I was not aware of it (only after some time later) because this PR linked the other issue first and you got requested for review instead. So I think it would be fair that you take the C+ role here #16696 as well.

[parasharrajat]

@hannojg Please resolve the conflicts. @mountiny We can merge this afterward.

[hannojg]

Merge conflicts resolved, made sure the latest changes made to the class component are reflected appropriately in the new function component

[parasharrajat]

Bump @mountiny

[mountiny]

thanks for your patience while i was ooo and thorough testing and review. Going to ship it now. Thanks everyone!

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.37-0 🚀

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

[Julesssss]

FYI this PR also seems to have introduced this regression.

I'd revert it, but we have a PR ready to go so I think that's the simpler path forward.

[parasharrajat]

I think we mistakenly removed it during merge conflicts. There was no intention of changing styles. Or may be this flex1 style was added while we working on the PR and thus accidentally got removed.

[OSBotify]

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.37-7 🚀

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

[sobitneupane]

This regression was caused by the changes introduce in this PR.

IssueTitle: DEV: Console error on type email in close account page

[abdulrahuman5196]

This caused a regression of Text Description not toggling properly - more information here #22204 (comment)