Prevent full screen loading on Workflows page if data is present

[ishpaul777]

Details

Fixed Issues

$ #38153
$ #38566
PROPOSAL:

Tests

• Verify that no errors appear in the JS console

Precondition:

• User is an admin of Collect workspace.

1. Open Workflows page in Newdot.
2. Go offline and then go online.
3. Verify loading indicator is not visible switching on the internet.

Test steps 2

Precondition:

• User is an admin of Collect workspace.
• The Collect workspace does not have bank acount set up.

1. Go to Profile > Workspaces > Collect workspace.
2. Go to Workflows.
3. Toggle on Make or track payments.
4. verify Workflow page will not load infinitely.

Offline tests

QA Steps

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

Screenshots/Videos

Android: Native

Cant be tested on simulator

Android: mWeb Chrome

Cant be tested on simulator

iOS: Native

Cant be tested on simulator

iOS: mWeb Safari

Cant be tested on simulator

MacOS: Chrome / Safari

Screen.Recording.2024-03-16.at.2.03.50.AM.mov

MacOS: Desktop

Screen.Recording.2024-03-16.at.2.54.44.AM.mov

[melvin-bot]

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

[jjcoffee]

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

android-app-2024-03-19_14.06.46.mp4

Android: mWeb Chrome

android-chrome-2024-03-19_13.06.16.mp4

iOS: Native

ios-app-2024-03-19_15.03.41.mp4

iOS: mWeb Safari

ios-safari-2024-03-19_14.31.14.mp4

MacOS: Chrome / Safari

desktop-chrome.mp4

MacOS: Desktop

desktop-app-2024-03-19_12.55.19.mp4

[ishpaul777]

thanks for testing i'll look into it and adress this bug.

[ishpaul777]

@jjcoffee can you check if the issue is resolved

Screen.Recording.2024-03-19.at.4.28.57.PM.mov

[ishpaul777]

This PR should also resolve #38566

[ishpaul777]

Done 👍

[jjcoffee]

@ishpaul777 Unfortunately still seeing a flash of the loader specifically when turning off the toggle whilst offline:

ios-app-off-2024-03-19_15.08.04.mp4

[mountiny]

@ishpaul777 can we prioritize getting this one over the finish line please instead of picking up new tasks. Thank you!

[ishpaul777]

@jjcoffee Can you please give me hints, how can i switch to offline and online while on same page in simulator? I cant reproduce this on chrome desktop.

https://github.com/Expensify/App/assets/104348397/91d0b56d-e34e-458e-877b-9003f1f1c6c0

i beleive loading indicator is only visible when reimbursement.isLoading && achdata === undefined can you please check adding some logs whether any of condition is true?

I reproduced this is because achdata is undefined, when toggle is off and on reconnect there is call to openPolicyWorkflowsPage. i dont know what else we can do in this case @jjcoffee any ideas?

[jjcoffee]

@ishpaul777 Is there any reasoning/context for where it was decided to add a loader for this page? I'm not 100% sure it makes sense unless we're missing data for both items (so Add approvals too), or at the very least if we're missing the reimbursementAccount altogether (rather than just achData). Any data pulled through openPolicyWorkflowsPage will just overwrite the stale data, so I'd vote for just not having a loader. cc @luacmartins in case you have thoughts.

[mountiny]

I think some loading should be in place. That is for case of deeplinking to the page when you do not have the data loaded from elsewhere.

But I think we could do a better work with that and use some kind of a skeleton for the parts which we do not have data for.

[ishpaul777]

Resolved conflicts.

[ishpaul777]

Is there any reasoning/context for where it was decided to add a loader for this page?|

This was decide here #37629 (comment) to show loader.

[ishpaul777]

Can you try to repro again i am not able to repro this

Screen.Recording.2024-03-21.at.7.09.40.PM.mov

[luacmartins]

@jjcoffee are you available to continue your review on this PR?

[jjcoffee]

@luacmartins Sure, it's on my list for today. Will retest soon to confirm whether or not this is still reproducible.

[luacmartins]

LGTM and tests well

[jjcoffee]

Same issue is still there, easy enough to spot if you just go offline and come back online (no changes need to be made):

desktop-chrome-bug-2024-03-22_16.26.10.mp4

We are optimistically setting isLoading to true every time we call OpenPolicyWorkflowsPage:

App/src/libs/actions/Policy.ts

Lines 2055 to 2057 in b9f3906

	value: {
	isLoading: true,
	},

So whenever we don't have a bank account set up, achData will be undefined, and so we'll always display the loader on every OpenPolicyWorkflowsPage call.

App/src/pages/workspace/workflows/WorkspaceWorkflowsPage.tsx

Line 264 in 6ce15be

const isLoading = reimbursementAccount?.isLoading && reimbursementAccount?.achData === undefined;

I think it might make more sense to check instead for policy?.reimbursementChoice === undefined. Then as long as we have some value for the reimbursementChoice we'll display it (even if it's stale) until it gets populated with new data, e.g. after going offline and coming back online.

In reality the only time we'll then display the loader is for this case (deeplinking to the workflows page from a fresh sign-in), as the policy data will be populated earlier anyway.

[luacmartins]

Yea, I think that makes sense, let's change the conditional and resolve conflicts! @ishpaul777

[luacmartins]

@ishpaul777 just making sure that you saw this comment:

I think it might make more sense to check instead for policy?.reimbursementChoice === undefined. Then as long as we have some value for the reimbursementChoice we'll display it (even if it's stale) until it gets populated with new data, e.g. after going offline and coming back online.

[ishpaul777]

I think it might make more sense to check instead for policy?.reimbursementChoice === undefined

hmm but we added loader for the condition when specifically achData is not fetched, and undefined for example a fresh sign in. so in case if its not fetched and internet is slow (change internet to slow 3g to repro) we dont actually show the loader but the "connect bank account" option while we actually want a loader here

Screen.Recording.2024-03-23.at.2.30.47.AM.mov

[ishpaul777]

@luacmartins yes i was trying to make sense out of it and doing some testing

[ishpaul777]

After think for a while i'd vote this #38428 (comment) is not a bug but the expected behaviour i.e we want to show to loader when we aren't sure if user has a verified BA(reimbursementAccount?.achData === undefined), example when offline to online and a call in progress reimbursementAccount?.isLoading) lmk if you think otherwise @luacmartins

[luacmartins]

Hmm I think we should show stale data if we have it locally and then update the UI. What you have in this video seems to be the correct behavior to me.

[jjcoffee]

Much more stable like this. LGTM!

[melvin-bot]

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

[luacmartins]

Tests were passing