Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: avatar not changed in tooltip when updating avatar #20713

Merged
merged 6 commits into from
Jun 14, 2023

Conversation

s-alves10
Copy link
Contributor

@s-alves10 s-alves10 commented Jun 13, 2023

Details

Fixed Issues

$ #20672
PROPOSAL: #20672 (comment)

Tests

  1. Go to offline mode
  2. Go to Settings -> Profile and change the avatar
  3. Go to any chat and hover on email to see user details in tooltip
  4. Verify if updated avatar is displayed
  5. Go to online mode and take steps 2 - 4.
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to Settings -> Profile and change the avatar
  2. Go to any chat and hover on email to see user details in tooltip
  3. Verify if updated avatar is displayed

QA Steps

  1. Go to offline mode
  2. Go to Settings -> Profile and change the avatar
  3. Go to any chat and hover on email to see user details in tooltip
  4. Verify if updated avatar is displayed
  5. Go to online mode and take steps 2 - 4.
  • Verify that no errors appear in the JS console

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
    • 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
20672_mac_chrome.mp4
Mobile Web - Chrome
20672_android_chrome.mp4
Mobile Web - Safari
20672_ios_safari.mp4
Desktop
20672_mac_desktop.mp4
iOS
20672_ios_native.mp4
Android
20672_android_native.mp4

@s-alves10 s-alves10 marked this pull request as ready for review June 13, 2023 21:15
@s-alves10 s-alves10 requested a review from a team as a code owner June 13, 2023 21:15
@melvin-bot melvin-bot bot requested review from parasharrajat and pecanoro and removed request for a team June 13, 2023 21:15
@melvin-bot
Copy link

melvin-bot bot commented Jun 13, 2023

@pecanoro @parasharrajat One of you needs to 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]

@pecanoro pecanoro requested review from allroundexperts and removed request for parasharrajat June 14, 2023 00:36
@pecanoro
Copy link
Contributor

Reassigning since @allroundexperts can review it sooner!

@allroundexperts
Copy link
Contributor

allroundexperts commented Jun 14, 2023

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 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 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-06-14.at.6.49.47.AM.mov
Mobile Web - Chrome
Screen.Recording.2023-06-14.at.7.03.38.AM.mov
Mobile Web - Safari
Screen.Recording.2023-06-14.at.7.07.32.AM.mov
Desktop
Screen.Recording.2023-06-14.at.6.51.11.AM.mov
iOS
Screen.Recording.2023-06-14.at.7.11.54.AM.mov
Android
Screen.Recording.2023-06-14.at.7.12.37.AM.mov

