Skip to content

Fix tax updating for changing waypoints or currency#73045

Merged
luacmartins merged 3 commits intomainfrom
Rory-TaxUpdatingForWaypoints
Oct 22, 2025
Merged

Fix tax updating for changing waypoints or currency#73045
luacmartins merged 3 commits intomainfrom
Rory-TaxUpdatingForWaypoints

Conversation

@roryabraham
Copy link
Contributor

@roryabraham roryabraham commented Oct 21, 2025

Explanation of Change

Due to excessive and incorrect value-diffing with usePrevious, tax rates are not being correctly updated when parameters (such as the waypoints for a distance expense) change.

Fixed Issues

$ #72380

Tests / QA Steps

Prerequisites

  1. Create a workspace

  2. Enable tax and distance rates

  3. Set up two tax rates:

    1. A default for the workspace currency default (USD)
    2. A different default for foreign currencies
    image
  4. Go to workspace settings -> distance rates -> settings -> enable tax tracking

    image

Test changing waypoints

  1. Click on the global create button -> track distance
  2. Enter two waypoints
  3. Click next
  4. Observe the tax amount
  5. Click back
  6. Change one of the waypoints
  7. Click next
  8. Verify the tax amount updated in accordance with the new waypoints

Test changing currency

  1. Click on the global create expense button
  2. Enter a $20USD expense
  3. Verify that the workspace default tax rate is applied
  4. Click back
  5. Change the currency to a different currency
  6. Verify that the foreign currency tax rate is applied
  • Verify that no errors appear in the JS console

Offline tests

None.

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
    • 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
web.mov
MacOS: Desktop

@roryabraham roryabraham self-assigned this Oct 21, 2025
@roryabraham roryabraham requested a review from jjcoffee October 21, 2025 01:53
@roryabraham roryabraham marked this pull request as ready for review October 21, 2025 01:53
@roryabraham roryabraham requested a review from a team as a code owner October 21, 2025 01:53
@melvin-bot melvin-bot bot requested review from Gonals and removed request for a team October 21, 2025 01:53
@melvin-bot
Copy link

melvin-bot bot commented Oct 21, 2025

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

if (defaultTaxCode !== currentTaxCode) {
setMoneyRequestTaxRate(transactionID, defaultTaxCode ?? '');
}
}, [customUnitRateID, policy, shouldShowTax, transaction, transactionID]);
Copy link
Contributor

Choose a reason for hiding this comment

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

❌ PERF-6 (docs)

Instead of passing entire objects as dependencies, specify individual object properties to create more granular dependency tracking and reduce unnecessary hook executions.

}, [customUnitRateID, policy, shouldShowTax, transaction?.taxCode, transaction?.currency, transaction?.modifiedCurrency, transactionID]);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This suggestion is not correct as written. In theory I agree with the principle, but in practice there are a bunch of transaction fields used within this effect, and while I could enumerate them all, it would make the effect more brittle - changing one of the TransactionUtils functions to use an additional property would result in the effect not being re-run when it needs to.

This is the kind of thing React Compiler could probably memoize much more effectively than we could manually, because it could deeply analyze the usage of all variables in your function scope and apply the kind of granular memoization that this comment strives for, but can do it reliably at build time.

previousTaxCode,
distance,
]);
}, [policy, shouldShowTax, transaction, isDistanceRequest, customUnitRateID, distance]);
Copy link
Contributor

Choose a reason for hiding this comment

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

❌ PERF-6 (docs)

Instead of passing entire objects as dependencies, specify individual object properties to create more granular dependency tracking and reduce unnecessary hook executions.

}, [policy, shouldShowTax, transaction?.amount, transaction?.taxAmount, transaction?.taxCode, transaction?.currency, transaction?.transactionID, isDistanceRequest, customUnitRateID, distance]);

@codecov
Copy link

codecov bot commented Oct 21, 2025

Codecov Report

❌ Patch coverage is 28.57143% with 5 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/components/MoneyRequestConfirmationList.tsx 28.57% 5 Missing ⚠️
Files with missing lines Coverage Δ
src/components/MoneyRequestConfirmationList.tsx 51.11% <28.57%> (+0.27%) ⬆️

... and 9 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Burhan-Rashid
Copy link
Contributor

@roryabraham there is a regression with these changes.
When the user goes back from the confirmation page to the amount selection page changes the currency to some non-default currency and proceeds to the confirmation page, the tax code that is seen on the confirmation page doesn't reflect the foreign currency default tax code, instead it still shows the previous tax code.

taxcodeissuechanges.mp4

@roryabraham
Copy link
Contributor Author

@Burhan-Rashid I'm not able to reproduce that regression on this branch. It is explicitly covered by the test/QA steps and the video I included in the PR description shows that the bug you describe is not present.

@github-actions
Copy link
Contributor

LGTM :feelsgood:. Thank you for your hard work!

@Burhan-Rashid
Copy link
Contributor

@Burhan-Rashid I'm not able to reproduce that regression on this branch. It is explicitly covered by the test/QA steps and the video I included in the PR description shows that the bug you describe is not present.

I think there might have been some cache related issue on my local. I am also not able to reproduce it currently. Sorry for the inconvenience.

@roryabraham
Copy link
Contributor Author

roryabraham commented Oct 22, 2025

No worries - thank you for your diligence in testing 😄

@jjcoffee
Copy link
Contributor

jjcoffee commented Oct 22, 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
android-app-2025-10-22_16.30.53.mp4
Android: mWeb Chrome
android-chrome-2025-10-22_16.25.46.mp4
iOS: HybridApp
ios-app-2025-10-22_18.22.24.mp4
iOS: mWeb Safari
ios-safari-2025-10-22_18.26.17.mp4
MacOS: Chrome / Safari
desktop-chrome-2025-10-22_14.35.50.mp4
MacOS: Desktop
desktop-app-2025-10-22_15.12.18.mp4

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

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

LGTM! Tests well and is much cleaner like this, thanks for stepping in!

@melvin-bot melvin-bot bot requested a review from luacmartins October 22, 2025 16:29
@melvin-bot
Copy link

melvin-bot bot commented Oct 22, 2025

@luacmartins 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

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM

@luacmartins luacmartins merged commit 63e72de into main Oct 22, 2025
29 checks passed
@luacmartins luacmartins deleted the Rory-TaxUpdatingForWaypoints branch October 22, 2025 18:19
@OSBotify
Copy link
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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.2.37-1 🚀

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

blimpich added a commit that referenced this pull request Oct 24, 2025
…aypoints"

This reverts commit 63e72de, reversing
changes made to 001dd99.
@blimpich blimpich mentioned this pull request Oct 24, 2025
54 tasks
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/blimpich in version: 9.2.37-8 🚀

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.

5 participants