[Held requests] Clean up the hold/unhold logic #45151

cdOut · 2024-07-10T13:26:53Z

Details

Fix for hold/unhold logic to make it display properly as an option both in the context menu on right-click/long-press as well as a promoted aciton in the reports details page.

Fixed Issues

$ #44573
$ #45518
PROPOSAL:

Tests

Expenses on iouReports

Submit an expense to another account.
Confirm that you can hold the expense from both accounts participating in the expense report.
Hold it from one of the accounts and confirm that it only can be unheld by the account that held it.

Expenses on expenseReports

Create a workspace and invite a second account into it
Submit an expense for said workspace from the other account.
Confirm that the member of said expense report can hold it, same for approved assigned to it and also admin of said workspace.
As for unholding, members should be able to do so if they also put it on hold originally, approvers should be able to unhold expenses assigned to them and admins should be able to unhold any expenses from their workspaces.

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

Screenshots/Videos

MacOS: Desktop and Chrome / Safari

DESKTOP.WEB.mov

war-in

LGTM 👍

robertjchen · 2024-07-18T22:35:27Z

@cdOut Is this ready for review? 🙏

melvin-bot · 2024-07-19T09:34:54Z

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

parasharrajat · 2024-07-20T09:30:10Z

I am getting unhold request error from backend when I try to unhold the request from Approver.

parasharrajat · 2024-07-20T09:35:53Z

BUG: If some reason hold/unhold request is failed on the client. After clearing the RBR error from request, the unheld or held message from report is not removed.

Expected: The message should also remove on clearing RBR when the operation failed.

20.07.2024_15.05.01_REC.mp4

parasharrajat · 2024-07-20T09:37:08Z

Now, I have couple of questions on how the button visibility should work for all the cases.

If a user is not able to hold a request, should the hold button be hidden on the report. Vice-versa for unhold.
If the buttons should be visible all the times, What should happen when a non-autorized user clicks that button. For example, a member tries to unhold a request which was held by approver.

@trjExpensify

parasharrajat · 2024-07-20T09:39:07Z

Approver of workspace is not able to unhold a expense request PUT on hold by someone else (member or admin).
Admin of workspace is not able to unhold a expense request PUT on hold by someone else (member or approver).

Related: #45151 (comment)

robertjchen · 2024-07-22T01:01:31Z

@parasharrajat

If a user is not able to hold a request, should the hold button be hidden on the report. Vice-versa for unhold.

Yes, the hold button should be hidden if the user is not able to hold a particular request and vice versa.

If the buttons should be visible all the times, What should happen when a non-autorized user clicks that button. For example, a member tries to unhold a request which was held by approver.

Ideally, we would not allow the user to get to this state through the frontend.

Approver of workspace is not able to unhold a expense request PUT on hold by someone else (member or admin).

Admin of workspace is not able to unhold a expense request PUT on hold by someone else (member or approver).

Interesting- let me double-check the backend. In theory, admin/approvers for expense reports should be unable to unhold in all cases to move a report/request through the approval workflow.

The submitter is prevented from unholding in all cases EXCEPT the case where they had specifically held their submission in the first place. 🤔

In the case of an IOU, the approver cannot unhold if the submitter/requestor had put it on hold.

robertjchen · 2024-07-22T03:30:42Z

Thanks again for the tests @parasharrajat ! Made a few tweaks to the backend to allow an approver/admin to unhold an expense put on hold by someone else, but it shouldn't block the progress here 👍

parasharrajat · 2024-07-22T09:00:52Z

@cdOut Can you please look into the bugs above?

cdOut · 2024-07-22T12:34:42Z

Yes, I'll look into them today.

cdOut · 2024-07-24T13:08:39Z

Update to the issue, I'm working on fixing the bugs today and will focus on getting it to be ready for a re-review early tomorrow.

cdOut · 2024-07-29T08:05:12Z

As an update to the issue thread, today I'm completing the fix for the context menu (Long-press / Right Mouse Button) to also work properly with our current logic and I'll let @parasharrajat know when it's ready for a re-review later.

parasharrajat · 2024-07-31T21:28:13Z

@cdOut Please Resolve conflicts.

parasharrajat · 2024-08-01T07:44:25Z

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.tsx

