Skip to content

Conversation

@chrispader
Copy link
Contributor

@chrispader chrispader commented May 6, 2025

@maddylewis

Explanation of Change

Fixes an issue with the React Native TextInput component in combination with handling modals. By default, the composer on the ReportScreen would get re-focussed once a modal hides, because it becomes the "first responder" on iOS. This is not something that is handled by React Native directly, but is rather an internal logic in UIKit.

When we show two modals right after each other, we want to prevent the keyboard from opening, because it seems like a "flicker". This can only be achieved with a native fix in the React Native codebase directly.

This PR adds the necessary functionality to the React Native TextInput component, which let's us (explicitly) prevent re-focusing in specific scenarios. The following things have been added:

  • A command/ref function called prevenAutoFocusOnFirstResponderOnce, which let's us prevent the re-focus once (on the next focus)
  • A prop called preventFocusOnFirstResponder, which let's us set this behavior permanently. This can also be toggled to achieve the same effect as the command.

Because we're handling two modals after each other, the re-focusing of the TextInput after we close all modals will not work out-of-the-box, once we prevent the re-focusing after the first modal. Therefore, i added the necessary logic in JavaScript to achieve the same effect manually.

Fixed Issues

$ #54813
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
  1. Open app
  2. Go to report/chat
  3. Focus composer by pressing on the text input
  4. Long-press a message
  5. Press "Add emoji reaction" bubble
  6. Make sure that the keyboard doesn't open in-between modals
  7. Select emoji or press on backdrop
  8. Make sure that the composer is focused again.

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • 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: 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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_20250507_182945_New.Expensify.Dev.mp4
Android: mWeb Chrome
iOS: Native
Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-05-06.at.16.50.53.mp4
Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-05-06.at.16.51.04.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@chrispader chrispader requested a review from a team as a code owner May 6, 2025 14:35
@github-actions
Copy link
Contributor

github-actions bot commented May 6, 2025

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@melvin-bot
Copy link

melvin-bot bot commented May 6, 2025

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

@parasharrajat
Copy link
Member

I will get the review going.

@francoisl francoisl requested a review from parasharrajat May 6, 2025 16:36
@francoisl
Copy link
Contributor

It’s 845 commits behind (base commit: 1082941)

Can we also pull main into the branch so it's more up-to-date please? We've had issues in the past with super outdated branches that used code that was removed or modified in other files and didn't cause conflicts.

@chrispader
Copy link
Contributor Author

@francoisl @parasharrajat merged main and just tested this PR in HybridApp as well, everthing works there as well! 🚀

@parasharrajat
Copy link
Member

@chrispader I am trying to understand the solution here. We call focus manually on the composer after a modal hides

ComposerFocusManager.refocusAfterModalFullyClosed(uniqueModalId, restoreFocusType);
.

So why can't we control this part to fix this issue? Just don't call this when we already know that a new modal is about to open. Have you already tried this?

@chrispader
Copy link
Contributor Author

@chrispader I am trying to understand the solution here. We call focus manually on the composer after a modal hides

So why can't we control this part to fix this issue? Just don't call this when we already know that a new modal is about to open. Have you already tried this?

Yes i've tried this right in the beginning, but unfortunately the ComposerFocusManager is not what's causing the issue here. Even if you comment out this line or disable all the logic around this the keyboard is still opening between the two modals, because of the UIResponder's "first responder chain" logic in the native implementation of UITextField and UITextView.

You can test it out and see that the keyboard will still open when you comment out this line

@parasharrajat
Copy link
Member

Yeah, I tested and it does. So first responder theory seems correct. I will test out this PR shortly.

@francoisl
Copy link
Contributor

@parasharrajat did you have a chance to start reviewing?

@parasharrajat
Copy link
Member

Yes. I will post updates after few hours.

@chrispader
Copy link
Contributor Author

Build is taking forever, I tried a few times and it takes about an hour and fails.

@parasharrajat hmm weird, but i don't think it's related to this PR. I could build successfully

@github-actions
Copy link
Contributor

🚧 @francoisl has triggered a test Expensify/App build. You can view the workflow run here.

@parasharrajat
Copy link
Member

Thanks @francoisl. I have been struggling to build since yesterday 🥹

@francoisl
Copy link
Contributor

Haha no worries, feel free to ask anytime.

@github-actions
Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #61492.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/61492/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/61492/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/61492/NewExpensify.dmg https://61492.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@parasharrajat
Copy link
Member

BUG: mWeb Chrome: No Focus return to the composer after emoji picker is hidden. it works on staging.

28.06.2025_15.31.16_REC.mp4

@chrispader
Copy link
Contributor Author

BUG: mWeb Chrome: No Focus return to the composer after emoji picker is hidden. it works on staging.

Cannot reproduce this one :/

XRecorder_20250628_01.mp4
XRecorder_20250628_04.mov

@parasharrajat
Copy link
Member

parasharrajat commented Jun 29, 2025

I can reproduce this on real device as well as simulator. Please clear your cache and try with https://61492.pr-testing.expensify.com/

Steps:

  1. Open any chat.
  2. Click on composer to focus it.
  3. Now click on the emoji picker sign on the composer.
  4. Close the picker by clicking the the background area.
  5. No focus on the composer.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 1, 2025

🚧 @francoisl has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 1, 2025

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #61492.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/61492/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/61492/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/61492/NewExpensify.dmg https://61492.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@francoisl
Copy link
Contributor

I can reproduce this on real device as well as simulator. Please clear your cache and try with 61492.pr-testing.expensify.com

Steps:

I'm also unable to reproduce this with a physical device and with Browserstack, via https://61492.pr-testing.expensify.com/.

Rajat, does this happen 100% of the time for you? I tried to repro from different views where the composer is used, but I wonder if there's some additional requirement for the issue to happen that we're not seeing.
Otherwise, maybe let's not block on this and see if it pops up again in the future.

screen-20250701-205832.mp4
Screen.Recording.2025-07-01.at.21.12.33.mov

@parasharrajat
Copy link
Member

Let me look at it again but if you can't reproduce this either then I think we can move ahead and see of QA finds it.

@francoisl
Copy link
Contributor

Sounds good. Let us know how it goes. Other than that I think this is ready to merge? 🙏

@parasharrajat
Copy link
Member

Screenshots

🔲 iOS / native

ScreenRecording_06-28-2025.14-37-26_1.MP4

🔲 iOS / Safari

ScreenRecording_06-28-2025.14-48-51_1.MP4

🔲 MacOS / Desktop

28.06.2025_14.41.06_REC.mp4

🔲 MacOS / Chrome

28.06.2025_14.36.13_REC.mp4

🔲 Android / Chrome

Screenrecorder-2025-07-03-12-02-04-856.mp4

🔲 Android / native

Screenrecorder-2025-07-03-12-27-34-363.mp4

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.
  • 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.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from nkuoch July 3, 2025 07:51
@parasharrajat
Copy link
Member

Ready @francoisl

@francoisl francoisl merged commit 9494e08 into Expensify:main Jul 3, 2025
26 checks passed
@github-actions
Copy link
Contributor

github-actions bot commented Jul 3, 2025

🚀 Deployed to staging by https://github.com/francoisl in version: 9.1.75-0 🚀

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

@github-actions
Copy link
Contributor

github-actions bot commented Jul 7, 2025

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.76-5 🚀

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

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants