Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add skeleton to loading Accounting options #41980

Merged

Conversation

narefyev91
Copy link
Contributor

Details

If the data is not ready, we should see a skeleton loader on the Connections card in the Accounting page, not "Hmm... it's not here" page

Fixed Issues

$ #41250
PROPOSAL:

Tests

  1. Create Workspace
  2. Go to "More Settings"
  3. Make your connection extra slow using the dev tools
  4. Enable "Accounting" for the first time
  5. Quickly navigate to the new "Accounting" menu that appeared (before the request EnablePolicyConnections is resolved)
  6. Verify that no "Hmm it's not here" page is shown
  7. Verify that skeleton loader is shown
  • Verify that no errors appear in the JS console

Offline tests

  1. Create Workspace
  2. Go to "More Settings"
  3. Make your connection extra slow using the dev tools
  4. Enable "Accounting" for the first time
  5. Quickly navigate to the new "Accounting" menu that appeared (before the request EnablePolicyConnections is resolved)
  6. Verify that no "Hmm it's not here" page is shown
  7. Verify that skeleton loader is shown

QA Steps

  1. Create Workspace
  2. Go to "More Settings"
  3. Make your connection extra slow using the dev tools
  4. Enable "Accounting" for the first time
  5. Quickly navigate to the new "Accounting" menu that appeared (before the request EnablePolicyConnections is resolved)
  6. Verify that no "Hmm it's not here" page is shown
  7. Verify that skeleton loader is shown
  • 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
android.mov
Android: mWeb Chrome
android-web.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios-web.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@narefyev91 narefyev91 requested review from a team as code owners May 10, 2024 12:49
@melvin-bot melvin-bot bot removed the request for review from a team May 10, 2024 12:49
Copy link

melvin-bot bot commented May 10, 2024

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

@melvin-bot melvin-bot bot requested a review from eVoloshchak May 10, 2024 12:49
@narefyev91
Copy link
Contributor Author

cc @s77rt

@shawnborton
Copy link
Contributor

Almost there - but the fake avatar circles should be left-aligned with the content above, the same way that the accounting rows are:
CleanShot 2024-05-10 at 09 37 58@2x

CleanShot 2024-05-10 at 09 38 28@2x

Can you check that the skeleton also has the exact same height and spacing as the real rows? Ideally there should be no "jump" from loading to real content. Thanks!

@s77rt
Copy link
Contributor

s77rt commented May 13, 2024

This is not fixing the root cause and we don't need a skeleton loader here. The enable accounting switch works offline and we should be able to view the accounting page immediately.

@narefyev91
Copy link
Contributor Author

This is not fixing the root cause and we don't need a skeleton loader here. The enable accounting switch works offline and we should be able to view the accounting page immediately.

@s77rt Issue with "Hmmm page is not here" - was already fixed before. Current PR is for removing loader - when accounting resources and fetching. When you do it offline - you will see 2 hardcoded values like Quickbooks and Xero - but it can be more coming from API request - that's why we should show skeleton instead of loader for the whole page.

@narefyev91
Copy link
Contributor Author

@shawnborton are we good with such skeleton? Same height for each item and same positions for all elements:

Screen.Recording.2024-05-13.at.14.45.43.mov

@shawnborton
Copy link
Contributor

That looks pretty good to me. Do we have control over how wide these lines are?
CleanShot 2024-05-13 at 08 30 11@2x

If so, I think it might be nicer to make them match something more like the width of the top line here: +
CleanShot 2024-05-13 at 08 31 02@2x

@narefyev91
Copy link
Contributor Author

That looks pretty good to me. Do we have control over how wide these lines are? CleanShot 2024-05-13 at 08 30 11@2x

If so, I think it might be nicer to make them match something more like the width of the top line here: + CleanShot 2024-05-13 at 08 31 02@2x

sure thing! let me add that

@narefyev91
Copy link
Contributor Author

narefyev91 commented May 13, 2024

@shawnborton good? or make it a bit more bigger? currently it's 20% - let me know which percent i should add

Screen.Recording.2024-05-13.at.15.39.51.mov

@shawnborton
Copy link
Contributor

That looks good to me. I can see where it might be nice to have one of those be slightly wider than the other, to create some variance, but I can totally get down with what you have. cc @Expensify/design for viz.

@dannymcclain
Copy link
Contributor

I don't mind the skeleton lines being the same width I don't think, but I kinda want them to be a litttttttle bit wider, maybe like 40% instead of 20? Honestly not a huge deal. It's looking pretty good as is.