@@ -416,7 +454,7 @@ function updateAvatar(file) {
*/
function deleteAvatar() {
// We want to use the old dot avatar here as this affects both platforms.
const defaultAvatar = UserUtils.getDefaultAvatarURL(currentUserEmail);
const defaultAvatar = UserUtils.getDefaultAvatarURL(currentUserEmail, true);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@s-alves10 Let's not try to change it to true. I'm sure we had it as false due to a reason.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If set to false, default user avatar URL is different than the ones that are current using. When user removes avatar, there is an inconsistency. You can easily check that.

Please let me know if you still want to change it

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see the in-consistency, but why does it happen for the avatar in the tooltip and not with avatars elsewhere?

Copy link
Contributor Author

@s-alves10 s-alves10 Jun 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other avatars get avatar URL with the below function.

App/src/libs/UserUtils.js

Lines 150 to 152 in 0a471b0

function getAvatar(avatarURL, login) {
return isDefaultAvatar(avatarURL) ? getDefaultAvatar(login) : avatarURL;
}

This function corrects this error, but it seems redundant. I think the current change doesn't affect this function

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use this function inside our tooltip like we are using elsewhere? This will prevent us from using true here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@s-alves10 Any update on above?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome. Thanks!

onyxMethod: Onyx.METHOD.MERGE,
key: ONYXKEYS.PERSONAL_DETAILS_LIST,
value: {
[personalDetails[currentUserEmail].accountID]: {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For all of these, can you please add these only if personalDetails[currentUserEmail].accountID exists?

onyxMethod: Onyx.METHOD.MERGE,
key: ONYXKEYS.PERSONAL_DETAILS_LIST,
value: {
[personalDetails[currentUserEmail].accountID]: {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

onyxMethod: Onyx.METHOD.MERGE,
key: ONYXKEYS.PERSONAL_DETAILS_LIST,
value: {
[personalDetails[currentUserEmail].accountID]: {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here as well.

onyxMethod: Onyx.METHOD.MERGE,
key: ONYXKEYS.PERSONAL_DETAILS_LIST,
value: {
[personalDetails[currentUserEmail].accountID]: {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here too.

onyxMethod: Onyx.METHOD.MERGE,
key: ONYXKEYS.PERSONAL_DETAILS_LIST,
value: {
[personalDetails[currentUserEmail].accountID]: {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And here lastly.

@allroundexperts
Copy link
Contributor

@s-alves10 PR mostly looks good. Can you please handle comments ASAP? Thanks!

@allroundexperts
Copy link
Contributor

@s-alves10 Can you also check why the uploaded image while in offline mode, does not show up in the image viewer modal?

Screen.Recording.2023-06-14.at.7.46.26.AM.mov

@allroundexperts
Copy link
Contributor

Screenshot 2023-06-14 at 7 49 36 AM

@s-alves10 Please confirm the above item as well and check it if it passes.

@@ -379,6 +379,7 @@ function updateAvatar(file) {
},
},
];

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not needed.

@s-alves10
Copy link
Contributor Author

@s-alves10 Can you also check why the uploaded image while in offline mode, does not show up in the image viewer modal?

This seems out of scope but let me check.

@allroundexperts
Copy link
Contributor

@s-alves10 Can you also check why the uploaded image while in offline mode, does not show up in the image viewer modal?

This seems out of scope but let me check.

It looked so to me as well but just wanted to confirm. If it's not related to your change, then we'll create a new ticket for this.

@s-alves10
Copy link
Contributor Author

s-alves10 commented Jun 14, 2023

@allroundexperts

When you upload an image in offline mode, avatar is stored as blob. blob url hasn't image extension in it and image check fails here

const isImage = Str.isImage(props.source);

That's why it isn't displayed as image

@s-alves10
Copy link
Contributor Author

Do you think this is a regression?

@allroundexperts
Copy link
Contributor

@s-alves10 Can you verify this as well?

Is this one I have to check?

Verify and then check.

@s-alves10
Copy link
Contributor Author

Checked.

@mountiny
Copy link
Contributor

@allroundexperts @s-alves10 can you confirm that once you go back online, the avatar will show correctly in this scenario?

@allroundexperts
Copy link
Contributor

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Tests well as well!

@mountiny
Copy link
Contributor

@pecanoro I think its good to CP this and make a follow up issue for the problem discovered by this PR. All yours 🙇

@pecanoro
Copy link
Contributor

Awesome, doing a final test run!

@pecanoro
Copy link
Contributor

The bug #1 we found with the profile image, I think it might be working on dev and some fix might have been recently merged as it works well for me. We will see after the back-end deploy anyways, otherwise, all good! Approving!

@pecanoro pecanoro merged commit f467085 into Expensify:main Jun 14, 2023
@melvin-bot
Copy link

melvin-bot bot commented Jun 14, 2023

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

@s-alves10
Copy link
Contributor Author

@pecanoro I think its good to CP this and make a follow up issue for the problem discovered by this PR. All yours 🙇

I can work on the follow up issue. Thanks

@OSBotify
Copy link
Contributor

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

@pecanoro
Copy link
Contributor

Oh shit, I forgot to add the CP label.

@github-actions
Copy link
Contributor

⚠️ ⚠️ Heads up! This pull request has the CP Staging label ⚠️ ⚠️
If you applied the CP Staging label before the PR was merged, the PR will be be immediately deployed to staging even if the open StagingDeployCash deploy checklist is locked.
However if you applied the CP Staging after the PR was merged it's possible it won't be CP'ed automatically. If you need it to be CP'ed to staging, tag a member of @Expensify/mobile-deployers to CP it manually, otherwise you can wait for it to go out with the next deploy.

OSBotify pushed a commit that referenced this pull request Jun 14, 2023
fix: avatar not changed in tooltip when updating avatar
(cherry picked from commit f467085)
OSBotify added a commit that referenced this pull request Jun 14, 2023
…ing-20713

🍒 Cherry pick PR #20713 to staging 🍒
@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.27-7 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@pecanoro
Copy link
Contributor

Tested on staging, bug was fixed!

@allroundexperts
Copy link
Contributor

Tested on staging, bug was fixed!

I can verify that this is indeed fixed.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.27-7 🚀

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

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

@s-alves10 s-alves10 deleted the fix/issue-20672 branch November 22, 2023 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants