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] Fix tax rate being updated when currency is updated in offline mode #42128

Merged
merged 6 commits into from
May 14, 2024

Conversation

MonilBhavsar
Copy link
Contributor

@MonilBhavsar MonilBhavsar commented May 14, 2024

Details

Fixed Issues

$ #42049
PROPOSAL:

Tests

Precondition:

  • Workspace has enabled tax rate.
  • Workspace currency default and Foreign currency default are different.
  1. Go to staging.new.expensify.com
  2. Go to workspace chat.
  3. Go offline.
  4. Submit an expense in local currency.
  5. Go to transaction thread.
  6. Click Amount and change it to a foreign currency.
  7. Ensure tax rate and tax amount is updated accordingly
  8. Ensure system message only displays amount and currency change
  • Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Precondition:

  • Workspace has enabled tax rate.
  • Workspace currency default and Foreign currency default are different.
  1. Go to staging.new.expensify.com
  2. Go to workspace chat.
  3. Go offline.
  4. Submit an expense in local currency.
  5. Go to transaction thread.
  6. Click Amount and change it to a foreign currency.
  7. Ensure tax rate and tax amount is updated accordingly
  8. Ensure system message only displays amount and currency change
  • 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 See MacOS: Chrome / Safari
Android: mWeb Chrome See MacOS: Chrome / Safari
iOS: Native See MacOS: Chrome / Safari
iOS: mWeb Safari See MacOS: Chrome / Safari
MacOS: Chrome / Safari
Screen.Recording.2024-05-14.at.11.25.08.AM.mov
MacOS: Desktop See MacOS: Chrome / Safari

@MonilBhavsar MonilBhavsar self-assigned this May 14, 2024
@MonilBhavsar MonilBhavsar requested a review from a team as a code owner May 14, 2024 05:49
@melvin-bot melvin-bot bot requested review from rojiphil and removed request for a team May 14, 2024 05:49
Copy link

melvin-bot bot commented May 14, 2024

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

@MonilBhavsar
Copy link
Contributor Author

@rojiphil are you available to review this PR?

@rojiphil
Copy link
Contributor

are you available to review this PR?

@MonilBhavsar Yes. reviewing.

@MonilBhavsar
Copy link
Contributor Author

Thank you!

@MonilBhavsar
Copy link
Contributor Author

How's it going here

if (!transaction?.amount) {
return;
}
const transactionTaxCode = transaction?.taxCode ?? '';
const defaultTaxCode = TransactionUtils.getDefaultTaxCode(policy, transaction) ?? '';
const defaultTaxCode = TransactionUtils.getDefaultTaxCode(policy, transaction, currency) ?? '';
const taxPercentage = TransactionUtils.getTaxValue(policy, transaction, transactionTaxCode ?? defaultTaxCode) ?? '';
Copy link
Contributor

Choose a reason for hiding this comment

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

Just one issue I notice here. Otherwise this works fine.
Currently, the tax code and tax amount does not correlate correctly as displayed below. I think this is because we are giving preference to transactionTaxCode over defaultTaxCode here.
When a currency changes, is it intentional to reset the tax code to the default one (i.e. Foreign or workspace) even when the transaction tax code is set to a non-default one?

42128-web-chrome.mp4

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When a currency changes, is it intentional to reset the tax code to the default one (i.e. Foreign or workspace) even when the transaction tax code is set to a non-default one?

Yes!

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok. Got it. Thanks. Now I know what is expected here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for clarifying!

When a currency changes, is it intentional to reset the tax code to the default one (i.e. Foreign or workspace) even when the transaction tax code is set to a non-default one?

Also, this is behavior server side. When online if currency is changed, then server will update taxRate and hence taxAmount

Copy link
Contributor

Choose a reason for hiding this comment

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

Just digged in a little deeper. Would the following solve this issue?

    const transactionCurrency = TransactionUtils.getCurrency(transaction);
    const taxCode = ((transactionCurrency !== currency) ?  defaultTaxCode : transactionTaxCode) ??  defaultTaxCode;
    const taxPercentage = TransactionUtils.getTaxValue(policy, transaction, taxCode) ?? '';

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It would, but we have this similar logic to get taxCode in getDefaultTaxCode() that is used by other functions too, so let's use it

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 the logic within getDefaultTaxCode() and here are not similar. The reasoning being that getDefaultTaxCode() returns one of the default tax codes whereas we want to choose to return either transaction’s tax code or default tax code here. But I may be missing your point. Once the code changes are done, I will take a look.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, i think I am getting the issue now

