Display skeleton avtar while loading #30625

dukenv0307 · 2023-10-31T08:25:23Z

Details

Display skeleton avtar while loading

Fixed Issues

$ #28638
PROPOSAL: #28638 (comment)

Tests

Log out the account
Enter any account to login
Verify that the current avatar display as skeleton style while loading

Verify that no errors appear in the JS console

Offline tests

QA Steps

Log out the account
Enter any account to login
Verify that the current avatar display as skeleton style while loading

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-10-31.at.15.18.15.mov

Android: mWeb Chrome

Screen.Recording.2023-10-31.at.15.10.23.mov

iOS: Native

Screen.Recording.2023-10-31.at.15.15.19.mov

iOS: mWeb Safari

Screen.Recording.2023-10-31.at.15.12.05.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-31.at.15.03.08.mov

MacOS: Desktop

Screen.Recording.2023-10-31.at.15.21.07.mov

melvin-bot · 2023-10-31T08:25:38Z

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

ArekChr · 2023-10-31T11:55:02Z

@dukenv0307 I've noticed that unlike other loaders, this skeleton doesn't have a shine effect. Could you please add that to ensure consistency?

ArekChr · 2023-10-31T11:55:56Z

Regarding the review, I will be out of the office starting tomorrow and throughout this week, returning on Monday.

dukenv0307 · 2023-11-02T03:50:52Z

@ArekChr Updated to skeleton avatar.

ArekChr · 2023-11-06T11:33:11Z

I was OOO, reviewing

ArekChr · 2023-11-06T11:34:06Z

@dukenv0307 could you update the branch with the latest main? Thanks!

ArekChr · 2023-11-06T11:50:34Z

@shawnborton The issue doesn't seem to happen on the main branch anymore. It looks like it's been sorted out.
But now we've got a different design, a skeleton loader added to the user avatar.
On staging, there's a user icon instead.

Should we proceed with this pull request, or is it okay as it is now on staging?

Here is how it is currently on the staging:

main.mov

Here's what the PR changes look like:

pr.mov

dukenv0307 · 2023-11-06T12:22:47Z

Updated to the latest main.

dukenv0307 · 2023-11-10T04:45:50Z

@shawnborton Any thought on the comment above?

shawnborton · 2023-11-10T11:55:47Z

I like the PR changes you have proposed here with the skeleton loader on the avatar. cc @Expensify/design for visibility.

ArekChr · 2023-11-13T07:31:34Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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

Android: Native

android.mov

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ArekChr · 2023-11-13T10:33:07Z

src/components/AvatarSkeleton.js

+import SkeletonViewContentLoader from './SkeletonViewContentLoader';
+
+const propTypes = {
+    /**  */


Missing comment here

ArekChr · 2023-11-13T10:33:34Z

src/components/AvatarSkeleton.js

+};
+
+const defaultTypes = {
+    shouldAnimate: true,


Is this prop needed at all?

We can add this to re-use without animation in the feature.

Let's remove it for now. If it's needed in the future, we can implement it then.

ArekChr · 2023-11-13T10:44:30Z

src/components/AvatarSkeleton.js

+import SkeletonViewContentLoader from './SkeletonViewContentLoader';
+
+const propTypes = {
+    /** Whether enable animtaion */


Suggested change

/** Whether enable animtaion */

/** Indicates if the animation should be enabled. */

dukenv0307 · 2023-11-13T10:47:16Z

@ArekChr Updated to remove the prop.

src/components/AvatarSkeleton.js

OSBotify · 2023-11-14T22:08:31Z

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T20:51:46Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T21:07:09Z

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.4.0-0 🚀

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

display skeleton avtar while loading

11f90d3

dukenv0307 marked this pull request as ready for review October 31, 2023 08:25

dukenv0307 requested a review from a team as a code owner October 31, 2023 08:25

melvin-bot bot requested review from ArekChr and removed request for a team October 31, 2023 08:25

create skeleton avtar component

934b666

Merge branch 'main' into fix/28638

9648ed3

ArekChr reviewed Nov 13, 2023

View reviewed changes

dukenv0307 added 2 commits November 13, 2023 17:40

Merge branch 'main' into fix/28638

9be6cb3

add comment

38aa4fe

ArekChr reviewed Nov 13, 2023

View reviewed changes

remove prop

6c7368e

ArekChr approved these changes Nov 13, 2023

View reviewed changes

melvin-bot bot requested a review from youssef-lr November 13, 2023 10:50

youssef-lr reviewed Nov 13, 2023

View reviewed changes

src/components/AvatarSkeleton.js Show resolved Hide resolved

youssef-lr approved these changes Nov 14, 2023

View reviewed changes

youssef-lr merged commit 5f5fe0d into Expensify:main Nov 14, 2023

OSBotify mentioned this pull request Nov 14, 2023

Deploy Checklist: New Expensify 2023-11-14 #31324

Closed

OSBotify mentioned this pull request Nov 15, 2023

Deploy Checklist: New Expensify 2023-11-15 #31404

Closed

37 tasks

melvin-bot bot mentioned this pull request Nov 15, 2023

[PAID] [$500] LHN - Incorrect backup avatar while waiting for avatar to load #28638

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display skeleton avtar while loading #30625

Display skeleton avtar while loading #30625

dukenv0307 commented Oct 31, 2023 •

edited

Loading

melvin-bot bot commented Oct 31, 2023

ArekChr commented Oct 31, 2023

ArekChr commented Oct 31, 2023

dukenv0307 commented Nov 2, 2023

ArekChr commented Nov 6, 2023

ArekChr commented Nov 6, 2023

ArekChr commented Nov 6, 2023

dukenv0307 commented Nov 6, 2023

dukenv0307 commented Nov 10, 2023 •

edited

Loading

shawnborton commented Nov 10, 2023

ArekChr commented Nov 13, 2023 •

edited

Loading

ArekChr Nov 13, 2023

ArekChr Nov 13, 2023

dukenv0307 Nov 13, 2023

ArekChr Nov 13, 2023

ArekChr Nov 13, 2023

dukenv0307 commented Nov 13, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

OSBotify commented Nov 15, 2023

	/** Whether enable animtaion */
	/** Indicates if the animation should be enabled. */

Display skeleton avtar while loading #30625

Display skeleton avtar while loading #30625

Conversation

dukenv0307 commented Oct 31, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 31, 2023

ArekChr commented Oct 31, 2023

ArekChr commented Oct 31, 2023

dukenv0307 commented Nov 2, 2023

ArekChr commented Nov 6, 2023

ArekChr commented Nov 6, 2023

ArekChr commented Nov 6, 2023

dukenv0307 commented Nov 6, 2023

dukenv0307 commented Nov 10, 2023 • edited Loading

shawnborton commented Nov 10, 2023

ArekChr commented Nov 13, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

ArekChr Nov 13, 2023

Choose a reason for hiding this comment

ArekChr Nov 13, 2023

Choose a reason for hiding this comment

dukenv0307 Nov 13, 2023

Choose a reason for hiding this comment

ArekChr Nov 13, 2023

Choose a reason for hiding this comment

ArekChr Nov 13, 2023

Choose a reason for hiding this comment

dukenv0307 commented Nov 13, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

OSBotify commented Nov 15, 2023

dukenv0307 commented Oct 31, 2023 •

edited

Loading

dukenv0307 commented Nov 10, 2023 •

edited

Loading

ArekChr commented Nov 13, 2023 •

edited

Loading