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

Add useEffect to select default tax code #43519

Merged
merged 15 commits into from
Aug 16, 2024
Merged

Conversation

aldo-expensify
Copy link
Contributor

@aldo-expensify aldo-expensify commented Jun 12, 2024

Re-implementation of #42126

Details

Needs: https://github.com/Expensify/Auth/pull/10987 and https://github.com/Expensify/Web-Expensify/pull/42115

Fixed Issues

$ #42114
PROPOSAL:

Tests

  1. Create a workspace
  2. Set the workspace default currency to USD if it is not already that
  3. Go to "More features" and enable "Distance rates" and "Taxes"
  4. Go to "Taxes" and define 3 tax rates:
    1. Tax USD40: 40%
    2. Tax other currency10: 10%
    3. Tax distance25: 25%
  5. Still in "Taxes", click in "Settings" in the top and choose the following defaults:
    image
  6. Verify you end up with a configuration like this:
    image
  7. Go "Distance rates" and enable "Track tax" in the top right settings
  8. Create a distance rate, assign a tax rate to it and input some amount smaller than the rate in "Tax reclaimable on":
    image
  9. In the DM chat with yourself, click "+ > Track expense" and create an expense with the same currency as the workspace currency
    image
  10. Wait for the concierge message with actions and click "Categorize it"
    image
  11. The RHN should open with the workspace as the only alternative, select the workspace
  12. Choose any category from the list
  13. In the expense form, click "Show more"
  14. Verify that the tax code is set to the default tax code for expenses with the currency of the workspace
  15. Verify that the tax amount looks correct
  16. Change the tax code manually
  17. Verify that the tax amount is updated
  18. Dismiss the RHN clicking outside
  19. In the DM chat with yourself, click "+ > Track expense" and create an expense with a different currency
  20. Wait for the concierge message with actions and click "Categorize it"
  21. The RHN should open with the workspace as the only alternative, select the workspace
  22. Choose any category from the list
  23. In the expense form, click "Show more"
  24. Verify that the tax code is set to the default tax code for expenses with a different currency of the workspace
  25. Dismiss the RHN clicking outside
  26. In the DM chat with yourself, click "+ > Track expense" and create a distance request
  27. Wait for the concierge message with actions and click "Categorize it"
  28. The RHN should open with the workspace as the only alternative, select the workspace
  29. Choose any category from the list
  30. Verify that the tax code is set to the default tax code for the distance rate selected
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • 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-06-11.at.7.37.13.PM.mov
MacOS: Desktop

@aldo-expensify aldo-expensify self-assigned this Jun 12, 2024
@aldo-expensify aldo-expensify requested a review from a team as a code owner June 12, 2024 02:21
@melvin-bot melvin-bot bot requested review from eh2077 and removed request for a team June 12, 2024 02:21
Copy link

melvin-bot bot commented Jun 12, 2024

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

@aldo-expensify aldo-expensify mentioned this pull request Jun 12, 2024
50 tasks
@eh2077

This comment was marked as outdated.

@eh2077
Copy link
Contributor

eh2077 commented Jun 13, 2024

@aldo-expensify May I know do I need to wait for the backend change to do the test?

@aldo-expensify
Copy link
Contributor Author

@aldo-expensify May I know do I need to wait for the backend change to do the test?

I don't think it is necessary, the optimistic data should make it looks like it is working fine unless you logout / login

@eh2077
Copy link
Contributor

eh2077 commented Jun 18, 2024

@aldo-expensify I finished frontend (optimistic update) test and it works well for me, see two recordings in the Web browser section of my checklist.

I also can repro the negative tax amount issue in the transaction thread as you mentioned here. It seems I got red dot in the Tax field while you didn't.

image

Let me know if I should continue testing with other platforms or waiting for subsequent updates, thank you.

@MonilBhavsar
Copy link
Contributor

@aldo-expensify looks like this is just held on the clarification above

@aldo-expensify
Copy link
Contributor Author

I resolved the conflicts and pushed a fix for the taxes showing negative. I don't think taxes will ever be negative, so I added a Math.abs here:

// Calculate the formatted tax amount based on the transaction's tax amount and the IOU currency code
const formattedTaxAmount = CurrencyUtils.convertToDisplayString(Math.abs(transaction?.taxAmount ?? 0), iouCurrencyCode);

just like we do for the amount:

iouAmount={Math.abs(transaction?.amount ?? 0)}
iouComment={transaction?.comment.comment ?? ''}

With this change, the taxAmount is still stored with the same sign (negative/positve) we store the amount... which I think makes sense. If the front end is storing the optimistic amount positive, then the optimistic taxAmount is positive.

If you follow the testing steps it is possible that you end up with the report loading forever:

image

I think this is unrelated and is happening because of regressions coming from this PR: #40168 (I already fixed a very similar regression)

