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

Fix currency handling - always handle backend amounts as if they are in cents #24175

Merged
merged 16 commits into from
Aug 16, 2023

Conversation

aldo-expensify
Copy link
Contributor

@aldo-expensify aldo-expensify commented Aug 4, 2023

Details

The backend ALWAYS stores "cents" for transactions and reports, it doesn't matter if the currency has 0, 1, 2 or 10 decimals.

The frontend at some point started sending something different when we started diving the "frontend amount" by a number depending on the number of decimals of the currency:

0 decimals currency -> divide by 0
1 decimals currency -> divide by 10
2 decimals currency -> divide by 100
3 decimals currency -> divide by 1000

This is wrong, they always should be multiplied and divided by 100 to convert.

The library used in the backend and the library used in the frontend (Intl) format the RSD currency with 0 decimals. A client needed decimals, so we updated the backend to display RSD with two decimals.
Now, we have to force the frontend to also do the same so we don't get bug reports because of inconsistent behaviour.

PayPal: The URL for paying with paypal is generated correctly for any currency now.

When we split a bill, we need to consider the number of decimals of a currency so we don't produce amounts that are incompatible with the number of decimals of the currency. After splitting, it returns back to the format of "cents" that we use for storing amounts.

Fixed Issues

$ #23235
$ https://github.com/Expensify/Expensify/issues/300539
$ #19792
$ #24510

PROPOSAL:

Tests

Request money, verify decimals

  1. Create money requests in currencies that have decimals and currencies without decimals, for example:
    • BHD: 3 decimals, the third decimal will be truncated because we can't store it in the database, but it still should display with 3 decimal places after the . (the third decimal will always be a 0)
    • JPY: 0 decimals
    • VND: 0 decimals
    • USD: 2 decimals
    • RSD: 2 decimals (special case, should be tested)
  2. Verify that the LHN preview looks correctly formatted and inside the chats too. You should verify that the offline optimistic data is also correct.

Verify paypal payment URL

  1. Add Paypal as a payment method
  2. Create a workspace
  3. In your workspace expense chat, request money in USD (may require tweaking beta permissions to be able to do this)
  4. Try to pay with paypal
  5. Verify that the URL and the Paypal page shows the right amount in USD
  6. Go to the workspace settings
  7. Change the workspace's currency to JPY
  8. In your workspace expense chat, request money in JPY (may require tweaking beta permissions to be able to do this)
  9. Try to pay with paypal
  10. Verify that the URL and the Paypal page shows the right amount in JPY

Verify split bill amounts

  1. Start a bill split from the green + button in the top left corner
  2. Choose 10 JPY
  3. Add 3 other accounts to the split (your account is the 4th account)
  4. Verify that the split is 3 JPY, 3 JPY, 3 JPY and 1 JPY for you (the account making the split)
  5. Do another split with other 3 accounts, but choose 10 USD as the amount
  6. Verify that each part is 2.5 USD
  • Verify that no errors appear in the JS console

Offline tests

Same as the "online", just check that the currencies amounts are correctly formatted.

QA Steps

  1. Create money requests in currencies that have decimals and currencies without decimals, for example:
    • BHD: 3 decimals, the third decimal will be truncated because we can't store it in the database, but it still should display with 3 decimal places after the . (the third decimal will always be a 0)
    • JPY: 0 decimals
    • VND: 0 decimals
    • USD: 2 decimals
    • RSD: 2 decimals (special case, should be tested)
  2. Verify that the LHN preview looks correctly formatted and inside the chats too. You should verify that the offline optimistic data is also correct.

Verify paypal payment URL

  1. Add Paypal as a payment method
  2. Create a workspace
  3. In your workspace expense chat, request money in USD (may require tweaking beta permissions to be able to do this)
  4. Try to pay with paypal
  5. Verify that the URL and the Paypal page shows the right amount in USD
  6. Go to the workspace settings
  7. Change the workspace's currency to JPY
  8. In your workspace expense chat, request money in JPY (may require tweaking beta permissions to be able to do this)
  9. Try to pay with paypal
  10. Verify that the URL and the Paypal page shows the right amount in JPY

Verify split bill amounts

  1. Start a bill split from the green + button in the top left corner
  2. Choose 10 JPY
  3. Add 3 other accounts to the split (your account is the 4th account)
  4. Verify that the split is 3 JPY, 3 JPY, 3 JPY and 1 JPY for you (the account making the split)
  5. Do another split with other 3 accounts, but choose 10 USD as the amount
  6. Verify that each part is 2.5 USD
  • 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 / Chrome
    • iOS / native
    • iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2023-08-04.at.5.16.05.PM.mov
Screen.Recording.2023-08-04.at.5.17.36.PM.mov
Screen.Recording.2023-08-04.at.5.56.17.PM.mov

Paypal:

Screen.Recording.2023-08-04.at.6.14.12.PM.mov

Split bill:

Screenshot 2023-08-14 at 4 40 07 PM Screenshot 2023-08-14 at 4 40 20 PM
Mobile Web - Chrome
Mobile Web - Safari
Screen.Recording.2023-08-04.at.5.44.28.PM.mov
Desktop
Screen.Recording.2023-08-04.at.5.23.57.PM.mov
iOS
Screen.Recording.2023-08-04.at.5.39.51.PM.mov
Android

