Skip to content

Fix stale fields leaking when merging odometer and map distance expenses - #94748

Draft
Julesssss wants to merge 2 commits into
mainfrom
jules-fixOdometerMapMergeLeak
Draft

Fix stale fields leaking when merging odometer and map distance expenses#94748
Julesssss wants to merge 2 commits into
mainfrom
jules-fixOdometerMapMergeLeak

Conversation

@Julesssss

@Julesssss Julesssss commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Merging an odometer distance expense with a map distance expense produced a corrupted result — leaked odometer readings, the wrong route, and a combined receipt — because the front end accumulated both modalities' fields in the merge transaction instead of replacing them on each merchant selection.

Two distinct leaks, both fixed by making a merchant selection fully own the distance bundle:

  • Odometer readings (getMergeFieldUpdatedValues, MergeTransactionUtils.ts): odometer fields were only set when the selected expense was itself an odometer request, so selecting a map merchant left the previous odometer readings untouched — Onyx.merge ignores omitted keys. They are now explicitly nulled for any non-odometer selection.
  • receipt and customUnit (handleSelect, DetailsReviewPage.tsx): these are objects, and setMergeTransactionKey uses Onyx.merge, which deep-extends them and keeps stale sub-keys from the previously selected expense. They are now nulled first in the same synchronous batch so the new value fully replaces rather than merges.

Fixed Issues

$ #91794
PROPOSAL:

Tests

Setup — produce two eligible distance expenses

Both expenses must be distance requests and neither may be on an IOU report. They do not need a workspace — two unreported (personal) distance expenses are eligible.

  1. Create a distance expense via the Odometer tab — enter start/end readings and attach a receipt. (If the Odometer tab isn't available on a personal account, create both expenses on a workspace that has odometer distance enabled.)
  2. Create a distance expense via the Map tab — set a route with at least two waypoints and attach a receipt.

Merge — finishing on the map expense

  1. Open the odometer expense, tap the header's More (⋯) menu, and select Merge.
    • The map expense should appear in the eligible list. If you see "No eligible expenses found" instead, the setup is wrong: confirm both expenses are distance requests, neither is on an IOU report, and neither is still scanning/pending.
  2. Select the map expense to merge with.
  3. On the Details review page, for the Merchant field, tap the odometer expense, then the map expense, then the odometer expense again (toggle back and forth), finishing on the map expense.
  4. Tap Continue and confirm the merge.
  5. Verify the merged expense is a clean map distance expense: it shows the map route/waypoints, shows no odometer readings, and the receipt is the map expense's receipt only (not a combined image).

Merge — finishing on the odometer expense

  1. Repeat steps 3–6, but finish the Merchant toggle on the odometer expense.
  2. Verify the merged expense shows the odometer readings, no map route/waypoints, and the odometer receipt only.
  • Verify that no errors appear in the JS console

Offline 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 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 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)
  • 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.
  • 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

@codecov

codecov Bot commented Jun 27, 2026

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
src/libs/MergeTransactionUtils.ts 81.93% <100.00%> (+2.10%) ⬆️
src/pages/TransactionMerge/DetailsReviewPage.tsx 0.00% <0.00%> (ø)
... and 101 files with indirect coverage changes

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 Ran the tests against e429098 (jules-fixOdometerMapMergeLeak). The PR's unit tests and all core CI checks pass.

Check Result
Unit tests (MergeTransactionTest.ts, MergeTransactionUtilsTest.ts) 104 passed, 0 failed
typecheck (tsc) ✅ Passed
ESLint (changed files) ✅ Passed
Prettier (--check) ✅ Passed
React Compiler check-changed ⚠️ Could not run — see below
Details
  • Unit tests — ran the two suites changed in this PR: 2 passed, 2 total / 104 tests passed.
  • typechecknpm run typecheck (tsc) completed clean.
  • ESLint — ran ./scripts/lint.sh directly on the 4 changed files (the lint-changed wrapper can't compute a merge-base in this shallow checkout, so I targeted the files explicitly). No violations.
  • Prettier--check reports all matched files use Prettier code style.
  • React Compiler check-changed — couldn't run in this environment: the script resolves the base branch via origin/<GITHUB_BASE_REF>, which is empty here, so it errors on git rev-parse origin/. This is an environment limitation of the runner, not a problem with the PR. It will still run normally in CI.

Files tested: src/libs/MergeTransactionUtils.ts, src/pages/TransactionMerge/DetailsReviewPage.tsx, plus the two test files above.

@MelvinBot

This comment was marked as outdated.

@MelvinBot

Copy link
Copy Markdown
Contributor

⏱️ Ran out of time before I could finish. This usually means the task was too complex or I got stuck exploring. Please try again with a more specific request or post in #melvinbot-ai.

Run details

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