Migrate AvatarWithImagePicker.js to function component

[jczekalski]

Details

• Rewrote the component from class to functional syntax
• ⚠️ I noticed that although the spinning indicator animation is triggered via lifecycle methods (this.animation.start()), this.animation.getSyncingStyles() is not actually used anywhere and the styles are not passed to Animated.View. It looks like they should be passed to some sort of spinning loader component and were in the past, but the component was removed at some point. I removed the animation-related code, but I'm not sure if the fact that this animated loader is missing is a bug or a feature.

Fixed Issues

$ #16119

Tests

• Verify that no errors appear in the JS console

1. Tap on the avatar in Profile or Workspaces
2. Upload a new avatar, check if resizing works
3. Remove avatar.

Offline tests

Upload a photo offline, then go online. Check if the photo updated.

QA Steps

• Verify that no errors appear in the JS console

1. Tap on the avatar in Profile or Workspaces
2. Upload a new avatar, check if resizing works
3. Remove avatar.

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
  • 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
  • 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.mov

Mobile Web - Chrome

chrome.mov

Mobile Web - Safari

safari.mov

Desktop

electron.mov

iOS

ios.mov

Android

android.mov

[melvin-bot]

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

[staszekscp]

Hey @mollfpr! Could you have a look at this PR, because it's been a while, since it has been created 😄

[mollfpr]

@staszekscp Sorry, I thought we were waiting for the issue off hold 😅

I'll do the review in the morning, thank you!

[mollfpr]

Sorry for the delay; the code looks good. Just need to resolve the conflicts, and I'll do the final test. Thanks!

[blazejkustra]

@mollfpr I took over this PR, resolved the conflicts and made one small improvement as I saw some errors in the console. Please have a look now 😄

[mollfpr]

Thanks @blazejkustra for the update 👍

I'll finish the test in the morning.

[mollfpr]

NAB: no default props.

[blazejkustra]

Adjusted 👍 Thanks for quick response!

[blazejkustra]

Oh sorry, I misunderstood your comment. Adjusted it one more time.

[mollfpr]

@blazejkustra The app crashes on clicking the workspace avatar. Might it be related to useLocalize?

Screen.Recording.2023-08-09.at.20.52.32.mov

[mollfpr]

We must add the displayName property for the function component.

[blazejkustra]

@blazejkustra The app crashes on clicking the workspace avatar. Might it be related to useLocalize?

I investigated it deeply, even reduced AvatarWithImagePicker.js to this:

import React, {useState} from 'react';

function AvatarWithImagePicker() {
    const [validationError, setValidationError] = useState(null);
    return null;
}

AvatarWithImagePicker.displayName = 'AvatarWithImagePicker';

export default AvatarWithImagePicker;

But the hook error was still appearing in the console. Which is very weird as there is nothing wrong with hooks in the snippet above.

So I dig deeper, only once I removed Form component from WorkspaceSettingsPage where AvatarWithImagePicker is used it started to work again. As for now, I have no clue why it is happening. Will continue investigating tomorrow @mollfpr

[blazejkustra]

Found the real cause and reported it on #expensify-bugs channel here. I reckon that the progress on this PR is on hold until the underlying issue is resolved.

[blazejkustra]

This PR is now on HOLD until #25397 is fixed.