Skip to content

fix: mobile doesn't need manual focus anymore for autoFocus#54755

Merged
mountiny merged 1 commit into
Expensify:mainfrom
margelo:fix/textinput-auto-focus
Jan 23, 2025
Merged

fix: mobile doesn't need manual focus anymore for autoFocus#54755
mountiny merged 1 commit into
Expensify:mainfrom
margelo:fix/textinput-auto-focus

Conversation

@hannojg

@hannojg hannojg commented Jan 2, 2025

Copy link
Copy Markdown
Contributor

Explanation of Change

There is a bug in react native where calling textInputRef.focus() doesn't focus the text input. That is the reason for the bug which this PR wants to fix. This kind of bug doesn't happen when we use the autoFocus native prop on the TextInput.
I figured, instead of going down the rabbit hole and analyzing why .focus() became broken in certain conditions, we should start to rely on the autoFocus prop again.

In the past we use to manually call textInputRef.focus() to circumvent a bunch of bugs. However, now that we are:

  • on the new arch
  • use native-stack for navigation

those previous problems don't really exist anymore, and it seems safe to remove our manually calling code. (I think it's also cleaner to remove our "custom" code and instead rely on the build in APIs such as the autoFocus prop).

Note

For now I have kept the shouldDelayFocus prop. I think we should be able to remove this prop as well as it was only helping us to circumvent certain bugs, but:

  • I think it would be better to handle this in a separate PR
  • On android there was one case where the input wasn't focused just using the autoFocus prop and we need to investigate why that happens

Opened a follow up ticket here:

Fixed Issues

$ #54658
PROPOSAL: #54658

Tests

  • Open the app on a physical iOS device
  • Open the sign in page
  • Enter your email (note: make sure that the email address is added to your iOS mail app as well)
  • When being brought to the magic code page
    1. Make sure that the keyboard has switched to a numeric input
    2. open your mail app and wait for the code to arrive, don't open it
  • Go back to the app and make sure that it auto suggests the magic code

Additionally make sure all other text inputs when navigating through the app are still being auto focused.

Offline tests

n/a

QA Steps

Same as testing steps

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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.ts 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 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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.

Screenshots/Videos

Android: Native
Screen_Recording_20250102_141359_New.Expensify.Dev.mp4
Android: mWeb Chrome
Screen_Recording_20250102_144524_Samsung.Internet.mp4
iOS: Native
ios_after.MP4
iOS: mWeb Safari
ios_mWeb.MP4
MacOS: Chrome / Safari
CleanShot.2025-01-02.at.14.39.03.mp4
MacOS: Desktop
CleanShot.2025-01-02.at.14.48.53.mp4

@melvin-bot

melvin-bot Bot commented Jan 2, 2025

Copy link
Copy Markdown

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

@hannojg hannojg marked this pull request as ready for review January 2, 2025 13:53
@hannojg hannojg requested a review from a team as a code owner January 2, 2025 13:53
@melvin-bot melvin-bot Bot requested review from allroundexperts and removed request for a team January 2, 2025 13:53
@melvin-bot

melvin-bot Bot commented Jan 2, 2025

Copy link
Copy Markdown

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

@hannojg

hannojg commented Jan 2, 2025

Copy link
Copy Markdown
Contributor Author

@allroundexperts

allroundexperts commented Jan 6, 2025

Copy link
Copy Markdown
Contributor

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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.ts 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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

Android: Native
Android: mWeb Chrome
Screen.Recording.2025-01-08.at.11.08.39.PM.mov
iOS: Native
ScreenRecording_01-08-2025.21-07-16_1.MP4
ScreenRecording_01-08-2025.21-10-24_1.MP4
ScreenRecording_01-08-2025.21-14-10_1.MP4
iOS: mWeb Safari
Screen.Recording.2025-01-08.at.10.56.54.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-01-08.at.10.52.57.PM.mov
MacOS: Desktop
Screen.Recording.2025-01-08.at.10.55.35.PM.mov

@allroundexperts

Copy link
Copy Markdown
Contributor

@hannojg Although the field is focused, but the keyboard does not appear. Is that expected?

ScreenRecording_01-08-2025.22-41-03_1.MP4

@hannojg

hannojg commented Jan 9, 2025

Copy link
Copy Markdown
Contributor Author

Although the field is focused, but the keyboard does not appear. Is that expected?

I know that there are certain conditions in which we will display the keyboard in the chat. We don't display it per se for every chat. I would need to lookup the conditions for that, hold on …

@allroundexperts

Copy link
Copy Markdown
Contributor

This is happening on dev as well btw, so it shouldn't block the approval.

@melvin-bot

melvin-bot Bot commented Jan 22, 2025

Copy link
Copy Markdown

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

@melvin-bot

melvin-bot Bot commented Jan 22, 2025

Copy link
Copy Markdown

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

@allroundexperts

Copy link
Copy Markdown
Contributor

🎀 👀 🎀

@melvin-bot

melvin-bot Bot commented Jan 22, 2025

Copy link
Copy Markdown

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

@mountiny mountiny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, changes look good to me

@mountiny

Copy link
Copy Markdown
Contributor

Is this issue happening in dev too? #54755 (comment) I think we should open the keyboard everytime

@hannojg

hannojg commented Jan 23, 2025

Copy link
Copy Markdown
Contributor Author

I think there is custom behavior to when the keyboard should open when opening a chat (I never understood why though, but there were some reasons for that). On production the keyboard doesn't open for me for every chat.
So I think this is a feature, not a bug.

@mountiny

Copy link
Copy Markdown
Contributor
image got it

@mountiny mountiny merged commit c257d31 into Expensify:main Jan 23, 2025
@hannojg

hannojg commented Jan 23, 2025

Copy link
Copy Markdown
Contributor Author

😂 😂

when I have time I will find the specific code lines that control that behaviour

@OSBotify

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown
Contributor

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

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

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.89-8 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants