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

Corrected Currency Display: Enforce Two Decimal Places in Amounts #35797

Conversation

abzokhattab
Copy link
Contributor

Details

Fixed Issues

$ #34894
$ #34894 (comment)

Tests

  • Verify that no errors appear in the JS console
  1. Navigate to FAB (Floating Action Button)
  2. Select Request Money
  3. Select manual
  4. Enter an amount that has a last decimal digit as 0 (e.g. 23.20)
  5. click on Next > go back using the header back button
  6. Ensure the amount shown to the user is the same as in step 4

Offline tests

  1. Navigate to FAB (Floating Action Button)
  2. Select Request Money
  3. Select manual
  4. Enter an amount that has a last decimal digit as 0 (e.g. 23.20)
  5. click on Next > go back using the header back button
  6. Ensure the amount shown to the user is the same as in step 4

QA Steps

  • Verify that no errors appear in the JS console
  1. Navigate to FAB (Floating Action Button)
  2. Select Request Money
  3. Select manual
  4. Enter an amount that has a last decimal digit as 0 (e.g. 23.20)
  5. click on Next > go back using the header back button
  6. Ensure the amount shown to the user is the same as in step 4

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
      • 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

Android: Native
Screen.Recording.2024-02-02.at.2.15.48.AM.mov
Android: mWeb Chrome
Screen.Recording.2024-02-05.at.10.21.39.AM.mov
iOS: Native
Screen.Recording.2024-02-02.at.2.15.48.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-02-05.at.10.21.39.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-05.at.10.20.36.AM.mov
MacOS: Desktop
Screen.Recording.2024-02-05.at.10.20.59.AM.mov

@abzokhattab abzokhattab requested a review from a team as a code owner February 5, 2024 08:39
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team February 5, 2024 08:39
Copy link

melvin-bot bot commented Feb 5, 2024

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

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Feb 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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
24-03-19-17-19-43.mp4
Android: mWeb Chrome
Screen.Recording.2024-03-19.at.17.36.21.mov
iOS: Native
Screen.Recording.2024-03-19.at.17.24.48.mov
iOS: mWeb Safari
Screen.Recording.2024-03-19.at.17.28.12.mov
MacOS: Chrome / Safari
Screen.Recording.2024-03-19.at.17.39.29.mov
MacOS: Desktop
Screen.Recording.2024-03-19.at.17.22.21.mov

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

Bug:

  1. Open any 1:1 chat
  2. Press '+' button -> Request Money
  3. Enter an amount without the decimal point (i.e. "5")
  4. Click "Next"
  5. Click "Back"
  6. Notice the amount is now "5.00"
Screen.Recording.2024-02-06.at.15.22.18.mov

This is kind of an edge case, this comment explains it well

you're not wrong #34894 (comment), it's not quite consistent, but I think if the user has JUST entered a value, we'd want to maintain it as is, making it easier for the user to fix if needed. This is also how Square Cash and Venmo do it, as a reference.

@abzokhattab
Copy link
Contributor Author

done .. please review the latest change

@eVoloshchak
Copy link
Contributor

This is still present
It should work this way for any number, not just for numbers without the decimal point
https://github.com/Expensify/App/assets/9059945/9e1df7c0-d730-4ed8-877f-4d975db2cc06

@abzokhattab
Copy link
Contributor Author

abzokhattab commented Feb 9, 2024

This is still present
It should work this way for any number, not just for numbers without the decimal point
https://github.com/Expensify/App/assets/9059945/9e1df7c0-d730-4ed8-877f-4d975db2cc06

@eVoloshchak why do you consider the case mentioned in the video attached as a bug, i think it makes sense to be converted to 8.90.

the thing is, the amount of the transaction is saved as a number in the server and either you enter 8.90 or 8.9 it will be converted to 8.9 when saving it as a number so what you are requesting requires changing the type of this var to string so that the value is shown as it was entered. this change will need lots of change as well in the frontend since the transaction amount is used in many locations

@eVoloshchak
Copy link
Contributor

why do you consider the case mentioned in the video attached as a bug, i think it makes sense to be converted to 8.90

@abzokhattab, this isn't a bug per se, but I agree with this comment

