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: Implement loading skeleton small screen width #43652

Merged

Conversation

truph01
Copy link
Contributor

@truph01 truph01 commented Jun 13, 2024

Details

  • This PR add the loading skeleton to the small screen width on the search page:
    image

Fixed Issues

$ #43395
PROPOSAL: #43395 (comment)

Tests

Mobile device

  1. Open app
  2. Go to /search/all?sortBy=date&sortOrder=desc
  3. When the data is not available, verify the skeleton is displayed like below:
    image

Desktop device

  1. Open app.
  2. Go to /search/all?sortBy=date&sortOrder=desc
  3. When the data is not available, verify the skeleton is displayed as it is.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-06-13.at.19.01.45.mov
Android: mWeb Chrome
Screen.Recording.2024-06-13.at.19.00.56.mov
iOS: Native
Screen.Recording.2024-06-13.at.19.17.31.mov
iOS: mWeb Safari
Screen.Recording.2024-06-13.at.18.59.19.mov
MacOS: Chrome / Safari
Screen.Recording.2024-06-13.at.18.55.17.mov
MacOS: Desktop
Screen.Recording.2024-06-13.at.19.02.34.mov

@truph01 truph01 requested a review from a team as a code owner June 13, 2024 11:53
@melvin-bot melvin-bot bot requested review from akinwale and removed request for a team June 13, 2024 11:53
Copy link

melvin-bot bot commented Jun 13, 2024

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

@akinwale
Copy link
Contributor

Pinging @Expensify/design for review here.

@dannymcclain dannymcclain requested a review from a team June 13, 2024 13:41
@shawnborton
Copy link
Contributor

Looks pretty good! I'm going to spin up a test build for easier testing.

@shawnborton
Copy link
Contributor

Another thing I noticed is that our desktop loading skeleton isn't quite accurate - it should also have the colored background behind it to simulate the table row cards that would show up. Something like this:
CleanShot 2024-06-13 at 16 36 11@2x

@luacmartins perhaps we could increase the bounty and address that here as well?

src/CONST.ts Outdated Show resolved Hide resolved
import ItemListSkeletonView from './ItemListSkeletonView';

type TableListItemSkeletonProps = {
shouldAnimate?: boolean;
fixedNumItems?: number;
};

const circleRadius = 8;
const padding = 12;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the padding on mobile for these cards is 12 vertical, and 16 horizontal.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@shawnborton Can you share the design about the "padding" you mentioned above?

Copy link
Contributor

Choose a reason for hiding this comment

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

This is what the padding should look like:
CleanShot 2024-06-14 at 17 28 36@2x

Copy link
Contributor

Choose a reason for hiding this comment

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

And there should be an 8px gap between the content at the top of the row and the content at the bottom:
CleanShot 2024-06-14 at 17 29 07@2x

renderSkeletonItem={() => (
<>
<Circle
cx={padding + circleRadius}
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of doing any fancy math here, can we just say that this should be 16x16?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The fancy math will help me when debugging. I will remove these once we do not have a design change any more. Also, in this case, padding + circleRadius = 16

<Rect
x={padding + circleRadius * 2 + 4}
y={padding + circleRadius - 2}
width={windowWidth * 0.2}
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we just give this a fixed width of 40?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated. Here is result:

image

Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't match the Figma design though. Can you double check? The receipt icon is 36x40.

This comment has been minimized.

@shawnborton
Copy link
Contributor

Maybe this helps note some of the differences:
CleanShot 2024-06-13 at 17 07 08@2x

Another thing I am seeing is that the gap between rows is incorrect - it should be 12px, not 16 or 20.

@shawnborton
Copy link
Contributor

But this in a quick Figma file for easier inspection too.

@luacmartins luacmartins self-requested a review June 13, 2024 15:42
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Looking good. I agree with @shawnborton's comments. We need to adjust some of the values and also I think we should remove a lot of the math and just set fixed values for these.

src/CONST.ts Outdated Show resolved Hide resolved
@truph01
Copy link
Contributor Author

truph01 commented Jun 14, 2024

@shawnborton

Another thing I am seeing is that the gap between rows is incorrect - it should be 12px, not 16 or 20.

I updated. Here is result:
Screenshot 2024-06-14 at 18 59 55

@truph01
Copy link
Contributor Author

truph01 commented Jun 14, 2024

@luacmartins

We need to adjust some of the values and also I think we should remove a lot of the math and just set fixed values for these.

I will add the fixed values once there is no design that needs to be updated. The math helps me a lot of when debugging.

@shawnborton
Copy link
Contributor

Can you please review the Figma file here to make sure you are using the exact measurements? Thanks!

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

@truph01 is this ready for review again?

@shawnborton
Copy link
Contributor

Hmm any idea why iOS failed to build?

@shawnborton
Copy link
Contributor

Anyways let's start reviewing this and getting some screenshots. Thanks!

luacmartins
luacmartins previously approved these changes Jun 20, 2024
Copy link
Contributor

@luacmartins luacmartins 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. I kicked off another test build. Let's get this one wrapped up!

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/43652/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/43652/NewExpensify.dmg https://43652.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@akinwale
Copy link
Contributor

@truph01 Please add test steps to the OP. Thanks.

@truph01
Copy link
Contributor Author

truph01 commented Jun 21, 2024

@akinwale I added the test steps

@shawnborton
Copy link
Contributor

Sorry for the late comment, but I realized that this component should actually be 108px tall. We need an extra 8px of gap between the top header row and the bottom content:
CleanShot 2024-06-21 at 14 46 14@2x

This way it will match up perfectly with our changes here: #43733

@luacmartins
Copy link
Contributor

luacmartins commented Jun 21, 2024

@truph01 seems like we have to make some small adjustments

@truph01
Copy link
Contributor Author

truph01 commented Jun 21, 2024

We need an extra 8px of gap between the top header row and the bottom content

@shawnborton I updated it. Here is result:

image

@shawnborton
Copy link
Contributor

Looks good to me. Let's get this thing into final review!

luacmartins
luacmartins previously approved these changes Jun 21, 2024
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM

@akinwale
Copy link
Contributor

akinwale commented Jun 22, 2024

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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
43652-android-native.mp4
Android: mWeb Chrome
43652-android-chrome.mp4
iOS: Native
43652-ios-native.mp4
iOS: mWeb Safari
43652-ios-safari.mp4
MacOS: Chrome / Safari
43652-web.mp4
MacOS: Desktop
43652-desktop.mp4

@truph01
Copy link
Contributor Author

truph01 commented Jun 22, 2024

@akinwale I fixed your comment

@shawnborton
Copy link
Contributor

Screenshots look good!

Copy link
Contributor

@akinwale akinwale left a comment

Choose a reason for hiding this comment

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

LGTM.

@melvin-bot melvin-bot bot requested a review from luacmartins June 24, 2024 05:04
@luacmartins luacmartins merged commit 6393f36 into Expensify:main Jun 24, 2024
15 of 16 checks passed
@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

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.2-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jul 3, 2024

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants