[CP Staging] Expense - No option to cancel payment for paid expense as 3-dot menu is removed #45130

cdOut · 2024-07-09T23:16:32Z

Details

Add Cancel payment button from the 3-dot menu that has been removed back into ReportDetailsPage.

Fixed Issues

$ #45077
PROPOSAL:

Tests

Create a workspace on the first account and invite a second account to it.
On the second account submit an expense to said workspace.
On the first account pay the amount from the previous expense.
Confirm that the Cancel payment appears in the details page and works properly.

Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Screen.Recording.2024-07-10.at.01.11.18.mov

melvin-bot · 2024-07-09T23:19:14Z

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

allroundexperts · 2024-07-09T23:37:37Z

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-07-10.at.4.58.24.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-07-10.at.4.57.54.AM.mov

iOS: Native

Screen.Recording.2024-07-10.at.4.57.15.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-07-10.at.4.56.43.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-10.at.4.53.54.AM.mov

MacOS: Desktop

Screen.Recording.2024-07-10.at.4.55.56.AM.mov

allroundexperts · 2024-07-10T00:03:11Z

src/pages/ReportDetailsPage.tsx

+    const isPayer = ReportUtils.isPayer(session, moneyRequestReport);
+    const isSettled = ReportUtils.isSettled(moneyRequestReport?.reportID ?? '-1');
+
+    const shouldShowCancelPaymentButton = caseID === CASES.MONEY_REPORT && isPayer && isSettled && ReportUtils.isExpenseReport(moneyRequestReport);


Should we make a utility function out of this?

Also, why are we adding this extra check here? This did not exist in the MoneyReportHeader component previously.

I don't think that is necessary, this is done in the same way as shouldShowLeaveButton and canUnapproveRequest have been handled in the same file.

This is also the only place where the payment cancellation use-case gets called.

Again, the extra check is due to ReportDetailsPage unifying the functionality of three different components from before, MoneyRequestHeader, MoneyReportHeader and HeaderView. I wanted to make sure this only works for the case which it comes from, hence the CASES.MONEY_REPORT check.

allroundexperts · 2024-07-10T00:05:18Z

src/pages/ReportDetailsPage.tsx

+        if (!moneyRequestReport) {
+            return;
+        }


Why are we adding this extra condition? I don't see it being used in MoneyReportHeader component.

This sort of check has to be added here, since for ReportDetailsPage, which combines MoneyReportHeader, MoneyRequestHeader and HeaderView logic after Details Revamp, moneyRequestReport might be undefined in other cases, unlike in MoneyReportHeader, which had it as a required argument passed to the component.

I have moved this logic into the IOU.cancelPayment(); function and changed it to support OnyxEntry<OnyxTypes.Report>. This unifies the cancel function with other IOU functions such as IOU.unapproveExpenseReport(); and should be a good solution here.

mountiny · 2024-07-10T00:24:17Z

@allroundexperts ready for another look

allroundexperts

Thanks for the explanation. This works well!

mountiny

Thanks for a quick work, just one question, I will move it ahead still though. I believe Alberto is now out

mountiny · 2024-07-10T00:35:32Z

src/pages/ReportDetailsPage.tsx

