Skip to content

Static skeleton loader for offline reports#58079

Merged
MariaHCD merged 9 commits intoExpensify:mainfrom
callstack-internal:static-skeleton-loader-for-offline-chat
Mar 19, 2025
Merged

Static skeleton loader for offline reports#58079
MariaHCD merged 9 commits intoExpensify:mainfrom
callstack-internal:static-skeleton-loader-for-offline-chat

Conversation

@martasudol
Copy link
Contributor

@martasudol martasudol commented Mar 10, 2025

Explanation of Change

In offline state, chat history is blank except for the last message at the bottom of a page. It doesn't look user-friendly so with this change the flow is the following:

  • If the user is offline and only has partially loaded data, we show a static skeleton above loaded messages.
  • Once they go online, messages will load in and replace the skeleton.
  • If locally available data includes the CREATED message (oldest one) we can skip rendering the static skeleton at the top (since we have the whole history).
    This will result in no blank spaces & informative workflow that lets you know what's going on.

Fixed Issues

$#57593

Tests

  1. Turn on offline mode
  2. Navigate to the reports list
  3. Click on any report
  4. You should see local messages and static skeleton above.
  5. If you turn off offline mode, you should not see skeleton anymore.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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 https://github.com/user-attachments/assets/6a5e6e33-c42f-4c37-aa03-95aa1b558f9d
Android: mWeb Chrome https://github.com/user-attachments/assets/a646ba27-31f9-41a2-a56f-6a986fc2b11a
iOS: Native https://github.com/user-attachments/assets/67cbaf04-53b8-47fb-b4ea-0234fc29114c
iOS: mWeb Safari https://github.com/user-attachments/assets/dc6074fa-3094-4b71-8dd2-a92f68ea7cd9
MacOS: Chrome / Safari https://github.com/user-attachments/assets/5822d194-4633-488a-97fd-5574e9b95f25
MacOS: Desktop https://github.com/user-attachments/assets/8dc103ec-d0fa-475a-88d2-e27562bf745b

@martasudol martasudol marked this pull request as ready for review March 10, 2025 10:32
@martasudol martasudol requested review from a team as code owners March 10, 2025 10:32
@melvin-bot melvin-bot bot requested review from akinwale and removed request for a team March 10, 2025 10:32
@melvin-bot
Copy link

melvin-bot bot commented Mar 10, 2025

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

@mountiny
Copy link
Contributor

@fedirjh Can you please jump on the review? Thanks!

@martasudol there are conflicts

@dannymcclain
Copy link
Contributor

Videos are looking pretty good to me—but what is this empty state?

image

@Expensify/design I've never seen one of our table row empty states in a chat before.

@shawnborton
Copy link
Contributor

Yeah, that seems incorrect to me - I thought we would just use standard skeleton rows that were static?

@shawnborton
Copy link
Contributor

The desktop style looks correct to me FWIW:
CleanShot 2025-03-10 at 15 46 21@2x

@shawnborton
Copy link
Contributor

And this from the mobile video is correct:
CleanShot 2025-03-10 at 15 47 16@2x

@martasudol
Copy link
Contributor Author

This empty state is displayed when there are no messages already fetched and user is offline. That was done in the previous task and somehow I also feel it doesn't fit here well. Maybe just static skeleton would be the option here too? So to simplify this:

  1. In offline state (we do not fetch any data), if there are any messages already fetched - we show static skeleton above them.
  2. In offline state (we do not fetch any data), if there are no messages at all - we show empty state.
    What do you think @dannymcclain @shawnborton?

@shawnborton
Copy link
Contributor

Hmm personally I don't think that empty state makes sense for chats. I would say we should never be showing an empty state like that in any chat room.

@martasudol
Copy link
Contributor Author

@shawnborton understandable. Do you think static skeleton also in this case is proper approach?

@shawnborton
Copy link
Contributor

That would be fine with me personally, let's see if @Expensify/design agrees though!

@dannymcclain
Copy link
Contributor

That would be fine with me personally, let's see if @Expensify/design agrees though!

Same!

@martasudol
Copy link
Contributor Author

Got it, already modified so right now in this case we show static skeleton for the whole report section 👌 also updated recordings in the PR description so you can take a look!

