-
Notifications
You must be signed in to change notification settings - Fork 286
/
write-scope-requests.test.js
410 lines (372 loc) · 12.6 KB
/
write-scope-requests.test.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
/**
* Analytics write scope requests tests.
*
* Site Kit by Google, Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* WordPress dependencies
*/
import {
activatePlugin,
createURL,
visitAdminPage,
} from '@wordpress/e2e-test-utils';
/**
* Internal dependencies
*/
import {
deactivateUtilityPlugins,
resetSiteKit,
useRequestInterception,
setupSiteKit,
pageWait,
ignorePermissionScopeErrors,
} from '../../../utils';
import * as fixtures from '../../../../../assets/js/modules/analytics-4/datastore/__fixtures__';
describe( 'Analytics write scope requests', () => {
// These variables are used to determine whether or not we need to intercept requests to the server. By default the first request
// won't be intercepted to reach the server and to trigger the insufficient scopes error on the server. The following requests will
// be intercepted and mocked to immediately return fake data to emulate property/profile creation.
let interceptCreatePropertyRequest;
let interceptCreateWebDataStreamRequest;
beforeAll( async () => {
await page.setRequestInterception( true );
useRequestInterception( ( request ) => {
if (
request
.url()
.startsWith(
'https://sitekit.withgoogle.com/o/oauth2/auth'
)
) {
const requestURL = new URL( request.url() );
const scope = requestURL.searchParams.get( 'scope' );
request.respond( {
status: 302,
headers: {
location: createURL(
'/wp-admin/index.php',
`oauth2callback=1&code=valid-test-code&scope=${ encodeURIComponent(
scope
) }`
),
},
} );
} else if (
request.url().match( 'analytics-4/data/create-account-ticket' )
) {
request.respond( {
status: 200,
body: JSON.stringify( {
// eslint-disable-next-line sitekit/acronym-case
accountTicketId: 'testAccountTicketID',
} ),
} );
} else if (
request
.url()
.match(
'/wp-json/google-site-kit/v1/modules/analytics-4/data/report?'
)
) {
request.respond( {
status: 200,
body: JSON.stringify( {} ),
} );
} else if (
request
.url()
.match(
'/wp-json/google-site-kit/v1/modules/pagespeed-insights/data/pagespeed'
)
) {
request.respond( { status: 200, body: JSON.stringify( {} ) } );
} else if (
request.url().match( 'analytics-4/data/create-property' )
) {
if ( interceptCreatePropertyRequest ) {
interceptCreatePropertyRequest = false;
request.respond( {
status: 200,
body: JSON.stringify( {
...fixtures.createProperty,
_id: '1001', // Ensure match with ID in tests/e2e/plugins/module-setup-analytics.php
} ),
} );
} else {
request.continue();
}
} else if (
request.url().match( 'analytics-4/data/create-webdatastream' )
) {
if ( interceptCreateWebDataStreamRequest ) {
interceptCreateWebDataStreamRequest = false;
request.respond( {
status: 200,
body: JSON.stringify( fixtures.createWebDataStream ),
} );
} else {
request.continue();
}
} else if (
request.url().match( 'analytics-4/data/conversion-events' ) ||
request.url().match( 'search-console/data/searchanalytics' )
) {
request.respond( {
status: 200,
body: JSON.stringify( [] ),
} );
} else if (
request
.url()
.match( 'analytics-4/data/enhanced-measurement-settings' )
) {
request.respond( {
status: 200,
body: JSON.stringify(
fixtures.defaultEnhancedMeasurementSettings
),
} );
} else if (
request.url().match( 'analytics-4/data/google-tag-settings' )
) {
request.respond( {
status: 200,
body: JSON.stringify( fixtures.googleTagSettings ),
} );
} else if (
request.url().match( 'analytics-4/data/container-lookup' )
) {
request.respond( {
body: JSON.stringify( fixtures.container ),
status: 200,
} );
} else if (
request.url().match( 'analytics-4/data/sync-custom-dimensions' )
) {
request.respond( {
status: 200,
body: '[]',
} );
} else if (
// Intercept request to GA TOS URL and redirect to gatoscallback.
request
.url()
.includes( '//accounts.google.com/accountchooser' ) &&
request.url().includes( 'provisioningSignup' )
) {
request.respond( {
status: 302,
headers: {
location: createURL(
// Here we intentionally leave out the accountId to cut the process short and avoid API requests.
'/wp-admin/index.php',
'gatoscallback=1&accountTicketId=testAccountTicketID'
),
},
} );
} else {
request.continue();
}
} );
} );
beforeEach( async () => {
await activatePlugin( 'e2e-tests-oauth-callback-plugin' );
await setupSiteKit();
} );
afterEach( async () => {
ignorePermissionScopeErrors();
await deactivateUtilityPlugins();
await resetSiteKit();
} );
/*
* @TODO Fix this test which fails with a generic TimeoutError
* without more detail as to what it was waiting for or how long.
* This only fails consistently in CI.
*/
// eslint-disable-next-line jest/no-disabled-tests
it.skip( 'prompts for additional permissions during a new Analytics account creation if the user has not granted the Analytics edit scope', async () => {
interceptCreatePropertyRequest = true;
interceptCreateWebDataStreamRequest = true;
await activatePlugin(
'e2e-tests-module-setup-analytics-api-mock-no-account'
);
// Go to the analytics setup page.
await visitAdminPage( 'admin.php', 'page=googlesitekit-settings' );
await page.waitForSelector( '.mdc-tab-bar' );
await expect( page ).toClick( '.mdc-tab', {
text: /connect more services/i,
} );
await page.waitForSelector(
'.googlesitekit-settings-connect-module--analytics'
);
await expect( page ).toClick( '.googlesitekit-cta-link', {
text: /set up analytics/i,
} );
await page.waitForSelector( '.googlesitekit-setup-module--analytics' );
await page.waitForSelector( '.googlesitekit-setup-module__inputs' );
// The user sees a notice above the button that explains they will need to grant additional permissions.
await expect( page ).toMatchElement( 'p', {
text: /You will need to give Site Kit permission to create an Analytics account/i,
} );
// Upon clicking the button, they're redirected to OAuth (should be mocked).
// This request is intercepted above and handled through the oauth callback plugin.
await expect( page ).toClick( '.mdc-button', {
text: /create account/i,
} );
// Once redirected back from OAuth, the user will end back on the Analytics setup screen
// where the original action is automatically invoked, without requiring them to click the button again.
// This request is intercepted above and returns a test account ticket ID.
// Once the account ticket ID is received, the TOS URL will be available which will invoke a navigation
// to the external Analytics TOS screen to action.
await page.waitForResponse( ( res ) =>
res.url().match( 'analytics-4/data/create-account-ticket' )
);
await page.waitForRequest(
( req ) =>
req.isNavigationRequest() &&
req.url().includes( 'provisioningSignup' )
);
// Without this, we might run into a weird issue when ending the test during the request above.
await page.waitForNavigation( { waitUntil: 'networkidle2' } );
} );
it( 'prompts for additional permissions during a new Analytics property creation if the user has not granted the Analytics edit scope', async () => {
// Don't intercept initial request to create property to trigger modal.
interceptCreatePropertyRequest = false;
interceptCreateWebDataStreamRequest = true;
await activatePlugin( 'e2e-tests-module-setup-analytics-api-mock' );
// Go to the analytics setup page.
await visitAdminPage( 'admin.php', 'page=googlesitekit-settings' );
await page.waitForSelector( '.mdc-tab-bar' );
await expect( page ).toClick( '.mdc-tab', {
text: /connect more services/i,
} );
await page.waitForSelector(
'.googlesitekit-settings-connect-module--analytics'
);
await expect( page ).toClick( '.googlesitekit-cta-link', {
text: /set up analytics/i,
} );
await page.waitForSelector( '.googlesitekit-setup-module--analytics' );
await page.waitForSelector( '.googlesitekit-setup-module__inputs' );
// Select "Set up a new property" option (GA4)
await expect( page ).toClick(
'.googlesitekit-analytics-4__select-property'
);
await expect( page ).toClick( '.mdc-menu-surface--open li', {
text: /set up a new property/i,
} );
// Add a brief delay to allow the submit button to become enabled.
await pageWait();
// Click on confirm changes button and wait for permissions modal dialog.
await expect( page ).toClick( '.mdc-button--raised', {
text: /configure analytics/i,
} );
await page.waitForSelector( '.mdc-dialog--open .mdc-button', {
timeout: 3000,
} );
interceptCreatePropertyRequest = true;
await expect( page ).toClick( '.mdc-dialog--open .mdc-button', {
text: /proceed/i,
} );
// expect( console ).toHaveErrored(); // Permission scope error.
await page.waitForRequest( ( req ) =>
req.url().match( 'analytics-4/data/create-property' )
);
await page.waitForRequest( ( req ) =>
req.url().match( 'analytics-4/data/create-webdatastream' )
);
// They should end up on the dashboard.
await Promise.all( [
page.waitForNavigation(),
page.waitForSelector( '.googlesitekit-publisher-win__title' ),
] );
await expect( page ).toMatchElement(
'.googlesitekit-publisher-win__title',
{
text: /Congrats on completing the setup for Analytics!/i,
}
);
} );
it( 'prompts for additional permissions during a new Analytics web data stream creation if the user has not granted the Analytics edit scope', async () => {
interceptCreatePropertyRequest = true;
interceptCreateWebDataStreamRequest = false;
await activatePlugin( 'e2e-tests-module-setup-analytics-api-mock' );
// Go to the analytics setup page.
await visitAdminPage( 'admin.php', 'page=googlesitekit-settings' );
await page.waitForSelector( '.mdc-tab-bar' );
await expect( page ).toClick( '.mdc-tab', {
text: /connect more services/i,
} );
await page.waitForSelector(
'.googlesitekit-settings-connect-module--analytics'
);
await expect( page ).toClick( '.googlesitekit-cta-link', {
text: /set up analytics/i,
} );
await page.waitForSelector( '.googlesitekit-setup-module--analytics' );
await page.waitForSelector( '.googlesitekit-setup-module__inputs' );
// Select "Test Account A" account.
await expect( page ).toClick(
'.googlesitekit-analytics__select-account'
);
await expect( page ).toClick( '.mdc-menu-surface--open li', {
text: /example com/i,
} );
// Select "example.com" property.
await expect( page ).toClick(
'.googlesitekit-analytics-4__select-property'
);
await expect( page ).toClick( '.mdc-menu-surface--open li', {
text: /example property/i,
} );
// Select "Set up a new web data stream" option.
await expect( page ).toClick(
'.googlesitekit-analytics-4__select-webdatastream'
);
await expect( page ).toClick( '.mdc-menu-surface--open li', {
text: /set up a new web data stream/i,
} );
await expect( page ).toClick( '.mdc-button--raised', {
text: /configure analytics/i,
} );
await page.waitForRequest( ( req ) =>
req.url().match( 'analytics-4/data/create-webdatastream' )
);
// Click on confirm changes button and wait for permissions modal dialog.
await page.waitForSelector( '.mdc-dialog--open .mdc-button', {
timeout: 3000,
} );
interceptCreateWebDataStreamRequest = true;
// Click on proceed button and wait for oauth request.
await expect( page ).toClick( '.mdc-dialog--open .mdc-button', {
text: /proceed/i,
} );
await page.waitForRequest( ( req ) =>
req.url().includes( 'sitekit.withgoogle.com/o/oauth2/auth' )
);
// They should end up on the dashboard.
await Promise.all( [
page.waitForNavigation(),
page.waitForSelector( '.googlesitekit-publisher-win__title' ),
] );
await expect( page ).toMatchElement(
'.googlesitekit-publisher-win__title',
{
text: /Congrats on completing the setup for Analytics!/i,
}
);
} );
} );