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

core: set relevant metric based on insight category #16325

Merged
merged 4 commits into from
Feb 7, 2025
Merged

core: set relevant metric based on insight category #16325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0dbd30c
core: set relevant metric based on insight category
connorjclark Feb 6, 2025
d5dfe0c
sample
connorjclark Feb 6, 2025
4855bbf
need more context
connorjclark Feb 7, 2025
0e969b6
update
connorjclark Feb 7, 2025
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
13 changes: 12 additions & 1 deletion core/audits/insights/insight-audit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,22 @@ async function adaptInsightToAuditProduct(artifacts, context, insightName, creat
};
}

// This hack is to add metric adorners if an insight category links it to a metric,
// but doesn't output a metric savings for that metric.
let metricSavings = insight.metricSavings;
if (insight.category === 'INP' && !metricSavings?.INP) {
metricSavings = {...metricSavings, INP: /** @type {any} */ (0)};
} else if (insight.category === 'CLS' && !metricSavings?.CLS) {
metricSavings = {...metricSavings, CLS: /** @type {any} */ (0)};
} else if (insight.category === 'LCP' && !metricSavings?.LCP) {
metricSavings = {...metricSavings, LCP: /** @type {any} */ (0)};
}

return {
scoreDisplayMode:
insight.metricSavings ? Audit.SCORING_MODES.METRIC_SAVINGS : Audit.SCORING_MODES.NUMERIC,
score: insight.shouldShow ? 0 : 1,
metricSavings: insight.metricSavings,
metricSavings,
warnings: insight.warnings,
details,
};
Expand Down
2 changes: 1 addition & 1 deletion core/scripts/assert-golden-lhr-unchanged.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ node "$pwd/cleanup-LHR-for-diff.js" "$goldenLHRPath"
node "$pwd/cleanup-LHR-for-diff.js" "$freshLHRPath"

colorText "Diff'ing golden LHR against the fresh LHR" "$purple"
git --no-pager diff --color=always --no-index "$goldenLHRPath" "$freshLHRPath"
git --no-pager diff -U30 --color=always --no-index "$goldenLHRPath" "$freshLHRPath"

# Use the return value from last command
retVal=$?
Expand Down
24 changes: 24 additions & 0 deletions core/test/fixtures/user-flows/reports/sample-flow-result.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3879,6 +3879,9 @@
"description": "A large DOM can increase the duration of style calculations and layout reflows, impacting page responsiveness. A large DOM will also increase memory usage. [Learn how to avoid an excessive DOM size](https://developer.chrome.com/docs/lighthouse/performance/dom-size/).",
"score": 1,
"scoreDisplayMode": "numeric",
"metricSavings": {
"INP": 0
},
"details": {
"type": "table",
"headings": [
Expand Down Expand Up @@ -3965,6 +3968,9 @@
"description": "Optimize LCP by making the LCP image [discoverable](https://web.dev/articles/optimize-lcp#1_eliminate_resource_load_delay) from the HTML immediately, and [avoiding lazy-loading](https://web.dev/articles/lcp-lazy-loading)",
"score": 0,
"scoreDisplayMode": "numeric",
"metricSavings": {
"LCP": 0
},
"details": {
"type": "checklist",
"items": {
Expand Down Expand Up @@ -4030,6 +4036,9 @@
"description": "Tap interactions may be [delayed by up to 300 ms](https://developer.chrome.com/blog/300ms-tap-delay-gone-away/) if the viewport is not optimized for mobile.",
"score": 1,
"scoreDisplayMode": "numeric",
"metricSavings": {
"INP": 0
},
"details": {
"type": "table",
"headings": [
Expand Down Expand Up @@ -11056,6 +11065,9 @@
"description": "A large DOM can increase the duration of style calculations and layout reflows, impacting page responsiveness. A large DOM will also increase memory usage. [Learn how to avoid an excessive DOM size](https://developer.chrome.com/docs/lighthouse/performance/dom-size/).",
"score": 1,
"scoreDisplayMode": "numeric",
"metricSavings": {
"INP": 0
},
"details": {
"type": "table",
"headings": [
Expand Down Expand Up @@ -11190,6 +11202,9 @@
"description": "Tap interactions may be [delayed by up to 300 ms](https://developer.chrome.com/blog/300ms-tap-delay-gone-away/) if the viewport is not optimized for mobile.",
"score": 1,
"scoreDisplayMode": "numeric",
"metricSavings": {
"INP": 0
},
"details": {
"type": "table",
"headings": [
Expand Down Expand Up @@ -22610,6 +22625,9 @@
"description": "A large DOM can increase the duration of style calculations and layout reflows, impacting page responsiveness. A large DOM will also increase memory usage. [Learn how to avoid an excessive DOM size](https://developer.chrome.com/docs/lighthouse/performance/dom-size/).",
"score": 1,
"scoreDisplayMode": "numeric",
"metricSavings": {
"INP": 0
},
"details": {
"type": "table",
"headings": [
Expand Down Expand Up @@ -22696,6 +22714,9 @@
"description": "Optimize LCP by making the LCP image [discoverable](https://web.dev/articles/optimize-lcp#1_eliminate_resource_load_delay) from the HTML immediately, and [avoiding lazy-loading](https://web.dev/articles/lcp-lazy-loading)",
"score": 0,
"scoreDisplayMode": "numeric",
"metricSavings": {
"LCP": 0
},
"details": {
"type": "checklist",
"items": {
Expand Down Expand Up @@ -22761,6 +22782,9 @@
"description": "Tap interactions may be [delayed by up to 300 ms](https://developer.chrome.com/blog/300ms-tap-delay-gone-away/) if the viewport is not optimized for mobile.",
"score": 1,
"scoreDisplayMode": "numeric",
"metricSavings": {
"INP": 0
},
"details": {
"type": "table",
"headings": [
Expand Down
6 changes: 6 additions & 0 deletions core/test/results/sample_v2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5874,6 +5874,9 @@
"description": "A large DOM can increase the duration of style calculations and layout reflows, impacting page responsiveness. A large DOM will also increase memory usage. [Learn how to avoid an excessive DOM size](https://developer.chrome.com/docs/lighthouse/performance/dom-size/).",
"score": 1,
"scoreDisplayMode": "numeric",
"metricSavings": {
"INP": 0
},
"details": {
"type": "table",
"headings": [
Expand Down Expand Up @@ -5960,6 +5963,9 @@
"description": "Optimize LCP by making the LCP image [discoverable](https://web.dev/articles/optimize-lcp#1_eliminate_resource_load_delay) from the HTML immediately, and [avoiding lazy-loading](https://web.dev/articles/lcp-lazy-loading)",
"score": 0,
"scoreDisplayMode": "numeric",
"metricSavings": {
"LCP": 0
},
"details": {
"type": "checklist",
"items": {
Expand Down