fix: Show top report skeleton when offline

[paultsimura]

Details

Show the top report skeleton when offline & the beginning of the history is not loaded.
Also, show the skeleton animation always regardless of the network state: #31367 (comment)

Fixed Issues

$ #31367
$ #30503
PROPOSAL: #31367 (comment)

Tests

Same as QA

Offline tests

Same as QA

QA Steps

1. Open a chat that has a long chat history.
2. Go offline.
3. Scroll to the top.
4. Return to LHN.
5. Reopen the chat in Step 1 and scroll to the top.

• Verify that a short 3-sections skeleton is displayed on top and is animated.

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

Screenshots/Videos

Android: Native

android-compressed.mp4

Android: mWeb Chrome

chrome-compressed.mp4

iOS: Native

iOS.mp4

iOS: mWeb Safari

safari.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

[melvin-bot]

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

[paultsimura]

@getusha a friendly bump on this PR

[getusha]

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

Screen.Recording.2023-11-27.at.11.21.40.PM.mov

Android: mWeb Chrome

Screen.Recording.2023-11-27.at.11.25.25.PM.mov

iOS: Native

Screen.Recording.2023-11-27.at.11.12.19.PM.mov

iOS: mWeb Safari

Screen.Recording.2023-11-27.at.11.26.23.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-11-27.at.11.29.59.PM.mov

MacOS: Desktop

Screen.Recording.2023-11-27.at.11.36.30.PM.mov

[getusha]

@paultsimura i am seeing this when the report do not have much report items.

It Looks fine, i was wondering if we want the skeleton to fill the screen.

[paultsimura]

@getusha I believe, it's coming from the isLoadingInitialReportActions var, which was implemented like this before my PR.

@shawnborton what would you say about such UI here? #31492 (comment)

[shawnborton]

Hmm yeah, a couple more skeleton messages might be nice to fill the screen a bit more. cc @Expensify/design in case they disagree :)

[paultsimura]

I don't think we have a truly flexible solution here: it's either a fixed number of skeleton rows (which used to be 3) or a skeleton that takes the whole screen height:

Whole height

long-skeleton.mov

I tried to increase the fixed height to 5, but it still won't work for all the cases, let's say we have 3 items loaded, the 5 lines look OK:

5-lines-mobile.mov

But if we have only 1 item loaded, then 5 lines won't be enough, especially on web:

5-lines-web.mov

Should we want to use the full-height skeleton for the initial data loading?

@shawnborton @getusha

[shawnborton]

Should we want to use the full-height skeleton for the initial data loading?

What does this mean exactly?

Otherwise can we just pick a higher number, like 7? If it doesn't work perfectly everywhere, that's okay - as long as it covers most of the cases.

[paultsimura]

What does this mean exactly?

This value is set to true when we first open the Report. If we're opening the report when offline, this value doesn't change to false until we're back online.

This is how the screen looks when we are loading the initial report actions and there are no pre-loaded actions:

Maybe we could go with the same approach and append the full-height skeleton even if we have some of the actions (though it will be scrollable):

Otherwise, I'll go with the fixed 7:

@shawnborton it's up to you ☝️

[shawnborton]

I don't feel too strongly, I'd say whatever our C+/engineer thinks is the best approach works for me.

[paultsimura]

Got it. @getusha your shot, please

[getusha]

I think if it's the same on main/production, we can leave it as it is because it's a design choice.
what do you think? @shawnborton

[shawnborton]

That works for me

[paultsimura]

That works for me

@getusha in this case, I think the PR can be approved if the rest LGTY?

[getusha]

@paultsimura the author PR checklist check is failing, can you make sure the PR has up-to-date checklist content?

[paultsimura]

@getusha done ✅
Does it show different for you?

[getusha]

Looks good, works well.

[paultsimura]

Just an FYI: I think I finally figured out why it was decided to use the 3-lines-high skeleton when loading the initial report data.
This is to replace only the header (avatars, "Say hello", and the "Collaboration..." message). In many cases, it's the only thing that will be loaded after coming back online.

cc: @getusha @shawnborton

[aldo-expensify]

Considering the conversation above, @getusha @paultsimura are we fine to proceed then?

[paultsimura]

Are we fine to proceed then?

From my POV – yes

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 1.4.7-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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