fix: Chat - Skeleton placeholder flickers when opening chat with IOU in offline mode by paultsimura · Pull Request #30658 · Expensify/App

paultsimura · 2023-10-31T20:36:42Z

Details

Fix the flickering of the IOU report when offline

Fixed Issues

$ #30503
PROPOSAL: #30503 (comment)

Tests

Same as QA.

Offline tests

Same as QA.

QA Steps

Precondition: There must be a user with an existing unpaid IOU.

Log out and log in again and do not open the chat report with the user that has existing IOU.
Go offline.
Go to + > Request money > Manual.
Request money from the user in the precondition.
Click on the IOU report preview

Verify that the skeleton UI is not flickering

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

Android: Native

Android-compressed.mp4

Android: mWeb Chrome

chrome.mp4

iOS: Native

iOS.mp4

iOS: mWeb Safari

safari.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mp4

# Conflicts: # src/pages/home/report/ReportActionsView.js

melvin-bot · 2023-10-31T20:36:48Z

@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 · 2023-10-31T20:47:39Z

@getusha the PR's ready, the only thing I'm concerned about is that the skeleton UI is not visible on the first render of the IOU report. It appears only if we re-render it (e.g. go to transaction view and back).

But this seems to have been done intentionally (please see the comment):

App/src/pages/home/report/ReportActionsList.js

Lines 371 to 376 in 36495e6

    
           // Skip this hook on the first render, as we are not sure if more actions are going to be loaded 
        
           // Therefore showing the skeleton on footer might be misleading 
        
           if (!hasFooterRendered.current) { 
        
               hasFooterRendered.current = true; 
        
               return null; 
        
           }

getusha · 2023-10-31T20:54:29Z

the only thing I'm concerned about is that the skeleton UI is not visible on the first render of the IOU report.

@paultsimura is this happening on main?

aldo-expensify · 2023-10-31T22:50:14Z

src/pages/home/report/ReportActionsView.js

     * @returns {Boolean}
     */
    const isReportFullyVisible = useMemo(() => getIsReportFullyVisible(isFocused), [isFocused]);
+    const isFullHistoryFetched = useMemo(() => _.last(props.reportActions).actionName === CONST.REPORT.ACTIONS.TYPE.CREATED, [props.reportActions]);


I don't think _.last(props.reportActions).actionName === CONST.REPORT.ACTIONS.TYPE.CREATED is expensive enough to be using useMemo. This is just accessing the lsat member of an array which should be very fast.

paultsimura · 2023-11-01T05:05:28Z

@ospfranco @fedirjh could you please help us understand what use case was this piece of code initially fixing, and if it might be safe to remove now since we've separated the actions loading variables to isLoadingNewerReportActions, isLoadingOlderReportActions, and isLoadingInitialReportActions?

App/src/pages/home/report/ReportActionsList.js

Lines 371 to 376 in 36495e6

    
           // Skip this hook on the first render, as we are not sure if more actions are going to be loaded 
        
           // Therefore showing the skeleton on footer might be misleading 
        
           if (!hasFooterRendered.current) { 
        
               hasFooterRendered.current = true; 
        
               return null; 
        
           }

paultsimura · 2023-11-01T13:13:28Z

