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

Revert "Revert "Handle tax for split requests"" and fix reported bugs #42737

Merged
merged 13 commits into from
Jun 6, 2024

Conversation

MonilBhavsar
Copy link
Contributor

@MonilBhavsar MonilBhavsar commented May 29, 2024

Reverts #42670

Details

Pass taxCode and taxAmount to Split API commands.
Tracks tax both online and offline optimistically for split expense with policy expense chat

Fixed Issues

$ #39690
PROPOSAL:

Tests

Same as QA steps

And test #42642

  1. Create a split scan.
  2. When the receipt is scanning, click on the split preview.
  3. Click Amount.
  4. Change the currency to foreign currency.
  5. Enter amount and save it.
  6. Click Tax rate.
  7. Ensure no duplicate tax rates are rendered

And test #42649

  1. Create a split scan expense
  2. While the receipt is scanning, click on the split preview
  3. Click Amount and enter amount
  4. Click Tax rate and select a non-zero tax rate
  5. Click Tax amount
  6. Click Save without modifying the current value
  7. Ensure tax amount is saved and no error is displayed

And test #42682

  1. Navigate to a workspace chat
  2. Click '+' icon > Split expense > Enter amount > Select a tax rate
  3. Change the previously selected tax rate with a new rate
  4. Verify Tax amount should be updated with the new tax rate

And test #42655

  1. Submit expense to any user.
  2. Go to transaction thread.
  3. Click Amount.
  4. Click on the currency.
  5. Select a different currency.
  6. Verify new currency was saved
  • Verify that no errors appear in the JS console

Offline tests

Same as QA steps

QA Steps

Prerequisite: Tax is enabled on workspace

  1. Go to FAB > Split > Select a workspace chat
  2. Ensure tax rate and tax amount are selected
  3. Update currency, expense amount and tax rate and ensure tax rate and tax amount are updated accordingly. Note the taxAmount at this point
  4. Split the expense
  5. Go to money request with workspace and ensure tax rate is selected as it is and tax amount is divided by half

Now we repeat by splitting with individuals

  1. Go to FAB > Split > Select a workspace chat
  2. Ensure tax rate and tax amount are not displayed
  3. Go to individual money requests and ensure tax rate and tax amount are no displayed
  4. Repeat for offline

Testing split scans

  1. Go to FAB and select Split Expense and select Scan
  2. Add a receipt
  3. While in scanning state, update tax rate and ensure tax rate and tax amount are updated in draft transaction accordingly and no API call is being made
  4. While in scanning state, update tax amount and ensure tax amount are updated in draft transaction accordingly and no API call is being made
  5. While in scanning state, update expense amount and currency and ensure tax rate and tax amount are updated in draft transaction accordingly and no API call is being made
  • 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

https://drive.google.com/file/d/1C6T9vQ1VwujJJKlCbNNo8cZ_udQZmc3W/view?usp=sharing

Screenshot 2024-05-29 at 4 37 03 PM Screenshot 2024-05-29 at 4 47 55 PM
MacOS: Desktop See MacOS: Chrome / Safari

@MonilBhavsar MonilBhavsar self-assigned this May 29, 2024
@MonilBhavsar MonilBhavsar marked this pull request as ready for review May 29, 2024 12:33
@MonilBhavsar MonilBhavsar requested a review from a team as a code owner May 29, 2024 12:33
@melvin-bot melvin-bot bot requested review from dukenv0307 and removed request for a team May 29, 2024 12:33
Copy link

melvin-bot bot commented May 29, 2024

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

@dukenv0307 I'm back with a followup PR. I have updated tests section to test and address deploy blockers created on former PR. Please take a look, thank you!

@dukenv0307
Copy link
Contributor

While in scanning state, update tax amount and ensure tax amount are updated in draft transaction accordingly and no API call is being made

@MonilBhavsar This step is failed.

  1. Go to FAB and select Split Expense
  2. Enter large amount with currency VND
  3. Go to confirmation page
  4. Edit tax amount
  5. Observe that users can not delete the amount from right to left, but they can replace it with other one
Screen.Recording.2024-05-30.at.11.27.57.mov

@MonilBhavsar
Copy link
Contributor Author

@dukenv0307 sorry, I am not understanding it. Could you please explain it again. In Video, i see you're only updating taxAmount?

@dukenv0307
Copy link
Contributor

web-resize.mp4

@MonilBhavsar Pls check this video. Nothing happens when I press the delete button.

@MonilBhavsar
Copy link
Contributor Author

This happens on staging too and is specific to currencies like VND where we don't support decimals. I would address that in another issue and PR

@trjExpensify
Copy link
Contributor

