Skip to content

Fix magic code navigates back on payment (SettlementButton) v2 - #96622

Merged
mountiny merged 1 commit into
Expensify:mainfrom
software-mansion-labs:fix/magic-code-navigates-back-payment-v2
Jul 22, 2026
Merged

mountiny merged 1 commit into
Expensify:mainfrom
software-mansion-labs:fix/magic-code-navigates-back-payment-v2

Conversation

@jmusial

@jmusial jmusial commented Jul 21, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

When an unvalidated user triggers a payment, the new useVerifyAccountAndResume hook stores the pending payment action, sends the user to the dynamic verify-account (magic code) page, and resumes the stored action once validation succeeds — while dropping it if the user leaves the page without validating.

Fixed Issues

$ #72980
PROPOSAL:

Tests

Pre requisite:

  1. Log in with a new account and don't verify it with a magic code

Then:

a) ROUTES.SEARCH_ROOT

  1. Create a workspace as admin (via green "+" button)
  2. Navigate to the Inbox tab and create an expense
  3. Submit and Approve the expense
  4. Navigate to the Spend tab > Ready to pay
  5. Click on the Pay Button > Pay with business account
  6. Verify that the magic code verification modal slides out.
  7. Provide Magic Code
  8. Verify that account setup modal slides out.

b) ROUTES.SEARCH_MONEY_REQUEST_REPORT

  1. Create a workspace as admin (via green "+" button)
  2. Navigate to the Inbox tab and create an expense
  3. Submit and Approve the expense
  4. Navigate to the Spend tab > Expenses
  5. Click on the Expense
  6. Click on the Pay Button > Pay with business account
  7. Verify that the magic code verification modal slides out.
  8. Provide Magic Code
  9. Verify that account setup modal slides out.

c) ROUTES.REPORT_WITH_ID with the reportID

  1. Create a workspace as admin (via green "+" button)
  2. Navigate to the Inbox tab and create an expense
  3. Submit and Approve the expense
  4. Click on the Report
  5. Click on the Pay Button > Pay with business account
  6. Verify that the magic code verification modal slides out.
  7. Provide Magic Code
  8. Verify that account setup modal slides out.

d) #96091 regression test

  1. Open app
  2. Go to workspace chat.
  3. Create a report.
  4. Open the report.
  5. Click on the report header.
  6. Click on the blue link under "From".
  7. Click on the report.
  8. Verify that no overlay (covering the whole screen) will appear when report RHP is opened.

Offline tests

QA Steps

Same as tests

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
    • 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
Screen.Recording.2026-06-15.at.11.41.51.mov
Android: mWeb Chrome
Screen.Recording.2026-06-15.at.11.45.47.mov
iOS: Native
Screen.Recording.2026-06-15.at.11.33.22.mov
iOS: mWeb Safari
Screen.Recording.2026-06-15.at.11.25.20.mov
MacOS: Chrome / Safari
Screen.Recording.2026-06-11.at.09.55.21.mov
Screen.Recording.2026-07-21.at.13.04.52.mov

@jmusial

jmusial commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

@codex review

@codecov

codecov Bot commented Jul 21, 2026 •

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
src/hooks/useVerifyAccountAndResume.ts 95.23% <95.23%> (ø)
...s/WideRHPContextProvider/useShouldRenderOverlay.ts 0.00% <0.00%> (ø)
src/components/SettlementButton/index.tsx 85.18% <48.57%> (+2.98%) ⬆️
... and 26 files with indirect coverage changes

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

Copy link
Copy Markdown

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: 210cc0e205

ℹ️ 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 thread src/hooks/useVerifyAccountAndResume.ts Resolved
@jmusial
jmusial marked this pull request as ready for review July 21, 2026 11:14
@jmusial
jmusial requested review from a team as code owners July 21, 2026 11:14
@melvin-bot
melvin-bot Bot requested review from aimane-chnaif and joekaufmanexpensify and removed request for a team July 21, 2026 11:15
@melvin-bot

melvin-bot Bot commented Jul 21, 2026

Copy link
Copy Markdown

@aimane-chnaif 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]

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

Good for product 👍

@aimane-chnaif

