Fix QR image show OldDot avatar for a moment after profile avatar being removed #19521

hoangzinh · 2023-05-24T11:43:14Z

Details

Fixed Issues

$ #19211
PROPOSAL: #19211 (comment)

Tests

On Web/mWeb:

Login app in 2 tabs.
From the first tab open Share QR image
From second tab, try to remove the user avatar.
Focus back to the first tab
Verify that the center QR image should show NewDot default avatar.

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

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

Screen.Recording.2023-05-24.at.21.27.17.-.web.mp4

Mobile Web - Chrome

Screen.Recording.2023-05-24.at.22.17.48.-.android.chrome.mp4

Mobile Web - Safari

Screen.Recording.2023-05-24.at.22.25.27.mp4

Desktop

Screen.Recording.2023-05-24.at.21.45.59.-.desktop.mp4

iOS

Screen.Recording.2023-05-24.at.22.29.36.-.ios.mp4

Android

Screen.Recording.2023-05-24.at.22.20.36.-.android.mp4

…ng removed

melvin-bot · 2023-05-24T15:41:17Z

@tgolen @fedirjh 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]

fedirjh · 2023-05-24T19:52:31Z

src/libs/ReportUtils.js

+function getNewDotDefaultAvatar(login = '') {
+    if (login === CONST.EMAIL.CONCIERGE) {
+        return CONST.CONCIERGE_ICON_URL;
+    }
+
+    // There are 24 possible new dot default avatars, so we choose which one this user has based
+    // on a simple hash of their login. Note that Avatar count starts at 1.
+    const loginHashBucket = hashLogin(login, CONST.DEFAULT_AVATAR_COUNT) + 1;
+
+    return `${CONST.CLOUDFRONT_URL}/images/avatars/default-avatar_${loginHashBucket}.png`;
+}


@hoangzinh This helper function looks same as getOldDotDefaultAvatar , the only diff is the url part default-. To maintain DRY code, maybe we should:

Rename getOldDotDefaultAvatar to getDefaultAvatarURL

Include new parameter , isNewDot and update code accordingly

