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

core(trace-elements): add sentry debugging for impactedNodes #15915

Merged
merged 4 commits into from
Apr 5, 2024
Merged

core(trace-elements): add sentry debugging for impactedNodes #15915

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c306df
core(trace-elements): add sentry debugging for `impactedNodes`
adamraine Apr 3, 2024
872c8f3
Merge branch 'main' into sentry-not-iterable
adamraine Apr 5, 2024
7ca4c30
json string
adamraine Apr 5, 2024
879b971
Merge branch 'main' into sentry-not-iterable
adamraine Apr 5, 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
2 changes: 1 addition & 1 deletion core/audits/layout-shifts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class LayoutShifts extends Audit {
.slice(0, MAX_LAYOUT_SHIFTS);
for (const event of topLayoutShiftEvents) {
const biggestImpactNodeId = TraceElements.getBiggestImpactNodeForShiftEvent(
event.args.data.impacted_nodes || [], impactByNodeId);
event.args.data.impacted_nodes || [], impactByNodeId, event);
const biggestImpactElement = traceElements.find(t => t.nodeId === biggestImpactNodeId);

// Turn root causes into sub-items.
Expand Down
35 changes: 25 additions & 10 deletions core/gather/gatherers/trace-elements.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,19 +88,34 @@ class TraceElements extends BaseGatherer {
*
* @param {LH.Artifacts.TraceImpactedNode[]} impactedNodes
* @param {Map<number, number>} impactByNodeId
* @param {import('../../lib/trace-engine.js').SaneSyntheticLayoutShift} event Only for debugging
* @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;
static getBiggestImpactNodeForShiftEvent(impactedNodes, impactByNodeId, event) {
try {
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;
} catch (err) {
// See https://github.com/GoogleChrome/lighthouse/issues/15870
// `impactedNodes` should always be an array here, but it can randomly be something else for
// currently unknown reasons. This exception handling will help us identify what
// `impactedNodes` really is and also prevent the error from being fatal.
Sentry.captureException(err, {
extra: {
impactedNodes,
Copy link
Collaborator

@connorjclark connorjclark Apr 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's possible the object can't be serialized for some reason (what if its a map), so to be safe... can you add three more fields:

let impactedNodesString = '?';
try { impactedNodesString = JSON.stringify(impactedNodes) } catch {}

const impactedNodesType = typeof impactedNodesString;

const impactedNodesClassName = impactedNodes?.constructor?.name;

(in addition to impactedNodes)

event,
},
});
return;
}
return biggestImpactNodeId;
}

/**
Expand Down Expand Up @@ -129,7 +144,7 @@ class TraceElements extends BaseGatherer {
const nodeIds = [];
const impactedNodes = event.args.data.impacted_nodes || [];
const biggestImpactedNodeId =
this.getBiggestImpactNodeForShiftEvent(impactedNodes, impactByNodeId);
this.getBiggestImpactNodeForShiftEvent(impactedNodes, impactByNodeId, event);
if (biggestImpactedNodeId !== undefined) {
nodeIds.push(biggestImpactedNodeId);
}
Expand Down
7 changes: 7 additions & 0 deletions core/test/gather/gatherers/trace-elements-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,13 @@ describe('Trace Elements gatherer - GetTopLayoutShiftElements', () => {
{nodeId: 15}, // score: 0.1
]);
});

describe('getBiggestImpactForShiftEvent', () => {
it('is non fatal if impactedNodes is not iterable', () => {
const result = TraceElementsGatherer.getBiggestImpactNodeForShiftEvent(1, new Map());
expect(result).toBeUndefined();
});
});
});

describe('Trace Elements gatherer - Animated Elements', () => {
Expand Down
Loading