Skip to content

feat(26270): Add Skeleton UI for Money Requests#26613

Merged
mountiny merged 12 commits into
Expensify:mainfrom
mananjadhav:feat-26270-skeleton-ui
Sep 4, 2023
Merged

feat(26270): Add Skeleton UI for Money Requests#26613
mountiny merged 12 commits into
Expensify:mainfrom
mananjadhav:feat-26270-skeleton-ui

Conversation

@mananjadhav

@mananjadhav mananjadhav commented Sep 3, 2023

Copy link
Copy Markdown
Collaborator

Details

  • Adds the SkeletonView to the Money Requests, while the transaction is being loaded.

Fixed Issues

$ #26270
PROPOSAL:

Tests

  • Check the skeleton UI is loaded for the request money
  • Check the skeleton UI is loaded for the distance money request
  • Verify the skeleton UI design is as per this spec.
  • Verify the skeleton UI is hidden once the transaction is loaded.
  • Verify that no errors appear in the JS console

Offline tests

  • Skeleton UI won't be loaded in the offline mode, as we see greyed out amounts for the transaction.

QA Steps

For all platforms

  1. Open the app, logout if you're already logged in. (this is to ensure that we don't load the transactions from local storage).
  2. You can enable throttling with slow 3G/2G for the longer duration on the SkeletionUI.
  3. Go to any chat where you have an existing IOU (Money Requests)
  4. Verify that the skeleton view is showed for the money preview.
  5. Once the transaction is loaded, it shows the amount, and description.
  6. Repeat steps 3 to 5 for any distance requests. It should show skeleton view below the map.
  7. Verify the skeleton view, looks like the following:

image

  • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Distance Requests

web-iou-skeleton-ui-3.mov

Multiple Requests

web-iou-skeleton-ui-2.mov

IOU Requests

web-iou-skeleton-ui-1.mov
Mobile Web - Chrome
mweb-chrome-ioi-skeleton-ui.mov
Mobile Web - Safari
mweb-safari-iou-skeleton-ui.mov
Desktop
desktop-iou-skeleton-ui.mov
iOS
ios-iou-skeleton-ui.mov
Android
android-iou-skeleton-ui.mov

@hayata-suenaga hayata-suenaga self-requested a review September 3, 2023 19:01
@hayata-suenaga

Copy link
Copy Markdown
Contributor

@mananjadhav Is it possible that you can push the rest of the changes soon? I think we want to fix this as soon as possible 🙇 (i.e. we want to deploy this to production)

@mananjadhav

Copy link
Copy Markdown
Collaborator Author

I am just working on the checklist.

@mananjadhav mananjadhav marked this pull request as ready for review September 3, 2023 19:32
@mananjadhav mananjadhav requested a review from a team as a code owner September 3, 2023 19:32
@melvin-bot melvin-bot Bot requested review from fedirjh, mountiny and shawnborton and removed request for a team September 3, 2023 19:32
@melvin-bot

melvin-bot Bot commented Sep 3, 2023

Copy link
Copy Markdown

@shawnborton @fedirjh @mountiny 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]

@mananjadhav

Copy link
Copy Markdown
Collaborator Author

@hayata-suenaga @mountiny @shawnborton @fedirjh The PR is ready.

Comment thread src/components/MoneyRequestSkeletonView.js Outdated
Comment thread src/components/MoneyRequestSkeletonView.js Outdated
Comment thread src/components/MoneyRequestSkeletonView.js Outdated
Comment thread src/components/MoneyRequestSkeletonView.js Outdated
Comment thread src/components/ReportActionItem/MoneyRequestPreview.js Outdated
@mountiny

mountiny commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

niiice, videos looking good!

@mananjadhav

Copy link
Copy Markdown
Collaborator Author

@parasharrajat I've fixed the comments. Should've raised a PR fresh in the morning to avoid silly changes. Thanks for catching those.

@parasharrajat

Copy link
Copy Markdown
Member

@mananjadhav Can you please fix the attachments on the descriptions? It seems some are not rendered. We can work on it in the IST zone in the morning to if there are more requests.

@mananjadhav

Copy link
Copy Markdown
Collaborator Author

@parasharrajat I've updated the description so that Web attachments show up.

We can work on it in the IST zone in the morning to if there are more requests.

Sure that'll be great!

@parasharrajat

parasharrajat commented Sep 3, 2023

Copy link
Copy Markdown
Member

I am seeing something strange. On every Money Report(iOU, Expense), it first shows a bottom skeleton loader and then it will be replaced with normal messages as well IOU preview.

Is this correct?

Check video from 0.15 Sec.

Screen.Recording.2023-09-04.at.2.16.27.AM.mov

@mananjadhav

