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

Preserve transactions amount in create IOU #40062

Conversation

abzokhattab
Copy link
Contributor

@abzokhattab abzokhattab commented Apr 11, 2024

Details

Fixed Issues

$ #34894
$ #34894 (comment)

Tests

  • Verify that no errors appear in the JS console

In the meantime - do you mind updating the tests one more time? Sorry. Since we wrote them, we changed the design of the app so there's no longer a "Request money" option, it's "Submit expense" or "track expense". And the FAB is no longer Floating, though maybe we still call it that?

Test 1:

  1. Go to FAB >> Submit expense
  2. Select Manual
  3. Ensure that the input is not prefilled with 0.00

Test2:

  1. Go to FAB >> Submit expense
  2. Select Manual
  3. Enter an amount that has a last decimal digit as 0 (e.g. 23.20)
  4. click on Next > go back using the header back button
  5. Ensure the amount shown to the user is the same as in step 3

Test3:

  1. Create a random expense report
  2. Open the report and edit the amount so that the last decimal digit is 0 (e.g. 23.20)
  3. Open the report again
  4. Verify the amount is displayed correctly, the last digit is 0

Offline tests

Same as in tests

QA Steps

  • Verify that no errors appear in the JS console

same as in tests

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 April 11, 2024 02:15
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team April 11, 2024 02:15
Copy link

melvin-bot bot commented Apr 11, 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]

@abzokhattab
Copy link
Contributor Author

@dangrous I kept the amount check here and it fixed the zero issue:

const selectedAmountAsString = amount ? CurrencyUtils.convertToFrontendAmountAsString(amount) : '';

const frontendAmount = newAmount ? CurrencyUtils.convertToFrontendAmountAsString(newAmount) : '';

Result:

Screen.Recording.2024-04-11.at.4.16.25.AM.mov

@dangrous
Copy link
Contributor

@eVoloshchak can you give this a look? Looks like we've got some new merge conflicts too, @abzokhattab

@abzokhattab
Copy link
Contributor Author

Resolved the conflicts .. please let me know if you have any other comments

@eVoloshchak
Copy link
Contributor

I'm too late again, apologies @abzokhattab, could you resolve the conflicts again?

@abzokhattab
Copy link
Contributor Author

oh, okay resolved them :D @eVoloshchak

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Apr 18, 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

Android: Native
Screen.Recording.2024-04-19.at.00.04.02.mov
Android: mWeb Chrome
Screen.Recording.2024-04-19.at.00.00.34.mov
iOS: Native
Screen.Recording.2024-04-19.at.00.04.45.mov
iOS: mWeb Safari
Screen.Recording.2024-04-19.at.00.02.28.mov
MacOS: Chrome / Safari
Screen.Recording.2024-04-18.at.23.58.34.mov
MacOS: Desktop
Screen.Recording.2024-04-18.at.23.59.25.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.

Tests well!

@melvin-bot melvin-bot bot requested a review from dangrous April 18, 2024 22:07
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.

Just one question - and now some merge conflicts - then i think we're good.

To note, too - our preserving of user input means that if a user enters 123.2 initially and then goes to the next screen and back, it's still 123.2 which is a little wonky? But as we discussed, we DO want that for 123 (no decimal) so I think it's probably fine. Just wanted to bring it up in case we wanted to discuss.