function getDefaultAvatarURL(login = '',isNewDot=false) { if (login === CONST.EMAIL.CONCIERGE) { return CONST.CONCIERGE_ICON_URL; } // There are 8 possible old dot default avatars, so we choose which one this user has based // on a simple hash of their login. Note that Avatar count starts at 1. const loginHashBucket = hashLogin(login, CONST.OLD_DEFAULT_AVATAR_COUNT) + 1; return `${CONST.CLOUDFRONT_URL}/images/avatars/${isNewDot?'default-':''}avatar_${loginHashBucket}.png`; }

It's also diff with number of possible default avatars too. CONST.OLD_DEFAULT_AVATAR_COUNT vs CONST.DEFAULT_AVATAR_COUNT

It's reason I decided to make a new method for it. Code will be easier to read w/out branching conditions.

It's also diff with number of possible default avatars too. CONST.OLD_DEFAULT_AVATAR_COUNT vs CONST.DEFAULT_AVATAR_COUNT

hmm , it could be extracted as well to a new variable

Good idea. Let me update the PR

I have updated PR for those default avatar methods. Please you help me review it again. Thanks @fedirjh

fedirjh

Looks good, left minor improvement

fedirjh · 2023-05-24T22:57:51Z

src/libs/ReportUtils.js

+    // We choose default avatar this user has based on a simple hash of their login.
+    // Note that Avatar count starts at 1.
+    const loginHashBucket = hashLogin(login, isNewDot ? CONST.DEFAULT_AVATAR_COUNT : CONST.OLD_DEFAULT_AVATAR_COUNT) + 1;
+    const defaultAvatar = isNewDot ? `default-avatar_${loginHashBucket}` : `avatar_${loginHashBucket}`;


Suggested change

const defaultAvatar = isNewDot ? `default-avatar_${loginHashBucket}` : `avatar_${loginHashBucket}`;

const avatarPrefix = isNewDot ? `default-avatar` : `avatar`;

I updated PR according to above suggestion.

fedirjh · 2023-05-24T22:58:17Z

src/libs/ReportUtils.js


-    return `${CONST.CLOUDFRONT_URL}/images/avatars/avatar_${loginHashBucket}.png`;
+    return `${CONST.CLOUDFRONT_URL}/images/avatars/${defaultAvatar}.png`;


Suggested change

return `${CONST.CLOUDFRONT_URL}/images/avatars/${defaultAvatar}.png`;

return `${CONST.CLOUDFRONT_URL}/images/avatars/${avatarPrefix}_${loginHashBucket}.png`;

fedirjh · 2023-05-25T00:24:45Z

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

Web.mov

Mobile Web - Chrome

Chrome.mov

Mobile Web - Safari

Safari.mov

Desktop

Dektop.mov

iOS

IOS.mov

Android

Android.mov

fedirjh

LGTM and test well.

cc @tgolen

src/libs/ReportUtils.js

tgolen · 2023-05-25T07:41:08Z

src/libs/ReportUtils.js

+ *
+ * @param {String} [avatarURL] - the avatar source from user's personalDetails
+ * @param {String} [login] - the email of the user
+ * @returns {String|Function}


How does this return a function? According to JSDocs, avatarURL is a string and getDefaultAvatarURL() returns a string.

Sorry @tgolen copy/paste mistake.

src/libs/ReportUtils.js

tgolen · 2023-05-25T07:43:42Z

src/libs/ReportUtils.js

    isDefaultAvatar,
-    getOldDotDefaultAvatar,
+    getDefaultAvatarURL,


IMO these methods are in the wrong file. Can you move all of the avatar-related functions (that have nothing to do with reports) to UserUtils.js please?

Nice suggestion btw. I will update it in next commit

Co-authored-by: Tim Golen <[email protected]>

hoangzinh · 2023-05-25T10:46:31Z

@fedirjh @tgolen

IMO these methods are in the wrong file. Can you move all of the avatar-related functions (that have nothing to do with reports) to UserUtils.js please?

Given the fact that, it will require a bit of effort & touching to multiple files. To avoid it will be getting conflict with other PR touching same LOC, please help me review this PR ASAP. Thanks

tgolen

Oh wow, I didn't realize there we so many. Thanks for moving those 🎉

fedirjh · 2023-05-25T15:34:44Z

src/libs/ReportUtils.js

@@ -8,7 +8,7 @@ import ONYXKEYS from '../ONYXKEYS';
 import CONST from '../CONST';
 import * as Localize from './Localize';
 import * as Expensicons from '../components/Icon/Expensicons';
-import hashCode from './hashCode';
+import hashLogin from './hashLogin';


I wonder why this was import and exported ? maybe we can remove it and update it's usage here , it's only used once in StyleUtils

App/src/styles/StyleUtils.js

Line 165 in 0f33e2c

const colorHash = ReportUtils.hashLogin(workspaceName.trim(), workspaceColorOptions.length);

Or it can be moved to userUtils as well and exported from there. What do you think @tgolen ?

UserUtils makes sense to me 👍

Nice catch @fedirjh I think we can put this method in UserUtils. I updated PR for this suggestion

fedirjh

LGTM and tests well

tgolen

Sorry, one last thing... I wonder if you agree.

tgolen · 2023-05-25T16:22:22Z

src/styles/StyleUtils.js

@@ -162,7 +162,7 @@ function getAvatarBorderStyle(size, type) {
 * @returns {Object}
 */
 function getDefaultWorkspaceAvatarColor(workspaceName) {
-    const colorHash = ReportUtils.hashLogin(workspaceName.trim(), workspaceColorOptions.length);
+    const colorHash = UserUtils.hashLogin(workspaceName.trim(), workspaceColorOptions.length);


This really begs the question if we need this to be in a lib at all. It's one line of code that is only used in one spot. Let's just define it here and keep it out of the utils entirely. This is a good reminder of over-engineering things :D (not you, I'm not sure who originally wrote this).

Hmm it's used in UserUtils as well

getDefaultAvatarURL

getDefaultAvatar

@tgolen bump for comment above ^

Ah, OK. I missed that, thanks.

hoangzinh · 2023-05-26T13:47:38Z

@fedirjh @tgolen hopefully we can merge this PR today 🥺 . I have fix merge conflict several times so I'm worry that It might have resolve conflict mistakes.
Basically for not really big concerns, I can create another following PR to address it.

hoangzinh · 2023-05-26T22:15:51Z

Quick bump on it ^

fedirjh · 2023-05-26T22:23:02Z

@hoangzinh you have a lint error

hoangzinh · 2023-05-26T22:39:57Z

@fedirjh all checks is green now.

OSBotify · 2023-05-29T05:38:58Z

✋ 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-05-30T00:27:56Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.20-0 🚀

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

OSBotify · 2023-05-31T16:35:09Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.20-5 🚀

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

Fix QR image show OldDot avatar for a moment after profile avatar bei…

c349a4b

…ng removed

hoangzinh marked this pull request as ready for review May 24, 2023 15:41

hoangzinh requested a review from a team as a code owner May 24, 2023 15:41

melvin-bot bot requested review from fedirjh and tgolen and removed request for a team May 24, 2023 15:41

Update comment

6efd89b

hoangzinh mentioned this pull request May 24, 2023

[HOLD for payment 2023-06-07] [$1000] Center QR image turns into difference avatar for a moment after being removed. #19211

Closed

6 tasks

fedirjh reviewed May 24, 2023

View reviewed changes

Dry code get default avatar url methods for OldDot and NewDot

1b7aee9

fedirjh reviewed May 24, 2023

View reviewed changes

Code refactor

8b5db9c

fedirjh previously approved these changes May 25, 2023

View reviewed changes

tgolen requested changes May 25, 2023

View reviewed changes

Update comment text

a363394

Co-authored-by: Tim Golen <[email protected]>

hoangzinh dismissed fedirjh’s stale review via a363394 May 25, 2023 08:53

hoangzinh and others added 6 commits May 25, 2023 15:54

Code refactor

4b9cabd

Co-authored-by: Tim Golen <[email protected]>

Update method JSDoc

20a9bfd

Co-authored-by: Tim Golen <[email protected]>

Update JSDocs

56cacd7

Move all of the avatar-related functions to UserUtils

e1b9251

Merge branch 'main' into df/19211

5390a71

Fix 'UserUtils' is not defined

7dda968

tgolen previously approved these changes May 25, 2023

View reviewed changes

fedirjh reviewed May 25, 2023

View reviewed changes

Move hashLogin into UserUtils

41a3193

hoangzinh dismissed tgolen’s stale review via 41a3193 May 25, 2023 15:56

fedirjh previously approved these changes May 25, 2023

View reviewed changes

tgolen requested changes May 25, 2023

View reviewed changes

Merge branch 'main' into df/19211

9fce055

hoangzinh dismissed fedirjh’s stale review via 9fce055 May 25, 2023 23:28

hoangzinh added 2 commits May 26, 2023 20:41

Merge branch 'main' into df/19211

ba9a41c

Fix resolve conflict mistake

6a826ef

Merge branch 'main' into df/19211

b8b27d5

Fix linter due to merge main branch

0d94dcd

tgolen approved these changes May 29, 2023

View reviewed changes

tgolen merged commit 06192ac into Expensify:main May 29, 2023

OSBotify mentioned this pull request May 29, 2023

Deploy Checklist: New Expensify 2023-05-29 #19785

Closed

44 tasks

jjcoffee mentioned this pull request Oct 24, 2023

[HOLD for payment 2023-12-28] [$500] Chat - Avatar of a new user changes when switching from offline to online #28518

Closed

6 tasks

jjcoffee mentioned this pull request Nov 30, 2023

fix: Avatar changes when from offline to online #32090

Merged

47 tasks

	const defaultAvatar = isNewDot ? `default-avatar_${loginHashBucket}` : `avatar_${loginHashBucket}`;
	const avatarPrefix = isNewDot ? `default-avatar` : `avatar`;


		return `${CONST.CLOUDFRONT_URL}/images/avatars/avatar_${loginHashBucket}.png`;
		return `${CONST.CLOUDFRONT_URL}/images/avatars/${defaultAvatar}.png`;

Fix QR image show OldDot avatar for a moment after profile avatar being removed #19521

Fix QR image show OldDot avatar for a moment after profile avatar being removed #19521

Conversation

hoangzinh commented May 24, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedirjh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedirjh commented May 25, 2023

Reviewer Checklist

Screenshots/Videos

fedirjh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoangzinh commented May 25, 2023

tgolen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedirjh left a comment

Choose a reason for hiding this comment

tgolen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedirjh May 25, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoangzinh commented May 26, 2023 • edited Loading

hoangzinh commented May 26, 2023

fedirjh commented May 26, 2023

hoangzinh commented May 26, 2023

OSBotify commented May 29, 2023

OSBotify commented May 30, 2023

OSBotify commented May 31, 2023

hoangzinh commented May 24, 2023 •

edited

Loading

fedirjh May 25, 2023 •

edited

Loading

hoangzinh commented May 26, 2023 •

edited

Loading