-
Notifications
You must be signed in to change notification settings - Fork 414
/
onFID-test.js
300 lines (225 loc) · 9.07 KB
/
onFID-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
/*
* Copyright 2020 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.
*/
import assert from 'assert';
import {beaconCountIs, clearBeacons, getBeacons} from '../utils/beacons.js';
import {browserSupportsEntry} from '../utils/browserSupportsEntry.js';
import {domReadyState} from '../utils/domReadyState.js';
import {stubForwardBack} from '../utils/stubForwardBack.js';
import {stubVisibilityChange} from '../utils/stubVisibilityChange.js';
describe('onFID()', async function() {
// Retry all tests in this suite up to 2 times.
this.retries(2);
let browserSupportsFID;
before(async function() {
browserSupportsFID = await browserSupportsEntry('first-input');
});
beforeEach(async function() {
await clearBeacons();
});
it('reports the correct value after input', async function() {
if (!browserSupportsFID) this.skip();
await browser.url('/test/fid');
// Click on the <h1>.
const h1 = await $('h1');
await h1.click();
await beaconCountIs(1);
const [fid] = await getBeacons();
assert(fid.value >= 0);
assert(fid.id.match(/^v3-\d+-\d+$/));
assert.strictEqual(fid.name, 'FID');
assert.strictEqual(fid.value, fid.delta);
assert.strictEqual(fid.rating, 'good');
assert.match(fid.navigationType, /navigate|reload/);
assert.match(fid.entries[0].name, /(mouse|pointer)down/);
});
it('does not report if the browser does not support FID and the polyfill is not used', async function() {
if (browserSupportsFID) this.skip();
await browser.url('/test/fid');
// Click on the <h1>.
const h1 = await $('h1');
await h1.click();
// Wait a bit to ensure no beacons were sent.
await browser.pause(1000);
const loadBeacons = await getBeacons();
assert.strictEqual(loadBeacons.length, 0);
await stubForwardBack();
// Assert no entries after bfcache restores either (if the browser does
// not support native FID and the polyfill is not used).
await h1.click();
// Wait a bit to ensure no beacons were sent.
await browser.pause(1000);
const bfcacheRestoreBeacons = await getBeacons();
assert.strictEqual(bfcacheRestoreBeacons.length, 0);
});
it('falls back to the polyfill in non-supporting browsers', async function() {
// Ignore Safari until this bug is fixed:
// https://bugs.webkit.org/show_bug.cgi?id=211101
if (browser.capabilities.browserName === 'Safari') this.skip();
await browser.url('/test/fid?polyfill=1');
// Click on the <h1>.
const h1 = await $('h1');
await h1.click();
await beaconCountIs(1);
const [fid] = await getBeacons();
assert(fid.value >= 0);
assert(fid.id.match(/^v3-\d+-\d+$/));
assert.strictEqual(fid.name, 'FID');
assert.strictEqual(fid.value, fid.delta);
assert.strictEqual(fid.rating, 'good');
assert.match(fid.navigationType, /navigate|reload/);
assert.match(fid.entries[0].name, /(mouse|pointer)down/);
if (browserSupportsFID) {
assert('duration' in fid.entries[0]);
} else {
assert(!('duration' in fid.entries[0]));
}
});
it('does not report if the document was hidden at page load time', async function() {
// Ignore Safari until this bug is fixed:
// https://bugs.webkit.org/show_bug.cgi?id=211101
if (browser.capabilities.browserName === 'Safari') this.skip();
await browser.url('/test/fid?hidden=1');
await domReadyState('interactive');
await stubVisibilityChange('visible');
// Click on the <h1>.
const h1 = await $('h1');
await h1.click();
// Wait a bit to ensure no beacons were sent.
await browser.pause(1000);
const beacons = await getBeacons();
assert.strictEqual(beacons.length, 0);
});
it('does not report if the document changes to hidden before the first input', async function() {
// Ignore Safari until this bug is fixed:
// https://bugs.webkit.org/show_bug.cgi?id=211101
if (browser.capabilities.browserName === 'Safari') this.skip();
await stubVisibilityChange('hidden');
// Returning to visible will also render the <body>.
await stubVisibilityChange('visible');
// Click on the h1.
const h1 = await $('h1');
await h1.click();
// Wait a bit to ensure no beacons were sent.
await browser.pause(1000);
const beacons = await getBeacons();
assert.strictEqual(beacons.length, 0);
});
it('reports the first input delay after bfcache restores', async function() {
if (!browserSupportsFID) this.skip();
await browser.url('/test/fid');
// Click on the <h1>.
const h1 = await $('h1');
await h1.click();
await beaconCountIs(1);
const [fid1] = await getBeacons();
assert(fid1.value >= 0);
assert(fid1.id.match(/^v3-\d+-\d+$/));
assert.strictEqual(fid1.name, 'FID');
assert.strictEqual(fid1.value, fid1.delta);
assert.strictEqual(fid1.rating, 'good');
assert.match(fid1.navigationType, /navigate|reload/);
assert.match(fid1.entries[0].name, /(mouse|pointer)down/);
await clearBeacons();
await stubForwardBack();
// Click on the <h1>.
await h1.click();
await beaconCountIs(1);
const [fid2] = await getBeacons();
assert(fid2.value >= 0);
assert(fid2.id.match(/^v3-\d+-\d+$/));
assert(fid1.id !== fid2.id);
assert.strictEqual(fid2.name, 'FID');
assert.strictEqual(fid2.rating, 'good');
assert.strictEqual(fid2.value, fid2.delta);
assert.strictEqual(fid2.navigationType, 'back-forward-cache');
assert.match(fid2.entries[0].name, /(mouse|pointer)down/);
});
it('reports prerender as nav type for prerender', async function() {
if (!browserSupportsFID) this.skip();
await browser.url('/test/fid?prerender=1');
// Click on the <h1>.
const h1 = await $('h1');
await h1.click();
await beaconCountIs(1);
const [fid] = await getBeacons();
assert(fid.value >= 0);
assert(fid.id.match(/^v3-\d+-\d+$/));
assert.strictEqual(fid.name, 'FID');
assert.strictEqual(fid.value, fid.delta);
assert.strictEqual(fid.rating, 'good');
assert.strictEqual(fid.navigationType, 'prerender');
assert.match(fid.entries[0].name, /(mouse|pointer)down/);
});
it('reports restore as nav type for wasDiscarded', async function() {
if (!browserSupportsFID) this.skip();
await browser.url('/test/fid?wasDiscarded=1');
// Click on the <h1>.
const h1 = await $('h1');
await h1.click();
await beaconCountIs(1);
const [fid] = await getBeacons();
assert(fid.value >= 0);
assert(fid.id.match(/^v3-\d+-\d+$/));
assert.strictEqual(fid.name, 'FID');
assert.strictEqual(fid.value, fid.delta);
assert.strictEqual(fid.rating, 'good');
assert.strictEqual(fid.navigationType, 'restore');
assert.match(fid.entries[0].name, /(mouse|pointer)down/);
});
describe('attribution', function() {
it('includes attribution data on the metric object', async function() {
if (!browserSupportsFID) this.skip();
await browser.url('/test/fid?attribution=1');
// Click on the <h1>.
const h1 = await $('h1');
await h1.click();
await beaconCountIs(1);
const [fid] = await getBeacons();
assert(fid.value >= 0);
assert(fid.id.match(/^v3-\d+-\d+$/));
assert.strictEqual(fid.name, 'FID');
assert.strictEqual(fid.value, fid.delta);
assert.strictEqual(fid.rating, 'good');
assert.match(fid.navigationType, /navigate|reload/);
assert.match(fid.entries[0].name, /(mouse|pointer)down/);
// This value is frequently not set in Chrome for some reason,
// so just check that it's a string.
assert(typeof fid.attribution.eventTarget === 'string');
assert.equal(fid.attribution.eventTime, fid.entries[0].startTime);
assert.equal(fid.attribution.eventType, fid.entries[0].name);
assert.deepEqual(fid.attribution.eventEntry, fid.entries[0]);
assert.equal(fid.attribution.loadState, 'complete');
});
it('reports the domReadyState when input occurred', async function() {
if (!browserSupportsFID) this.skip();
await browser.url('/test/fid?attribution=1&delayDCL=1000');
// Click on the <h1>.
const h1 = await $('h1');
await h1.click();
await beaconCountIs(1);
const [fid1] = await getBeacons();
assert.equal(fid1.attribution.loadState, 'dom-interactive');
await clearBeacons();
await browser.url('/test/fid?attribution=1&delayResponse=1000');
// Click on the <h1>.
const p = await $('p');
await p.click();
await beaconCountIs(1);
const [fid2] = await getBeacons();
assert.equal(fid2.attribution.loadState, 'loading');
});
});
});