fix: Approving a report causes the workspace chat to “flash” in the LHN before disappearing #35928

tienifr · 2024-02-06T17:34:41Z

Details

Fixed Issues

$ #35309
PROPOSAL: #35309 (comment)

Tests

Make sure user A (submitter) and user B (approver) on a workspace with scheduled submit (e.g. delayed submission)
Have user A create a request via Request money
Have user A submit the report
As user B, user A’s workspace chat will show unread in the LHN
As user B, tap into user A’s report, approve it
Verify that the green dot disappear immediately if there's no more IOU to approve/pay

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Make sure user A (submitter) and user B (approver) on a workspace with scheduled submit (e.g. delayed submission)
Have user A create a request via Request money
Have user A submit the report
As user B, user A’s workspace chat will show unread in the LHN
As user B, tap into user A’s report, approve it
Verify that the green dot disappear immediately if there's no more IOU to approve/pay

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-02-14.at.15.12.02.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-02-14.at.14.58.07.mov

iOS: mWeb Safari

Screen.Recording.2024-02-14.at.14.56.14.mov

MacOS: Chrome / Safari

Screen.Recording.2024-02-07.at.00.23.32.mov

MacOS: Desktop

Screen.Recording.2024-02-07.at.00.27.34.mov

…HN before disappearing

melvin-bot · 2024-02-06T17:34:52Z

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

tienifr · 2024-02-23T02:46:33Z

@situchan any updates?

situchan · 2024-02-25T16:01:36Z

@tienifr please merge main. I will complete review today

tienifr · 2024-02-26T03:21:14Z

@situchan merged

situchan

As we made shouldShowSettlementButtton, hasIOUToApproveOrPay utils, can we also apply these to the places where you referenced this logic?

tienifr · 2024-02-27T10:17:48Z

I just refactored the PR to create shouldShowPayButton and shouldShowApproveButton. Even though there're some duplicated codes in 2 these functions but it's the tradeoff. We need to use shouldShowPayButton and shouldShowApproveButton in many places so create the utils function can help prevent the inconsistency bug. Beside these duplicated code are so simple

tienifr · 2024-02-27T10:18:25Z

@situchan Can you help check #35928 (comment). I re-tested and it worked well

tienifr · 2024-02-29T03:08:53Z

@situchan I just resolved the conflicts, can you help review soon? Thanks

tienifr · 2024-03-01T05:08:23Z

DM to @situchan

situchan

Code now looks much better

tienifr · 2024-03-04T03:14:35Z

@situchan any updates?

tienifr · 2024-03-06T03:43:09Z

Bump @situchan on 1:1

src/libs/actions/IOU.ts

situchan · 2024-03-06T12:28: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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

multiple.requests.mov

single.request.mov

MacOS: Desktop

situchan · 2024-03-06T12:29:29Z

@tienifr all good after addressing feedback above

tienifr · 2024-03-07T05:07:22Z

@situchan Thanks for your suggestion. I updated

iwiznia · 2024-03-07T16:12:58Z

src/libs/PolicyUtils.ts

