@paulirish/trace_engine 0.0.37 → 0.0.38
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.
- package/.tmp/tsbuildinfo/tsconfig.tsbuildinfo +1 -1
- package/core/platform/NumberUtilities.d.ts +0 -1
- package/core/platform/NumberUtilities.js +0 -17
- package/core/platform/NumberUtilities.js.map +1 -1
- package/core/platform/PromiseUtilities.d.ts +10 -0
- package/core/platform/PromiseUtilities.js +18 -0
- package/core/platform/PromiseUtilities.js.map +1 -0
- package/core/platform/SetUtilities.d.ts +2 -0
- package/core/platform/SetUtilities.js +23 -0
- package/core/platform/SetUtilities.js.map +1 -0
- package/generated/protocol.d.ts +36 -8
- package/models/trace/EntriesFilter.d.ts +72 -0
- package/models/trace/EntriesFilter.js +296 -0
- package/models/trace/EntriesFilter.js.map +1 -0
- package/models/trace/LegacyTracingModel.js.map +1 -0
- package/models/trace/extras/Metadata.d.ts +2 -1
- package/models/trace/extras/Metadata.js +23 -4
- package/models/trace/extras/Metadata.js.map +1 -1
- package/models/trace/extras/TraceTree.d.ts +10 -7
- package/models/trace/extras/TraceTree.js +30 -15
- package/models/trace/extras/TraceTree.js.map +1 -1
- package/models/trace/extras/URLForEntry.d.ts +6 -5
- package/models/trace/extras/URLForEntry.js +6 -5
- package/models/trace/extras/URLForEntry.js.map +1 -1
- package/models/trace/handlers/EnhancedTracesHandler.d.ts +48 -0
- package/models/trace/handlers/EnhancedTracesHandler.js +165 -0
- package/models/trace/handlers/EnhancedTracesHandler.js.map +1 -0
- package/models/trace/handlers/FlowsHandler.d.ts +7 -0
- package/models/trace/handlers/FlowsHandler.js +157 -0
- package/models/trace/handlers/FlowsHandler.js.map +1 -0
- package/models/trace/handlers/ImagePaintingHandler.d.ts +1 -0
- package/models/trace/handlers/ImagePaintingHandler.js +8 -0
- package/models/trace/handlers/ImagePaintingHandler.js.map +1 -1
- package/models/trace/handlers/ModelHandlers.d.ts +1 -0
- package/models/trace/handlers/ModelHandlers.js +1 -0
- package/models/trace/handlers/ModelHandlers.js.map +1 -1
- package/models/trace/handlers/PageLoadMetricsHandler.d.ts +2 -1
- package/models/trace/handlers/PageLoadMetricsHandler.js.map +1 -1
- package/models/trace/handlers/handlers-tsconfig.json +1 -0
- package/models/trace/helpers/Timing.d.ts +1 -0
- package/models/trace/helpers/Timing.js +7 -0
- package/models/trace/helpers/Timing.js.map +1 -1
- package/models/trace/insights/CLSCulprits.d.ts +1 -1
- package/models/trace/insights/CLSCulprits.js +32 -3
- package/models/trace/insights/CLSCulprits.js.map +1 -1
- package/models/trace/insights/CumulativeLayoutShift.d.ts +13 -36
- package/models/trace/insights/CumulativeLayoutShift.js +73 -199
- package/models/trace/insights/CumulativeLayoutShift.js.map +1 -1
- package/models/trace/insights/DocumentLatency.d.ts +1 -1
- package/models/trace/insights/DocumentLatency.js +31 -3
- package/models/trace/insights/DocumentLatency.js.map +1 -1
- package/models/trace/insights/FontDisplay.d.ts +1 -1
- package/models/trace/insights/FontDisplay.js +23 -2
- package/models/trace/insights/FontDisplay.js.map +1 -1
- package/models/trace/insights/ImageDelivery.d.ts +23 -0
- package/models/trace/insights/ImageDelivery.js +130 -0
- package/models/trace/insights/ImageDelivery.js.map +1 -0
- package/models/trace/insights/InsightRunners.d.ts +0 -3
- package/models/trace/insights/InsightRunners.js +0 -3
- package/models/trace/insights/InsightRunners.js.map +1 -1
- package/models/trace/insights/InteractionToNextPaint.d.ts +1 -1
- package/models/trace/insights/InteractionToNextPaint.js +26 -3
- package/models/trace/insights/InteractionToNextPaint.js.map +1 -1
- package/models/trace/insights/LCPDiscovery.js +36 -9
- package/models/trace/insights/LCPDiscovery.js.map +1 -1
- package/models/trace/insights/LCPPhases.js +40 -8
- package/models/trace/insights/LCPPhases.js.map +1 -1
- package/models/trace/insights/LargestContentfulPaint.d.ts +7 -20
- package/models/trace/insights/LargestContentfulPaint.js +37 -57
- package/models/trace/insights/LargestContentfulPaint.js.map +1 -1
- package/models/trace/insights/Models.d.ts +1 -0
- package/models/trace/insights/Models.js +1 -0
- package/models/trace/insights/Models.js.map +1 -1
- package/models/trace/insights/RenderBlocking.js +31 -7
- package/models/trace/insights/RenderBlocking.js.map +1 -1
- package/models/trace/insights/SlowCSSSelector.d.ts +1 -1
- package/models/trace/insights/SlowCSSSelector.js +27 -4
- package/models/trace/insights/SlowCSSSelector.js.map +1 -1
- package/models/trace/insights/ThirdParties.d.ts +1 -1
- package/models/trace/insights/ThirdParties.js +25 -2
- package/models/trace/insights/ThirdParties.js.map +1 -1
- package/models/trace/insights/Viewport.js +27 -7
- package/models/trace/insights/Viewport.js.map +1 -1
- package/models/trace/insights/insights-tsconfig.json +1 -0
- package/models/trace/insights/types.d.ts +12 -0
- package/models/trace/insights/types.js +7 -0
- package/models/trace/insights/types.js.map +1 -1
- package/models/trace/lantern/BaseNode.d.ts +91 -0
- package/models/trace/lantern/BaseNode.js +268 -0
- package/models/trace/lantern/BaseNode.js.map +1 -0
- package/models/trace/lantern/CPUNode.d.ts +24 -0
- package/models/trace/lantern/CPUNode.js +64 -0
- package/models/trace/lantern/CPUNode.js.map +1 -0
- package/models/trace/lantern/LanternError.d.ts +3 -0
- package/models/trace/lantern/LanternError.js +7 -0
- package/models/trace/lantern/LanternError.js.map +1 -0
- package/models/trace/lantern/MetricsModule.d.ts +11 -0
- package/models/trace/lantern/MetricsModule.js +14 -0
- package/models/trace/lantern/MetricsModule.js.map +1 -0
- package/models/trace/lantern/NetworkNode.d.ts +22 -0
- package/models/trace/lantern/NetworkNode.js +83 -0
- package/models/trace/lantern/NetworkNode.js.map +1 -0
- package/models/trace/lantern/PageDependencyGraph.d.ts +43 -0
- package/models/trace/lantern/PageDependencyGraph.js +509 -0
- package/models/trace/lantern/PageDependencyGraph.js.map +1 -0
- package/models/trace/lantern/SimulationModule.d.ts +17 -0
- package/models/trace/lantern/SimulationModule.js +13 -0
- package/models/trace/lantern/SimulationModule.js.map +1 -0
- package/models/trace/lantern/simulation/NetworkAnalyzer.d.ts +112 -0
- package/models/trace/lantern/simulation/NetworkAnalyzer.js +486 -0
- package/models/trace/lantern/simulation/NetworkAnalyzer.js.map +1 -0
- package/models/trace/types/File.d.ts +5 -0
- package/models/trace/types/File.js +3 -0
- package/models/trace/types/File.js.map +1 -1
- package/models/trace/types/TraceEvents.d.ts +5 -0
- package/models/trace/types/TraceEvents.js +12 -2
- package/models/trace/types/TraceEvents.js.map +1 -1
- package/models/trace/types/types-tsconfig.json +6 -0
- package/package.json +1 -1
- package/test/test-trace-engine.mjs +10 -4
- package/.tmp/tsbuildinfo/models/trace/LanternComputationData.d.ts +0 -46
- package/.tmp/tsbuildinfo/models/trace/LanternComputationData.d.ts.map +0 -1
- package/.tmp/tsbuildinfo/models/trace/LegacyTracingModel.d.ts +0 -2
- package/.tmp/tsbuildinfo/models/trace/LegacyTracingModel.d.ts.map +0 -1
- package/.tmp/tsbuildinfo/models/trace/ModelImpl.d.ts +0 -72
- package/.tmp/tsbuildinfo/models/trace/ModelImpl.d.ts.map +0 -1
- package/.tmp/tsbuildinfo/models/trace/Processor.d.ts +0 -25
- package/.tmp/tsbuildinfo/models/trace/Processor.d.ts.map +0 -1
- package/.tmp/tsbuildinfo/models/trace/TracingManager.d.ts +0 -2
- package/.tmp/tsbuildinfo/models/trace/TracingManager.d.ts.map +0 -1
- package/.tmp/tsbuildinfo/models/trace/trace.d.ts +0 -13
- package/.tmp/tsbuildinfo/models/trace/trace.d.ts.map +0 -1
- package/models/trace/insights/ThirdPartyWeb.d.ts +0 -13
- package/models/trace/insights/ThirdPartyWeb.js +0 -42
- package/models/trace/insights/ThirdPartyWeb.js.map +0 -1
|
@@ -1,12 +1,33 @@
|
|
|
1
1
|
// Copyright 2024 The Chromium Authors. All rights reserved.
|
|
2
2
|
// Use of this source code is governed by a BSD-style license that can be
|
|
3
3
|
// found in the LICENSE file.
|
|
4
|
+
// import * as i18n from '../../../core/i18n/i18n.js';
|
|
4
5
|
import * as Platform from '../../../core/platform/platform.js';
|
|
5
6
|
import * as Helpers from '../helpers/helpers.js';
|
|
6
7
|
import * as Types from '../types/types.js';
|
|
8
|
+
import { InsightCategory } from './types.js';
|
|
9
|
+
const UIStrings = {
|
|
10
|
+
/** Title of an insight that provides details about the fonts used on the page, and the value of their `font-display` properties. */
|
|
11
|
+
title: 'Font display',
|
|
12
|
+
/**
|
|
13
|
+
* @description Text to tell the user about the font-display CSS feature to help improve a the UX of a page.
|
|
14
|
+
*/
|
|
15
|
+
description: 'Consider setting [`font-display`](https://developer.chrome.com/blog/font-display) to `swap` or `optional` to ensure text is consistently visible. `swap` can be further optimized to mitigate layout shifts with [font metric overrides](https://developer.chrome.com/blog/font-fallbacks).',
|
|
16
|
+
};
|
|
17
|
+
// const str_ = i18n.i18n.registerUIStrings('models/trace/insights/FontDisplay.ts', UIStrings);
|
|
18
|
+
const i18nString = string => string; // i18n.i18n.getLocalizedString.bind(undefined, str_);
|
|
7
19
|
export function deps() {
|
|
8
20
|
return ['Meta', 'NetworkRequests', 'LayoutShifts'];
|
|
9
21
|
}
|
|
22
|
+
function finalize(partialModel) {
|
|
23
|
+
return {
|
|
24
|
+
title: i18nString(UIStrings.title),
|
|
25
|
+
description: i18nString(UIStrings.description),
|
|
26
|
+
category: InsightCategory.INP,
|
|
27
|
+
shouldShow: Boolean(partialModel.fonts.find(font => font.wastedTime > 0)),
|
|
28
|
+
...partialModel,
|
|
29
|
+
};
|
|
30
|
+
}
|
|
10
31
|
export function generateInsight(parsedTrace, context) {
|
|
11
32
|
const fonts = [];
|
|
12
33
|
for (const event of parsedTrace.LayoutShifts.beginRemoteFontLoadEvents) {
|
|
@@ -35,10 +56,10 @@ export function generateInsight(parsedTrace, context) {
|
|
|
35
56
|
}
|
|
36
57
|
fonts.sort((a, b) => b.wastedTime - a.wastedTime);
|
|
37
58
|
const savings = Math.max(...fonts.map(f => f.wastedTime));
|
|
38
|
-
return {
|
|
59
|
+
return finalize({
|
|
39
60
|
relatedEvents: fonts.map(f => f.request),
|
|
40
61
|
fonts,
|
|
41
62
|
metricSavings: { FCP: savings },
|
|
42
|
-
};
|
|
63
|
+
});
|
|
43
64
|
}
|
|
44
65
|
//# sourceMappingURL=FontDisplay.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FontDisplay.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/FontDisplay.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"FontDisplay.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/FontDisplay.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,IAAI,MAAM,4BAA4B,CAAC;AACnD,OAAO,KAAK,QAAQ,MAAM,oCAAoC,CAAC;AAC/D,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAC,eAAe,EAA+D,MAAM,YAAY,CAAC;AAEzG,MAAM,SAAS,GAAG;IAChB,oIAAoI;IACpI,KAAK,EAAE,cAAc;IACrB;;OAEG;IACH,WAAW,EACP,6RAA6R;CAClS,CAAC;AAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,sCAAsC,EAAE,SAAS,CAAC,CAAC;AAC5F,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAEtE,MAAM,UAAU,IAAI;IAClB,OAAO,CAAC,MAAM,EAAE,iBAAiB,EAAE,cAAc,CAAC,CAAC;AACrD,CAAC;AAUD,SAAS,QAAQ,CAAC,YAA0F;IAE1G,OAAO;QACL,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;QAClC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC;QAC9C,QAAQ,EAAE,eAAe,CAAC,GAAG;QAC7B,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QACzE,GAAG,YAAY;KAChB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAC3B,WAAsC,EAAE,OAA0B;IACpE,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,YAAY,CAAC,yBAAyB,EAAE,CAAC;QACvE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3D,SAAS;QACX,CAAC;QAED,MAAM,SAAS,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;QAClD,MAAM,OAAO,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,SAAS;QACX,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;QACnC,IAAI,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAE9C,IAAI,yBAAyB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5C,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,YAAY,CAC7C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAChG,2FAA2F;YAC3F,UAAU,GAAG,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,CAAC,GAAG,CAAC,CAChF,CAAC;YAC9B,yCAAyC;YACzC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAA8B,CAAC;QACvE,CAAC;QAED,KAAK,CAAC,IAAI,CAAC;YACT,OAAO;YACP,OAAO;YACP,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC;IAElD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAA8B,CAAC;IAEvF,OAAO,QAAQ,CAAC;QACd,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;QACxC,KAAK;QACL,aAAa,EAAE,EAAC,GAAG,EAAE,OAAO,EAAC;KAC9B,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nimport * as i18n from '../../../core/i18n/i18n.js';\nimport * as Platform from '../../../core/platform/platform.js';\nimport * as Helpers from '../helpers/helpers.js';\nimport * as Types from '../types/types.js';\n\nimport {InsightCategory, type InsightModel, type InsightSetContext, type RequiredData} from './types.js';\n\nconst UIStrings = {\n /** Title of an insight that provides details about the fonts used on the page, and the value of their `font-display` properties. */\n title: 'Font display',\n /**\n * @description Text to tell the user about the font-display CSS feature to help improve a the UX of a page.\n */\n description:\n 'Consider setting [`font-display`](https://developer.chrome.com/blog/font-display) to `swap` or `optional` to ensure text is consistently visible. `swap` can be further optimized to mitigate layout shifts with [font metric overrides](https://developer.chrome.com/blog/font-fallbacks).',\n};\n\nconst str_ = i18n.i18n.registerUIStrings('models/trace/insights/FontDisplay.ts', UIStrings);\nconst i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);\n\nexport function deps(): ['Meta', 'NetworkRequests', 'LayoutShifts'] {\n return ['Meta', 'NetworkRequests', 'LayoutShifts'];\n}\n\nexport type FontDisplayInsightModel = InsightModel<{\n fonts: Array<{\n request: Types.Events.SyntheticNetworkRequest,\n display: string,\n wastedTime: Types.Timing.MilliSeconds,\n }>,\n}>;\n\nfunction finalize(partialModel: Omit<FontDisplayInsightModel, 'title'|'description'|'category'|'shouldShow'>):\n FontDisplayInsightModel {\n return {\n title: i18nString(UIStrings.title),\n description: i18nString(UIStrings.description),\n category: InsightCategory.INP,\n shouldShow: Boolean(partialModel.fonts.find(font => font.wastedTime > 0)),\n ...partialModel,\n };\n}\n\nexport function generateInsight(\n parsedTrace: RequiredData<typeof deps>, context: InsightSetContext): FontDisplayInsightModel {\n const fonts = [];\n for (const event of parsedTrace.LayoutShifts.beginRemoteFontLoadEvents) {\n if (!Helpers.Timing.eventIsInBounds(event, context.bounds)) {\n continue;\n }\n\n const requestId = `${event.pid}.${event.args.id}`;\n const request = parsedTrace.NetworkRequests.byId.get(requestId);\n if (!request) {\n continue;\n }\n\n const display = event.args.display;\n let wastedTime = Types.Timing.MilliSeconds(0);\n\n if (/^(block|fallback|auto)$/.test(display)) {\n const wastedTimeMicro = Types.Timing.MicroSeconds(\n request.args.data.syntheticData.finishTime - request.args.data.syntheticData.sendStartTime);\n // TODO(crbug.com/352244504): should really end at the time of the next Commit trace event.\n wastedTime = Platform.NumberUtilities.floor(Helpers.Timing.microSecondsToMilliseconds(wastedTimeMicro), 1 / 5) as\n Types.Timing.MilliSeconds;\n // All browsers wait for no more than 3s.\n wastedTime = Math.min(wastedTime, 3000) as Types.Timing.MilliSeconds;\n }\n\n fonts.push({\n request,\n display,\n wastedTime,\n });\n }\n\n fonts.sort((a, b) => b.wastedTime - a.wastedTime);\n\n const savings = Math.max(...fonts.map(f => f.wastedTime)) as Types.Timing.MilliSeconds;\n\n return finalize({\n relatedEvents: fonts.map(f => f.request),\n fonts,\n metricSavings: {FCP: savings},\n });\n}\n"]}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type * as Types from '../types/types.js';
|
|
2
|
+
import { type InsightModel, type InsightSetContext, type RequiredData } from './types.js';
|
|
3
|
+
export declare function deps(): ['NetworkRequests', 'Meta', 'ImagePainting'];
|
|
4
|
+
export type ImageOptimizationType = 'modern-format-or-compression' | 'compression' | 'video-format' | 'responsive-size';
|
|
5
|
+
export interface ImageOptimization {
|
|
6
|
+
type: ImageOptimizationType;
|
|
7
|
+
byteSavings: number;
|
|
8
|
+
}
|
|
9
|
+
export interface OptimizableImage {
|
|
10
|
+
request: Types.Events.SyntheticNetworkRequest;
|
|
11
|
+
optimizations: ImageOptimization[];
|
|
12
|
+
/**
|
|
13
|
+
* If the an image resource has multiple `PaintImage`s, we compare its intrinsic size to the largest of the displayed sizes.
|
|
14
|
+
*
|
|
15
|
+
* It is theoretically possible for `PaintImage` events with the same URL to have different intrinsic sizes.
|
|
16
|
+
* However, this should be rare because it requires serving different images from the same URL.
|
|
17
|
+
*/
|
|
18
|
+
largestImagePaint: Types.Events.PaintImage;
|
|
19
|
+
}
|
|
20
|
+
export type ImageDeliveryInsightModel = InsightModel<{
|
|
21
|
+
optimizableImages: OptimizableImage[];
|
|
22
|
+
}>;
|
|
23
|
+
export declare function generateInsight(parsedTrace: RequiredData<typeof deps>, context: InsightSetContext): ImageDeliveryInsightModel;
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
// Copyright 2024 The Chromium Authors. All rights reserved.
|
|
2
|
+
// Use of this source code is governed by a BSD-style license that can be
|
|
3
|
+
// found in the LICENSE file.
|
|
4
|
+
// import * as i18n from '../../../core/i18n/i18n.js';
|
|
5
|
+
import * as Helpers from '../helpers/helpers.js';
|
|
6
|
+
import { InsightCategory } from './types.js';
|
|
7
|
+
const UIStrings = {
|
|
8
|
+
/**
|
|
9
|
+
* @description Title of an insight that recommends ways to reduce the size of images downloaded and used on the page.
|
|
10
|
+
*/
|
|
11
|
+
title: 'Improve image delivery',
|
|
12
|
+
/**
|
|
13
|
+
* @description Description of an insight that recommends ways to reduce the size of images downloaded and used on the page.
|
|
14
|
+
*/
|
|
15
|
+
description: 'Reducing the download time of images can improve the perceived load time of the page and LCP. [Learn more about optimizing image size](https://developer.chrome.com/docs/lighthouse/performance/uses-optimized-images/)',
|
|
16
|
+
};
|
|
17
|
+
// const str_ = i18n.i18n.registerUIStrings('models/trace/insights/ImageDelivery.ts', UIStrings);
|
|
18
|
+
const i18nString = string => string; // i18n.i18n.getLocalizedString.bind(undefined, str_);
|
|
19
|
+
/**
|
|
20
|
+
* Even JPEGs with lots of detail can usually be compressed down to <1 byte per pixel
|
|
21
|
+
* Using 4:2:2 subsampling already gets an uncompressed bitmap to 2 bytes per pixel.
|
|
22
|
+
* The compression ratio for JPEG is usually somewhere around 10:1 depending on content, so
|
|
23
|
+
* 8:1 is a reasonable expectation for web content which is 1.5MB for a 6MP image.
|
|
24
|
+
*
|
|
25
|
+
* WebP usually gives ~20% additional savings on top of that, so we will assume 10:1 for WebP.
|
|
26
|
+
* This is quite pessimistic as their study shows a photographic compression ratio of ~29:1.
|
|
27
|
+
* https://developers.google.com/speed/webp/docs/webp_lossless_alpha_study#results
|
|
28
|
+
*
|
|
29
|
+
* AVIF usually gives ~20% additional savings on top of WebP, so we will use 12:1 for AVIF.
|
|
30
|
+
* This is quite pessimistic as Netflix study shows a photographic compression ratio of ~40:1
|
|
31
|
+
* (0.4 *bits* per pixel at SSIM 0.97).
|
|
32
|
+
* https://netflixtechblog.com/avif-for-next-generation-image-coding-b1d75675fe4
|
|
33
|
+
*/
|
|
34
|
+
const TARGET_BYTES_PER_PIXEL_AVIF = 2 * 1 / 12;
|
|
35
|
+
/**
|
|
36
|
+
* If GIFs are above this size, we'll flag them
|
|
37
|
+
* See https://github.com/GoogleChrome/lighthouse/pull/4885#discussion_r178406623 and https://github.com/GoogleChrome/lighthouse/issues/4696#issuecomment-370979920
|
|
38
|
+
*/
|
|
39
|
+
const GIF_SIZE_THRESHOLD = 100 * 1024;
|
|
40
|
+
const BYTE_SAVINGS_THRESHOLD = 4096;
|
|
41
|
+
export function deps() {
|
|
42
|
+
return ['NetworkRequests', 'Meta', 'ImagePainting'];
|
|
43
|
+
}
|
|
44
|
+
function finalize(partialModel) {
|
|
45
|
+
return {
|
|
46
|
+
title: i18nString(UIStrings.title),
|
|
47
|
+
description: i18nString(UIStrings.description),
|
|
48
|
+
category: InsightCategory.LCP,
|
|
49
|
+
shouldShow: partialModel.optimizableImages.length > 0,
|
|
50
|
+
...partialModel,
|
|
51
|
+
relatedEvents: partialModel.optimizableImages.map(image => image.request),
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Calculate rough savings percentage based on 1000 real gifs transcoded to video
|
|
56
|
+
* https://github.com/GoogleChrome/lighthouse/issues/4696#issuecomment-380296510
|
|
57
|
+
*/
|
|
58
|
+
function estimateGIFPercentSavings(request) {
|
|
59
|
+
return Math.round((29.1 * Math.log10(request.args.data.decodedBodyLength) - 100.7)) / 100;
|
|
60
|
+
}
|
|
61
|
+
function getPixelCounts(paintImage) {
|
|
62
|
+
return {
|
|
63
|
+
filePixels: paintImage.args.data.srcWidth * paintImage.args.data.srcHeight,
|
|
64
|
+
displayedPixels: paintImage.args.data.width * paintImage.args.data.height,
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
export function generateInsight(parsedTrace, context) {
|
|
68
|
+
const isWithinContext = (event) => Helpers.Timing.eventIsInBounds(event, context.bounds);
|
|
69
|
+
const contextRequests = parsedTrace.NetworkRequests.byTime.filter(isWithinContext);
|
|
70
|
+
const optimizableImages = [];
|
|
71
|
+
for (const request of contextRequests) {
|
|
72
|
+
if (request.args.data.resourceType !== 'Image') {
|
|
73
|
+
continue;
|
|
74
|
+
}
|
|
75
|
+
const imagePaints = parsedTrace.ImagePainting.paintImageEventForUrl.get(request.args.data.url)?.filter(isWithinContext);
|
|
76
|
+
// This will filter out things like preloaded image requests where an image file is downloaded
|
|
77
|
+
// but never rendered on the page.
|
|
78
|
+
if (!imagePaints?.length) {
|
|
79
|
+
continue;
|
|
80
|
+
}
|
|
81
|
+
const largestImagePaint = imagePaints.reduce((prev, curr) => {
|
|
82
|
+
const prevPixels = getPixelCounts(prev).displayedPixels;
|
|
83
|
+
const currPixels = getPixelCounts(curr).displayedPixels;
|
|
84
|
+
return prevPixels > currPixels ? prev : curr;
|
|
85
|
+
});
|
|
86
|
+
const { filePixels: imageFilePixels, displayedPixels: largestImageDisplayPixels, } = getPixelCounts(largestImagePaint);
|
|
87
|
+
// Decoded body length is almost always the right one to be using because of the below:
|
|
88
|
+
// `encodedDataLength = decodedBodyLength + headers`.
|
|
89
|
+
// HOWEVER, there are some cases where an image is compressed again over the network and transfer size
|
|
90
|
+
// is smaller (see https://github.com/GoogleChrome/lighthouse/pull/4968).
|
|
91
|
+
// Use the min of the two numbers to be safe.
|
|
92
|
+
const imageBytes = Math.min(request.args.data.decodedBodyLength, request.args.data.encodedDataLength);
|
|
93
|
+
const bytesPerPixel = imageBytes / imageFilePixels;
|
|
94
|
+
let optimizations = [];
|
|
95
|
+
if (request.args.data.mimeType === 'image/gif') {
|
|
96
|
+
if (imageBytes > GIF_SIZE_THRESHOLD) {
|
|
97
|
+
const percentSavings = estimateGIFPercentSavings(request);
|
|
98
|
+
const byteSavings = Math.round(imageBytes * percentSavings);
|
|
99
|
+
optimizations.push({ type: 'video-format', byteSavings });
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
else if (bytesPerPixel > TARGET_BYTES_PER_PIXEL_AVIF) {
|
|
103
|
+
const idealAvifImageSize = Math.round(TARGET_BYTES_PER_PIXEL_AVIF * imageFilePixels);
|
|
104
|
+
const byteSavings = imageBytes - idealAvifImageSize;
|
|
105
|
+
if (request.args.data.mimeType !== 'image/webp' && request.args.data.mimeType !== 'image/avif') {
|
|
106
|
+
optimizations.push({ type: 'modern-format-or-compression', byteSavings });
|
|
107
|
+
}
|
|
108
|
+
else {
|
|
109
|
+
optimizations.push({ type: 'compression', byteSavings });
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
const wastedPixelRatio = 1 - (largestImageDisplayPixels / imageFilePixels);
|
|
113
|
+
if (wastedPixelRatio > 0) {
|
|
114
|
+
const byteSavings = Math.round(wastedPixelRatio * imageBytes);
|
|
115
|
+
optimizations.push({ type: 'responsive-size', byteSavings });
|
|
116
|
+
}
|
|
117
|
+
optimizations = optimizations.filter(optimization => optimization.byteSavings > BYTE_SAVINGS_THRESHOLD);
|
|
118
|
+
if (optimizations.length > 0) {
|
|
119
|
+
optimizableImages.push({
|
|
120
|
+
request,
|
|
121
|
+
largestImagePaint,
|
|
122
|
+
optimizations,
|
|
123
|
+
});
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
return finalize({
|
|
127
|
+
optimizableImages,
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
//# sourceMappingURL=ImageDelivery.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ImageDelivery.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/ImageDelivery.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,IAAI,MAAM,4BAA4B,CAAC;AACnD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AAGjD,OAAO,EAAC,eAAe,EAA+D,MAAM,YAAY,CAAC;AAEzG,MAAM,SAAS,GAAG;IAChB;;OAEG;IACH,KAAK,EAAE,wBAAwB;IAC/B;;OAEG;IACH,WAAW,EACP,yNAAyN;CAC9N,CAAC;AAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,wCAAwC,EAAE,SAAS,CAAC,CAAC;AAC9F,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAEtE;;;;;;;;;;;;;;GAcG;AACH,MAAM,2BAA2B,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;AAE/C;;;GAGG;AACH,MAAM,kBAAkB,GAAG,GAAG,GAAG,IAAI,CAAC;AAEtC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAEpC,MAAM,UAAU,IAAI;IAClB,OAAO,CAAC,iBAAiB,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;AACtD,CAAC;AAyBD,SAAS,QAAQ,CAAC,YAA4F;IAE5G,OAAO;QACL,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;QAClC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC;QAC9C,QAAQ,EAAE,eAAe,CAAC,GAAG;QAC7B,UAAU,EAAE,YAAY,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC;QACrD,GAAG,YAAY;QACf,aAAa,EAAE,YAAY,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;KAC1E,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,yBAAyB,CAAC,OAA6C;IAC9E,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC;AAC5F,CAAC;AAED,SAAS,cAAc,CAAC,UAAmC;IACzD,OAAO;QACL,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS;QAC1E,eAAe,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;KAC1E,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAC3B,WAAsC,EAAE,OAA0B;IACpE,MAAM,eAAe,GAAG,CAAC,KAAyB,EAAW,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtH,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAEnF,MAAM,iBAAiB,GAAuB,EAAE,CAAC;IACjD,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE,CAAC;QACtC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,KAAK,OAAO,EAAE,CAAC;YAC/C,SAAS;QACX,CAAC;QAED,MAAM,WAAW,GACb,WAAW,CAAC,aAAa,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;QAExG,8FAA8F;QAC9F,kCAAkC;QAClC,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;YACzB,SAAS;QACX,CAAC;QAED,MAAM,iBAAiB,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YAC1D,MAAM,UAAU,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC;YACxD,MAAM,UAAU,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC;YACxD,OAAO,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,MAAM,EACJ,UAAU,EAAE,eAAe,EAC3B,eAAe,EAAE,yBAAyB,GAC3C,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;QAEtC,uFAAuF;QACvF,yDAAyD;QACzD,sGAAsG;QACtG,yEAAyE;QACzE,6CAA6C;QAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAEtG,MAAM,aAAa,GAAG,UAAU,GAAG,eAAe,CAAC;QAEnD,IAAI,aAAa,GAAwB,EAAE,CAAC;QAC5C,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;YAC/C,IAAI,UAAU,GAAG,kBAAkB,EAAE,CAAC;gBACpC,MAAM,cAAc,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;gBAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,cAAc,CAAC,CAAC;gBAC5D,aAAa,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,cAAc,EAAE,WAAW,EAAC,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;aAAM,IAAI,aAAa,GAAG,2BAA2B,EAAE,CAAC;YACvD,MAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,2BAA2B,GAAG,eAAe,CAAC,CAAC;YACrF,MAAM,WAAW,GAAG,UAAU,GAAG,kBAAkB,CAAC;YACpD,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;gBAC/F,aAAa,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,8BAA8B,EAAE,WAAW,EAAC,CAAC,CAAC;YAC1E,CAAC;iBAAM,CAAC;gBACN,aAAa,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,aAAa,EAAE,WAAW,EAAC,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QAED,MAAM,gBAAgB,GAAG,CAAC,GAAG,CAAC,yBAAyB,GAAG,eAAe,CAAC,CAAC;QAC3E,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,UAAU,CAAC,CAAC;YAC9D,aAAa,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,iBAAiB,EAAE,WAAW,EAAC,CAAC,CAAC;QAC7D,CAAC;QAED,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,GAAG,sBAAsB,CAAC,CAAC;QAExG,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,iBAAiB,CAAC,IAAI,CAAC;gBACrB,OAAO;gBACP,iBAAiB;gBACjB,aAAa;aACd,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;QACd,iBAAiB;KAClB,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nimport * as i18n from '../../../core/i18n/i18n.js';\nimport * as Helpers from '../helpers/helpers.js';\nimport type * as Types from '../types/types.js';\n\nimport {InsightCategory, type InsightModel, type InsightSetContext, type RequiredData} from './types.js';\n\nconst UIStrings = {\n /**\n * @description Title of an insight that recommends ways to reduce the size of images downloaded and used on the page.\n */\n title: 'Improve image delivery',\n /**\n * @description Description of an insight that recommends ways to reduce the size of images downloaded and used on the page.\n */\n description:\n 'Reducing the download time of images can improve the perceived load time of the page and LCP. [Learn more about optimizing image size](https://developer.chrome.com/docs/lighthouse/performance/uses-optimized-images/)',\n};\n\nconst str_ = i18n.i18n.registerUIStrings('models/trace/insights/ImageDelivery.ts', UIStrings);\nconst i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);\n\n/**\n * Even JPEGs with lots of detail can usually be compressed down to <1 byte per pixel\n * Using 4:2:2 subsampling already gets an uncompressed bitmap to 2 bytes per pixel.\n * The compression ratio for JPEG is usually somewhere around 10:1 depending on content, so\n * 8:1 is a reasonable expectation for web content which is 1.5MB for a 6MP image.\n *\n * WebP usually gives ~20% additional savings on top of that, so we will assume 10:1 for WebP.\n * This is quite pessimistic as their study shows a photographic compression ratio of ~29:1.\n * https://developers.google.com/speed/webp/docs/webp_lossless_alpha_study#results\n *\n * AVIF usually gives ~20% additional savings on top of WebP, so we will use 12:1 for AVIF.\n * This is quite pessimistic as Netflix study shows a photographic compression ratio of ~40:1\n * (0.4 *bits* per pixel at SSIM 0.97).\n * https://netflixtechblog.com/avif-for-next-generation-image-coding-b1d75675fe4\n */\nconst TARGET_BYTES_PER_PIXEL_AVIF = 2 * 1 / 12;\n\n/**\n * If GIFs are above this size, we'll flag them\n * See https://github.com/GoogleChrome/lighthouse/pull/4885#discussion_r178406623 and https://github.com/GoogleChrome/lighthouse/issues/4696#issuecomment-370979920\n */\nconst GIF_SIZE_THRESHOLD = 100 * 1024;\n\nconst BYTE_SAVINGS_THRESHOLD = 4096;\n\nexport function deps(): ['NetworkRequests', 'Meta', 'ImagePainting'] {\n return ['NetworkRequests', 'Meta', 'ImagePainting'];\n}\n\nexport type ImageOptimizationType = 'modern-format-or-compression'|'compression'|'video-format'|'responsive-size';\n\nexport interface ImageOptimization {\n type: ImageOptimizationType;\n byteSavings: number;\n}\n\nexport interface OptimizableImage {\n request: Types.Events.SyntheticNetworkRequest;\n optimizations: ImageOptimization[];\n /**\n * If the an image resource has multiple `PaintImage`s, we compare its intrinsic size to the largest of the displayed sizes.\n *\n * It is theoretically possible for `PaintImage` events with the same URL to have different intrinsic sizes.\n * However, this should be rare because it requires serving different images from the same URL.\n */\n largestImagePaint: Types.Events.PaintImage;\n}\n\nexport type ImageDeliveryInsightModel = InsightModel<{\n optimizableImages: OptimizableImage[],\n}>;\n\nfunction finalize(partialModel: Omit<ImageDeliveryInsightModel, 'title'|'description'|'category'|'shouldShow'>):\n ImageDeliveryInsightModel {\n return {\n title: i18nString(UIStrings.title),\n description: i18nString(UIStrings.description),\n category: InsightCategory.LCP,\n shouldShow: partialModel.optimizableImages.length > 0,\n ...partialModel,\n relatedEvents: partialModel.optimizableImages.map(image => image.request),\n };\n}\n\n/**\n * Calculate rough savings percentage based on 1000 real gifs transcoded to video\n * https://github.com/GoogleChrome/lighthouse/issues/4696#issuecomment-380296510\n */\nfunction estimateGIFPercentSavings(request: Types.Events.SyntheticNetworkRequest): number {\n return Math.round((29.1 * Math.log10(request.args.data.decodedBodyLength) - 100.7)) / 100;\n}\n\nfunction getPixelCounts(paintImage: Types.Events.PaintImage): {displayedPixels: number, filePixels: number} {\n return {\n filePixels: paintImage.args.data.srcWidth * paintImage.args.data.srcHeight,\n displayedPixels: paintImage.args.data.width * paintImage.args.data.height,\n };\n}\n\nexport function generateInsight(\n parsedTrace: RequiredData<typeof deps>, context: InsightSetContext): ImageDeliveryInsightModel {\n const isWithinContext = (event: Types.Events.Event): boolean => Helpers.Timing.eventIsInBounds(event, context.bounds);\n\n const contextRequests = parsedTrace.NetworkRequests.byTime.filter(isWithinContext);\n\n const optimizableImages: OptimizableImage[] = [];\n for (const request of contextRequests) {\n if (request.args.data.resourceType !== 'Image') {\n continue;\n }\n\n const imagePaints =\n parsedTrace.ImagePainting.paintImageEventForUrl.get(request.args.data.url)?.filter(isWithinContext);\n\n // This will filter out things like preloaded image requests where an image file is downloaded\n // but never rendered on the page.\n if (!imagePaints?.length) {\n continue;\n }\n\n const largestImagePaint = imagePaints.reduce((prev, curr) => {\n const prevPixels = getPixelCounts(prev).displayedPixels;\n const currPixels = getPixelCounts(curr).displayedPixels;\n return prevPixels > currPixels ? prev : curr;\n });\n\n const {\n filePixels: imageFilePixels,\n displayedPixels: largestImageDisplayPixels,\n } = getPixelCounts(largestImagePaint);\n\n // Decoded body length is almost always the right one to be using because of the below:\n // `encodedDataLength = decodedBodyLength + headers`.\n // HOWEVER, there are some cases where an image is compressed again over the network and transfer size\n // is smaller (see https://github.com/GoogleChrome/lighthouse/pull/4968).\n // Use the min of the two numbers to be safe.\n const imageBytes = Math.min(request.args.data.decodedBodyLength, request.args.data.encodedDataLength);\n\n const bytesPerPixel = imageBytes / imageFilePixels;\n\n let optimizations: ImageOptimization[] = [];\n if (request.args.data.mimeType === 'image/gif') {\n if (imageBytes > GIF_SIZE_THRESHOLD) {\n const percentSavings = estimateGIFPercentSavings(request);\n const byteSavings = Math.round(imageBytes * percentSavings);\n optimizations.push({type: 'video-format', byteSavings});\n }\n } else if (bytesPerPixel > TARGET_BYTES_PER_PIXEL_AVIF) {\n const idealAvifImageSize = Math.round(TARGET_BYTES_PER_PIXEL_AVIF * imageFilePixels);\n const byteSavings = imageBytes - idealAvifImageSize;\n if (request.args.data.mimeType !== 'image/webp' && request.args.data.mimeType !== 'image/avif') {\n optimizations.push({type: 'modern-format-or-compression', byteSavings});\n } else {\n optimizations.push({type: 'compression', byteSavings});\n }\n }\n\n const wastedPixelRatio = 1 - (largestImageDisplayPixels / imageFilePixels);\n if (wastedPixelRatio > 0) {\n const byteSavings = Math.round(wastedPixelRatio * imageBytes);\n optimizations.push({type: 'responsive-size', byteSavings});\n }\n\n optimizations = optimizations.filter(optimization => optimization.byteSavings > BYTE_SAVINGS_THRESHOLD);\n\n if (optimizations.length > 0) {\n optimizableImages.push({\n request,\n largestImagePaint,\n optimizations,\n });\n }\n }\n\n return finalize({\n optimizableImages,\n });\n}\n"]}
|
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
export * as CumulativeLayoutShift from './CumulativeLayoutShift.js';
|
|
2
2
|
export * as DocumentLatency from './DocumentLatency.js';
|
|
3
|
-
export * as FontDisplay from './FontDisplay.js';
|
|
4
3
|
export * as InteractionToNextPaint from './InteractionToNextPaint.js';
|
|
5
4
|
export * as LargestContentfulPaint from './LargestContentfulPaint.js';
|
|
6
5
|
export * as RenderBlocking from './RenderBlocking.js';
|
|
7
|
-
export * as SlowCSSSelector from './SlowCSSSelector.js';
|
|
8
|
-
export * as ThirdPartyWeb from './ThirdPartyWeb.js';
|
|
9
6
|
export * as Viewport from './Viewport.js';
|
|
@@ -3,11 +3,8 @@
|
|
|
3
3
|
// found in the LICENSE file.
|
|
4
4
|
export * as CumulativeLayoutShift from './CumulativeLayoutShift.js';
|
|
5
5
|
export * as DocumentLatency from './DocumentLatency.js';
|
|
6
|
-
export * as FontDisplay from './FontDisplay.js';
|
|
7
6
|
export * as InteractionToNextPaint from './InteractionToNextPaint.js';
|
|
8
7
|
export * as LargestContentfulPaint from './LargestContentfulPaint.js';
|
|
9
8
|
export * as RenderBlocking from './RenderBlocking.js';
|
|
10
|
-
export * as SlowCSSSelector from './SlowCSSSelector.js';
|
|
11
|
-
export * as ThirdPartyWeb from './ThirdPartyWeb.js';
|
|
12
9
|
export * as Viewport from './Viewport.js';
|
|
13
10
|
//# sourceMappingURL=InsightRunners.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"InsightRunners.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/InsightRunners.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"InsightRunners.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/InsightRunners.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,sBAAsB,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,sBAAsB,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nexport * as CumulativeLayoutShift from './CumulativeLayoutShift.js';\nexport * as DocumentLatency from './DocumentLatency.js';\nexport * as InteractionToNextPaint from './InteractionToNextPaint.js';\nexport * as LargestContentfulPaint from './LargestContentfulPaint.js';\nexport * as RenderBlocking from './RenderBlocking.js';\nexport * as Viewport from './Viewport.js';\n"]}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { SyntheticInteractionPair } from '../types/TraceEvents.js';
|
|
2
|
-
import type
|
|
2
|
+
import { type InsightModel, type InsightSetContext, type RequiredData } from './types.js';
|
|
3
3
|
export declare function deps(): ['UserInteractions'];
|
|
4
4
|
export type INPInsightModel = InsightModel<{
|
|
5
5
|
longestInteractionEvent?: SyntheticInteractionPair;
|
|
@@ -1,17 +1,40 @@
|
|
|
1
1
|
// Copyright 2024 The Chromium Authors. All rights reserved.
|
|
2
2
|
// Use of this source code is governed by a BSD-style license that can be
|
|
3
3
|
// found in the LICENSE file.
|
|
4
|
+
// import * as i18n from '../../../core/i18n/i18n.js';
|
|
4
5
|
import * as Helpers from '../helpers/helpers.js';
|
|
6
|
+
import { InsightCategory } from './types.js';
|
|
7
|
+
const UIStrings = {
|
|
8
|
+
/**
|
|
9
|
+
* @description Text to tell the user about the longest user interaction.
|
|
10
|
+
*/
|
|
11
|
+
description: 'Start investigating with the longest phase. [Delays can be minimized](https://web.dev/articles/optimize-inp#optimize_interactions). To reduce processing duration, [optimize the main-thread costs](https://web.dev/articles/optimize-long-tasks), often JS.',
|
|
12
|
+
/**
|
|
13
|
+
* @description Title for the performance insight "INP by phase", which shows a breakdown of INP by phases / sections.
|
|
14
|
+
*/
|
|
15
|
+
title: 'INP by phase',
|
|
16
|
+
};
|
|
17
|
+
// const str_ = i18n.i18n.registerUIStrings('models/trace/insights/InteractionToNextPaint.ts', UIStrings);
|
|
18
|
+
const i18nString = string => string; // i18n.i18n.getLocalizedString.bind(undefined, str_);
|
|
5
19
|
export function deps() {
|
|
6
20
|
return ['UserInteractions'];
|
|
7
21
|
}
|
|
22
|
+
function finalize(partialModel) {
|
|
23
|
+
return {
|
|
24
|
+
title: i18nString(UIStrings.title),
|
|
25
|
+
description: i18nString(UIStrings.description),
|
|
26
|
+
category: InsightCategory.INP,
|
|
27
|
+
shouldShow: Boolean(partialModel.longestInteractionEvent),
|
|
28
|
+
...partialModel,
|
|
29
|
+
};
|
|
30
|
+
}
|
|
8
31
|
export function generateInsight(parsedTrace, context) {
|
|
9
32
|
const interactionEvents = parsedTrace.UserInteractions.interactionEventsWithNoNesting.filter(event => {
|
|
10
33
|
return Helpers.Timing.eventIsInBounds(event, context.bounds);
|
|
11
34
|
});
|
|
12
35
|
if (!interactionEvents.length) {
|
|
13
36
|
// A valid result, when there is no user interaction.
|
|
14
|
-
return {};
|
|
37
|
+
return finalize({});
|
|
15
38
|
}
|
|
16
39
|
const longestByInteractionId = new Map();
|
|
17
40
|
for (const event of interactionEvents) {
|
|
@@ -28,10 +51,10 @@ export function generateInsight(parsedTrace, context) {
|
|
|
28
51
|
// last array element. To keep things simpler, sort desc and pick from front.
|
|
29
52
|
// See https://source.chromium.org/chromium/chromium/src/+/main:components/page_load_metrics/browser/responsiveness_metrics_normalization.cc;l=45-59;drc=cb0f9c8b559d9c7c3cb4ca94fc1118cc015d38ad
|
|
30
53
|
const highPercentileIndex = Math.min(9, Math.floor(normalizedInteractionEvents.length / 50));
|
|
31
|
-
return {
|
|
54
|
+
return finalize({
|
|
32
55
|
relatedEvents: [normalizedInteractionEvents[0]],
|
|
33
56
|
longestInteractionEvent: normalizedInteractionEvents[0],
|
|
34
57
|
highPercentileInteractionEvent: normalizedInteractionEvents[highPercentileIndex],
|
|
35
|
-
};
|
|
58
|
+
});
|
|
36
59
|
}
|
|
37
60
|
//# sourceMappingURL=InteractionToNextPaint.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"InteractionToNextPaint.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/InteractionToNextPaint.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"InteractionToNextPaint.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/InteractionToNextPaint.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,IAAI,MAAM,4BAA4B,CAAC;AACnD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AAGjD,OAAO,EAAC,eAAe,EAA+D,MAAM,YAAY,CAAC;AAEzG,MAAM,SAAS,GAAG;IAChB;;OAEG;IACH,WAAW,EACP,8PAA8P;IAClQ;;OAEG;IACH,KAAK,EAAE,cAAc;CACtB,CAAC;AAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,iDAAiD,EAAE,SAAS,CAAC,CAAC;AACvG,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAEtE,MAAM,UAAU,IAAI;IAClB,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC9B,CAAC;AAOD,SAAS,QAAQ,CAAC,YAAkF;IAClG,OAAO;QACL,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;QAClC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC;QAC9C,QAAQ,EAAE,eAAe,CAAC,GAAG;QAC7B,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,uBAAuB,CAAC;QACzD,GAAG,YAAY;KAChB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,WAAsC,EAAE,OAA0B;IAChG,MAAM,iBAAiB,GAAG,WAAW,CAAC,gBAAgB,CAAC,8BAA8B,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;QACnG,OAAO,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAC9B,qDAAqD;QACrD,OAAO,QAAQ,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC;IAED,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAoC,CAAC;IAC3E,KAAK,MAAM,KAAK,IAAI,iBAAiB,EAAE,CAAC;QACtC,MAAM,GAAG,GAAG,KAAK,CAAC,aAAa,CAAC;QAChC,MAAM,OAAO,GAAG,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;YACxC,sBAAsB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IACD,MAAM,2BAA2B,GAAG,CAAC,GAAG,sBAAsB,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAE1D,6EAA6E;IAC7E,+EAA+E;IAC/E,6EAA6E;IAC7E,iMAAiM;IACjM,MAAM,mBAAmB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC;IAE7F,OAAO,QAAQ,CAAC;QACd,aAAa,EAAE,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC;QAC/C,uBAAuB,EAAE,2BAA2B,CAAC,CAAC,CAAC;QACvD,8BAA8B,EAAE,2BAA2B,CAAC,mBAAmB,CAAC;KACjF,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nimport * as i18n from '../../../core/i18n/i18n.js';\nimport * as Helpers from '../helpers/helpers.js';\nimport type {SyntheticInteractionPair} from '../types/TraceEvents.js';\n\nimport {InsightCategory, type InsightModel, type InsightSetContext, type RequiredData} from './types.js';\n\nconst UIStrings = {\n /**\n * @description Text to tell the user about the longest user interaction.\n */\n description:\n 'Start investigating with the longest phase. [Delays can be minimized](https://web.dev/articles/optimize-inp#optimize_interactions). To reduce processing duration, [optimize the main-thread costs](https://web.dev/articles/optimize-long-tasks), often JS.',\n /**\n * @description Title for the performance insight \"INP by phase\", which shows a breakdown of INP by phases / sections.\n */\n title: 'INP by phase',\n};\n\nconst str_ = i18n.i18n.registerUIStrings('models/trace/insights/InteractionToNextPaint.ts', UIStrings);\nconst i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);\n\nexport function deps(): ['UserInteractions'] {\n return ['UserInteractions'];\n}\n\nexport type INPInsightModel = InsightModel<{\n longestInteractionEvent?: SyntheticInteractionPair,\n highPercentileInteractionEvent?: SyntheticInteractionPair,\n}>;\n\nfunction finalize(partialModel: Omit<INPInsightModel, 'title'|'description'|'category'|'shouldShow'>): INPInsightModel {\n return {\n title: i18nString(UIStrings.title),\n description: i18nString(UIStrings.description),\n category: InsightCategory.INP,\n shouldShow: Boolean(partialModel.longestInteractionEvent),\n ...partialModel,\n };\n}\n\nexport function generateInsight(parsedTrace: RequiredData<typeof deps>, context: InsightSetContext): INPInsightModel {\n const interactionEvents = parsedTrace.UserInteractions.interactionEventsWithNoNesting.filter(event => {\n return Helpers.Timing.eventIsInBounds(event, context.bounds);\n });\n\n if (!interactionEvents.length) {\n // A valid result, when there is no user interaction.\n return finalize({});\n }\n\n const longestByInteractionId = new Map<number, SyntheticInteractionPair>();\n for (const event of interactionEvents) {\n const key = event.interactionId;\n const longest = longestByInteractionId.get(key);\n if (!longest || event.dur > longest.dur) {\n longestByInteractionId.set(key, event);\n }\n }\n const normalizedInteractionEvents = [...longestByInteractionId.values()];\n normalizedInteractionEvents.sort((a, b) => b.dur - a.dur);\n\n // INP is the \"nearest-rank\"/inverted_cdf 98th percentile, except Chrome only\n // keeps the 10 worst events around, so it can never be more than the 10th from\n // last array element. To keep things simpler, sort desc and pick from front.\n // See https://source.chromium.org/chromium/chromium/src/+/main:components/page_load_metrics/browser/responsiveness_metrics_normalization.cc;l=45-59;drc=cb0f9c8b559d9c7c3cb4ca94fc1118cc015d38ad\n const highPercentileIndex = Math.min(9, Math.floor(normalizedInteractionEvents.length / 50));\n\n return finalize({\n relatedEvents: [normalizedInteractionEvents[0]],\n longestInteractionEvent: normalizedInteractionEvents[0],\n highPercentileInteractionEvent: normalizedInteractionEvents[highPercentileIndex],\n });\n}\n"]}
|
|
@@ -1,16 +1,45 @@
|
|
|
1
1
|
// Copyright 2024 The Chromium Authors. All rights reserved.
|
|
2
2
|
// Use of this source code is governed by a BSD-style license that can be
|
|
3
3
|
// found in the LICENSE file.
|
|
4
|
+
// import * as i18n from '../../../core/i18n/i18n.js';
|
|
4
5
|
import * as Handlers from '../handlers/handlers.js';
|
|
5
6
|
import * as Helpers from '../helpers/helpers.js';
|
|
6
7
|
import * as Types from '../types/types.js';
|
|
7
|
-
import { InsightWarning } from './types.js';
|
|
8
|
+
import { InsightCategory, InsightWarning, } from './types.js';
|
|
9
|
+
const UIStrings = {
|
|
10
|
+
/**
|
|
11
|
+
*@description Title of an insight that provides details about the LCP metric, and the network requests necessary to load it. Details how the LCP request was discoverable - in other words, the path necessary to load it (ex: network requests, JavaScript)
|
|
12
|
+
*/
|
|
13
|
+
title: 'LCP request discovery',
|
|
14
|
+
/**
|
|
15
|
+
*@description Description of an insight that provides details about the LCP metric, and the network requests necessary to load it.
|
|
16
|
+
*/
|
|
17
|
+
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)',
|
|
18
|
+
};
|
|
19
|
+
// const str_ = i18n.i18n.registerUIStrings('models/trace/insights/LCPDiscovery.ts', UIStrings);
|
|
20
|
+
const i18nString = string => string; // i18n.i18n.getLocalizedString.bind(undefined, str_);
|
|
8
21
|
export function deps() {
|
|
9
22
|
return ['NetworkRequests', 'PageLoadMetrics', 'LargestImagePaint', 'Meta'];
|
|
10
23
|
}
|
|
24
|
+
function finalize(partialModel) {
|
|
25
|
+
const relatedEvents = partialModel.lcpEvent && partialModel.lcpRequest ?
|
|
26
|
+
// TODO: add entire request initiator chain?
|
|
27
|
+
[partialModel.lcpEvent, partialModel.lcpRequest] :
|
|
28
|
+
[];
|
|
29
|
+
return {
|
|
30
|
+
title: i18nString(UIStrings.title),
|
|
31
|
+
description: i18nString(UIStrings.description),
|
|
32
|
+
category: InsightCategory.LCP,
|
|
33
|
+
shouldShow: Boolean(partialModel.lcpRequest &&
|
|
34
|
+
(partialModel.shouldIncreasePriorityHint || partialModel.shouldPreloadImage ||
|
|
35
|
+
partialModel.shouldRemoveLazyLoading)),
|
|
36
|
+
...partialModel,
|
|
37
|
+
relatedEvents,
|
|
38
|
+
};
|
|
39
|
+
}
|
|
11
40
|
export function generateInsight(parsedTrace, context) {
|
|
12
41
|
if (!context.navigation) {
|
|
13
|
-
return {};
|
|
42
|
+
return finalize({});
|
|
14
43
|
}
|
|
15
44
|
const networkRequests = parsedTrace.NetworkRequests;
|
|
16
45
|
const frameMetrics = parsedTrace.PageLoadMetrics.metricScoresByFrameId.get(context.frameId);
|
|
@@ -24,17 +53,15 @@ export function generateInsight(parsedTrace, context) {
|
|
|
24
53
|
const metricScore = navMetrics.get("LCP" /* Handlers.ModelHandlers.PageLoadMetrics.MetricName.LCP */);
|
|
25
54
|
const lcpEvent = metricScore?.event;
|
|
26
55
|
if (!lcpEvent || !Types.Events.isLargestContentfulPaintCandidate(lcpEvent)) {
|
|
27
|
-
return { warnings: [InsightWarning.NO_LCP] };
|
|
56
|
+
return finalize({ warnings: [InsightWarning.NO_LCP] });
|
|
28
57
|
}
|
|
29
58
|
const docRequest = networkRequests.byTime.find(req => req.args.data.requestId === context.navigationId);
|
|
30
59
|
if (!docRequest) {
|
|
31
|
-
return { lcpEvent, warnings: [InsightWarning.NO_DOCUMENT_REQUEST] };
|
|
60
|
+
return finalize({ lcpEvent, warnings: [InsightWarning.NO_DOCUMENT_REQUEST] });
|
|
32
61
|
}
|
|
33
62
|
const lcpRequest = parsedTrace.LargestImagePaint.lcpRequestByNavigation.get(context.navigation);
|
|
34
63
|
if (!lcpRequest) {
|
|
35
|
-
return {
|
|
36
|
-
lcpEvent,
|
|
37
|
-
};
|
|
64
|
+
return finalize({ lcpEvent });
|
|
38
65
|
}
|
|
39
66
|
const initiatorUrl = lcpRequest.args.data.initiator?.url;
|
|
40
67
|
// TODO(b/372319476): Explore using trace event HTMLDocumentParser::FetchQueuedPreloads to determine if the request
|
|
@@ -48,13 +75,13 @@ export function generateInsight(parsedTrace, context) {
|
|
|
48
75
|
Helpers.Timing.secondsToMicroseconds(docRequest.args.data.timing.requestTime) +
|
|
49
76
|
Helpers.Timing.millisecondsToMicroseconds(docRequest.args.data.timing.receiveHeadersStart) :
|
|
50
77
|
undefined;
|
|
51
|
-
return {
|
|
78
|
+
return finalize({
|
|
52
79
|
lcpEvent,
|
|
53
80
|
shouldRemoveLazyLoading: imageLoadingAttr === 'lazy',
|
|
54
81
|
shouldIncreasePriorityHint: imageFetchPriorityHint !== 'high',
|
|
55
82
|
shouldPreloadImage: !imgPreloadedOrFoundInHTML,
|
|
56
83
|
lcpRequest,
|
|
57
84
|
earliestDiscoveryTimeTs: earliestDiscoveryTime ? Types.Timing.MicroSeconds(earliestDiscoveryTime) : undefined,
|
|
58
|
-
};
|
|
85
|
+
});
|
|
59
86
|
}
|
|
60
87
|
//# sourceMappingURL=LCPDiscovery.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"LCPDiscovery.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/LCPDiscovery.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAE3C,OAAO,
|
|
1
|
+
{"version":3,"file":"LCPDiscovery.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/LCPDiscovery.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,IAAI,MAAM,4BAA4B,CAAC;AACnD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EACL,eAAe,EAGf,cAAc,GAEf,MAAM,YAAY,CAAC;AAEpB,MAAM,SAAS,GAAG;IAChB;;OAEG;IACH,KAAK,EAAE,uBAAuB;IAC9B;;OAEG;IACH,WAAW,EACP,8NAA8N;CACnO,CAAC;AAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,uCAAuC,EAAE,SAAS,CAAC,CAAC;AAC7F,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAEtE,MAAM,UAAU,IAAI;IAClB,OAAO,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAC7E,CAAC;AAYD,SAAS,QAAQ,CAAC,YAA2F;IAE3G,MAAM,aAAa,GAAG,YAAY,CAAC,QAAQ,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC;QACpE,4CAA4C;QAC5C,CAAC,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAClD,EAAE,CAAC;IACP,OAAO;QACL,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;QAClC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC;QAC9C,QAAQ,EAAE,eAAe,CAAC,GAAG;QAC7B,UAAU,EAAE,OAAO,CACf,YAAY,CAAC,UAAU;YACvB,CAAC,YAAY,CAAC,0BAA0B,IAAI,YAAY,CAAC,kBAAkB;gBAC1E,YAAY,CAAC,uBAAuB,CAAC,CAAC;QAC3C,GAAG,YAAY;QACf,aAAa;KACd,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAC3B,WAAsC,EAAE,OAA0B;IACpE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC;IAED,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC;IAEpD,MAAM,YAAY,GAAG,WAAW,CAAC,eAAe,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5F,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IACD,MAAM,WAAW,GAAG,UAAU,CAAC,GAAG,mEAAuD,CAAC;IAC1F,MAAM,QAAQ,GAAG,WAAW,EAAE,KAAK,CAAC;IACpC,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,iCAAiC,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3E,OAAO,QAAQ,CAAC,EAAC,QAAQ,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,EAAC,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IACxG,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,QAAQ,CAAC,EAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,cAAc,CAAC,mBAAmB,CAAC,EAAC,CAAC,CAAC;IAC9E,CAAC;IAED,MAAM,UAAU,GAAG,WAAW,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAChG,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,QAAQ,CAAC,EAAC,QAAQ,EAAC,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC;IACzD,mHAAmH;IACnH,wCAAwC;IACxC,MAAM,kBAAkB,GACpB,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,KAAK,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,YAAY,CAAC;IACpG,MAAM,yBAAyB,GAAG,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,kBAAkB,CAAC;IAE5F,MAAM,gBAAgB,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC;IACzD,MAAM,sBAAsB,GAAG,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC;IACvE,6EAA6E;IAC7E,MAAM,qBAAqB,GAAG,UAAU,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrE,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;YACzE,OAAO,CAAC,MAAM,CAAC,0BAA0B,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAChG,SAAS,CAAC;IAEd,OAAO,QAAQ,CAAC;QACd,QAAQ;QACR,uBAAuB,EAAE,gBAAgB,KAAK,MAAM;QACpD,0BAA0B,EAAE,sBAAsB,KAAK,MAAM;QAC7D,kBAAkB,EAAE,CAAC,yBAAyB;QAC9C,UAAU;QACV,uBAAuB,EAAE,qBAAqB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,SAAS;KAC9G,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nimport * as i18n from '../../../core/i18n/i18n.js';\nimport * as Handlers from '../handlers/handlers.js';\nimport * as Helpers from '../helpers/helpers.js';\nimport * as Types from '../types/types.js';\n\nimport {\n InsightCategory,\n type InsightModel,\n type InsightSetContext,\n InsightWarning,\n type RequiredData,\n} from './types.js';\n\nconst UIStrings = {\n /**\n *@description Title of an insight that provides details about the LCP metric, and the network requests necessary to load it. Details how the LCP request was discoverable - in other words, the path necessary to load it (ex: network requests, JavaScript)\n */\n title: 'LCP request discovery',\n /**\n *@description Description of an insight that provides details about the LCP metric, and the network requests necessary to load it.\n */\n description:\n '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)',\n};\n\nconst str_ = i18n.i18n.registerUIStrings('models/trace/insights/LCPDiscovery.ts', UIStrings);\nconst i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);\n\nexport function deps(): ['NetworkRequests', 'PageLoadMetrics', 'LargestImagePaint', 'Meta'] {\n return ['NetworkRequests', 'PageLoadMetrics', 'LargestImagePaint', 'Meta'];\n}\n\nexport type LCPDiscoveryInsightModel = InsightModel<{\n lcpEvent?: Types.Events.LargestContentfulPaintCandidate,\n shouldRemoveLazyLoading?: boolean,\n shouldIncreasePriorityHint?: boolean,\n shouldPreloadImage?: boolean,\n /** The network request for the LCP image, if there was one. */\n lcpRequest?: Types.Events.SyntheticNetworkRequest,\n earliestDiscoveryTimeTs?: Types.Timing.MicroSeconds,\n}>;\n\nfunction finalize(partialModel: Omit<LCPDiscoveryInsightModel, 'title'|'description'|'category'|'shouldShow'>):\n LCPDiscoveryInsightModel {\n const relatedEvents = partialModel.lcpEvent && partialModel.lcpRequest ?\n // TODO: add entire request initiator chain?\n [partialModel.lcpEvent, partialModel.lcpRequest] :\n [];\n return {\n title: i18nString(UIStrings.title),\n description: i18nString(UIStrings.description),\n category: InsightCategory.LCP,\n shouldShow: Boolean(\n partialModel.lcpRequest &&\n (partialModel.shouldIncreasePriorityHint || partialModel.shouldPreloadImage ||\n partialModel.shouldRemoveLazyLoading)),\n ...partialModel,\n relatedEvents,\n };\n}\n\nexport function generateInsight(\n parsedTrace: RequiredData<typeof deps>, context: InsightSetContext): LCPDiscoveryInsightModel {\n if (!context.navigation) {\n return finalize({});\n }\n\n const networkRequests = parsedTrace.NetworkRequests;\n\n const frameMetrics = parsedTrace.PageLoadMetrics.metricScoresByFrameId.get(context.frameId);\n if (!frameMetrics) {\n throw new Error('no frame metrics');\n }\n\n const navMetrics = frameMetrics.get(context.navigationId);\n if (!navMetrics) {\n throw new Error('no navigation metrics');\n }\n const metricScore = navMetrics.get(Handlers.ModelHandlers.PageLoadMetrics.MetricName.LCP);\n const lcpEvent = metricScore?.event;\n if (!lcpEvent || !Types.Events.isLargestContentfulPaintCandidate(lcpEvent)) {\n return finalize({warnings: [InsightWarning.NO_LCP]});\n }\n\n const docRequest = networkRequests.byTime.find(req => req.args.data.requestId === context.navigationId);\n if (!docRequest) {\n return finalize({lcpEvent, warnings: [InsightWarning.NO_DOCUMENT_REQUEST]});\n }\n\n const lcpRequest = parsedTrace.LargestImagePaint.lcpRequestByNavigation.get(context.navigation);\n if (!lcpRequest) {\n return finalize({lcpEvent});\n }\n\n const initiatorUrl = lcpRequest.args.data.initiator?.url;\n // TODO(b/372319476): Explore using trace event HTMLDocumentParser::FetchQueuedPreloads to determine if the request\n // is discovered by the preload scanner.\n const initiatedByMainDoc =\n lcpRequest?.args.data.initiator?.type === 'parser' && docRequest.args.data.url === initiatorUrl;\n const imgPreloadedOrFoundInHTML = lcpRequest?.args.data.isLinkPreload || initiatedByMainDoc;\n\n const imageLoadingAttr = lcpEvent.args.data?.loadingAttr;\n const imageFetchPriorityHint = lcpRequest?.args.data.fetchPriorityHint;\n // This is the earliest discovery time an LCP request could have - it's TTFB.\n const earliestDiscoveryTime = docRequest && docRequest.args.data.timing ?\n Helpers.Timing.secondsToMicroseconds(docRequest.args.data.timing.requestTime) +\n Helpers.Timing.millisecondsToMicroseconds(docRequest.args.data.timing.receiveHeadersStart) :\n undefined;\n\n return finalize({\n lcpEvent,\n shouldRemoveLazyLoading: imageLoadingAttr === 'lazy',\n shouldIncreasePriorityHint: imageFetchPriorityHint !== 'high',\n shouldPreloadImage: !imgPreloadedOrFoundInHTML,\n lcpRequest,\n earliestDiscoveryTimeTs: earliestDiscoveryTime ? Types.Timing.MicroSeconds(earliestDiscoveryTime) : undefined,\n });\n}\n"]}
|
|
@@ -1,10 +1,24 @@
|
|
|
1
1
|
// Copyright 2024 The Chromium Authors. All rights reserved.
|
|
2
2
|
// Use of this source code is governed by a BSD-style license that can be
|
|
3
3
|
// found in the LICENSE file.
|
|
4
|
+
// import * as i18n from '../../../core/i18n/i18n.js';
|
|
4
5
|
import * as Handlers from '../handlers/handlers.js';
|
|
5
6
|
import * as Helpers from '../helpers/helpers.js';
|
|
6
7
|
import * as Types from '../types/types.js';
|
|
7
|
-
import { InsightWarning } from './types.js';
|
|
8
|
+
import { InsightCategory, InsightWarning, } from './types.js';
|
|
9
|
+
const UIStrings = {
|
|
10
|
+
/**
|
|
11
|
+
*@description Title of an insight that provides details about the LCP metric, broken down by phases / parts.
|
|
12
|
+
*/
|
|
13
|
+
title: 'LCP by phase',
|
|
14
|
+
/**
|
|
15
|
+
* @description Description of a DevTools insight that presents a breakdown for the LCP metric by phases.
|
|
16
|
+
* This is displayed after a user expands the section to see more. No character length limits.
|
|
17
|
+
*/
|
|
18
|
+
description: 'Each [phase has specific improvement strategies](https://web.dev/articles/optimize-lcp#lcp-breakdown). Ideally, most of the LCP time should be spent on loading the resources, not within delays.',
|
|
19
|
+
};
|
|
20
|
+
// const str_ = i18n.i18n.registerUIStrings('models/trace/insights/LCPPhases.ts', UIStrings);
|
|
21
|
+
const i18nString = string => string; // i18n.i18n.getLocalizedString.bind(undefined, str_);
|
|
8
22
|
export function deps() {
|
|
9
23
|
return ['NetworkRequests', 'PageLoadMetrics', 'LargestImagePaint', 'Meta'];
|
|
10
24
|
}
|
|
@@ -50,9 +64,27 @@ function breakdownPhases(nav, docRequest, lcpMs, lcpRequest) {
|
|
|
50
64
|
renderDelay,
|
|
51
65
|
};
|
|
52
66
|
}
|
|
67
|
+
function finalize(partialModel) {
|
|
68
|
+
const relatedEvents = [];
|
|
69
|
+
if (partialModel.lcpEvent) {
|
|
70
|
+
relatedEvents.push(partialModel.lcpEvent);
|
|
71
|
+
}
|
|
72
|
+
if (partialModel.lcpRequest) {
|
|
73
|
+
relatedEvents.push(partialModel.lcpRequest);
|
|
74
|
+
}
|
|
75
|
+
return {
|
|
76
|
+
title: i18nString(UIStrings.title),
|
|
77
|
+
description: i18nString(UIStrings.description),
|
|
78
|
+
category: InsightCategory.LCP,
|
|
79
|
+
// TODO: should move the component's "getPhaseData" to model.
|
|
80
|
+
shouldShow: Boolean(partialModel.phases) && (partialModel.lcpMs ?? 0) > 0,
|
|
81
|
+
...partialModel,
|
|
82
|
+
relatedEvents,
|
|
83
|
+
};
|
|
84
|
+
}
|
|
53
85
|
export function generateInsight(parsedTrace, context) {
|
|
54
86
|
if (!context.navigation) {
|
|
55
|
-
return {};
|
|
87
|
+
return finalize({});
|
|
56
88
|
}
|
|
57
89
|
const networkRequests = parsedTrace.NetworkRequests;
|
|
58
90
|
const frameMetrics = parsedTrace.PageLoadMetrics.metricScoresByFrameId.get(context.frameId);
|
|
@@ -66,7 +98,7 @@ export function generateInsight(parsedTrace, context) {
|
|
|
66
98
|
const metricScore = navMetrics.get("LCP" /* Handlers.ModelHandlers.PageLoadMetrics.MetricName.LCP */);
|
|
67
99
|
const lcpEvent = metricScore?.event;
|
|
68
100
|
if (!lcpEvent || !Types.Events.isLargestContentfulPaintCandidate(lcpEvent)) {
|
|
69
|
-
return { warnings: [InsightWarning.NO_LCP] };
|
|
101
|
+
return finalize({ warnings: [InsightWarning.NO_LCP] });
|
|
70
102
|
}
|
|
71
103
|
// This helps calculate the phases.
|
|
72
104
|
const lcpMs = Helpers.Timing.microSecondsToMilliseconds(metricScore.timing);
|
|
@@ -75,23 +107,23 @@ export function generateInsight(parsedTrace, context) {
|
|
|
75
107
|
const lcpRequest = parsedTrace.LargestImagePaint.lcpRequestByNavigation.get(context.navigation);
|
|
76
108
|
const docRequest = networkRequests.byTime.find(req => req.args.data.requestId === context.navigationId);
|
|
77
109
|
if (!docRequest) {
|
|
78
|
-
return { lcpMs, lcpTs, lcpEvent, lcpRequest, warnings: [InsightWarning.NO_DOCUMENT_REQUEST] };
|
|
110
|
+
return finalize({ lcpMs, lcpTs, lcpEvent, lcpRequest, warnings: [InsightWarning.NO_DOCUMENT_REQUEST] });
|
|
79
111
|
}
|
|
80
112
|
if (!lcpRequest) {
|
|
81
|
-
return {
|
|
113
|
+
return finalize({
|
|
82
114
|
lcpMs,
|
|
83
115
|
lcpTs,
|
|
84
116
|
lcpEvent,
|
|
85
117
|
lcpRequest,
|
|
86
118
|
phases: breakdownPhases(context.navigation, docRequest, lcpMs, lcpRequest) ?? undefined,
|
|
87
|
-
};
|
|
119
|
+
});
|
|
88
120
|
}
|
|
89
|
-
return {
|
|
121
|
+
return finalize({
|
|
90
122
|
lcpMs,
|
|
91
123
|
lcpTs,
|
|
92
124
|
lcpEvent,
|
|
93
125
|
lcpRequest,
|
|
94
126
|
phases: breakdownPhases(context.navigation, docRequest, lcpMs, lcpRequest) ?? undefined,
|
|
95
|
-
};
|
|
127
|
+
});
|
|
96
128
|
}
|
|
97
129
|
//# sourceMappingURL=LCPPhases.js.map
|