Skip to content

refactor: Decompose Modal - #92881

Draft
TaduJR wants to merge 1 commit into
Expensify:mainfrom
TaduJR:refactor-decompose-modal
Draft

refactor: Decompose Modal#92881
TaduJR wants to merge 1 commit into
Expensify:mainfrom
TaduJR:refactor-decompose-modal

Conversation

@TaduJR

@TaduJR TaduJR commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

This PR introduces a v2 Modal/Popover/PopoverMenu/Dialog system as Radix-inspired compound primitives, replacing the v1 boolean-prop and lifecycle-leak debt at the foundation layer. v1 paths are untouched — v2 ships at sibling paths; existing callers keep importing v1.

What ships

  • Overlay/ — shared foundation: Presence, DismissableLayer, Portal, AnimatedSurface, observable stores, platform-split side-effect hooks
  • Modal/v2/ — compound primitive + 6 variants (BottomDockedModal, CenteredModal, CenteredSmallModal, ConfirmDialog, FullscreenModal, RightDockedModal) + slot-based confirm/ / decision/ sub-compounds
  • Popover/v2/ — anchored floating-panel compound with useAnchoredOpener shared trigger flow
  • PopoverMenu/v2/ — re-platformed onto the new foundation
  • Dialog/ — v2 replacement for Modal/Global: DialogProvider queue + 4 presenters (Confirm, Decision, HoldMenu, HRSyncResults)
  • v2 show-hooksuseConfirmDialog, useDecisionDialog, useHoldMenuDialog, useHRSyncResultsDialog mirror v1 hook shapes for one-line caller migration

Sample consumer migrations (one per surface)

  • ComparePlansModalCenteredModal / CenteredSmallModal
  • AccountSwitcher (offline + GPS confirms) → useConfirmDialog + DialogProvider mounted app-wide
  • MoneyReportHeaderModalsuseDecisionDialog + useHoldMenuDialog
  • WorkspaceHRPage + WorkspaceMembersPageuseHRSyncResultsDialog

Fixed Issues

$ #91238
PROPOSAL:

Tests

1. Compare Plans Modal — Settings → Subscription

  1. Go to Settings → Subscription → Your Plan, tap "Explore all plans".
    • Wide: small centered dialog with two side-by-side plan cards, X in top-right header.
    • Narrow: full-width modal, cards stacked, back (←) in top-left.
  2. Close via X / back → modal slides out to the right.
  3. Reopen → tap backdrop → modal closes.
  4. Reopen → press Escape (desktop) → modal closes.
  5. Reopen → tap Upgrade / Downgrade on a non-current-plan card → modal fades out (not slides) and the app navigates to the upgrade/downgrade screen.
  6. Current plan card is visually marked (highlighted border + "This is your current plan" label, no action button).
  7. Bottom safe-area is respected (content doesn't sit under the home indicator).

2. AccountSwitcher confirms

Setup: Account with a delegate relationship (you delegate to someone, or someone delegates to you).

2.1 — Offline confirm

  1. Click your avatar at the top of the LHN → AccountSwitcher popover opens.
  2. Disable network. Reopen the switcher, tap a different account.
  3. Centered dialog appears: title "You appear to be offline", single Confirm button (no Cancel).
  4. Confirm / Escape / backdrop tap each close the dialog. No account switch happens.

2.2 — GPS trip-in-progress confirm

Repro: start a GPS-tracked distance request, then attempt to switch accounts before stopping it.

  1. With a GPS trip active AND online, open the switcher and tap a different account.
  2. Centered dialog appears with two buttons: Confirm + Cancel.
  3. Cancel / Escape / backdrop → dialog closes, GPS trip continues, no account switch.
  4. Reopen → Confirm → GPS trip stops, account switches.

3. Money report Hold Menu + Decision dialogs

3.1 — Hold Menu (partial / full)

Repro: open a money report you can pay/approve that has at least one held expense.

  1. Tap Pay in the report header.
    • If some expenses are held and some are not → dialog shows two stacked buttons: "Pay only $X" (non-held amount) and "Pay $Y" (full).
    • If all expenses are held → dialog shows one button: "Pay $Y" + a prompt mentioning transaction count.
  2. Tap each option → payment fires for the correct amount; dialog closes; success animation plays.
  3. Escape / backdrop tap → dialog closes, no payment.
  4. Repeat the flow with the Approve button → same dialog, title becomes "Confirm approve", button labels become "Approve only $X" / "Approve $Y".
  5. Repeat via the bulk-select dropdown on a report list view → same dialog.
  6. iOS only: no visible delay or touch glitch between tapping Pay and the dialog appearing.

3.2 — Export Decision dialogs (offline / failed download)

  1. From a money report header, open Export.
  2. Offline path: kill network → tap an export template → dialog: "You appear to be offline" + single Confirm button.
  3. Failure path: trigger an export that fails server-side → dialog: "Download failed" + single Confirm button.
  4. Confirm / Escape / backdrop close the dialog. No export retries.

4. HR Sync Results dialog

Setup: Corporate workspace with Gusto or TriNet connected, you're a workspace admin.

  1. Go to Settings → Workspaces → [workspace] → HR.
  2. Trigger an HR sync via the provider card and stay on the page.
  3. When sync hits JOB_DONE, a right-docked modal slides in:
    • Title "Sync results", back (←) button, provider name
    • Added count, Removed count
    • Skipped employees expandable section (chevron expands the list with reasons)
  4. Back → modal slides out to the right, focus returns to the HR page.
  5. Repeat step 1–4 from Settings → Workspaces → [workspace] → Members (sync can be triggered from there too) → same modal opens.
  6. Navigate away from the HR/Members page before sync completes → no modal opens (gated on isFocused).
  7. After closing the result modal, return to the page → modal does NOT reopen for the same completed sync.
  • Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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

@TaduJR
TaduJR requested review from a team as code owners June 7, 2026 23:15
@melvin-bot
melvin-bot Bot requested review from flaviadefaria and linhvovan29546 and removed request for a team June 7, 2026 23:15
@melvin-bot

melvin-bot Bot commented Jun 7, 2026

Copy link
Copy Markdown

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

@TaduJR
TaduJR marked this pull request as draft June 7, 2026 23:15
@codecov

codecov Bot commented Jun 7, 2026

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
src/App.tsx 100.00% <ø> (ø)
src/CONST/index.ts 93.84% <ø> (ø)
src/components/Dialog/actions.ts 100.00% <100.00%> (ø)
src/components/Dialog/constants.ts 100.00% <100.00%> (ø)
src/components/Dialog/createDialogCallable.tsx 100.00% <100.00%> (ø)
src/components/MenuItem.tsx 88.10% <100.00%> (ø)
src/components/Modal/v2/compound/Close.tsx 100.00% <100.00%> (ø)
src/components/Modal/v2/compound/Content.tsx 100.00% <100.00%> (ø)
src/components/Modal/v2/compound/Heading.tsx 100.00% <100.00%> (ø)
src/components/Modal/v2/compound/Layout.tsx 100.00% <100.00%> (ø)
... and 139 more
... and 14 files with indirect coverage changes

chatgpt-codex-connector[bot]

This comment was marked as resolved.

Comment thread src/components/Overlay/hooks/useAnchoredPosition/shared.ts Outdated
@TaduJR

TaduJR commented Jun 8, 2026

Copy link
Copy Markdown
Contributor Author

@roryabraham

Sorry for the delay. This one was tough and need some time.
Also I had a divided and more than 80 commits but accidentally lost it in merge resolution, and was forced to reset. I hope it doesn't affect review process, but let me know if it is must I will re-commit functionally separately.

@TaduJR

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

@TaduJR

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

@TaduJR

This comment was marked as resolved.

@chatgpt-codex-connector

This comment was marked as outdated.

@TaduJR

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

@TaduJR

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

@TaduJR

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

@TaduJR

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

@TaduJR

TaduJR commented Jun 8, 2026

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

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

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

@roryabraham

Copy link
Copy Markdown
Contributor

@TaduJR is there any way we can split this up into multiple smaller PRs? For just a few examples:

  • Extract the useIsPopoverVisible => useIsVisible rename (or just remove this, if it's non-critical)
  • Defer the Popover/v2 implementation until after Modal/v2 is done
  • Defer the Dialog implementation until after Modal/v2 is done

@TaduJR

TaduJR commented Jun 8, 2026

Copy link
Copy Markdown
Contributor Author

@TaduJR is there any way we can split this up into multiple smaller PRs? For just a few examples:

Yes it's possible @roryabraham.

Extract the useIsPopoverVisible => useIsVisible rename (or just remove this, if it's non-critical)

This is a cosmetic one but I really recommend it.

We can split it in to 4 PR's

PR 1 - Overlay/ foundation + PopoverMenu/v2 re-platforming onto it + the two Overlay-layer pointer-events / flex:1 fixes.
PR 2 - Modal/v2/ + 6 variants + ComparePlansModal as the sample consumer. Depends on PR 1.
PR 3 - Popover/v2/. Depends on PR 1
PR 4 - Dialog/ + the 4 dialog hooks + DialogProvider mount + the 3 dialog consumer migrations (Depends on PR 2.

Sound good?

@roryabraham

Copy link
Copy Markdown
Contributor

This is a cosmetic one but I really recommend it.

Let's put it in its own PR then to keep this PR as small as can be. Seems trivial to land separately.


Otherwise, the split you propose sounds good.

@TaduJR
TaduJR force-pushed the refactor-decompose-modal branch from b7a4ccb to 047d65a Compare June 21, 2026 11:44
@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. ⚠️

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.

2 participants