Skip to content

Open keyboard automatically on Android magic code screen#90771

Open
wildan-m wants to merge 8 commits into
Expensify:mainfrom
wildan-m:wildan/80025-android-keyboard-magic-code
Open

Open keyboard automatically on Android magic code screen#90771
wildan-m wants to merge 8 commits into
Expensify:mainfrom
wildan-m:wildan/80025-android-keyboard-magic-code

Conversation

@wildan-m
Copy link
Copy Markdown
Contributor

@wildan-m wildan-m commented May 15, 2026

Explanation of Change

On Android, the soft keyboard did not open automatically when reaching the magic code input screen after adding a new contact method. The form was relying on a fixed 300 ms delay before focusing the input, which has no relationship to whether the app window actually holds focus at that moment. Android's documented behavior is to silently drop the keyboard request whenever the window has not regained focus by the time the focus call is made, so the keyboard never appeared. iOS and web were unaffected because they do not have the same window-focus requirement.

The fix replaces the fixed delay with two combined signals. First, the form listens for the navigation transition-end event so it focuses the input exactly when the screen transition finishes (deterministic instead of a guessed timeout). Then it awaits a small helper that resolves only once the app window has regained focus — a no-op on iOS and web, and on Android a Promise tied to the system's window focus events. A safety fallback timer fires if the transition-end event never arrives (for example when the screen is already focused while the effect runs), and a guard flag ensures the listener and the fallback never both run.

The mobile Safari path is intentionally left as a synchronous focus call, because that browser only opens the keyboard when the focus call originates inside the user gesture handler.

Fixed Issues

$ #80025
PROPOSAL: #80025 (comment)

Tests

  1. Sign in on Android Native with a test account.
  2. Navigate to account settings > Profile.
  3. Click on "Contact Method".
  4. Click on "New Contact method".
  5. Enter a valid new email address and click "Add".
  6. Verify the magic code screen is displayed.
  7. Verify the soft keyboard opens automatically (without having to tap the input field).
  8. Enter the magic code received via email and click "Verify" to confirm the input still works as expected.
  • Verify that no errors appear in the JS console

Offline tests

The fix only changes when and how the magic code input is focused after a screen transition; it does not alter any network behavior. With the device offline, opening the magic code screen still focuses the input and opens the keyboard exactly as in the online case (verification of the magic code itself still fails offline as before, since that requires a network request).

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
  • 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: N/A — no new copy
    • 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
Kapture.2026-05-16.at.20.15.14.mp4
Android: mWeb Chrome
Kapture.2026-05-16.at.20.24.15.mp4
iOS: Native
Kapture.2026-05-16.at.20.32.39.mp4
iOS: mWeb Safari
Kapture.2026-05-16.at.20.34.35.mp4
MacOS: Chrome / Safari
Kapture.2026-05-16.at.20.26.57.mp4

…oid keyboard

Replaces the deprecated InteractionManager.runAfterInteractions approach with
React Navigation's transitionEnd event listener — the canonical replacement
recommended in contributingGuides/INTERACTION_MANAGER.md and the same pattern
used by useAutoFocusInput across 100+ screens.

Falls back to setTimeout(CONST.SCREEN_TRANSITION_END_TIMEOUT) when
transitionEnd does not fire (e.g. when the screen is already focused).
@codecov
Copy link
Copy Markdown

codecov Bot commented May 15, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
...ionModal/ValidateCodeForm/BaseValidateCodeForm.tsx 87.61% <100.00%> (+5.01%) ⬆️
... and 10 files with indirect coverage changes

@wildan-m wildan-m marked this pull request as ready for review May 16, 2026 14:11
@wildan-m wildan-m requested review from a team as code owners May 16, 2026 14:11
@melvin-bot melvin-bot Bot requested review from flaviadefaria and gijoe0295 and removed request for a team May 16, 2026 14:11
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 16, 2026

@gijoe0295 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 May 16, 2026 14:11
// Android only opens the soft keyboard once the app window has focus, so we
// chain: wait for the screen transition to finish, then for the window-focus
// signal (a no-op on iOS and web), then focus the input.
let didFocus = false;
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.

❌ CONSISTENCY-3 (docs)

The transitionEnd listener + setTimeout fallback + isWindowReadyToFocus() pattern introduced here duplicates the same pattern already implemented in src/hooks/useAutoFocusInput.ts (lines 100-126). Both use navigation.addListener('transitionEnd', ...), check event?.data?.closing, fall back with setTimeout(..., CONST.SCREEN_TRANSITION_END_TIMEOUT), and chain with isWindowReadyToFocus() before focusing.

Consider extracting the shared "focus after transition" logic into a reusable hook (e.g., useTransitionEndCallback) that both useAutoFocusInput and this component can consume, or adapt useAutoFocusInput to work for this use case. This would eliminate the maintenance burden of keeping two copies of this non-trivial pattern in sync.


Reviewed at: 0ac8e59 | Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

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.

Acknowledged but keeping the inlined approach. The proposal explicitly evaluated reusing useAutoFocusInput and rejected it because adapting it for MagicCodeInput requires adding an inputCallbackRef prop to the input's public API — which would cascade through every existing MagicCodeInput consumer, well outside the scope of an Android-keyboard-only bug fix on one screen. Extracting a brand-new shared hook is the same amount of scope creep with the added downside of two callers immediately depending on a hook with no other proven users.

The current inlining is a localized 30-line block that's tightly bound to this one useFocusEffect; the maintenance burden of keeping it loosely in sync with useAutoFocusInput is low, and the C+ reviewer already approved this approach. Happy to revisit as a follow-up if there's a third consumer in the future.

Comment thread tests/unit/BaseValidateCodeFormTest.tsx Outdated
};

jest.mock('@react-navigation/native', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
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.

❌ CONSISTENCY-5 (docs)

The eslint-disable-next-line @typescript-eslint/no-unsafe-assignment directive lacks a justification comment explaining why the rule is disabled.

Add a comment explaining the reason, e.g.:

// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- jest.requireActual returns unknown; safe cast for test mock
const actualNav = jest.requireActual('@react-navigation/native');

Reviewed at: 0ac8e59 | Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

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.

Applied in 0dd1382 — added a justification comment to the eslint-disable directive explaining that jest.requireActual returns unknown and this is the standard pattern for spreading the actual module in jest.mock factories.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0ac8e59061

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines +191 to +192
isWindowReadyToFocus().then(() => {
inputValidateCodeRef.current?.focusLastSelected();
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Guard the deferred focus after blur

On Android, isWindowReadyToFocus() can remain pending until the next AppState focus event (src/libs/isWindowReadyToFocus/index.android.ts), but this .then is not cancelled when the route blurs; cleanup only removes the listener/timer. If the magic-code screen starts this wait and then loses navigation focus while the app window is still blurred, the promise later resolves and focuses this screen's input even though another screen is active, stealing focus/keyboard. Track an isActive flag (or equivalent) and check it before calling focusLastSelected().

Useful? React with 👍 / 👎.

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.

Good catch — applied in 0dd1382.

Added an isCancelled flag local to the useFocusEffect callback, set to true in the cleanup function and checked inside the isWindowReadyToFocus().then(...) callback before calling focusLastSelected(). That way if the screen unfocuses (or unmounts) while the window-ready promise is still pending on Android, the late resolution becomes a no-op instead of stealing keyboard focus on whatever screen is now active.

Also added a unit test covering the scenario (does not steal focus if the screen unfocuses before isWindowReadyToFocus resolves) — it mounts the form, fires transitionEnd, unmounts before resolving the promise, then resolves it and asserts focusLastSelected was never called.

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.

1 participant