fix: negative amount in settlement button when the unheld expense comes from self #51209

mkzie2 · 2024-10-21T23:02:55Z

Details

Fixed Issues

$ #50497
PROPOSAL: #50497 (comment)

Tests

[User A] Submit $100 to User B
[User B] Submit $20 to User A
Hold the IOU submitted by User A
Go to IOU report
Verify the amount in payment button in header matches the IOU report's Total
Go to A-B DM
Verify the amount in payment button in report preview matches the preview total
Press payment button
Verify These expenses are on hold. Do you want to pay anyway? modal displays

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

See Tests

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…es from self

melvin-bot · 2024-10-21T23:27:52Z

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

akinwale · 2024-10-28T22:01:17Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

51209-web.mp4

MacOS: Desktop

akinwale

LGTM.

Beamanator

Hmm I really don't think this new variable is intuitive.... The name is clear but reading this PR I as myself "Why" everywhere - I think we need a lot more comments 🙏

Do y'all think it's super clear why we pass this everywhere we added it? If not, it's def going to make everyone confused

…e/50497

mkzie2 · 2024-11-04T11:45:05Z

@Beamanator Can you elaborate which confusion did you face? I think these changes are straight-forward and comments might be redundant.

Beamanator · 2024-11-04T13:42:33Z

src/components/ReportActionItem/ReportPreview.tsx

