Skip to content

Fix Analytics account creation in the new setup flow #12239

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.

Sign up for GitHub

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

Open
fresh3nough wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Fix Analytics account creation in the new setup flow #12239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions assets/js/components/key-metrics-setup/KeyMetricsSetupApp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,17 @@ export default function KeyMetricsSetupApp() {
select( MODULES_SEARCH_CONSOLE ).isGatheringData();
} );

// Await the resolution of Analytics 4 settings before triggering
// the background sync of audiences and custom dimensions. This
// ensures propertyID is available for the sync and isSyncing
// check, preventing the button from being stuck in a disabled state.
const hasResolvedAnalytics4Settings = useSelect( ( select ) => {
select( MODULES_ANALYTICS_4 ).getSettings();
return select( MODULES_ANALYTICS_4 ).hasFinishedResolution(
'getSettings'
);
} );

const isSyncing = useSelect( ( select ) => {
const isFetchingSyncAvailableCustomDimensions =
select(
Expand Down Expand Up @@ -189,9 +200,15 @@ export default function KeyMetricsSetupApp() {
useDispatch( MODULES_ANALYTICS_4 );

useEffect( () => {
syncAvailableAudiences();
fetchSyncAvailableCustomDimensions();
}, [ syncAvailableAudiences, fetchSyncAvailableCustomDimensions ] );
if ( hasResolvedAnalytics4Settings ) {
syncAvailableAudiences();
fetchSyncAvailableCustomDimensions();
}
}, [
hasResolvedAnalytics4Settings,
syncAvailableAudiences,
fetchSyncAvailableCustomDimensions,
] );

const onSaveClick = useCallback( () => {
if ( isBusy || isSyncing ) {
Expand Down
63 changes: 63 additions & 0 deletions assets/js/components/key-metrics-setup/KeyMetricsSetupApp.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ describe( 'KeyMetricsSetupApp', () => {
registry
.dispatch( CORE_MODULES )
.receiveGetModules( withConnected( MODULE_SLUG_ANALYTICS_4 ) );

registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetSettings( {} );
} );

afterEach( () => {
Expand Down Expand Up @@ -347,6 +349,67 @@ describe( 'KeyMetricsSetupApp', () => {
expect( fetchMock ).toHaveFetched( syncCustomDimensionsEndpoint );
} );

it( 'should not sync audiences and custom dimensions until Analytics 4 settings have resolved', async () => {
const analytics4SettingsEndpoint = new RegExp(
'^/google-site-kit/v1/modules/analytics-4/data/settings'
);

// Create a fresh registry without pre-populated Analytics 4
// settings so getSettings resolution remains pending.
const freshRegistry = createTestRegistry();
provideUserAuthentication( freshRegistry );
provideSiteInfo( freshRegistry );
freshRegistry.dispatch( CORE_USER ).receiveGetUserInputSettings( {} );
freshRegistry.dispatch( CORE_USER ).receiveGetDismissedItems( [] );
freshRegistry.dispatch( CORE_USER ).receiveGetDismissedPrompts( {} );
freshRegistry.dispatch( CORE_USER ).receiveGetCapabilities( {} );
freshRegistry
.dispatch( CORE_USER )
.receiveGetUserAudienceSettings( {
configuredAudiences: null,
isAudienceSegmentationWidgetHidden: false,
didSetAudiences: false,
} );
freshRegistry.dispatch( CORE_USER ).receiveGetInitialSetupSettings( {
isAnalyticsSetupComplete: false,
} );
freshRegistry
.dispatch( CORE_MODULES )
.receiveGetModules( withConnected( MODULE_SLUG_ANALYTICS_4 ) );

// Freeze the Analytics 4 settings endpoint so the resolver
// never completes and hasFinishedResolution stays false.
freezeFetch( analytics4SettingsEndpoint );

fetchMock.post( syncAudiencesEndpoint, { body: [], status: 200 } );
fetchMock.post( syncCustomDimensionsEndpoint, {
body: [],
status: 200,
} );
fetchMock.getOnce( searchAnalyticsRegexp, {
body: searchConsoleFixtures.report,
} );
fetchMock.getOnce( analytics4ReportRegexp, {
body: analyticsFixtures.report,
} );
muteFetch( searchConsoleDataAvailableRegexp );
muteFetch( analytics4DataAvailableRegexp );

const { waitForRegistry } = render( <KeyMetricsSetupApp />, {
registry: freshRegistry,
viewContext: VIEW_CONTEXT_KEY_METRICS_SETUP,
} );

await waitForRegistry();

// Since Analytics 4 settings have not resolved, the sync
// actions should not have been dispatched yet.
expect( fetchMock ).not.toHaveFetched( syncAudiencesEndpoint );
expect( fetchMock ).not.toHaveFetched(
syncCustomDimensionsEndpoint
);
} );

it( 'should not attempt to sync again while syncing is already in progress', async () => {
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAudienceSettings( {
availableAudiences: null,
Expand Down