Skip to content

FIX: iOS - Expose Pager's internal onPageSelected as onTabSelect to fix Start chat tab switching input fields losing focus - #60468

Merged
arosiclair merged 42 commits into
Expensify:mainfrom
ikevin127:ikevin127-ikevin127-startChatTabsInputFocus
May 29, 2025
Merged

arosiclair merged 42 commits into
Expensify:mainfrom
ikevin127:ikevin127-ikevin127-startChatTabsInputFocus

Conversation

@ikevin127

Copy link
Copy Markdown
Contributor

Explanation of Change

♻ From reviewer's comment:

The key sequence is:

  1. User selects the #Room tab.
  2. Transition animation begins (i.e., setViewControllers:direction:animated:completion:).
  3. Our useAutoFocusInput hook assigns focus to the room name input field.
  4. Upon animation completion, iOS internally calls removeFromSuperview, which causes the input to lose focus.

In this PR we're adding a react-navigation patch for the react-native-tab-view package in order to expose the onPageSelected navigator event method, which offers the right amount of delay in order to fix our issue targeting the key sequence events described above of iOS internal calls, while removing already existing autofocus logic which proved to not be effective.

Note

🟢 I fixed the issue for the Chat tab as well, now behaviour all platforms should be aligned - with the exception of iOS: mWeb Safari where the behaviour remains the same as in current staging / production.

Fixed Issues

$ #59388
PROPOSAL: #59388 (comment)

Tests

  1. Launch HybridApp.
  2. Open FAB > Start chat.
  3. Make sure it opens to Chat tab, otherwise switch to Chat, close and repeat step 2.
  4. Tap on the Room tab and verify that the input is focused and the focus is not lost shortly after.
  5. Tap back on the Chat tab and verify that the input is focused and the focus is not lost shortly after.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests.

  • 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 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
android.mp4
Android: HybridApp
android-hybrid.mp4
Android: mWeb Chrome
android-mweb.mp4
iOS: Native
ios.mp4
iOS: HybridApp
ios-hybrid.mp4
Details

👇 Behaviour is unchanged from current staging / production.

iOS: mWeb Safari
ios-mweb.mp4
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@ikevin127
ikevin127 requested a review from a team as a code owner April 17, 2025 22:38
@melvin-bot
melvin-bot Bot requested review from ntdiary and removed request for a team April 17, 2025 22:38
@melvin-bot

melvin-bot Bot commented Apr 17, 2025

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ 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. ⚠️

Comment on lines +45 to +46
// @ts-expect-error - props not used
function WorkspaceNewRoomPage(props, ref: React.Ref<WorkspaceNewRoomPageHandle>) {

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.

why do we need this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ref forwarding, I'll remove the @ts-expect-error though 👍

const isIOSNative = getPlatform() === CONST.PLATFORM.IOS;
// We're disabling the useAutoFocusInput functionality on iOS native because we're using the new `onPageSelected` focus method in `NewChatSelectorPage`, otherwise keeping it to align the behavior on all platforms
const {inputCallbackRef} = useAutoFocusInput(undefined, isIOSNative);
const roomPageInputRef = useRef<AnimatedTextInputRef>(null);

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.

Suggested change
const roomPageInputRef = useRef<AnimatedTextInputRef>(null);
const roomPageInputRef = useRef<AnimatedTextInputRef | null>(null);

return;
}
inputCallbackRef(inputRef);
// @ts-expect-error - inputRef.current is not read-only

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.

Suggested change
// @ts-expect-error - inputRef.current is not read-only

@getusha

getusha commented Apr 23, 2025

Copy link
Copy Markdown
Contributor

will do thorough review after testing

@getusha

getusha commented Apr 24, 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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • 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
Screen.Recording.2025-05-21.at.4.36.27.in.the.afternoon.mov
Android: mWeb Chrome
Screen.Recording.2025-05-21.at.3.52.38.in.the.afternoon.mov
iOS: Native
Screen.Recording.2025-04-28.at.12.56.53.in.the.afternoon.mov
iOS: mWeb Safari
Screen.Recording.2025-05-21.at.4.02.28.in.the.afternoon.mov
MacOS: Chrome / Safari
Screen.Recording.2025-05-21.at.3.49.34.in.the.afternoon.mov
MacOS: Desktop
Screen.Recording.2025-05-28.at.1.14.14.in.the.morning.mov

@getusha

getusha commented Apr 28, 2025

Copy link
Copy Markdown
Contributor

Works flawlessly

Screen.Recording.2025-04-28.at.12.48.19.in.the.afternoon.mov

Comment thread src/pages/NewChatSelectorPage.tsx Resolved
Comment thread src/pages/NewChatSelectorPage.tsx Resolved
Comment thread src/pages/NewChatSelectorPage.tsx Resolved
Comment thread src/pages/NewChatPage.tsx Resolved
Comment thread src/pages/NewChatPage.tsx Resolved
@ikevin127