@narefyev91
Copy link
Contributor Author

I don't mind the skeleton lines being the same width I don't think, but I kinda want them to be a litttttttle bit wider, maybe like 40% instead of 20? Honestly not a huge deal. It's looking pretty good as is.

Done deal! Added 40%
Screenshot 2024-05-13 at 16 41 45

@shawnborton
Copy link
Contributor

Cool, that works for me!

@narefyev91 narefyev91 requested a review from s77rt May 13, 2024 15:16
src/pages/workspace/withPolicyConnections.tsx Outdated Show resolved Hide resolved
src/pages/workspace/withPolicyConnections.tsx Outdated Show resolved Hide resolved
src/pages/workspace/withPolicyConnections.tsx Show resolved Hide resolved
src/pages/workspace/withPolicyConnections.tsx Outdated Show resolved Hide resolved
# Conflicts:
#	src/pages/workspace/accounting/PolicyAccountingPage.tsx
@narefyev91 narefyev91 requested a review from s77rt May 14, 2024 11:37
@narefyev91 narefyev91 requested a review from s77rt May 14, 2024 13:53
@narefyev91 narefyev91 requested a review from s77rt May 14, 2024 14:43

if (props.policy?.areConnectionsEnabled && (!props.policy || status === 'loading' || hasConnectionsDataBeenFetched === false)) {
if (props.policy?.areConnectionsEnabled && status === 'loading') {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still trying to see in which cases we will end up using the loader. The status initially will be loaded because initWithStoredValues is false

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems like that we do not have any choice to show skeleton instead of loader. Just if we put back hasConnectionsDataBeenFetched === false - page with Accounting will not be loaded

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably we can close this one @s77rt and close related GH issue as well

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is that on other pages we are not using any loader indicator

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can add a second parameter to withPolicyConnections to decide if we want to use the full screen loader

function withPolicyConnections<TProps extends WithPolicyConnectionsProps>(WrappedComponent: ComponentType<TProps>, shouldBlockView = true) {

Use that parameter with the rendering condition and in PolicyAccountingPage pass that parameter as false

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that works! @s77rt

src/pages/workspace/withPolicyConnections.tsx Outdated Show resolved Hide resolved
src/pages/workspace/withPolicyConnections.tsx Outdated Show resolved Hide resolved
src/pages/workspace/withPolicyConnections.tsx Outdated Show resolved Hide resolved
narefyev91 and others added 4 commits May 14, 2024 18:11
Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>
Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>
Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>
@@ -41,7 +41,7 @@ function withPolicyConnections<TProps extends WithPolicyConnectionsProps>(Wrappe
openPolicyAccountingPage(props.policy.id);
}, [props.policy?.id, isConnectionDataFetchNeeded]);

if (props.policy?.areConnectionsEnabled && status === 'loading') {
if (props.policy?.areConnectionsEnabled && status === 'loading' && shouldBlockView) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the status, I think it does not do match, instead use isConnectionDataFetchNeeded


if (props.policy?.areConnectionsEnabled && (!props.policy || status === 'loading' || hasConnectionsDataBeenFetched === false)) {
if (props.policy?.areConnectionsEnabled && isConnectionDataFetchNeeded && shouldBlockView) {
return (
<FullPageOfflineBlockingView>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove <FullPageOfflineBlockingView /> The accounting pages are accessible offline. Also since we are using isConnectionDataFetchNeeded we will render this only when online afterall. However we need to disable the Set up buttons on the connections (QBO and Xero) since the setup requires connection

Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>
Co-authored-by: Abdelhafidh Belalia <16493223+s77rt@users.noreply.github.com>
@s77rt
Copy link
Contributor

s77rt commented May 14, 2024

Code looks good to me. Testing...

@s77rt
Copy link
Contributor

s77rt commented May 14, 2024

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.mov
Android: mWeb Chrome

Networking issue

iOS: Native
ios.mov
iOS: mWeb Safari
mweb-safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

Copy link

melvin-bot bot commented May 14, 2024

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

@s77rt
Copy link
Contributor

s77rt commented May 14, 2024

@narefyev91 Thank you!

@melvin-bot melvin-bot bot requested a review from youssef-lr May 14, 2024 16:52
Copy link
Contributor

@youssef-lr youssef-lr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@youssef-lr youssef-lr merged commit b928739 into Expensify:main May 15, 2024
17 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@narefyev91
Copy link
Contributor Author

@narefyev91 Thank you!

Thank you too! As usual nice to work with you!

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.4.74-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants