Skip to content

Enable autofocus on Per Diem destination picker#85310

Merged
rlinoz merged 2 commits intomainfrom
claude-perDiemAutofocusFix
Mar 20, 2026
Merged

Enable autofocus on Per Diem destination picker#85310
rlinoz merged 2 commits intomainfrom
claude-perDiemAutofocusFix

Conversation

@MelvinBot
Copy link
Contributor

@MelvinBot MelvinBot commented Mar 15, 2026

Explanation of Change

The Per Diem destination picker's search input sometimes failed to autofocus when switching to the Per Diem tab. This was caused by two timing issues in IOURequestStartPage:

  1. Keyboard.dismiss() raced with autofocusresetIOUTypeIfChanged called Keyboard.dismiss() unconditionally on every tab switch. On iOS, the keyboard dismiss animation suppresses subsequent .focus() calls, preventing the Per Diem search input from gaining focus. This is now conditional — Keyboard.dismiss() is skipped when switching to the Per Diem tab.

  2. requestAnimationFrame was too earlyonTabSelectFocusHandler used requestAnimationFrame to focus the Per Diem input, but with lazy-loaded tabs the component hadn't mounted yet by the next animation frame. This is now replaced with setTimeout(..., CONST.ANIMATED_TRANSITION) to give the tab enough time to mount before attempting focus.

Fixed Issues

$ #85277
PROPOSAL: #85277 (comment)

Tests

  1. Have a workspace with Per Diem enabled and at least 12 per diem destinations (so the search input appears)
  2. Open the app on iOS
  3. Press FAB -> Create expense
  4. Go to the Per Diem tab
  5. Verify the search input field is autofocused and the keyboard appears
  • Verify that no errors appear in the JS console

Offline tests

N/A — Autofocus behavior is client-side only and does not depend on network state.

QA Steps

  1. Have a workspace with Per Diem enabled and at least 12 per diem destinations
  2. Open the app on iOS
  3. Press FAB -> Create expense
  4. Go to the Per Diem tab
  5. Verify the search input field is autofocused and the keyboard appears
  6. Navigate away and back to verify autofocus fires reliably each time
  • 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
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

Remove disableAutoFocus from DestinationPicker so the SelectionList's
built-in useFocusEffect autofocus fires when the Per Diem tab gains
focus. Also fix the stale ref in IOURequestStepDestination's
useImperativeHandle by using a lazy getter so the ref is read at call
time rather than at render time.

Co-authored-by: Cong Pham <suneox@users.noreply.github.com>
@suneox
Copy link
Contributor

suneox commented Mar 16, 2026

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: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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: HybridApp
CleanShot.2026-03-16.at.00.06.52.5.mp4
Android: mWeb Chrome
CleanShot.2026-03-16.at.00.03.37.3.mp4
iOS: HybridApp
CleanShot.2026-03-16.at.00.01.38.2.mp4
iOS: mWeb Safari
CleanShot.2026-03-16.at.00.04.39.4.mp4
MacOS: Chrome / Safari
CleanShot.2026-03-16.at.00.01.03.1.mp4

@suneox
Copy link
Contributor

suneox commented Mar 16, 2026

@MelvinBot Please investigate why auto focus sometimes doesn't work when creating a manual expense from Quick Action. This happens when the Manual tab was previously selected and then change tab to Per Diem.

CleanShot.2026-03-16.at.00.01.38.2.mp4

@MelvinBot
Copy link
Contributor Author

🔍 Investigation: Autofocus fails when switching from Manual to Per Diem tab

Summary: The intermittent autofocus failure when switching from the Manual tab to the Per Diem tab is caused by two interacting issues: (1) an unconditional Keyboard.dismiss() call that races with the subsequent autofocus mechanisms, and (2) a lazy-loading race condition where the focus attempt fires before the Per Diem tab component has mounted.

Root Cause: Two timing conflicts prevent the Per Diem destination picker from gaining focus:

1. Keyboard.dismiss() races with autofocus (iOS)

In IOURequestStartPage.tsx:183, resetIOUTypeIfChanged calls Keyboard.dismiss() unconditionally on every tab switch:

const resetIOUTypeIfChanged = useCallback(
    (newIOUType: IOURequestType) => {
        Keyboard.dismiss(); // fires on EVERY tab switch, before autofocus

This fires via onTabSelected from the OnyxTabNavigator's screenListeners.state handler — before either autofocus mechanism runs. On iOS, the keyboard dismiss animation (~250ms) can suppress subsequent .focus() calls. This explains the "sometimes" nature: when the keyboard was visible on the Manual tab (user was typing an amount), Keyboard.dismiss() actively interferes; when it wasn't visible, it's a no-op and autofocus works.

2. Lazy-loading race condition

With lazyLoadEnabled on the tab navigator (IOURequestStartPage.tsx:322), the Per Diem tab content (IOURequestStepDestination) is not mounted until the user switches to it. The focus handler at IOURequestStartPage.tsx:119-128:

const onTabSelectFocusHandler = ({index}: {index: number}) => {
    requestAnimationFrame(() => {
        if (index !== PER_DIEM_TAB_INDEX) { return; }
        perDiemInputRef.current?.focus?.();
    });
};

...wraps the focus call in requestAnimationFrame. But with lazy loading, the IOURequestStepDestination component may still be mounting when this fires, meaning perDiemInputRef.current is null and the focus call is silently skipped via optional chaining.

Contributing factor: Non-memoized focusTextInput

In BaseSelectionListWithSections.tsx:187-189, focusTextInput is not wrapped in useCallback. Every render creates a new function reference, which changes the dependency array of the useFocusEffect callback in TextInput.tsx:88-104, causing the 300ms autofocus timeout to be repeatedly cleared and reset. The initMoneyRequest call during tab switch triggers Onyx updates that cause cascading re-renders, amplifying this effect.

Timeline

t=0ms:     Tab press → navigation state changes
t≈0ms:     screenListeners.state fires → Keyboard.dismiss() + initMoneyRequest (Onyx.set)
t≈0ms+:    Per Diem screen starts mounting (lazy)
t≈16ms:    requestAnimationFrame fires → perDiemInputRef.current is null → focus skipped
t≈0-300ms: Onyx re-renders repeatedly reset useFocusEffect timeout
t≈300ms+:  Final setTimeout fires → focus() attempt may be suppressed by Keyboard.dismiss()

Note: This is a pre-existing issue not introduced by this PR. The PR's changes (removing disableAutoFocus and fixing the stale ref) are correct improvements, but they don't address these timing conflicts.

Relevant Code Locations

Next Steps: If this should be addressed, a separate issue could be filed. Potential fixes include: (1) conditioning Keyboard.dismiss() to skip Per Diem tab switches or deferring it, (2) replacing requestAnimationFrame with a retry/polling mechanism that waits for the ref to be available, or (3) memoizing focusTextInput with useCallback to prevent timeout resets.

@suneox
Copy link
Contributor

suneox commented Mar 16, 2026

@MelvinBot Ok so we can revert the current changes and then apply the fix as follows:
(1) Condition Keyboard.dismiss() to skip Per Diem tab switches.
(2) replacing requestAnimationFrame by setTimeout with CONST.ANIMATED_TRANSITION to handle focusing, similar to the pattern used on many other places.

…questStartPage

- Reverted removal of disableAutoFocus in DestinationPicker
- Reverted stale ref fix in IOURequestStepDestination
- Conditioned Keyboard.dismiss() to skip Per Diem tab switches so it
  does not suppress subsequent focus calls on iOS
- Replaced requestAnimationFrame with setTimeout using
  CONST.ANIMATED_TRANSITION in onTabSelectFocusHandler for reliable
  focus timing after tab animation completes

Co-authored-by: Cong Pham <suneox@users.noreply.github.com>
@MelvinBot
Copy link
Contributor Author

Done! I've reverted the previous changes and applied the new fix approach. Here's what changed:

  1. Reverted disableAutoFocus: true removal in DestinationPicker.tsx and the stale ref fix in IOURequestStepDestination.tsx
  2. Conditioned Keyboard.dismiss() in IOURequestStartPage.tsx — it now skips dismissal when switching to the Per Diem tab, so it doesn't suppress the subsequent focus call on iOS
  3. Replaced requestAnimationFrame with setTimeout(…, CONST.ANIMATED_TRANSITION) in onTabSelectFocusHandler for reliable focus timing after the tab animation completes, matching the pattern used elsewhere in the codebase (e.g., IOURequestStepAmount, IOURequestStepHours, IOURequestStepTimeRate)

@codecov
Copy link

codecov bot commented Mar 16, 2026

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/pages/iou/request/IOURequestStartPage.tsx 71.21% <80.00%> (-0.55%) ⬇️
... and 60 files with indirect coverage changes

@suneox
Copy link
Contributor

suneox commented Mar 18, 2026

@MelvinBot ready for review

@MelvinBot
Copy link
Contributor Author

I have failed to help you. I let you down and for that I am sorry. Please try again later. This may be due to a Claude outage (check here).

Failure details: https://github.com/Expensify/Expensify/actions/runs/23245907686

@suneox
Copy link
Contributor

suneox commented Mar 18, 2026

@MelvinBot Update PR status to ready not draft

@MelvinBot MelvinBot marked this pull request as ready for review March 18, 2026 13:07
@MelvinBot MelvinBot requested a review from a team as a code owner March 18, 2026 13:07
@MelvinBot
Copy link
Contributor Author

Done — PR has been marked as ready for review.

@melvin-bot melvin-bot bot requested review from joekaufmanexpensify and suneox and removed request for a team March 18, 2026 13:08
@melvin-bot
Copy link

melvin-bot bot commented Mar 18, 2026

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

@melvin-bot melvin-bot bot removed the request for review from a team March 18, 2026 13:08
@suneox
Copy link
Contributor

suneox commented Mar 19, 2026

@MelvinBot update Explanation of Change for current PR

@MelvinBot
Copy link
Contributor Author

Updated the Explanation of Change to match the current implementation. The description now accurately reflects the two changes in IOURequestStartPage.tsx:

  1. Conditional Keyboard.dismiss() — Skipped when switching to the Per Diem tab to prevent it from racing with autofocus
  2. requestAnimationFramesetTimeout(..., CONST.ANIMATED_TRANSITION) — Gives the lazy-loaded Per Diem tab enough time to mount before attempting focus

Copy link
Contributor

@joekaufmanexpensify joekaufmanexpensify left a comment

Choose a reason for hiding this comment

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

Fine for product

@melvin-bot
Copy link

melvin-bot bot commented Mar 20, 2026

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

@melvin-bot melvin-bot bot requested a review from rlinoz March 20, 2026 12:45
@github-actions
Copy link
Contributor

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

@github-actions

This comment has been minimized.

@github-actions
Copy link
Contributor

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

@github-actions
Copy link
Contributor

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

Android 🤖 iOS 🍎
❌ FAILED ❌ ❌ FAILED ❌
The QR code can't be generated, because the Android build failed The QR code can't be generated, because the iOS build failed
Web 🕸️
https://85310.pr-testing.expensify.com
Web

👀 View the workflow run that generated this build 👀

@rlinoz rlinoz merged commit 693f7f5 into main Mar 20, 2026
43 checks passed
@rlinoz rlinoz deleted the claude-perDiemAutofocusFix branch March 20, 2026 15:40
@github-actions
Copy link
Contributor

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

@github-actions
Copy link
Contributor

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

Android 🤖 iOS 🍎
❌ FAILED ❌ https://ad-hoc-expensify-cash.s3.us-east-1.amazonaws.com/rock-artifacts/ad-hoc/rock-ios-device-AdHoc-693f7f5-9be7b50-c2e4e52dd4c3b18d9aa456573fc568050ff894b6/index.html
The QR code can't be generated, because the Android build failed iOS
Web 🕸️
https://85310.pr-testing.expensify.com
Web

👀 View the workflow run that generated this build 👀

@OSBotify
Copy link
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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/rlinoz in version: 9.3.42-0 🚀

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

Bundle Size Analysis (Sentry):

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.

5 participants