Grab the users custom avatar or default avatar to display properly

[bondydaa]

Details

I believe this came from #20276 because it was using getDefaultAvatar which will only ever grab the default avatar for a user and never one they might have uploaded. I believe this new method will first grab a custom one if present then default to the default avatar if it needs to but honestly I'm really confused by UserUtils.getAvatar since you have to pass it the url you think you want 🤷

Fixed Issues

$ #20683

Tests

• Verify that no errors appear in the JS console

1. Ensure you have a custom avatar uploaded for your user
2. open up a chat with another user
3. click on the chat name to show the member list (or navigate it however you choose)
4. Hover over the avatar which should show a tooltip of the avatar again (?)
5. hover over the user's name/login which should show a tooltip of the avatar.
6. Ensure the avatar is the same in both those tooltips

Offline tests

1. Ensure you have a custom avatar uploaded for your user
2. open up a chat with another user
3. click on the chat name to show the member list (or navigate it however you choose)
4. Hover over the avatar which should show a tooltip of the avatar again (?)
5. hover over the user's name/login which should show a tooltip of the avatar.
6. Ensure the avatar is the same in both those tooltips

QA Steps

• Verify that no errors appear in the JS console

1. Ensure you have a custom avatar uploaded for your user
2. open up a chat with another user
3. click on the chat name to show the member list (or navigate it however you choose)
4. Hover over the avatar which should show a tooltip of the avatar again (?)
5. hover over the user's name/login which should show a tooltip of the avatar.
6. Ensure the avatar is the same in both those tooltips

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

Mobile Web - Safari

Desktop

iOS

Android

[melvin-bot]

@Santhosh-Sellavel @hayata-suenaga 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]

[fedirjh]

Suggested change

	const avatar = UserUtils.getAvatar(personalDetails.avatar, participant.login);
	const {avatar} = getPersonalDetailsForLogin(participant.login);

@bondydaa I think we can simply get avatar from getPersonalDetailsForLogin

[Santhosh-Sellavel]

@fedirjh Please have a look again getPersonalDetailsForLogin doesn't always have an avatar, so it seems fine to me!

[fedirjh]

@Santhosh-Sellavel It either return allPersonalDetails[login] which have avatar , or it construct a default object.

[Santhosh-Sellavel]

allPersonalDetails[login] might not have an avatar if not set

[fedirjh]

If avatar is not set it will fallback to default avatar. API always return avatar with personalDetails

[Santhosh-Sellavel]

Okay then!

[Santhosh-Sellavel]

Is this a regression PR?

[fedirjh]

Is this a regression PR?

Yes

[fedirjh]

@bondydaa I have a second thought about the root cause. Actually, the UserDetailsTooltip relies on the accountID to retrieve the user details within the component itself, as seen here.

App/src/components/UserDetailsTooltip/index.js

Line 14 in 0a471b0

const userDetails = lodashGet(props.personalDetailsList, props.accountID, props.fallbackUserDetails);

I believe the root cause is that we are not passing the accountID. As a result, the UserDetailsTooltip will fallback to the fallbackUserDetails, which holds the default avatar. I have further debugged this and I believe the changes should be made here. We should return the accountID as well.

App/src/pages/ReportParticipantsPage.js

Line 79 in 0a471b0

participantsList: [{login, displayName: userPersonalDetail.displayName}],

[mountiny]

@fedirjh Can you test your proposed solution if it works well?

[fedirjh]

Can you test your proposed solution if it works well?

@mountiny Tested and works as expected.

tooltip.mov

[bondydaa]

So then is this because we're halfway between transitioning the PERSONAL_DETAILS and PERSONAL_DETAILS_LIST onyx keys?

which was identified here #20672 and solved with #20713?

[fedirjh]

So then is this because we're halfway between transitioning the PERSONAL_DETAILS and PERSONAL_DETAILS_LIST onyx keys?

@bondydaa Yes that’s correct. Also It looks like the solution I provided was already implemented within this PR

[mountiny]

@bondydaa ok so should we just live with this problem for a bit and let it be handled in here https://github.com/Expensify/App/pull/20473/files#diff-cfc1b0041979edd1cf120bf6f6b714a0c81f0562ee1aafbda836ce61aae559d5? we plan to merge that today

[fedirjh]

@mountiny FYI #20473 will also fix this issue #20672

[bondydaa]

okay closing this then.