@@ -93,7 +97,7 @@ function MoneyRequestAmountForm(
const isTaxAmountForm = Navigation.getActiveRoute().includes('taxAmount');

const decimals = CurrencyUtils.getCurrencyDecimals(currency);
const selectedAmountAsString = amount ? CurrencyUtils.convertToFrontendAmount(amount).toString() : '';
const selectedAmountAsString = amount ? CurrencyUtils.convertToFrontendAmountAsString(amount) : '';
Copy link
Contributor

Choose a reason for hiding this comment

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

Won't this just return '' if we let the null amount go through?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes but if the amount is zero the convertToFrontendAmountAsString will return 0.00 which is not wanted.. so i kept that check to return "" in this specific case

@abzokhattab
Copy link
Contributor Author

abzokhattab commented Apr 23, 2024

But as we discussed, we DO want that for 123 (no decimal) so I think it's probably fine. Just wanted to bring it up in case we wanted to discuss it.

that would pass .. if the user enters 123 and goes back it will be the same. as per the requirement here

Screen.Recording.2024-04-23.at.6.58.19.AM.mov

cc @eVoloshchak

@abzokhattab
Copy link
Contributor Author

now some merge conflicts - then i think we're good.

conflicts are now resolved

@allgandalf
Copy link
Contributor

@abzokhattab @dangrous @eVoloshchak , I still think that my fix from the issue:

const initializeAmount = useCallback((newAmount) => {
   const frontendAmount = newAmount ? 
       (newAmount.includes('.') ? parseFloat(CurrencyUtils.convertToFrontendAmount(newAmount)).toFixed(2) : CurrencyUtils.convertToFrontendAmount(newAmount)) 
       : '';

Is a lot simpler fix for this issue, @abzokhattab can you test this one please, we need not be making such vast changes, this can possibly be dealt on the FE itself

@dangrous
Copy link
Contributor

more merge conflicts unfortunately - @eVoloshchak let us know when you can take a look, and if we can potentially simplify re: @GandalfGwaihir 's thought above (I haven't investigated yet). Thank you!

@eVoloshchak
Copy link
Contributor

@GandalfGwaihir, newAmount is Number, it doesn't support .includes() method for it (possibly component was migrated to ts recently?)

I cannot test this due to the above, but looking at the code it seems it doesn't implement the behavior described in #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.

Is that correct?

@dangrous
Copy link
Contributor

dangrous commented May 7, 2024

Bump on this thanks!

@dangrous dangrous assigned dangrous and abzokhattab and unassigned dangrous May 7, 2024
src/components/MoneyRequestAmountInput.tsx Outdated Show resolved Hide resolved
src/components/MoneyRequestAmountInput.tsx Outdated Show resolved Hide resolved
src/components/MoneyRequestAmountInput.tsx Outdated Show resolved Hide resolved
src/libs/CurrencyUtils.ts Show resolved Hide resolved
@@ -144,7 +148,7 @@ function MoneyRequestAmountForm(
}, [isFocused, wasFocused]);

const initializeAmount = useCallback((newAmount: number) => {
const frontendAmount = newAmount ? CurrencyUtils.convertToFrontendAmount(newAmount).toString() : '';
const frontendAmount = newAmount ? CurrencyUtils.convertToFrontendAmountAsString(newAmount).toString() : '';
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
const frontendAmount = newAmount ? CurrencyUtils.convertToFrontendAmountAsString(newAmount).toString() : '';
const frontendAmount = CurrencyUtils.convertToFrontendAmountAsString(newAmount);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this suggestion will cause this issue again

Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't this already handled in convertToFrontendAmountAsString?

  if (amountAsInt === null || amountAsInt === undefined) {
        return '';
  }

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not the same:

newAmount ? the question mark here checks if the value is null, undefined and not 0 so in case the value is 0 it goes to the else condition which returns an empty string ""

@dangrous
Copy link
Contributor

let us know if you have any questions on @eVoloshchak suggestions, @abzokhattab!

@abzokhattab
Copy link
Contributor Author

abzokhattab commented May 19, 2024

let us know if you have any questions on @eVoloshchak suggestions, @abzokhattab!

sorry I missed the notification.

here is the lastest test:

Screen.Recording.2024-05-19.at.7.05.31.PM.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.

Re-tested, looking good

@dangrous
Copy link
Contributor

This is looking good! One quick question - can we add testing steps to make sure we don't create #39599 and #39537 again? (And did we test for that here too?) Code looks ready to go I think - we're still on our merge "slush" though

@eVoloshchak
Copy link
Contributor

@abzokhattab, could you take a look at #40062 (comment) please?
(not urgent since we're in the merge freeze, but will be helpful when we do the final batch of tests on this PR)

@abzokhattab
Copy link
Contributor Author

I added another test to ensure that the input is not prefilled with 0.00

I think the PR is ready now

dangrous
dangrous previously approved these changes May 28, 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.

Looks good! Holding on the merge for now, though.

In the meantime - do you mind updating the tests one more time? Sorry. Since we wrote them, we changed the design of the app so there's no longer a "Request money" option, it's "Submit expense" or "track expense". And the FAB is no longer Floating, though maybe we still call it that?

Anyways, thanks for your work - and patience - on this!

@dangrous
Copy link
Contributor

Merge freeze is off so I think we're good to push this through once the tests are updated as noted above! (To be in line with new UI)

@abzokhattab
Copy link
Contributor Author

done .. just update the test 🎉

@dangrous
Copy link
Contributor

Great! But now conflicts 😂

@abzokhattab
Copy link
Contributor Author

Lol, this loop never ends 😂

Done .. maybe the last time .. maybe

@abzokhattab abzokhattab requested a review from dangrous May 29, 2024 19:33
@eVoloshchak
Copy link
Contributor

@abzokhattab, please add one more test from #34894

  1. Create a random expense report
  2. Open the report and edit the amount so that the last decimal digit is 0 (e.g. 23.20)
  3. Open the report again
  4. Verify the amount is displayed correctly, the last digit is 0

@abzokhattab
Copy link
Contributor Author

@eVoloshchak done

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.

kk, let's go for it!

@dangrous dangrous merged commit 4de7af8 into Expensify:main Jun 4, 2024
18 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jun 4, 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 ✅

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