-
Notifications
You must be signed in to change notification settings - Fork 9.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
core(lightwallet): add timing-budget audit (#9901)
- Loading branch information
1 parent
14d62c2
commit 5f2b73e
Showing
58 changed files
with
405 additions
and
301 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| /** | ||
| * @license Copyright 2019 Google Inc. All Rights Reserved. | ||
| * 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 http://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. | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| const Audit = require('./audit.js'); | ||
| const TimingSummary = require('../computed/metrics/timing-summary.js'); | ||
| const MainResource = require('../computed/main-resource.js'); | ||
| const Budget = require('../config/budget.js'); | ||
| const i18n = require('../lib/i18n/i18n.js'); | ||
|
|
||
| const UIStrings = { | ||
| /** Title of a Lighthouse audit that compares how quickly the page loads against targets set by the user. Timing budgets are a type of performance budget. */ | ||
| title: 'Timing budget', | ||
| /** Description of a Lighthouse audit where a user sets budgets for how quickly the page loads. No character length limits. 'Learn More' becomes link text to additional documentation. */ | ||
| description: 'Set a timing budget to help you keep an eye on the performance of your site. Performant sites load fast and respond to user input events quickly. [Learn more](https://developers.google.com/web/tools/lighthouse/audits/budgets).', | ||
| /** Label for a column in a data table; entries will be the names of different timing metrics, e.g. "Time to Interactive", "First Contentful Paint", etc. */ | ||
| columnTimingMetric: 'Metric', | ||
| /** Label for a column in a data table; entries will be the measured value of a particular timing metric. Most entries will have a unit of milliseconds, but units could be other things as well. */ | ||
| columnMeasurement: 'Measurement', | ||
| }; | ||
|
|
||
| const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings); | ||
|
|
||
| /** @typedef {{metric: LH.Budget.TimingMetric, label: string, measurement?: number, overBudget?: number}} BudgetItem */ | ||
|
|
||
| class TimingBudget extends Audit { | ||
| /** | ||
| * @return {LH.Audit.Meta} | ||
| */ | ||
| static get meta() { | ||
| return { | ||
| id: 'timing-budget', | ||
| title: str_(UIStrings.title), | ||
| description: str_(UIStrings.description), | ||
| scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE, | ||
| requiredArtifacts: ['devtoolsLogs', 'traces', 'URL'], | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * @param {LH.Budget.TimingMetric} timingMetric | ||
| * @return {string} | ||
| */ | ||
| static getRowLabel(timingMetric) { | ||
| /** @type {Record<LH.Budget.TimingMetric, string>} */ | ||
| const strMappings = { | ||
| 'first-contentful-paint': i18n.UIStrings.firstContentfulPaintMetric, | ||
| 'first-cpu-idle': i18n.UIStrings.firstCPUIdleMetric, | ||
| 'interactive': i18n.UIStrings.interactiveMetric, | ||
| 'first-meaningful-paint': i18n.UIStrings.firstMeaningfulPaintMetric, | ||
| 'max-potential-fid': i18n.UIStrings.maxPotentialFIDMetric, | ||
| 'estimated-input-latency': i18n.UIStrings.estimatedInputLatencyMetric, | ||
| 'total-blocking-time': i18n.UIStrings.totalBlockingTimeMetric, | ||
| 'speed-index': i18n.UIStrings.speedIndexMetric, | ||
| }; | ||
| return str_(strMappings[timingMetric]); | ||
| } | ||
|
|
||
| /** | ||
| * @param {LH.Budget.TimingMetric} timingMetric | ||
| * @param {LH.Artifacts.TimingSummary} summary | ||
| * @return {number|undefined} | ||
| */ | ||
| static getMeasurement(timingMetric, summary) { | ||
| /** @type {Record<LH.Budget.TimingMetric, number|undefined>} */ | ||
| const measurements = { | ||
| 'first-contentful-paint': summary.firstContentfulPaint, | ||
| 'first-cpu-idle': summary.firstCPUIdle, | ||
| 'interactive': summary.interactive, | ||
| 'first-meaningful-paint': summary.firstMeaningfulPaint, | ||
| 'max-potential-fid': summary.maxPotentialFID, | ||
| 'estimated-input-latency': summary.estimatedInputLatency, | ||
| 'total-blocking-time': summary.totalBlockingTime, | ||
| 'speed-index': summary.speedIndex, | ||
| }; | ||
| return measurements[timingMetric]; | ||
| } | ||
|
|
||
| /** | ||
| * @param {LH.Budget} budget | ||
| * @param {LH.Artifacts.TimingSummary} summary | ||
| * @return {Array<BudgetItem>} | ||
| */ | ||
| static tableItems(budget, summary) { | ||
| if (!budget.timings) { | ||
| return []; | ||
| } | ||
| return budget.timings.map((timingBudget) => { | ||
| const metricName = timingBudget.metric; | ||
| const label = this.getRowLabel(metricName); | ||
| const measurement = this.getMeasurement(metricName, summary); | ||
| const overBudget = measurement && (measurement > timingBudget.budget) | ||
| ? (measurement - timingBudget.budget) : undefined; | ||
| return { | ||
| metric: metricName, | ||
| label, | ||
| measurement, | ||
| overBudget, | ||
| }; | ||
| }).sort((a, b) => { | ||
| return (b.overBudget || 0) - (a.overBudget || 0); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @param {LH.Artifacts} artifacts | ||
| * @param {LH.Audit.Context} context | ||
| * @return {Promise<LH.Audit.Product>} | ||
| */ | ||
| static async audit(artifacts, context) { | ||
| const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS]; | ||
| const trace = artifacts.traces[Audit.DEFAULT_PASS]; | ||
| const mainResource = await MainResource.request({URL: artifacts.URL, devtoolsLog}, context); | ||
| const summary = (await TimingSummary.request({trace, devtoolsLog}, context)).metrics; | ||
| const budget = Budget.getMatchingBudget(context.settings.budgets, mainResource.url); | ||
|
|
||
| if (!budget) { | ||
| return { | ||
| score: 0, | ||
| notApplicable: true, | ||
| }; | ||
| } | ||
|
|
||
| /** @type {LH.Audit.Details.Table['headings']} */ | ||
| const headers = [ | ||
| {key: 'label', itemType: 'text', text: str_(UIStrings.columnTimingMetric)}, | ||
| /** | ||
| * Note: SpeedIndex, unlike other timing metrics, is not measured in milliseconds. | ||
| * The renderer applies the correct units to the 'measurement' and 'overBudget' columns for SpeedIndex. | ||
| */ | ||
| {key: 'measurement', itemType: 'ms', text: str_(UIStrings.columnMeasurement)}, | ||
| {key: 'overBudget', itemType: 'ms', text: str_(i18n.UIStrings.columnOverBudget)}, | ||
| ]; | ||
|
|
||
| return { | ||
| details: Audit.makeTableDetails(headers, this.tableItems(budget, summary)), | ||
| score: 1, | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| module.exports = TimingBudget; | ||
| module.exports.UIStrings = UIStrings; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.