Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CP Staging] Use selected currency when utilising tax rate #42064

Merged
merged 5 commits into from
May 14, 2024

Conversation

ShridharGoel
Copy link
Contributor

@ShridharGoel ShridharGoel commented May 13, 2024

Details

Use selected currency when utilising tax rate.

Fixed Issues

$ #42047
PROPOSAL: #42047 (comment)

Tests

  1. Set default tax as 0 and foreign tax as some value like 5%.
  2. Go to submit expense flow.
  3. Try to change the tax amount.
  4. It should change to the new amount if it is below the 5% limit.

QA Steps

  1. Set default tax as 0 and foreign tax as some value like 5%.
  2. Go to submit expense flow.
  3. Try to change the tax amount.
  4. It should change to the new amount if it is below the 5% limit.

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: mWeb Chrome
Screenrecording_20240514_002141.mp4
iOS: Native
Screen.Recording.2024-05-14.at.12.16.13.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-05-14.at.12.18.08.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-05-13.at.11.18.14.PM.mov
MacOS: Desktop
Screen.Recording.2024-05-14.at.12.28.01.AM.mov

@ShridharGoel ShridharGoel requested a review from a team as a code owner May 13, 2024 13:31
@melvin-bot melvin-bot bot requested review from allroundexperts and removed request for a team May 13, 2024 13:31
Copy link

melvin-bot bot commented May 13, 2024

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

@allroundexperts
Copy link
Contributor

allroundexperts commented May 13, 2024

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 tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • 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 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 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
    • 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.js 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.
  • 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: Native

Android build not working locally

Android: mWeb Chrome
Screen.Recording.2024-05-14.at.12.29.53.AM.mov
iOS: Native
Screen.Recording.2024-05-14.at.12.21.52.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-05-14.at.12.19.05.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-05-13.at.11.47.37.PM.mov
MacOS: Desktop
Screen.Recording.2024-05-14.at.12.13.12.AM.mov

@allroundexperts
Copy link
Contributor

@ShridharGoel TS errors.

@@ -34,13 +34,13 @@ type IOURequestStepTaxAmountPageProps = IOURequestStepTaxAmountPageOnyxProps &
transaction: OnyxEntry<Transaction>;
};

