Fix Share somewhere in assign task shows a wrong report #23338

bernhardoj · 2023-07-21T08:07:44Z

Details

In the assign task page, when we select an assignee, it will automatically find the report of the assignee (using getChatByParticipants) and set it as the value of Share somewhere. However, getChatByParticipants may find a wrong report that has the same participant, for example, task report. This PR make sure getChatByParticipants filtering out task, money request, chat room, and policy expense report.

Fixed Issues

$ #22433
PROPOSAL: #22433 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Prerequisite: user A assigns a task to user B

As user A:

Open Assign Task
Enter any title and go next
Open the assignee page
Select user B
Verify Share somewhere shows user B

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.

Screenshots/Videos

Web

Screen.Recording.2023-07-21.at.15.56.41.mov

Mobile Web - Chrome

Chrome.mp4

Mobile Web - Safari

Screen.Recording.2023-07-21.at.16.02.23.mov

Desktop

Screen.Recording.2023-07-21.at.16.01.55.mov

iOS

Screen.Recording.2023-07-21.at.16.04.35.mov

Android

New.Expensify.mp4

melvin-bot · 2023-07-21T08:07:49Z

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

bernhardoj · 2023-07-21T08:08:18Z

src/libs/ReportUtils.js

-        // Only return the room if it has all the participants and is not a policy room
-        return !isUserCreatedPolicyRoom(report) && _.isEqual(newParticipantList, _.sortBy(report.participantAccountIDs));
+        // Only return the chat if it has all the participants
+        return _.isEqual(newParticipantList, _.sortBy(report.participantAccountIDs));
    });


isUserCreatedPolicyRoom is included in isChatRoom

bernhardoj · 2023-07-21T08:10:08Z

If we take a look at the usages of getChatByParticipants, all of them use to find either 1:1 DM or group chat only, never thread, money request, task, chat room, and policy expense chat.

getChatByParticipants usages to find 1:1 DM chat

Request money

App/src/libs/actions/IOU.js

Lines 322 to 324 in 011a398

    
           if (!chatReport) { 
        
               chatReport = ReportUtils.getChatByParticipants([payerAccountID]); 
        
           }

Send money (the code is still there)

App/src/libs/actions/IOU.js

Lines 924 to 926 in 011a398

    
           if (!chatReport) { 
        
               chatReport = ReportUtils.getChatByParticipants([recipientAccountID]); 
        
           }

Split bill

App/src/libs/actions/IOU.js

Lines 602 to 603 in 011a398

    
           const existingChatReport = ReportUtils.getChatByParticipants([accountID]); 
        
           isNewOneOnOneChatReport = !existingChatReport;

Message user

App/src/pages/ProfilePage.js

Lines 210 to 213 in 011a398

    
           <MenuItem 
        
               title={`${props.translate('common.message')}${displayName}`} 
        
               icon={Expensicons.ChatBubble} 
        
               onPress={() => Report.navigateToAndOpenReportWithAccountIDs([accountID])}

App/src/libs/actions/Report.js

