Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DMs to show all avatars #21402

Merged
merged 16 commits into from
Jul 5, 2023

Conversation

WikusKriek
Copy link
Contributor

@WikusKriek WikusKriek commented Jun 23, 2023

Details

Feature request to show up to 8 person Avatars in DMs.

Fixed Issues

$ #15929 (comment)
PROPOSAL: #15929 (comment)

Tests

  1. Log into the app
  2. Create groups of different sizes
  3. Verify that avatars display according to design
  4. Verify that avatars resize Smaller with smaller screen and stack if there are more than 4
  5. Verify that avatars resize to Large when less than three person DM on a small screen
  6. Create a new workspace and invite 8 or more users, or invite more user to an existing workspace.
  7. Click next.
  8. Verify that the avatars displayed on the add message screen display according to the design
  9. Verify that the avatars are of Large size for the add message screen.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Test Steps

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
Web.Chrome.2023-07-04.at.18.07.43.mov
MacOS.Chrome.2023-06-23.at.17.01.14.mov
Mobile Web - Chrome
Android.Chrome.2023-07-04.at.18.55.37.mov
Android.Native.2023-06-23.at.17.30.34.mov
Mobile Web - Safari
IOS.Safari.2023-07-04.at.18.39.15.mov
IOS.Safari.2023-06-23.at.19.00.39.mov
Desktop
Desktop.2023-07-04.at.19.18.00.mov
MacOS.Desktop.2023-06-23.at.19.05.18.mov
iOS
IOS.Native.2023-07-04.at.18.34.36.mov
IOS.Native.2023-06-23.at.18.58.01.mov
Android
Android.Native.2023-07-04.at.18.50.22.mov
Android.Native.2023-06-23.at.17.30.34.mov

Signed-off-by: wikuskriek <wikus.kriek.2w@gmail.com>
Signed-off-by: wikuskriek <wikus.kriek.2w@gmail.com>
@WikusKriek
Copy link
Contributor Author

@mananjadhav would appreciate you just scanning this over and giving some feedback.

Signed-off-by: wikuskriek <wikus.kriek.2w@gmail.com>
Signed-off-by: wikuskriek <wikus.kriek.2w@gmail.com>
@WikusKriek WikusKriek marked this pull request as ready for review June 23, 2023 17:31
@WikusKriek WikusKriek requested a review from a team as a code owner June 23, 2023 17:31
@melvin-bot melvin-bot bot requested review from mananjadhav and shawnborton and removed request for a team June 23, 2023 17:31
@melvin-bot
Copy link

melvin-bot bot commented Jun 23, 2023

@shawnborton @mananjadhav 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]

@shawnborton
Copy link
Contributor

Nice, this looks good to me. Should we also update the invite to workspace flow where we show avatars as well?

cc @puneetlath for review too

@puneetlath
Copy link
Contributor

I only looked at the videos, not the code, but it looks good to me too!

@puneetlath
Copy link
Contributor

Should we also update the invite to workspace flow where we show avatars as well?

On that page it can be a theoretically infinite number of users right? Whereas on the group chat page it's max 8. If so, I think it's fine to leave the invite page as-is.

Or were you think we'd use the same pattern with up to 8?

@WikusKriek
Copy link
Contributor Author

Nice, this looks good to me. Should we also update the invite to workspace flow where we show avatars as well?

cc @puneetlath for review too

It will look something like this, might need to also just dynamically change avatar size. Some change will be needed for the +(more users) text logic. It currently overflows on both rows.

Screen.Recording.2023-06-24.at.08.37.16.mov

@puneetlath
Copy link
Contributor

That does look pretty nice.

@mananjadhav
Copy link
Collaborator

The screencasts look good, I am currently reviewing the code.

@shawnborton
Copy link
Contributor

Nice, I like that as well!

@puneetlath
Copy link
Contributor

Let's do it then @WikusKriek. And we can double the bounty for the scope increase.

@WikusKriek
Copy link
Contributor Author

@mananjadhav I have pushed more changes now related to workflow invite avatars.