@getusha I think I figured it out. We use the useRef here to not show the skeleton while the first request to load more actions is running (so that we won't show it just for a second):

App/src/pages/home/report/ReportActionsList.js

Lines 371 to 376 in c8e7ee5

    
           // Skip this hook on the first render, as we are not sure if more actions are going to be loaded 
        
           // Therefore showing the skeleton on footer might be misleading 
        
           if (!hasFooterRendered.current) { 
        
               hasFooterRendered.current = true; 
        
               return null; 
        
           }

But as we are offline, the actual request will not be sent to the BE, and we are safe to show the skeleton permanently until we are back online. So I've modified the logic with these references.

I also removed the originally proposed change to isLoadingOlderReportActions in ReportActionsView because when offline, we are already showing the isLoadingInitialReportActions skeleton, and I think this should be enough for the good UX (most likely, it was like this by design).

Ready for your re-review.

getusha · 2023-11-03T13:54:34Z

@paultsimura could you check why Jest Unit Tests are failing?

paultsimura · 2023-11-03T15:34:35Z

Jest Unit Tests are failing

@getusha I believe it was some flaky test. Resolved by itself after I merged main.

getusha · 2023-11-03T19:49:57Z

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

FILE.2023-11-06.17.46.51.mp4

Android: mWeb Chrome

Screen.Recording.2023-11-07.at.8.00.02.PM.mov

iOS: Native

Screen.Recording.2023-11-07.at.2.41.43.PM.mov

iOS: mWeb Safari

Screen.Recording.2023-11-07.at.4.20.50.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2023-11-07.at.4.13.27.PM.mov

MacOS: Desktop

Screen.Recording.2023-11-07.at.8.05.58.PM.mov

getusha · 2023-11-03T20:58:30Z

@paultsimura noticed this, still looks glitchy but with bigger interval than the previous one. can you check it?

Screen.Recording.2023-11-03.at.11.57.05.PM.mov

paultsimura · 2023-11-03T21:29:59Z

@getusha Could you please share a little context on how to reproduce this? I see on your recording, this is happening on a regular report screen, not the IOU as it was in the issue. I'll try to reproduce, but any details would be useful 🙏🏼

getusha · 2023-11-04T04:36:02Z

@paultsimura i just scrolled up, and this is happening. i think we should also fix this since it is the same issue at a different place.

paultsimura · 2023-11-04T05:13:35Z

we should also fix this since it the same issue at a different place.

Sure, I'm on it. Thanks for catching this bug

paultsimura · 2023-11-04T10:08:03Z

@getusha I couldn't reproduce it on either iOS or Android.
I see your recording is from Android – could you please double-check that you are testing after the app is already bundled, so it's not a cached version? Androids can get annoying by not loading the changes.

And also for the clarity of the experiment – please check if the same flickering is happening on the IOU Report 🙏

getusha · 2023-11-04T11:01:13Z

@paultsimura still not able to reproduce? i thought i saw a comment saying u're able to reproduce it.

paultsimura · 2023-11-04T12:33:49Z

@getusha I tried on web - checked staging by mistake, and commented "reproduced". Only after that I noticed that it was staging, so I removed that comment.

Still not able to reproduce on my branch.

getusha

Looks good and tests went well.

getusha · 2023-11-07T17:08:40Z

@paultsimura Looks like we have a conflict.

# Conflicts: # src/pages/home/report/ReportActionsView.js

paultsimura · 2023-11-07T18:23:19Z

@getusha thanks, resolved. Also made a tiny change in the last commit.

aldo-expensify · 2023-11-07T19:04:10Z

Why did we change from using the hook useNetwork to passing the network as a prop here: 7727150

Are you sure that this won't cause issues? Are we going to need to retest this?

paultsimura · 2023-11-07T19:19:47Z

@aldo-expensify the network prop has already been there (passed through withNetwork()) and was used in one place in this component:

App/src/pages/home/report/ReportActionsView.js

Line 124 in d75501f

    
           const wasNetworkChangeDetected = lodashGet(prevNetwork, 'isOffline') && !lodashGet(props.network, 'isOffline');

I just noticed it when merging the latest main, so decided to not mix withNetwork and useNetwork in one component as they are interchangeable. Also, I did a retest, and it works as expected.

aldo-expensify · 2023-11-07T19:31:25Z

I see now, thanks for explaining!

OSBotify · 2023-11-07T19:36:42Z

✋ 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 · 2023-11-08T08:30:12Z

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

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

OSBotify · 2023-11-09T22:45:49Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T16:01:51Z

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

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

OSBotify · 2023-11-14T21:55:18Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

s77rt · 2023-12-05T20:37:38Z

src/pages/home/report/ReportActionsView.js

-        // Only fetch more if we are not already fetching so that we don't initiate duplicate requests.
-        if (props.isLoadingOlderReportActions) {
+        // Only fetch more if we are neither already fetching (so that we don't initiate duplicate requests) nor offline.
+        if (props.network.isOffline || props.isLoadingOlderReportActions) {


This caused a regression #31367. Previously even if we were offline Report.getOlderActions would be still called and sets isLoadingOlderReportActions to true which in turns show the skeleton view. Now with this early return we prevented the skeleton view from showing up in this case.

paultsimura added 2 commits October 27, 2023 21:38

Prevent fetching older actions when offline

7fad6ac

Merge branch 'main' into fix/30503-report-skeleton

6c9b3b5

# Conflicts: # src/pages/home/report/ReportActionsView.js

paultsimura requested a review from a team as a code owner October 31, 2023 20:36

melvin-bot bot requested review from getusha and removed request for a team October 31, 2023 20:36

paultsimura mentioned this pull request Oct 31, 2023

[HOLD for payment 2023-12-12] [hold for payment 2023-11-16] [$500] Chat - Skeleton placeholder flickers when opening chat with IOU in offline mode #30503

Closed

6 tasks

aldo-expensify requested changes Oct 31, 2023

View reviewed changes

paultsimura added 3 commits November 1, 2023 14:41

Show skeleton on first render when offline

5dd8afb

Revert forced offline olderReportActions skeleton UI

0799c4f

Add missing dependencies

58b9957

paultsimura requested a review from aldo-expensify November 1, 2023 13:07

Merge branch 'main' into fix/30503-report-skeleton

fc3095c

getusha approved these changes Nov 7, 2023

View reviewed changes

Merge branch 'main' into fix/30503-report-skeleton

bbf2217

# Conflicts: # src/pages/home/report/ReportActionsView.js

Use props.network instead of useNetwork

7727150

aldo-expensify approved these changes Nov 7, 2023

View reviewed changes

aldo-expensify self-requested a review November 7, 2023 19:04

aldo-expensify approved these changes Nov 7, 2023

View reviewed changes

aldo-expensify merged commit 4dc53c7 into Expensify:main Nov 7, 2023

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

s77rt mentioned this pull request Nov 15, 2023

[HOLD for payment 2023-12-12] [$500] Chat - No skeleton loading when scrolling up the chat history offline until the chat is reopened #31367

Closed

6 tasks

s77rt reviewed Dec 5, 2023

View reviewed changes

Conversation

paultsimura commented Oct 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 31, 2023

Uh oh!

paultsimura commented Oct 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

getusha commented Oct 31, 2023

Uh oh!

aldo-expensify Oct 31, 2023

Choose a reason for hiding this comment

Uh oh!

paultsimura commented Nov 1, 2023

Uh oh!

paultsimura commented Nov 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

getusha commented Nov 3, 2023

Uh oh!

paultsimura commented Nov 3, 2023

Uh oh!

getusha commented Nov 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

getusha commented Nov 3, 2023

Uh oh!

paultsimura commented Nov 3, 2023

Uh oh!

getusha commented Nov 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

paultsimura commented Nov 4, 2023

Uh oh!

paultsimura commented Nov 4, 2023

Uh oh!

getusha commented Nov 4, 2023

Uh oh!

paultsimura commented Nov 4, 2023

Uh oh!

getusha left a comment

Choose a reason for hiding this comment

Uh oh!

getusha commented Nov 7, 2023

Uh oh!

paultsimura commented Nov 7, 2023

Uh oh!

aldo-expensify commented Nov 7, 2023

Uh oh!

paultsimura commented Nov 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aldo-expensify commented Nov 7, 2023

Uh oh!

OSBotify commented Nov 7, 2023

Uh oh!

OSBotify commented Nov 8, 2023

Uh oh!

OSBotify commented Nov 9, 2023

Uh oh!

OSBotify commented Nov 10, 2023

Uh oh!

OSBotify commented Nov 14, 2023

Uh oh!

s77rt Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

paultsimura commented Oct 31, 2023 •

edited

Loading

paultsimura commented Oct 31, 2023 •

edited

Loading

paultsimura commented Nov 1, 2023 •

edited

Loading

getusha commented Nov 3, 2023 •

edited

Loading

getusha commented Nov 4, 2023 •

edited

Loading

paultsimura commented Nov 7, 2023 •

edited

Loading