+    const childReport = ReportUtils.getReport(reportAction?.childReportID ?? '-1');
+    const parentReportAction = ReportActionsUtils.getReportAction(childReport?.parentReportID ?? '', childReport?.parentReportActionID ?? '');
+    const {reportActions: paginatedReportActions} = usePaginatedReportActions(childReport?.reportID ?? '-1');
+
+    const transactionThreadReportID = useMemo(
+        () => ReportActionsUtils.getOneTransactionThreadReportID(childReport?.reportID ?? '-1', paginatedReportActions ?? [], isOffline),
+        [childReport?.reportID, paginatedReportActions, isOffline],
+    );
+
+    const [transactionThreadReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${transactionThreadReportID}`);
+
+    const isMoneyRequestReport = useMemo(() => ReportUtils.isMoneyRequestReport(childReport), [childReport]);
+    const isInvoiceReport = useMemo(() => ReportUtils.isInvoiceReport(childReport), [childReport]);
+
+    const requestParentReportAction = useMemo(() => {
+        if (isMoneyRequestReport || isInvoiceReport) {
+            if (!paginatedReportActions || !transactionThreadReport?.parentReportActionID) {
+                return undefined;
+            }
+            return paginatedReportActions.find((action) => action.reportActionID === transactionThreadReport.parentReportActionID);
+        }
+        return parentReportAction;
+    }, [parentReportAction, isMoneyRequestReport, isInvoiceReport, paginatedReportActions, transactionThreadReport?.parentReportActionID]);
+
+    const moneyRequestAction = transactionThreadReportID ? requestParentReportAction : parentReportAction;
+
+    const [parentReportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${childReport?.parentReportID ?? '-1'}`);
+    const parentReport = ReportUtils.getReport(childReport?.parentReportID ?? '-1');
+
+    const isMoneyRequest = useMemo(() => ReportUtils.isMoneyRequest(childReport), [childReport]);
+    const isTrackExpenseReport = ReportUtils.isTrackExpenseReport(childReport);
+    const isSingleTransactionView = isMoneyRequest || isTrackExpenseReport;
+    const isMoneyRequestOrReport = isMoneyRequestReport || isInvoiceReport || isSingleTransactionView;


Don't we have utils to get all these already?

If you know of said utils then please point them out to me, but I don't think we already have one that would handle this sort of logic. This was recently written for just ReportDetailsPage which unified multiple pages with hold functionalities into one component.

Let me see.

trjExpensify · 2024-08-01T21:22:05Z

@parasharrajat did you look for those Utils, can we continue the review? Thanks!

parasharrajat · 2024-08-02T12:23:40Z

@trjExpensify Yes, I am testing it. I will have more updates in sometime today.

parasharrajat · 2024-08-04T16:49:01Z

Members can only unhold expenses they put on hold themselves.

This case is failing. User A requested money from user B. User B held the request.

BUG: User A is seeing unhold button.
BUG: User B does not see unhold button.

parasharrajat · 2024-08-04T16:53:26Z

Members can unhold their own expenses, but only if they themselves put the expense on hold.

User A requested money to a Workspace. User A held the request.

BUG: User A does not see unhold button.

parasharrajat

Bugs above. Rest the code looks good to me.

cdOut · 2024-08-05T09:43:47Z

I'll be looking at the bugs today, will let you know when it's done.

merge main into @cdOut/cleanup-hold-unhold

parasharrajat · 2024-08-07T13:16:27Z

@cdOut Any updates?

cdOut · 2024-08-07T14:50:04Z

I am finishing this one now, will send you an update later today when it's ready

cdOut · 2024-08-08T12:32:57Z

Got a little blocked since the way we detect who held the expense changed with this logic, will notify when I resolve this one

merge main into @cdOut/cleanup-hold-unhold

cdOut · 2024-08-09T10:21:22Z

@parasharrajat ready for your re-review, merged the latest main also

parasharrajat · 2024-08-09T21:26:51Z

Screenshots

🔲 iOS / native

10.08.2024_16.34.08_REC.mp4

🔲 iOS / Safari

10.08.2024_16.26.26_REC.mp4

🔲 MacOS / Desktop

10.08.2024_16.24.15_REC.mp4

🔲 MacOS / Chrome

10.08.2024_16.18.47_REC.mp4

🔲 Android / Chrome

10.08.2024_16.42.10_REC.mp4

🔲 Android / native

10.08.2024_16.31.22_REC.mp4

parasharrajat

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.

🎀 👀 🎀 C+ reviewed

robertjchen

Thanks!

OSBotify · 2024-08-10T19:15:41Z

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

Beamanator · 2024-08-14T20:12:31Z

FYI I believe this was deployed to prod yesterday, from this checklist - #47219

abdulrahuman5196 · 2024-10-28T20:10:08Z

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.tsx

+    const isSingleTransactionView = isMoneyRequest || isTrackExpenseReport;
+    const isMoneyRequestOrReport = isMoneyRequestReport || isInvoiceReport || isSingleTransactionView;
+
+    const areHoldRequirementsMet = isMoneyRequestOrReport && !ReportUtils.isArchivedRoom(transactionThreadReportID ? childReport : parentReport, parentReportNameValuePairs);


This caused an issue where the hold options are shown for invoice reports. More info here. #47570

Invoice reports were added after this change so technically it didn't cause the issue.

cdOut added 2 commits July 10, 2024 15:25

fix hold/unhold logic

948e1f7

fix lint errors

e43ffe0

war-in approved these changes Jul 11, 2024

View reviewed changes

cdOut added 5 commits July 19, 2024 11:07

fix isPolicyAdmin not being properly implemented in ReportUtils check

1384fe1

Merge branch 'main' into @cdOut/cleanup-hold-unhold

94ae4d3

fix prettier

ade4976

fix lint errors after merge

c8dce56

clean up code

c4289b4

cdOut marked this pull request as ready for review July 19, 2024 09:34

cdOut requested a review from a team as a code owner July 19, 2024 09:34

melvin-bot bot requested review from parasharrajat and removed request for a team July 19, 2024 09:34

This was referenced Jul 29, 2024

[Awaiting Payment 20th August] [Held requests] Clean up the hold/unhold logic #44573

Closed

[HOLD for payment 2024-08-14] [$250] Hold - Missing "Unhold" on the report header of held expense after it is moved to new report offline #46371

Closed

stephanieelliott mentioned this pull request Jul 30, 2024

[HOLD for payment 2024-08-19] [$250] Send invoice - Hold option is present for invoice and the invoice cannot be held #45518

Closed

5 tasks

cdOut added 3 commits July 31, 2024 11:11

correct logic for hold/unhold for ContextMenu action

1259a4a

fix prettier

dbf2421

Merge branch 'main' into @cdOut/cleanup-hold-unhold

1238c05

parasharrajat reviewed Aug 1, 2024

View reviewed changes

Merge branch 'main' into @cdOut/cleanup-hold-unhold

522447f

parasharrajat suggested changes Aug 4, 2024

View reviewed changes

Merge branch 'main' into @cdOut/cleanup-hold-unhold

3521502

merge main into @cdOut/cleanup-hold-unhold

trjExpensify mentioned this pull request Aug 5, 2024

[Search v1.2] - Unsubmitted expense can be held without error in Search #46742

Closed

6 tasks

cdOut added 3 commits August 9, 2024 12:03

fix isHoldCreator not working properly for money requests

9bbd7a7

fix prettier

07c607d

Merge branch 'main' into @cdOut/cleanup-hold-unhold

70691da

merge main into @cdOut/cleanup-hold-unhold

cdOut added 2 commits August 9, 2024 13:34

correct logic for non-IOU unhold author conditional

eee69cb

fix prettier and formatting

03e5b25

parasharrajat approved these changes Aug 10, 2024

View reviewed changes

melvin-bot bot requested a review from Beamanator August 10, 2024 11:09

robertjchen approved these changes Aug 10, 2024

View reviewed changes

robertjchen merged commit 93dc1c9 into Expensify:main Aug 10, 2024
17 checks passed

github-actions bot mentioned this pull request Aug 12, 2024

Deploy Checklist: New Expensify 2024-08-12 #47219

Closed

90 tasks

cdOut mentioned this pull request Aug 12, 2024

[Held requests] Hold button on expense preview appears only if open the expense first #47241

Open

6 tasks

abdulrahuman5196 reviewed Oct 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Held requests] Clean up the hold/unhold logic #45151

[Held requests] Clean up the hold/unhold logic #45151

cdOut commented Jul 10, 2024 •

edited

Loading

war-in left a comment

robertjchen commented Jul 18, 2024

melvin-bot bot commented Jul 19, 2024

parasharrajat commented Jul 20, 2024 •

edited

Loading

parasharrajat commented Jul 20, 2024

parasharrajat commented Jul 20, 2024 •

edited

Loading

parasharrajat commented Jul 20, 2024 •

edited

Loading

robertjchen commented Jul 22, 2024 •

edited

Loading

robertjchen commented Jul 22, 2024

parasharrajat commented Jul 22, 2024

cdOut commented Jul 22, 2024

cdOut commented Jul 24, 2024

cdOut commented Jul 29, 2024

parasharrajat commented Jul 31, 2024

parasharrajat Aug 1, 2024

cdOut Aug 1, 2024

parasharrajat Aug 1, 2024

trjExpensify commented Aug 1, 2024

parasharrajat commented Aug 2, 2024

parasharrajat commented Aug 4, 2024 •

edited

Loading

parasharrajat commented Aug 4, 2024

parasharrajat left a comment •

edited

Loading

cdOut commented Aug 5, 2024

parasharrajat commented Aug 7, 2024

cdOut commented Aug 7, 2024

cdOut commented Aug 8, 2024

cdOut commented Aug 9, 2024

parasharrajat commented Aug 9, 2024 •

edited

Loading

parasharrajat left a comment

robertjchen left a comment •

edited

Loading

OSBotify commented Aug 10, 2024

Beamanator commented Aug 14, 2024

abdulrahuman5196 Oct 28, 2024

parasharrajat Oct 29, 2024

[Held requests] Clean up the hold/unhold logic #45151

[Held requests] Clean up the hold/unhold logic #45151

Conversation

cdOut commented Jul 10, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

war-in left a comment

Choose a reason for hiding this comment

robertjchen commented Jul 18, 2024

melvin-bot bot commented Jul 19, 2024

parasharrajat commented Jul 20, 2024 • edited Loading

parasharrajat commented Jul 20, 2024

parasharrajat commented Jul 20, 2024 • edited Loading

parasharrajat commented Jul 20, 2024 • edited Loading

robertjchen commented Jul 22, 2024 • edited Loading

robertjchen commented Jul 22, 2024

parasharrajat commented Jul 22, 2024

cdOut commented Jul 22, 2024

cdOut commented Jul 24, 2024

cdOut commented Jul 29, 2024

parasharrajat commented Jul 31, 2024

parasharrajat Aug 1, 2024

Choose a reason for hiding this comment

cdOut Aug 1, 2024

Choose a reason for hiding this comment

parasharrajat Aug 1, 2024

Choose a reason for hiding this comment

trjExpensify commented Aug 1, 2024

parasharrajat commented Aug 2, 2024

parasharrajat commented Aug 4, 2024 • edited Loading

parasharrajat commented Aug 4, 2024

parasharrajat left a comment • edited Loading

Choose a reason for hiding this comment

cdOut commented Aug 5, 2024

parasharrajat commented Aug 7, 2024

cdOut commented Aug 7, 2024

cdOut commented Aug 8, 2024

cdOut commented Aug 9, 2024

parasharrajat commented Aug 9, 2024 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

robertjchen left a comment • edited Loading

Choose a reason for hiding this comment

OSBotify commented Aug 10, 2024

Beamanator commented Aug 14, 2024

abdulrahuman5196 Oct 28, 2024

Choose a reason for hiding this comment

parasharrajat Oct 29, 2024

Choose a reason for hiding this comment

cdOut commented Jul 10, 2024 •

edited

Loading

parasharrajat commented Jul 20, 2024 •

edited

Loading

parasharrajat commented Jul 20, 2024 •

edited

Loading

parasharrajat commented Jul 20, 2024 •

edited

Loading

robertjchen commented Jul 22, 2024 •

edited

Loading

parasharrajat commented Aug 4, 2024 •

edited

Loading

parasharrajat left a comment •

edited

Loading

parasharrajat commented Aug 9, 2024 •

edited

Loading

robertjchen left a comment •

edited

Loading