Refactor User_UploadAvatar (front-end)

[jasperhuangg]

Details

Since we changed UserAPI::uploadAvatar to return an avatar and avatarThumbnail here, we need to change how they are accessed in NewDot once the API call returns.

This also standardizes any accessing of avatars with avatar for the high resolution image and avatarThumbnail for the low resolution image. For personal details, we use both high and low resolution images. For policies, we only use the high resolution image. For more information, see my comment here.

Finally, this also updates avatar picker on the profile page and workspace settings page to be offline first, and use the new API commands.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/214156

Tests

1. Update your .env file to use the production API by following this SO. This needs to be done since our s3 bucket uploads only work in prod.

2. Sign into any account and open your Profile Settings (click on your avatar > Profile).

3. Click on the avatar picker and upload an avatar. Verify that no loading indicator appears, and that your avatar updates immediately after you click "Save" (the "Save" button in the cropping modal). Hard refresh (<Command><Shift><R>) the page, and verify that the new avatar is persisted.
   

4. Be ready to turn off your device wifi very quickly. Repeat step 3, but IMMEDIATELY turn off your device wifi before the avatar can finish uploading. It should still show the new avatar, but it should be greyed out like so:
   

5. Turn your device wifi back on, and verify the upload completes and the avatar isn't greyed out anymore.

6. Now click on the avatar picker again and select "Remove photo". Verify that the avatar is replaced with a default avatar. Reload the page and verify that this is persisted.

7. To test the error displaying, run the following code-snippet in the JS console, and verify it displays correctly:

   Onyx.merge('personalDetails', {
       '<current user email>': {
           errorFields: {
               avatar: {
                   1: 'Your profile picture could not be uploaded. Please try again later when you are online.'
               }
           }
       }
   });
   

   

8. Now repeat steps 3-6, but with the avatar picker in the Workspace Settings page.

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 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 was added in all src/languages/* files
  • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
• 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 */
  • Any functional components have the displayName property
  • 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 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 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.
• I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

• 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 verified tests pass on all platforms & I tested again on:
  • iOS / native
  • Android / native
  • iOS / Safari
  • Android / Chrome
  • MacOS / Chrome
  • 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 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 was added in all src/languages/* files
  • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
  • Any functional components have the displayName property
  • 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 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 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.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

QA Steps

Same as the testing steps, except you can skip step 1 and 7.

• Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

[Beamanator]

Code changes look good, a few tiny comments - haven't tested yet (will test after you do & you add a few screenshots plz :D)

[jasperhuangg]

@Beamanator Will do!

I think I should be able to test this by just trying to setting avatars locally for workspaces and personal details using the main branch, and then checking out this branch and seeing if we're still able to load them and update them.

I'll open up another PR that actually updates the API connectors in App to use the new updateUserAvatar and updateWorkspaceAvatar functions from https://github.com/Expensify/Web-Expensify/pull/34346 once this is merged.

I'm currently having some issues with my VPN and ngrok which is preventing me from running the App anywhere, but I'll get on test and adding more specific instructions in the OP once I do!

This is out of date! We're going to merge the Web PR first and test with it once it's been deployed.

[Beamanator]

Sounds good man! Oof good luck with VPN and ngrok :'( I don't thinkkk you need the VPN for App dev though, do you? I don't think I've needed it, I rarely rarely turn the VPN on (since it's annoying from where I'm located)

[jasperhuangg]

@Beamanator based on my comment here let's get the Web PR deployed first, that way I'll be able to test the front-end changes with working s3 buckets.

[Beamanator]

Some more tiny comments

[jasperhuangg]

@Beamanator addressed your comments! I removed the isCloseable logic and access errors from errorFields.avatar (in lieu of your comment on the Web PR here)

[Beamanator]

When testing locally (not in prod database), I did this:

1. uploaded avatar
2. Saw PDF Box can not upload user asset[] error
3. Clicked "Save"
4. Saw this console error:

I think this has something to do with the Save button being clickable when it shouldn't be? Do you experience this?

[jasperhuangg]

When testing locally (not in prod database), I did this:

1. uploaded avatar
2. Saw PDF Box can not upload user asset[] error
3. Clicked "Save"
4. Saw this console error:

I think this has something to do with the Save button being clickable when it shouldn't be? Do you experience this?

@Beamanator hmmm I can't reproduce, the button never becomes clickable for me:
https://user-images.githubusercontent.com/31285285/187338509-f1550766-3393-4029-b713-3bca0d04d37e.mov

Here's the condition we're using to decide whether the button should be disabled. Looking around in ProfilePage.js I can't see how the button would become enabled by uploading the avatar.

const isButtonDisabled = (currentUserDetails.firstName === this.state.firstName.trim())
            && (currentUserDetails.lastName === this.state.lastName.trim())
            && (lodashGet(currentUserDetails, 'timezone.selected') === this.state.selectedTimezone)
            && (lodashGet(currentUserDetails, 'timezone.automatic') === this.state.isAutomaticTimezone)
            && (currentUserDetails.pronouns === this.state.pronouns.trim());

[Beamanator]

Hmm something that seems not ideal, let me know if you agree @jasperhuangg (maybe can be handled in future issue):

1. Upload avatar
2. Immediately disconnect from wifi, verify you see avatar is grayed out
3. Connect to wifi, see avatar uploads successfully
4. Disconnect from wifi again, avatar is grayed out again?? I don't think it should be in this situation if it uploads successfully?

[Beamanator]

Also FYI may want to update the screenshot of the error with the X? :D

[jasperhuangg]

Hmm something that seems not ideal, let me know if you agree @jasperhuangg (maybe can be handled in future issue):

1. Upload avatar
2. Immediately disconnect from wifi, verify you see avatar is grayed out
3. Connect to wifi, see avatar uploads successfully
4. Disconnect from wifi again, avatar is grayed out again?? I don't think it should be in this situation if it uploads successfully?

Hmm it appears you can skip steps 1-3 and just do step 4, the avatar just always gets greyed out when you're offline.

EDIT: steps 1-3 are necessary I just technically already performed them.

[jasperhuangg]

@Beamanator figured it out, it's because we're not clearing pendingFields in the successData, so the next time you go offline pendingField.avatar is still 'update' when it should be null.

[Beamanator]

It looks like removing the workspace avatar isn't working - when I refresh the page (hard refresh)

[jasperhuangg]

It looks like removing the workspace avatar isn't working - when I refresh the page (hard refresh)

@Beamanator
Ah my b, it's because we're clearing out avatarURL rather than avatar here. I'll open up a PR.

[Beamanator]

aaah good catch @jasperhuangg - I guess we need to get that fix CP'd before merging this right?

[jasperhuangg]

aaah good catch @jasperhuangg - I guess we need to get that fix CP'd before merging this right?

Yup! HOLDing this PR on https://github.com/Expensify/Web-Expensify/pull/34724 for now.

[Beamanator]

@jasperhuangg merged! let's get it CP'd! :D

[Beamanator]

After a few rounds of testing everything's looking great!

[OSBotify]

🚀 Deployed to staging by @Beamanator in version: 1.1.94-3 🚀

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