Enhancement/#8144 - Handle “new visitors” and “returning visitors” to avoid the “partial data” state #9232

hussain-t · 2024-08-23T17:40:38Z

Summary

Addresses issue:

Handle the special case for “new visitors” and “returning visitors” to avoid the “partial data” state in the Audience Tile #8144

Relevant technical choices

This PR addresses the error states for the "new" and "returning" visitors reports for displaying the full-width error widget.

PR Author Checklist

My code is tested and passes existing unit tests.
My code has an appropriate set of unit tests which all pass.
My code is backward-compatible with WordPress 5.2 and PHP 7.4.
My code follows the WordPress coding standards.
My code has proper inline documentation.
I have added a QA Brief on the issue linked above.
I have signed the Contributor License Agreement (see https://cla.developers.google.com/).

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

Code Reviewer Checklist

Run the code.
Ensure the acceptance criteria are satisfied.
Reassess the implementation with the IB.
Ensure no unrelated changes are included.
Ensure CI checks pass.
Check Storybook where applicable.
Ensure there is a QA Brief.

Merge Reviewer Checklist

Ensure the PR has the correct target branch.
Double-check that the PR is okay to be merged.
Ensure the corresponding issue has a ZenHub release assigned.
Add a changelog message to the issue.

…g-visitors.

github-actions · 2024-08-23T17:47:18Z

Build files for 357eea2 have been deleted.

github-actions · 2024-08-23T17:48:14Z

Size Change: +8.4 kB (+0.47%)

Total Size: 1.81 MB

Filename	Size	Change
`./dist/assets/js/googlesitekit-activation-********************.js`	23.8 kB	+15 B (+0.06%)
`./dist/assets/js/googlesitekit-ad-blocking-recovery-********************.js`	73.1 kB	+1.72 kB (+2.42%)
`./dist/assets/js/googlesitekit-adminbar-********************.js`	34.5 kB	+50 B (+0.15%)
`./dist/assets/js/googlesitekit-api-********************.js`	9.97 kB	-3 B (-0.03%)
`./dist/assets/js/googlesitekit-components-gm2-********************.js`	5.97 kB	+1 B (+0.02%)
`./dist/assets/js/googlesitekit-components-gm3-********************.js`	10.1 kB	-6 B (-0.06%)
`./dist/assets/js/googlesitekit-datastore-forms-********************.js`	8.95 kB	+1 B (+0.01%)
`./dist/assets/js/googlesitekit-datastore-location-********************.js`	2.08 kB	-1 B (-0.05%)
`./dist/assets/js/googlesitekit-datastore-site-********************.js`	20.3 kB	-18 B (-0.09%)
`./dist/assets/js/googlesitekit-datastore-user-********************.js`	26.1 kB	-16 B (-0.06%)
`./dist/assets/js/googlesitekit-entity-dashboard-********************.js`	83.3 kB	+284 B (+0.34%)
`./dist/assets/js/googlesitekit-main-dashboard-********************.js`	156 kB	+1.01 kB (+0.65%)
`./dist/assets/js/googlesitekit-modules-********************.js`	22.1 kB	+1 B (0%)
`./dist/assets/js/googlesitekit-modules-ads-********************.js`	32.8 kB	+2 B (+0.01%)
`./dist/assets/js/googlesitekit-modules-adsense-********************.js`	125 kB	+249 B (+0.2%)
`./dist/assets/js/googlesitekit-modules-analytics-4-********************.js`	169 kB	+701 B (+0.42%)
`./dist/assets/js/googlesitekit-modules-pagespeed-insights-********************.js`	22.5 kB	+24 B (+0.11%)
`./dist/assets/js/googlesitekit-modules-reader-revenue-manager-********************.js`	21.7 kB	+10 B (+0.05%)
`./dist/assets/js/googlesitekit-modules-search-console-********************.js`	58.6 kB	+37 B (+0.06%)
`./dist/assets/js/googlesitekit-modules-tagmanager-********************.js`	32 kB	+10 B (+0.03%)
`./dist/assets/js/googlesitekit-notifications-********************.js`	18.5 kB	-5 B (-0.03%)
`./dist/assets/js/googlesitekit-polyfills-********************.js`	378 B	+1 B (+0.27%)
`./dist/assets/js/googlesitekit-settings-********************.js`	83.3 kB	+341 B (+0.41%)
`./dist/assets/js/googlesitekit-splash-********************.js`	91 kB	+1.61 kB (+1.8%)
`./dist/assets/js/googlesitekit-user-input-********************.js`	64.7 kB	+1.69 kB (+2.68%)
`./dist/assets/js/googlesitekit-vendor-********************.js`	321 kB	+12 B (0%)
`./dist/assets/js/googlesitekit-widgets-********************.js`	86.2 kB	+590 B (+0.69%)
`./dist/assets/js/googlesitekit-wp-dashboard-********************.js`	61.8 kB	+92 B (+0.15%)
`./dist/assets/js/runtime-********************.js`	1.3 kB	+2 B (+0.15%)

ℹ️ View Unchanged

Filename	Size
`./dist/assets/css/googlesitekit-admin-css-********************.min.css`	57.5 kB
`./dist/assets/css/googlesitekit-adminbar-css-********************.min.css`	11.8 kB
`./dist/assets/css/googlesitekit-authorize-application-css-********************.min.css`	846 B
`./dist/assets/css/googlesitekit-wp-dashboard-css-********************.min.css`	8.2 kB
`./dist/assets/js/31-********************.js`	2.76 kB
`./dist/assets/js/32-********************.js`	2.25 kB
`./dist/assets/js/33-********************.js`	3.64 kB
`./dist/assets/js/34-********************.js`	935 B
`./dist/assets/js/35-********************.js`	892 B
`./dist/assets/js/36-********************.js`	3.12 kB
`./dist/assets/js/analytics-advanced-tracking-********************.js`	901 B
`./dist/assets/js/googlesitekit-consent-mode-********************.js`	25.6 kB
`./dist/assets/js/googlesitekit-data-********************.js`	2.37 kB
`./dist/assets/js/googlesitekit-datastore-ui-********************.js`	9.91 kB
`./dist/assets/js/googlesitekit-events-provider-contact-form-7-********************.js`	646 B
`./dist/assets/js/googlesitekit-events-provider-easy-digital-downloads-********************.js`	624 B
`./dist/assets/js/googlesitekit-events-provider-mailchimp-********************.js`	630 B
`./dist/assets/js/googlesitekit-events-provider-ninja-forms-********************.js`	712 B
`./dist/assets/js/googlesitekit-events-provider-optin-monster-********************.js`	675 B
`./dist/assets/js/googlesitekit-events-provider-popup-maker-********************.js`	634 B
`./dist/assets/js/googlesitekit-events-provider-woocommerce-********************.js`	657 B
`./dist/assets/js/googlesitekit-events-provider-wpforms-********************.js`	633 B
`./dist/assets/js/googlesitekit-i18n-********************.js`	3.93 kB

_{compressed-size-action}

.../analytics-4/components/audience-segmentation/dashboard/AudienceTilesWidget/index.stories.js

benbowler

Hey @hussain-t, the PR and code looks good, great use of a hook to split out the complex queries from this already complex component.

I've add a couple of small comments below, LMK your thoughts.

.../analytics-4/components/audience-segmentation/dashboard/AudienceTilesWidget/index.stories.js

...les/analytics-4/components/audience-segmentation/dashboard/AudienceTilesWidget/index.test.js

…g-visitors.

benbowler · 2024-08-30T07:42:49Z

Thanks @hussain-t, I resolved the conflicts with the useInViewSelect work as I was working on that ticket and moving to MR once the checks pass.

…g-visitors.

hussain-t · 2024-09-09T11:02:04Z

...components/audience-segmentation/dashboard/AudienceTilesWidget/AudienceTile/index.stories.js

@@ -311,7 +311,7 @@ ViewOnlyNoDimensions.args = {
 	viewContext: VIEW_CONTEXT_MAIN_DASHBOARD_VIEW_ONLY,
 	setupRegistry: ( registry ) => {
 		registry.dispatch( MODULES_ANALYTICS_4 ).setSettings( {
-			availableAudiences: null,
+			availableAudiences: [],


Mocking with a null value breaks the story.

site-kit-wp/assets/js/modules/analytics-4/datastore/audiences.js

Lines 714 to 716 in 7ce10f7

const audience = availableAudiences.find(

( { name } ) => name === audienceResourceName

);

hussain-t · 2024-09-09T12:19:00Z

Thanks for the valuable feedback, @techanvil. I've addressed them.

…rableSiteKitAndOtherAudiences.

…t loaded.

…data audiences.

…rtial data audiences.

techanvil

Hi @hussain-t, thanks for the update.

However, when I tested it, filtering for audienceResourceName or newVsReturning in the network tab to verify the correct reports were being made, I found it still wasn't behaving as expected.

Digging in I realised this IB point hadn't been covered and it had simply escaped me the first time round:

Fetch the top cities, top content and top content titles for siteKitAudienceResourceNames separately with dimensionFilters set to newVsReturning.

I also noticed getConfiguredSiteKitAndOtherAudiences() was misnamed so giving unexpected results when trying to use it here.

So, it turned out to still need a fair bit of work. To help move this along I've got stuck into this myself and have got it to a point where it's working in my testing.

I've pushed the changes, please take a look, and if you're happy then wrap it up from here, there are a few JS tests that need to be fixed, and a failing VRT test, once these are done it should be good to go 🤞

…g-visitors.

hussain-t · 2024-09-10T16:05:58Z

Thanks so much for the fixes, @techanvil. I have made a couple of minor fixes and fixed the failing tests. Please note that VRT keeps failing randomly upon several attempts.

techanvil · 2024-09-10T19:02:27Z

Thanks so much for the fixes, @techanvil. I have made a couple of minor fixes and fixed the failing tests. Please note that VRT keeps failing randomly upon several attempts.

No problem @hussain-t. I've also taken a look at the VRT and realised it needed an update so I've pushed that as well to move this along. I also updated a JS test which was sometimes failing for me locally.

techanvil

This is now LGTM, thanks @hussain-t.

hussain-t added 15 commits August 23, 2024 16:32

Handle new and returning visitors partial data state.

c6540fc

Add partial data stories for nre and returning audiences.

7878a0e

Hide partial data badge for site kit audiences.

a0f0f35

Add tests.

ecf546a

Pass appropriate report to check for zero data.

1ce7108

Check correct report and dimension value for zero data.

9662c20

Improve tests.

8ec870e

Add test snapshot.

7c97dca

Merge branch 'develop' into enhancement/#8144-handle-new-and-returnin…

c779947

…g-visitors.

Implement all tiles error for sit kit new and returning visitors.

a4418d8

Update tests.

0a0b80a

Update snapshot.

675a2a2

Extract reports to useAudienceTilesReports.

96bebdd

Use useAudienceTilesReports hook.

dce4779

Reduce complexity by extracting getAudienceTileData.

e69874a

hussain-t added 3 commits August 26, 2024 09:52

Fix stories.

9f90737

Fix stories for zero data.

77eaf9f

Update VRT images.

8c7090b

hussain-t commented Aug 27, 2024

View reviewed changes

.../analytics-4/components/audience-segmentation/dashboard/AudienceTilesWidget/index.stories.js Show resolved Hide resolved

hussain-t commented Aug 27, 2024

View reviewed changes

.../analytics-4/components/audience-segmentation/dashboard/AudienceTilesWidget/index.stories.js Show resolved Hide resolved

hussain-t commented Aug 27, 2024

View reviewed changes

.../analytics-4/components/audience-segmentation/dashboard/AudienceTilesWidget/index.stories.js Show resolved Hide resolved

benbowler reviewed Aug 28, 2024

View reviewed changes

.../analytics-4/components/audience-segmentation/dashboard/AudienceTilesWidget/index.stories.js Show resolved Hide resolved

...les/analytics-4/components/audience-segmentation/dashboard/AudienceTilesWidget/index.test.js Outdated Show resolved Hide resolved

hussain-t and others added 5 commits August 28, 2024 17:02

Merge branch 'develop' into enhancement/#8144-handle-new-and-returnin…

452365e

…g-visitors.

Add DefaultAudiencesPartialData story.

5d6158b

Update the comment.

9277d53

Add default audiences partial data VRT images.

d96ced0

Merge useInViewSelect work.

41f0bba

hussain-t added 6 commits September 9, 2024 12:41

Simplify condition.

b89a8f0

Address comment to determine fetch reports.

3512b73

Merge branch 'develop' into enhancement/#8144-handle-new-and-returnin…

65374d7

…g-visitors.

Fix tests.

9a20694

Merge branch 'develop' into enhancement/#8144-handle-new-and-returnin…

424de3d

…g-visitors.

Fix story.

c7c11f2

hussain-t commented Sep 9, 2024

View reviewed changes

techanvil added 5 commits September 9, 2024 17:33

Fix selector name getConfiguredSiteKitAndOtherAudiences -> getConfigu…

dd80988

…rableSiteKitAndOtherAudiences.

Add and use getConfiguredSiteKitAndOtherAudiences().

0ac1476

Fix hasAudiencePartialData() to return undefined when partial data no…

ad496a4

…t loaded.

Update getReportForAllAudiences to use newVsReturning for SK partial …

623d422

…data audiences.

Update top cities and content reports to use newVsReturning for SK pa…

cceea37

…rtial data audiences.

techanvil requested changes Sep 9, 2024

View reviewed changes

hussain-t added 7 commits September 10, 2024 15:01

Merge branch 'develop' into enhancement/#8144-handle-new-and-returnin…

a96449d

…g-visitors.

Add fallback array.

738ba43

Conditionally check for audienceType.

f93e596

Fix and improve tests.

efeafd4

Update snapshots.

96d76d2

Remove duplicate mock report.

8498af2

Fix getReportForAllAudiences tests.

b3f2e22

techanvil added 4 commits September 10, 2024 17:56

Fix the SiteKitAudiencesPartialData story.

bc343a8

Don't use boolean function parameters.

a58823a

Improve test stability.

cdd0db9

Update VRT reference images.

357eea2

techanvil approved these changes Sep 10, 2024

View reviewed changes

techanvil merged commit 0023bde into develop Sep 10, 2024
16 of 21 checks passed

techanvil deleted the enhancement/#8144-handle-new-and-returning-visitors branch September 10, 2024 19:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhancement/#8144 - Handle “new visitors” and “returning visitors” to avoid the “partial data” state #9232

Enhancement/#8144 - Handle “new visitors” and “returning visitors” to avoid the “partial data” state #9232

hussain-t commented Aug 23, 2024 •

edited by techanvil

Loading

github-actions bot commented Aug 23, 2024 •

edited

Loading

github-actions bot commented Aug 23, 2024 •

edited

Loading

benbowler left a comment

benbowler commented Aug 30, 2024

hussain-t Sep 9, 2024

hussain-t commented Sep 9, 2024

techanvil left a comment •

edited

Loading

hussain-t commented Sep 10, 2024

techanvil commented Sep 10, 2024

techanvil left a comment

	const audience = availableAudiences.find(
	( { name } ) => name === audienceResourceName
	);

Enhancement/#8144 - Handle “new visitors” and “returning visitors” to avoid the “partial data” state #9232

Enhancement/#8144 - Handle “new visitors” and “returning visitors” to avoid the “partial data” state #9232

Conversation

hussain-t commented Aug 23, 2024 • edited by techanvil Loading

Summary

Relevant technical choices

PR Author Checklist

Code Reviewer Checklist

Merge Reviewer Checklist

github-actions bot commented Aug 23, 2024 • edited Loading

github-actions bot commented Aug 23, 2024 • edited Loading

benbowler left a comment

Choose a reason for hiding this comment

benbowler commented Aug 30, 2024

hussain-t Sep 9, 2024

Choose a reason for hiding this comment

hussain-t commented Sep 9, 2024

techanvil left a comment • edited Loading

Choose a reason for hiding this comment

hussain-t commented Sep 10, 2024

techanvil commented Sep 10, 2024

techanvil left a comment

Choose a reason for hiding this comment

hussain-t commented Aug 23, 2024 •

edited by techanvil

Loading

github-actions bot commented Aug 23, 2024 •

edited

Loading

github-actions bot commented Aug 23, 2024 •

edited

Loading

techanvil left a comment •

edited

Loading