Feat: Update how GBR is determined for IOU/expense reports #30655

puneetlath · 2023-10-31T20:11:47Z

Details

This is a copy of #29778 with a couple commits added. It updates how the GBR is determined in the LHN on the client.

Fixed Issues

$ #29595

Tests

From accountA create a workspace
Invite accountB to the workspace
Create a DM with accountB and request money from them
Log into accountB
Verify you see the Green dot on your DM with accountA
From the DM, create a task and assign it to accountA
In your workspace chat, request money
Sign into accountA
Verify you see the green dot on your DM with accountB
Verify you see the green dot on accountB's workspace chat
Mark the task as completed
Mark the expense report as "paid elsewhere"
Verify you don't see any green dots

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

N/A

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 / 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
- 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(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 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.

Behaviour is the same for all platforms, attaching screenshots for focused and most recent for IOU green dot

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…BR-is-determined

akinwale · 2023-10-31T20:17:14Z

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(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 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

MacOS: Desktop

melvin-bot · 2023-10-31T20:43:36Z

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

src/libs/ReportUtils.js

src/libs/SidebarUtils.ts

Co-authored-by: Marc Glasser <[email protected]>

marcaaron · 2023-10-31T22:43:23Z

src/libs/ReportUtils.js

-
-        // Current user is an admin and the report has been approved but not settled yet
-        return policy.role === CONST.POLICY.ROLE.ADMIN && isReportApproved(report);
+    if (option.isUnreadWithMention) {


Will a report ever have this property?

Crap, no it will not. Updated to check. Alternate would be to add the lastReadTime and lastMentionedTime to the optionItem. But I don't really love that either.

marcaaron

Few other small comments - idk if they need to be blockers.

marcaaron · 2023-10-31T22:55:20Z

src/libs/ReportUtils.js

+ * @param {Object} [parentReportAction] - The parent report action of the report (Used to check if the task has been canceled)
+ * @returns {Boolean}
+ */
+function isWaitingForAssigneeToCompleteTask(report, parentReportAction = {}) {


Looks like this one could also be an "option"

Idk though maybe we can do a follow up to address as long as all of these other methods are referencing fields that will exist on either a report or an option.

Seems like for the most part all the things we need are there 🤷

marcaaron · 2023-10-31T23:08:37Z

src/components/LHNOptionsList/OptionRowLHN.js

@@ -116,8 +116,7 @@ function OptionRowLHN(props) {

    const hasBrickError = optionItem.brickRoadIndicator === CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR;
    const defaultSubscriptSize = optionItem.isExpenseRequest ? CONST.AVATAR_SIZE.SMALL_NORMAL : CONST.AVATAR_SIZE.DEFAULT;
-    const shouldShowGreenDotIndicator =
-        !hasBrickError && (optionItem.isUnreadWithMention || optionItem.isWaitingForTaskCompleteFromAssignee || ReportUtils.isWaitingForIOUActionFromCurrentUser(optionItem));
+    const shouldShowGreenDotIndicator = !hasBrickError && ReportUtils.requiresAttentionFromCurrentUser(optionItem, optionItem.parentReportAction);


I see we are using either the report (in this case, "option") or the parentReportAction to determine if the task is canceled. Why do we only pass the parentReportAction here?

marcaaron · 2023-10-31T23:27:00Z

src/libs/ReportUtils.js


-        // Current user is an admin and the report has been approved but not settled yet
-        return policy.role === CONST.POLICY.ROLE.ADMIN && isReportApproved(report);
+    if (option.isUnreadWithMention || isUnreadWithMention(option)) {


Seems fine. Though - someone could possibly do something silly like add just one of the option.lastReadTime or option.lastMentionedTime. Can protect against this by only calling isUnreadWithMention() with option when option.isUnreadWithMention is undefined.

Not gonna block on that, but I think this review has kind of highlighted that the code needs reworking or something.

I created this follow up to try and find a way to make this better: #30668

puneetlath · 2023-10-31T23:45:01Z

Thanks for the thorough review @marcaaron! I'm going to go ahead and merge this, but I created this follow up to try and clean up some of this logic to make it easier to follow/less likely to cause future bugs. #30668

OSBotify · 2023-11-02T10:38:35Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.95-0 🚀

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

Beamanator · 2023-11-03T09:58:14Z

src/libs/ReportUtils.js

-        if (isReportManager(report) && !isReportApproved(report)) {
-            return true;
-        }
+    if (isArchivedRoom(getReport(option.parentReportID))) {


@puneetlath did you think about the case of archived options too? see #30824 (comment)

Ah yeah, I'm not sure why we did it this way. Thanks for handling!

…R-is-determined" This reverts commit 3634718, reversing changes made to 342a2c4.

OSBotify · 2023-11-06T22:08:38Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.95-9 🚀

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

OSBotify · 2023-11-06T22:35:58Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.96-0 🚀

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

OSBotify · 2023-11-09T22:53:31Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

waterim and others added 17 commits October 17, 2023 16:17

add hasOutstandingChildRequest verification

cb3f3d0

adjusted and removed unused parts

ddba0ec

clean up show GBR

4fca049

Merge remote-tracking branch 'upstream/main' into feat-29595-Update-G…

7523bd6

…BR-is-determined

Merge remote-tracking branch 'upstream/main' into feat-29595-Update-G…

b8b6752

…BR-is-determined

tests

f6b79e6

fix lint

f4cb009

tests fix

63f6bd8

updated text

647efb8

fix GBR display

de9e121

Merge remote-tracking branch 'upstream/main' into feat-29595-Update-G…

2bb9228

…BR-is-determined

changes

bfb06ae

remove iou ordering

a9c9ef2

lint fix

0ce0891

Merge remote-tracking branch 'upstream/main' into feat-29595-Update-G…

dd4a7bb

…BR-is-determined

Add task logic to shouldShowGBR

c79c9f1

Use or instead of null coalescing in getOrderedReportIDs

c497922

puneetlath changed the title ~~Feat 29595 update gbr is determined~~ [HOLD] Feat: Update how GBR is determined for IOU/expense reports Oct 31, 2023

puneetlath added 3 commits October 31, 2023 16:23

Update pinned logic for linter

8e1ad6d

Add tests for various shouldShowGBR cases

1195a83

Remove unneeded import

3e938c6

puneetlath marked this pull request as ready for review October 31, 2023 20:43

puneetlath requested a review from a team as a code owner October 31, 2023 20:43

melvin-bot bot requested review from ntdiary and removed request for a team October 31, 2023 20:43

puneetlath self-assigned this Oct 31, 2023

puneetlath requested review from akinwale and amyevans October 31, 2023 20:43

amyevans previously approved these changes Oct 31, 2023

View reviewed changes

marcaaron requested changes Oct 31, 2023

View reviewed changes

Rename functions to separate UI from function logic

943bc80

puneetlath dismissed amyevans’s stale review via 943bc80 October 31, 2023 21:26

puneetlath and others added 4 commits October 31, 2023 22:26

Update src/libs/ReportUtils.js

d6eff10

Co-authored-by: Marc Glasser <[email protected]>

Rename shouldShowGBR to requiresAttentionFromCurrentUser in tests

fb9b40d

Rename shouldShowGBR in one more place

cc74887

Rename report to option in requiresAttentionFromCurrentUser

b35d1da

puneetlath requested a review from marcaaron October 31, 2023 22:40

marcaaron reviewed Oct 31, 2023

View reviewed changes

Account for both options and reports in unread check

efcefdb

puneetlath requested a review from marcaaron October 31, 2023 22:59

marcaaron reviewed Oct 31, 2023

View reviewed changes

marcaaron approved these changes Oct 31, 2023

View reviewed changes

puneetlath changed the title ~~[HOLD] Feat: Update how GBR is determined for IOU/expense reports~~ Feat: Update how GBR is determined for IOU/expense reports Oct 31, 2023

puneetlath merged commit 3634718 into main Oct 31, 2023
18 checks passed

puneetlath deleted the feat-29595-Update-GBR-is-determined branch October 31, 2023 23:45

OSBotify mentioned this pull request Nov 2, 2023

Deploy Checklist: New Expensify 2023-11-02 #30752

Closed

iwiznia mentioned this pull request Nov 2, 2023

[Wave 6: Workspace Chats] GBR shown on chats that shouldn't have them #30775

Closed

s-alves10 mentioned this pull request Nov 3, 2023

[HOLD for payment 2023-11-13] [$500] LHN - Green dot for money request is still displayed in spite of having deleted the workspace #30824

Closed

6 tasks

Beamanator reviewed Nov 3, 2023

View reviewed changes

AndrewGable mentioned this pull request Nov 3, 2023

[HOLD #30668] [$500] Chat - Unpinned deleted tasks assigned by another user are shown above other pinned messages #30798

Closed

6 tasks

AndrewGable added a commit that referenced this pull request Nov 3, 2023

Revert "Merge pull request #30655 from Expensify/feat-29595-Update-GB…

d37bb2c

…R-is-determined" This reverts commit 3634718, reversing changes made to 342a2c4.

melvin-bot bot mentioned this pull request Nov 6, 2023

[HOLD for payment 2023-11-13] [HOLD E/E #326097] [Wave 6: Workspace Chats] Update how GBR is determined for IOU/expense reports #29595

Closed

OSBotify mentioned this pull request Nov 6, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Update how GBR is determined for IOU/expense reports #30655

Feat: Update how GBR is determined for IOU/expense reports #30655

puneetlath commented Oct 31, 2023 •

edited

Loading

akinwale commented Oct 31, 2023

melvin-bot bot commented Oct 31, 2023

marcaaron Oct 31, 2023

puneetlath Oct 31, 2023

marcaaron left a comment

marcaaron Oct 31, 2023

marcaaron Oct 31, 2023

marcaaron Oct 31, 2023

marcaaron Oct 31, 2023

marcaaron Oct 31, 2023

puneetlath Oct 31, 2023

puneetlath commented Oct 31, 2023

OSBotify commented Nov 2, 2023

Beamanator Nov 3, 2023

puneetlath Nov 3, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 9, 2023

Feat: Update how GBR is determined for IOU/expense reports #30655

Feat: Update how GBR is determined for IOU/expense reports #30655

Conversation

puneetlath commented Oct 31, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

akinwale commented Oct 31, 2023

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Oct 31, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcaaron left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

puneetlath commented Oct 31, 2023

OSBotify commented Nov 2, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Nov 6, 2023

OSBotify commented Nov 6, 2023

OSBotify commented Nov 9, 2023

puneetlath commented Oct 31, 2023 •

edited

Loading