lighthouse 12.1.0-dev.20240630 → 12.1.0-dev.20240702

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 (115) hide show
  1. package/core/audits/byte-efficiency/byte-efficiency-audit.d.ts +5 -7
  2. package/core/audits/byte-efficiency/byte-efficiency-audit.js +3 -6
  3. package/core/audits/byte-efficiency/render-blocking-resources.d.ts +3 -7
  4. package/core/audits/byte-efficiency/render-blocking-resources.js +10 -16
  5. package/core/audits/dobetterweb/uses-http2.d.ts +4 -6
  6. package/core/audits/dobetterweb/uses-http2.js +2 -5
  7. package/core/audits/long-tasks.d.ts +6 -6
  8. package/core/audits/long-tasks.js +4 -4
  9. package/core/audits/prioritize-lcp-image.d.ts +1 -1
  10. package/core/audits/uses-rel-preload.d.ts +4 -3
  11. package/core/audits/uses-rel-preload.js +8 -6
  12. package/core/computed/critical-request-chains.d.ts +4 -3
  13. package/core/computed/critical-request-chains.js +5 -4
  14. package/core/computed/document-urls.js +1 -1
  15. package/core/computed/load-simulator.d.ts +3 -4
  16. package/core/computed/load-simulator.js +1 -1
  17. package/core/computed/main-resource.js +1 -1
  18. package/core/computed/metrics/lantern-first-contentful-paint.d.ts +2 -4
  19. package/core/computed/metrics/lantern-first-contentful-paint.js +1 -3
  20. package/core/computed/metrics/lantern-interactive.d.ts +2 -4
  21. package/core/computed/metrics/lantern-interactive.js +1 -3
  22. package/core/computed/metrics/lantern-largest-contentful-paint.d.ts +2 -4
  23. package/core/computed/metrics/lantern-largest-contentful-paint.js +1 -3
  24. package/core/computed/metrics/lantern-max-potential-fid.d.ts +2 -4
  25. package/core/computed/metrics/lantern-max-potential-fid.js +1 -3
  26. package/core/computed/metrics/lantern-metric.d.ts +8 -8
  27. package/core/computed/metrics/lantern-metric.js +1 -1
  28. package/core/computed/metrics/lantern-speed-index.d.ts +2 -4
  29. package/core/computed/metrics/lantern-speed-index.js +1 -3
  30. package/core/computed/metrics/lantern-total-blocking-time.d.ts +2 -4
  31. package/core/computed/metrics/lantern-total-blocking-time.js +1 -3
  32. package/core/computed/metrics/total-blocking-time.js +1 -1
  33. package/core/computed/network-analysis.js +1 -1
  34. package/core/computed/page-dependency-graph.d.ts +3 -6
  35. package/core/computed/page-dependency-graph.js +3 -4
  36. package/core/computed/tbt-impact-tasks.js +2 -2
  37. package/core/lib/asset-saver.js +1 -1
  38. package/core/lib/lantern/lantern.d.ts +2 -19
  39. package/core/lib/lantern/lantern.js +2 -45
  40. package/core/lib/lantern-trace-saver.d.ts +4 -6
  41. package/core/lib/lantern-trace-saver.js +2 -3
  42. package/core/lib/navigation-error.js +2 -2
  43. package/core/lib/network-recorder.js +1 -1
  44. package/core/lib/network-request.d.ts +4 -4
  45. package/core/lib/network-request.js +2 -2
  46. package/package.json +2 -2
  47. package/tsconfig.json +0 -11
  48. package/types/artifacts.d.ts +2 -2
  49. package/types/gatherer.d.ts +4 -5
  50. package/core/lib/lantern/BaseNode.d.ts +0 -163
  51. package/core/lib/lantern/BaseNode.js +0 -369
  52. package/core/lib/lantern/BaseNode.test.js +0 -385
  53. package/core/lib/lantern/CpuNode.d.ts +0 -43
  54. package/core/lib/lantern/CpuNode.js +0 -99
  55. package/core/lib/lantern/LanternError.d.ts +0 -8
  56. package/core/lib/lantern/LanternError.js +0 -9
  57. package/core/lib/lantern/Metric.d.ts +0 -69
  58. package/core/lib/lantern/Metric.js +0 -137
  59. package/core/lib/lantern/NetworkNode.d.ts +0 -49
  60. package/core/lib/lantern/NetworkNode.js +0 -136
  61. package/core/lib/lantern/PageDependencyGraph.d.ts +0 -82
  62. package/core/lib/lantern/PageDependencyGraph.js +0 -610
  63. package/core/lib/lantern/PageDependencyGraph.test.js +0 -654
  64. package/core/lib/lantern/TBTUtils.d.ts +0 -44
  65. package/core/lib/lantern/TBTUtils.js +0 -76
  66. package/core/lib/lantern/TBTUtils.test.d.ts +0 -2
  67. package/core/lib/lantern/TBTUtils.test.js +0 -130
  68. package/core/lib/lantern/TraceEngineComputationData.d.ts +0 -25
  69. package/core/lib/lantern/TraceEngineComputationData.js +0 -466
  70. package/core/lib/lantern/metrics/FirstContentfulPaint.d.ts +0 -79
  71. package/core/lib/lantern/metrics/FirstContentfulPaint.js +0 -198
  72. package/core/lib/lantern/metrics/FirstContentfulPaint.test.js +0 -54
  73. package/core/lib/lantern/metrics/Interactive.d.ts +0 -20
  74. package/core/lib/lantern/metrics/Interactive.js +0 -109
  75. package/core/lib/lantern/metrics/Interactive.test.js +0 -56
  76. package/core/lib/lantern/metrics/LargestContentfulPaint.d.ts +0 -19
  77. package/core/lib/lantern/metrics/LargestContentfulPaint.js +0 -105
  78. package/core/lib/lantern/metrics/LargestContentfulPaint.test.js +0 -42
  79. package/core/lib/lantern/metrics/MaxPotentialFID.d.ts +0 -24
  80. package/core/lib/lantern/metrics/MaxPotentialFID.js +0 -91
  81. package/core/lib/lantern/metrics/MetricTestUtils.d.ts +0 -19
  82. package/core/lib/lantern/metrics/MetricTestUtils.js +0 -48
  83. package/core/lib/lantern/metrics/SpeedIndex.d.ts +0 -32
  84. package/core/lib/lantern/metrics/SpeedIndex.js +0 -142
  85. package/core/lib/lantern/metrics/SpeedIndex.test.js +0 -83
  86. package/core/lib/lantern/metrics/TotalBlockingTime.d.ts +0 -25
  87. package/core/lib/lantern/metrics/TotalBlockingTime.js +0 -125
  88. package/core/lib/lantern/metrics/__snapshots__/FirstContentfulPaint.test.js.snap +0 -11
  89. package/core/lib/lantern/metrics/__snapshots__/Interactive.test.js.snap +0 -17
  90. package/core/lib/lantern/metrics/metrics.d.ts +0 -9
  91. package/core/lib/lantern/metrics/metrics.js +0 -16
  92. package/core/lib/lantern/simulation/ConnectionPool.d.ts +0 -48
  93. package/core/lib/lantern/simulation/ConnectionPool.js +0 -152
  94. package/core/lib/lantern/simulation/ConnectionPool.test.js +0 -195
  95. package/core/lib/lantern/simulation/Constants.d.ts +0 -52
  96. package/core/lib/lantern/simulation/Constants.js +0 -48
  97. package/core/lib/lantern/simulation/DNSCache.d.ts +0 -42
  98. package/core/lib/lantern/simulation/DNSCache.js +0 -74
  99. package/core/lib/lantern/simulation/DNSCache.test.js +0 -72
  100. package/core/lib/lantern/simulation/NetworkAnalyzer.d.ts +0 -209
  101. package/core/lib/lantern/simulation/NetworkAnalyzer.js +0 -597
  102. package/core/lib/lantern/simulation/NetworkAnalyzer.test.js +0 -475
  103. package/core/lib/lantern/simulation/SimulationTimingMap.d.ts +0 -153
  104. package/core/lib/lantern/simulation/SimulationTimingMap.js +0 -219
  105. package/core/lib/lantern/simulation/Simulator.d.ts +0 -157
  106. package/core/lib/lantern/simulation/Simulator.js +0 -593
  107. package/core/lib/lantern/simulation/Simulator.test.js +0 -434
  108. package/core/lib/lantern/simulation/TCPConnection.test.d.ts +0 -2
  109. package/core/lib/lantern/simulation/TCPConnection.test.js +0 -374
  110. package/core/lib/lantern/simulation/TcpConnection.d.ts +0 -89
  111. package/core/lib/lantern/simulation/TcpConnection.js +0 -230
  112. package/core/lib/lantern/simulation/simulation.d.ts +0 -21
  113. package/core/lib/lantern/simulation/simulation.js +0 -28
  114. package/core/lib/lantern/types/lantern.d.ts +0 -256
  115. package/core/lib/lantern/types/lantern.js +0 -7
