Fix Avatar has no tooltip in thread report header and displaying "fake" text in WS chat #20504

hoangzinh · 2023-06-09T10:32:22Z

Details

Fixed Issues

$ #19825
PROPOSAL: #19825 (comment)

Tests

Create new room from any workspace (if not exist)
Send any message in room chat
Thread that message
Verify that tooltip showing thread creator's email when hover avatar on thread report header or on LHN
Create a Workspace chat (if not exist)
Repeat 2->4
Go to Search page
Search threads above
Verify that tooltip showing creator's email for those threads in Search page

Verify that no errors appear in the JS console

Offline tests

This tooltip is not affected by network

QA Steps

Same as Tests

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
- 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-06-09.at.22.49.23.-.web.mov

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

Screen.Recording.2023-06-09.at.18.41.15.-.desktop.mov

iOS

N/A

Android

N/A

hoangzinh · 2023-06-09T10:38:23Z

src/pages/home/HeaderView.js

@@ -116,7 +116,7 @@ const HeaderView = (props) => {
    }
    const shouldShowThreeDotsButton = !!threeDotMenuItems.length;

-    const shouldShowSubscript = isPolicyExpenseChat && !props.report.isOwnPolicyExpenseChat && !ReportUtils.isArchivedRoom(props.report) && !isTaskReport;
+    const shouldShowSubscript = isPolicyExpenseChat && !props.report.isOwnPolicyExpenseChat && !ReportUtils.isArchivedRoom(props.report) && !isTaskReport && !isThread;


I'm not sure should we centralize the logic to show subscript by reuse ReportUtils.shouldReportShowSubscript, there are some differences between them so I leave as it is.

I don't see any reason why subscript visibility of LHN avatar and report header avatar are inconsistent.
There are 4 instances where subscript avatar visibility is calculated:

App/src/libs/ReportUtils.js

Lines 2122 to 2131 in 0a947cc

function shouldReportShowSubscript(report) {

if (isArchivedRoom(report)) {

return false;

}

if (isPolicyExpenseChat(report) && !report.isOwnPolicyExpenseChat) {

return true;

}

return isExpenseReport(report);

App/src/libs/OptionsListUtils.js

Line 422 in 0a947cc

result.shouldShowSubscript = result.isPolicyExpenseChat && !report.isOwnPolicyExpenseChat && !result.isArchivedRoom;

App/src/pages/home/HeaderView.js

Line 119 in 0a947cc

const shouldShowSubscript = isPolicyExpenseChat && !props.report.isOwnPolicyExpenseChat && !ReportUtils.isArchivedRoom(props.report) && !isTaskReport;

App/src/pages/home/report/ReportActionsList.js

Lines 134 to 137 in 0a947cc

shouldShowSubscriptAvatar={

(ReportUtils.isPolicyExpenseChat(report) || ReportUtils.isExpenseReport(report)) &&

_.contains([CONST.REPORT.ACTIONS.TYPE.IOU, CONST.REPORT.ACTIONS.TYPE.REPORTPREVIEW], reportAction.actionName)

}

I think we should combine all of these into one (except last case).

let me try to consolidate them

So the condition to show Subscript should be:

function shouldReportShowSubscript(report) { if (isArchivedRoom(report)) { return false; } if (isPolicyExpenseChat(report) && !isThread(report) && !isTaskReport(report) && !report.isOwnPolicyExpenseChat) { return true; } return isExpenseReport(report); }

Do you agree @0xmiroslav?

yes agree. only the concern is isExpenseReport. let's test all cases thoroughly in all pages (LHN, Search, header)

@0xmiroslav I have updated PR and also add more steps to Tests. Please help to review it again. Thanks

melvin-bot · 2023-06-09T11:43:47Z

@puneetlath @rushatgabhane One of you needs to 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]

0xmiros

I think this should also be fixed here since they have the same root cause.

0xmiros · 2023-06-09T12:15:04Z

src/pages/home/HeaderView.js

@@ -116,7 +116,7 @@ const HeaderView = (props) => {
    }
    const shouldShowThreeDotsButton = !!threeDotMenuItems.length;

-    const shouldShowSubscript = isPolicyExpenseChat && !props.report.isOwnPolicyExpenseChat && !ReportUtils.isArchivedRoom(props.report) && !isTaskReport;
+    const shouldShowSubscript = isPolicyExpenseChat && !props.report.isOwnPolicyExpenseChat && !ReportUtils.isArchivedRoom(props.report) && !isTaskReport && !isThread;


I don't see any reason why subscript visibility of LHN avatar and report header avatar are inconsistent.
There are 4 instances where subscript avatar visibility is calculated:

App/src/libs/ReportUtils.js

Lines 2122 to 2131 in 0a947cc

