Skip to content

core(trace-elements): remove sentry debugging for invalid impactedNodes #16523

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

Merged
connorjclark merged 1 commit into from
Jun 4, 2025
Merged

core(trace-elements): remove sentry debugging for invalid impactedNodes #16523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/insights/cls-culprits-insight.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ class CLSCulpritsInsight extends Audit {
/** @type {LH.Audit.Details.Table['items']} */
const items = events.map(event => {
const biggestImpactNodeId = TraceElements.getBiggestImpactNodeForShiftEvent(
event.args.data.impacted_nodes || [], impactByNodeId, event);
event.args.data.impacted_nodes || [], impactByNodeId);
return {
node: makeNodeItemForNodeId(artifacts.TraceElements, biggestImpactNodeId),
score: event.args.data?.weighted_score_delta,
Expand Down
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 @@ -89,7 +89,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);
event.args.data.impacted_nodes || [], impactByNodeId);
const biggestImpactElement = traceElements.find(t => t.nodeId === biggestImpactNodeId);

// Turn root causes into sub-items.
Expand Down
50 changes: 10 additions & 40 deletions core/gather/gatherers/trace-elements.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,49 +152,19 @@ 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, 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;
}
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;
} 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.

// It's possible `impactedNodes` is not JSON serializable, so let's add more supplemental
// fields just in case.
const impactedNodesType = typeof impactedNodes;
const impactedNodesClassName = impactedNodes?.constructor?.name;

let impactedNodesJson;
let eventJson;
try {
impactedNodesJson = JSON.parse(JSON.stringify(impactedNodes));
eventJson = JSON.parse(JSON.stringify(event));
} catch {}

Sentry.captureException(err, {
extra: {
impactedNodes: impactedNodesJson,
event: eventJson,
impactedNodesType,
impactedNodesClassName,
},
});
return;
}
return biggestImpactNodeId;
}

/**
Expand Down Expand Up @@ -222,7 +192,7 @@ class TraceElements extends BaseGatherer {
const nodeIds = [];
const impactedNodes = event.args.data.impacted_nodes || [];
const biggestImpactedNodeId =
this.getBiggestImpactNodeForShiftEvent(impactedNodes, impactByNodeId, event);
this.getBiggestImpactNodeForShiftEvent(impactedNodes, impactByNodeId);
if (biggestImpactedNodeId !== undefined) {
nodeIds.push(biggestImpactedNodeId);
}
Expand Down
6 changes: 2 additions & 4 deletions core/runner.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,10 +312,8 @@ class Runner {
if (!isEqual(normalizedGatherSettings[k], normalizedAuditSettings[k])) {
throw new Error(
`Cannot change settings between gathering and auditing…
Difference found at: \`${k}\`
${normalizedGatherSettings[k]}
vs
${normalizedAuditSettings[k]}`);
Difference found at: \`${k}\`: ${JSON.stringify(normalizedGatherSettings[k], null, 2)}
vs: ${JSON.stringify(normalizedAuditSettings[k], null, 2)}`);
}
Copy link
Collaborator Author

@connorjclark connorjclark Jun 4, 2025

Choose a reason for hiding this comment

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

drive by improvement here... was printing [Object] when throttling settings differed

}

Expand Down
9 changes: 0 additions & 9 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 @@ -72,15 +72,6 @@ function makeLCPTraceEvent(nodeId) {
};
}

describe('Trace Elements gatherer - GetTopLayoutShifts', () => {
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', () => {
it('gets animated node ids with non-composited animations', async () => {
const traceEvents = [
Expand Down