@@ -1,198 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2024 Google LLC
4
- * SPDX-License-Identifier: Apache-2.0
5
- */
6
-
7
- import * as Lantern from '../lantern.js';
8
-
9
- /** @typedef {import('../BaseNode.js').Node} Node */
10
- /** @template T @typedef {import('../NetworkNode.js').NetworkNode<T>} NetworkNode */
11
- /** @typedef {import('../CpuNode.js').CPUNode} CpuNode */
12
-
13
- class FirstContentfulPaint extends Lantern.Metric {
14
- /**
15
- * @return {Lantern.Simulation.MetricCoefficients}
16
- */
17
- static get COEFFICIENTS() {
18
- return {
19
- intercept: 0,
20
- optimistic: 0.5,
21
- pessimistic: 0.5,
22
- };
23
- }
24
-
25
- /**
26
- * @template T
27
- * @typedef FirstPaintBasedGraphOpts
28
- * @property {number} cutoffTimestamp The timestamp used to filter out tasks that occured after
29
- * our paint of interest. Typically this is First Contentful Paint or First Meaningful Paint.
30
- * @property {function(NetworkNode<T>):boolean} treatNodeAsRenderBlocking The function that determines
31
- * which resources should be considered *possibly* render-blocking.
32
- * @property {(function(CpuNode):boolean)=} additionalCpuNodesToTreatAsRenderBlocking The function that
33
- * determines which CPU nodes should also be included in our blocking node IDs set,
34
- * beyond what getRenderBlockingNodeData() already includes.
35
- */
36
-
37
- /**
38
- * This function computes the set of URLs that *appeared* to be render-blocking based on our filter,
39
- * *but definitely were not* render-blocking based on the timing of their EvaluateScript task.
40
- * It also computes the set of corresponding CPU node ids that were needed for the paint at the
41
- * given timestamp.
42
- *
43
- * @template [T=unknown]
44
- * @param {Node} graph
45
- * @param {FirstPaintBasedGraphOpts<T>} opts
46
- * @return {{definitelyNotRenderBlockingScriptUrls: Set<string>, renderBlockingCpuNodeIds: Set<string>}}
47
- */
48
- static getRenderBlockingNodeData(
49
- graph,
50
- {cutoffTimestamp, treatNodeAsRenderBlocking, additionalCpuNodesToTreatAsRenderBlocking}
51
- ) {
52
- /** @type {Map<string, CpuNode>} A map of blocking script URLs to the earliest EvaluateScript task node that executed them. */
53
- const scriptUrlToNodeMap = new Map();
54
-
55
- /** @type {Array<CpuNode>} */
56
- const cpuNodes = [];
57
- graph.traverse(node => {
58
- if (node.type === Lantern.BaseNode.TYPES.CPU) {
59
- // A task is *possibly* render blocking if it *started* before cutoffTimestamp.
60
- // We use startTime here because the paint event can be *inside* the task that was render blocking.
61
- if (node.startTime <= cutoffTimestamp) cpuNodes.push(node);
62
-
63
- // Build our script URL map to find the earliest EvaluateScript task node.
64
- const scriptUrls = node.getEvaluateScriptURLs();
65
- for (const url of scriptUrls) {
66
- // Use the earliest CPU node we find.
67
- const existing = scriptUrlToNodeMap.get(url) || node;
68
- scriptUrlToNodeMap.set(url, node.startTime < existing.startTime ? node : existing);
69
- }
70
- }
71
- });
72
-
73
- cpuNodes.sort((a, b) => a.startTime - b.startTime);
74
-
75
- // A script is *possibly* render blocking if it finished loading before cutoffTimestamp.
76
- const possiblyRenderBlockingScriptUrls = Lantern.Metric.getScriptUrls(graph, node => {
77
- // The optimistic LCP treatNodeAsRenderBlocking fn wants to exclude some images in the graph,
78
- // but here it only receives scripts to evaluate. It's a no-op in this case, but it will
79
- // matter below in the getFirstPaintBasedGraph clone operation.
80
- return node.endTime <= cutoffTimestamp && treatNodeAsRenderBlocking(node);
81
- });
82
-
83
- // A script is *definitely not* render blocking if its EvaluateScript task started after cutoffTimestamp.
84
- /** @type {Set<string>} */
85
- const definitelyNotRenderBlockingScriptUrls = new Set();
86
- /** @type {Set<string>} */
87
- const renderBlockingCpuNodeIds = new Set();
88
- for (const url of possiblyRenderBlockingScriptUrls) {
89
- // Lookup the CPU node that had the earliest EvaluateScript for this URL.
90
- const cpuNodeForUrl = scriptUrlToNodeMap.get(url);
91
-
92
- // If we can't find it at all, we can't conclude anything, so just skip it.
93
- if (!cpuNodeForUrl) continue;
94
-
95
- // If we found it and it was in our `cpuNodes` set that means it finished before cutoffTimestamp, so it really is render-blocking.
96
- if (cpuNodes.includes(cpuNodeForUrl)) {
97
- renderBlockingCpuNodeIds.add(cpuNodeForUrl.id);
98
- continue;
99
- }
100
-
101
- // We couldn't find the evaluate script in the set of CPU nodes that ran before our paint, so
102
- // it must not have been necessary for the paint.
103
- definitelyNotRenderBlockingScriptUrls.add(url);
104
- }
105
-
106
- // The first layout, first paint, and first ParseHTML are almost always necessary for first paint,
107
- // so we always include those CPU nodes.
108
- const firstLayout = cpuNodes.find(node => node.didPerformLayout());
109
- if (firstLayout) renderBlockingCpuNodeIds.add(firstLayout.id);
110
- const firstPaint = cpuNodes.find(node => node.childEvents.some(e => e.name === 'Paint'));
111
- if (firstPaint) renderBlockingCpuNodeIds.add(firstPaint.id);
112
- const firstParse = cpuNodes.find(node => node.childEvents.some(e => e.name === 'ParseHTML'));
113
- if (firstParse) renderBlockingCpuNodeIds.add(firstParse.id);
114
-
115
- // If a CPU filter was passed in, we also want to include those extra nodes.
116
- if (additionalCpuNodesToTreatAsRenderBlocking) {
117
- cpuNodes
118
- .filter(additionalCpuNodesToTreatAsRenderBlocking)
119
- .forEach(node => renderBlockingCpuNodeIds.add(node.id));
120
- }
121
-
122
- return {
123
- definitelyNotRenderBlockingScriptUrls,
124
- renderBlockingCpuNodeIds,
125
- };
126
- }
127
-
128
- /**
129
- * This function computes the graph required for the first paint of interest.
130
- *
131
- * @template [T=unknown]
132
- * @param {Node} dependencyGraph
133
- * @param {FirstPaintBasedGraphOpts<T>} opts
134
- * @return {Node}
135
- */
136
- static getFirstPaintBasedGraph(
137
- dependencyGraph,
138
- {cutoffTimestamp, treatNodeAsRenderBlocking, additionalCpuNodesToTreatAsRenderBlocking}
139
- ) {
140
- const rbData = this.getRenderBlockingNodeData(dependencyGraph, {
141
- cutoffTimestamp,
142
- treatNodeAsRenderBlocking,
143
- additionalCpuNodesToTreatAsRenderBlocking,
144
- });
145
- const {definitelyNotRenderBlockingScriptUrls, renderBlockingCpuNodeIds} = rbData;
146
-
147
- return dependencyGraph.cloneWithRelationships(node => {
148
- if (node.type === Lantern.BaseNode.TYPES.NETWORK) {
149
- // Exclude all nodes that ended after cutoffTimestamp (except for the main document which we always consider necessary)
150
- // endTime is negative if request does not finish, make sure startTime isn't after cutoffTimestamp in this case.
151
- const endedAfterPaint = node.endTime > cutoffTimestamp || node.startTime > cutoffTimestamp;
152
- if (endedAfterPaint && !node.isMainDocument()) return false;
153
-
154
- const url = node.request.url;
155
- // If the URL definitely wasn't render-blocking then we filter it out.
156
- if (definitelyNotRenderBlockingScriptUrls.has(url)) {
157
- return false;
158
- }
159
-
160
- // Lastly, build up the FCP graph of all nodes we consider render blocking
161
- return treatNodeAsRenderBlocking(node);
162
- } else {
163
- // If it's a CPU node, just check if it was blocking.
164
- return renderBlockingCpuNodeIds.has(node.id);
165
- }
166
- });
167
- }
168
-
169
- /**
170
- * @param {Node} dependencyGraph
171
- * @param {Lantern.Simulation.ProcessedNavigation} processedNavigation
172
- * @return {Node}
173
- */
174
- static getOptimisticGraph(dependencyGraph, processedNavigation) {
175
- return this.getFirstPaintBasedGraph(dependencyGraph, {
176
- cutoffTimestamp: processedNavigation.timestamps.firstContentfulPaint,
177
- // In the optimistic graph we exclude resources that appeared to be render blocking but were
178
- // initiated by a script. While they typically have a very high importance and tend to have a
179
- // significant impact on the page's content, these resources don't technically block rendering.
180
- treatNodeAsRenderBlocking: node =>
181
- node.hasRenderBlockingPriority() && node.initiatorType !== 'script',
182
- });
183
- }
184
-
185
- /**
186
- * @param {Node} dependencyGraph
187
- * @param {Lantern.Simulation.ProcessedNavigation} processedNavigation
188
- * @return {Node}
189
- */
190
- static getPessimisticGraph(dependencyGraph, processedNavigation) {
191
- return this.getFirstPaintBasedGraph(dependencyGraph, {
192
- cutoffTimestamp: processedNavigation.timestamps.firstContentfulPaint,
193
- treatNodeAsRenderBlocking: node => node.hasRenderBlockingPriority(),
194
- });
195
- }
196
- }
197
-
198
- export {FirstContentfulPaint};
@@ -1,54 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2024 Google LLC
4
- * SPDX-License-Identifier: Apache-2.0
5
- */
6
-
7
- import assert from 'assert/strict';
8
-
9
- import * as Lantern from '../lantern.js';
10
- import {readJson} from '../../../test/test-utils.js';
11
- import {getComputationDataFromFixture} from './MetricTestUtils.js';
12
-
13
- const {FirstContentfulPaint} = Lantern.Metrics;
14
-
15
- const trace = readJson('../../../test/fixtures/artifacts/progressive-app/trace.json', import.meta);
16
-
17
- describe('Metrics: Lantern FCP', () => {
18
- it('should compute predicted value', async () => {
19
- const data = await getComputationDataFromFixture({trace});
20
- const result = await FirstContentfulPaint.compute(data);
21
-
22
- expect({
23
- timing: Math.round(result.timing),
24
- optimistic: Math.round(result.optimisticEstimate.timeInMs),
25
- pessimistic: Math.round(result.pessimisticEstimate.timeInMs),
26
- optimisticNodeTimings: result.optimisticEstimate.nodeTimings.size,
27
- pessimisticNodeTimings: result.pessimisticEstimate.nodeTimings.size,
28
- }).toMatchSnapshot();
29
- assert.ok(result.optimisticGraph, 'should have created optimistic graph');
30
- assert.ok(result.pessimisticGraph, 'should have created pessimistic graph');
31
- });
32
-
33
- it('should handle negative request networkEndTime', async () => {
34
- const data = await getComputationDataFromFixture({trace});
35
- data.graph.request.networkEndTime = -1;
36
- const result = await FirstContentfulPaint.compute(data);
37
-
38
- const optimisticNodes = [];
39
- result.optimisticGraph.traverse(node => {
40
- if (node.type === 'network') {
41
- optimisticNodes.push(node);
42
- }
43
- });
44
- expect(optimisticNodes.map(node => node.request.url)).toEqual(['https://squoosh.app/']);
45
-
46
- const pessimisticNodes = [];
47
- result.pessimisticGraph.traverse(node => {
48
- if (node.type === 'network') {
49
- pessimisticNodes.push(node);
50
- }
51
- });
52
- expect(pessimisticNodes.map(node => node.request.url)).toEqual(['https://squoosh.app/']);
53
- });
54
- });
@@ -1,20 +0,0 @@
1
- export type Node = import('../BaseNode.js').Node;
2
- export class Interactive extends Lantern.Metric {
3
- /**
4
- * @param {Node} dependencyGraph
5
- * @return {Node}
6
- */
7
- static getOptimisticGraph(dependencyGraph: Node): Node;
8
- /**
9
- * @param {Node} dependencyGraph
10
- * @return {Node}
11
- */
12
- static getPessimisticGraph(dependencyGraph: Node): Node;
13
- /**
14
- * @param {Lantern.Simulation.Result['nodeTimings']} nodeTimings
15
- * @return {number}
16
- */
17
- static getLastLongTaskEndTime(nodeTimings: Lantern.Simulation.Result['nodeTimings'], duration?: number): number;
18
- }
19
- import * as Lantern from '../lantern.js';
20
- //# sourceMappingURL=Interactive.d.ts.map
@@ -1,109 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2024 Google LLC
4
- * SPDX-License-Identifier: Apache-2.0
5
- */
6
-
7
- import * as Lantern from '../lantern.js';
8
-
9
- /** @typedef {import('../BaseNode.js').Node} Node */
10
-
11
- // Any CPU task of 20 ms or more will end up being a critical long task on mobile
12
- const CRITICAL_LONG_TASK_THRESHOLD = 20;
13
-
14
- class Interactive extends Lantern.Metric {
15
- /**
16
- * @return {Lantern.Simulation.MetricCoefficients}
17
- */
18
- static get COEFFICIENTS() {
19
- return {
20
- intercept: 0,
21
- optimistic: 0.45,
22
- pessimistic: 0.55,
23
- };
24
- }
25
-
26
- /**
27
- * @param {Node} dependencyGraph
28
- * @return {Node}
29
- */
30
- static getOptimisticGraph(dependencyGraph) {
31
- // Adjust the critical long task threshold for microseconds
32
- const minimumCpuTaskDuration = CRITICAL_LONG_TASK_THRESHOLD * 1000;
33
-
34
- return dependencyGraph.cloneWithRelationships(node => {
35
- // Include everything that might be a long task
36
- if (node.type === Lantern.BaseNode.TYPES.CPU) {
37
- return node.duration > minimumCpuTaskDuration;
38
- }
39
-
40
- // Include all scripts and high priority requests, exclude all images
41
- const isImage = node.request.resourceType === Lantern.NetworkRequestTypes.Image;
42
- const isScript = node.request.resourceType === Lantern.NetworkRequestTypes.Script;
43
- return (
44
- !isImage &&
45
- (isScript ||
46
- node.request.priority === 'High' ||
47
- node.request.priority === 'VeryHigh')
48
- );
49
- });
50
- }
51
-
52
- /**
53
- * @param {Node} dependencyGraph
54
- * @return {Node}
55
- */
56
- static getPessimisticGraph(dependencyGraph) {
57
- return dependencyGraph;
58
- }
59
-
60
- /**
61
- * @param {Lantern.Simulation.Result} simulationResult
62
- * @param {import('../Metric.js').Extras} extras
63
- * @return {Lantern.Simulation.Result}
64
- */
65
- static getEstimateFromSimulation(simulationResult, extras) {
66
- if (!extras.lcpResult) throw new Error('missing lcpResult');
67
-
68
- const lastTaskAt = Interactive.getLastLongTaskEndTime(simulationResult.nodeTimings);
69
- const minimumTime = extras.optimistic
70
- ? extras.lcpResult.optimisticEstimate.timeInMs
71
- : extras.lcpResult.pessimisticEstimate.timeInMs;
72
- return {
73
- timeInMs: Math.max(minimumTime, lastTaskAt),
74
- nodeTimings: simulationResult.nodeTimings,
75
- };
76
- }
77
-
78
- /**
79
- * @param {Lantern.Simulation.MetricComputationDataInput} data
80
- * @param {Omit<import('../Metric.js').Extras, 'optimistic'>=} extras
81
- * @return {Promise<Lantern.Metrics.Result>}
82
- */
83
- static async compute(data, extras) {
84
- const lcpResult = extras?.lcpResult;
85
- if (!lcpResult) {
86
- throw new Error('LCP is required to calculate the Interactive metric');
87
- }
88
-
89
- const metricResult = await super.compute(data, extras);
90
- metricResult.timing = Math.max(metricResult.timing, lcpResult.timing);
91
- return metricResult;
92
- }
93
-
94
- /**
95
- * @param {Lantern.Simulation.Result['nodeTimings']} nodeTimings
96
- * @return {number}
97
- */
98
- static getLastLongTaskEndTime(nodeTimings, duration = 50) {
99
- return Array.from(nodeTimings.entries())
100
- .filter(([node, timing]) => {
101
- if (node.type !== Lantern.BaseNode.TYPES.CPU) return false;
102
- return timing.duration > duration;
103
- })
104
- .map(([_, timing]) => timing.endTime)
105
- .reduce((max, x) => Math.max(max || 0, x || 0), 0);
106
- }
107
- }
108
-
109
- export {Interactive};
@@ -1,56 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2024 Google LLC
4
- * SPDX-License-Identifier: Apache-2.0
5
- */
6
-
7
- import assert from 'assert/strict';
8
-
9
- import * as Lantern from '../lantern.js';
10
- import {getComputationDataFromFixture} from './MetricTestUtils.js';
11
- import {readJson} from '../../../test/test-utils.js';
12
-
13
- const {Interactive, FirstContentfulPaint, LargestContentfulPaint} = Lantern.Metrics;
14
-
15
- const trace = readJson('../../../test/fixtures/artifacts/progressive-app/trace.json', import.meta);
16
- const iframeTrace = readJson('../../../test/fixtures/artifacts/iframe/trace.json', import.meta);
17
-
18
- describe('Metrics: Lantern TTI', () => {
19
- it('should compute predicted value', async () => {
20
- const data = await getComputationDataFromFixture({trace});
21
- const result = await Interactive.compute(data, {
22
- lcpResult: await LargestContentfulPaint.compute(data, {
23
- fcpResult: await FirstContentfulPaint.compute(data),
24
- }),
25
- });
26
-
27
- expect({
28
- timing: Math.round(result.timing),
29
- optimistic: Math.round(result.optimisticEstimate.timeInMs),
30
- pessimistic: Math.round(result.pessimisticEstimate.timeInMs),
31
- }).toMatchSnapshot();
32
- assert.equal(result.optimisticEstimate.nodeTimings.size, 14);
33
- assert.equal(result.pessimisticEstimate.nodeTimings.size, 31);
34
- assert.ok(result.optimisticGraph, 'should have created optimistic graph');
35
- assert.ok(result.pessimisticGraph, 'should have created pessimistic graph');
36
- });
37
-
38
- it('should compute predicted value on iframes with substantial layout', async () => {
39
- const data = await getComputationDataFromFixture({
40
- trace: iframeTrace,
41
- });
42
- const result = await Interactive.compute(data, {
43
- lcpResult: await LargestContentfulPaint.compute(data, {
44
- fcpResult: await FirstContentfulPaint.compute(data),
45
- }),
46
- });
47
-
48
- expect({
49
- timing: Math.round(result.timing),
50
- optimistic: Math.round(result.optimisticEstimate.timeInMs),
51
- pessimistic: Math.round(result.pessimisticEstimate.timeInMs),
52
- }).toMatchSnapshot();
53
- assert.ok(result.optimisticGraph, 'should have created optimistic graph');
54
- assert.ok(result.pessimisticGraph, 'should have created pessimistic graph');
55
- });
56
- });
@@ -1,19 +0,0 @@
1
- export type Node = import('../BaseNode.js').Node;
2
- /** @typedef {import('../BaseNode.js').Node} Node */
3
- export class LargestContentfulPaint extends Lantern.Metric {
4
- /**
5
- * Low priority image nodes are usually offscreen and very unlikely to be the
6
- * resource that is required for LCP. Our LCP graphs include everything except for these images.
7
- *
8
- * @param {Node} node
9
- * @return {boolean}
10
- */
11
- static isNotLowPriorityImageNode(node: Node): boolean;
12
- /**
13
- * @param {Lantern.Simulation.Result} simulationResult
14
- * @return {Lantern.Simulation.Result}
15
- */
16
- static getEstimateFromSimulation(simulationResult: Lantern.Simulation.Result): Lantern.Simulation.Result;
17
- }
18
- import * as Lantern from '../lantern.js';
19
- //# sourceMappingURL=LargestContentfulPaint.d.ts.map
@@ -1,105 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2024 Google LLC
4
- * SPDX-License-Identifier: Apache-2.0
5
- */
6
-
7
- import * as Lantern from '../lantern.js';
8
-
9
- /** @typedef {import('../BaseNode.js').Node} Node */
10
-
11
- class LargestContentfulPaint extends Lantern.Metric {
12
- /**
13
- * @return {Lantern.Simulation.MetricCoefficients}
14
- */
15
- static get COEFFICIENTS() {
16
- return {
17
- intercept: 0,
18
- optimistic: 0.5,
19
- pessimistic: 0.5,
20
- };
21
- }
22
-
23
- /**
24
- * Low priority image nodes are usually offscreen and very unlikely to be the
25
- * resource that is required for LCP. Our LCP graphs include everything except for these images.
26
- *
27
- * @param {Node} node
28
- * @return {boolean}
29
- */
30
- static isNotLowPriorityImageNode(node) {
31
- if (node.type !== 'network') return true;
32
- const isImage = node.request.resourceType === 'Image';
33
- const isLowPriority = node.request.priority === 'Low' || node.request.priority === 'VeryLow';
34
- return !isImage || !isLowPriority;
35
- }
36
-
37
- /**
38
- * @param {Node} dependencyGraph
39
- * @param {Lantern.Simulation.ProcessedNavigation} processedNavigation
40
- * @return {Node}
41
- */
42
- static getOptimisticGraph(dependencyGraph, processedNavigation) {
43
- const lcp = processedNavigation.timestamps.largestContentfulPaint;
44
- if (!lcp) {
45
- throw new Lantern.Error('NO_LCP');
46
- }
47
-
48
- return Lantern.Metrics.FirstContentfulPaint.getFirstPaintBasedGraph(dependencyGraph, {
49
- cutoffTimestamp: lcp,
50
- treatNodeAsRenderBlocking: LargestContentfulPaint.isNotLowPriorityImageNode,
51
- });
52
- }
53
-
54
- /**
55
- * @param {Node} dependencyGraph
56
- * @param {Lantern.Simulation.ProcessedNavigation} processedNavigation
57
- * @return {Node}
58
- */
59
- static getPessimisticGraph(dependencyGraph, processedNavigation) {
60
- const lcp = processedNavigation.timestamps.largestContentfulPaint;
61
- if (!lcp) {
62
- throw new Lantern.Error('NO_LCP');
63
- }
64
-
65
- return Lantern.Metrics.FirstContentfulPaint.getFirstPaintBasedGraph(dependencyGraph, {
66
- cutoffTimestamp: lcp,
67
- treatNodeAsRenderBlocking: _ => true,
68
- // For pessimistic LCP we'll include *all* layout nodes
69
- additionalCpuNodesToTreatAsRenderBlocking: node => node.didPerformLayout(),
70
- });
71
- }
72
-
73
- /**
74
- * @param {Lantern.Simulation.Result} simulationResult
75
- * @return {Lantern.Simulation.Result}
76
- */
77
- static getEstimateFromSimulation(simulationResult) {
78
- const nodeTimesNotOffscreenImages = Array.from(simulationResult.nodeTimings.entries())
79
- .filter(entry => LargestContentfulPaint.isNotLowPriorityImageNode(entry[0]))
80
- .map(entry => entry[1].endTime);
81
-
82
- return {
83
- timeInMs: Math.max(...nodeTimesNotOffscreenImages),
84
- nodeTimings: simulationResult.nodeTimings,
85
- };
86
- }
87
-
88
- /**
89
- * @param {Lantern.Simulation.MetricComputationDataInput} data
90
- * @param {Omit<import('../Metric.js').Extras, 'optimistic'>=} extras
91
- * @return {Promise<Lantern.Metrics.Result>}
92
- */
93
- static async compute(data, extras) {
94
- const fcpResult = extras?.fcpResult;
95
- if (!fcpResult) {
96
- throw new Error('FCP is required to calculate the LCP metric');
97
- }
98
-
99
- const metricResult = await super.compute(data, extras);
100
- metricResult.timing = Math.max(metricResult.timing, fcpResult.timing);
101
- return metricResult;
102
- }
103
- }
104
-
105
- export {LargestContentfulPaint};
@@ -1,42 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2024 Google LLC
4
- * SPDX-License-Identifier: Apache-2.0
5
- */
6
-
7
- import assert from 'assert/strict';
8
-
9
- import * as Lantern from '../lantern.js';
10
- import {getComputationDataFromFixture} from './MetricTestUtils.js';
11
- import {readJson} from '../../../test/test-utils.js';
12
-
13
- const {FirstContentfulPaint, LargestContentfulPaint} = Lantern.Metrics;
14
-
15
- const trace = readJson('../../../test/fixtures/artifacts/paul/trace.json', import.meta);
16
-
17
- describe('Metrics: Lantern LCP', () => {
18
- it('should compute predicted value', async () => {
19
- const data = await getComputationDataFromFixture({trace});
20
- const result = await LargestContentfulPaint.compute(data, {
21
- fcpResult: await FirstContentfulPaint.compute(data),
22
- });
23
-
24
- expect({
25
- timing: Math.round(result.timing),
26
- optimistic: Math.round(result.optimisticEstimate.timeInMs),
27
- pessimistic: Math.round(result.pessimisticEstimate.timeInMs),
28
- optimisticNodeTimings: result.optimisticEstimate.nodeTimings.size,
29
- pessimisticNodeTimings: result.pessimisticEstimate.nodeTimings.size}).
30
- toMatchInlineSnapshot(`
31
- Object {
32
- "optimistic": 1457,
33
- "optimisticNodeTimings": 8,
34
- "pessimistic": 1616,
35
- "pessimisticNodeTimings": 9,
36
- "timing": 1536,
37
- }
38
- `);
39
- assert.ok(result.optimisticGraph, 'should have created optimistic graph');
40
- assert.ok(result.pessimisticGraph, 'should have created pessimistic graph');
41
- });
42
- });
@@ -1,24 +0,0 @@
1
- export type Node = import('../BaseNode.js').Node;
2
- /** @typedef {import('../BaseNode.js').Node} Node */
3
- export class MaxPotentialFID extends Lantern.Metric {
4
- /**
5
- * @param {Node} dependencyGraph
6
- * @return {Node}
7
- */
8
- static getOptimisticGraph(dependencyGraph: Node): Node;
9
- /**
10
- * @param {Node} dependencyGraph
11
- * @return {Node}
12
- */
13
- static getPessimisticGraph(dependencyGraph: Node): Node;
14
- /**
15
- * @param {Lantern.Simulation.Result['nodeTimings']} nodeTimings
16
- * @param {number} fcpTimeInMs
17
- * @return {Array<{duration: number}>}
18
- */
19
- static getTimingsAfterFCP(nodeTimings: Lantern.Simulation.Result['nodeTimings'], fcpTimeInMs: number): Array<{
20
- duration: number;
21
- }>;
22
- }
23
- import * as Lantern from '../lantern.js';
24
- //# sourceMappingURL=MaxPotentialFID.d.ts.map