lighthouse 9.5.0 → 9.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/changelog.md +70 -0
  2. package/dist/report/bundle.esm.js +23 -366
  3. package/dist/report/flow.js +20 -25
  4. package/dist/report/standalone.js +17 -22
  5. package/lighthouse-cli/test/smokehouse/core-tests.js +2 -0
  6. package/lighthouse-cli/test/smokehouse/frontends/lib.js +1 -3
  7. package/lighthouse-cli/test/smokehouse/frontends/smokehouse-bin.js +1 -3
  8. package/lighthouse-cli/test/smokehouse/lighthouse-runners/cli.js +1 -0
  9. package/lighthouse-cli/test/smokehouse/readme.md +5 -4
  10. package/lighthouse-cli/test/smokehouse/report-assert.js +16 -13
  11. package/lighthouse-cli/test/smokehouse/version-check-test.js +46 -0
  12. package/lighthouse-cli/test/smokehouse/version-check.js +49 -0
  13. package/lighthouse-core/audits/bootup-time.js +2 -70
  14. package/lighthouse-core/audits/byte-efficiency/duplicated-javascript.js +3 -5
  15. package/lighthouse-core/audits/byte-efficiency/legacy-javascript.js +2 -5
  16. package/lighthouse-core/audits/byte-efficiency/unminified-javascript.js +4 -2
  17. package/lighthouse-core/audits/byte-efficiency/unused-javascript.js +3 -1
  18. package/lighthouse-core/audits/deprecations.js +603 -28
  19. package/lighthouse-core/audits/installable-manifest.js +27 -6
  20. package/lighthouse-core/audits/long-tasks.js +3 -3
  21. package/lighthouse-core/audits/metrics/experimental-interaction-to-next-paint.js +88 -0
  22. package/lighthouse-core/audits/third-party-summary.js +3 -3
  23. package/lighthouse-core/audits/work-during-interaction.js +280 -0
  24. package/lighthouse-core/computed/metrics/responsiveness.js +157 -0
  25. package/lighthouse-core/config/config-helpers.js +1 -1
  26. package/lighthouse-core/config/metrics-to-audits.js +5 -0
  27. package/lighthouse-core/fraggle-rock/config/default-config.js +9 -1
  28. package/lighthouse-core/fraggle-rock/gather/base-artifacts.js +2 -2
  29. package/lighthouse-core/fraggle-rock/gather/session.js +8 -2
  30. package/lighthouse-core/gather/gather-runner.js +2 -4
  31. package/lighthouse-core/gather/gatherers/css-usage.js +59 -34
  32. package/lighthouse-core/gather/gatherers/trace-elements.js +21 -2
  33. package/lighthouse-core/lib/arbitrary-equality-map.js +2 -2
  34. package/lighthouse-core/lib/i18n/i18n.js +2 -0
  35. package/lighthouse-core/lib/minify-trace.js +2 -0
  36. package/lighthouse-core/lib/script-helpers.js +24 -0
  37. package/lighthouse-core/lib/stack-packs.js +8 -5
  38. package/lighthouse-core/lib/tracehouse/task-groups.js +1 -0
  39. package/lighthouse-core/lib/tracehouse/task-summary.js +87 -0
  40. package/lighthouse-core/lib/tracehouse/trace-processor.js +39 -14
  41. package/lighthouse-core/runner.js +1 -1
  42. package/package.json +10 -8
  43. package/report/assets/styles.css +5 -2
  44. package/report/clients/bundle.js +1 -0
  45. package/report/renderer/components.js +1 -1
  46. package/report/renderer/details-renderer.js +4 -4
  47. package/report/renderer/performance-category-renderer.js +15 -11
  48. package/report/test/renderer/__snapshots__/report-renderer-axe-test.js.snap +6 -98
  49. package/report/test/renderer/details-renderer-test.js +9 -9
  50. package/report/test/renderer/performance-category-renderer-test.js +31 -0
  51. package/report/test/renderer/report-renderer-axe-test.js +3 -15
  52. package/report/test-assets/faux-psi-template.html +3 -2
  53. package/report/test-assets/faux-psi.js +22 -1
  54. package/shared/localization/locales/en-US.json +244 -4
  55. package/shared/localization/locales/en-XL.json +244 -4
  56. package/shared/localization/swap-locale.js +2 -1
  57. package/third-party/chromium-synchronization/installability-errors-test.js +1 -0
  58. package/third-party/snyk/snapshot.json +2 -3
  59. package/tsconfig.json +1 -0
  60. package/types/artifacts.d.ts +40 -1
  61. package/types/lhr/audit-details.d.ts +3 -1
  62. package/types/smokehouse.d.ts +1 -1
