Add skeleton to loading Accounting options #41980

narefyev91 · 2024-05-10T12:49:20Z

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

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

Verify that no errors appear in the JS console

Offline tests

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

QA Steps

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

Verify that no errors appear in the JS console

PR Author Checklist

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

melvin-bot · 2024-05-10T12:49:25Z

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

narefyev91 · 2024-05-10T12:49:42Z

cc @s77rt

shawnborton · 2024-05-10T13:38:56Z

Almost there - but the fake avatar circles should be left-aligned with the content above, the same way that the accounting rows are:

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 · 2024-05-13T08:54:59Z

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 · 2024-05-13T09:00:46Z

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 · 2024-05-13T11:47:28Z

@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 · 2024-05-13T12:31:17Z

That looks pretty good to me. Do we have control over how wide these lines are?

If so, I think it might be nicer to make them match something more like the width of the top line here: +

narefyev91 · 2024-05-13T12:39:11Z

That looks pretty good to me. Do we have control over how wide these lines are?

If so, I think it might be nicer to make them match something more like the width of the top line here: +

sure thing! let me add that

narefyev91 · 2024-05-13T12:40:19Z

@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 · 2024-05-13T12:54:15Z

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.

src/pages/workspace/accounting/PolicyAccountingPage.tsx

dannymcclain · 2024-05-13T13:38:39Z

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 · 2024-05-13T13:42:09Z

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%

shawnborton · 2024-05-13T14:00:33Z

Cool, that works for me!

src/pages/workspace/withPolicyConnections.tsx

# Conflicts: # src/pages/workspace/accounting/PolicyAccountingPage.tsx

src/pages/workspace/withPolicyConnections.tsx

s77rt · 2024-05-14T14:45:24Z

src/pages/workspace/withPolicyConnections.tsx