@@ -263,6 +264,21 @@ function ReportDetailsPage({policies, report, session, personalDetails}: ReportD
    const shouldShowWriteCapability = !isMoneyRequestReport;
    const shouldShowMenuItem = shouldShowNotificationPref || shouldShowWriteCapability || (!!report?.visibility && report.chatType !== CONST.REPORT.CHAT_TYPE.INVOICE);

+    const isPayer = ReportUtils.isPayer(session, moneyRequestReport);
+    const isSettled = ReportUtils.isSettled(moneyRequestReport?.reportID ?? '-1');


I wonder if we need this default really

Suggested change

const isSettled = ReportUtils.isSettled(moneyRequestReport?.reportID ?? '-1');

const isSettled = ReportUtils.isSettled(moneyRequestReport?.reportID);

This might be obsolete but I wanted to add it as an extra percussion to make sure this doesn't cause a crash anytime in the app.

OSBotify · 2024-07-10T00:47:02Z

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

…yment-fix [CP Staging] Expense - No option to cancel payment for paid expense as 3-dot menu is removed (cherry picked from commit c973e62)

OSBotify · 2024-07-10T09:55:03Z

🚀 Cherry-picked to staging by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

mountiny · 2024-07-10T10:23:13Z

QA worked well

Screen.Recording.2024-07-10.at.11.21.37.mov

OSBotify · 2024-07-10T11:08:08Z

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

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

OSBotify · 2024-07-10T11:22:11Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.6-0 🚀

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

OSBotify · 2024-07-10T11:39:25Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.6-0 🚀

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

OSBotify · 2024-07-15T20:28:29Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.6-8 🚀

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

add cancel payment button into the report details page

0669a7a

cdOut marked this pull request as ready for review July 9, 2024 23:19

cdOut requested a review from a team as a code owner July 9, 2024 23:19

melvin-bot bot removed the request for review from a team July 9, 2024 23:19

melvin-bot bot requested a review from akinwale July 9, 2024 23:19

add missing dependency to useMemo

b1e53c6

mountiny changed the title ~~Expense - No option to cancel payment for paid expense as 3-dot menu is removed~~ [CP Staging] Expense - No option to cancel payment for paid expense as 3-dot menu is removed Jul 9, 2024

mountiny requested review from allroundexperts and removed request for akinwale July 9, 2024 23:36

mountiny assigned cdOut Jul 10, 2024

allroundexperts reviewed Jul 10, 2024

View reviewed changes

mountiny requested a review from Gonals July 10, 2024 00:13

cdOut added 2 commits July 10, 2024 02:16

refactor the cancelPayment IOU function

e98a186

fix prettier

1abb522

mountiny requested a review from allroundexperts July 10, 2024 00:24

allroundexperts approved these changes Jul 10, 2024

View reviewed changes

mountiny approved these changes Jul 10, 2024

View reviewed changes

mountiny merged commit c973e62 into Expensify:main Jul 10, 2024
18 checks passed

github-actions bot mentioned this pull request Jul 10, 2024

Deploy Checklist: New Expensify 2024-07-08 #44947

Closed

86 tasks

mountiny mentioned this pull request Jul 10, 2024

[Details revamp] No option to cancel payment for paid expense as 3-dot menu is removed #45077

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Expense - No option to cancel payment for paid expense as 3-dot menu is removed #45130

[CP Staging] Expense - No option to cancel payment for paid expense as 3-dot menu is removed #45130

cdOut commented Jul 9, 2024

melvin-bot bot commented Jul 9, 2024

allroundexperts commented Jul 9, 2024 •

edited

Loading

allroundexperts Jul 10, 2024

allroundexperts Jul 10, 2024

cdOut Jul 10, 2024 •

edited

Loading

cdOut Jul 10, 2024

allroundexperts Jul 10, 2024

cdOut Jul 10, 2024

mountiny commented Jul 10, 2024

allroundexperts left a comment

mountiny left a comment

mountiny Jul 10, 2024

cdOut Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

mountiny commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 15, 2024

	const isSettled = ReportUtils.isSettled(moneyRequestReport?.reportID ?? '-1');
	const isSettled = ReportUtils.isSettled(moneyRequestReport?.reportID);

[CP Staging] Expense - No option to cancel payment for paid expense as 3-dot menu is removed #45130

[CP Staging] Expense - No option to cancel payment for paid expense as 3-dot menu is removed #45130

Conversation

cdOut commented Jul 9, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 9, 2024

allroundexperts commented Jul 9, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts Jul 10, 2024

Choose a reason for hiding this comment

allroundexperts Jul 10, 2024

Choose a reason for hiding this comment

cdOut Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

cdOut Jul 10, 2024

Choose a reason for hiding this comment

allroundexperts Jul 10, 2024

Choose a reason for hiding this comment

cdOut Jul 10, 2024

Choose a reason for hiding this comment

mountiny commented Jul 10, 2024

allroundexperts left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mountiny Jul 10, 2024

Choose a reason for hiding this comment

cdOut Jul 10, 2024

Choose a reason for hiding this comment

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

mountiny commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 15, 2024

allroundexperts commented Jul 9, 2024 •

edited

Loading

cdOut Jul 10, 2024 •

edited

Loading