Use icon data to determine tool tips for `MultipleAvatars` #19104

grgia · 2023-05-17T09:27:17Z

Details

When we get all the icons for a report, every icon is an object that has a key name associated with its login. This is a much more reliable source to match for the tooltips.

Fixed Issues

$ #19091

Tests

(WEB / DESKTOP ONLY)

Verify that no errors appear in the JS console
For the following cases of multiple avatars, ensure that tool tips show the correct information in Header, LHN, Report Action etc.
- a DM
- a workspace chat
- a thread (in replies preview and in report header)
- a group chat
- IOU preview
- Archived room

Offline tests

QA Steps

(WEB / DESKTOP ONLY)

Verify that no errors appear in the JS console
For the following cases of multiple avatars, ensure that tool tips show the correct login in Header, LHN, Report Action etc.
- a DM
- a workspace chat
- a thread (in replies preview and in report header)
- a group chat
- IOU preview
- Archived room

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

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

iOS

N/A

Android

N/A

melvin-bot · 2023-05-17T09:38:31Z

@s77rt @tgolen 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]

stitesExpensify

Code looks great, solid cleanup. I haven't tested though, I'll leave that to @s77rt

s77rt

Looks good but the design may contradict with current behaviour so need to be sure we want that change.

src/components/MultipleAvatars.js

s77rt · 2023-05-17T19:46:40Z

src/components/LHNOptionsList/OptionRowLHN.js

@@ -138,7 +137,6 @@ const OptionRowLHN = (props) => {
                                                props.isFocused ? StyleUtils.getBackgroundAndBorderStyle(focusedBackgroundColor) : undefined,
                                                hovered && !props.isFocused ? StyleUtils.getBackgroundAndBorderStyle(hoveredBackgroundColor) : undefined,
                                            ]}
-                                            avatarTooltips={optionItem.isPolicyExpenseChat ? [optionItem.subtitle] : avatarTooltips}


NAB but we used to show 'Workspace' instead of the workspace's name.

@JmillsExpensify @shawnborton is Showing Workspace the desire behavior here?

Hmm what do we do for users? I feel like we stay consistent and just always show the room title?

for users we show the login email

Interesting... I lean towards just using the room title, or basically whatever the text to the right of the avatar or the chat header says?

I agree, I think this change is fine in that case. Also, I think rooms don't use tooltips currently, so this would only be for Workspace chats.

src/components/OptionRow.js

src/pages/workspace/WorkspaceInviteMessagePage.js

grgia · 2023-05-17T20:32:43Z

@s77rt pushed changes

tgolen · 2023-05-17T20:36:56Z

src/components/MultipleAvatars.js