function getTaxAmount(transaction: OnyxEntry<Transaction>, policy: OnyxEntry<Policy>, isEditing: boolean): number | undefined {
function getTaxAmount(transaction: OnyxEntry<Transaction>, policy: OnyxEntry<Policy>, currency: string | undefined, isEditing: boolean): number | undefined {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you pass currency from all function usages also, please

Copy link
Contributor

@MonilBhavsar MonilBhavsar May 13, 2024

Choose a reason for hiding this comment

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

Passing currency from src/pages/iou/request/step/IOURequestStepAmount.tsx might fix #42049 NVM

@MonilBhavsar MonilBhavsar changed the title Use selected currency when utilising tax rate [CP Staging] Use selected currency when utilising tax rate May 13, 2024
@ShridharGoel
Copy link
Contributor Author

Updating

@ShridharGoel
Copy link
Contributor Author

Should we pass currency to transformedTaxRates as well? It calls getDefaultTaxCode, so we can pass it further to getDefaultTaxCode.

@MonilBhavsar
Copy link
Contributor

Yes, I think we should update all usages

@ShridharGoel
Copy link
Contributor Author

We don't have currency in OptionsListUtils though.

@ShridharGoel
Copy link
Contributor Author

Looks like transformedTaxRates needs only the transaction currency. Thoughts?

@@ -371,7 +371,7 @@ function MoneyRequestConfirmationList({

// Calculate and set tax amount in transaction draft
useEffect(() => {
const taxAmount = getTaxAmount(transaction, policy).toString();
const taxAmount = getTaxAmount(transaction, policy, currency).toString();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@MonilBhavsar Added here as well, does this look fine?

Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't look good to me as currency is related to mileage rate or policy default currency. const currency = (mileageRate as MileageRate)?.currency ?? policyCurrency;
We should either use selected currency or transaction currency

@MonilBhavsar
Copy link
Contributor

Looks like transformedTaxRates needs only the transaction currency. Thoughts?

👍 we can leave it. Thanks for checking!

@MonilBhavsar
Copy link
Contributor

@allroundexperts over to you

@allroundexperts
Copy link
Contributor

Hm... isn't the lint failing?

@MonilBhavsar
Copy link
Contributor

@ShridharGoel could you please fix the lint errors

@ShridharGoel
Copy link
Contributor Author

I found another bug which we can fix in this, updating it.

@MonilBhavsar
Copy link
Contributor

Just a small feedback, as a reviewer force pushing commits make difficult to know what has been updated since last commit as it deletes commit history.

@allroundexperts
Copy link
Contributor

@ShridharGoel Are you done?

@ShridharGoel
Copy link
Contributor Author

The issue which I'm trying to fix: When we change the currency for the first time, on the money request confirmation page it starts showing the max tax amount instead of the amount set by the user. This happens because we have a diff tax calculation logic in MoneyRequestConfirmationList.

@ShridharGoel
Copy link
Contributor Author

Updated.

@ShridharGoel
Copy link
Contributor Author

Screen.Recording.2024-05-13.at.11.18.14.PM.mov

@MonilBhavsar
Copy link
Contributor

The video mentioned in issue shows the tax currency being changed. I think then we should just disable the changing option there?

I believe it is already the case. Looking...

@MonilBhavsar
Copy link
Contributor

It's a regression from https://github.com/Expensify/App/pull/40159/files
Currency for tax amount is uneditable

@ShridharGoel
Copy link
Contributor Author

@MonilBhavsar No, it's actually from #40443 only.

@ShridharGoel
Copy link
Contributor Author

ShridharGoel commented May 13, 2024

isEditing definition was changed in #40443.

But actually we should always have isCurrencyPressable as false which I've updated.

@MonilBhavsar
Copy link
Contributor

Nice, thanks!
So what is remaining to get final review on this PR. Could you please summarise?

@ShridharGoel
Copy link
Contributor Author

The changes have been completed.

Summary:

  • We use the selected currency in the flow now.

  • User can't change the currency via tax editing page.

@allroundexperts
Copy link
Contributor

Thanks for letting us know. I'm on the review.

@allroundexperts
Copy link
Contributor

@ShridharGoel Can you please update the screen recordings?

@ShridharGoel
Copy link
Contributor Author

On it.

@allroundexperts
Copy link
Contributor

Changing the currency resets the tax amount. Is that expected?

@ShridharGoel
Copy link
Contributor Author

I think yes since the tax percent changes.

@MonilBhavsar
Copy link
Contributor

Changing the currency resets the tax amount.

Can you please explain "reset". Perhaps with an example

@ShridharGoel
Copy link
Contributor Author

Added all videos except native Android where I have some build issues. Can we start an adhoc build?

@ShridharGoel
Copy link
Contributor Author

Also, I think older tax amount doesn't make sense when the currency is changed so it gets calculated again.

@allroundexperts
Copy link
Contributor

@MonilBhavsar Notice how the tax amount changes from 5 to 5.76 after I change the currency at the end.

Screen.Recording.2024-05-14.at.12.13.12.AM.mov

@MonilBhavsar
Copy link
Contributor

Yes, Expected

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Tests good!

@melvin-bot melvin-bot bot requested a review from lakchote May 13, 2024 19:37
@lakchote lakchote merged commit 2304a1f into Expensify:main May 14, 2024
16 of 17 checks passed
@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 pushed a commit that referenced this pull request May 14, 2024
[CP Staging] Use selected currency when utilising tax rate

(cherry picked from commit 2304a1f)
@Beamanator
Copy link
Contributor

CPing 👍

Beamanator added a commit that referenced this pull request May 14, 2024
…ng-42064-1

🍒 Cherry pick PR #42064 to staging 🍒
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/lakchote in version: 1.4.73-3 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.73-7 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 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