Skip to content

[Payment due @DylanDylann] [Odometer] Show discard changes modal when switching tabs - #94899

Merged
Julesssss merged 61 commits into
mainfrom
jules-cloneOdometerShowDiscardModal
Jun 29, 2026
Merged

[Payment due @DylanDylann] [Odometer] Show discard changes modal when switching tabs#94899
Julesssss merged 61 commits into
mainfrom
jules-cloneOdometerShowDiscardModal

Conversation

@Julesssss

@Julesssss Julesssss commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

CLONE OF THIS PR, CONTRIBUTOR LEFT SWM Tested by me and C+.


Explanation of Change

This PR adds a feature we agreed on in this discussion to show a Discard Changes confirmation modal when the user tries to switch away from the Odometer tab to another tab with unsaved changes.

image

The tab-switch guard is generic, not odometer-specific. A new TabSwitchGuardContext lets any tab screen register getHasUnsavedChanges / onDiscard / onCancel callbacks keyed by tab name, and OnyxTabNavigator intercepts tabPress to show the shared "Discard changes?" modal - on confirm it runs onDiscard and then jumps to the target tab (it always jumps, even if onDiscard fails, surfacing a Growl error rather than stranding the user). It's wired through the existing useDiscardChangesConfirmation hook via a new onTabSwitchDiscard option that self-disables outside a tab navigator, and both the nav-away and tab-switch paths render an identical modal from getDiscardChangesModalConfig. On the Odometer tab, confirming clears the readings/images (or restores the confirmation-edit backup when editing) before the tab switch.

The discard diff is hardened against false positives: image changes use a re-mint-invariant identity (getOdometerImageIdentity, name|size|lastModified) that survives the draft round-trip but still detects a real swap, and the resync / unsaved-changes branching is extracted into unit-tested pure predicates (odometerResync.ts, getOdometerHasUnsavedChanges) that won't re-hydrate readings the user intentionally cleared.

Fixed Issues

$ #89940
PROPOSAL: N/A

Tests

  1. Start a new expense and open the Distance request flow, then switch to the Odometer tab.
  2. Enter a start reading and/or end reading, and/or attach a start/end odometer image. Do not save.
  3. Tap a different tab (Map, Manual, or GPS) and verify that a "Discard changes?" confirmation modal appears.
  4. Tap Cancel and verify that you stay on the Odometer tab with your unsaved readings/images intact.
  5. Tap a different tab again, then tap the danger/confirm button in the modal.
  6. Verify that the modal closes, the Odometer tab is reset (readings cleared, images removed), and the app navigates to the tab you originally tapped.
  7. Back on the Odometer tab with empty readings/images, switch tabs and verify that no modal is shown and the tab switch happens immediately.
  8. Type a reading, then delete it so the field is empty. Verify the field stays empty (it does not snap back to the value you just cleared) and that switching tabs now shows no modal.
  9. Regression check the shared navigator: open another OnyxTabNavigator-based flow that does not register a guard (e.g. the Map/Manual distance tabs with no unsaved odometer changes) and verify tab switches happen immediately with no modal.

Nav-away discard still works

  1. With unsaved odometer changes, use the in-app back button or press outside the RHP to leave the flow.
  2. Verify the existing "Discard changes?" modal still appears (this PR does not change nav-away behavior).

Save-for-later draft

  1. With odometer readings/images entered, tap Save for later, then reopen the flow.
  2. Switch tabs without making further edits and verify that NO modal appears (the hydrated draft equals the transaction, so it is not treated as an unsaved change).
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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
untitled.webm
Android: mWeb Chrome
untitled2.webm
iOS: Native
Simulator.Screen.Recording.-.iPhone.16.Pro.Max.-.2026-06-16.at.23.05.25.mov
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.16.Pro.Max.-.2026-06-16.at.23.22.23.mov
MacOS: Chrome / Safari
Screen.Recording.2026-06-16.at.20.56.57.mov

Replace per-tab browser history for the distance-create tabs (UNSTABLE_router,
web-only, allowlist-scoped) so browser-back closes the RHP instead of cycling
tabs, and the existing discard guard fires. Gate the odometer step's discard hook
to standalone screens to avoid a double modal.
…eterImageUri for image-change detection