@rojiphil
Copy link
Contributor

rojiphil commented May 14, 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

MacOS: Chrome / Safari
42128-web-safari-01.mp4
Android: Native
42128-android-native-01.mp4
Android: mWeb Chrome
42128-mweb-chrome-01.mp4
iOS: Native
42128-ios-native-01.mp4
iOS: mWeb Safari
42128-mweb-safari-01.mp4
MacOS: Desktop
42128-desktop-01.mp4

@rojiphil
Copy link
Contributor

@MonilBhavsar Oh! We have conflicts to address too.
Other than the issue mentioned here, the code looks good.
I can generate the test videos and complete the checklist when we are ready.

@Beamanator
Copy link
Contributor

Bump @rojiphil - any updates here? This fixes a deploy blocker so please make it high priority 🙏

@MonilBhavsar
Copy link
Contributor Author

MonilBhavsar commented May 14, 2024

Latest is here #42128 (comment)
I need to take a look at this comment

I'm tackling another one in parallel. Should be back here once I submit another one for review

@rojiphil
Copy link
Contributor

any updates here? This fixes a deploy blocker so please make it high priority

@Beamanator Sure. This is taken with high priority. The latest update here is that we have an issue that is being worked upon here

@Beamanator
Copy link
Contributor

Ahaa, thanks gents!! 🙏

@MonilBhavsar
Copy link
Contributor Author

This is ready for review/test. Thank you @rojiphil for detailed testing and drawing my attention!

Copy link
Contributor

@rojiphil rojiphil left a comment

Choose a reason for hiding this comment

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

Code looks super good. But I have just one additional comment. Please do have a look.
Post your feedback I would go ahead and complete the checklist. Thanks.

const taxAmount = getTaxAmount(transaction, policy, newAmount);
// If currency has changed, then we get the default tax rate based on currency, otherwise we use the current tax rate selected in transaction, if we have it.
const transactionTaxCode = transaction?.taxCode ?? '';
const taxCode = currency !== transactionCurrency ? TransactionUtils.getDefaultTaxCode(policy, transaction, currency) ?? '' : transactionTaxCode;
Copy link
Contributor

Choose a reason for hiding this comment

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

Since transactionTaxCode may return empty, can we fallback to defaultTaxCode as getDefaultTaxCode() is always guaranteed to return a valid value?
Something like this:

const defaultTaxCode = TransactionUtils.getDefaultTaxCode(policy, transaction, currency);
const taxCode = (currency !== transactionCurrency ? defaultTaxCode : transactionTaxCode) ?? defaultTaxCode;

This way, we can avoid taxCode being empty. This also aligns with the existing implementation i.e. transactionTaxCode ?? defaultTaxCode where we fallback to the default one if transactionTaxCode is empty. This will also help us keep any possible regressions at bay.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. Updated!

Copy link
Contributor

@rojiphil rojiphil 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 tests well too.
Checklist completed.

@melvin-bot melvin-bot bot requested a review from cristipaval May 14, 2024 18:07
Copy link

melvin-bot bot commented May 14, 2024

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

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

LGTM!

@Beamanator Beamanator merged commit 0d424d2 into main May 14, 2024
16 of 17 checks passed
@Beamanator Beamanator deleted the monil-fixOfflineCurrencyTaxUpdate branch May 14, 2024 18:35
OSBotify pushed a commit that referenced this pull request May 14, 2024
…pdate

[CP Staging] Fix tax rate being updated when currency is updated in offline mode

(cherry picked from commit 0d424d2)
@Beamanator
Copy link
Contributor

This successfully got deployed to Desktop and Web in https://github.com/Expensify/App/actions/runs/9084540534

And it should have been deployed to android & iOS in a following CP (there were 2 more last night)

@Beamanator
Copy link
Contributor

@rojiphil @MonilBhavsar are either of you around to test this in staging?

@rojiphil
Copy link
Contributor

are either of you around to test this in staging?

Works well on staging for me

20240515_122012.mp4

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

4 participants