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

Set default tax #42126

Closed
wants to merge 8 commits into from
Closed

Conversation

aldo-expensify
Copy link
Contributor

@aldo-expensify aldo-expensify commented May 14, 2024

Details

Solution: use the policy's default tax rate if taxCode is not set. We do this in a useEffect in the same way we do it for other fields, for example here:

useEffect(() => {
if (customUnitRateID || !canUseP2PDistanceRequests) {
return;
}
if (!customUnitRateID) {
const rateID = lastSelectedDistanceRates?.[policy?.id ?? ''] ?? defaultMileageRate?.customUnitRateID ?? '';
IOU.setCustomUnitRateID(transactionID, rateID);
}
}, [defaultMileageRate, customUnitRateID, lastSelectedDistanceRates, policy?.id, canUseP2PDistanceRequests, transactionID]);

Fixed Issues

$ #42114
PROPOSAL:

Tests

  1. Create workspace and enable Taxes
  2. Set the tax rate 5% as default
  3. In the chat with yourself, track an expense
  4. In the whisper with actions, click "Categorize it"
  5. Select the policyExpenseChat of the workspace you created in step 1
  6. Select any category
  7. Scroll down and click "Show more"
  8. Verify that you see the Tax correctly selected: "Tax Rate 1 (5%) - Default"
  9. Verify that the Tax amount looks correct (5% of the amount your entered)
  10. Click "Submit"
  11. Verify that the tax is still set
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Create workspace and enable Taxes
  2. Set the tax rate 5% as default
  3. In the chat with yourself, track an expense
  4. In the whisper with actions, click "Categorize it"
  5. Select the policyExpenseChat of the workspace you created in step 1
  6. Select any category
  7. Scroll down and click "Show more"
  8. Verify that you see the Tax correctly selected: "Tax Rate 1 (5%) - Default"
  9. Verify that the Tax amount looks correct (5% of the amount your entered)
  10. Click "Submit"
  11. Verify that the tax is still set
  • 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2024-05-13.at.7.30.09.PM.mov
MacOS: Desktop

@aldo-expensify aldo-expensify self-assigned this May 14, 2024
@aldo-expensify
Copy link
Contributor Author

aldo-expensify commented May 14, 2024

Following the Test steps described above, I end up with a negative tax amount:

image

