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

feat: Added Skeleton UI to chats #8042

Merged
merged 59 commits into from
Jul 29, 2022
Merged

Conversation

mananjadhav
Copy link
Collaborator

@mananjadhav mananjadhav commented Mar 8, 2022

Details

  • Adds a background screen with shimmer animation, when the chat is loading
  • It also adds an additional dependency react-content-loader for SVG based animation on components.

Fixed Issues

$ #7081

Tests

  • Tested the ghost screen on all platforms

  • Checked for responsive nature, ie, it should cover the full screen

  • Verified that it shows up only on the first load of the chat data

  • Verified that the expected order is maintained

  • Shouldn't show the screen if the report data already exists

  • Tested animation on switching between the chats

  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (PR Author) Checklist

  • I verified the PR has a small number of commits behind main
  • 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 clearly indicated the environment tests should be run in (Staging vs Production)
  • I wrote testing steps that cover success & fail scenarios (if applicable)
  • I included screenshots or videos for tests on all platforms
  • I ran the tests & verify they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • MacOS / Desktop
  • I verified there are no console errors related to changes in this PR
  • I followed proper code patterns (see Reviewing the code)
    • I added comments when the code was not self explanatory
    • I put all copy / text shown in the product in all src/languages/* files (if applicable)
    • I followed proper naming convention for platform-specific files (if applicable)
    • I followed style guidelines (in Styling.md) for all style edits I made
    • I followed the JSDocs style guidelines (in STYLE.md)
  • 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 corroborated the UI performance was not affected (the performance is the same than main branch)
  • If I created a new component I verified that a similar component doesn't exist in the codebase

PR Reviewer Checklist

  • I verified the PR has a small number of commits behind main
  • 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 testing environment is mentioned in the test steps
  • I verified testing steps cover success & fail scenarios (if applicable)
  • 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 related to changes in this PR
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified comments were added when the code was not self explanatory
    • I verified any copy / text shown in the product was added in all src/languages/* files (if applicable)
    • I verified proper naming convention for platform-specific files was followed (if applicable)
    • I verified style guidelines were followed
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components are not impacted by changes in this PR (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 the UI performance was not affected (the performance is the same than main branch)
  • If a new component is created I verified that a similar component doesn't exist in the codebase

QA Steps

For all the platforms

  1. Ensure you're in the logged out state
  2. Login to the app
  3. Visit any chat with the first load
  4. By default, it should load the skeleton UI until the data is fetched from the API
  5. It should render the chats after the data is fetched with the Fade In Animation
  6. Keep switching between the chats to see the skeletal UI for any remote chat
  7. The Skeletal UI repeat pattern should be as [HOLD for payment 2022-08-11 - Reminder to add bonus] Add skeleton UI to chats #7081 (comment)
  8. Scroll to load more chats. While the chats are being loaded you should see two sets of skeleton UI loaders.
  9. Once the chat data is loaded and you switch between the chats, you shouldn't see the Skeleton UI, just the chat data with a fast fadein animation.
  • Verify that no errors appear in the JS console

Screenshots

Web

https://user-images.githubusercontent.com/3069065/175809839-cbb36e8e-0d77-4fb1-9060-f3ab57f43935.mov
https://user-images.githubusercontent.com/3069065/178344350-4115b23d-c006-49ae-86ae-e914ca6df577.mov

Mobile Web

https://user-images.githubusercontent.com/3069065/175809876-baaecb7b-bc49-4d4d-999f-56ca4e1f9783.mov
https://user-images.githubusercontent.com/3069065/175809892-59b58f60-c0c6-463b-be26-9fbecddcf288.mov

Desktop

https://user-images.githubusercontent.com/3069065/175809929-31a50372-d329-47dc-b173-03fa2aa95588.mov
https://user-images.githubusercontent.com/3069065/178345476-33e4a3ee-1858-48ad-b139-f65ccbe5b017.mp4

iOS

https://user-images.githubusercontent.com/3069065/175809976-ecf88fe7-046b-4c65-abb7-154d5efb89e7.mov
https://user-images.githubusercontent.com/3069065/175809984-14919ff4-ccdd-45e2-9188-0d7afee5488f.mov

Android

https://user-images.githubusercontent.com/3069065/175809992-09d82713-d87f-4fcd-a90e-1b9839947de7.mov
https://user-images.githubusercontent.com/3069065/175810023-584c8df6-f51a-41ca-97f1-f1cdee6645e0.mov

@mananjadhav mananjadhav marked this pull request as ready for review March 8, 2022 18:40
@mananjadhav mananjadhav requested a review from a team as a code owner March 8, 2022 18:40
@MelvinBot MelvinBot removed the request for review from a team March 8, 2022 18:40
Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

Please mention platforms/devices on QA steps.

src/pages/home/ReportScreen.js Outdated Show resolved Hide resolved
src/pages/home/ReportScreen.js Outdated Show resolved Hide resolved
src/components/ChatGhostUI/index.js Outdated Show resolved Hide resolved
src/components/ChatGhostUI/index.js Outdated Show resolved Hide resolved
src/components/ChatGhostUI/index.js Outdated Show resolved Hide resolved
src/components/ChatGhostUI/index.js Outdated Show resolved Hide resolved
src/components/ChatGhostUI/index.js Outdated Show resolved Hide resolved
src/components/ChatGhostUI/index.js Outdated Show resolved Hide resolved
@parasharrajat
Copy link
Member

Please also look into this danilowoz/react-content-loader#125. Performance is crucial for this page.

@shawnborton
Copy link
Contributor

This looks like it's not quite aligned correctly either. Notice that when we overlay the ghost loader on top of real content, the avatars and messages aren't lined up:
image

@Luke9389 Luke9389 mentioned this pull request Mar 9, 2022
7 tasks
@mananjadhav
Copy link
Collaborator Author

This looks like it's not quite aligned correctly either.

Fixing it.

@parasharrajat
Copy link
Member

Conflicts again... 🙄

src/libs/actions/Report.js Outdated Show resolved Hide resolved
@mananjadhav
Copy link
Collaborator Author

@parasharrajat Resolved the conflict and 1 comment that you raised.

@parasharrajat
Copy link
Member

Conflicts again...

@mananjadhav
Copy link
Collaborator Author

Resolved @parasharrajat

Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

code LGTM just noticed a small thing

src/pages/home/ReportScreen.js Outdated Show resolved Hide resolved
parasharrajat
parasharrajat previously approved these changes Jul 29, 2022
Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

It seems pagination is broken but that can't be caused by this PR. When pagination was working, this PR was working correctly. I am currently not sure how to test that correctly but to me, PR looks good.

cc: @Luke9389

PR 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 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.

🎀 👀 🎀 C+ reviewed

@mananjadhav
Copy link
Collaborator Author

mananjadhav commented Jul 29, 2022

Thanks @parasharrajat for the quick review on this one.

@marcaaron Updated the comment, quick approval will move this forward.

@Luke9389 Luke9389 merged commit a3859da into Expensify:main Jul 29, 2022
@Luke9389
Copy link
Contributor

Merged! Before any more conflicts happen XD

@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.

@OSBotify
Copy link
Contributor

OSBotify commented Aug 1, 2022

🚀 Deployed to staging by @Luke9389 in version: 1.1.87-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 4, 2022

🚀 Deployed to production by @yuwenmemon in version: 1.1.87-9 🚀

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

@grgia
Copy link
Contributor

grgia commented Dec 12, 2022

Commenting for completion of the BZ checklist. This PR introduced a bug where the skeleton UI went over the edge of the screen on mobile. See PR for the fix.

skeletonViewLines.push(<SkeletonViewLines numberOfRows={1} key={`skeletonViewLines${index}`} />);
}
}
return <>{skeletonViewLines}</>;
Copy link
Contributor

Choose a reason for hiding this comment

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

This should have been wrapped within a View. Otherwise the skeleton lines may shrink if the outer view height is not enough.

(Coming from a regression #19442)

Copy link
Member

@parasharrajat parasharrajat May 30, 2023

Choose a reason for hiding this comment

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

Again, this was not needed at the time we built it so this can't be a regression from this PR. Later when the payment page was added it should have been adjusted to that case as well thus that PR should be linked as regression PR.

@mananjadhav
Copy link
Collaborator Author

Our x coordinate for the SVG components had issues with spacing, which caused a regression here.

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.

None yet