@@ -227,14 +227,14 @@ function isPaidGroupPolicy(policy: OnyxEntry<Policy> | EmptyObject): boolean {
 * Checks if policy's scheduled submit / auto reporting frequency is "instant".
 * Note: Free policies have "instant" submit always enabled.
 */
-function isInstantSubmitEnabled(policy: OnyxEntry<Policy>): boolean {
+function isInstantSubmitEnabled(policy: OnyxEntry<Policy> | EmptyObject): boolean {


Is this to support the case when the policy is not loaded or what?
And if so, why was it not needed before?

It's same as other cases if you see next line.

policy?.autoReportingFrequency
policy has optional chaining for nothing.

This came from the fact that Onyx values are optional (null on fist component render, before Onyx data is loaded)

iwiznia · 2024-03-07T16:17:21Z

src/libs/actions/IOU.ts

@@ -3691,10 +3691,75 @@ function sendMoneyWithWallet(report: OnyxTypes.Report, amount: number, currency:
    Report.notifyNewAction(params.chatReportID, managerID);
 }

+function shouldShowPayButton(iouReport: OnyxEntry<OnyxTypes.Report> | EmptyObject, chatReport: OnyxEntry<OnyxTypes.Report> | EmptyObject, policy: OnyxEntry<OnyxTypes.Policy> | EmptyObject) {


Loooove these helper methods since they removed duplication and made code easier to follow ❤️

Is this really determining if we need to show the button or is it really determining canIOUBePaid?

Especially here is weird to call a method called shouldShowPayButton

iwiznia · 2024-03-07T16:37:05Z

src/libs/actions/IOU.ts

+    const iouSettled = ReportUtils.isSettled(iouReport?.reportID);
+    const isOnInstantSubmitPolicy = PolicyUtils.isInstantSubmitEnabled(policy);
+    const isOnSubmitAndClosePolicy = PolicyUtils.isSubmitAndClose(policy);
+    if (!isPaidGroupPolicy) {


Not sure how costly the methods above are, but maybe consider moving this if to be right at the top?

iwiznia · 2024-03-07T16:40:12Z

src/libs/actions/IOU.ts

+    return isPayer && !isDraftExpenseReport && !iouSettled && !iouReport?.isWaitingOnBankAccount && reimbursableSpend !== 0 && !iouCanceled && !isAutoReimbursable;
+}
+
+function shouldShowApproveButton(


Same here, should this be canApproveIOU?

tienifr · 2024-03-08T04:00:47Z

@iwiznia Thanks for your suggestion. I updated the PR

melvin-bot · 2024-03-08T15:53:55Z

@iwiznia looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2024-03-08T15:59:14Z

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

iwiznia · 2024-03-08T17:44:57Z

It was a mistake, I thought they had already passed. Given the perf tests broke, going to revert this.

situchan · 2024-03-08T17:47:33Z

@iwiznia looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

This seems to be happening on other PRs as well

OSBotify · 2024-03-12T18:37:45Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.50-5 🚀

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

allgandalf · 2024-07-10T08:56:19Z

src/libs/actions/IOU.ts

+        onyxMethod: Onyx.METHOD.MERGE,
+        key: `${ONYXKEYS.COLLECTION.REPORT}${expenseReport?.chatReportID}`,
+        value: {
+            hasOutstandingChildRequest: hasIOUToApproveOrPay(chatReport, expenseReport?.reportID ?? ''),


We missed to check if the report was fully approved before passing expenseReport?.reportID, this caused the bug #43014

fix: Approving a report causes the workspace chat to “flash” in the L…

0ddffd1

…HN before disappearing

tienifr marked this pull request as ready for review February 6, 2024 17:34

tienifr requested a review from a team as a code owner February 6, 2024 17:34

melvin-bot bot requested review from situchan and removed request for a team February 6, 2024 17:34

tienifr added 3 commits February 13, 2024 22:57

fix conflict

933cf9d

Merge branch 'main' into fix/35309

fda9b4e

lint fix

11800a4

Merge branch 'main' into fix/35309

9d5d2c7

This comment was marked as outdated.

Sign in to view

situchan reviewed Feb 26, 2024

View reviewed changes

tienifr added 2 commits February 27, 2024 15:14

Merge branch 'main' into fix/35309

99e950b

refactor

293223f

resolve conflicts

4ecbd81

resolve conflicts

b6d451f

situchan reviewed Mar 1, 2024

View reviewed changes

resolve conflicts

d5f7f3a

situchan suggested changes Mar 6, 2024

View reviewed changes

src/libs/actions/IOU.ts Outdated Show resolved Hide resolved

src/libs/actions/IOU.ts Outdated Show resolved Hide resolved

src/libs/actions/IOU.ts Outdated Show resolved Hide resolved

situchan reviewed Mar 6, 2024

View reviewed changes

src/libs/actions/IOU.ts Outdated Show resolved Hide resolved

tienifr added 2 commits March 7, 2024 11:49

merge main

a54129e

refactor

d46b13a

situchan approved these changes Mar 7, 2024

View reviewed changes

melvin-bot bot requested a review from iwiznia March 7, 2024 06:43

iwiznia requested changes Mar 7, 2024

View reviewed changes

refactor

c290a70

iwiznia approved these changes Mar 8, 2024

View reviewed changes

iwiznia merged commit a2c24e1 into Expensify:main Mar 8, 2024
15 checks passed

melvin-bot bot added the Emergency label Mar 8, 2024

iwiznia removed the Emergency label Mar 8, 2024

iwiznia mentioned this pull request Mar 8, 2024

[HOLD] Revert "fix: Approving a report causes the workspace chat to “flash” in the LHN before disappearing" #37996

Merged

github-actions bot mentioned this pull request Mar 11, 2024

Deploy Checklist: New Expensify 2024-03-11 #38037

Closed

49 tasks

melvin-bot bot mentioned this pull request Mar 12, 2024

[HOLD for payment 2024-03-19] [$500] Approving a report causes the workspace chat to “flash” in the LHN before disappearing #35309

Closed

6 tasks

lanitochka17 mentioned this pull request Mar 12, 2024

[$500] LHN - Report is not marked as unread in LHN when the IOU is received #38186

Closed

6 tasks

allgandalf reviewed Jul 10, 2024

View reviewed changes

allgandalf mentioned this pull request Jul 10, 2024

[HOLD for payment 2024-07-10] [$250] Partial approved reports don’t have GBR in the LHN #43014

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Approving a report causes the workspace chat to “flash” in the LHN before disappearing #35928

fix: Approving a report causes the workspace chat to “flash” in the LHN before disappearing #35928

tienifr commented Feb 6, 2024 •

edited

Loading

melvin-bot bot commented Feb 6, 2024

tienifr commented Feb 23, 2024

situchan commented Feb 25, 2024

tienifr commented Feb 26, 2024

This comment was marked as outdated.

situchan left a comment

tienifr commented Feb 27, 2024

tienifr commented Feb 27, 2024

tienifr commented Feb 29, 2024

tienifr commented Mar 1, 2024

situchan left a comment

tienifr commented Mar 4, 2024

tienifr commented Mar 6, 2024

situchan commented Mar 6, 2024

situchan commented Mar 6, 2024

tienifr commented Mar 7, 2024

iwiznia Mar 7, 2024

situchan Mar 7, 2024 •

edited

Loading

iwiznia Mar 7, 2024

iwiznia Mar 7, 2024

iwiznia Mar 7, 2024

iwiznia Mar 7, 2024

iwiznia Mar 7, 2024

tienifr commented Mar 8, 2024

melvin-bot bot commented Mar 8, 2024

OSBotify commented Mar 8, 2024

iwiznia commented Mar 8, 2024

situchan commented Mar 8, 2024

OSBotify commented Mar 12, 2024

allgandalf Jul 10, 2024

fix: Approving a report causes the workspace chat to “flash” in the LHN before disappearing #35928

fix: Approving a report causes the workspace chat to “flash” in the LHN before disappearing #35928

Conversation

tienifr commented Feb 6, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 6, 2024

tienifr commented Feb 23, 2024

situchan commented Feb 25, 2024

tienifr commented Feb 26, 2024

This comment was marked as outdated.

situchan left a comment

Choose a reason for hiding this comment

tienifr commented Feb 27, 2024

tienifr commented Feb 27, 2024

tienifr commented Feb 29, 2024

tienifr commented Mar 1, 2024

situchan left a comment

Choose a reason for hiding this comment

tienifr commented Mar 4, 2024

tienifr commented Mar 6, 2024

situchan commented Mar 6, 2024

Reviewer Checklist

Screenshots/Videos

situchan commented Mar 6, 2024

tienifr commented Mar 7, 2024

iwiznia Mar 7, 2024

Choose a reason for hiding this comment

situchan Mar 7, 2024 • edited Loading

Choose a reason for hiding this comment

iwiznia Mar 7, 2024

Choose a reason for hiding this comment

iwiznia Mar 7, 2024

Choose a reason for hiding this comment

iwiznia Mar 7, 2024

Choose a reason for hiding this comment

iwiznia Mar 7, 2024

Choose a reason for hiding this comment

iwiznia Mar 7, 2024

Choose a reason for hiding this comment

tienifr commented Mar 8, 2024

melvin-bot bot commented Mar 8, 2024

OSBotify commented Mar 8, 2024

iwiznia commented Mar 8, 2024

situchan commented Mar 8, 2024

OSBotify commented Mar 12, 2024

allgandalf Jul 10, 2024

Choose a reason for hiding this comment

tienifr commented Feb 6, 2024 •

edited

Loading

situchan Mar 7, 2024 •

edited

Loading