fix 22610: Request Money input is not getting focus when navigating back #22985

tienifr · 2023-07-17T07:36:47Z

Details

Inside BaseOptionSelector, add focus logic in componentDidUpdate so that the input focus after navigating back.

Fixed Issues

$ #22610
PROPOSAL: #22610 (comment)

Tests

Request Money
Enter Amount & Click Next
See focus getting applied to input
Click on any User contact
Go back to previous screen
Verify the innput is focused.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Request Money
Enter Amount & Click Next
See focus getting applied to input
Click on any User contact
Go back to previous screen
Verify the innput is focused.

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

22610-web.mov

Mobile Web - Chrome

22610-mweb-chrome.mov

Mobile Web - Safari

22610-mweb-safari.mov

Desktop

22610-desktop.mov

iOS

22610-ios.mov

Android

22610-android.mov

melvin-bot · 2023-07-18T03:58:39Z

@eVoloshchak 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]

cead22 · 2023-07-18T15:19:25Z

src/components/OptionsSelector/BaseOptionsSelector.js

@@ -125,6 +125,16 @@ class BaseOptionsSelector extends Component {
    }

    componentDidUpdate(prevProps) {
+        if (this.props.autoFocus && !prevProps.isFocused && this.props.isFocused) {
+            InteractionManager.runAfterInteractions(() => {
+                // Focus text input


Comment should say why, on top of what, here's a suggestion, but feel free to add your own update

Suggested change

// Focus text input

// If we automatically focus on a text input when mounting a component,

// let's automatically focus on it when the component updates as well (eg, when navigating back from a page)

cead22 · 2023-07-18T15:20:05Z

src/components/OptionsSelector/BaseOptionsSelector.js

+                if (!this.textInput) {
+                    return;
+                }


Should we move this to the top of the function? If we don't have a textInput, we don't need the if, or the call to InteractionManager, right

tienifr · 2023-07-19T04:13:30Z

@cead22 Thanks for your suggestion. I just updated my PR a bit

eVoloshchak · 2023-07-19T14:23:33Z

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

Screen.Recording.2023-07-19.at.18.12.53.mov

Mobile Web - Chrome

screen-20230719-182257.mp4

Mobile Web - Safari

Screen.Recording.2023-07-19.at.18.17.40.mov

Desktop

Screen.Recording.2023-07-19.at.18.49.55.mov

iOS

Screen.Recording.2023-07-19.at.18.15.54.mov

Android

screen-20230719-182123.mp4

eVoloshchak · 2023-07-19T15:49:38Z

There's no keyboard shown when input is focused on mobile Safari, this is known and handled in #10414

Screen.Recording.2023-07-19.at.18.46.56.mov

tienifr · 2023-07-21T02:35:06Z

@cead22 Can you help review my PR? Thanks

tienifr · 2023-07-24T14:50:06Z

@cead22 any updates?

cead22 · 2023-07-24T19:15:12Z

Sorry I was assigned on Wednesday and I was OOO on Thursday and Friday

OSBotify · 2023-07-24T19:25:11Z

✋ 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-07-25T01:42:48Z

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.45-0 🚀

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

OSBotify · 2023-07-26T15:52:19Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.45-7 🚀

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

BaseOptionSelector: add focus logic in componentDidUpdate

c0d257d

tienifr marked this pull request as ready for review July 18, 2023 03:58

tienifr requested a review from a team as a code owner July 18, 2023 03:58

melvin-bot bot requested review from eVoloshchak and removed request for a team July 18, 2023 03:58

tienifr mentioned this pull request Jul 18, 2023

[HOLD for payment 2023-08-02] [$1000] Request Money input is not getting focus when navigating back #22610

Closed

6 tasks

cead22 requested changes Jul 18, 2023

View reviewed changes

fix: clean code

a455a6f

eVoloshchak approved these changes Jul 19, 2023

View reviewed changes

melvin-bot bot requested a review from cead22 July 19, 2023 15:51

cead22 approved these changes Jul 24, 2023

View reviewed changes

cead22 merged commit dbbb809 into Expensify:main Jul 24, 2023

OSBotify mentioned this pull request Jul 25, 2023

Deploy Checklist: New Expensify 2023-07-25 #23522

Closed

dukenv0307 mentioned this pull request Jul 25, 2023

[$1000] Input loses focus when using keyboard shortcut #23322

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix 22610: Request Money input is not getting focus when navigating back #22985

fix 22610: Request Money input is not getting focus when navigating back #22985

tienifr commented Jul 17, 2023 •

edited

Loading

melvin-bot bot commented Jul 18, 2023

cead22 Jul 18, 2023

cead22 Jul 18, 2023

tienifr commented Jul 19, 2023

eVoloshchak commented Jul 19, 2023 •

edited

Loading

eVoloshchak commented Jul 19, 2023

tienifr commented Jul 21, 2023

tienifr commented Jul 24, 2023

cead22 commented Jul 24, 2023

OSBotify commented Jul 24, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

	// Focus text input
	// If we automatically focus on a text input when mounting a component,
	// let's automatically focus on it when the component updates as well (eg, when navigating back from a page)

fix 22610: Request Money input is not getting focus when navigating back #22985

fix 22610: Request Money input is not getting focus when navigating back #22985

Conversation

tienifr commented Jul 17, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 18, 2023

cead22 Jul 18, 2023

Choose a reason for hiding this comment

cead22 Jul 18, 2023

Choose a reason for hiding this comment

tienifr commented Jul 19, 2023

eVoloshchak commented Jul 19, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak commented Jul 19, 2023

tienifr commented Jul 21, 2023

tienifr commented Jul 24, 2023

cead22 commented Jul 24, 2023

OSBotify commented Jul 24, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

tienifr commented Jul 17, 2023 •

edited

Loading

eVoloshchak commented Jul 19, 2023 •

edited

Loading