-        if (props.policy?.areConnectionsEnabled && (!props.policy || status === 'loading' || hasConnectionsDataBeenFetched === false)) {
+        if (props.policy?.areConnectionsEnabled && status === 'loading') {


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

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

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

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

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

Yeah that works! @s77rt

src/pages/workspace/withPolicyConnections.tsx

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

s77rt · 2024-05-14T15:56:21Z

src/pages/workspace/withPolicyConnections.tsx

@@ -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) {


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

s77rt · 2024-05-14T16:04:40Z

src/pages/workspace/withPolicyConnections.tsx


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


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

src/pages/workspace/withPolicyConnections.tsx

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

src/pages/workspace/withPolicyConnections.tsx

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

s77rt · 2024-05-14T16:42:41Z

Code looks good to me. Testing...

s77rt · 2024-05-14T16:51:15Z

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

melvin-bot · 2024-05-14T16:51:36Z

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 · 2024-05-14T16:51:56Z

@narefyev91 Thank you!

youssef-lr

LGTM!

OSBotify · 2024-05-15T01:57:16Z

✋ 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 · 2024-05-15T06:40:58Z

@narefyev91 Thank you!

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

OSBotify · 2024-05-15T10:15:41Z

🚀 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 · 2024-05-23T00:00:42Z

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

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

Add skeleton to loading Accounting options

e302bcd

narefyev91 requested review from a team as code owners May 10, 2024 12:49

melvin-bot bot removed the request for review from a team May 10, 2024 12:49

melvin-bot bot requested a review from eVoloshchak May 10, 2024 12:49

updates after design review + add logic to support offline

9f07b73

s77rt suggested changes May 13, 2024

View reviewed changes

src/pages/workspace/accounting/PolicyAccountingPage.tsx Outdated Show resolved Hide resolved

src/pages/workspace/accounting/PolicyAccountingPage.tsx Outdated Show resolved Hide resolved

updates after c+ review

05fa9bc

add more width for lines

3b02297

narefyev91 requested a review from s77rt May 13, 2024 15:16

s77rt suggested changes May 13, 2024

View reviewed changes

narefyev91 added 2 commits May 14, 2024 13:33

updates after c+ review

d2511d6

Merge branch 'refs/heads/main' into add-skeleton-for-loading-accounting

18dffb0

# Conflicts: # src/pages/workspace/accounting/PolicyAccountingPage.tsx

narefyev91 requested a review from s77rt May 14, 2024 11:37

s77rt reviewed May 14, 2024

View reviewed changes

src/pages/workspace/withPolicyConnections.tsx Outdated Show resolved Hide resolved

src/pages/workspace/withPolicyConnections.tsx Show resolved Hide resolved

narefyev91 requested a review from s77rt May 14, 2024 13:53

updates after c+ review

6725691

updates after c+ review

9a5e596

narefyev91 requested a review from s77rt May 14, 2024 14:43

s77rt reviewed May 14, 2024

View reviewed changes

s77rt suggested changes May 14, 2024

View reviewed changes

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

Update src/pages/workspace/withPolicyConnections.tsx

0101ec0

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

Update src/pages/workspace/withPolicyConnections.tsx

0a5d79e

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

Update src/pages/workspace/withPolicyConnections.tsx

7f3f860

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

updates after c+ review

695c947

s77rt reviewed May 14, 2024

View reviewed changes

updates after c+ review

8392a21

s77rt reviewed May 14, 2024

View reviewed changes

updates after c+ review

83f966b

s77rt reviewed May 14, 2024

View reviewed changes

src/pages/workspace/withPolicyConnections.tsx Outdated Show resolved Hide resolved

Update src/pages/workspace/withPolicyConnections.tsx

9e84439

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

s77rt reviewed May 14, 2024

View reviewed changes

src/pages/workspace/withPolicyConnections.tsx Outdated Show resolved Hide resolved

Update src/pages/workspace/withPolicyConnections.tsx

b6dbb99

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

s77rt approved these changes May 14, 2024

View reviewed changes

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

youssef-lr approved these changes May 15, 2024

View reviewed changes

youssef-lr merged commit b928739 into Expensify:main May 15, 2024
17 checks passed

github-actions bot mentioned this pull request May 15, 2024

Deploy Checklist: New Expensify 2024-05-15 #42185

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add skeleton to loading Accounting options #41980

Add skeleton to loading Accounting options #41980

narefyev91 commented May 10, 2024

melvin-bot bot commented May 10, 2024

narefyev91 commented May 10, 2024

shawnborton commented May 10, 2024

s77rt commented May 13, 2024

narefyev91 commented May 13, 2024

narefyev91 commented May 13, 2024

shawnborton commented May 13, 2024

narefyev91 commented May 13, 2024

narefyev91 commented May 13, 2024 •

edited

Loading

shawnborton commented May 13, 2024

dannymcclain commented May 13, 2024

narefyev91 commented May 13, 2024

shawnborton commented May 13, 2024

s77rt May 14, 2024

narefyev91 May 14, 2024

narefyev91 May 14, 2024

s77rt May 14, 2024

s77rt May 14, 2024

narefyev91 May 14, 2024

s77rt May 14, 2024

s77rt May 14, 2024

s77rt commented May 14, 2024

s77rt commented May 14, 2024

melvin-bot bot commented May 14, 2024

s77rt commented May 14, 2024

youssef-lr left a comment

OSBotify commented May 15, 2024

narefyev91 commented May 15, 2024

OSBotify commented May 15, 2024

OSBotify commented May 23, 2024


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

Add skeleton to loading Accounting options #41980

Add skeleton to loading Accounting options #41980

Conversation

narefyev91 commented May 10, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 10, 2024

narefyev91 commented May 10, 2024

shawnborton commented May 10, 2024

s77rt commented May 13, 2024

narefyev91 commented May 13, 2024

narefyev91 commented May 13, 2024

shawnborton commented May 13, 2024

narefyev91 commented May 13, 2024

narefyev91 commented May 13, 2024 • edited Loading

shawnborton commented May 13, 2024

dannymcclain commented May 13, 2024

narefyev91 commented May 13, 2024

shawnborton commented May 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s77rt commented May 14, 2024

s77rt commented May 14, 2024

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented May 14, 2024

s77rt commented May 14, 2024

youssef-lr left a comment

Choose a reason for hiding this comment

OSBotify commented May 15, 2024

narefyev91 commented May 15, 2024

OSBotify commented May 15, 2024

OSBotify commented May 23, 2024

narefyev91 commented May 13, 2024 •

edited

Loading