aimane-chnaif commented Jul 22, 2026 •

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
  • 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 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)
  • 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)
  • 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.
  • 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.mov
Android: mWeb Chrome
iOS: HybridApp
ios1.mov
ios2.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
web1.mov
web2.mov
web3.mov

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🚀

Reviewed commit: 210cc0e205

ℹ️ 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".

@MelvinBot

Copy link
Copy Markdown
Contributor

Review

Overall this looks solid and well-designed. The extraction of the verify-then-resume logic into useVerifyAccountAndResume cleanly fixes the reported "navigates back instead of forward" bug, the checkForNecessaryAction refactor preserves the original guard ordering, and the unit tests cover the meaningful paths (resume-same-route, resume-after-self-close, and abandon). Typecheck, ESLint, React Compiler, tests, and codecov all pass.

I verified the one subtle correctness concern and it holds up — see below. A few minor suggestions, none blocking.

Correctness check: success vs. abandon race (verified OK)

The abandon detection in useVerifyAccountAndResume.ts:28-33 drops the pending action when a state change moves off the verify route while isUserValidated is still false. The risk would be the verify page navigating away before validated=true propagates here, causing the listener to mistake a successful validation for an abandon and silently drop the payment.

This is safe because VerifyAccountPageBase only navigates away inside an effect gated on isUserValidated (VerifyAccountPageBase.tsx:70-82) — so by the time the state event fires, validated=true is already committed, and the useEffectEvent-backed listener reads the fresh true and early-returns. The useEffectEvent here is load-bearing, and the inline comment explaining that is appreciated.

Minor suggestions (non-blocking)

  1. Stale triggerKYCFlow in the resumed closure. In handlePaymentSelection the resumed action captures the press-time triggerKYCFlow (a KYCWall render-prop callback) and event. This works as long as KYCWall stays mounted while the verify-account RHP is open — which it should — but it's worth a quick manual confirm that the "Pay with business account" → add-bank KYC path still triggers correctly after validation, since that's the one closure whose callback originates outside this component.

  2. No unit test for the overlay fix. The useShouldRenderOverlay change (guarding the async hide callback with conditionRef) is only covered by manual regression step (d). The fix itself is correct — an interrupted fade-out's callback now checks the latest condition before hiding — but a small hook test toggling condition true→false→true within the animation window would lock in the regression guard.

  3. Comment nits. The comment at index.tsx:202-203 ("The guards checked after…") and the resume comment ("…apply them to the resumed.") read as truncated — consider "apply them to the resumed action" for clarity.

One thing to double-check by design intent: on resume, checkForNecessaryAction's earlier guards (isDelegateAccessRestricted, isAccountLocked) are intentionally not re-run — only checkForPostValidationBlockers. That's reasonable since those states don't change from validating, just flagging it's a deliberate narrowing vs. the pre-refactor single pass.

Nice work — approach and test coverage are good.

@melvin-bot
melvin-bot Bot requested a review from mountiny July 22, 2026 15:34

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

Thank you

@mountiny
mountiny merged commit 21ceaf9 into Expensify:main Jul 22, 2026
42 of 45 checks passed
@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

Copy link
Copy Markdown
Contributor

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

@OSBotify OSBotify mentioned this pull request Jul 22, 2026
52 tasks done
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.4.43-0 🚀

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

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 I reviewed the changes in this PR against the help site content under docs/articles, and no help site changes are required.

Why: This PR is an internal bug fix / refactor. It introduces the useVerifyAccountAndResume hook and rewires SettlementButton so that when an unvalidated user starts a payment, the pending action is stored, the user is sent to the magic-code verify-account screen, and the payment resumes after they validate (or is dropped if they leave without validating). It also fixes an overlay rendering edge case in useShouldRenderOverlay.

The user-facing product behavior it documents is unchanged — an unvalidated user still has to verify their account before paying. The fix only restores the correct navigation/resume behavior after verification (the regression from #72980). None of that is behavior the help articles describe at a level that would need updating; the payment/verification articles remain accurate as written.

Since no changes are required, I did not create a draft help site PR.

@jmusial, if you believe a specific article should be updated to reflect this flow, let me know which one and I'll draft the change.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.4.43-1 🚀

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.

6 participants