@aldo-expensify aldo-expensify mentioned this pull request Aug 4, 2023
57 tasks
@aldo-expensify aldo-expensify marked this pull request as ready for review August 4, 2023 23:44
@aldo-expensify aldo-expensify requested a review from a team as a code owner August 4, 2023 23:44
@melvin-bot melvin-bot bot requested review from thesahindia and removed request for a team August 4, 2023 23:44
@melvin-bot
Copy link

melvin-bot bot commented Aug 4, 2023

@thesahindia 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 requested review from sobitneupane and a team and removed request for thesahindia August 4, 2023 23:45
@melvin-bot melvin-bot bot requested review from MariaHCD and removed request for a team August 4, 2023 23:45
@melvin-bot
Copy link

melvin-bot bot commented Aug 4, 2023

@thesahindia @MariaHCD One of you needs to 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 thesahindia August 4, 2023 23:45
@aldo-expensify
Copy link
Contributor Author

Reassigned review to @sobitneupane since they are the C+ here: #23235

@aldo-expensify aldo-expensify removed the request for review from thesahindia August 5, 2023 00:18
@aldo-expensify
Copy link
Contributor Author

My Android dev environment is not working at the moment, so I wasn't able to take videos and test. I don't think this is platform dependent at all.

@aimane-chnaif
Copy link
Contributor

My Android dev environment is not working at the moment

@aldo-expensify are you facing the same issue as https://expensify.slack.com/archives/C01GTK53T8Q/p1691020867484089 or another one?


// We are forcindg the number of decimals because we overridden the default number of decimals in the backend for RSD
// See: https://github.com/Expensify/PHP-Libs/pull/834
minimumFractionDigits: currency === 'RSD' ? getCurrencyDecimals(currency) : undefined,
Copy link
Contributor Author

@aldo-expensify aldo-expensify Aug 5, 2023

Choose a reason for hiding this comment

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

The library used in the backend and the library used in the frontend (Intl) format the RSD currency with 0 decimals. A client needed decimals, so we updated the backend to display RSD with two decimals.
Now, we have to force the frontend to also do the same so we don't get bug reports because of inconsistent behaviour.

I ONLY enabled this for RSD because otherwise the formatting will be inconsistent between backend and frontend for currencies with more than 2 decimals.

@@ -622,7 +622,6 @@
"RSD": {
"symbol": "РСД",
"name": "Serbian Dinar",
"decimals": 0,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@aldo-expensify
Copy link
Contributor Author

Hmm, I brought back an issue that happens when splitting JPY (or other currencies with less decimals):

image

The splitted amounts don't add up to the total.

I'll make this a draft meanwhile I fix that again.

@aldo-expensify
Copy link
Contributor Author

Split bill amount doesn't add up to total. In the following screenshot, all the splits sums to $10.11 (expected: $10.12) which is not the case in staging.

Screenshot 2023-08-15 at 20 13 05

Good catch, it seems to be due to precision errors for decimal numbers operations:

image

I'll fix it and add a test

@aldo-expensify
Copy link
Contributor Author

@aldo-expensify RSD in LHN doesn't have decimals

Screenshot 2023-08-15 at 19 32 46

Seems like this is backend problem. I can see the payload of the RequestMoney request including the decimals (1012), but the response has removed them.

Payload:

Screenshot 2023-08-15 at 11 47 55 AM

Response:

image

The front end optimistic data seems to be doing it well:

image

Please ignore this problem when reviewing, I'll take care of it in a follow up PR

@aldo-expensify
Copy link
Contributor Author

aldo-expensify commented Aug 15, 2023

@sobitneupane thanks for the thorough review, you can continue the rest:

  • 10.12 USD splitting incorrectly: Fixed ✅
  • 10.12 RSD showing as 10 RSD in the LHN: backend bug, I'll fix it in a follow up, I don't want to hold this PR on that because it keeps running into conflicts.

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

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 / Chrome
    • iOS / native
    • iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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(themeColors.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 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.

@melvin-bot melvin-bot bot requested a review from Gonals August 16, 2023 09:28
@melvin-bot
Copy link

melvin-bot bot commented Aug 16, 2023

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

MariaHCD
MariaHCD previously approved these changes Aug 16, 2023
src/libs/CurrencyUtils.js Outdated Show resolved Hide resolved
Co-authored-by: Maria D'Costa <maria@expensify.com>
@aldo-expensify
Copy link
Contributor Author

Fixed the comment with the suggested changes

@MariaHCD MariaHCD merged commit ae6dd7e into main Aug 16, 2023
@MariaHCD MariaHCD deleted the aldo_fix-decimals branch August 16, 2023 18:10
@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/MariaHCD in version: 1.3.55-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/MariaHCD in version: 1.3.56-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

@rayane-djouah
Copy link
Contributor

FYI, this PR didn't catch that the BE only supports up to two decimal places and users can't enter more than two decimals in the amount field in the app. There's a mismatch because although users can't put in more than two decimals, the third decimal shows as zero on the IOU confirmation page and elsewhere in the app for currencies (like BHD) that use more than 2 decimals. We fixed it by setting maximumFractionDigits to 2 in NumberFormatOptions, so now any currency with more than 2 decimals will only show two in the UI. more details here: #43945 (comment)

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.

7 participants