@@ -191,6 +191,7 @@ class WorkspaceInviteMessagePage extends React.Component {
size={CONST.AVATAR_SIZE.LARGE}
icons={OptionsListUtils.getAvatarsForAccountIDs(_.values(this.props.invitedEmailsToAccountIDsDraft), this.props.personalDetails)}
shouldStackHorizontally
shouldStackVertically
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having both shouldStackHorizontally and shouldStackVertically sound confusing. Can we rename them better based on their use?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will leave shouldStackHorizontally as is and rename shlouldStackVertically to shouldDisplayAvatarsInRows.

@@ -57,20 +63,34 @@ const defaultProps = {
secondAvatarStyle: [StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)],
fallbackIcon: undefined,
shouldStackHorizontally: false,
shouldStackVertically: false,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should one of them be true by default?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No it is not a case of the one or the other. There is a case where both are false and it executes thie code

<View style={singleAvatarStyles}>
<UserDetailsTooltip accountID={props.icons[0].id}>
{/* View is necessary for tooltip to show for multiple avatars in LHN */}
<View>
<Avatar
source={props.icons[0].source || props.fallbackIcon}
fill={themeColors.iconSuccessFill}
size={props.isFocusMode ? CONST.AVATAR_SIZE.MID_SUBSCRIPT : CONST.AVATAR_SIZE.SMALLER}
imageStyles={[singleAvatarStyles]}
name={props.icons[0].name}
type={props.icons[0].type}
/>
</View>
</UserDetailsTooltip>
<View style={secondAvatarStyles}>
{props.icons.length === 2 ? (
<UserDetailsTooltip accountID={props.icons[1].id}>
<View>
<Avatar
source={props.icons[1].source || props.fallbackIcon}
fill={themeColors.iconSuccessFill}
size={props.isFocusMode ? CONST.AVATAR_SIZE.MID_SUBSCRIPT : CONST.AVATAR_SIZE.SMALLER}
imageStyles={[singleAvatarStyles]}
name={props.icons[1].name}
type={props.icons[1].type}
/>
</View>
</UserDetailsTooltip>
) : (
<Tooltip text={tooltipTexts.slice(1).join(', ')}>
<View style={[singleAvatarStyles, styles.alignItemsCenter, styles.justifyContentCenter]}>
<Text
selectable={false}
style={props.size === CONST.AVATAR_SIZE.SMALL ? styles.avatarInnerTextSmall : styles.avatarInnerText}
>
{`+${props.icons.length - 1}`}
</Text>
</View>
</Tooltip>
)}
</View>
</View>
)}
</View>

let avatarContainerStyles = props.size === CONST.AVATAR_SIZE.SMALL ? [styles.emptyAvatarSmall, styles.emptyAvatarMarginSmall] : [styles.emptyAvatar, styles.emptyAvatarMargin];
const singleAvatarStyles = props.size === CONST.AVATAR_SIZE.SMALL ? styles.singleAvatarSmall : styles.singleAvatar;
const secondAvatarStyles = [props.size === CONST.AVATAR_SIZE.SMALL ? styles.secondAvatarSmall : styles.secondAvatar, ...props.secondAvatarStyle];
const tooltipTexts = props.shouldShowTooltip ? _.pluck(props.icons, 'name') : [''];