Ports two refinements from the earlier RHP-close work that were not carried
into the browser-back rewrite: pass restoreLastInputFocus as the tab guard's
onCancel so canceling the discard modal during a tab switch re-focuses the
input, and compare odometer images via getOdometerImageUri in getHasUnsavedChanges.
- centralize RN tab-switch action types (JUMP_TO/NAVIGATE_DEPRECATED) in
  CONST.NAVIGATION.ACTION_TYPE and add a test guarding the JUMP_TO coupling
- reuse goForwardInBrowserHistory util in useDiscardChangesConfirmation
  instead of inline window.history.go(1)
- document DistanceTabGuardContext as a single-active-guard registry
Move the inline branching of IOURequestStepDistanceOdometer's "resync from
transaction" effect into pure isExternalOdometerResync /
shouldInitializeOdometerFromTransaction helpers and cover them with unit
tests. The effect's side-effects and dependency array are unchanged - this
is behavior-preserving, just making the subtle logic named and testable.
…itch

Removes the browser-Back-button discard mechanism introduced in 4ab9a73:
the tab-history replacement router, goForwardInBrowserHistory helper, and the
page-level useActiveTabGuardDiscardConfirmation hook. Restores the per-step
useDiscardChangesConfirmation (header/hardware back) and keeps the core
tab-switch discard modal and the resync guard untouched.
@Julesssss
Julesssss removed the request for review from flaviadefaria June 29, 2026 20:08
@Expensify Expensify deleted a comment from github-actions Bot Jun 29, 2026
@Expensify Expensify deleted a comment from github-actions Bot Jun 29, 2026
@Julesssss
Julesssss force-pushed the jules-cloneOdometerShowDiscardModal branch 2 times, most recently from 41b9d7e to d1934f0 Compare June 29, 2026 20:52
@codecov

codecov Bot commented Jun 29, 2026

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
...hangesConfirmation/getDiscardChangesModalConfig.ts 100.00% <100.00%> (ø)
...ooks/useDiscardChangesConfirmation/index.native.ts 100.00% <100.00%> (ø)
src/hooks/useDiscardChangesConfirmation/index.ts 95.45% <100.00%> (+0.10%) ⬆️
src/hooks/useOdometerReceiptStitcher/index.ts 94.11% <ø> (ø)
...c/hooks/useRestartOnOdometerImagesFailure/index.ts 92.85% <100.00%> (+92.85%) ⬆️
src/libs/OdometerReceipt/deriveOdometerReceipt.ts 100.00% <ø> (ø)
src/libs/OdometerReceipt/stitchTask.ts 100.00% <ø> (ø)
src/libs/actions/TransactionEdit.ts 75.25% <ø> (+17.52%) ⬆️
src/libs/stitchOdometerImages/index.native.ts 0.00% <ø> (ø)
src/libs/stitchOdometerImages/index.ts 0.00% <ø> (ø)
... and 8 more
... and 93 files with indirect coverage changes

…er_show_discard_changes_modal_when_switching_tabs

# Conflicts:
#	src/hooks/useDiscardChangesConfirmation/index.native.ts
#	src/hooks/useDiscardChangesConfirmation/index.ts
#	src/libs/Navigation/OnyxTabNavigator.tsx
@github-actions

This comment was marked as resolved.

@Julesssss

Copy link
Copy Markdown
Contributor Author

OKAY so this PR has been in progress for a while, the contributor left SWM but the PR was approved by me and C+ for merge. However a merge conflict arose today and I can't write to that PR so had to clone it.

I will handle any issues here but essentially I have just merged main to resolve conflicts.

@Julesssss

Copy link
Copy Markdown
Contributor Author

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: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari

@Julesssss
Julesssss merged commit 84b100a into main Jun 29, 2026
38 of 39 checks passed
@Julesssss
Julesssss deleted the jules-cloneOdometerShowDiscardModal branch June 29, 2026 22:25
@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions

This comment has been minimized.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.4.25-0 🚀

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

@jponikarchuk

Copy link
Copy Markdown

Deploy Blocker #94961 was identified to be related to this PR.

@OSBotify

OSBotify commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.4.25-2 🚀

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.

5 participants