I also can repro the negative tax amount issue in the transaction thread as you mentioned #42114 (comment). It seems I got red dot in the Tax field while you didn't.

@eh2077 I'm not sure about this validation error, I haven't seen it while testing. It may be an unrelated bug? 🤷

Considering the skeleton loading forever problem, I'm not sure if you will be able to test correctly. Can you give it a try and see if works for you?

@MonilBhavsar
Copy link
Contributor

@eh2077 could you please check this comment above when you have moment, thanks!

@eh2077
Copy link
Contributor

eh2077 commented Jun 28, 2024

@MonilBhavsar Sure, I just tried to re-test it. I found two issues this time

  • The page is stuck after submit the categoried expense
  • The validator error and the negative tax are still there
image image

@aldo-expensify
Copy link
Contributor Author

The page is stuck after submit the categoried expense

This is unrelated and seems to happen in main too. I think you can go around it if you click Categorize and then go offline and finish moving the expense to the policyExpenseChat while offline.

The validator error and the negative tax are still there

I pushed a fix for the negative tax, I missed that. About the validation error, I still don't see it, and it is probably unrelated.

@eh2077
Copy link
Contributor

eh2077 commented Jul 8, 2024

I'll re-test it today

@eh2077
Copy link
Contributor

eh2077 commented Jul 16, 2024

@aldo-expensify Kindly help to resolve the conflicts when you get a chance.

@aldo-expensify
Copy link
Contributor Author

@eh2077 this is ready for review again, please review asap to avoid more delays / conflicts

@eh2077
Copy link
Contributor

eh2077 commented Aug 4, 2024

@aldo-expensify Can you please clean up debugging console logs? Other than that code changes look good to me.

Just realised that free trials of my exiting accounts have been ended. I have applied for free trials here. I'll complete the checklist asap once my account is granted with free trial.

@eh2077
Copy link
Contributor

eh2077 commented Aug 6, 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
0-web.mp4
MacOS: Desktop

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.

LGTM and tested well

@melvin-bot melvin-bot bot requested a review from tylerkaraszewski August 6, 2024 16:28
Copy link

melvin-bot bot commented Aug 6, 2024

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

@aldo-expensify
Copy link
Contributor Author

@MonilBhavsar this is ready for internal review (friendly bump)

@MonilBhavsar
Copy link
Contributor

Oops sorry I missed it. I was focussed on fireroom. I'll surely get to this tomorrow morning - the first thing

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

Thanks! Some minor comments. Doing some tests

Comment on lines +170 to +171
? CurrencyUtils.convertToDisplayString(Math.abs(updatedTransaction?.taxAmount), transactionCurrency)
: CurrencyUtils.convertToDisplayString(Math.abs(transactionTaxAmount ?? 0), transactionCurrency);
Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, why this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The tax amount is negative in some cases and we never want to display it as a negative number

(transaction.taxAmount !== undefined &&
previousTransactionAmount === transaction.amount &&
previousTransactionCurrency === transaction.currency &&
previousCustomUnitRateID === customUnitRateID &&
Copy link
Contributor

Choose a reason for hiding this comment

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

Why we added customUnitRateID?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because if the rate changes we should recalculate the tax amount because it may have changed

IOU.setMoneyRequestTaxRate(transactionID, defaultTaxCode ?? '');
}, [customUnitRateID, policy, previousCustomUnitRateID, previousTransactionCurrency, previousTransactionModifiedCurrency, shouldShowTax, transaction, transactionID]);

// A flag for showing the billable field
Copy link
Contributor

Choose a reason for hiding this comment

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

This comment looks off from the code below it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Probably a bad conflict resolution, I'll remove it.

@MonilBhavsar
Copy link
Contributor

Okay looks good and works fine!
Just these questions and hopefully, we can merge tonight.


@eh2077 checklist is failing somehow, could you please a final look. Thanks!

@melvin-bot melvin-bot bot requested a review from rlinoz August 8, 2024 16:46
Copy link

melvin-bot bot commented Aug 8, 2024

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

@aldo-expensify
Copy link
Contributor Author

@MonilBhavsar I replied your questions and removed the comment that was added by mistake. Ready for review again.

@aldo-expensify
Copy link
Contributor Author

aldo-expensify commented Aug 15, 2024

Bump @MonilBhavsar, It would be nice if this doesn't get conflicts again

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

Looks good! 🚀

@MonilBhavsar MonilBhavsar merged commit cf897a0 into main Aug 16, 2024
16 checks passed
@MonilBhavsar MonilBhavsar deleted the aldo_select-default-tax branch August 16, 2024 06:31
@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/MonilBhavsar in version: 9.0.22-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 9.0.22-1 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.0.22-9 🚀

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.

4 participants