useEffect(() => {
if (props.shouldStackVertically && props.icons.length > props.maxAvatars) {
const rowSize = Math.min(Math.ceil(props.icons.length / 2), props.maxAvatars);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move this block to another method? and have some comments there?

@WikusKriek
Copy link
Contributor Author

@shawnborton I have been trying to find, if we wanted to change the stacked design even for the large screen? This is how it looks web browser with different sizes.

image Screenshot 2023-07-04 at 12 10 22 AM Screenshot 2023-07-04 at 12 10 12 AM

@mananjadhav It should look like this, I missed a change but pushed the fix now.
image

@mananjadhav
Copy link
Collaborator

Thanks for the fix @WikusKriek. Testing again now.

@mananjadhav
Copy link
Collaborator

mananjadhav commented Jul 4, 2023

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 web-workspace-invite-avatars
web-group-avatars_U6BXLv2A.mp4
Mobile Web - Chrome Screenshot 2023-07-04 at 10 24 35 PM Screenshot 2023-07-04 at 10 19 07 PM Screenshot 2023-07-04 at 10 17 28 PM Screenshot 2023-07-04 at 10 15 59 PM Screenshot 2023-07-04 at 10 15 35 PM Screenshot 2023-07-04 at 10 20 47 PM Screenshot 2023-07-04 at 10 23 07 PM
Mobile Web - Safari

mweb-safari-workspace-invite-avatars-2
mweb-safari-workspace-invite-avatars-1

Screenshot 2023-07-04 at 10 25 38 PM Screenshot 2023-07-04 at 10 27 55 PM Screenshot 2023-07-04 at 10 29 19 PM
Desktop
desktop-multile-avatars.mov
iOS ios-multiple-avatars-3 ios-multiple-avatars-2 ios-multiple-avatars-1

image

image

Screenshot 2023-07-04 at 10 07 38 PM 1
Android android-multiple-avatars-1 android-multiple-avatars-2 android-multiple-avatars-3 android-multiple-avatars-4

image

image


@WikusKriek this tests well, just one thing is missing, can you upload screencasts for the workspace invite image?

🎀 👀 🎀 C+ Reviewed. @shawnborton @puneetlath all yours.

@WikusKriek
Copy link
Contributor Author

@mananjadhav I added screen recordings of workspace invite.

@mananjadhav
Copy link
Collaborator

Thanks @WikusKriek. @puneetlath @shawnborton if you folks can take a look.

@shawnborton
Copy link
Contributor

I think this feels good to me.

puneetlath
puneetlath previously approved these changes Jul 5, 2023
setAvatarRows([firstRow, secondRow]);
};

// useEffect hook to update avatar rows when props change
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB: I don't think this comment is necessary. The code right below it pretty clearly does exactly what this comment says.

@puneetlath
Copy link
Contributor

@WikusKriek FYI you have conflicts.

@roryabraham do you want to approve as well? You're technically the CME on the issue.

@puneetlath
Copy link
Contributor

Looks like Rory is OOO, so I'm going to go ahead and merge.

@puneetlath puneetlath merged commit 309dda3 into Expensify:main Jul 5, 2023
10 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jul 5, 2023

✋ 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
Copy link
Contributor

OSBotify commented Jul 7, 2023

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.38-7 🚀

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

>
{`+${props.icons.length - 1}`}
</Text>
<Text style={[styles.avatarInnerTextSmall, StyleUtils.getAvatarExtraFontSizeStyle(props.size)]}>{`+${avatars.length - props.maxAvatarsInRow}`}</Text>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This Text should be non-selectable and caused regression here. We updated and make this non-selectable here.

{avatars.length > props.maxAvatarsInRow && (
<Tooltip
// We only want to cap tooltips to only the first 10 users or so since some reports have hundreds of users, causing performance to degrade.
text={tooltipTexts.slice(3, 10).join(', ')}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was missed to change tooltip text while implementing this feature so it caused regression - #22951
More details:
Bug: #22951 (comment)
Root cause: #22951 (comment)

Comment on lines +101 to +106
useEffect(() => {
calculateAvatarRows();

// The only dependencies of the effect are based on props, so we can safely disable the exhaustive-deps rule
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [props.icons, props.maxAvatarsInRow, props.shouldDisplayAvatarsInRows]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greetings,

This code has introduced a regression in #24062. The useEffect is triggered after the re-rendering process, during which the app uses outdated state data along with the new prop data, leading to a crash. Rather than using useEffect in combination with State, the recommended approach involves using useMemo to recalculate the data upon prop changes. This adjustment guarantees the correct flow of data.


// Slice the icons array into two rows
const firstRow = props.icons.slice(rowSize);
const secondRow = props.icons.slice(0, rowSize);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Coming from #31151

The slice seems backward between firstRow and secondRow, so causing the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants