[TS migration] Migrate 'AvatarWithIndicator.js' component to TypeScript #30328

fabioh8010 · 2023-10-25T08:42:32Z

Details

Fixed Issues

$ #25034
PROPOSAL: N/A

Tests

Check if the avatar icon in the Sidebar is correctly rendered.
Check if it open Settings when pressed / clicked.

Offline tests

Same as above.

QA Steps

Same as above.

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

Screen.Recording.2023-10-25.at.05.25.36.mov

Android: mWeb Chrome

Screen.Recording.2023-10-25.at.05.26.40.mov

iOS: Native

Screen.Recording.2023-10-25.at.05.34.26.mov

iOS: mWeb Safari

Screen.Recording.2023-10-25.at.05.34.52.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-25.at.05.35.49.mov

Screen.Recording.2023-10-25.at.05.36.03.mov

MacOS: Desktop

Screen.Recording.2023-10-25.at.05.36.17.mov

src/components/AvatarWithIndicator.tsx

src/libs/UserUtils.ts

kubabutkiewicz

lgtm 😄

melvin-bot · 2023-10-27T12:36:08Z

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

robertKozik · 2023-11-06T17:26:53Z

Hi @fabioh8010 could you resolve conflicts?

robertKozik · 2023-11-06T17:46:03Z

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

android.native.mov

Android: mWeb Chrome

android.web.mov

iOS: Native

ios.native.mov

iOS: mWeb Safari

ios.web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

robertKozik · 2023-11-08T22:55:22Z

@fabioh8010 bump on resolve conficts

…mponent/AvatarWithIndicator

kubabutkiewicz · 2023-11-09T08:09:56Z

Hi @robertKozik Fabio is OOO, I took over and conflicts are resolved now 😄

melvin-bot · 2023-11-09T09:40:44Z

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

Beamanator

One main question about shouldRender={false}

I also have some NAB suggestions for improving comments in UserUtils - since we renamed a lot of avatarURL params to avatarSource, we maaay want to also update the docs, basically changing the wording from "given a URL" to "given an avatar source" - but if this sounds too picky for everyone we can probably leave it 😬

Beamanator · 2023-11-09T10:54:19Z

src/components/AvatarWithIndicator.tsx

-        <Tooltip text={props.tooltipText}>
+        <Tooltip
+            text={tooltipText}
+            shouldRender={false}


Why do we even wrap everything in Tooltip if we're never going to render the Tooltip, just its children? Is this actually needed? If so, I think we should explain why

Beamanator · 2023-11-09T10:55:32Z

src/libs/UserUtils.ts

            return true;
        }
    }