@shawnborton
Copy link
Contributor

Videos look good to me! And then once your other PR with color changes gets merged, I assume the skeletons will appear a bit darker (which I think is a good thing, they are quite faint right now).

@martasudol
Copy link
Contributor Author

Exactly @shawnborton - actually, PR with color changes is already merged (#58200)

@shawnborton
Copy link
Contributor

Sounds good! Anyways all good on my end, I think we can start the final review of this one.

@dubielzyk-expensify
Copy link
Contributor

That would be fine with me personally, let's see if @Expensify/design agrees though!

Me three

@martasudol
Copy link
Contributor Author

@fedirjh could you please review it? 🙏

@fedirjh
Copy link
Contributor

fedirjh commented Mar 13, 2025

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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
CleanShot.2025-03-14.at.06.09.06.mp4
Screenshot 2025-03-14 at 6 09 40 AM Screenshot 2025-03-14 at 6 11 08 AM
Android: mWeb Chrome
CleanShot.2025-03-14.at.05.54.42.mp4
Screenshot 2025-03-14 at 5 55 14 AM
iOS: Native
CleanShot.2025-03-14.at.05.22.05.mp4
Screenshot 2025-03-14 at 5 23 04 AM
iOS: mWeb Safari
CleanShot.2025-03-14.at.05.33.26.mp4
MacOS: Chrome / Safari
CleanShot.2025-03-13.at.16.43.08.mp4
MacOS: Desktop
CleanShot.2025-03-13.at.17.08.03.mp4

@shawnborton
Copy link
Contributor

Can we pull main into the branch? I am seeing the old gap in the report header that we ended up reverting:
CleanShot 2025-03-17 at 09 48 10@2x

Or maybe @fedirjh you need to pull again. I will also run a test build for us.

@github-actions
Copy link
Contributor

🚧 @shawnborton has triggered a test app build. You can view the workflow run here.

@martasudol
Copy link
Contributor Author

@shawnborton please wait a liitle bit with build, I'm addressing @fedirjh comments.

@shawnborton
Copy link
Contributor

Ah oopsies - but no worries, just let me know when you want me to rebuild again!

@github-actions

This comment has been minimized.

@martasudol
Copy link
Contributor Author

@shawnborton we're good to go with build 👌

@shawnborton
Copy link
Contributor

Coming right up 🚀

@github-actions
Copy link
Contributor

🚧 @shawnborton has triggered a test app build. You can view the workflow run here.

@github-actions
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/58079/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Android Hybrid 🤖🔄 iOS Hybrid 🍎🔄
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/58079-hybrid/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/58079-hybrid/index.html
Android Hybrid iOS Hybrid
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/58079/NewExpensify.dmg https://58079.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@martasudol
Copy link
Contributor Author

@fedirjh @shawnborton, just a gentle reminder about the review 🙏

@shawnborton
Copy link
Contributor

@fedirjh can you please begin final review of this?

@martasudol are the videos in your OP above up to date with the latest styles?

@martasudol
Copy link
Contributor Author

@shawnborton just updated

@fedirjh
Copy link
Contributor

fedirjh commented Mar 18, 2025

Screenshots/Videos

Android: Native
CleanShot.2025-03-18.at.20.58.26.mp4
Android: mWeb Chrome
CleanShot.2025-03-18.at.21.03.17.mp4
iOS: Native
Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-03-18.at.19.44.29.mp4
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-03-18.at.20.04.48.mp4
MacOS: Chrome / Safari
CleanShot.2025-03-17.at.19.26.16.mp4
MacOS: Desktop
CleanShot.2025-03-17.at.20.10.41.mp4

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

LGTM.

Over to you @shawnborton

@melvin-bot melvin-bot bot requested a review from MariaHCD March 18, 2025 20:13
@shawnborton
Copy link
Contributor

Videos look good to me, cc @MariaHCD for final review - thanks!

@MariaHCD MariaHCD merged commit b4349b1 into Expensify:main Mar 19, 2025
18 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.

@github-actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/MariaHCD in version: 9.1.16-0 🚀

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

@github-actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.1.16-4 🚀

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

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.

8 participants