[Workspace Feeds]: Update isLoading both for expensify and company cards

[waterim]

Details

Fixed Issues

$ #52909
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

Details

Screen.Recording.2024-11-22.at.10.20.58.mov

[melvin-bot]

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

[allgandalf]

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 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-26.at.5.35.58.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-11-26.at.5.37.54.PM.mov

iOS: Native

Screen.Recording.2024-11-26.at.5.30.53.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-11-26.at.5.32.13.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-26.at.5.16.18.PM.mov

MacOS: Desktop

Screen.Recording.2024-11-26.at.5.27.53.PM.mov

[waterim]

@mountiny @allgandalf
okay, I see the point here, but the issue still the same
we are waiting for an initial loading on Expensify page because cardsList is empty and when we get it back it returns empty Object {} and after cardSettings.isLoading && !cardsList will be always false as even empty cardsList returns {}

Meanwhile in the CompanyCards we are just using cardFeeds.isLoading and this one will return true each time we are fetching data (each time we are navigating here)

[waterim]

Discussion

[mountiny]

@Expensify/design Can you please help us with how to show the loader on the company / expensify cards?

I think we have three cases:

• there is no cardSettings and cardList locally - this can mean you either:
  • do not have any on the policy, - loader - empty state
  • or we are opening the page for a first time - loader - show the card list
• you have some cardSetting and cardList locally - no loader - show the list even if fetching data again.

This way the problem is that if you do not have cards setup, we would be showing the loader everytime you go to the empty feature page. But at least the spinner will not show up when you already have some cards assigned.

That feels like the best outcome in my opinion

[allgandalf]

@waterim @mountiny , 2 issues i think we need to discuss:

1. On Initial login, we really would not know whether there is a feed added or there is a empty state, in this case there should be a loading indicator, which is why we introduced the PR:

• [Internal QA]: Add a loader to the cards page while waiting for cards collection and feed settings #52615

2. Observe that in company cards, when we reload, the state changes as follows:

a. loading indicator
b. Added feed with no card assigned (so empty modal)
c. Finally the state where we have card list.

I don't have any strong opinion about 2, but would love your inputs here.

Screen.Recording.2024-11-22.at.6.38.03.PM.mov

[waterim]

Hmm, im my opinion it should work in the same way is it works for expensify cards
if cardsList is empty we are showing cardSettings.isLoading state which will be true each time we are on the page
but when cardsList has some data, even an empty {} we will not show loader here

with company cards right now we are showing loading indicator each time as our expression takes only cardFeeds.isLoading, which will be true each time were are going to this page.

Solution looks like this for companyCards:

1. We can add a verification const isLoading = !isOffline && (!cardFeeds || (cardFeeds.isLoading && !cardsList));

But here an issue comes because cardsList :>> undefined when its empty, backend returning not an empty object as it works with ExpensifyCards

[shawnborton]

@mountiny what you have here makes total sense to me 👍

[allgandalf]

@waterim is the PR ready for review based on design teams feeback?

[mountiny]

@waterim I think when the feed is set up, then it should return an empty object but not if there is no feed.

@waterim is the current state based on how I described from functional perspective? if yes then the PR is ready to test @allgandalf

[waterim]

Updating to make it as you described, right now no loading will be

[waterim]

Updated behaviour @mountiny @allgandalf

Screen.Recording.2024-11-26.at.00.01.37.mov

[allgandalf]

@waterim there is a loading spinner everytime we open company cards when no feed is added, whereas on expensify cards page, we only show loading indicator for the very first time when we login, do you think this is expected ?:

Screen.Recording.2024-11-26.at.5.17.38.PM.mov

[mountiny]

I think this is expected because we have no card settings and no card list, so we cannot know if it's because there are actually no card feeds or if it's loading - and if it's actually just loading, then showing the section would be awkward.

So I think this is fine. For normal user it should not be a problem as they wont have this page just enabled without a feed and keep going there so I am fine with this

[allgandalf]

• there is no cardSettings and cardList locally:

  • do not have any on the policy, - loader - empty state
  • we are opening the page for a first time - loader - show the card list

• there is cardSettings and cardList present locally:

  • Have some cardSetting and cardList locally, even if fetching data again - no loader

  LGTM! thanks for the quick changes @waterim 🙇

[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/mountiny in version: 9.0.67-0 🚀

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

[joekaufmanexpensify]

Some questions about this one. Asked here.

[joekaufmanexpensify]

Any of the issues here should not block deploy, so checking this off.

[github-actions]

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.67-9 🚀

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

[Ollyws]

This was returning true with an empty object which was causing the assign card page to be shown briefly before the review request page, we fixed this in #56914