Feat: Improve isLoading to prevent loading for undefined

[waterim]

Details

Fixed Issues

$ #51333
PROPOSAL: N/A

Tests

1. Open any workspace
2. Enable Company Cards
3. Navigate to Company Cards and see that no loading spinner is there

• Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

None

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

Screen.Recording.2024-10-23.at.21.15.36.mov

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

[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 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.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(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.
• 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.2024-11-11.at.6.07.56.in.the.morning.mov

Android: mWeb Chrome

Screen.Recording.2024-11-11.at.5.43.52.at.night.mov

iOS: Native

Screen.Recording.2024-11-11.at.6.11.22.in.the.morning.mov

iOS: mWeb Safari

Screen.Recording.2024-11-11.at.5.52.55.at.night.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-25.at.7.17.58.in.the.evening.mov

MacOS: Desktop

Screen.Recording.2024-11-11.at.6.18.04.in.the.morning.mov

[getusha]

There is loading indicator when opening the page on a fresh sign in, is this expected? @waterim @joekaufmanexpensify?

Screen.Recording.2024-10-25.at.7.22.21.in.the.evening.mov

[joekaufmanexpensify]

There is loading indicator when opening the page on a fresh sign in, is this expected?

On the Expensify Card page you mean?

[getusha]

Yes

…

On Fri, 25 Oct 2024 at 7:35 PM Joseph Kaufman ***@***.***> wrote: There is loading indicator when opening the page on a fresh sign in, is this expected? On the Expensify Card page you mean? — Reply to this email directly, view it on GitHub <#51360 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AR4OEVYBYMGIVLELQODWBOLZ5JXMHAVCNFSM6AAAAABQPQHBT6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMZYGI4DAMZQGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[joekaufmanexpensify]

@waterim could we easily clean that up here too?

[waterim]

@joekaufmanexpensify Sorry, missed this comment, sure, will update today

[joekaufmanexpensify]

All good. And sounds great. TY!

[waterim]

@joekaufmanexpensify Issue is a bit weird as this loading is an issue with some onyx update, On an initial loading all useOnyx hooks are returning an undefined for a moment and a correct data after meanwhile in companyCards everything works correctly and data is coming from onyx as it should be

[joekaufmanexpensify]

Got it. Is it easy to fix that?

[waterim]

@joekaufmanexpensify Cant understand why its happening, we dont have any resets, but it still shows undefined for some reason, still researching

[waterim]

@joekaufmanexpensify
Okay, finally I was able to understand why its happening, sorry for taking more time, I was thinking totally in a different way
This loading is happening on the Expensify because useOnyx is not delaying rendering of the component, same as in company cards, but for companyCards we are getting cardFeeds in "WorkspaceInitialPage" initializing data for this key which we are using in companyCards for updating brickRoadIndicator

But for expensifyCards both cardSettings and cardList are not initialized in other places and thats why for the initial render it shows loading inidicator for a moment while it getting data from onyx store as useOnyx has 'isLoading' inidicator during that time.

Im not sure do we need to fix it to be honest, as its an expected behaviour from useOnyx, but 2 solutions exists:

1. replace useOnyx with withOnyx, as withOnyx waits for data to be loaded, but its deprecated
2. to use cardSettings and cardList in WorkspaceInitialPage for brickRoadIndicator, but we didnt have it earlier and I don't know do we need it or not

Let me know your thoughts on this please

[joekaufmanexpensify]

Is one of those solutions viable? The loading indicator does look kind of odd. If we can fix this without much effort, that would be solid IMO.

[waterim]

@joekaufmanexpensify it will be hacky or with using a deprecated withOnyx, only these 2 solutions I can see here
But I can add a brickRoadIndicator as we don't have and for this will use both those onyx keys, if its fine I will go with this one

[waterim]

@joekaufmanexpensify @getusha Updated

[joekaufmanexpensify]

But I can add a brickRoadIndicator as we don't have and for this will use both those onyx keys, if its fine I will go with this one

Mind clarifying a bit more about what this solution means? I'm not sure I understand

[waterim]

@joekaufmanexpensify loading happens because data we use from useOnyx is not persisted and it means we need to wait for an initial data fetching from the store, but if we use useOnyx for the same keys somewhere else in the app (parent views)
In this solution WorkspaceInitialPage we will not have a loading indicator as data was already fetched from the store and we have it i cache
CompanyCards are using cardFeeds and the reason why it doesnt have loading is because cardFeeds were used in WorkspaceInitialPage to get the errors for brickRoadIndicator

For ExpensifyCards we didnt brickRoadIndicator and I added verifications for errors in WorkspaceInitialPage as we have for other screens (it means both cardList and cardSettings which we are using for Expensify page will be fetched before and with using once again same onyx keys we will not have "undefined" for an initial load)

[melvin-bot]

We did not find an internal engineer to review this PR, trying to assign a random engineer to #51333 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

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

[github-actions]

🚀 Deployed to staging by https://github.com/rlinoz in version: 9.0.60-0 🚀

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

[VickyStash]

@waterim @getusha It looks like the companyCards will never be a falsy value, so I'm not sure if this check is correct. Could you double-check?

[waterim]

We want only initial loading for a smooth work

[VickyStash]

But it looks like !companyCards will never be true

[mountiny]

I think you are right, lets try to fix this in a next PR

[github-actions]

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.60-3 🚀

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