Migrate `Avatar.js` to use functional component #17217

techievivek · 2023-04-10T08:48:41Z

Details

Migrated the Avatar component from class based to function based.

Fixed Issues

$ GH_LINK
PROPOSAL: N/A

Tests

Login with a new account(or an existing one) on newDot and update the default profile pic.
Login with an existing account and disconnect the Internet.
Start a new chat with the first account for which you updated the profile pic.
Connect back to the internet and ensure the user's profile pic get updated from the default avatar to original one.

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as tests step.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-04-11.at.7.13.14.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-04-11.at.6.52.29.PM.mov

Mobile Web - Safari

Screen.Recording.2023-04-11.at.7.04.28.PM.mov

Desktop

Screen.Recording.2023-04-11.at.6.48.17.PM.mov

iOS

Screen.Recording.2023-04-11.at.7.01.35.PM.mov

Android

Screen.Recording.2023-04-11.at.6.50.30.PM.mov

techievivek · 2023-04-10T09:05:02Z

src/components/Avatar.js

-        this.setState({imageError: false});
-    }
+        setImageError(false);
+    }, [props.network.isOffline]);


Started a conversation around whether or not imageError should be included in the dep array in the open-source channel here: https://expensify.slack.com/archives/C01GTK53T8Q/p1681117333835879

Added a comment to explain why imageError shouldn't be a dependency in running side effects.

MelvinBot · 2023-04-11T13:50:57Z

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

marcaaron

LGTM!

MariaHCD · 2023-04-12T11:17:28Z

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 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 correct English and 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

Screen.Recording.2023-04-12.at.4.08.04.PM.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

MariaHCD · 2023-04-12T14:49:14Z

My android emulator doesn't want to work anymore 😭 @marcaaron Could you test on Android? I've tested all other platforms.

marcaaron · 2023-04-12T17:59:25Z

Taking a look now! I am having some Android issues too today so we'll see how it goes 🙃 😫

marcaaron · 2023-04-12T19:05:44Z

Ok avatars are looking good to me on Android.

OSBotify · 2023-04-12T19:12:27Z

✋ 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-04-13T03:43:36Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.0-0 🚀

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

OSBotify · 2023-04-17T22:58:02Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.0-2 🚀

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

techievivek added 2 commits April 10, 2023 12:11

used useEffect

406b865

fixed a typo and migrated rest of the code

c6af927

techievivek self-assigned this Apr 10, 2023

techievivek commented Apr 10, 2023

View reviewed changes

techievivek requested a review from marcaaron April 11, 2023 13:49

techievivek marked this pull request as ready for review April 11, 2023 13:50

techievivek requested a review from a team as a code owner April 11, 2023 13:50

melvin-bot bot requested review from MariaHCD and removed request for a team April 11, 2023 13:50

added a comment

420c6c2

techievivek force-pushed the techievivek_migrate_Avatar_to_use_functonal_component branch from 81db650 to 420c6c2 Compare April 11, 2023 14:12

marcaaron approved these changes Apr 11, 2023

View reviewed changes

MariaHCD approved these changes Apr 12, 2023

View reviewed changes

marcaaron merged commit ea06eeb into main Apr 12, 2023

marcaaron deleted the techievivek_migrate_Avatar_to_use_functonal_component branch April 12, 2023 19:05

OSBotify mentioned this pull request Apr 13, 2023

Deploy Checklist: New Expensify 2023-04-13 #17379

Closed

26 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate `Avatar.js` to use functional component #17217

Migrate `Avatar.js` to use functional component #17217

techievivek commented Apr 10, 2023 •

edited

Loading

techievivek Apr 10, 2023 •

edited

Loading

techievivek Apr 11, 2023

MelvinBot commented Apr 11, 2023

marcaaron left a comment

MariaHCD commented Apr 12, 2023 •

edited

Loading

MariaHCD commented Apr 12, 2023

marcaaron commented Apr 12, 2023

marcaaron commented Apr 12, 2023

OSBotify commented Apr 12, 2023

OSBotify commented Apr 13, 2023

OSBotify commented Apr 17, 2023

Migrate Avatar.js to use functional component #17217

Migrate Avatar.js to use functional component #17217

Conversation

techievivek commented Apr 10, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

techievivek Apr 10, 2023 • edited Loading

Choose a reason for hiding this comment

techievivek Apr 11, 2023

Choose a reason for hiding this comment

MelvinBot commented Apr 11, 2023

marcaaron left a comment

Choose a reason for hiding this comment

MariaHCD commented Apr 12, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

MariaHCD commented Apr 12, 2023

marcaaron commented Apr 12, 2023

marcaaron commented Apr 12, 2023

OSBotify commented Apr 12, 2023

OSBotify commented Apr 13, 2023

OSBotify commented Apr 17, 2023

Migrate `Avatar.js` to use functional component #17217

Migrate `Avatar.js` to use functional component #17217

techievivek commented Apr 10, 2023 •

edited

Loading

techievivek Apr 10, 2023 •

edited

Loading

MariaHCD commented Apr 12, 2023 •

edited

Loading