Some components remain in loading state on error

[mitogh]

Bug Description

Given a user that is authorized to a module (Analytics), after the user is granted the appropriate permissions and the user connects both modules if the user no longer has access to the data of those modules (the user permissions were removed from Analytics or Search Console the module never terminates the loading process and remains to load when visiting the modules section.

Steps to reproduce

1. First assign a user to a property in Google Analytics.
2. Then connect your Site Kit Plugin with this assigned user,
3. Then connect the Google Analytics module
4. Observe the module working as expected.
5. Then remove this user access from the Google Analytics page so this user no longer has access to this report.
6. Then from your browser visiting the Site Kit dashboard remove all the Session Storage values by going in Settings > More Tools > Developer Tools. Click on Application > Session Storage and remove all the values from the site kit
7. Refresh the page and observe the page showing the loading indicator every time you refresh the page.

Screenshots

Analytics

Search Console

Main Dashboard

---

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• Components should render their respective error states rather than a loading state when a report request results in an error

Implementation Brief

• Update isGatheringData and hasZeroData selectors such that:
  • If the underlying getReport has not yet finished resolution, return undefined
  • If the underlying getReport has finished resolution and the report is not an array return false – an error occurred while fetching the report
• Update and/or remove instances where the result of getReport(...) is used to infer a loading state
  • If a value based on hasFinishedResolution is available, remove the comparison based on the report value
  • If a condition is only based on the report value, update it to use a value based on hasFinishedResolution instead
• Finish and merge Fix loading states when report errors #5000
  • PR only includes updates to isGatheringData so far
• Ensure Storybook cases are correct

Test Coverage

• No changes

QA Brief

• Follow the steps from the steps to reproduce.
• The widgets will no longer be stuck on loading state, they will load the error state of the widgets.

Changelog entry

• Fix infinite loading state for components relying on gathering or zero data reports.

[aaemnnosttv]

@wpdarren would you please give this a test to see if you're able to reproduce it?

[wpdarren]

@aaemnnosttv yes, I was able to reproduce this.

Rather than seeing the User does not have sufficient permissions message, the flashing loading indicator appears on the Analytics module page and the current and unified dashboard.

Screenshots

[eugene-manuilov]

IBR ✔️

[aaemnnosttv]

@eugene-manuilov I just realized the suggested changes also apply to our hasZeroData selectors which are very similar in their implementation so I've updated the IB to include these as well and bumped the estimate accordingly – does that sound okay to you?

[eugene-manuilov]

Yes, looks good to me, @aaemnnosttv. Thanks for adding it! IB ✔️

[aaemnnosttv]

Moving this to the next release due to some unforeseen side effects that have come up as a result of these changes.

[wpdarren]

QA Update: ✅

Verified:

• Could reproduce the error on the latest release.
• When switched to develop branch, I could see that the widgets will no longer be stuck on loading state and they load the error state of the widgets.