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.

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

Jump to bottom

Update Analytics setup to display all available accounts and properties. #9440

Merged
merged 22 commits into from
Oct 9, 2024
Merged

Update Analytics setup to display all available accounts and properties. #9440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
3ac8acc
Update Analytics setup to display all available accounts and properties.
ankitrox Oct 1, 2024
271ca11
Fix: JS tests.
ankitrox Oct 1, 2024
6b77ad7
Fix: stories.
ankitrox Oct 1, 2024
4abbd09
Merge branch 'develop' into enhancement/9348-analytics-display-accoun…
ankitrox Oct 1, 2024
8011ab8
Add tests for multiple fetch requests.
ankitrox Oct 1, 2024
95b8543
Merge branch 'develop' into enhancement/9348-analytics-display-accoun…
ankitrox Oct 3, 2024
eb38781
Port the logic to reducer.
ankitrox Oct 4, 2024
f69ab61
Change page size to original 200 value.
ankitrox Oct 4, 2024
10a3191
Rename sort file.
ankitrox Oct 4, 2024
6021106
Fix: E2E tests.
ankitrox Oct 4, 2024
193c1fb
Address CR feedback.
ankitrox Oct 7, 2024
802b4bc
Resolve merge conflicts.
ankitrox Oct 7, 2024
31a2dd4
Use createReducer.
ankitrox Oct 7, 2024
9519a73
Fix: js tests.
ankitrox Oct 7, 2024
a6ee23a
Address CR feedback.
ankitrox Oct 9, 2024
ab2bd42
Fix: page size.
ankitrox Oct 9, 2024
d74436a
Update use of pageToken as arg to param.
aaemnnosttv Oct 9, 2024
d6d0470
Resolve accountSummaries when finding matched account.
aaemnnosttv Oct 9, 2024
0831c54
Use empty string for falsy page token arg.
aaemnnosttv Oct 9, 2024
4cf0791
Merge branch 'develop' into enhancement/9348-analytics-display-accoun…
aaemnnosttv Oct 9, 2024
cd22814
Merge branch 'develop' into enhancement/9348-analytics-display-accoun…
aaemnnosttv Oct 9, 2024
a721e81
Remove call to non-existent method.
aaemnnosttv Oct 9, 2024
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
5 changes: 4 additions & 1 deletion assets/js/components/notifications/GoogleTagIDMismatchNotification.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,10 @@ export default {
};
registry
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetAccountSummaries( accountSummaries );
.receiveGetAccountSummaries( {
accountSummaries,
nextPageToken: null,
} );
registry
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetWebDataStreamsBatch( datastreams, {
Expand Down
7 changes: 4 additions & 3 deletions assets/js/modules/analytics-4/components/common/AccountCreate/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,10 @@ describe( 'AccountCreate', () => {
} );

registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetSettings( {} );
registry
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetAccountSummaries( [] );
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries( {
accountSummaries: [],
nextPageToken: null,
} );
registry
.dispatch( MODULES_ANALYTICS_4 )
.finishResolution( 'getAccountSummaries', [] );
Expand Down
7 changes: 5 additions & 2 deletions assets/js/modules/analytics-4/components/common/AccountSelect.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,10 @@ const setupEmptyRegistry = ( registry ) => {
registry.dispatch( MODULES_ANALYTICS_4 ).setSettings( {} );
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetExistingTag( null );

registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries( [] );
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries( {
accountSummaries: [],
nextPageToken: null,
} );
registry
.dispatch( MODULES_ANALYTICS_4 )
.finishResolution( 'getAccountSummaries', [] );
Expand All @@ -73,7 +76,7 @@ describe( 'AccountSelect', () => {
// Note: we do length + 1 here because there should also be an item for
// "Set up a new account".
expect( listItems ).toHaveLength(
fixtures.accountSummaries.length + 1
fixtures.accountSummaries.accountSummaries.length + 1
);
} );

Expand Down
20 changes: 12 additions & 8 deletions assets/js/modules/analytics-4/components/common/PropertySelect.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ import {
provideUserAuthentication,
} from '../../../../../../tests/js/test-utils';

const accountID = fixtures.accountSummaries[ 1 ]._id;
const properties = fixtures.accountSummaries[ 1 ].propertySummaries;
const accountID = fixtures.accountSummaries.accountSummaries[ 1 ]._id;
const properties =
fixtures.accountSummaries.accountSummaries[ 1 ].propertySummaries;
const propertyIDs = properties.map( ( { _id } ) => _id );

const setupRegistry = ( registry ) => {
Expand Down Expand Up @@ -86,12 +87,15 @@ const setupEmptyRegistry = ( registry ) => {
dispatch( MODULES_ANALYTICS_4 ).receiveGetSettings( {} );
dispatch( MODULES_ANALYTICS_4 ).setAccountID( accountID );

dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries(
fixtures.accountSummaries.map( ( account ) => ( {
...account,
propertySummaries: [],
} ) )
);
dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries( {
accountSummaries: fixtures.accountSummaries.accountSummaries.map(
( account ) => ( {
...account,
propertySummaries: [],
} )
),
nextPageToken: null,
} );
dispatch( MODULES_ANALYTICS_4 ).finishResolution(
'getAccountSummaries',
[]
Expand Down
42 changes: 27 additions & 15 deletions .../modules/analytics-4/components/settings/PropertyOrWebDataStreamNotAvailableError.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ import * as fixtures from '../../datastore/__fixtures__';
import { MODULES_ANALYTICS_4 } from '../../datastore/constants';
import PropertyOrWebDataStreamNotAvailableError from './PropertyOrWebDataStreamNotAvailableError';

const accountID = fixtures.accountSummaries[ 1 ]._id;
const properties = fixtures.accountSummaries[ 1 ].propertySummaries;
const accountID = fixtures.accountSummaries.accountSummaries[ 1 ]._id;
const properties =
fixtures.accountSummaries.accountSummaries[ 1 ].propertySummaries;
const propertyID = properties[ 0 ]._id;
const measurementID =
fixtures.webDataStreamsBatch[ propertyID ][ 0 ].webStreamData.measurementId; // eslint-disable-line sitekit/acronym-case
Expand Down Expand Up @@ -85,7 +86,7 @@ describe( 'PropertyOrWebDataStreamNotAvailableError', () => {
expect( container ).toBeEmptyDOMElement();
} );

it( 'should not render when Web Data Streams are not loaded yet', () => {
it( 'should not render when Web Data Streams are not loaded yet', async () => {
freezeFetch(
new RegExp(
'^/google-site-kit/v1/modules/analytics-4/data/webdatastreams'
Expand All @@ -96,42 +97,48 @@ describe( 'PropertyOrWebDataStreamNotAvailableError', () => {
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetAccountSummaries( fixtures.accountSummaries );

const { container } = render(
const { container, waitForRegistry } = render(
<PropertyOrWebDataStreamNotAvailableError
hasModuleAccess
isDisabled={ false }
/>,
{ registry }
);

await waitForRegistry();

expect( container ).toBeEmptyDOMElement();
} );

it( 'should not render when selected property and Web Data Stream are available', () => {
it( 'should not render when selected property and Web Data Stream are available', async () => {
provideGA4PropertyAndWebDataStream( registry );

const { container } = render(
const { container, waitForRegistry } = render(
<PropertyOrWebDataStreamNotAvailableError
hasModuleAccess
isDisabled={ false }
/>,
{ registry }
);

await waitForRegistry();

expect( container ).toBeEmptyDOMElement();
} );

it( 'should not render when user does not have module access', () => {
it( 'should not render when user does not have module access', async () => {
provideGA4PropertyAndWebDataStream( registry );

const { container } = render(
const { container, waitForRegistry } = render(
<PropertyOrWebDataStreamNotAvailableError
hasModuleAccess={ false }
isDisabled={ false }
/>,
{ registry }
);

await waitForRegistry();

expect( container ).toBeEmptyDOMElement();
} );

Expand All @@ -149,7 +156,7 @@ describe( 'PropertyOrWebDataStreamNotAvailableError', () => {
expect( container ).toBeEmptyDOMElement();
} );

it( 'should render error message when selected Web Data Stream is not available', () => {
it( 'should render error message when selected Web Data Stream is not available', async () => {
registry
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetAccountSummaries( fixtures.accountSummaries );
Expand All @@ -160,37 +167,42 @@ describe( 'PropertyOrWebDataStreamNotAvailableError', () => {
}
);

const { container } = render(
const { container, waitForRegistry } = render(
<PropertyOrWebDataStreamNotAvailableError
hasModuleAccess
isDisabled={ false }
/>,
{ registry }
);

await waitForRegistry();

expect( container ).toHaveTextContent(
`The previously selected web data stream with measurement ID ${ measurementID } is no longer available.`
);
} );

it( 'should render error message when selected property is not available', () => {
registry
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetAccountSummaries( [] );
it( 'should render error message when selected property is not available', async () => {
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries( {
accountSummaries: [],
nextPageToken: null,
} );
registry
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetWebDataStreamsBatch( fixtures.webDataStreamsBatch, {
propertyIDs: [ propertyID ],
} );

const { container } = render(
const { container, waitForRegistry } = render(
<PropertyOrWebDataStreamNotAvailableError
hasModuleAccess
isDisabled={ false }
/>,
{ registry }
);

await waitForRegistry();

expect( container ).toHaveTextContent(
`The previously selected property with ID ${ propertyID } is no longer available.`
);
Expand Down
9 changes: 5 additions & 4 deletions assets/js/modules/analytics-4/components/settings/SettingsEnhancedMeasurementSwitch.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import SettingsEnhancedMeasurementSwitch from './SettingsEnhancedMeasurementSwit

describe( 'SettingsEnhancedMeasurementSwitch', () => {
const { webDataStreams, accountSummaries } = fixtures;
const accounts = accountSummaries;
const accounts = accountSummaries.accountSummaries;
const properties = accounts[ 1 ].propertySummaries;
const accountID = accounts[ 1 ]._id;
const propertyID = properties[ 0 ]._id;
Expand Down Expand Up @@ -68,9 +68,10 @@ describe( 'SettingsEnhancedMeasurementSwitch', () => {
webDataStreamID,
} );

registry
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetAccountSummaries( accounts );
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries( {
accountSummaries: accounts,
nextPageToken: null,
} );
registry
.dispatch( MODULES_ANALYTICS_4 )
.finishResolution( 'getAccountSummaries', [] );
Expand Down
2 changes: 1 addition & 1 deletion assets/js/modules/analytics-4/components/settings/SettingsForm.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const {
webDataStreamsBatch,
defaultEnhancedMeasurementSettings,
} = fixtures;
const accounts = accountSummaries;
const accounts = accountSummaries.accountSummaries;
const properties = accounts[ 1 ].propertySummaries;
const accountID = accounts[ 1 ]._id;
const propertyID = properties[ 0 ]._id;
Expand Down
2 changes: 1 addition & 1 deletion assets/js/modules/analytics-4/components/settings/SettingsView.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import WithRegistrySetup from '../../../../../../tests/js/WithRegistrySetup';
import * as fixtures from '../../datastore/__fixtures__';

const { accountSummaries, webDataStreamsBatch, googleTagSettings } = fixtures;
const accounts = accountSummaries;
const accounts = accountSummaries.accountSummaries;
const properties = accounts[ 1 ].propertySummaries;
const accountID = accounts[ 1 ]._id;
const propertyID = properties[ 0 ]._id;
Expand Down
9 changes: 5 additions & 4 deletions assets/js/modules/analytics-4/components/setup/SetupEnhancedMeasurementSwitch.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ describe( 'SetupEnhancedMeasurementSwitch', () => {
let registry;

const { webDataStreams, accountSummaries } = fixtures;
const accounts = accountSummaries;
const accounts = accountSummaries.accountSummaries;
const properties = accounts[ 1 ].propertySummaries;
const accountID = accounts[ 1 ]._id;
const propertyID = properties[ 0 ]._id;
Expand Down Expand Up @@ -60,9 +60,10 @@ describe( 'SetupEnhancedMeasurementSwitch', () => {
webDataStreamID,
} );

registry
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetAccountSummaries( accounts );
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries( {
accountSummaries: accounts,
nextPageToken: null,
} );
registry
.dispatch( MODULES_ANALYTICS_4 )
.finishResolution( 'getAccountSummaries', [] );
Expand Down
2 changes: 1 addition & 1 deletion assets/js/modules/analytics-4/components/setup/SetupForm.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import { VIEW_CONTEXT_MAIN_DASHBOARD } from '../../../../googlesitekit/constants
import { CORE_SITE } from '../../../../googlesitekit/datastore/site/constants';

const { accountSummaries, webDataStreamsBatch } = fixtures;
const accounts = accountSummaries;
const accounts = accountSummaries.accountSummaries;
const properties = accounts[ 1 ].propertySummaries;
const accountID = accounts[ 1 ]._id;
const propertyID = properties[ 0 ]._id;
Expand Down
34 changes: 21 additions & 13 deletions assets/js/modules/analytics-4/components/setup/SetupForm.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ const {
webDataStreamsBatch,
webDataStreams,
} = fixtures;
const accounts = accountSummaries;
const accounts = accountSummaries.accountSummaries;
const properties = accounts[ 1 ].propertySummaries;
const accountID = accounts[ 1 ]._id;
const propertyID = properties[ 0 ]._id;
Expand Down Expand Up @@ -221,12 +221,16 @@ describe( 'SetupForm', () => {
it( 'auto-submits the form', async () => {
registry.dispatch( MODULES_ANALYTICS_4 ).setSettings( {} );
registry.dispatch( MODULES_TAGMANAGER ).setSettings( {} );
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries(
accountSummaries.map( ( account ) => ( {
...account,
propertySummaries: [],
} ) )
);
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetExistingTag( null );
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries( {
accountSummaries: accountSummaries.accountSummaries.map(
( account ) => ( {
...account,
propertySummaries: [],
} )
),
nextPageToken: null,
} );
registry
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetProperty( properties[ 0 ], {
Expand Down Expand Up @@ -339,12 +343,16 @@ describe( 'SetupForm', () => {

it( 'auto-submits the form only once in the case of an error', async () => {
registry.dispatch( MODULES_TAGMANAGER ).setSettings( {} );
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries(
accountSummaries.map( ( account ) => ( {
...account,
propertySummaries: [],
} ) )
);
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetExistingTag( null );
registry.dispatch( MODULES_ANALYTICS_4 ).receiveGetAccountSummaries( {
accountSummaries: accountSummaries.accountSummaries.map(
( account ) => ( {
...account,
propertySummaries: [],
} )
),
nextPageToken: null,
} );
registry
.dispatch( MODULES_ANALYTICS_4 )
.receiveGetWebDataStreamsBatch( webDataStreamsBatch, {
Expand Down
Loading
Loading