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

support for offline tax tracking #40443

Conversation

teneeto
Copy link
Contributor

@teneeto teneeto commented Apr 18, 2024

Details

This PR adds Support for tax tracking when offline.

Fixed Issues

$: 39616
PROPOSAL: 39616

Tests

  • Submit Expense
  1. Go to workspace chat.
  2. Start a Submit expense (money request) flow.
  3. In confirmation page, click Show more > Tax amount > Change Currency.
  4. Submit Expense
    Expectation: when currency is changed from Policy default currency to another currency then let's make sure we use tax rate as foreign default else it should remain as workspace default .
  • Edit Expense
  1. Go to transaction thread.
  2. Click and update expense amount or tax rate.
    Expectation: when changing request amount and tax rate offline, the tax amount will change accordingly and immediately.
  • Verify that no errors appear in the JS console

Offline tests

  • Submit Expense
  1. Go to workspace chat.
  2. Start a Submit expense (money request) flow.
  3. In confirmation page, click Show more > Tax amount > Change Currency.
  4. Submit Expense
    Expectation: when currency is changed from Policy default currency to another currency then let's make sure we use tax rate as foreign default else it should remain as workspace default .
  • Edit Expense
  1. Go to transaction thread.
  2. Click and update expense amount or tax rate.
    Expectation: when changing request amount and tax rate offline, the tax amount will change accordingly and immediately.

QA Steps

  • Submit Expense
  1. Go to workspace chat.
  2. Start a Submit expense (money request) flow.
  3. In confirmation page, click Show more > Tax amount > Change Currency.
  4. Submit Expense
    Expectation: when currency is changed from Policy default currency to another currency then let's make sure we use tax rate as foreign default else it should remain as workspace default .
  • Edit Expense
  1. Go to transaction thread.
  2. Click and update expense amount or tax rate.
    Expectation: when changing request amount and tax rate offline, the tax amount will change accordingly and immediately.
  • 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

MacOS: Chrome / Safari
Screen.Recording.2024-04-18.at.15.18.16.mov
iOS: Native
Android: Native
Android: mWeb Chrome
iOS: mWeb Safari
MacOS: Desktop

@teneeto teneeto changed the title Feature/39616/support for offline tax tracking support for offline tax tracking Apr 18, 2024
Copy link

melvin-bot bot commented May 9, 2024

🎯 @getusha, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #41881.

@getusha
Copy link
Contributor

getusha commented May 9, 2024

@teneeto could you just put the issue link like #39616 in the PR description?

@MonilBhavsar
Copy link
Contributor

MonilBhavsar commented May 10, 2024

I noticed a bug -

  1. Click on 'Submit expense'
  2. Change currency to other than default currency
  3. Ensure tax rate changes
  4. but tax amount is updated to zero (And then changing tax rate also does not update tax amount. Tax amount stays zero)

cc @teneeto @getusha

Looks like we're updating it correctly in draft transaction in Onyx, but not displaying it

Screenshot 2024-05-10 at 4 58 05 PM

See taxAmount in Onyx is 45 and in UI it is 0

@MonilBhavsar
Copy link
Contributor

See taxAmount in Onyx is 45 and in UI it is 0

This is bug with certain currencies where amount in small decimals is not supported. Not related to this PR

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. Let's ship it! 🚀

@MonilBhavsar MonilBhavsar merged commit 2e6e8ca into Expensify:main May 13, 2024
15 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.4.73-0 🚀

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

@Julesssss
Copy link
Contributor

Hey @teneeto @MonilBhavsar. I believe this deploy blocker was introduced by this large PR. Would you mind taking a look? As this is a huge PR reverting isn't going to be ideal so ideally we can get a quick fix submitted.

Comment on lines +131 to +132
taxCode,
taxAmount,
Copy link
Contributor

Choose a reason for hiding this comment

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

This is causing the deploy blocker: #42114 (comment)

@aldo-expensify aldo-expensify mentioned this pull request May 14, 2024
50 tasks
@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 ✅

@rushatgabhane
Copy link
Member

hey, this PR caused a blocker - #42045

const transactionChanges = {
taxCode,
...(taxAmount && {taxAmount}),
Copy link
Contributor

Choose a reason for hiding this comment

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

It caused this bug, when taxAmount is zero, the value will be ignored

const getTaxAmount = (transaction: OnyxEntry<OnyxTypes.Transaction>, policy: OnyxEntry<OnyxTypes.Policy>) => {
const defaultTaxCode = TransactionUtils.getDefaultTaxCode(policy, transaction) ?? '';

const taxPercentage = TransactionUtils.getTaxValue(policy, transaction, transaction?.taxCode ?? defaultTaxCode) ?? '';
Copy link
Contributor

Choose a reason for hiding this comment

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

When the currency differs from the current transaction currency, the taxCode should have also changed to the default (i.e. local or foreign based on the newly updated currency) tax rate. And, the tax amount should also have been recomputed. Missing these changes here resulted in issue #42049.

Comment on lines +382 to 384
if (transaction?.taxAmount && previousTransactionAmount === transaction?.amount && previousTransactionCurrency === transaction?.currency) {
return IOU.setMoneyRequestTaxAmount(transaction?.transactionID, transaction?.taxAmount, true);
}
Copy link
Contributor

@aldo-expensify aldo-expensify May 31, 2024

Choose a reason for hiding this comment

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

What is this block doing here? is it here in case the currency didn't change?

if transaction?.taxAmount && previousTransactionAmount, what is the purpose of calling IOU.setMoneyRequestTaxAmount? is the draft in a different state?

Comment on lines +677 to +683
const defaultTaxCode = () => {
if (!transaction) {
return defaultExternalID;
}

return policy && getDefaultTaxCode(policy, transaction);
};
Copy link
Contributor

Choose a reason for hiding this comment

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

@teneeto Why did we wrap this code in a function? Why didn't we just do something like:

const defaultTaxCode = !transaction ? defaultExternalID : policy && getDefaultTaxCode(policy, transaction);

Are you expecting that policy or transaction can mutate?

const moneyRequestTaxPercentage = (transaction?.taxRate ? transaction?.taxRate?.data?.value : defaultTaxValue) ?? '';
const editingTaxPercentage = (transactionTaxCode ? taxRates?.taxes[transactionTaxCode]?.value : moneyRequestTaxPercentage) ?? '';
const defaultTaxCode = TransactionUtils.getDefaultTaxCode(policy, transaction) ?? '';
const getTaxValue = (taxCode: string) => TransactionUtils.getTaxValue(policy, transaction, taxCode);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did we create this getTaxValue function, it is only used inside here, right? is it just to type getTaxValue(xxx) instead of TransactionUtils.getTaxValue(policy, transaction, taxCode)?

if (percentage) {
return TransactionUtils.calculateTaxAmount(percentage, amount);
function getTaxAmount(policy: OnyxEntry<Policy>, transaction: OnyxEntry<Transaction>, selectedTaxCode: string, amount: number): number | undefined {
const getTaxValue = (taxCode: string) => TransactionUtils.getTaxValue(policy, transaction, taxCode);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did we define a function here? this makes the code more confusing

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.

9 participants