@@ -97,6 +97,11 @@ const UIStrings = {
97
97
  'protocol-timeout': `Lighthouse could not determine if there was a service worker. Please try with a newer version of Chrome.`,
98
98
  /** Message logged when the web app has been uninstalled o desktop, signalling that the install banner state is being reset. */
99
99
  'pipeline-restarted': 'PWA has been uninstalled and installability checks resetting.',
100
+ /**
101
+ * @description Error message explaining that the URL of the manifest uses a scheme that is not supported on Android.
102
+ * @example {data:} scheme
103
+ */
104
+ 'scheme-not-supported-for-webapk': 'The manifest URL scheme ({scheme}) is not supported on Android.',
100
105
  };
101
106
  /* eslint-enable max-len */
102
107
 
@@ -125,7 +130,7 @@ class InstallableManifest extends Audit {
125
130
  failureTitle: str_(UIStrings.failureTitle),
126
131
  description: str_(UIStrings.description),
127
132
  supportedModes: ['navigation'],
128
- requiredArtifacts: ['URL', 'WebAppManifest', 'InstallabilityErrors'],
133
+ requiredArtifacts: ['WebAppManifest', 'InstallabilityErrors'],
129
134
  };
130
135
  }
131
136
 
@@ -156,6 +161,17 @@ class InstallableManifest extends Audit {
156
161
  // @ts-expect-error errorIds from protocol should match up against the strings dict
157
162
  const matchingString = UIStrings[err.errorId];
158
163
 
164
+ if (err.errorId === 'scheme-not-supported-for-webapk') {
165
+ // If there was no manifest, then there will be at lest one other installability error.
166
+ // We can ignore this error if that's the case.
167
+ const manifestUrl = artifacts.WebAppManifest?.url;
168
+ if (!manifestUrl) continue;
169
+
170
+ const scheme = new URL(manifestUrl).protocol;
171
+ i18nErrors.push(str_(matchingString, {scheme}));
172
+ continue;
173
+ }
174
+
159
175
  // Handle an errorId we don't recognize.
160
176
  if (matchingString === undefined) {
161
177
  i18nErrors.push(str_(UIStrings.noErrorId, {errorId: err.errorId}));
@@ -195,7 +211,6 @@ class InstallableManifest extends Audit {
195
211
  *
196
212
  */
197
213
  static async audit(artifacts, context) {
198
- const manifestValues = await ManifestValues.request(artifacts, context);
199
214
  const {i18nErrors, warnings} = InstallableManifest.getInstallabilityErrors(artifacts);
200
215
 
201
216
  const manifestUrl = artifacts.WebAppManifest ? artifacts.WebAppManifest.url : null;
@@ -210,10 +225,16 @@ class InstallableManifest extends Audit {
210
225
  const errorReasons = i18nErrors.map(reason => {
211
226
  return {reason};
212
227
  });
213
- /** DevTools InstallabilityErrors does not emit an error unless there is a manifest, so include manifestValues's error */
214
- if (manifestValues.isParseFailure) {
215
- errorReasons.push({
216
- reason: manifestValues.parseFailureReason});
228
+
229
+ // If InstallabilityErrors is empty, double check ManifestValues to make sure nothing was missed.
230
+ // InstallabilityErrors can be empty erroneously in our DevTools web tests.
231
+ if (!errorReasons.length) {
232
+ const manifestValues = await ManifestValues.request(artifacts, context);
233
+ if (manifestValues.isParseFailure) {
234
+ errorReasons.push({
235
+ reason: manifestValues.parseFailureReason,
236
+ });
237
+ }
217
238
  }
218
239
 
219
240
  // Include the detailed pass/fail checklist as a diagnostic.
@@ -9,9 +9,9 @@ const Audit = require('./audit.js');
9
9
  const NetworkRecords = require('../computed/network-records.js');
10
10
  const i18n = require('../lib/i18n/i18n.js');
11
11
  const MainThreadTasks = require('../computed/main-thread-tasks.js');
12
- const BootupTime = require('./bootup-time.js');
13
12
  const PageDependencyGraph = require('../computed/page-dependency-graph.js');
14
13
  const LoadSimulator = require('../computed/load-simulator.js');
14
+ const {getJavaScriptURLs, getAttributableURLForTask} = require('../lib/tracehouse/task-summary.js');
15
15
 
16
16
  /** We don't always have timing data for short tasks, if we're missing timing data. Treat it as though it were 0ms. */
17
17
  const DEFAULT_TIMING = {startTime: 0, endTime: 0, duration: 0};
@@ -77,7 +77,7 @@ class LongTasks extends Audit {
77
77
  }
78
78
  }
79
79
 
80
- const jsURLs = BootupTime.getJavaScriptURLs(networkRecords);
80
+ const jsURLs = getJavaScriptURLs(networkRecords);
81
81
  // Only consider up to 20 long, top-level (no parent) tasks that have an explicit endTime
82
82
  const longtasks = tasks
83
83
  .map(t => {
@@ -90,7 +90,7 @@ class LongTasks extends Audit {
90
90
 
91
91
  // TODO(beytoven): Add start time that matches with the simulated throttling
92
92
  const results = longtasks.map(task => ({
93
- url: BootupTime.getAttributableURLForTask(task, jsURLs),
93
+ url: getAttributableURLForTask(task, jsURLs),
94
94
  duration: task.duration,
95
95
  startTime: task.startTime,
96
96
  }));
@@ -0,0 +1,88 @@
1
+ /**
2
+ * @license Copyright 2022 The Lighthouse Authors. All Rights Reserved.
3
+ * 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
4
+ * 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.
5
+ */
6
+ 'use strict';
7
+
8
+ const Audit = require('../audit.js');
9
+ const ComputedResponsivenes = require('../../computed/metrics/responsiveness.js');
10
+ const i18n = require('../../lib/i18n/i18n.js');
11
+
12
+ const UIStrings = {
13
+ /** Description of the Interaction to Next Paint metric. This description is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
14
+ description: 'Interaction to Next Paint measures page responsiveness, how long it ' +
15
+ 'takes the page to visibly respond to user input. [Learn more](https://web.dev/inp/).',
16
+ };
17
+
18
+ const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
19
+
20
+ /**
21
+ * @fileoverview This metric gives a high-percentile measure of responsiveness to input.
22
+ */
23
+ class ExperimentalInteractionToNextPaint extends Audit {
24
+ /**
25
+ * @return {LH.Audit.Meta}
26
+ */
27
+ static get meta() {
28
+ return {
29
+ id: 'experimental-interaction-to-next-paint',
30
+ title: str_(i18n.UIStrings.interactionToNextPaint),
31
+ description: str_(UIStrings.description),
32
+ scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
33
+ supportedModes: ['timespan'],
34
+ requiredArtifacts: ['traces'],
35
+ };
36
+ }
37
+
38
+ /**
39
+ * @return {LH.Audit.ScoreOptions}
40
+ */
41
+ static get defaultOptions() {
42
+ return {
43
+ // https://web.dev/inp/
44
+ // This is using the same threshold as field tools since only supported in
45
+ // unsimulated user flows for now.
46
+ // see https://www.desmos.com/calculator/4xtrhg51th
47
+ p10: 200,
48
+ median: 500,
49
+ };
50
+ }
51
+
52
+ /**
53
+ * @param {LH.Artifacts} artifacts
54
+ * @param {LH.Audit.Context} context
55
+ * @return {Promise<LH.Audit.Product>}
56
+ */
57
+ static async audit(artifacts, context) {
58
+ const {settings} = context;
59
+ // TODO: responsiveness isn't yet supported by lantern.
60
+ if (settings.throttlingMethod === 'simulate') {
61
+ return {score: null, notApplicable: true};
62
+ }
63
+
64
+ const trace = artifacts.traces[Audit.DEFAULT_PASS];
65
+ const metricData = {trace, settings};
66
+ const interactionEvent = await ComputedResponsivenes.request(metricData, context);
67
+
68
+ // TODO: include the no-interaction state in the report instead of using n/a.
69
+ if (interactionEvent === null) {
70
+ return {score: null, notApplicable: true};
71
+ }
72
+
73
+ // TODO: remove workaround once 103.0.5052.0 is sufficiently released.
74
+ const timing = interactionEvent.name === 'FallbackTiming' ?
75
+ interactionEvent.duration : interactionEvent.args.data.duration;
76
+
77
+ return {
78
+ score: Audit.computeLogNormalScore({p10: context.options.p10, median: context.options.median},
79
+ timing),
80
+ numericValue: timing,
81
+ numericUnit: 'millisecond',
82
+ displayValue: str_(i18n.UIStrings.ms, {timeInMs: timing}),
83
+ };
84
+ }
85
+ }
86
+
87
+ module.exports = ExperimentalInteractionToNextPaint;
88
+ module.exports.UIStrings = UIStrings;
@@ -6,11 +6,11 @@
6
6
  'use strict';
7
7
 
8
8
  const Audit = require('./audit.js');
9
- const BootupTime = require('./bootup-time.js');
10
9
  const i18n = require('../lib/i18n/i18n.js');
11
10
  const thirdPartyWeb = require('../lib/third-party-web.js');
12
11
  const NetworkRecords = require('../computed/network-records.js');
13
12
  const MainThreadTasks = require('../computed/main-thread-tasks.js');
13
+ const {getJavaScriptURLs, getAttributableURLForTask} = require('../lib/tracehouse/task-summary.js');
14
14
 
15
15
  const UIStrings = {
16
16
  /** Title of a diagnostic audit that provides details about the code on a web page that the user doesn't control (referred to as "third-party code"). This descriptive title is shown to users when the amount is acceptable and no user action is required. */
@@ -98,10 +98,10 @@ class ThirdPartySummary extends Audit {
98
98
  byURL.set(request.url, urlSummary);
99
99
  }
100
100
 
101
- const jsURLs = BootupTime.getJavaScriptURLs(networkRecords);
101
+ const jsURLs = getJavaScriptURLs(networkRecords);
102
102
 
103
103
  for (const task of mainThreadTasks) {
104
- const attributableURL = BootupTime.getAttributableURLForTask(task, jsURLs);
104
+ const attributableURL = getAttributableURLForTask(task, jsURLs);
105
105
 
106
106
  const urlSummary = byURL.get(attributableURL) || {...defaultSummary};
107
107
  const taskDuration = task.selfTime * cpuMultiplier;
@@ -0,0 +1,280 @@
1
+ /**
2
+ * @license Copyright 2022 The Lighthouse Authors. All Rights Reserved.
3
+ * 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
4
+ * 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.
5
+ */
6
+ 'use strict';
7
+
8
+ const Audit = require('./audit.js');
9
+ const ComputedResponsivenes = require('../computed/metrics/responsiveness.js');
10
+ const ProcessedTrace = require('../computed/processed-trace.js');
11
+ const i18n = require('../lib/i18n/i18n.js');
12
+ const NetworkRecords = require('../computed/network-records.js');
13
+ const MainThreadTasks = require('../lib/tracehouse/main-thread-tasks.js');
14
+ const {taskGroups} = require('../lib/tracehouse/task-groups.js');
15
+ const TraceProcessor = require('../lib/tracehouse/trace-processor.js');
16
+ const {getExecutionTimingsByURL} = require('../lib/tracehouse/task-summary.js');
17
+ const inpThresholds = require('./metrics/experimental-interaction-to-next-paint.js').defaultOptions;
18
+ const LHError = require('../lib/lh-error.js');
19
+
20
+ /** @typedef {import('../computed/metrics/responsiveness.js').EventTimingEvent} EventTimingEvent */
21
+ /** @typedef {import('../lib/tracehouse/main-thread-tasks.js').TaskNode} TaskNode */
22
+
23
+ const TASK_THRESHOLD = 1;
24
+
25
+ const UIStrings = {
26
+ /** Title of a diagnostic audit that provides detail on the main thread work the browser did during a key user interaction. This descriptive title is shown to users when the amount is acceptable and no user action is required. */
27
+ title: 'Minimizes work during key interaction',
28
+ /** Title of a diagnostic audit that provides detail on the main thread work the browser did during a key user interaction. This imperative title is shown to users when there is a significant amount of execution time that could be reduced. */
29
+ failureTitle: 'Minimize work during key interaction',
30
+ /** Description of the work-during-interaction metric. This description is displayed within a tooltip when the user hovers on the metric name to see more. No character length limits. 'Learn More' becomes link text to additional documentation. */
31
+ description: 'This is the thread-blocking work occurring during the Interaction to Next Paint measurement. [Learn more](https://web.dev/inp/).',
32
+ /** Label for a column in a data table; entries will be information on the time that the browser is delayed before responding to user input. Ideally fits within a ~40 character limit. */
33
+ inputDelay: 'Input delay',
34
+ /** Label for a column in a data table; entries will be information on the time taken by code processing user input that delays a response to the user. Ideally fits within a ~40 character limit. */
35
+ processingDelay: 'Processing delay',
36
+ /** Label for a column in a data table; entries will be information on the time that the browser is delayed before presenting a response to user input on screen. Ideally fits within a ~40 character limit. */
37
+ presentationDelay: 'Presentation delay',
38
+ /**
39
+ * @description Summary text that identifies the time the browser took to process a user interaction.
40
+ * @example {mousedown} interactionType
41
+ */
42
+ displayValue: `{timeInMs, number, milliseconds}\xa0ms spent on event '{interactionType}'`,
43
+ /** Label for a column in a data table; entries will the UI element that was the target of a user interaction (for example, a button that was clicked on). Ideally fits within a ~40 character limit. */
44
+ eventTarget: 'Event target',
45
+ };
46
+
47
+ const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
48
+
49
+ /**
50
+ * @fileoverview This metric gives a high-percentile measure of responsiveness to input.
51
+ */
52
+ class WorkDuringInteraction extends Audit {
53
+ /**
54
+ * @return {LH.Audit.Meta}
55
+ */
56
+ static get meta() {
57
+ return {
58
+ id: 'work-during-interaction',
59
+ title: str_(UIStrings.title),
60
+ failureTitle: str_(UIStrings.failureTitle),
61
+ description: str_(UIStrings.description),
62
+ scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
63
+ supportedModes: ['timespan'],
64
+ requiredArtifacts: ['traces', 'devtoolsLogs', 'TraceElements'],
65
+ };
66
+ }
67
+
68
+ /**
69
+ * @param {TaskNode} task
70
+ * @param {TaskNode|undefined} parent
71
+ * @param {number} startTs
72
+ * @param {number} endTs
73
+ * @return {number}
74
+ */
75
+ static recursivelyClipTasks(task, parent, startTs, endTs) {
76
+ const taskEventStart = task.event.ts;
77
+ const taskEventEnd = task.endEvent?.ts ?? task.event.ts + Number(task.event.dur || 0);
78
+
79
+ task.startTime = Math.max(startTs, Math.min(endTs, taskEventStart)) / 1000;
80
+ task.endTime = Math.max(startTs, Math.min(endTs, taskEventEnd)) / 1000;
81
+ task.duration = task.endTime - task.startTime;
82
+
83
+ const childTime = task.children
84
+ .map(child => WorkDuringInteraction.recursivelyClipTasks(child, task, startTs, endTs))
85
+ .reduce((sum, child) => sum + child, 0);
86
+ task.selfTime = task.duration - childTime;
87
+ return task.duration;
88
+ }
89
+
90
+ /**
91
+ * Clip the tasks by the start and end points. Take the easy route and drop
92
+ * to duration 0 if out of bounds, since only durations are needed in the
93
+ * end (for now).
94
+ * Assumes owned tasks, so modifies in place. Can be called multiple times on
95
+ * the same `tasks` because always computed from original event timing.
96
+ * @param {Array<TaskNode>} tasks
97
+ * @param {number} startTs
98
+ * @param {number} endTs
99
+ */
100
+ static clipTasksByTs(tasks, startTs, endTs) {
101
+ for (const task of tasks) {
102
+ if (task.parent) continue;
103
+ WorkDuringInteraction.recursivelyClipTasks(task, undefined, startTs, endTs);
104
+ }
105
+ }
106
+
107
+ /**
108
+ * @param {EventTimingEvent} interactionEvent
109
+ */
110
+ static getPhaseTimes(interactionEvent) {
111
+ const interactionData = interactionEvent.args.data;
112
+ const startTs = interactionEvent.ts;
113
+ const navStart = startTs - interactionData.timeStamp * 1000;
114
+ const processingStartTs = navStart + interactionData.processingStart * 1000;
115
+ const processingEndTs = navStart + interactionData.processingEnd * 1000;
116
+ const endTs = startTs + interactionData.duration * 1000;
117
+ return {
118
+ inputDelay: {startTs, endTs: processingStartTs},
119
+ processingDelay: {startTs: processingStartTs, endTs: processingEndTs},
120
+ presentationDelay: {startTs: processingEndTs, endTs},
121
+ };
122
+ }
123
+
124
+ /**
125
+ * @param {EventTimingEvent} interactionEvent
126
+ * @param {LH.Trace} trace
127
+ * @param {LH.Artifacts.ProcessedTrace} processedTrace
128
+ * @param {Array<LH.Artifacts.NetworkRequest>} networkRecords
129
+ * @return {{table: LH.Audit.Details.Table, phases: Record<string, {startTs: number, endTs: number}>}}
130
+ */
131
+ static getThreadBreakdownTable(interactionEvent, trace, processedTrace, networkRecords) {
132
+ // Limit to interactionEvent's thread.
133
+ // TODO(bckenny): limit to interactionEvent's navigation.
134
+ const threadEvents = TraceProcessor.filteredTraceSort(trace.traceEvents, evt => {
135
+ return evt.pid === interactionEvent.pid && evt.tid === interactionEvent.tid;
136
+ });
137
+ const traceEndTs = threadEvents.reduce((endTs, evt) => {
138
+ return Math.max(evt.ts + (evt.dur || 0), endTs);
139
+ }, 0);
140
+ // frames is only used for URL attribution, so can include all frames, even if OOPIF.
141
+ const {frames} = processedTrace;
142
+ const threadTasks = MainThreadTasks.getMainThreadTasks(threadEvents, frames, traceEndTs);
143
+
144
+ const phases = WorkDuringInteraction.getPhaseTimes(interactionEvent);
145
+
146
+ /** @type {LH.Audit.Details.TableItem[]} */
147
+ const items = [];
148
+ for (const [phaseName, phaseTimes] of Object.entries(phases)) {
149
+ // Clip tasks to start and end time.
150
+ WorkDuringInteraction.clipTasksByTs(threadTasks, phaseTimes.startTs, phaseTimes.endTs);
151
+ const executionTimings = getExecutionTimingsByURL(threadTasks, networkRecords);
152
+
153
+ const results = [];
154
+ for (const [url, timingByGroupId] of executionTimings) {
155
+ const totalExecutionTimeForURL = Object.values(timingByGroupId)
156
+ .reduce((total, timespanMs) => total + timespanMs);
157
+
158
+ const scriptingTotal = timingByGroupId[taskGroups.scriptEvaluation.id] || 0;
159
+ const layoutTotal = timingByGroupId[taskGroups.styleLayout.id] || 0;
160
+ const renderTotal = timingByGroupId[taskGroups.paintCompositeRender.id] || 0;
161
+
162
+ results.push({
163
+ url: url,
164
+ total: totalExecutionTimeForURL,
165
+ scripting: scriptingTotal,
166
+ layout: layoutTotal,
167
+ render: renderTotal,
168
+ });
169
+ }
170
+
171
+ const filteredResults = results
172
+ .filter(result => result.total > TASK_THRESHOLD)
173
+ .sort((a, b) => b.total - a.total);
174
+
175
+ items.push({
176
+ phase: str_(UIStrings[/** @type {keyof UIStrings} */ (phaseName)]),
177
+ total: (phaseTimes.endTs - phaseTimes.startTs) / 1000,
178
+ subItems: {
179
+ type: 'subitems',
180
+ items: filteredResults,
181
+ },
182
+ });
183
+ }
184
+
185
+ /** @type {LH.Audit.Details.Table['headings']} */
186
+ const headings = [
187
+ /* eslint-disable max-len */
188
+ {key: 'phase', itemType: 'text', subItemsHeading: {key: 'url', itemType: 'url'}, text: 'Phase'},
189
+ {key: 'total', itemType: 'ms', subItemsHeading: {key: 'total', granularity: 1, itemType: 'ms'}, granularity: 1, text: 'Total time'},
190
+ {key: null, itemType: 'ms', subItemsHeading: {key: 'scripting', granularity: 1, itemType: 'ms'}, text: 'Script evaluation'},
191
+ {key: null, itemType: 'ms', subItemsHeading: {key: 'layout', granularity: 1, itemType: 'ms'}, text: taskGroups.styleLayout.label},
192
+ {key: null, itemType: 'ms', subItemsHeading: {key: 'render', granularity: 1, itemType: 'ms'}, text: taskGroups.paintCompositeRender.label},
193
+ /* eslint-enable max-len */
194
+ ];
195
+
196
+ return {
197
+ table: Audit.makeTableDetails(headings, items),
198
+ phases,
199
+ };
200
+ }
201
+
202
+ /**
203
+ * @param {LH.Artifacts['TraceElements']} traceElements
204
+ * @return {LH.Audit.Details.Table | undefined}
205
+ */
206
+ static getTraceElementTable(traceElements) {
207
+ const responsivenessElement = traceElements.find(el => el.traceEventType === 'responsiveness');
208
+ if (!responsivenessElement) return;
209
+
210
+ /** @type {LH.Audit.Details.Table['headings']} */
211
+ const headings = [
212
+ {key: 'node', itemType: 'node', text: str_(UIStrings.eventTarget)},
213
+ ];
214
+ const elementItems = [{node: Audit.makeNodeItem(responsivenessElement.node)}];
215
+
216
+ return Audit.makeTableDetails(headings, elementItems);
217
+ }
218
+
219
+ /**
220
+ * @param {LH.Artifacts} artifacts
221
+ * @param {LH.Audit.Context} context
222
+ * @return {Promise<LH.Audit.Product>}
223
+ */
224
+ static async audit(artifacts, context) {
225
+ const {settings} = context;
226
+ // TODO: responsiveness isn't yet supported by lantern.
227
+ if (settings.throttlingMethod === 'simulate') {
228
+ return {score: null, notApplicable: true};
229
+ }
230
+
231
+ const trace = artifacts.traces[WorkDuringInteraction.DEFAULT_PASS];
232
+ const metricData = {trace, settings};
233
+ const interactionEvent = await ComputedResponsivenes.request(metricData, context);
234
+ // If no interaction, diagnostic audit is n/a.
235
+ if (interactionEvent === null) {
236
+ return {score: null, notApplicable: true};
237
+ }
238
+ // TODO: remove workaround once 103.0.5052.0 is sufficiently released.
239
+ if (interactionEvent.name === 'FallbackTiming') {
240
+ throw new LHError(
241
+ LHError.errors.UNSUPPORTED_OLD_CHROME,
242
+ {featureName: 'detailed EventTiming trace events'}
243
+ );
244
+ }
245
+
246
+ const auditDetailsItems = [];
247
+
248
+ const traceElementItem = WorkDuringInteraction.getTraceElementTable(artifacts.TraceElements);
249
+ if (traceElementItem) auditDetailsItems.push(traceElementItem);
250
+
251
+ const devtoolsLog = artifacts.devtoolsLogs[WorkDuringInteraction.DEFAULT_PASS];
252
+ // Network records will usually be empty for timespans.
253
+ const networkRecords = await NetworkRecords.request(devtoolsLog, context);
254
+ const processedTrace = await ProcessedTrace.request(trace, context);
255
+ const {table: breakdownTable, phases} = WorkDuringInteraction.getThreadBreakdownTable(
256
+ interactionEvent, trace, processedTrace, networkRecords);
257
+ auditDetailsItems.push(breakdownTable);
258
+
259
+ const interactionType = interactionEvent.args.data.type;
260
+ auditDetailsItems.push({
261
+ type: /** @type {const} */ ('debugdata'),
262
+ interactionType,
263
+ phases,
264
+ });
265
+
266
+ const duration = interactionEvent.args.data.duration;
267
+ const displayValue = str_(UIStrings.displayValue, {timeInMs: duration, interactionType});
268
+ return {
269
+ score: duration < inpThresholds.p10 ? 1 : 0,
270
+ displayValue,
271
+ details: {
272
+ type: 'list',
273
+ items: auditDetailsItems,
274
+ },
275
+ };
276
+ }
277
+ }
278
+
279
+ module.exports = WorkDuringInteraction;
280
+ module.exports.UIStrings = UIStrings;
@@ -0,0 +1,157 @@
1
+ /**
2
+ * @license Copyright 2022 The Lighthouse Authors. All Rights Reserved.
3
+ * 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
4
+ * 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.
5
+ */
6
+ 'use strict';
7
+
8
+ /**
9
+ * @fileoverview Returns a high-percentle (usually 98th) measure of how long it
10
+ * takes the page to visibly respond to user input (or null, if there was no
11
+ * user input in the provided trace).
12
+ */
13
+
14
+ /** @typedef {LH.Trace.CompleteEvent & {name: 'Responsiveness.Renderer.UserInteraction', args: {frame: string, data: {interactionType: 'drag'|'keyboard'|'tapOrClick', maxDuration: number}}}} ResponsivenessEvent */
15
+ /** @typedef {'keydown'|'keypress'|'keyup'|'mousedown'|'mouseup'|'pointerdown'|'pointerup'|'click'} EventTimingType */
16
+ /**
17
+ * @typedef EventTimingData
18
+ * @property {string} frame
19
+ * @property {number} timeStamp The time of user interaction (in ms from navStart).
20
+ * @property {number} processingStart The start of interaction handling (in ms from navStart).
21
+ * @property {number} processingEnd The end of interaction handling (in ms from navStart).
22
+ * @property {number} duration The time from user interaction to browser paint (in ms).
23
+ * @property {EventTimingType} type
24
+ * @property {number} nodeId
25
+ * @property {number} interactionId
26
+ */
27
+ /** @typedef {LH.Trace.AsyncEvent & {name: 'EventTiming', args: {data: EventTimingData}}} EventTimingEvent */
28
+ /**
29
+ * A fallback EventTiming placeholder, used if updated EventTiming events are not available.
30
+ * TODO: Remove once 103.0.5052.0 is sufficiently released.
31
+ * @typedef {{name: 'FallbackTiming', duration: number}} FallbackTimingEvent
32
+ */
33
+
34
+ const makeComputedArtifact = require('../computed-artifact.js');
35
+ const ProcessedTrace = require('../processed-trace.js');
36
+
37
+ const KEYBOARD_EVENTS = new Set(['keydown', 'keypress', 'keyup']);
38
+ const CLICK_TAP_DRAG_EVENTS = new Set([
39
+ 'mousedown', 'mouseup', 'pointerdown', 'pointerup', 'click']);
40
+ /** A map of Responsiveness `interactionType` to matching EventTiming `type`s. */
41
+ const interactionTypeToType = {
42
+ keyboard: KEYBOARD_EVENTS,
43
+ tapOrClick: CLICK_TAP_DRAG_EVENTS,
44
+ drag: CLICK_TAP_DRAG_EVENTS,
45
+ };
46
+
47
+ class Responsiveness {
48
+ /**
49
+ * @param {LH.Artifacts.ProcessedTrace} processedTrace
50
+ * @return {ResponsivenessEvent|null}
51
+ */
52
+ static getHighPercentileResponsiveness(processedTrace) {
53
+ const responsivenessEvents = processedTrace.frameTreeEvents
54
+ // https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/timing/responsiveness_metrics.cc;l=146-150;drc=a1a2302f30b0a58f7669a41c80acdf1fa11958dd
55
+ .filter(/** @return {e is ResponsivenessEvent} */ e => {
56
+ return e.name === 'Responsiveness.Renderer.UserInteraction';
57
+ }).sort((a, b) => b.args.data.maxDuration - a.args.data.maxDuration);
58
+
59
+ // If there were no interactions with the page, the metric is N/A.
60
+ if (responsivenessEvents.length === 0) {
61
+ return null;
62
+ }
63
+
64
+ // INP is the "nearest-rank"/inverted_cdf 98th percentile, except Chrome only
65
+ // keeps the 10 worst events around, so it can never be more than the 10th from
66
+ // last array element. To keep things simpler, sort desc and pick from front.
67
+ // See https://source.chromium.org/chromium/chromium/src/+/main:components/page_load_metrics/browser/responsiveness_metrics_normalization.cc;l=45-59;drc=cb0f9c8b559d9c7c3cb4ca94fc1118cc015d38ad
68
+ const index = Math.min(9, Math.floor(responsivenessEvents.length / 50));
69
+
70
+ return responsivenessEvents[index];
71
+ }
72
+
73
+ /**
74
+ * Finds the interaction event that was probably the responsivenessEvent.maxDuration
75
+ * source.
76
+ * Note that (presumably due to rounding to ms), the interaction duration may not
77
+ * be the same value as `maxDuration`, just the closest value. Function will throw
78
+ * if the closest match is off by more than 4ms.
79
+ * TODO: this doesn't try to match inputs to interactions and break ties if more than
80
+ * one interaction had this duration by returning the first found.
81
+ * @param {ResponsivenessEvent} responsivenessEvent
82
+ * @param {LH.Trace} trace
83
+ * @return {EventTimingEvent|FallbackTimingEvent}
84
+ */
85
+ static findInteractionEvent(responsivenessEvent, {traceEvents}) {
86
+ const candidates = traceEvents.filter(/** @return {evt is EventTimingEvent} */ evt => {
87
+ // Examine only beginning/instant EventTiming events.
88
+ return evt.name === 'EventTiming' && evt.ph !== 'e';
89
+ });
90
+
91
+ if (candidates.length && !candidates.some(candidate => candidate.args.data?.frame)) {
92
+ // Full EventTiming data added in https://crrev.com/c/3632661
93
+ return {
94
+ name: 'FallbackTiming',
95
+ duration: responsivenessEvent.args.data.maxDuration,
96
+ };
97
+ }
98
+
99
+ const {maxDuration, interactionType} = responsivenessEvent.args.data;
100
+ let bestMatchEvent;
101
+ let minDurationDiff = Number.POSITIVE_INFINITY;
102
+ for (const candidate of candidates) {
103
+ // Must be from same frame.
104
+ if (candidate.args.data.frame !== responsivenessEvent.args.frame) continue;
105
+
106
+ // TODO(bckenny): must be in same navigation as well.
107
+
108
+ const {type, duration} = candidate.args.data;
109
+ // Discard if type is incompatible with responsiveness interactionType.
110
+ const matchingTypes = interactionTypeToType[interactionType];
111
+ if (!matchingTypes) {
112
+ throw new Error(`unexpected responsiveness interactionType '${interactionType}'`);
113
+ }
114
+ if (!matchingTypes.has(type)) continue;
115
+
116
+ const durationDiff = Math.abs(duration - maxDuration);
117
+ if (durationDiff < minDurationDiff) {
118
+ bestMatchEvent = candidate;
119
+ minDurationDiff = durationDiff;
120
+ }
121
+ }
122
+
123
+ if (!bestMatchEvent) {
124
+ throw new Error(`no interaction event found for responsiveness type '${interactionType}'`);
125
+ }
126
+ // TODO: seems to regularly happen up to 3ms and as high as 4. Allow for up to 5ms to be sure.
127
+ if (minDurationDiff > 5) {
128
+ throw new Error(`no interaction event found within 5ms of responsiveness maxDuration (max: ${maxDuration}, closest ${bestMatchEvent.args.data.duration})`); // eslint-disable-line max-len
129
+ }
130
+
131
+ return bestMatchEvent;
132
+ }
133
+
134
+ /**
135
+ * @param {{trace: LH.Trace, settings: Immutable<LH.Config.Settings>}} data
136
+ * @param {LH.Artifacts.ComputedContext} context
137
+ * @return {Promise<EventTimingEvent|FallbackTimingEvent|null>}
138
+ */
139
+ static async compute_(data, context) {
140
+ const {settings, trace} = data;
141
+ if (settings.throttlingMethod === 'simulate') {
142
+ throw new Error('Responsiveness currently unsupported by simulated throttling');
143
+ }
144
+
145
+ const processedTrace = await ProcessedTrace.request(trace, context);
146
+ const responsivenessEvent = Responsiveness.getHighPercentileResponsiveness(processedTrace);
147
+ if (!responsivenessEvent) return null;
148
+
149
+ const interactionEvent = Responsiveness.findInteractionEvent(responsivenessEvent, trace);
150
+ return JSON.parse(JSON.stringify(interactionEvent));
151
+ }
152
+ }
153
+
154
+ module.exports = makeComputedArtifact(Responsiveness, [
155
+ 'trace',
156
+ 'settings',
157
+ ]);
@@ -6,7 +6,7 @@
6
6
  'use strict';
7
7
 
8
8
  const path = require('path');
9
- const {isEqual: isDeepEqual} = require('lodash');
9
+ const isDeepEqual = require('lodash/isEqual.js');
10
10
  const constants = require('./constants.js');
11
11
  const Budget = require('./budget.js');
12
12
  const ConfigPlugin = require('./config-plugin.js');
@@ -48,9 +48,14 @@ const clsRelevantAudits = [
48
48
  // 'preload-fonts', // actually in BP, rather than perf
49
49
  ];
50
50
 
51
+ const inpRelevantAudits = [
52
+ 'work-during-interaction',
53
+ ];
54
+
51
55
  module.exports = {
52
56
  fcpRelevantAudits,
53
57
  lcpRelevantAudits,
54
58
  tbtRelevantAudits,
55
59
  clsRelevantAudits,
60
+ inpRelevantAudits,
56
61
  };