This comment was marked as outdated.

@ikevin127

ikevin127 commented May 22, 2025 •

Copy link
Copy Markdown
Contributor Author

@getusha Thanks for testing thoroughly and catching that, here's the explanation for it:

  • the native version (PagerViewAdapter) of the react-native-tab-view upstream PR does not require us to call onTabSelect on mount because the internal onPageSelected does that automatically on mount and on tab switch
  • the web-based version (PanResponderAdapter) of the react-native-tab-view upstream PR does not call onTabSelect on mount (this was removed from the upsteam PR in this commit), meaning we need to call onTabSelect on first mount because there's no native implementation of the onPageSelected, instead we added that in the upstream PR, except for the mount part which was removed -> meaning the function is only called on tab switch -> this is why we need to call onTabSelect on mount in this PR

♻️ To deal with the differences between native / web-based platforms, to make sure we only call onTabSelect once, only when needed; I created platform specific implementations for the function:

  • on native onTabSelect will return noop because the native code (PagerViewAdapter) of the react-native-tab-view using the internal onPageSelected will handle both mount / on tab switch focus; fixing this issue where onTabSelect was being called twice
  • on web-based onTabSelect will be called only once on mount (we use a ref to remember), then after mount, the internal implementation (PanResponderAdapter) of the react-native-tab-view will handle the call internally on tab switch

🟢 Ready for final review, please let me know if you find any other issues!

@getusha

getusha commented May 27, 2025

Copy link
Copy Markdown
Contributor

Thanks for the update, seems to work fine on all platforms now.

Screen.Recording.2025-05-27.at.6.43.53.in.the.evening.mov

@ikevin127 could you fix conflicts so we can ship this? thx

@ikevin127

Copy link
Copy Markdown
Contributor Author

@getusha 🟢 Done, thanks for the thorough review once again!

The reassure test seems to fail for cache reasons:

Failed to apply patch file react-native-tab-view+3.5.2.patch.
Failed to apply patch file: /home/runner/work/App/App/patches/tmp-patches-uS3/react-native-tab-view+3.5.2.patch

as react-native-tab-view+3.5.2.patch doesn't exist anymore, was updated to react-native-tab-view+4.1.0.patch after the package version update in this PR. I think we're good to merge as this is a reassure cache issue 👍

@getusha getusha 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.

LGTM

@melvin-bot
melvin-bot Bot requested a review from arosiclair May 27, 2025 22:06
arosiclair
arosiclair previously approved these changes May 28, 2025

@arosiclair arosiclair 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.

Excellent work @ikevin127 👍

@arosiclair

Copy link
Copy Markdown
Contributor

Not sure why this occurs in the perf test:

hint: Recursive merging with submodules currently only supports trivial cases.
Failed to merge submodule Mobile-Expensify (not checked out)
CONFLICT (submodule): Merge conflict in Mobile-Expensify

@ikevin127 can you try merging main?

@ikevin127

Copy link
Copy Markdown
Contributor Author

@arosiclair ✅ Done, should be good now!

@arosiclair
arosiclair merged commit ba0eb23 into Expensify:main May 29, 2025
@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 github-actions Bot mentioned this pull request May 29, 2025
89 tasks done
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/arosiclair in version: 9.1.54-0 🚀

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

@github-actions

github-actions Bot commented Jun 2, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 9.1.54-7 🚀

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


### [react-native-tab-view+4.1.0.patch](react-native-tab-view+4.1.0.patch)

- Reason: Explanation/details

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.

Hi 👋 Thank you for adding this file, good to see we're making some progress on documenting our patches!

We introduced this flow to get a better idea and one source of truth about the patches, so would be nice if you could add a few lines about why we need this patch 🙏

@ikevin127 ikevin127 Jun 4, 2025 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

👋 Hi, this pathch was only updated in this PR since this PR updated the react-native-tab-view version which required updating the patch: react-native-tab-view+3.5.2.patch -> react-native-tab-view+4.1.0.patch, the initial patch was introduced by this PR -> the author @chrispader might be able to add some details here as to why we need this patch.

I added the details.md with as much detail as I could because it was blocking the PR from merging.

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 for the explanation 🙇 @chrispader could you share some details on this patch? I can prepare a PR but need some context 🙏

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.

I'm not totally sure anymore, but basically it just fixed an issue where the component would not cause a re-render when the tab changes. As in:

This PR fixes a problem where the camera in IOURequestStepScan would not render, because the current position value provided by react-native-tab-view never updates when changing the tab.

We were talking about upstreaming this and i think someone from Callstack might have worked on that: #39854 (comment)


- Reason: Explanation/details
- Upstream PR/issue: N/A
- E/App issue: https://github.com/Expensify/App/issues/38796 | https://github.com/Expensify/App/issues/39285

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.

Also this section is for an E/App issue created exclusively for removing this patch. I'm gonna update the guide with some more explanation

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.

6 participants