Feature: Add the ability to configure tax rates on distance rates

[nkdengineer]

Details

Fixed Issues

$ #41574
PROPOSAL: #41574 (comment)

Tests

1. Go to Settings -> Workspace -> choose a Workspace with disable Taxes
2. Click Distance Rates -> Click Settings
3. Verify that: 'Track Tax' is locked and has a message below
4. Click More features in the message and navigate to More Features page
5. Enable Taxes
6. Back to Setting in Distance Rates
7. Verify that: 'Track Tax' button is not locked
8. Enable 'Track Tax'
9. Select a Rate
10. Verify that: have 2 new rows 'Tax Rate' and 'Tax reclaimable on'
11. Try to update 2 new rows
12. Verify that: the update is successful

• Verify that no errors appear in the JS console

Offline tests

QA Steps

1. Go to Settings -> Workspace -> choose a Workspace with disable Taxes
2. Click Distance Rates -> Click Settings
3. Verify that: 'Track Tax' is locked and has a message below
4. Click More features in the message and navigate to More Features page
5. Enable Taxes
6. Back to Setting in Distance Rates
7. Verify that: 'Track Tax' button is not locked
8. Enable 'Track Tax'
9. Select a Rate
10. Verify that: have 2 new rows 'Tax Rate' and 'Tax reclaimable on'
11. Try to update 2 new rows
12. Verify that: the update is successful

• 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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • 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 verified the translation was requested/reviewed 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.js 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.
• 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.mov

Android: mWeb Chrome

android-mweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-mweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

[trjExpensify]

The WebPR was deployed to staging if you want to resume on getting this merge ready!

[trjExpensify]

Is this ready for review?

[MonilBhavsar]

Mostly looks good. Looks like we need spanish translations here for some text entered in English

[nkdengineer]

@trjExpensify @MonilBhavsar I've completed bullets 1 and 2, but encountered some issues with the APIs in bullets 3 and 4. I've already raised the problem in the issue.

[melvin-bot]

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

[nkdengineer]

We need Spanish translations here for some text entered in English and asking in here

[MonilBhavsar]

I think we should make it 1:1:1 since this function is for updating the rate value. I'll add a new API, which we can use with similar parameters.

[MonilBhavsar]

Can we please use UpdateDistanceTaxClaimableValue here and UpdateDistanceTaxRate where we update tax rate?

[nkdengineer]

I added 2 function UpdateDistanceTaxClaimableValue && UpdateDistanceTaxRate, its use the same parameters and the same API with function updatePolicyDistanceRateValue
When the new API is done, please let me know so I can fix here

[MonilBhavsar]

@nkdengineer conflicts here.
I also commented on translations thread. We can update it now.
@eVoloshchak could you please take a look. Thanks all!

[trjExpensify]

@nkdengineer we really would appreciate it if we can get this PR merged today. It's for our external commit at a conference next week, so a merge today means we can ensure we get it through the deploy cycles to production on time. Can you prioritise these changes, so @eVoloshchak can re-review? Thanks!

[nkdengineer]

Working on it now.

[nkdengineer]

Bug: Changing Tax rate and Tax reclaimable on stops working after you create a second distance rate
Bug: Tax reclaimable on number isn't fully displayed, it's rounded to one digit after the separator, while we allow entering three digits

@eVoloshchak Fixed these bug and update your suggestion. Ready for review again.

[eVoloshchak]

Not critical: I think we can safely remove this <View>

[nkdengineer]

agree.

[nkdengineer]

@eVoloshchak Updated.

[eVoloshchak]

Bug: sometimes the amount is displayed as 0 when you try to edit it. I'm not sure what are the steps to reproduce this reliably, but I've hit this bug quite a few times just by updating the amount continuously. This might be a BE issue (did not verify this), but the responses look fine

Screen.Recording.2024-06-05.at.18.26.18.mov

Screen.Recording.2024-06-05.at.18.22.05.mov

[MonilBhavsar]

Not able to reproduce this ^

Screen.Recording.2024-06-05.at.10.10.47.PM.mov

[MonilBhavsar]

Noticed a small bug, we can fix it as followup -
If rate is 0.670 and tax reclaimable amount is also 0.670, then in Amount and Currency component, the reclaimable amount is displayed as 0.67, while the rate is displayed correctly as 0.670

[nkdengineer]

I can reproduce this bug. Some time the currentTaxReclaimableOnValue has too many digits after the decimal point that makes the amount form strip all digits after decimal. I fixed it now.

[MonilBhavsar]

Thanks for the quick fix @nkdengineer! Looks good to me.
@eVoloshchak are you around to take a look again? We can take a look and fix it as followup as we're not reliably able to reproduce #42141 (comment)

[eVoloshchak]

LGTM!

[MonilBhavsar]

Looks good! Let's ship it 🚀

[MonilBhavsar]

Nice teamwork on this @nkdengineer @eVoloshchak @trjExpensify 🤝

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[trjExpensify]

Wahoo! Nice work ❤️