@@ -230,7 +230,7 @@ function ReportPreview({
            return '';
        }

-        if (ReportUtils.hasHeldExpenses(iouReport?.reportID) && canAllowSettlement) {
+        if (ReportUtils.hasHeldExpenses(iouReport?.reportID) && canAllowSettlement && !isNonHeldAmountNegative) {


Here's an example of something not clear. Why don't we return nonHeldAmount here if ! isNonHeldAmountNegative?

@Beamanator As the original issue states, the nonHeldAmount amount can be negative if we hold a transaction. Since we cannot pay partially in this case, we shouldn't display the nonHeldAmount as the default option.

That's a great comment for this PR 🙏 Can you please add a comment like that here? & think about the other places you made similar changes - the point is so that other people can read the code & understand why isNonHeldAmountNegative is needed so they don't have to find the PR that made the change, then find the issue, then read to figure out the context

Added comments.

akinwale · 2024-11-08T10:41:29Z

@mkzie2 Any updates here?

akinwale

@mkzie2 A couple of changes required with respect to variable naming which would make it easier to understand the code in context. Thanks.

akinwale · 2024-11-12T10:41:38Z

src/components/ReportActionItem/ReportPreview.tsx

@@ -122,7 +122,7 @@ function ReportPreview({
    const [isPaidAnimationRunning, setIsPaidAnimationRunning] = useState(false);
    const [isHoldMenuVisible, setIsHoldMenuVisible] = useState(false);
    const [requestType, setRequestType] = useState<ActionHandledType>();
-    const [nonHeldAmount, fullAmount] = ReportUtils.getNonHeldAndFullAmount(iouReport, policy);
+    const {nonHeldAmount, fullAmount, isNonHeldAmountNegative} = ReportUtils.getNonHeldAndFullAmount(iouReport, policy);


@mkzie2 Please rename isNonHeldAmountNegative to hasValidNonHeldAmount, as this makes more sense in the contexts where the boolean value is being checked.

hasValidNonHeldAmount should be true if the nonHeldAmount value is not negative and is greater than 0.

Thanks for the great suggestion. I updated.

akinwale · 2024-11-12T10:42:59Z

src/libs/ReportUtils.ts

+    return {
+        nonHeldAmount: CurrencyUtils.convertToDisplayString((iouReport?.unheldTotal ?? 0) * coefficient, iouReport?.currency),
+        fullAmount: CurrencyUtils.convertToDisplayString((iouReport?.total ?? 0) * coefficient, iouReport?.currency),
+        isNonHeldAmountNegative: (iouReport?.unheldTotal ?? 0) * coefficient < 0,


Let's rename this to hasValidNonHeldAmount and add a comment explaining what the value is for. To reiterate, hasValidNonHeldAmount should be true if the nonHeldAmount value is not negative and is greater than 0.

mkzie2 · 2024-11-13T04:36:55Z

I renamed the variable and added comments.

Beamanator

Thanks for updating to the new variable name (hat top to @akinwale for that idea) - though I think you didn't consider how that affects the rest of the code.

src/libs/ReportUtils.ts

src/components/ReportActionItem/ReportPreview.tsx

mkzie2 · 2024-11-13T13:15:42Z

@Beamanator I updated.

Beamanator · 2024-11-13T13:34:10Z

Code is looking great, thanks so much @mkzie2 🙏

@mkzie2 @akinwale can y'all both please re-test before we get this merged?

mkzie2 · 2024-11-13T14:13:52Z

@Beamanator, I tested it when pushing the code. All yours @akinwale.

akinwale · 2024-11-13T16:29:37Z

Code is looking great, thanks so much @mkzie2 🙏

@mkzie2 @akinwale can y'all both please re-test before we get this merged?

@Beamanator Re-tested and confirmed working as expected.

akinwale

LGTM.

Beamanator

LGTM

OSBotify · 2024-11-13T16:45:06Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-11-14T00:52:44Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.0.62-0 🚀

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

kavimuru · 2024-11-14T22:29:35Z

#51209 failing with original issue #50497 in android and mweb

https://platform.applause.com/services/links/v1/external/47aff5376ede83d76cfee97f77ef00047666eb99b29a79b79a74f2251bae25c6
https://platform.applause.com/services/links/v1/external/0bf87726ece0010e98488bcda7c0cc1b1de0544cc2be1be246165b9ebfc4b5f8

Beamanator · 2024-11-15T08:11:59Z

@mkzie2 @akinwale can y'all please take a look? ^

mkzie2 · 2024-11-15T08:58:22Z

I tested and it works well. Can you please double-check @akinwale ?

Screen.Recording.2024-11-15.at.15.57.02.mov

github-actions · 2024-11-15T14:16:04Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.62-4 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

fix: negative amount in settlement button when the unheld expense com…

f69e86b

…es from self

mkzie2 marked this pull request as ready for review October 21, 2024 23:27

mkzie2 requested a review from a team as a code owner October 21, 2024 23:27

melvin-bot bot requested a review from akinwale October 21, 2024 23:27

melvin-bot bot removed the request for review from a team October 21, 2024 23:27

akinwale approved these changes Oct 30, 2024

View reviewed changes

melvin-bot bot requested a review from Beamanator October 30, 2024 15:59

Beamanator requested changes Oct 30, 2024

View reviewed changes

Merge branch 'main' of https://github.com/mkzie2/App into mkzie2-issu…

702d6b5

…e/50497

Beamanator reviewed Nov 4, 2024

View reviewed changes

add comments

02e1f41

akinwale suggested changes Nov 12, 2024

View reviewed changes

rename variable

c9b00c5

Beamanator requested changes Nov 13, 2024

View reviewed changes

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved

src/components/ReportActionItem/ReportPreview.tsx Show resolved Hide resolved

src/components/ReportActionItem/ReportPreview.tsx Outdated Show resolved Hide resolved

mkzie2 added 2 commits November 13, 2024 20:02

Merge branch 'main' into mkzie2-issue/50497

108c738

refactor hasValidNonHeldAmount logic

5e66d72

akinwale approved these changes Nov 13, 2024

View reviewed changes

melvin-bot bot requested a review from Beamanator November 13, 2024 16:29

Beamanator approved these changes Nov 13, 2024

View reviewed changes

Beamanator merged commit e902c04 into Expensify:main Nov 13, 2024
17 checks passed

github-actions bot mentioned this pull request Nov 14, 2024

Deploy Checklist: New Expensify 2024-11-14 #52512

Closed

47 tasks

melvin-bot bot mentioned this pull request Nov 15, 2024

[HOLD for payment 2024-11-22] [$250] Held expense - Negative amount in the payment button when the unheld expense comes from self #50497

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: negative amount in settlement button when the unheld expense comes from self #51209

fix: negative amount in settlement button when the unheld expense comes from self #51209

mkzie2 commented Oct 21, 2024 •

edited

Loading

melvin-bot bot commented Oct 21, 2024

akinwale commented Oct 28, 2024 •

edited

Loading

akinwale left a comment

Beamanator left a comment

mkzie2 commented Nov 4, 2024

Beamanator Nov 4, 2024

mkzie2 Nov 8, 2024

Beamanator Nov 8, 2024

mkzie2 Nov 12, 2024

akinwale commented Nov 8, 2024

akinwale left a comment

akinwale Nov 12, 2024

mkzie2 Nov 13, 2024

akinwale Nov 12, 2024 •

edited

Loading

mkzie2 Nov 13, 2024

mkzie2 commented Nov 13, 2024

Beamanator left a comment

mkzie2 commented Nov 13, 2024

Beamanator commented Nov 13, 2024

mkzie2 commented Nov 13, 2024

akinwale commented Nov 13, 2024

akinwale left a comment

Beamanator left a comment

OSBotify commented Nov 13, 2024

github-actions bot commented Nov 14, 2024

kavimuru commented Nov 14, 2024

Beamanator commented Nov 15, 2024

mkzie2 commented Nov 15, 2024

github-actions bot commented Nov 15, 2024

fix: negative amount in settlement button when the unheld expense comes from self #51209

fix: negative amount in settlement button when the unheld expense comes from self #51209

Conversation

mkzie2 commented Oct 21, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 21, 2024

akinwale commented Oct 28, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

akinwale left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

mkzie2 commented Nov 4, 2024

Beamanator Nov 4, 2024

Choose a reason for hiding this comment

mkzie2 Nov 8, 2024

Choose a reason for hiding this comment

Beamanator Nov 8, 2024

Choose a reason for hiding this comment

mkzie2 Nov 12, 2024

Choose a reason for hiding this comment

akinwale commented Nov 8, 2024

akinwale left a comment

Choose a reason for hiding this comment

akinwale Nov 12, 2024

Choose a reason for hiding this comment

mkzie2 Nov 13, 2024

Choose a reason for hiding this comment

akinwale Nov 12, 2024 • edited Loading

Choose a reason for hiding this comment

mkzie2 Nov 13, 2024

Choose a reason for hiding this comment

mkzie2 commented Nov 13, 2024

Beamanator left a comment

Choose a reason for hiding this comment

mkzie2 commented Nov 13, 2024

Beamanator commented Nov 13, 2024

mkzie2 commented Nov 13, 2024

akinwale commented Nov 13, 2024

akinwale left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 13, 2024

github-actions bot commented Nov 14, 2024

kavimuru commented Nov 14, 2024

Beamanator commented Nov 15, 2024

mkzie2 commented Nov 15, 2024

github-actions bot commented Nov 15, 2024

mkzie2 commented Oct 21, 2024 •

edited

Loading

akinwale commented Oct 28, 2024 •

edited

Loading

akinwale Nov 12, 2024 •

edited

Loading