fix skeleton loading forever on options list when offline #18788

aimane-chnaif · 2023-05-11T18:32:19Z

Details

show skeleton when personal details are not ready or
old logic: while loading reports data
new logic: only when reports data doesn't exist, no matter loading or not

Fixed Issues

$ #18781
PROPOSAL: Coming from https://expensify.slack.com/archives/C049HHMV9SM/p1683821308209489?thread_ts=1683794916.311659&cid=C049HHMV9SM

Tests

Login any account
Open one of Search/New chat/New group pages
Observe you can see possible contacts
Go offline > online > quickly offline
Verify that you can still see possible contacts instead of skeleton

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 / 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
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-05-11.at.7.31.14.PM.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-05-11T18:32:24Z

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

aimane-chnaif · 2023-05-11T18:33:03Z

cc: @amyevans for review

github-actions · 2023-05-11T18:34:52Z

⚠️ ⚠️ Heads up! This pull request has the CP Staging label ⚠️ ⚠️
If you applied the CP Staging label before the PR was merged, the PR will be be immediately deployed to staging even if the open StagingDeployCash deploy checklist is locked.
However if you applied the CP Staging after the PR was merged it's possible it won't be CP'ed automatically. If you need it to be CP'ed to staging, tag a member of @Expensify/mobile-deployers to CP it manually, otherwise you can wait for it to go out with the next deploy.

PauloGasparSv · 2023-05-11T18:41:14Z

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.

Screenshots/Videos

Web

Screen.Recording.2023-05-11.at.17.51.30.mov

Mobile Web - Chrome

Screen.Recording.2023-05-11.at.17.54.41.mov

Mobile Web - Safari

N/A can't test offline behavior correctly in the dev Simulator

Desktop

Screen.Recording.2023-05-11.at.17.58.56.mov

iOS

N/A can't test offline behavior correctly in the dev Simulator

Android

Screen.Recording.2023-05-11.at.18.00.01.mov

PauloGasparSv · 2023-05-11T18:43:10Z

@aimane-chnaif can you add the screenshots for all platforms?

aimane-chnaif · 2023-05-11T18:43:45Z

@aimane-chnaif can you add the screenshots for all platforms?

doing them right now

aimane-chnaif · 2023-05-11T20:30:33Z

@PauloGasparSv @amyevans ready for review 🚀

parasharrajat · 2023-05-11T20:34:53Z

Do you need the C+ review here?

PauloGasparSv · 2023-05-11T20:36:36Z

Do you need the C+ review here?

Please do if that's possible @rushatgabhane!

parasharrajat · 2023-05-11T20:39:55Z

Its me @parasharrajat Why everyone is tagging Rushat instead of me? 🤔

PauloGasparSv · 2023-05-11T20:42:43Z

Its me @parasharrajat Why everyone is tagging Rushat instead of me? 🤔

So sorry for that @parasharrajat 🤦
(And @rushatgabhane too for the pings)

PauloGasparSv

LGTM, all yours @parasharrajat

src/libs/ReportUtils.js

parasharrajat · 2023-05-12T09:52:42Z

I couldn't pick it up yesterday as it was very late for me. Checking it now.

parasharrajat · 2023-05-12T10:02:07Z

@aimane-chnaif can you please explain to me what has been done over this PR and what are we trying to change here?

aimane-chnaif · 2023-05-12T13:43:44Z

@aimane-chnaif can you please explain to me what has been done over this PR and what are we trying to change here?

Full discussion is in https://expensify.slack.com/archives/C049HHMV9SM/p1683821308209489?thread_ts=1683794916.311659&cid=C049HHMV9SM

Before this PR:
We showed skeleton

when personal details are not fetched (as soon as login) - empty or has data without login key
or while loading reports data (OpenApp or ReconnectApp)

This PR updates logic:
We will show skeleton

when personal details are not fetched - empty or no data with login key (because of some bad contacts without login key recently coming from backend - https://expensify.slack.com/archives/C049HHMV9SM/p1683816514449429)
or when any report with reportID key exists

login key check is needed to fix crash, the root cause is well explained in proposals in that issue
reportID check is needed because there might be draft reports (not actual reports)

…o issue-18781

PauloGasparSv · 2023-05-12T15:03:29Z

Still LGTM

Bump @parasharrajat @amyevans I think we should get 1+ review and tests on this before merging : )

hayata-suenaga · 2023-05-14T00:20:35Z

reviewing now

hayata-suenaga · 2023-05-14T00:28:40Z

I couldn't repro the original issue on staging web but still reviewing this PR now anyway

hayata-suenaga

Memo:

This PR uses ReportUtils::isReportDataReady instead of isLoadingReportData from the Onyx data so that data can be displayed when the data cannot be fetched under the offline condition.

Review:

All search pages display search results updated correctly. LGTM!

I haven't tested the changes on my local machine yet. Once I'm done with it, I'll merge the PR

PauloGasparSv · 2023-05-14T00:52:27Z

Thks @hayata-suenaga!!!

hayata-suenaga · 2023-05-14T01:06:30Z

tested well! 🚀

Screen.Recording.2023-05-13.at.6.03.10.PM.mov

fix skeleton loading forever on options list when offline (cherry picked from commit 365f43c)

…-18788 🍒 Cherry pick PR #18788 to staging 🍒

OSBotify · 2023-05-14T14:36:50Z

🚀 Cherry-picked to staging by https://github.com/hayata-suenaga in version: 1.3.13-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

mountiny · 2023-05-14T14:49:18Z

ios was deployed also in the 13-5 version so I cancelled the workflow which was stuck