but I think if the user has JUST entered a value, we'd want to maintain it as is, making it easier for the user to fix if needed. This is also how Square Cash and Venmo do it, as a reference.

The key here is we shouldn't change the amount if user JUST entered it. Say, you enter 8.8, click 'Next' and immediatelly come back wanting to change it. If it's immediately converted to 8.80, you have one additional keypress to do (and it's much worse for 8.00)

@abzokhattab
Copy link
Contributor Author

Do you mean that we should only add a new var (amountString) in the transaction optimistic values, which represents the precise amount entered by the user, however, this value will not be saved in the db is that right?

@eVoloshchak
Copy link
Contributor

Video below demonstrates the desired behavior
https://github.com/Expensify/App/assets/9059945/460be79a-3b96-4eb5-8b25-dc7f8696e889

Essentially, if you enter an amount, press next and then immediately press 'Back', amount should stay the same.
But if you enter an amount, press next and then press on amount to edit it, it should be displayed with two decimal places

@abzokhattab
Copy link
Contributor Author

abzokhattab commented Feb 18, 2024

Okay, i removed the logic that updates the amount on clicking on next below:

https://github.com/Expensify/App/blob/39b575c6af3c1442e9452aadbb79b403b40964e6/src/pages/iou/steps/MoneyRequestAmountForm.js#L240-#L243

but this will cause this issue again as a regression, so if we are fine with that we can move forward.

here the result:

Screen.Recording.2024-02-18.at.11.31.13.PM.mov

@eVoloshchak
Copy link
Contributor

@abzokhattab, this doesn't seem to work correctly, I can still see the same bug

Screen.Recording.2024-02-21.at.20.06.12.mov

@abzokhattab
Copy link
Contributor Author

abzokhattab commented Feb 22, 2024

@eVoloshchak okay done

please be aware that this change will cause those issues, if we are fine with this new approach then we can discard them
#33125 #33123 #30505

@eVoloshchak
Copy link
Contributor

@abzokhattab, took a look at #33125 #33123 #30505, we're definitely don't want those issues to come back
Let's look for another approach

@abzokhattab
Copy link
Contributor Author

do you have any idea in mind, I agree that we shouldn't bring them back,

the problem is with this useEffect which updates the amount whenever the value changes

useEffect(() => {
if (!currency || typeof amount !== 'number') {
return;
}
initializeAmount(amount);
// we want to re-initialize the state only when the selected tab or amount changes
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [selectedTab, amount]);

however, i think we shouldn't remove it , let me know if you have any approach in mind or what should we do in this case.

Thanks @eVoloshchak

@abzokhattab
Copy link
Contributor Author

kindly reminder @eVoloshchak

@abzokhattab
Copy link
Contributor Author

@dangrous okay i added some tests for the edge cases ... please let me now if you have any other comments.

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.

One minor change just to make typescript happy!

tests/unit/CurrencyUtilsTest.ts Outdated Show resolved Hide resolved
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.

cool, this looks good to me!

dangrous
dangrous previously approved these changes Apr 1, 2024
@dangrous
Copy link
Contributor

dangrous commented Apr 1, 2024

aw shoot, I was slow - can you update the merge conflicts @abzokhattab? Then we should be good to go

@abzokhattab abzokhattab force-pushed the preserving-the-transactions-amounts-the-same-as-the-user-entered branch from 4d26474 to 89d4d77 Compare April 1, 2024 20:59
@abzokhattab
Copy link
Contributor Author

There we go @dangrous

@dangrous
Copy link
Contributor

dangrous commented Apr 2, 2024

arggghhh sorry. One more time? I'll keep this tab open so it hopefully doesn't happen again

@abzokhattab
Copy link
Contributor Author

arggghhh sorry. One more time? I'll keep this tab open so it hopefully doesn't happen again

😂😂😂😂 hopefully this is the last time.

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.

Let's do it!

@dangrous dangrous merged commit 4fcd8a1 into Expensify:main Apr 3, 2024
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Apr 3, 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.

@iwiznia
Copy link
Contributor

iwiznia commented Apr 4, 2024

Reverting due to #39599

@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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.

5 participants