[TS migration] Migrate 'MultipleAvatars.js' component to TypeScript by VickyStash · Pull Request #31056 · Expensify/App

VickyStash · 2023-11-08T10:52:04Z

Details

[TS migration] Migrate 'MultipleAvatars.js' component to TypeScript

Fixed Issues

$ #25077
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

In the chats list, find a chat with another user and make sure the avatars look okay.
Create a new group chat, and make sure the avatars look okay inside the chat and its header. Also, make sure the group chat avatars look as expected in the chat list as well.

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

In the chats list, find a chat with another user and make sure the avatars look okay.
Create a new group chat, and make sure the avatars look okay inside the chat and its header. Also, make sure the group chat avatars look as expected in the chat list as well.

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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
  - 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

BartoszGrajdek · 2023-11-08T13:15:19Z

-                    displayName: props.icons[0].name,
-                    avatar: props.icons[0].avatar,
+                    displayName: icons[0].name,
+                    avatar: icons[0].source,


Can you explain to me why has this changed across the files? I don't understand why it was icon.avatar before and now it's icon.source, maybe I'm missing something 😄

@BartoszGrajdek I haven't found any place where icons have an avatar field, so it looked wrong, that's why I replaced it with source which makes more sense

Wow, this is really weird, I do not know how it's been working before then... Have you heard anything about it @blazejkustra?

Nooo, that has to be a mistake. It worked as we have fallback icons and probably nobody noticed 😄

@blazejkustra Maybe it makes sense to remove it then?

Why would you remove it? 🤔

@blazejkustra Because the tooltip anyway use the icon from props first and only then try to get user avatar. Since we pass the same icon as a prop, it doesn't make a difference if we pass it to the fallback details. Plus, it looks like before, undefined was always put as an avatar, so we shouldn't break anything.

Thank you for explanation, I'm fine with removing!

melvin-bot · 2023-11-09T08:57:06Z

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

# Conflicts: # src/types/onyx/OnyxCommon.ts

VickyStash · 2023-11-15T10:35:33Z

@thesahindia kind bump 😄

thesahindia · 2023-11-15T15:30:31Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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

Android: Native

Screen.Recording.2023-11-15.at.8.42.26.PM.mov

Android: mWeb Chrome

Screen.Recording.2023-11-15.at.8.41.53.PM.mov

iOS: Native

Screen.Recording.2023-11-15.at.8.57.51.PM.mov

iOS: mWeb Safari

Screen.Recording.2023-11-15.at.8.44.48.PM.mov

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-11-15T15:30:59Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25077 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

OSBotify · 2023-11-15T16:21:42Z

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

MonilBhavsar · 2023-11-17T12:40:12Z

+                        {[...avatars].splice(0, maxAvatarsInRow).map((icon, index) => (
                            <UserDetailsTooltip
-                                key={`stackedAvatars-${index}`}
+                                key={`stackedAvatars-${icon.id}`}


icon.id was undefined for Workspaces and hence created warnings. It was fixed here #31484

situchan · 2023-11-17T12:40:46Z

+                        {[...avatars].splice(0, maxAvatarsInRow).map((icon, index) => (
                            <UserDetailsTooltip
-                                key={`stackedAvatars-${index}`}
+                                key={`stackedAvatars-${icon.id}`}


There was small regression on this line. Workspace avatars don't have id so console error happened on Settings > Workspaces list page
Fixed in #31484

OSBotify · 2023-11-20T13:40:58Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.0-3 🚀

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

[TS migration] Migrate 'MultipleAvatars.js' component

280909e

kubabutkiewicz reviewed Nov 8, 2023

View reviewed changes

Comment thread src/components/MultipleAvatars.tsx Outdated

Update OnyxCommon Icon type

ab92c85

kubabutkiewicz approved these changes Nov 8, 2023

View reviewed changes

barttom reviewed Nov 8, 2023

View reviewed changes

Comment thread src/components/MultipleAvatars.tsx Outdated

Comment thread src/components/MultipleAvatars.tsx Outdated

Add useMemo for tooltipTexts

cf6410f

BartoszGrajdek reviewed Nov 8, 2023

View reviewed changes

blazejkustra suggested changes Nov 8, 2023

View reviewed changes

Comment thread src/components/MultipleAvatars.tsx Outdated

Comment thread src/components/MultipleAvatars.tsx Outdated

VickyStash added 2 commits November 8, 2023 18:06

Make size and secondAvatarStyle to be optional

bc3181a

Remove unused avatar props

22f237f

blazejkustra approved these changes Nov 9, 2023

View reviewed changes

VickyStash marked this pull request as ready for review November 9, 2023 08:57

VickyStash requested a review from a team as a code owner November 9, 2023 08:57

melvin-bot Bot removed the request for review from a team November 9, 2023 08:57

melvin-bot Bot requested a review from thesahindia November 9, 2023 08:57

VickyStash added 2 commits November 15, 2023 11:16

Merge branch 'main' into ts-migration/multipleAvatars-component

87f5a3e

# Conflicts: # src/types/onyx/OnyxCommon.ts

Update icon type

60f26d3

thesahindia approved these changes Nov 15, 2023

View reviewed changes

melvin-bot Bot requested a review from amyevans November 15, 2023 15:31

amyevans approved these changes Nov 15, 2023

View reviewed changes

amyevans merged commit a9743a2 into Expensify:main Nov 15, 2023

OSBotify mentioned this pull request Nov 16, 2023

Deploy Checklist: New Expensify 2023-11-15 #31404

Closed

37 tasks

MonilBhavsar reviewed Nov 17, 2023

View reviewed changes

situchan reviewed Nov 17, 2023

View reviewed changes

melvin-bot Bot mentioned this pull request Nov 20, 2023

[HOLD for payment 2023-11-27] [TS migration] Migrate 'MultipleAvatars.js' component to TypeScript #25077

Closed

Uh oh!

Conversation

VickyStash commented Nov 8, 2023 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

melvin-bot Bot commented Nov 9, 2023

Uh oh!

VickyStash commented Nov 15, 2023

Uh oh!

thesahindia commented Nov 15, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Nov 15, 2023

Uh oh!

OSBotify commented Nov 15, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 20, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

VickyStash commented Nov 8, 2023 •

edited by github-actions Bot

Loading