Skip to content

[CP Staging] Fix Onfido crash from stale cached wallet data on EnablePaymentsPage#88328

Merged
inimaga merged 2 commits intomainfrom
claude-fixOnfidoCrashStaleWalletData
Apr 20, 2026
Merged

[CP Staging] Fix Onfido crash from stale cached wallet data on EnablePaymentsPage#88328
inimaga merged 2 commits intomainfrom
claude-fixOnfidoCrashStaleWalletData

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

@MelvinBot MelvinBot commented Apr 20, 2026

Explanation of Change

PR #87254 removed initWithStoredValues: false from the useOnyx(ONYXKEYS.USER_WALLET) call in EnablePaymentsPage, which means useOnyx now immediately returns cached/persisted wallet data on mount — including a stale currentStep: ONFIDO from a previous session. This causes OnfidoStep to render before fresh API data arrives, initializing the Onfido SDK with an expired token and crashing iOS.

This PR adds a hasFreshData state gate to the loading condition so that step content only renders after the openEnablePaymentsPage() loading cycle (isLoading: true → false) completes. When offline, we fall back to cached data since no API call will happen.

Fixed Issues

$ #88173
PROPOSAL: #88173 (comment)

Tests

// TODO: The human co-author must fill out the tests you ran before marking this PR as "ready for review"
// Please describe what tests you performed that validates your changed worked.

  • Verify that no errors appear in the JS console

Offline tests

// TODO: The human co-author must fill out the offline tests before marking this PR as "ready for review"

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
  • 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

When EnablePaymentsPage mounts after removing initWithStoredValues: false
(PR #87254), useOnyx immediately returns cached wallet data with a stale
currentStep (e.g. ONFIDO). This renders OnfidoStep before fresh API data
arrives, causing a crash on iOS when the Onfido SDK initializes with an
expired token.

Add a hasFreshData gate so step content only renders after the
openEnablePaymentsPage() loading cycle completes (isLoading: true → false).
When offline, fall back to cached data since no API call will happen.

Co-authored-by: Vit Horacek <mountiny@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

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

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 20, 2026

Codecov Report

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

Files with missing lines Coverage Δ
src/pages/EnablePayments/EnablePaymentsPage.tsx 0.00% <0.00%> (ø)
src/pages/EnablePayments/EnablePayments.tsx 0.00% <0.00%> (ø)
... and 25 files with indirect coverage changes

@github-actions

This comment has been minimized.

@Krishna2323
Copy link
Copy Markdown
Contributor

@MelvinBot I think we need to apply the same hasFreshData gate to EnablePayments.tsx too. Check and update if required.

@MelvinBot
Copy link
Copy Markdown
Contributor Author

👋 Good catch, Krishna2323. EnablePayments.tsx has the same stale-data vulnerability — it reads userWallet?.currentStep (line 68) and can render VerifyIdentity (Onfido) at line 80 before fresh API data arrives, exactly like the bug this PR fixes in EnablePaymentsPage.tsx.

Specifically, EnablePayments.tsx line 42 only gates on isUserWalletEmpty || userWallet?.isLoading — it's missing the hasFreshData check that this PR adds to the other file.

The same pattern (adding hasFreshData state + the wasLoadingRef tracking effect + updating the loading condition to !hasFreshData && !isOffline) should be applied to EnablePayments.tsx as well.

I can only make code changes when directed by the PR author, an assignee, or an existing co-author. To have me implement this, the PR assignee or author should reply with a request tagging me.

@Krishna2323
Copy link
Copy Markdown
Contributor

@MelvinBot implement the fix in EnablePayments.tsx

Apply the same stale-data protection to EnablePayments.tsx that was
already added to EnablePaymentsPage.tsx — prevents rendering step
content (including VerifyIdentity/Onfido) before fresh API data arrives.

Co-authored-by: Krishna <Krishna2323@users.noreply.github.com>
@MelvinBot
Copy link
Copy Markdown
Contributor Author

Applied the same hasFreshData gate to EnablePayments.tsx. The change adds the wasLoadingRef + hasFreshData state pattern and updates the loading condition to !hasFreshData && !isOffline, matching what's already in EnablePaymentsPage.tsx.

Note: I omitted the isPendingOnfidoResult/hasFailedOnfido redirect logic since EnablePayments.tsx doesn't have that navigation behavior.

@Krishna2323
Copy link
Copy Markdown
Contributor

@MelvinBot fill the checklist, add tests and mark this ready for review

@MelvinBot
Copy link
Copy Markdown
Contributor Author

👋 Krishna2323 — I'm unable to fill the checklist, add tests, or mark this PR ready for review on your behalf.

Checklist & Tests: The PR Author Checklist and Tests/QA sections are intended to be filled out by the human co-author (mountiny) who can actually verify the changes across platforms.

Ready for review: Only the PR assignee (mountiny) should mark this ready for review once they've completed testing and filled out the checklist.

I can only make code changes when directed by the PR author, an assignee, or an existing co-author. To have me implement this, the PR assignee or author should reply with a request tagging me.

@mountiny mountiny marked this pull request as ready for review April 20, 2026 16:03
@mountiny mountiny requested a review from a team as a code owner April 20, 2026 16:03
@melvin-bot melvin-bot Bot requested review from mountiny and removed request for a team April 20, 2026 16:03
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 20, 2026

@mountiny 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 requested review from heyjennahay and removed request for a team April 20, 2026 16:03
openEnablePaymentsPage();
}, [isOffline]);

// Only render step content after the fresh data loading cycle (isLoading: true → false) completes,
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 wasLoadingRef + hasFreshData + useEffect loading-cycle gate pattern is duplicated verbatim between EnablePayments.tsx and EnablePaymentsPage.tsx. Both files implement the same state machine (track isLoading going from true to false, then set hasFreshData), and the same gating condition (!hasFreshData && !isOffline). This increases maintenance risk -- a bug fix in one file could easily be missed in the other.

Extract a shared custom hook, e.g.:

function useHasFreshWalletData(isOffline: boolean, isLoading: boolean | undefined): boolean {
    const wasLoadingRef = useRef(false);
    const [hasFreshData, setHasFreshData] = useState(false);

    useEffect(() => {
        if (isOffline) return;
        if (isLoading) {
            wasLoadingRef.current = true;
            return;
        }
        if (!wasLoadingRef.current) return;
        setHasFreshData(true);
    }, [isOffline, isLoading]);

    return hasFreshData;
}

Then use const hasFreshData = useHasFreshWalletData(isOffline, userWallet?.isLoading); in both components.


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

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.

Lets leave this for now. We can handle this in Part 3. #86660

cc: @JKobrynski

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.

@fabioh8010 👀 please

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 will handle in part 3 👍🏻

@Krishna2323
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: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
Monosnap.screencast.2026-04-20.19-20-47.mp4

Copy link
Copy Markdown
Contributor

@Krishna2323 Krishna2323 left a comment

Choose a reason for hiding this comment

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

LGTM!

@inimaga inimaga merged commit 0f44d00 into main Apr 20, 2026
44 of 47 checks passed
@inimaga inimaga deleted the claude-fixOnfidoCrashStaleWalletData branch April 20, 2026 16:46
@inimaga inimaga changed the title Fix Onfido crash from stale cached wallet data on EnablePaymentsPage [CP Staging] Fix Onfido crash from stale cached wallet data on EnablePaymentsPage Apr 20, 2026
OSBotify pushed a commit that referenced this pull request Apr 20, 2026
…lletData

Fix Onfido crash from stale cached wallet data on EnablePaymentsPage

(cherry picked from commit 0f44d00)

(cherry-picked to staging by AndrewGable)
@OSBotify OSBotify added the CP Staging marks PRs that have been CP'd to staging label Apr 20, 2026
@github-actions
Copy link
Copy Markdown
Contributor

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

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

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 9.3.60-19 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor Author

No help site changes are required for this PR.

This is a purely technical bug fix that adds a loading gate to prevent the Onfido SDK from initializing with stale cached wallet data. There are no changes to user-facing workflows, UI labels, steps, or features.

The relevant help site article (Set up your wallet) accurately describes the current wallet setup flow, and nothing in this PR alters that flow from the user's perspective.

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.3.60-22 🚀

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

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 9.3.61-0 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor Author

I reviewed the changes in this PR against the help site articles under App/docs/articles.

No help site changes are required.

This PR is a purely internal bug fix — it adds a loading state gate (hasFreshData) to prevent stale cached wallet data from rendering the Onfido step with an expired token. There are no changes to:

  • UI text, labels, or button names
  • User-facing flows or steps
  • New features or removed functionality

The existing help article at docs/articles/new-expensify/wallet-and-payments/Set-up-your-wallet.md remains accurate.

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

Labels

CP Staging marks PRs that have been CP'd to staging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants