Skip to content

Consolidate ConfirmModal instances into a global component#68190

Merged
roryabraham merged 21 commits intoExpensify:mainfrom
callstack-internal:ft/promise-modal
Sep 2, 2025
Merged

Consolidate ConfirmModal instances into a global component#68190
roryabraham merged 21 commits intoExpensify:mainfrom
callstack-internal:ft/promise-modal

Conversation

@zirgulis
Copy link
Contributor

@zirgulis zirgulis commented Aug 8, 2025

Explanation of Change

Currently the app suffers from component bloat in regards to ConfirmModal instances. Reduce the memory footprint and simplify working with modals by consolidating ConfirmModal instances into a single component instance.

Fixed Issues

$ #68799

Tests

  1. Export Flows
  • Export Progress Modal: When exporting reports with templates
  • Test Steps:
    a. Navigate to an expense report
    b. Click "Export" → Select any export template
    c. Verify: Export progress modal shows with "Export in progress" message
    d. Verify: Modal cannot be cancelled (no cancel button)
    e. Verify: Promise resolves correctly and clears selected transactions
  1. Report Management Actions

A. Unapprove Report

  • Test Steps:
    a. Go to an approved, exported report
    b. Click "More" → "Unapprove"
    c. Verify: Warning modal appears about integration export
    d. Click "Unapprove Report"
    e. Verify: Report gets unapproved successfully
    f. Test Cancel: Try again and click "Cancel" - verify nothing happens

B. Cancel Payment

  • Test Steps:
    a. Go to a report with pending payment
    b. Click "More" → "Cancel Payment"
    c. Verify: Confirmation modal appears
    d. Click "Cancel Payment"
    e. Verify: Payment is cancelled
    f. Test Cancel: Try again and click "Dismiss" - verify nothing happens

C. Delete Report/Expenses

  • Single Expense Delete:
    a. Go to report with single expense
    b. Click "More" → "Delete"
    c. Verify: Delete confirmation modal
    d. Click "Delete" → Verify: Expense deleted and navigation works
  • Multiple Expenses Delete:
    a. Go to report with multiple expenses
    b. Click "More" → "Delete"
    c. Verify: Different modal text for multiple expenses
    d. Click "Delete" → Verify: Entire report deleted

D. Reopen Exported Report

  • Test Steps:
    a. Go to closed, exported report
    b. Click "More" → "Reopen Report"
    c. Verify: Warning modal about reopening exported report
    d. Click "Reopen Report"
    e. Verify: Report reopens successfully
  1. Bulk Transaction Actions

Selected Transactions Delete

  • Test Steps:
    a. Go to expense report
    b. Select multiple transactions
    c. Click bulk actions → "Delete"
    d. Verify: Delete confirmation with count
    e. Verify: After deletion, navigation handles correctly

Export Again Modal

  • Test Steps:
    a. Try to re-export an already exported report
    b. Verify: "Export Again" modal appears
    c. Click "Export Again"
    d. Verify: Export proceeds

For each modal above, please test:

  1. Confirm Action: Click confirm → verify action completes
  2. Cancel Action: Click cancel → verify nothing happens
  3. Outside Click: Click outside modal → verify appropriate behavior
  4. Back Button (Android): Press back → verify modal closes appropriately

Offline tests

QA Steps

Same as in "Tests" section

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 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.2025-08-26.at.17.12.31.mov
Android: mWeb Chrome
Screen.Recording.2025-08-26.at.17.29.02.mov
iOS: Native
Screen.Recording.2025-08-26.at.16.47.39.mov
iOS: mWeb Safari
Screen.Recording.2025-08-26.at.17.31.37.mov
MacOS: Chrome / Safari
Screen.Recording.2025-08-26.at.16.51.13.mov
MacOS: Desktop
Screen.Recording.2025-08-26.at.17.50.23.mov

@github-actions
Copy link
Contributor

github-actions bot commented Aug 8, 2025

⚠️ 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. ⚠️

@zirgulis zirgulis force-pushed the ft/promise-modal branch 2 times, most recently from 07f62af to 04a86f1 Compare August 8, 2025 11:10
@zirgulis zirgulis force-pushed the ft/promise-modal branch 4 times, most recently from 1ef6a86 to c19f9e3 Compare August 21, 2025 12:36
@zirgulis zirgulis force-pushed the ft/promise-modal branch 4 times, most recently from ac7254e to 370a380 Compare August 26, 2025 12:54
@zirgulis zirgulis changed the title Add promise modal Consolidate ConfirmModal instances into a single, global component Aug 26, 2025
@zirgulis zirgulis changed the title Consolidate ConfirmModal instances into a single, global component Consolidate ConfirmModal instances into a global component Aug 26, 2025
@zirgulis zirgulis marked this pull request as ready for review August 26, 2025 15:29
@zirgulis zirgulis requested a review from a team as a code owner August 26, 2025 15:29
@melvin-bot melvin-bot bot requested review from alitoshmatov and removed request for a team August 26, 2025 15:29
@melvin-bot
Copy link

melvin-bot bot commented Aug 26, 2025

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

Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

Thanks in advance for your patience as we work through this review - while I'm sure this works well as written, I want to establish really clear and solid patterns for global shared modals. So I might just want to collaboratively iterate on this a bit, and I'm sure the end result is going to be great.

First piece of feedback is that I don't think PromiseModal is a great name, mostly because it over-emphasizes an implementation detail.

I don't love dumping AI-generated review notes, but after chatting in cursor a bit, I actually really liked its suggestion for directory structure and naming conventions:


Based on my examination of the current modal structure, I can see there are three main types of modals:

  1. Standard/Legacy Modal - Traditional modals where each component manages its own modal state
  2. ReanimatedModal - Specialized animated modals using React Native Reanimated
  3. PromiseModal - The new global/shared modal system using React Context and promises

Here's my proposed directory structure and naming convention:

Proposed Directory Structure

src/components/Modal/
├── Core/                          # Core modal components and types
│   ├── BaseModal.tsx
│   ├── ModalContent.tsx
│   ├── types.ts
│   ├── index.tsx
│   ├── index.ios.tsx
│   └── index.android.tsx
│
├── Animated/                      # Reanimated-based modals
│   ├── index.tsx
│   ├── types.ts
│   ├── utils.ts
│   ├── Container/
│   │   ├── index.tsx
│   │   ├── index.web.tsx
│   │   └── GestureHandler.tsx
│   └── Backdrop/
│       ├── index.tsx
│       └── index.web.tsx
│
├── Global/                        # Global/shared modal system
│   ├── ModalProvider.tsx          # Previously ModalContext.tsx
│   ├── useModal.tsx               # Basic modal hook
│   ├── useConfirmModal.tsx        # Previously useModalHook.tsx
│   ├── ConfirmModalWrapper.tsx    # Wrapper for confirm dialogs
│   ├── types.ts                   # Modal-specific types
│   └── index.ts                   # Exports
│
└── index.ts                       # Main modal exports

Naming Convention Changes

Core Components

  • Modal → Keep as main export (from Core/)
  • ReanimatedModalAnimatedModal (from Animated/)
  • PromiseModalProviderModalProvider (from Global/)

Hooks

  • useModal → Keep as the main global modal hook
  • useConfirmModal → Keep as the convenience hook for confirmations
  • usePromiseModal → Remove this alias, just use useModal

Types

  • PromiseResolvePayloadModalResolvePayload or ModalResult
  • ModalAction → Keep as-is
  • ModalInfo → Keep as-is but move to Global/types.ts

Benefits of This Structure

  1. Clear Separation of Concerns: Each directory has a specific purpose
  2. Intuitive Naming: Names describe what the component does, not how it's implemented
  3. Better Discoverability: Developers can easily find the right modal type for their use case
  4. Consistent with React Patterns: Global state management is clearly identified
  5. Future-Proof: Easy to add new modal types or deprecate old ones

Import Examples

// Legacy/one-off modals
import Modal from '@components/Modal';

// Animated modals  
import AnimatedModal from '@components/Modal/Animated';

// Global modal system
import {ModalProvider, useModal, useConfirmModal} from '@components/Modal/Global';

// Or if you prefer the shorter version:
import {ModalProvider, useModal, useConfirmModal} from '@components/Modal';

The Global/ directory name clearly indicates this is the shared modal system, while Core/ contains the foundational modal components that the other systems might build upon.

shouldReverseStackedButtons = false,
isConfirmLoading = false,
}: ConfirmModalWrapperProps) {
const handleConfirm = () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Would suggest memoizing these with useCallback but I have no basis to know whether React Compiler will do it automatically

@alitoshmatov
Copy link
Contributor

Working on it

@alitoshmatov
Copy link
Contributor

Almost done with the review, @zirgulis can you resolve the conflicts, thanks

@alitoshmatov
Copy link
Contributor

alitoshmatov commented Sep 2, 2025

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
confirm-android.mov
Android: mWeb Chrome
confirm-mweb.mov
iOS: HybridApp
confirm-ios.mp4
iOS: mWeb Safari
confirm-safari.mp4
MacOS: Chrome / Safari
confirm-web.mov
MacOS: Desktop
confirm-desktop.mov

@zirgulis
Copy link
Contributor Author

zirgulis commented Sep 2, 2025

@alitoshmatov merge conflicts are fixed, please review the changes

Copy link
Contributor

@alitoshmatov alitoshmatov left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from roryabraham September 2, 2025 17:43
@roryabraham roryabraham merged commit 0660ce5 into Expensify:main Sep 2, 2025
21 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Sep 2, 2025

✋ 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

OSBotify commented Sep 2, 2025

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.2.1-0 🚀

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

@jponikarchuk
Copy link

@zirgulis @trjExpensify "Export again" modal can be triggered by exporting again with the accounting software only, but not whithout accounting connected. Could you provide more detailed steps for the Export Again Modal.

bandicam.2025-09-04.10-07-32-428.mp4
bandicam.2025-09-04.10-19-27-011.mp4

@zirgulis
Copy link
Contributor Author

zirgulis commented Sep 4, 2025

@jponikarchuk From the code I see that export again modal will be only shown when connectedIntegration is present:

Pasted Graphic

So I think your reported behavior is expected, correct me if I'm wrong @trjExpensify

@trjExpensify
Copy link
Contributor

I think what @jponikarchuk is saying is that these tests are a bit confusing because they don't specify that it's a modal triggered after re-exporting a report to an accounting solution. 👍

Export Again Modal

Test Steps:
a. Try to re-export an already exported report
b. Verify: "Export Again" modal appears
c. Click "Export Again"
d. Verify: Export proceeds

@OSBotify
Copy link
Contributor

OSBotify commented Sep 5, 2025

🚀 Deployed to production by https://github.com/arosiclair in version: 9.2.1-20 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Sep 5, 2025

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.2.2-0 🚀

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

zirgulis added a commit to callstack-internal/Expensify-App that referenced this pull request Sep 8, 2025
zirgulis added a commit to callstack-internal/Expensify-App that referenced this pull request Sep 8, 2025
@OSBotify
Copy link
Contributor

OSBotify commented Sep 9, 2025

🚀 Deployed to production by https://github.com/francoisl in version: 9.2.2-8 🚀

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

zirgulis added a commit to callstack-internal/Expensify-App that referenced this pull request Sep 9, 2025
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.2.15-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 9.2.15-15 🚀

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

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