Is this expected? @MonilBhavsar @teneeto @getusha (Tagged you because you are in the original PR #40443 and may know if this is correct or not 🙇 )

@aldo-expensify aldo-expensify marked this pull request as ready for review May 14, 2024 02:31
@aldo-expensify aldo-expensify requested a review from a team as a code owner May 14, 2024 02:31
@melvin-bot melvin-bot bot removed the request for review from a team May 14, 2024 02:31
Copy link

melvin-bot bot commented May 14, 2024

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

@melvin-bot melvin-bot bot requested a review from hungvu193 May 14, 2024 02:31
@hungvu193
Copy link
Contributor

@aldo-expensify Let me know if this needs C+ review

@aldo-expensify
Copy link
Contributor Author

@aldo-expensify Let me know if this needs C+ review

Let me see if @getusha can get to this, since they reviewed the PR that introduced the regression https://github.com/Expensify/App/pull/40443/files#r1599258680

@aldo-expensify aldo-expensify requested review from getusha and removed request for hungvu193 May 14, 2024 02:49
@MonilBhavsar
Copy link
Contributor

Thanks for the PR! We already have a hook to set tax details here

useEffect(() => {
const taxAmount = getTaxAmount(transaction, policy).toString();
const amountInSmallestCurrencyUnits = CurrencyUtils.convertToBackendAmount(Number.parseFloat(taxAmount));
if (transaction?.taxAmount && previousTransactionAmount === transaction?.amount && previousTransactionCurrency === transaction?.currency) {
return IOU.setMoneyRequestTaxAmount(transactionID, transaction?.taxAmount ?? 0, true);
}
IOU.setMoneyRequestTaxAmount(transactionID, amountInSmallestCurrencyUnits, true);
}, [policy, transaction, transactionID, previousTransactionAmount, previousTransactionCurrency]);

Issue will be fixed with #42151

@aldo-expensify
Copy link
Contributor Author

Thanks for the PR! We already have a hook to set tax details here

That is setting taxAmount, not the taxCode. This PR is using the same pattern to set the taxCode.

@getusha
Copy link
Contributor

getusha commented May 19, 2024

@MonilBhavsar @aldo-expensify will this be fixed in #42151?

@MonilBhavsar
Copy link
Contributor

No, we should fix it here and close #42151

@MonilBhavsar
Copy link
Contributor

This is linked to this issue #42114. So I think we should assign Eric as a reviewer here 🤔 cc @aldo-expensify

@aldo-expensify aldo-expensify requested review from eh2077 and removed request for getusha May 22, 2024 07:51
@aldo-expensify
Copy link
Contributor Author

aldo-expensify commented May 22, 2024

Swapped reviewer to @eh2077, this should be ready for review.

@aldo-expensify
Copy link
Contributor Author

The backend for now is ignoring the taxCode and taxAmount sent in AddTrackedExpenseToPolicy, so if you manually change the tax code to one that is not the default, these changes won't be persisted, but that is out of the scope of this PR and I'm working on it in the backend. This PR is only taking care of selecting the default tax code when it is missing.

@eh2077
Copy link
Contributor

eh2077 commented May 22, 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

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari
0-web.mp4
MacOS: Desktop

N/A

Copy link
Contributor

@eh2077 eh2077 left a comment

Choose a reason for hiding this comment

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

Frontend optimistic updating works well. Code also looks good, just a minor comment

src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
@melvin-bot melvin-bot bot requested a review from dangrous May 22, 2024 17:25
Copy link

melvin-bot bot commented May 22, 2024

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

dangrous
dangrous previously approved these changes May 22, 2024
Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

This works for me but might be able to get around the eslint thing with @eh2077's suggestion!

src/components/MoneyRequestConfirmationList.tsx Outdated Show resolved Hide resolved
Comment on lines 311 to 313
if (defaultTaxCode) {
IOU.setMoneyRequestTaxRate(transactionID, defaultTaxCode);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we could remove this condition - if (defaultTaxCode)?
we can fallback to empty string and always set tax rate

@MonilBhavsar
Copy link
Contributor

Bug 1:

  1. Set tax settings to have different workspace default and foreign default currency rates
  2. Start request and proceed with default currency
  3. Go back to amount step(first step) and change amount to foreign currency

Expected: Tax rate changes to have foreign default currency rate
Actual: Tax rate does not change

Bug 2:

  1. Set tax settings to have different workspace default and foreign default currency rates
  2. Start request and proceed with default currency
  3. On confirmation list, update currency to foreign and then default

Expected: Tax rate changes to have foreign default currency rate and workspace default rates as per currency
Actual: Tax rate does not change

@aldo-expensify
Copy link
Contributor Author

@MonilBhavsar thanks for reviewing, I'll try to get back to this asap

@MonilBhavsar
Copy link
Contributor

Thanks! We can do similar to what we did here c671c7a#diff-29ef0426ea09b0af3420c95911645adcd54c0d3d4c0d8c4fa5aa99dfe37a3646R342-R365

On first mount, set default rate and only update the rate depending on other parameters

aldo-expensify and others added 2 commits May 30, 2024 23:12
Co-authored-by: Eric Han <117511920+eh2077@users.noreply.github.com>
…:Expensify/App into aldo_add-default-tax-rate-to-transaction
@aldo-expensify
Copy link
Contributor Author

Thanks! We can do similar to what we did here c671c7a#diff-29ef0426ea09b0af3420c95911645adcd54c0d3d4c0d8c4fa5aa99dfe37a3646R342-R365

On first mount, set default rate and only update the rate depending on other parameters

I tried it, but only works if the user press the "back" to change the amount. If the user clicks the amount input and changes the currency, it doesn't work because the component doesn't get unmounted.

Screen.Recording.2024-05-30.at.11.53.32.PM.mov

@aldo-expensify
Copy link
Contributor Author

aldo-expensify commented May 31, 2024

@MonilBhavsar I think the bugs you found are fixed now, but I found a new one: the tax amount doesn't update automatically when the tax code changes because the currency changed. I think the code here is buggy:

const taxAmount = getTaxAmount(transaction, policy).toString();
const amountInSmallestCurrencyUnits = CurrencyUtils.convertToBackendAmount(Number.parseFloat(taxAmount));
if (transaction?.taxAmount && previousTransactionAmount === transaction?.amount && previousTransactionCurrency === transaction?.currency) {
return IOU.setMoneyRequestTaxAmount(transactionID, transaction?.taxAmount ?? 0, true);
}
IOU.setMoneyRequestTaxAmount(transactionID, amountInSmallestCurrencyUnits, true);
}, [policy, transaction, transactionID, previousTransactionAmount, previousTransactionCurrency]);
// If completing a split expense fails, set didConfirm to false to allow the user to edit the fields again
if (isEditingSplitBill && didConfirm) {
setDidConfirm(false);

I wish there was some comment explaining that if statement inside the useEffect because it is pretty obscure what is doing.

Do you know in which cases are we supposed to update the tax amount automatically? is it when we change the taxCode or we change manually the amount, any other cases?

return;
}
const defaultTaxCode = TransactionUtils.getDefaultTaxCode(policy, transactionCurrency);
IOU.setMoneyRequestTaxRate(transactionID, defaultTaxCode ?? '');
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changing the function IOU.setMoneyRequestTaxRate to receive only the currency instead of the whole transaction object allow us to only watch the currency instead of the transaction object, which is what we want to react to if it changes.

@MonilBhavsar
Copy link
Contributor

I wish there was some comment explaining that if statement inside the useEffect because it is pretty obscure what is doing.

Agree, we're getting rid of that condition in this PR #42737

Do you know in which cases are we supposed to update the tax amount automatically? is it when we change the taxCode or we change manually the amount, any other cases?

Yes, when we change the taxCode, when we change the amount and when we change the currency(if taxCode changes, taxAmount should also update)

@MonilBhavsar
Copy link
Contributor

I think the bugs you found are fixed now, but I found a new one: the tax amount doesn't update automatically when the tax code changes because the currency changed. I think the code here is buggy:

I didn't check yet, but I believe it is related to this PR only?

@aldo-expensify
Copy link
Contributor Author

I'm re-implementing this here: #43519

I tested cases of:

  • default tax for currency other than the workspace's currency
  • default tax for same currency as the workspace's currency
  • default tax for distances with tax enable

The amount of the tax is updated when the tax code changes

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