function shouldReportShowSubscript(report) {

if (isArchivedRoom(report)) {

return false;

}

if (isPolicyExpenseChat(report) && !report.isOwnPolicyExpenseChat) {

return true;

}

return isExpenseReport(report);

App/src/libs/OptionsListUtils.js

Line 422 in 0a947cc

result.shouldShowSubscript = result.isPolicyExpenseChat && !report.isOwnPolicyExpenseChat && !result.isArchivedRoom;

App/src/pages/home/HeaderView.js

Line 119 in 0a947cc

const shouldShowSubscript = isPolicyExpenseChat && !props.report.isOwnPolicyExpenseChat && !ReportUtils.isArchivedRoom(props.report) && !isTaskReport;

App/src/pages/home/report/ReportActionsList.js

Lines 134 to 137 in 0a947cc

shouldShowSubscriptAvatar={

(ReportUtils.isPolicyExpenseChat(report) || ReportUtils.isExpenseReport(report)) &&

_.contains([CONST.REPORT.ACTIONS.TYPE.IOU, CONST.REPORT.ACTIONS.TYPE.REPORTPREVIEW], reportAction.actionName)

}

I think we should combine all of these into one (except last case).

0xmiros · 2023-06-09T20:10:36Z

Thread chat created from workspace chat seems broken. Happening on main so out of scope

__fake__.mov

0xmiros · 2023-06-09T20:47:04Z

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

web1.mov

web2.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

0xmiros

@puneetlath Looks good, tests well on all cases

puneetlath

Nice job with this. Good use of a helper method.

OSBotify · 2023-06-13T00:32:18Z

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

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

OSBotify · 2023-06-13T01:06:29Z

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

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

OSBotify · 2023-06-14T21:22:36Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.27-7 🚀

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

hoangzinh added 2 commits June 9, 2023 17:24

Fix tooltip displays as __fake__ for thread from WS chat

9ce7a11

Show tooltip if it's a Thread in HeaderView

51a4b93

hoangzinh commented Jun 9, 2023

View reviewed changes

Show tooltip for thread chatRoom in LHN

e60ef88

hoangzinh marked this pull request as ready for review June 9, 2023 11:43

hoangzinh requested a review from a team as a code owner June 9, 2023 11:43

melvin-bot bot requested review from puneetlath and rushatgabhane and removed request for a team June 9, 2023 11:43

hoangzinh mentioned this pull request Jun 9, 2023

[HOLD for payment 2023-06-21] [$1000] Avatar has no tooltip in thread report header #19825

Closed

6 tasks

0xmiros suggested changes Jun 9, 2023

View reviewed changes

hoangzinh added 2 commits June 9, 2023 21:44

Use same logic for checking should show subscript for a report

e7684a5

Show tooltip for thread chatRoom in Search page

5d46b3d

0xmiros approved these changes Jun 9, 2023

View reviewed changes

puneetlath approved these changes Jun 9, 2023

View reviewed changes

puneetlath merged commit 2381734 into Expensify:main Jun 9, 2023

OSBotify mentioned this pull request Jun 12, 2023

Deploy Checklist: New Expensify 2023-06-12 #20640

Closed

71 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Avatar has no tooltip in thread report header and displaying "fake" text in WS chat #20504

Fix Avatar has no tooltip in thread report header and displaying "fake" text in WS chat #20504

hoangzinh commented Jun 9, 2023 •

edited

Loading

hoangzinh Jun 9, 2023

0xmiros Jun 9, 2023

hoangzinh Jun 9, 2023

hoangzinh Jun 9, 2023

0xmiros Jun 9, 2023

hoangzinh Jun 9, 2023

melvin-bot bot commented Jun 9, 2023

0xmiros left a comment

0xmiros Jun 9, 2023

0xmiros commented Jun 9, 2023

0xmiros commented Jun 9, 2023

0xmiros left a comment

puneetlath left a comment

OSBotify commented Jun 13, 2023

OSBotify commented Jun 13, 2023

OSBotify commented Jun 14, 2023

	function shouldReportShowSubscript(report) {
	if (isArchivedRoom(report)) {
	return false;
	}

	if (isPolicyExpenseChat(report) && !report.isOwnPolicyExpenseChat) {
	return true;
	}

	return isExpenseReport(report);

	shouldShowSubscriptAvatar={
	(ReportUtils.isPolicyExpenseChat(report) \|\| ReportUtils.isExpenseReport(report)) &&
	_.contains([CONST.REPORT.ACTIONS.TYPE.IOU, CONST.REPORT.ACTIONS.TYPE.REPORTPREVIEW], reportAction.actionName)
	}

Fix Avatar has no tooltip in thread report header and displaying "__fake__" text in WS chat #20504

Fix Avatar has no tooltip in thread report header and displaying "__fake__" text in WS chat #20504

Conversation

hoangzinh commented Jun 9, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

hoangzinh Jun 9, 2023

Choose a reason for hiding this comment

0xmiros Jun 9, 2023

Choose a reason for hiding this comment

hoangzinh Jun 9, 2023

Choose a reason for hiding this comment

hoangzinh Jun 9, 2023

Choose a reason for hiding this comment

0xmiros Jun 9, 2023

Choose a reason for hiding this comment

hoangzinh Jun 9, 2023

Choose a reason for hiding this comment

melvin-bot bot commented Jun 9, 2023

0xmiros left a comment

Choose a reason for hiding this comment

0xmiros Jun 9, 2023

Choose a reason for hiding this comment

0xmiros commented Jun 9, 2023

0xmiros commented Jun 9, 2023

Reviewer Checklist

Screenshots/Videos

0xmiros left a comment

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 13, 2023

OSBotify commented Jun 13, 2023

OSBotify commented Jun 14, 2023

Fix Avatar has no tooltip in thread report header and displaying "fake" text in WS chat #20504

Fix Avatar has no tooltip in thread report header and displaying "fake" text in WS chat #20504

hoangzinh commented Jun 9, 2023 •

edited

Loading