@@ -66,7 +70,7 @@ const MultipleAvatars = (props) => {
    if (props.icons.length === 1 && !props.shouldStackHorizontally) {
        return (
            <View style={avatarContainerStyles}>
-                <Tooltip text={props.icons[0].name}>
+                <Tooltip text={props.shouldShowTooltip && props.icons[0].name}>


Hm, so, I've got a question here... if we don't want to show the tooltip, why is it being rendered at all? Should this maybe be more like {props.shouldShowTooltip && <Tooltip>}?

This was the previous pattern used, we would usually do a check like tooltips = showTooltip ? <tooltips> : undefined and just pass in undefined for the tooltips

maybe shouldShowTooltipText is a better name for this, since I think having the mouse change is still useful even when we dont show the text

Would you mind shooting me a screenshot (or maybe a video) of what happens with a tooltip when this props.shouldShowTooltip is false? I think maybe I'm just misunderstanding what it's supposed to do.

Screen.Recording.2023-05-18.at.11.15.05.AM.mov

it changes the mouse to indicate it's clickable, but no tooltip appears

Thanks! I think that we should not be relying on a non-rendered tooltip for that (it feels like it's a side effect that's being abused and isn't very obvious). What I suggest is:

Not rendering <Tooltip> if we aren't showing a tooltip

Use a style to change the cursor if <Tooltip> is not rendered

How difficult would it be to do that?

I think the mouse cursor is due to the fact that the avatars are clickable and not related to the tooltip.
We have already changed the behaviour a little and the <Tooltip /> will render the child as is if there is no tooltip to show.

App/src/components/Tooltip/index.js

Lines 151 to 153 in 9e43cb7

if ((_.isEmpty(this.props.text) && this.props.renderTooltipContent == null) || !this.hasHoverSupport) {

return this.props.children;

}

OK, that should work. Thanks

While looking at the changes to <Tooltip> I think it would have been helpful to have the comment for text propType to mention that when text is empty, only the children will be displayed. I don't think it's obvious anywhere in the code that the text prop would control that. You would only know it if you looked at the render method, which shouldn't be necessary when implementing a component.

App/src/components/Tooltip/index.js

Line 149 in 9e43cb7

// Skip the tooltip and return the children if the text is empty,

This is the current comment

src/components/OptionRow.js

src/components/MultipleAvatars.js

s77rt · 2023-05-18T13:42:27Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

s77rt

LGTM! 🚀

tgolen

We talked briefly 1:1 about a possible way to clean this up so that the styles and the props make more sense. Right now, the <MultipleAvatars> is very coupled to whatever is rendering it (ie. it needs to know that it's rendered in a report action, the search, the LHN, or an IOU preview, etc.). This makes it hard to reuse. Let's extract this out a little bit by adding these separate props to <MultipleAvatars>:

borderColor
borderColorHovered
borderColorPressed

NAB: at some point it would be good to split <MultipleAvatars> into two separate components:

<MultipleAvatars>
<MultipleAvatarsHorizontal>

tgolen · 2023-05-22T12:26:54Z

src/components/MultipleAvatars.js

@@ -43,6 +43,9 @@ const propTypes = {

    /** Whether to show the toolip text */
    shouldShowTooltip: PropTypes.bool,
+
+    /** Whether avatars are displayed within an IOUAction */


NAB: this comment could be a little bit better like this (since it doesn't actually have anything to do with IOUs)

Suggested change

/** Whether avatars are displayed within an IOUAction */

/** Whether avatars are displayed with the highlighted background color instead of the app background color. This is primarily the case for IOU previews. */

grgia · 2023-05-23T11:05:41Z

@s77rt @tgolen updated a comment, should be ready for final review!

tgolen · 2023-05-23T13:24:25Z

Ah, did you decide to not make these changes for the styles then? #19104 (review)

grgia · 2023-05-24T05:34:02Z

@tgolen I started to work on those in a separate PR, do you think that they should be done in this PR?

tgolen · 2023-05-24T08:33:44Z

I think a separate PR is OK as long as it gets done 👍

OSBotify · 2023-05-24T08:42:29Z

✋ 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-05-25T00:34:15Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-25T01:07:47Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-25T01:29:43Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.18-0 🚀

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

mvtglobally · 2023-05-25T03:46:15Z

@grgia Do we need to QA anything here?

grgia · 2023-05-25T08:22:39Z

@mvtglobally yes, I updated the QA steps

OSBotify · 2023-05-26T07:06:55Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.18-2 🚀

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

Because icons contain name data, deprecate avatarToolTips

db75baf

grgia self-assigned this May 17, 2023

grgia marked this pull request as ready for review May 17, 2023 09:37

grgia requested a review from a team as a code owner May 17, 2023 09:37

melvin-bot bot requested review from s77rt and tgolen and removed request for a team May 17, 2023 09:38

grgia added 2 commits May 17, 2023 11:14

prettier

b44b0fb

Merge branch 'main' into georgia-threadToolTip

a60e052

tgolen previously approved these changes May 17, 2023

View reviewed changes

stitesExpensify previously approved these changes May 17, 2023

View reviewed changes

s77rt suggested changes May 17, 2023

View reviewed changes

add shouldShowTooltip flag

2992ec6

grgia dismissed stale reviews from stitesExpensify and tgolen via 2992ec6 May 17, 2023 20:32

grgia requested review from s77rt, tgolen, stitesExpensify and shawnborton May 17, 2023 20:32

tgolen reviewed May 17, 2023

View reviewed changes

rename to shouldShowTooltipText

5f67530

s77rt suggested changes May 17, 2023

View reviewed changes

src/components/OptionRow.js Outdated Show resolved Hide resolved

src/components/MultipleAvatars.js Outdated Show resolved Hide resolved

Clean up

4ca6eb9

grgia requested review from s77rt and tgolen May 18, 2023 10:29

s77rt suggested changes May 18, 2023

View reviewed changes

src/components/MultipleAvatars.js Outdated Show resolved Hide resolved

src/components/MultipleAvatars.js Outdated Show resolved Hide resolved

grgia added 2 commits May 18, 2023 13:34

missed one use of tooltipTexts

718ae00

use toolTipTexts everywhere

b39d48a

add back conditionals for showing tooltips

6c2d6df

grgia requested a review from s77rt May 22, 2023 09:52

grgia added 3 commits May 22, 2023 11:05

Merge branch 'main' into georgia-threadToolTip

0ab1a28

prettier

bdb2659

tooltip comment for text proptype

9103839

s77rt previously approved these changes May 22, 2023

View reviewed changes

tgolen requested changes May 22, 2023

View reviewed changes

update comment for shouldUseCardBackground prop

95dca1a

grgia dismissed s77rt’s stale review via 95dca1a May 23, 2023 11:05

grgia requested review from s77rt and tgolen May 23, 2023 11:05

s77rt approved these changes May 23, 2023

View reviewed changes

tgolen approved these changes May 24, 2023

View reviewed changes

tgolen merged commit 577b070 into main May 24, 2023

tgolen deleted the georgia-threadToolTip branch May 24, 2023 08:35

grgia mentioned this pull request May 24, 2023

Refactor MultipleAvatars #19526

Closed

s77rt mentioned this pull request May 24, 2023

[HOLD for payment 2023-06-02] Wrong tooltip in thread #19091

Closed

6 tasks

OSBotify mentioned this pull request May 25, 2023

Deploy Checklist: New Expensify 2023-05-25 #19565

Closed

53 tasks

	if ((_.isEmpty(this.props.text) && this.props.renderTooltipContent == null) \|\| !this.hasHoverSupport) {
	return this.props.children;
	}

	/** Whether avatars are displayed within an IOUAction */
	/** Whether avatars are displayed with the highlighted background color instead of the app background color. This is primarily the case for IOU previews. */

Use icon data to determine tool tips for MultipleAvatars #19104

Use icon data to determine tool tips for MultipleAvatars #19104

Conversation

grgia commented May 17, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 17, 2023

stitesExpensify left a comment

Choose a reason for hiding this comment

s77rt 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

grgia commented May 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

grgia May 17, 2023 • edited Loading

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

Choose a reason for hiding this comment

s77rt commented May 18, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

s77rt left a comment

Choose a reason for hiding this comment

tgolen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

grgia commented May 23, 2023

tgolen commented May 23, 2023

grgia commented May 24, 2023

tgolen commented May 24, 2023

OSBotify commented May 24, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

mvtglobally commented May 25, 2023

grgia commented May 25, 2023

OSBotify commented May 26, 2023

Use icon data to determine tool tips for `MultipleAvatars` #19104

Use icon data to determine tool tips for `MultipleAvatars` #19104

grgia commented May 17, 2023 •

edited

Loading

grgia May 17, 2023 •

edited

Loading

s77rt commented May 18, 2023 •

edited

Loading