-    if (!avatarURL) {
+    if (!avatarSource) {
        // If null URL, we should also use a default avatar


NAB - maaaybe we can update this comment to something like:

Suggested change

// If null URL, we should also use a default avatar

// If null source, we should also use a default avatar

Beamanator · 2023-11-09T10:57:58Z

src/libs/UserUtils.ts

 * Provided a source URL, if source is a default avatar, return the associated SVG.
 * Otherwise, return the URL pointing to a user-uploaded avatar.


Just thinking - should we update these function docs since we are updating the first param to be a "source" instead of always a "URL"? For example, for this function I feel like it would be a bit clearer to say something like:

Suggested change

* Provided a source URL, if source is a default avatar, return the associated SVG.

* Otherwise, return the URL pointing to a user-uploaded avatar.

* Provided an avatar source, if source is a default avatar, return the associated SVG.

* Otherwise, return the URL or SVG pointing to the user-uploaded avatar.

Beamanator · 2023-11-29T11:53:59Z

Bump @fabioh8010 - we also have some conflicts here

…into ts/component/AvatarWithIndicator

fabioh8010 · 2023-11-29T21:34:21Z

@Beamanator sorry for the late, this one fell through the cracks! Everything updated now!

Beamanator · 2023-11-30T09:27:17Z

No problem! Thanks @fabioh8010 ! @robertKozik can you please review again on all platforms before we merge? 🙏

robertKozik · 2023-11-30T09:59:23Z

Sure! I'm on it 👀

Beamanator · 2023-11-30T10:19:08Z

Thanks! 🙌

robertKozik · 2023-11-30T20:47:12Z

@fabioh8010 @Beamanator all works well 👌🏼

Beamanator

LGTM

OSBotify · 2023-12-01T11:10:49Z

✋ 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-12-01T12:56:13Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.7-0 🚀

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

OSBotify · 2023-12-05T02:26:36Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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

fabioh8010 added 2 commits October 24, 2023 08:43

Rename AvatarWithIndicator to TSX

b389a83

Migrate AvatarWithIndicator to TS

18b8449

kubabutkiewicz reviewed Oct 25, 2023

View reviewed changes

src/components/AvatarWithIndicator.tsx Outdated Show resolved Hide resolved

pac-guerreiro reviewed Oct 25, 2023

View reviewed changes

src/libs/UserUtils.ts Outdated Show resolved Hide resolved

src/libs/UserUtils.ts Outdated Show resolved Hide resolved

src/libs/UserUtils.ts Outdated Show resolved Hide resolved

fabioh8010 added 2 commits October 25, 2023 06:23

Rename params to better name

cebcf98

Create AvatarSource type

8e34982

kubabutkiewicz approved these changes Oct 25, 2023

View reviewed changes

blazejkustra approved these changes Oct 27, 2023

View reviewed changes

fabioh8010 marked this pull request as ready for review October 27, 2023 12:36

fabioh8010 requested a review from a team as a code owner October 27, 2023 12:36

melvin-bot bot removed the request for review from a team October 27, 2023 12:36

melvin-bot bot requested a review from robertKozik October 27, 2023 12:36

Merge branch 'main' of github.com:fabioh8010/expensify-app into ts/co…

3e5419c

…mponent/AvatarWithIndicator

robertKozik approved these changes Nov 9, 2023

View reviewed changes

melvin-bot bot requested a review from Beamanator November 9, 2023 09:40

Beamanator requested changes Nov 9, 2023

View reviewed changes

shubham1206agra mentioned this pull request Nov 10, 2023

[TS Migration] Migrate 'ReportUtils.js' lib to TypeScript #29012

Merged

58 tasks

fabioh8010 added 5 commits November 29, 2023 18:20

Merge branch 'main' into ts/component/AvatarWithIndicator

57bf2be

Use AvatarSource in ReportAction

55903d6

Minor fixes in UserUtils docs

4eea09e

Merge remote-tracking branch 'fork/ts/component/AvatarWithIndicator' …

e9aa819

…into ts/component/AvatarWithIndicator

Remove .ruby-version

fef6485

Beamanator approved these changes Dec 1, 2023

View reviewed changes

Beamanator merged commit 27fd4e2 into Expensify:main Dec 1, 2023
15 checks passed

github-actions bot mentioned this pull request Dec 1, 2023

Deploy Checklist: New Expensify 2023-12-01 #32342

Closed

53 tasks

melvin-bot bot mentioned this pull request Dec 5, 2023

[HOLD for payment 2023-12-12] [TS migration] Migrate 'AvatarWithIndicator.js' component to TypeScript #25034

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'AvatarWithIndicator.js' component to TypeScript #30328

[TS migration] Migrate 'AvatarWithIndicator.js' component to TypeScript #30328

fabioh8010 commented Oct 25, 2023 •

edited by github-actions bot

Loading

kubabutkiewicz left a comment

melvin-bot bot commented Oct 27, 2023

robertKozik commented Nov 6, 2023

robertKozik commented Nov 6, 2023

robertKozik commented Nov 8, 2023

kubabutkiewicz commented Nov 9, 2023

melvin-bot bot commented Nov 9, 2023

Beamanator left a comment

Beamanator Nov 9, 2023

Beamanator Nov 9, 2023

Beamanator Nov 9, 2023

Beamanator commented Nov 29, 2023

fabioh8010 commented Nov 29, 2023

Beamanator commented Nov 30, 2023

robertKozik commented Nov 30, 2023

Beamanator commented Nov 30, 2023

robertKozik commented Nov 30, 2023

Beamanator left a comment

OSBotify commented Dec 1, 2023

OSBotify commented Dec 1, 2023

OSBotify commented Dec 5, 2023

	// If null URL, we should also use a default avatar
	// If null source, we should also use a default avatar

		* Provided a source URL, if source is a default avatar, return the associated SVG.
		* Otherwise, return the URL pointing to a user-uploaded avatar.

[TS migration] Migrate 'AvatarWithIndicator.js' component to TypeScript #30328

[TS migration] Migrate 'AvatarWithIndicator.js' component to TypeScript #30328

Conversation

fabioh8010 commented Oct 25, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kubabutkiewicz left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 27, 2023

robertKozik commented Nov 6, 2023

robertKozik commented Nov 6, 2023

Reviewer Checklist

Screenshots/Videos

robertKozik commented Nov 8, 2023

kubabutkiewicz commented Nov 9, 2023

melvin-bot bot commented Nov 9, 2023

Beamanator left a comment

Choose a reason for hiding this comment

Beamanator Nov 9, 2023

Choose a reason for hiding this comment

Beamanator Nov 9, 2023

Choose a reason for hiding this comment

Beamanator Nov 9, 2023

Choose a reason for hiding this comment

Beamanator commented Nov 29, 2023

fabioh8010 commented Nov 29, 2023

Beamanator commented Nov 30, 2023

robertKozik commented Nov 30, 2023

Beamanator commented Nov 30, 2023

robertKozik commented Nov 30, 2023

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 1, 2023

OSBotify commented Dec 1, 2023

OSBotify commented Dec 5, 2023

fabioh8010 commented Oct 25, 2023 •

edited by github-actions bot

Loading