Lines 556 to 558 in 011a398

    
           function navigateToAndOpenReportWithAccountIDs(participantAccountIDs) { 
        
               let newChat = {}; 
        
               const chat = ReportUtils.getChatByParticipants(participantAccountIDs);

Create task

App/src/libs/actions/Task.js

Lines 50 to 52 in 011a398

    
           // Grab the assigneeChatReportID if there is an assignee and if it's not the same as the parentReportID 
        
           // then we create an optimistic add comment report action on the assignee's chat to notify them of the task 
        
           const assigneeChatReportID = lodashGet(ReportUtils.getChatByParticipants([assigneeAccountID]), 'reportID');

Edit task

App/src/libs/actions/Task.js

Lines 374 to 378 in 011a398

    
           // If we make a change to the assignee, we want to add a comment to the assignee's chat 
        
           let optimisticAssigneeAddComment; 
        
           let assigneeChatReportID; 
        
           if (assigneeAccountID && assigneeAccountID !== report.managerID && assigneeAccountID !== ownerAccountID) { 
        
               assigneeChatReportID = ReportUtils.getChatByParticipants([assigneeAccountID]).reportID;

Auto-assign Share somewhere, which is our issue

App/src/libs/actions/Task.js

Lines 533 to 541 in 011a398

    
           const chat = ReportUtils.getChatByParticipants([newAssigneeAccountID]); 
        
           if (!chat) { 
        
               newChat = ReportUtils.buildOptimisticChatReport([newAssigneeAccountID]); 
        
           } 
        
           const reportID = chat ? chat.reportID : newChat.reportID; 
        
           if (!shareDestination) { 
        
               setShareDestinationValue(reportID); 
        
           }

getChatByParticipants usages to find group chat

Split bill

App/src/libs/actions/IOU.js

Lines 456 to 458 in 011a398

    
           const existingGroupChatReport = existingGroupChatReportID 
        
               ? chatReports[`${ONYXKEYS.COLLECTION.REPORT}${existingGroupChatReportID}`] 
        
               : ReportUtils.getChatByParticipants(participantAccountIDs);

So, this PR will fix all bugs in all usages above. Here is one of the examples that the getChatByParticipants bug affecting other parts.

Screen.Recording.2023-07-21.at.14.15.17.mov

abdulrahuman5196 · 2023-07-23T13:43:02Z

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 / Chrome
- iOS / native
- iOS / 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 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

Web

Screen.Recording.2023-07-23.at.6.39.59.PM.mp4

Mobile Web - Chrome

az_recorder_20230723_185301.mp4

Mobile Web - Safari

Untitled.mp4

Desktop

Screen.Recording.2023-07-23.at.6.56.49.PM.mp4

iOS

Screen.Recording.2023-07-23.at.7.09.00.PM.mp4

Android

az_recorder_20230723_190436.mp4

abdulrahuman5196 · 2023-07-23T13:46:37Z

@bernhardoj Thank you for checking all the instances of getChatByParticipants. Much appreciated.

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @robertjchen

🎀 👀 🎀
C+ Reviewed

robertjchen

LGTM!

OSBotify · 2023-07-24T04:41:51Z

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

OSBotify · 2023-07-25T01:43:42Z

🚀 Deployed to staging by https://github.com/robertjchen in version: 1.3.45-0 🚀

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

OSBotify · 2023-07-26T15:53:13Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.45-7 🚀

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

bernhardoj added 2 commits July 21, 2023 15:41

filter out task, money request, chat room, and policy expense report

72c999e

fix typo

0783509

bernhardoj requested a review from a team as a code owner July 21, 2023 08:07

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team July 21, 2023 08:07

bernhardoj commented Jul 21, 2023

View reviewed changes

abdulrahuman5196 approved these changes Jul 23, 2023

View reviewed changes

melvin-bot bot requested a review from robertjchen July 23, 2023 13:48

robertjchen approved these changes Jul 24, 2023

View reviewed changes

robertjchen merged commit 48edd31 into Expensify:main Jul 24, 2023

OSBotify mentioned this pull request Jul 25, 2023

Deploy Checklist: New Expensify 2023-07-25 #23522

Closed

melvin-bot bot mentioned this pull request Jul 26, 2023

[HOLD for payment 2023-08-02] [$1000] Web - Task Assignment Anomaly: Auto-Generated Content with unexpected character and Random Avatar in "Share Somewhere" Field of Task Assignment #22433

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Share somewhere in assign task shows a wrong report #23338

Fix Share somewhere in assign task shows a wrong report #23338

bernhardoj commented Jul 21, 2023

melvin-bot bot commented Jul 21, 2023

bernhardoj Jul 21, 2023

bernhardoj commented Jul 21, 2023 •

edited

Loading

abdulrahuman5196 commented Jul 23, 2023 •

edited

Loading

abdulrahuman5196 commented Jul 23, 2023

abdulrahuman5196 left a comment

robertjchen left a comment

OSBotify commented Jul 24, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

Fix Share somewhere in assign task shows a wrong report #23338

Fix Share somewhere in assign task shows a wrong report #23338

Conversation

bernhardoj commented Jul 21, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 21, 2023

bernhardoj Jul 21, 2023

Choose a reason for hiding this comment

bernhardoj commented Jul 21, 2023 • edited Loading

abdulrahuman5196 commented Jul 23, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 commented Jul 23, 2023

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

robertjchen left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 24, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

bernhardoj commented Jul 21, 2023 •

edited

Loading

abdulrahuman5196 commented Jul 23, 2023 •

edited

Loading