OSBotify · 2023-05-15T08:23:24Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.13-5 🚀

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

OSBotify · 2023-06-15T01:30:27Z

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-06-16T18:48:16Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

fix skeleton loading forever on options list when offline

2e3d808

aimane-chnaif requested a review from a team as a code owner May 11, 2023 18:32

melvin-bot bot requested review from parasharrajat and PauloGasparSv and removed request for a team May 11, 2023 18:32

PauloGasparSv assigned aimane-chnaif May 11, 2023

PauloGasparSv added the CP Staging label May 11, 2023

amyevans self-requested a review May 11, 2023 18:41

amyevans previously approved these changes May 11, 2023

View reviewed changes

handle bad data of personal details where login doesn't exist

158f31e

aimane-chnaif dismissed amyevans’s stale review via 158f31e May 11, 2023 20:22

PauloGasparSv previously approved these changes May 11, 2023

View reviewed changes

Beamanator reviewed May 12, 2023

View reviewed changes

src/libs/ReportUtils.js Outdated Show resolved Hide resolved

Merge branch 'main' of https://github.com/aimane-chnaif/Expensify int…

2e21e3d

…o issue-18781

aimane-chnaif dismissed PauloGasparSv’s stale review via 2e21e3d May 12, 2023 13:47

Beamanator mentioned this pull request May 12, 2023

Deploy Checklist: New Expensify 2023-05-11 #18764

Closed

51 tasks

PauloGasparSv approved these changes May 12, 2023

View reviewed changes

PauloGasparSv mentioned this pull request May 13, 2023

[HOLD for payment 2023-05-23] [HOLD for payment 2023-05-22] Request Money - Account list for New Chat or Request money is not displayed while offline #18781

Closed

6 tasks

hayata-suenaga self-requested a review May 14, 2023 00:20

hayata-suenaga approved these changes May 14, 2023

View reviewed changes

hayata-suenaga merged commit 365f43c into Expensify:main May 14, 2023

OSBotify pushed a commit that referenced this pull request May 14, 2023

Merge pull request #18788 from aimane-chnaif/issue-18781

4b15a28

fix skeleton loading forever on options list when offline (cherry picked from commit 365f43c)

OSBotify mentioned this pull request May 14, 2023

🍒 Cherry pick PR #18788 to staging 🍒 #18901

Merged

mountiny added a commit that referenced this pull request May 14, 2023

Merge pull request #18901 from Expensify/OSBotify-cherry-pick-staging…

cfd4858

…-18788 🍒 Cherry pick PR #18788 to staging 🍒

OSBotify mentioned this pull request May 15, 2023

Deploy Checklist: New Expensify 2023-05-15 #18938

Closed

67 tasks

OSBotify mentioned this pull request Jun 15, 2023

Deploy Checklist: New Expensify 2023-06-14 #20782

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix skeleton loading forever on options list when offline #18788

fix skeleton loading forever on options list when offline #18788

aimane-chnaif commented May 11, 2023 •

edited

Loading

melvin-bot bot commented May 11, 2023

aimane-chnaif commented May 11, 2023

github-actions bot commented May 11, 2023

PauloGasparSv commented May 11, 2023 •

edited

Loading

PauloGasparSv commented May 11, 2023

aimane-chnaif commented May 11, 2023

aimane-chnaif commented May 11, 2023

parasharrajat commented May 11, 2023

PauloGasparSv commented May 11, 2023

parasharrajat commented May 11, 2023 •

edited

Loading

PauloGasparSv commented May 11, 2023 •

edited

Loading

PauloGasparSv left a comment

parasharrajat commented May 12, 2023

parasharrajat commented May 12, 2023

aimane-chnaif commented May 12, 2023

PauloGasparSv commented May 12, 2023

hayata-suenaga commented May 14, 2023

hayata-suenaga commented May 14, 2023

hayata-suenaga left a comment •

edited

Loading

PauloGasparSv commented May 14, 2023

hayata-suenaga commented May 14, 2023

OSBotify commented May 14, 2023

mountiny commented May 14, 2023

OSBotify commented May 15, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

fix skeleton loading forever on options list when offline #18788

fix skeleton loading forever on options list when offline #18788

Conversation

aimane-chnaif commented May 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 11, 2023

aimane-chnaif commented May 11, 2023

github-actions bot commented May 11, 2023

PauloGasparSv commented May 11, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

PauloGasparSv commented May 11, 2023

aimane-chnaif commented May 11, 2023

aimane-chnaif commented May 11, 2023

parasharrajat commented May 11, 2023

PauloGasparSv commented May 11, 2023

parasharrajat commented May 11, 2023 • edited Loading

PauloGasparSv commented May 11, 2023 • edited Loading

PauloGasparSv left a comment

Choose a reason for hiding this comment

parasharrajat commented May 12, 2023

parasharrajat commented May 12, 2023

aimane-chnaif commented May 12, 2023

PauloGasparSv commented May 12, 2023

hayata-suenaga commented May 14, 2023

hayata-suenaga commented May 14, 2023

hayata-suenaga left a comment • edited Loading

Choose a reason for hiding this comment

PauloGasparSv commented May 14, 2023

hayata-suenaga commented May 14, 2023

OSBotify commented May 14, 2023

mountiny commented May 14, 2023

OSBotify commented May 15, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

aimane-chnaif commented May 11, 2023 •

edited

Loading

PauloGasparSv commented May 11, 2023 •

edited

Loading

parasharrajat commented May 11, 2023 •

edited

Loading

PauloGasparSv commented May 11, 2023 •

edited

Loading

hayata-suenaga left a comment •

edited

Loading