mananjadhav commented Sep 4, 2023

Copy link
Copy Markdown
Collaborator Author

Yeah I thought so too. I am only replacing with the skeleton view, the behavior exists for other wise IOU requests too. I don't have the message context too that I can replace the message with any other skeleton view.

Check from 00:13 secs.

iou-shifting-action-item.mov

@mountiny

mountiny commented Sep 4, 2023

Copy link
Copy Markdown
Contributor

Yeah I think the last thing is fine

@parasharrajat

Copy link
Copy Markdown
Member

I see. In that case, it is fine.

@parasharrajat

Copy link
Copy Markdown
Member

@mananjadhav What about ReportPreview component? I don't know where it is rendered exactly but this seems like a target too.

@mountiny

mountiny commented Sep 4, 2023

Copy link
Copy Markdown
Contributor

@mananjadhav typescript and jest tests are failing

@mountiny

mountiny commented Sep 4, 2023

Copy link
Copy Markdown
Contributor

Lets address those and the whisper hover and we can ship it

@mananjadhav

Copy link
Copy Markdown
Collaborator Author

@mountiny I am fixing the whisper style, but the actions seem to be unrelated to the change.

Error: Can't use 'tar -xzf' extract archive file: /home/runner/work/_actions/_temp_c7bd8373-bd25-4ab3-b03b-381b3f466a98/d821e6bc-5da4-4209-8fc4-21fe9c41257f.tar.gz. return code: 2.

@mananjadhav

Copy link
Copy Markdown
Collaborator Author

@rezkiy37 Thanks for reporting the issue, but for some reason I am not able to reproduce this issue at my end. Can you tell me the reproduction steps?

web-whisper-hover-style.mov

@rezkiy37

rezkiy37 commented Sep 4, 2023

Copy link
Copy Markdown
Contributor

@rezkiy37 Thanks for reporting the issue, but for some reason I am not able to reproduce this issue at my end. Can you tell me the reproduction steps?

web-whisper-hover-style.mov

Yeah, I see. Let try one more time, maybe someone has fixed it right now 😅

@mananjadhav

Copy link
Copy Markdown
Collaborator Author

Checking lint issues and other fixes.

@rezkiy37

rezkiy37 commented Sep 4, 2023

Copy link
Copy Markdown
Contributor

Hah, it was fixed in another PR that was merged 3 hours ago. No bug anymore 🙂

@mountiny

mountiny commented Sep 4, 2023

Copy link
Copy Markdown
Contributor

vit-26503theft to the rescue

@mananjadhav

Copy link
Copy Markdown
Collaborator Author

@mountiny @parasharrajat @rezkiy37 do we have any more outstanding comments?

@rezkiy37

rezkiy37 commented Sep 4, 2023

Copy link
Copy Markdown
Contributor

@mountiny @parasharrajat @rezkiy37 do we have any more outstanding comments?

From my side, LGTM!

@parasharrajat

Copy link
Copy Markdown
Member

Will do the checklist in 20 minutes.

@parasharrajat

parasharrajat commented Sep 4, 2023

Copy link
Copy Markdown
Member

Screenshots

🔲 iOS / native

Screen.Recording.2023-09-04.at.8.41.54.PM.mov

🔲 iOS / Safari

Screen.Recording.2023-09-04.at.8.34.58.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-09-04.at.8.43.40.PM.mov
Screen.Recording.2023-09-04.at.8.44.42.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-09-04.at.8.22.24.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-09-04.at.8.39.28.PM.mov

🔲 Android / native

Screen.Recording.2023-09-04.at.8.32.07.PM.mov

@parasharrajat parasharrajat left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

🎀 👀 🎀 C+ reviewed

@mountiny mountiny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for all the hard work!

@mountiny mountiny merged commit 41ca24b into Expensify:main Sep 4, 2023
@OSBotify

OSBotify commented Sep 4, 2023

Copy link
Copy Markdown
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

OSBotify commented Sep 4, 2023

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.63-0 🚀

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

@OSBotify

OSBotify commented Sep 5, 2023

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.63-2 🚀

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

@OSBotify

OSBotify commented Sep 5, 2023

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.64-0 🚀

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

@OSBotify

OSBotify commented Sep 6, 2023

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.64-2 🚀

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

/>
<Text style={[styles.textLabelSupporting, styles.mb1, styles.lh20]}>{getSettledMessage()}</Text>
</>
{_.isEmpty(props.transaction) ? (

@0xmiroslav 0xmiroslav Oct 9, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This caused regression of showing skeleton forever when delete money request offline - #26939
Because transaction data is also deleted optimistically.

src={Expensicons.DotIndicator}
width={4}
height={4}
additionalStyles={[styles.mr1, styles.ml1]}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

9 participants