-
Notifications
You must be signed in to change notification settings - Fork 9.4k
/
trace-elements.js
354 lines (312 loc) · 12.4 KB
/
trace-elements.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
/**
* @license
* Copyright 2020 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/* global getNodeDetails */
/**
* @fileoverview
* This gatherer identifies elements that contribrute to metrics in the trace (LCP, CLS, etc.).
* We take the backend nodeId from the trace and use it to find the corresponding element in the DOM.
*/
import BaseGatherer from '../base-gatherer.js';
import {resolveNodeIdToObjectId} from '../driver/dom.js';
import {pageFunctions} from '../../lib/page-functions.js';
import {Sentry} from '../../lib/sentry.js';
import Trace from './trace.js';
import {ProcessedTrace} from '../../computed/processed-trace.js';
import {ProcessedNavigation} from '../../computed/processed-navigation.js';
import {LighthouseError} from '../../lib/lh-error.js';
import {Responsiveness} from '../../computed/metrics/responsiveness.js';
import {CumulativeLayoutShift} from '../../computed/metrics/cumulative-layout-shift.js';
import {ExecutionContext} from '../driver/execution-context.js';
import RootCauses from './root-causes.js';
import {TraceEngineResult} from '../../computed/trace-engine-result.js';
/** @typedef {{nodeId: number, animations?: {name?: string, failureReasonsMask?: number, unsupportedProperties?: string[]}[], type?: string}} TraceElementData */
const MAX_LAYOUT_SHIFT_ELEMENTS = 15;
const MAX_LAYOUT_SHIFTS = 15;
/**
* @this {HTMLElement}
*/
/* c8 ignore start */
function getNodeDetailsData() {
const elem = this.nodeType === document.ELEMENT_NODE ? this : this.parentElement; // eslint-disable-line no-undef
let traceElement;
if (elem) {
// @ts-expect-error - getNodeDetails put into scope via stringification
traceElement = {node: getNodeDetails(elem)};
}
return traceElement;
}
/* c8 ignore stop */
class TraceElements extends BaseGatherer {
/** @type {LH.Gatherer.GathererMeta<'Trace'|'RootCauses'>} */
meta = {
supportedModes: ['timespan', 'navigation'],
dependencies: {Trace: Trace.symbol, RootCauses: RootCauses.symbol},
};
/** @type {Map<string, string>} */
animationIdToName = new Map();
constructor() {
super();
this._onAnimationStarted = this._onAnimationStarted.bind(this);
}
/** @param {LH.Crdp.Animation.AnimationStartedEvent} args */
_onAnimationStarted({animation: {id, name}}) {
if (name) this.animationIdToName.set(id, name);
}
/**
* This function finds the top (up to 15) elements that shift on the page.
*
* @param {LH.Trace} trace
* @param {LH.Gatherer.Context} context
* @return {Promise<Array<{nodeId: number}>>}
*/
static async getTopLayoutShiftElements(trace, context) {
const {impactByNodeId} = await CumulativeLayoutShift.request(trace, context);
return [...impactByNodeId.entries()]
.sort((a, b) => b[1] - a[1])
.slice(0, MAX_LAYOUT_SHIFT_ELEMENTS)
.map(([nodeId]) => ({nodeId}));
}
/**
* We want to a single representative node to represent the shift, so let's pick
* the one with the largest impact (size x distance moved).
*
* @param {LH.Artifacts.TraceImpactedNode[]} impactedNodes
* @param {Map<number, number>} impactByNodeId
* @return {number|undefined}
*/
static getBiggestImpactNodeForShiftEvent(impactedNodes, impactByNodeId) {
let biggestImpactNodeId;
let biggestImpactNodeScore = Number.NEGATIVE_INFINITY;
for (const node of impactedNodes) {
const impactScore = impactByNodeId.get(node.node_id);
if (impactScore !== undefined && impactScore > biggestImpactNodeScore) {
biggestImpactNodeId = node.node_id;
biggestImpactNodeScore = impactScore;
}
}
return biggestImpactNodeId;
}
/**
* This function finds the top (up to 15) layout shifts on the page, and returns
* the id of the largest impacted node of each shift, along with any related nodes
* that may have caused the shift.
*
* @param {LH.Trace} trace
* @param {LH.Artifacts.TraceEngineResult} traceEngineResult
* @param {LH.Artifacts.TraceEngineRootCauses} rootCauses
* @param {LH.Gatherer.Context} context
* @return {Promise<Array<{nodeId: number}>>}
*/
static async getTopLayoutShifts(trace, traceEngineResult, rootCauses, context) {
const {impactByNodeId} = await CumulativeLayoutShift.request(trace, context);
const clusters = traceEngineResult.LayoutShifts.clusters ?? [];
const layoutShiftEvents =
/** @type {import('../../lib/trace-engine.js').SaneSyntheticLayoutShift[]} */(
clusters.flatMap(c => c.events)
);
return layoutShiftEvents
.sort((a, b) => b.args.data.weighted_score_delta - a.args.data.weighted_score_delta)
.slice(0, MAX_LAYOUT_SHIFTS)
.flatMap(event => {
const nodeIds = [];
const impactedNodes = event.args.data.impacted_nodes || [];
const biggestImpactedNodeId =
this.getBiggestImpactNodeForShiftEvent(impactedNodes, impactByNodeId);
if (biggestImpactedNodeId !== undefined) {
nodeIds.push(biggestImpactedNodeId);
}
const index = layoutShiftEvents.indexOf(event);
const shiftRootCauses = rootCauses.layoutShifts[index];
if (shiftRootCauses) {
for (const cause of shiftRootCauses.unsizedMedia) {
nodeIds.push(cause.node.backendNodeId);
}
}
return nodeIds.map(nodeId => ({nodeId}));
});
}
/**
* @param {LH.Trace} trace
* @param {LH.Gatherer.Context} context
* @return {Promise<TraceElementData|undefined>}
*/
static async getResponsivenessElement(trace, context) {
const {settings} = context;
try {
const responsivenessEvent = await Responsiveness.request({trace, settings}, context);
if (!responsivenessEvent) return;
return {nodeId: responsivenessEvent.args.data.nodeId};
} catch {
// Don't let responsiveness errors sink the rest of the gatherer.
return;
}
}
/**
* Find the node ids of elements which are animated using the Animation trace events.
* @param {Array<LH.TraceEvent>} mainThreadEvents
* @return {Promise<Array<TraceElementData>>}
*/
async getAnimatedElements(mainThreadEvents) {
/** @type {Map<string, {begin: LH.TraceEvent | undefined, status: LH.TraceEvent | undefined}>} */
const animationPairs = new Map();
for (const event of mainThreadEvents) {
if (event.name !== 'Animation') continue;
if (!event.id2 || !event.id2.local) continue;
const local = event.id2.local;
const pair = animationPairs.get(local) || {begin: undefined, status: undefined};
if (event.ph === 'b') {
pair.begin = event;
} else if (
event.ph === 'n' &&
event.args.data &&
event.args.data.compositeFailed !== undefined) {
pair.status = event;
}
animationPairs.set(local, pair);
}
/** @type {Map<number, Set<{animationId: string, failureReasonsMask?: number, unsupportedProperties?: string[]}>>} */
const elementAnimations = new Map();
for (const {begin, status} of animationPairs.values()) {
const nodeId = begin?.args?.data?.nodeId;
const animationId = begin?.args?.data?.id;
const failureReasonsMask = status?.args?.data?.compositeFailed;
const unsupportedProperties = status?.args?.data?.unsupportedProperties;
if (!nodeId || !animationId) continue;
const animationIds = elementAnimations.get(nodeId) || new Set();
animationIds.add({animationId, failureReasonsMask, unsupportedProperties});
elementAnimations.set(nodeId, animationIds);
}
/** @type {Array<TraceElementData>} */
const animatedElementData = [];
for (const [nodeId, animationIds] of elementAnimations) {
const animations = [];
for (const {animationId, failureReasonsMask, unsupportedProperties} of animationIds) {
const animationName = this.animationIdToName.get(animationId);
animations.push({name: animationName, failureReasonsMask, unsupportedProperties});
}
animatedElementData.push({nodeId, animations});
}
return animatedElementData;
}
/**
* @param {LH.Trace} trace
* @param {LH.Gatherer.Context} context
* @return {Promise<{nodeId: number, type: string} | undefined>}
*/
static async getLcpElement(trace, context) {
let processedNavigation;
try {
processedNavigation = await ProcessedNavigation.request(trace, context);
} catch (err) {
// If we were running in timespan mode and there was no paint, treat LCP as missing.
if (context.gatherMode === 'timespan' && err.code === LighthouseError.errors.NO_FCP.code) {
return;
}
throw err;
}
// Use main-frame-only LCP to match the metric value.
const lcpData = processedNavigation.largestContentfulPaintEvt?.args?.data;
// These should exist, but trace types are loose.
if (lcpData?.nodeId === undefined || !lcpData.type) return;
return {
nodeId: lcpData.nodeId,
type: lcpData.type,
};
}
/**
* @param {LH.Gatherer.Context} context
*/
async startInstrumentation(context) {
await context.driver.defaultSession.sendCommand('Animation.enable');
context.driver.defaultSession.on('Animation.animationStarted', this._onAnimationStarted);
}
/**
* @param {LH.Gatherer.Context} context
*/
async stopInstrumentation(context) {
context.driver.defaultSession.off('Animation.animationStarted', this._onAnimationStarted);
await context.driver.defaultSession.sendCommand('Animation.disable');
}
/**
* @param {LH.Gatherer.ProtocolSession} session
* @param {number} backendNodeId
*/
async getNodeDetails(session, backendNodeId) {
try {
const objectId = await resolveNodeIdToObjectId(session, backendNodeId);
if (!objectId) return null;
const deps = ExecutionContext.serializeDeps([
pageFunctions.getNodeDetails,
getNodeDetailsData,
]);
return await session.sendCommand('Runtime.callFunctionOn', {
objectId,
functionDeclaration: `function () {
${deps}
return getNodeDetailsData.call(this);
}`,
returnByValue: true,
awaitPromise: true,
});
} catch (err) {
Sentry.captureException(err, {
tags: {gatherer: 'TraceElements'},
level: 'error',
});
}
return null;
}
/**
* @param {LH.Gatherer.Context<'Trace'|'RootCauses'>} context
* @return {Promise<LH.Artifacts.TraceElement[]>}
*/
async getArtifact(context) {
const session = context.driver.defaultSession;
const trace = context.dependencies.Trace;
const traceEngineResult = await TraceEngineResult.request({trace}, context);
const rootCauses = context.dependencies.RootCauses;
const processedTrace = await ProcessedTrace.request(trace, context);
const {mainThreadEvents} = processedTrace;
const lcpNodeData = await TraceElements.getLcpElement(trace, context);
const shiftElementsNodeData = await TraceElements.getTopLayoutShiftElements(trace, context);
const shiftsData = await TraceElements.getTopLayoutShifts(
trace, traceEngineResult, rootCauses, context);
const animatedElementData = await this.getAnimatedElements(mainThreadEvents);
const responsivenessElementData = await TraceElements.getResponsivenessElement(trace, context);
/** @type {Map<string, TraceElementData[]>} */
const backendNodeDataMap = new Map([
['largest-contentful-paint', lcpNodeData ? [lcpNodeData] : []],
['layout-shift-element', shiftElementsNodeData],
['layout-shift', shiftsData],
['animation', animatedElementData],
['responsiveness', responsivenessElementData ? [responsivenessElementData] : []],
]);
/** @type {Map<number, LH.Crdp.Runtime.CallFunctionOnResponse | null>} */
const callFunctionOnCache = new Map();
const traceElements = [];
for (const [traceEventType, backendNodeData] of backendNodeDataMap) {
for (let i = 0; i < backendNodeData.length; i++) {
const backendNodeId = backendNodeData[i].nodeId;
let response = callFunctionOnCache.get(backendNodeId);
if (response === undefined) {
response = await this.getNodeDetails(session, backendNodeId);
callFunctionOnCache.set(backendNodeId, response);
}
if (response?.result?.value) {
traceElements.push({
traceEventType,
...response.result.value,
animations: backendNodeData[i].animations,
nodeId: backendNodeId,
type: backendNodeData[i].type,
});
}
}
}
return traceElements;
}
}
export default TraceElements;