With that cleared up, @dukenv0307. Can you complete the review?

@dukenv0307
Copy link
Contributor

Ah thank you, I'll finish reviewing in an hour

@dukenv0307
Copy link
Contributor

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
Screen.Recording.2024-05-24.at.11.11.22.mov
Android: mWeb Chrome
web-resize.mp4
iOS: Native
web-resize.mp4
iOS: mWeb Safari
web-resize.10.30.52.mp4
MacOS: Chrome / Safari
web-resize.mp4
web-resize.mp4
web-resize.mp4
web-resize.mp4
web-resize.mp4
web-resize.mp4
web-resize.mp4
MacOS: Desktop
web-resize.mp4

}, []);

useEffect(() => {
if (!shouldShowTax || prevTaxAmount !== transaction?.taxAmount || (prevAmount === transaction?.amount && prevCurrency === transaction?.currency)) {
Copy link
Contributor

@dukenv0307 dukenv0307 May 31, 2024

Choose a reason for hiding this comment

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

@MonilBhavsar Is this expectation? This is inconsistency with the below flow where the new amount is saved

  1. Create a split scan.
  2. When the receipt is scanning, click on the split preview.
  3. Edit tax amount
  4. Save it
  5. Reload page
  6. Observe the new amount is saved
web-resize.mp4

Copy link
Contributor Author

@MonilBhavsar MonilBhavsar May 31, 2024

Choose a reason for hiding this comment

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

What do you think should be expected behavior here?
The expense amount is also saved in a similar way, so looks good to me

Copy link
Contributor

@dukenv0307 dukenv0307 Jun 3, 2024

Choose a reason for hiding this comment

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

The expense amount is also saved in a similar way

@MonilBhavsar Sorry, I don't understand your mean. Pls check the video below, the expense amount is saved but tax amount.

web-resize.mp4

I'm not sure, if it's the expectation we can go ahead

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah okay, I got you're saying now. Looking

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dukenv0307 I have fixed this bug. Hopefully, I didn't break anything in fixing it 🙏

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks, I'll re-check again

@MonilBhavsar MonilBhavsar mentioned this pull request May 31, 2024
50 tasks
@dukenv0307
Copy link
Contributor

overall, it looks good, I just left a minor comment ^

@dukenv0307
Copy link
Contributor

I re-tested and they worked well

@melvin-bot melvin-bot bot requested a review from dangrous June 4, 2024 03:35
Copy link

melvin-bot bot commented Jun 4, 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]

@MonilBhavsar
Copy link
Contributor Author

Resolved conflicts

@dangrous
Copy link
Contributor

dangrous commented Jun 4, 2024

I can look today but now there are conflicts - I'll start my review and see how far I get, and can finish up post-conflicts tomorrow!

@MonilBhavsar
Copy link
Contributor Author

Okay thanks! I'll make sure to resolve it before Mountain time, so we don't get it again 😅

dangrous
dangrous previously approved these changes Jun 5, 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.

Okay this looks good to me! I can take another final look (and merge) once conflicts are resolved.

@MonilBhavsar
Copy link
Contributor Author

@dangrous thanks! Conflicts resolved. Doing a quick test

@MonilBhavsar
Copy link
Contributor Author

tested again and works fine!
In last commit, I moved code around, so it does not show up in difference unnecessarily

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.

Looks good! Do we think @dukenv0307 should give it one more set of tests, since there have been some changes since last time, or am I good to merge?

@MonilBhavsar
Copy link
Contributor Author

Okay cool! @dukenv0307 could you please take a final look, please 🙇

@trjExpensify
Copy link
Contributor

Were the changes material?

@dukenv0307
Copy link
Contributor

will give the final feedback soon

@dukenv0307
Copy link
Contributor

works well. We're good to merge

@MonilBhavsar
Copy link
Contributor Author

Nice, thanks for checking!

@MonilBhavsar MonilBhavsar merged commit 0ae7feb into main Jun 6, 2024
15 checks passed
@MonilBhavsar MonilBhavsar deleted the revert-42670-revert-40240-monil-splitBillTaxUpdate branch June 6, 2024 05:21
@OSBotify
Copy link
Contributor

OSBotify commented Jun 6, 2024

✋ 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 production by https://github.com/luacmartins in version: 1.4.81-11 🚀

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

const transactionCurrency = TransactionUtils.getCurrency(transaction);
if (newAmount === TransactionUtils.getAmount(transaction) && currency === transactionCurrency) {
const transactionCurrency = TransactionUtils.getCurrency(currentTransaction);
if (newAmount === TransactionUtils.getAmount(currentTransaction) && currency === transactionCurrency) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Changing how to get the transaction caused this blocker #43259

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