@paulirish/trace_engine 0.0.24 → 0.0.26

package/models/trace/lantern/bundle-tsconfig.json

@@ -0,0 +1 @@
+{"compilerOptions":{"composite":true,"outDir":".","baseUrl":".","rootDir":"../../../../../../../front_end/models/trace/lantern"},"files":["../../../../../../../front_end/models/trace/lantern/lantern.ts"],"references":[{"path":"./lantern-tsconfig.json"}]}

package/models/trace/lantern/devtools_entrypoint-bundle-typescript-tsconfig.json

@@ -0,0 +1,42 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "composite": true,
+    "declaration": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSources": true,
+    "lib": [
+      "esnext",
+      "dom",
+      "dom.iterable"
+    ],
+    "module": "esnext",
+    "noEmitOnError": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": false,
+    "outDir": ".",
+    "rootDir": "../../../../../../../front_end/models/trace/lantern",
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "esnext",
+    "tsBuildInfoFile": "devtools_entrypoint-bundle-typescript-tsconfig.json.tsbuildinfo",
+    "typeRoots": [],
+    "useUnknownInCatchVariables": false
+  },
+  "files": [
+    "../../../../../../../front_end/models/trace/lantern/lantern.ts",
+    "../../../../../../../front_end/legacy/legacy-defs.d.ts",
+    "../../../../../../../front_end/global_typings/global_defs.d.ts",
+    "../../../../../../../node_modules/@types/filesystem/index.d.ts"
+  ],
+  "references": [
+    {
+      "path": "./lantern-tsconfig.json"
+    }
+  ]
+}

package/models/trace/lantern/lantern-tsconfig.json

@@ -0,0 +1,64 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "composite": true,
+    "declaration": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSources": true,
+    "lib": [
+      "esnext",
+      "dom",
+      "dom.iterable"
+    ],
+    "module": "esnext",
+    "noEmitOnError": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": false,
+    "outDir": ".",
+    "rootDir": "../../../../../../../front_end/models/trace/lantern",
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "esnext",
+    "tsBuildInfoFile": "lantern-tsconfig.json.tsbuildinfo",
+    "typeRoots": [],
+    "useUnknownInCatchVariables": false
+  },
+  "files": [
+    "../../../../../../../front_end/models/trace/lantern/BaseNode.ts",
+    "../../../../../../../front_end/models/trace/lantern/CPUNode.ts",
+    "../../../../../../../front_end/models/trace/lantern/LanternError.ts",
+    "../../../../../../../front_end/models/trace/lantern/MetricsModule.ts",
+    "../../../../../../../front_end/models/trace/lantern/NetworkNode.ts",
+    "../../../../../../../front_end/models/trace/lantern/PageDependencyGraph.ts",
+    "../../../../../../../front_end/models/trace/lantern/SimulationModule.ts",
+    "../../../../../../../front_end/models/trace/lantern/metrics/FirstContentfulPaint.ts",
+    "../../../../../../../front_end/models/trace/lantern/metrics/Interactive.ts",
+    "../../../../../../../front_end/models/trace/lantern/metrics/LargestContentfulPaint.ts",
+    "../../../../../../../front_end/models/trace/lantern/metrics/MaxPotentialFID.ts",
+    "../../../../../../../front_end/models/trace/lantern/metrics/Metric.ts",
+    "../../../../../../../front_end/models/trace/lantern/metrics/SpeedIndex.ts",
+    "../../../../../../../front_end/models/trace/lantern/metrics/TBTUtils.ts",
+    "../../../../../../../front_end/models/trace/lantern/metrics/TotalBlockingTime.ts",
+    "../../../../../../../front_end/models/trace/lantern/simulation/ConnectionPool.ts",
+    "../../../../../../../front_end/models/trace/lantern/simulation/Constants.ts",
+    "../../../../../../../front_end/models/trace/lantern/simulation/DNSCache.ts",
+    "../../../../../../../front_end/models/trace/lantern/simulation/NetworkAnalyzer.ts",
+    "../../../../../../../front_end/models/trace/lantern/simulation/SimulationTimingMap.ts",
+    "../../../../../../../front_end/models/trace/lantern/simulation/Simulator.ts",
+    "../../../../../../../front_end/models/trace/lantern/simulation/TCPConnection.ts",
+    "../../../../../../../front_end/models/trace/lantern/types/lantern.ts",
+    "../../../../../../../front_end/legacy/legacy-defs.d.ts",
+    "../../../../../../../front_end/global_typings/global_defs.d.ts",
+    "../../../../../../../node_modules/@types/filesystem/index.d.ts"
+  ],
+  "references": [
+    {
+      "path": "../types/bundle-tsconfig.json"
+    }
+  ]
+}

package/models/trace/lantern/lantern.d.ts

@@ -0,0 +1,29 @@
+import * as Metrics from './MetricsModule.js';
+import * as Simulation from './SimulationModule.js';
+export { BaseNode, type Node } from './BaseNode.js';
+export { CPUNode } from './CPUNode.js';
+export { LanternError as Error } from './LanternError.js';
+export { NetworkNode } from './NetworkNode.js';
+export { PageDependencyGraph } from './PageDependencyGraph.js';
+export type { NetworkRequest, ParsedURL, ResourcePriority, ResourceTiming, ResourceType, Trace, TraceEvent, } from './types/lantern.js';
+export declare const NetworkRequestTypes: {
+    readonly XHR: "XHR";
+    readonly Fetch: "Fetch";
+    readonly EventSource: "EventSource";
+    readonly Script: "Script";
+    readonly Stylesheet: "Stylesheet";
+    readonly Image: "Image";
+    readonly Media: "Media";
+    readonly Font: "Font";
+    readonly Document: "Document";
+    readonly TextTrack: "TextTrack";
+    readonly WebSocket: "WebSocket";
+    readonly Other: "Other";
+    readonly Manifest: "Manifest";
+    readonly SignedExchange: "SignedExchange";
+    readonly Ping: "Ping";
+    readonly Preflight: "Preflight";
+    readonly CSPViolationReport: "CSPViolationReport";
+    readonly Prefetch: "Prefetch";
+};
+export { Metrics, Simulation, };

package/models/trace/lantern/lantern.js

@@ -0,0 +1,33 @@
+// Copyright 2024 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+// TODO(crbug.com/348449529): refactor to proper devtools module
+import * as Metrics from './MetricsModule.js';
+import * as Simulation from './SimulationModule.js';
+export { BaseNode } from './BaseNode.js';
+export { CPUNode } from './CPUNode.js';
+export { LanternError as Error } from './LanternError.js';
+export { NetworkNode } from './NetworkNode.js';
+export { PageDependencyGraph } from './PageDependencyGraph.js';
+export const NetworkRequestTypes = {
+    XHR: 'XHR',
+    Fetch: 'Fetch',
+    EventSource: 'EventSource',
+    Script: 'Script',
+    Stylesheet: 'Stylesheet',
+    Image: 'Image',
+    Media: 'Media',
+    Font: 'Font',
+    Document: 'Document',
+    TextTrack: 'TextTrack',
+    WebSocket: 'WebSocket',
+    Other: 'Other',
+    Manifest: 'Manifest',
+    SignedExchange: 'SignedExchange',
+    Ping: 'Ping',
+    Preflight: 'Preflight',
+    CSPViolationReport: 'CSPViolationReport',
+    Prefetch: 'Prefetch',
+};
+export { Metrics, Simulation, };
+//# sourceMappingURL=lantern.js.map

package/models/trace/lantern/lantern.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lantern.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/lantern/lantern.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,gEAAgE;AAEhE,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,QAAQ,EAAY,MAAM,eAAe,CAAC;AAClD,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAC;AACrC,OAAO,EAAC,YAAY,IAAI,KAAK,EAAC,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAC,mBAAmB,EAAC,MAAM,0BAA0B,CAAC;AAW7D,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,aAAa;IAC1B,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;IAChC,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,WAAW;IACtB,kBAAkB,EAAE,oBAAoB;IACxC,QAAQ,EAAE,UAAU;CACZ,CAAC;AAEX,OAAO,EACL,OAAO,EACP,UAAU,GACX,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\n// TODO(crbug.com/348449529): refactor to proper devtools module\n\nimport * as Metrics from './MetricsModule.js';\nimport * as Simulation from './SimulationModule.js';\n\nexport {BaseNode, type Node} from './BaseNode.js';\nexport {CPUNode} from './CPUNode.js';\nexport {LanternError as Error} from './LanternError.js';\nexport {NetworkNode} from './NetworkNode.js';\nexport {PageDependencyGraph} from './PageDependencyGraph.js';\nexport type {\n  NetworkRequest,\n  ParsedURL,\n  ResourcePriority,\n  ResourceTiming,\n  ResourceType,\n  Trace,\n  TraceEvent,\n} from './types/lantern.js';\n\nexport const NetworkRequestTypes = {\n  XHR: 'XHR',\n  Fetch: 'Fetch',\n  EventSource: 'EventSource',\n  Script: 'Script',\n  Stylesheet: 'Stylesheet',\n  Image: 'Image',\n  Media: 'Media',\n  Font: 'Font',\n  Document: 'Document',\n  TextTrack: 'TextTrack',\n  WebSocket: 'WebSocket',\n  Other: 'Other',\n  Manifest: 'Manifest',\n  SignedExchange: 'SignedExchange',\n  Ping: 'Ping',\n  Preflight: 'Preflight',\n  CSPViolationReport: 'CSPViolationReport',\n  Prefetch: 'Prefetch',\n} as const;\n\nexport {\n  Metrics,\n  Simulation,\n};\n"]}

package/models/trace/lantern/metrics/FirstContentfulPaint.d.ts

@@ -0,0 +1,42 @@
+import { type Node } from '../BaseNode.js';
+import { type CPUNode } from '../CPUNode.js';
+import { type NetworkNode } from '../NetworkNode.js';
+import type * as Lantern from '../types/lantern.js';
+import { Metric } from './Metric.js';
+interface FirstPaintBasedGraphOpts<T> {
+    /**
+     * The timestamp used to filter out tasks that occured after our paint of interest.
+     * Typically this is First Contentful Paint or First Meaningful Paint.
+     */
+    cutoffTimestamp: number;
+    /**
+     * The function that determines which resources should be considered *possibly*
+     * render-blocking.
+     */
+    treatNodeAsRenderBlocking: (node: NetworkNode<T>) => boolean;
+    /**
+     * The function that determines which CPU nodes should also be included in our
+     * blocking node IDs set, beyond what getRenderBlockingNodeData() already includes.
+     */
+    additionalCpuNodesToTreatAsRenderBlocking?: (node: CPUNode) => boolean;
+}
+declare class FirstContentfulPaint extends Metric {
+    static get coefficients(): Lantern.Simulation.MetricCoefficients;
+    /**
+     * Computes the set of URLs that *appeared* to be render-blocking based on our filter,
+     * *but definitely were not* render-blocking based on the timing of their EvaluateScript task.
+     * It also computes the set of corresponding CPU node ids that were needed for the paint at the
+     * given timestamp.
+     */
+    static getRenderBlockingNodeData<T = unknown>(graph: Node, { cutoffTimestamp, treatNodeAsRenderBlocking, additionalCpuNodesToTreatAsRenderBlocking }: FirstPaintBasedGraphOpts<T>): {
+        definitelyNotRenderBlockingScriptUrls: Set<string>;
+        renderBlockingCpuNodeIds: Set<string>;
+    };
+    /**
+     * Computes the graph required for the first paint of interest.
+     */
+    static getFirstPaintBasedGraph<T>(dependencyGraph: Node, { cutoffTimestamp, treatNodeAsRenderBlocking, additionalCpuNodesToTreatAsRenderBlocking }: FirstPaintBasedGraphOpts<T>): Node<T>;
+    static getOptimisticGraph<T>(dependencyGraph: Node<T>, processedNavigation: Lantern.Simulation.ProcessedNavigation): Node<T>;
+    static getPessimisticGraph<T>(dependencyGraph: Node<T>, processedNavigation: Lantern.Simulation.ProcessedNavigation): Node<T>;
+}
+export { FirstContentfulPaint };

package/models/trace/lantern/metrics/FirstContentfulPaint.js

@@ -0,0 +1,137 @@
+// Copyright 2024 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+import { BaseNode } from '../BaseNode.js';
+import { Metric } from './Metric.js';
+class FirstContentfulPaint extends Metric {
+    static get coefficients() {
+        return {
+            intercept: 0,
+            optimistic: 0.5,
+            pessimistic: 0.5,
+        };
+    }
+    /**
+     * Computes the set of URLs that *appeared* to be render-blocking based on our filter,
+     * *but definitely were not* render-blocking based on the timing of their EvaluateScript task.
+     * It also computes the set of corresponding CPU node ids that were needed for the paint at the
+     * given timestamp.
+     */
+    static getRenderBlockingNodeData(graph, { cutoffTimestamp, treatNodeAsRenderBlocking, additionalCpuNodesToTreatAsRenderBlocking }) {
+        /** A map of blocking script URLs to the earliest EvaluateScript task node that executed them. */
+        const scriptUrlToNodeMap = new Map();
+        const cpuNodes = [];
+        graph.traverse(node => {
+            if (node.type === BaseNode.types.CPU) {
+                // A task is *possibly* render blocking if it *started* before cutoffTimestamp.
+                // We use startTime here because the paint event can be *inside* the task that was render blocking.
+                if (node.startTime <= cutoffTimestamp) {
+                    cpuNodes.push(node);
+                }
+                // Build our script URL map to find the earliest EvaluateScript task node.
+                const scriptUrls = node.getEvaluateScriptURLs();
+                for (const url of scriptUrls) {
+                    // Use the earliest CPU node we find.
+                    const existing = scriptUrlToNodeMap.get(url) || node;
+                    scriptUrlToNodeMap.set(url, node.startTime < existing.startTime ? node : existing);
+                }
+            }
+        });
+        cpuNodes.sort((a, b) => a.startTime - b.startTime);
+        // A script is *possibly* render blocking if it finished loading before cutoffTimestamp.
+        const possiblyRenderBlockingScriptUrls = Metric.getScriptUrls(graph, node => {
+            // The optimistic LCP treatNodeAsRenderBlocking fn wants to exclude some images in the graph,
+            // but here it only receives scripts to evaluate. It's a no-op in this case, but it will
+            // matter below in the getFirstPaintBasedGraph clone operation.
+            return node.endTime <= cutoffTimestamp && treatNodeAsRenderBlocking(node);
+        });
+        // A script is *definitely not* render blocking if its EvaluateScript task started after cutoffTimestamp.
+        const definitelyNotRenderBlockingScriptUrls = new Set();
+        const renderBlockingCpuNodeIds = new Set();
+        for (const url of possiblyRenderBlockingScriptUrls) {
+            // Lookup the CPU node that had the earliest EvaluateScript for this URL.
+            const cpuNodeForUrl = scriptUrlToNodeMap.get(url);
+            // If we can't find it at all, we can't conclude anything, so just skip it.
+            if (!cpuNodeForUrl) {
+                continue;
+            }
+            // If we found it and it was in our `cpuNodes` set that means it finished before cutoffTimestamp, so it really is render-blocking.
+            if (cpuNodes.includes(cpuNodeForUrl)) {
+                renderBlockingCpuNodeIds.add(cpuNodeForUrl.id);
+                continue;
+            }
+            // We couldn't find the evaluate script in the set of CPU nodes that ran before our paint, so
+            // it must not have been necessary for the paint.
+            definitelyNotRenderBlockingScriptUrls.add(url);
+        }
+        // The first layout, first paint, and first ParseHTML are almost always necessary for first paint,
+        // so we always include those CPU nodes.
+        const firstLayout = cpuNodes.find(node => node.didPerformLayout());
+        if (firstLayout) {
+            renderBlockingCpuNodeIds.add(firstLayout.id);
+        }
+        const firstPaint = cpuNodes.find(node => node.childEvents.some(e => e.name === 'Paint'));
+        if (firstPaint) {
+            renderBlockingCpuNodeIds.add(firstPaint.id);
+        }
+        const firstParse = cpuNodes.find(node => node.childEvents.some(e => e.name === 'ParseHTML'));
+        if (firstParse) {
+            renderBlockingCpuNodeIds.add(firstParse.id);
+        }
+        // If a CPU filter was passed in, we also want to include those extra nodes.
+        if (additionalCpuNodesToTreatAsRenderBlocking) {
+            cpuNodes.filter(additionalCpuNodesToTreatAsRenderBlocking).forEach(node => renderBlockingCpuNodeIds.add(node.id));
+        }
+        return {
+            definitelyNotRenderBlockingScriptUrls,
+            renderBlockingCpuNodeIds,
+        };
+    }
+    /**
+     * Computes the graph required for the first paint of interest.
+     */
+    static getFirstPaintBasedGraph(dependencyGraph, { cutoffTimestamp, treatNodeAsRenderBlocking, additionalCpuNodesToTreatAsRenderBlocking }) {
+        const rbData = this.getRenderBlockingNodeData(dependencyGraph, {
+            cutoffTimestamp,
+            treatNodeAsRenderBlocking,
+            additionalCpuNodesToTreatAsRenderBlocking,
+        });
+        const { definitelyNotRenderBlockingScriptUrls, renderBlockingCpuNodeIds } = rbData;
+        return dependencyGraph.cloneWithRelationships(node => {
+            if (node.type === BaseNode.types.NETWORK) {
+                // Exclude all nodes that ended after cutoffTimestamp (except for the main document which we always consider necessary)
+                // endTime is negative if request does not finish, make sure startTime isn't after cutoffTimestamp in this case.
+                const endedAfterPaint = node.endTime > cutoffTimestamp || node.startTime > cutoffTimestamp;
+                if (endedAfterPaint && !node.isMainDocument()) {
+                    return false;
+                }
+                const url = node.request.url;
+                // If the URL definitely wasn't render-blocking then we filter it out.
+                if (definitelyNotRenderBlockingScriptUrls.has(url)) {
+                    return false;
+                }
+                // Lastly, build up the FCP graph of all nodes we consider render blocking
+                return treatNodeAsRenderBlocking(node);
+            }
+            // If it's a CPU node, just check if it was blocking.
+            return renderBlockingCpuNodeIds.has(node.id);
+        });
+    }
+    static getOptimisticGraph(dependencyGraph, processedNavigation) {
+        return this.getFirstPaintBasedGraph(dependencyGraph, {
+            cutoffTimestamp: processedNavigation.timestamps.firstContentfulPaint,
+            // In the optimistic graph we exclude resources that appeared to be render blocking but were
+            // initiated by a script. While they typically have a very high importance and tend to have a
+            // significant impact on the page's content, these resources don't technically block rendering.
+            treatNodeAsRenderBlocking: node => node.hasRenderBlockingPriority() && node.initiatorType !== 'script',
+        });
+    }
+    static getPessimisticGraph(dependencyGraph, processedNavigation) {
+        return this.getFirstPaintBasedGraph(dependencyGraph, {
+            cutoffTimestamp: processedNavigation.timestamps.firstContentfulPaint,
+            treatNodeAsRenderBlocking: node => node.hasRenderBlockingPriority(),
+        });
+    }
+}
+export { FirstContentfulPaint };
+//# sourceMappingURL=FirstContentfulPaint.js.map

package/models/trace/lantern/metrics/FirstContentfulPaint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FirstContentfulPaint.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/metrics/FirstContentfulPaint.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,EAAC,QAAQ,EAAY,MAAM,gBAAgB,CAAC;AAKnD,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AAoBnC,MAAM,oBAAqB,SAAQ,MAAM;IACvC,MAAM,KAAc,YAAY;QAC9B,OAAO;YACL,SAAS,EAAE,CAAC;YACZ,UAAU,EAAE,GAAG;YACf,WAAW,EAAE,GAAG;SACjB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,yBAAyB,CAC5B,KAAW,EACX,EAAC,eAAe,EAAE,yBAAyB,EAAE,yCAAyC,EACvD;QAEjC,iGAAiG;QACjG,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAmB,CAAC;QAEtD,MAAM,QAAQ,GAAc,EAAE,CAAC;QAC/B,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACpB,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;gBACrC,+EAA+E;gBAC/E,mGAAmG;gBACnG,IAAI,IAAI,CAAC,SAAS,IAAI,eAAe,EAAE,CAAC;oBACtC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACtB,CAAC;gBAED,0EAA0E;gBAC1E,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAChD,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;oBAC7B,qCAAqC;oBACrC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;oBACrD,kBAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;gBACrF,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC;QAEnD,wFAAwF;QACxF,MAAM,gCAAgC,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE;YAC1E,6FAA6F;YAC7F,wFAAwF;YACxF,+DAA+D;YAC/D,OAAO,IAAI,CAAC,OAAO,IAAI,eAAe,IAAI,yBAAyB,CAAC,IAAI,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QAEH,yGAAyG;QACzG,MAAM,qCAAqC,GAAG,IAAI,GAAG,EAAU,CAAC;QAChE,MAAM,wBAAwB,GAAG,IAAI,GAAG,EAAU,CAAC;QACnD,KAAK,MAAM,GAAG,IAAI,gCAAgC,EAAE,CAAC;YACnD,yEAAyE;YACzE,MAAM,aAAa,GAAG,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAElD,2EAA2E;YAC3E,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,SAAS;YACX,CAAC;YAED,kIAAkI;YAClI,IAAI,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;gBACrC,wBAAwB,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;gBAC/C,SAAS;YACX,CAAC;YAED,6FAA6F;YAC7F,iDAAiD;YACjD,qCAAqC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjD,CAAC;QAED,kGAAkG;QAClG,wCAAwC;QACxC,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACnE,IAAI,WAAW,EAAE,CAAC;YAChB,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;QACD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC;QACzF,IAAI,UAAU,EAAE,CAAC;YACf,wBAAwB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC;QAC7F,IAAI,UAAU,EAAE,CAAC;YACf,wBAAwB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC9C,CAAC;QAED,4EAA4E;QAC5E,IAAI,yCAAyC,EAAE,CAAC;YAC9C,QAAQ,CAAC,MAAM,CAAC,yCAAyC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,wBAAwB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACpH,CAAC;QAED,OAAO;YACL,qCAAqC;YACrC,wBAAwB;SACzB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,uBAAuB,CAC1B,eAAqB,EACrB,EAAC,eAAe,EAAE,yBAAyB,EAAE,yCAAyC,EACvD;QAEjC,MAAM,MAAM,GAAG,IAAI,CAAC,yBAAyB,CAAC,eAAe,EAAE;YAC7D,eAAe;YACf,yBAAyB;YACzB,yCAAyC;SAC1C,CAAC,CAAC;QACH,MAAM,EAAC,qCAAqC,EAAE,wBAAwB,EAAC,GAAG,MAAM,CAAC;QAEjF,OAAO,eAAe,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE;YACnD,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACzC,uHAAuH;gBACvH,gHAAgH;gBAChH,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,GAAG,eAAe,IAAI,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC;gBAC3F,IAAI,eAAe,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;oBAC9C,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC7B,sEAAsE;gBACtE,IAAI,qCAAqC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;oBACnD,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,0EAA0E;gBAC1E,OAAO,yBAAyB,CAAC,IAAI,CAAC,CAAC;YACzC,CAAC;YACD,qDAAqD;YACrD,OAAO,wBAAwB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAU,kBAAkB,CAC9B,eAAwB,EAAE,mBAA2D;QACvF,OAAO,IAAI,CAAC,uBAAuB,CAAC,eAAe,EAAE;YACnD,eAAe,EAAE,mBAAmB,CAAC,UAAU,CAAC,oBAAoB;YACpE,4FAA4F;YAC5F,6FAA6F;YAC7F,+FAA+F;YAC/F,yBAAyB,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,yBAAyB,EAAE,IAAI,IAAI,CAAC,aAAa,KAAK,QAAQ;SACvG,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAU,mBAAmB,CAC/B,eAAwB,EAAE,mBAA2D;QACvF,OAAO,IAAI,CAAC,uBAAuB,CAAC,eAAe,EAAE;YACnD,eAAe,EAAE,mBAAmB,CAAC,UAAU,CAAC,oBAAoB;YACpE,yBAAyB,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,yBAAyB,EAAE;SACpE,CAAC,CAAC;IACL,CAAC;CACF;AAED,OAAO,EAAC,oBAAoB,EAAC,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 {BaseNode, type Node} from '../BaseNode.js';\nimport {type CPUNode} from '../CPUNode.js';\nimport {type NetworkNode} from '../NetworkNode.js';\nimport type * as Lantern from '../types/lantern.js';\n\nimport {Metric} from './Metric.js';\n\ninterface FirstPaintBasedGraphOpts<T> {\n  /**\n   * The timestamp used to filter out tasks that occured after our paint of interest.\n   * Typically this is First Contentful Paint or First Meaningful Paint.\n   */\n  cutoffTimestamp: number;\n  /**\n   * The function that determines which resources should be considered *possibly*\n   * render-blocking.\n   */\n  treatNodeAsRenderBlocking: (node: NetworkNode<T>) => boolean;\n  /**\n   * The function that determines which CPU nodes should also be included in our\n   * blocking node IDs set, beyond what getRenderBlockingNodeData() already includes.\n   */\n  additionalCpuNodesToTreatAsRenderBlocking?: (node: CPUNode) => boolean;\n}\n\nclass FirstContentfulPaint extends Metric {\n  static override get coefficients(): Lantern.Simulation.MetricCoefficients {\n    return {\n      intercept: 0,\n      optimistic: 0.5,\n      pessimistic: 0.5,\n    };\n  }\n\n  /**\n   * Computes the set of URLs that *appeared* to be render-blocking based on our filter,\n   * *but definitely were not* render-blocking based on the timing of their EvaluateScript task.\n   * It also computes the set of corresponding CPU node ids that were needed for the paint at the\n   * given timestamp.\n   */\n  static getRenderBlockingNodeData<T = unknown>(\n      graph: Node,\n      {cutoffTimestamp, treatNodeAsRenderBlocking, additionalCpuNodesToTreatAsRenderBlocking}:\n          FirstPaintBasedGraphOpts<T>,\n      ): {definitelyNotRenderBlockingScriptUrls: Set<string>, renderBlockingCpuNodeIds: Set<string>} {\n    /** A map of blocking script URLs to the earliest EvaluateScript task node that executed them. */\n    const scriptUrlToNodeMap = new Map<string, CPUNode>();\n\n    const cpuNodes: CPUNode[] = [];\n    graph.traverse(node => {\n      if (node.type === BaseNode.types.CPU) {\n        // A task is *possibly* render blocking if it *started* before cutoffTimestamp.\n        // We use startTime here because the paint event can be *inside* the task that was render blocking.\n        if (node.startTime <= cutoffTimestamp) {\n          cpuNodes.push(node);\n        }\n\n        // Build our script URL map to find the earliest EvaluateScript task node.\n        const scriptUrls = node.getEvaluateScriptURLs();\n        for (const url of scriptUrls) {\n          // Use the earliest CPU node we find.\n          const existing = scriptUrlToNodeMap.get(url) || node;\n          scriptUrlToNodeMap.set(url, node.startTime < existing.startTime ? node : existing);\n        }\n      }\n    });\n\n    cpuNodes.sort((a, b) => a.startTime - b.startTime);\n\n    // A script is *possibly* render blocking if it finished loading before cutoffTimestamp.\n    const possiblyRenderBlockingScriptUrls = Metric.getScriptUrls(graph, node => {\n      // The optimistic LCP treatNodeAsRenderBlocking fn wants to exclude some images in the graph,\n      // but here it only receives scripts to evaluate. It's a no-op in this case, but it will\n      // matter below in the getFirstPaintBasedGraph clone operation.\n      return node.endTime <= cutoffTimestamp && treatNodeAsRenderBlocking(node);\n    });\n\n    // A script is *definitely not* render blocking if its EvaluateScript task started after cutoffTimestamp.\n    const definitelyNotRenderBlockingScriptUrls = new Set<string>();\n    const renderBlockingCpuNodeIds = new Set<string>();\n    for (const url of possiblyRenderBlockingScriptUrls) {\n      // Lookup the CPU node that had the earliest EvaluateScript for this URL.\n      const cpuNodeForUrl = scriptUrlToNodeMap.get(url);\n\n      // If we can't find it at all, we can't conclude anything, so just skip it.\n      if (!cpuNodeForUrl) {\n        continue;\n      }\n\n      // If we found it and it was in our `cpuNodes` set that means it finished before cutoffTimestamp, so it really is render-blocking.\n      if (cpuNodes.includes(cpuNodeForUrl)) {\n        renderBlockingCpuNodeIds.add(cpuNodeForUrl.id);\n        continue;\n      }\n\n      // We couldn't find the evaluate script in the set of CPU nodes that ran before our paint, so\n      // it must not have been necessary for the paint.\n      definitelyNotRenderBlockingScriptUrls.add(url);\n    }\n\n    // The first layout, first paint, and first ParseHTML are almost always necessary for first paint,\n    // so we always include those CPU nodes.\n    const firstLayout = cpuNodes.find(node => node.didPerformLayout());\n    if (firstLayout) {\n      renderBlockingCpuNodeIds.add(firstLayout.id);\n    }\n    const firstPaint = cpuNodes.find(node => node.childEvents.some(e => e.name === 'Paint'));\n    if (firstPaint) {\n      renderBlockingCpuNodeIds.add(firstPaint.id);\n    }\n    const firstParse = cpuNodes.find(node => node.childEvents.some(e => e.name === 'ParseHTML'));\n    if (firstParse) {\n      renderBlockingCpuNodeIds.add(firstParse.id);\n    }\n\n    // If a CPU filter was passed in, we also want to include those extra nodes.\n    if (additionalCpuNodesToTreatAsRenderBlocking) {\n      cpuNodes.filter(additionalCpuNodesToTreatAsRenderBlocking).forEach(node => renderBlockingCpuNodeIds.add(node.id));\n    }\n\n    return {\n      definitelyNotRenderBlockingScriptUrls,\n      renderBlockingCpuNodeIds,\n    };\n  }\n\n  /**\n   * Computes the graph required for the first paint of interest.\n   */\n  static getFirstPaintBasedGraph<T>(\n      dependencyGraph: Node,\n      {cutoffTimestamp, treatNodeAsRenderBlocking, additionalCpuNodesToTreatAsRenderBlocking}:\n          FirstPaintBasedGraphOpts<T>,\n      ): Node<T> {\n    const rbData = this.getRenderBlockingNodeData(dependencyGraph, {\n      cutoffTimestamp,\n      treatNodeAsRenderBlocking,\n      additionalCpuNodesToTreatAsRenderBlocking,\n    });\n    const {definitelyNotRenderBlockingScriptUrls, renderBlockingCpuNodeIds} = rbData;\n\n    return dependencyGraph.cloneWithRelationships(node => {\n      if (node.type === BaseNode.types.NETWORK) {\n        // Exclude all nodes that ended after cutoffTimestamp (except for the main document which we always consider necessary)\n        // endTime is negative if request does not finish, make sure startTime isn't after cutoffTimestamp in this case.\n        const endedAfterPaint = node.endTime > cutoffTimestamp || node.startTime > cutoffTimestamp;\n        if (endedAfterPaint && !node.isMainDocument()) {\n          return false;\n        }\n\n        const url = node.request.url;\n        // If the URL definitely wasn't render-blocking then we filter it out.\n        if (definitelyNotRenderBlockingScriptUrls.has(url)) {\n          return false;\n        }\n\n        // Lastly, build up the FCP graph of all nodes we consider render blocking\n        return treatNodeAsRenderBlocking(node);\n      }\n      // If it's a CPU node, just check if it was blocking.\n      return renderBlockingCpuNodeIds.has(node.id);\n    });\n  }\n\n  static override getOptimisticGraph<T>(\n      dependencyGraph: Node<T>, processedNavigation: Lantern.Simulation.ProcessedNavigation): Node<T> {\n    return this.getFirstPaintBasedGraph(dependencyGraph, {\n      cutoffTimestamp: processedNavigation.timestamps.firstContentfulPaint,\n      // In the optimistic graph we exclude resources that appeared to be render blocking but were\n      // initiated by a script. While they typically have a very high importance and tend to have a\n      // significant impact on the page's content, these resources don't technically block rendering.\n      treatNodeAsRenderBlocking: node => node.hasRenderBlockingPriority() && node.initiatorType !== 'script',\n    });\n  }\n\n  static override getPessimisticGraph<T>(\n      dependencyGraph: Node<T>, processedNavigation: Lantern.Simulation.ProcessedNavigation): Node<T> {\n    return this.getFirstPaintBasedGraph(dependencyGraph, {\n      cutoffTimestamp: processedNavigation.timestamps.firstContentfulPaint,\n      treatNodeAsRenderBlocking: node => node.hasRenderBlockingPriority(),\n    });\n  }\n}\n\nexport {FirstContentfulPaint};\n"]}

package/models/trace/lantern/metrics/Interactive.d.ts

@@ -0,0 +1,12 @@
+import { type Node } from '../BaseNode.js';
+import type * as Lantern from '../types/lantern.js';
+import { type Extras, Metric } from './Metric.js';
+declare class Interactive extends Metric {
+    static get coefficients(): Lantern.Simulation.MetricCoefficients;
+    static getOptimisticGraph<T>(dependencyGraph: Node<T>): Node<T>;
+    static getPessimisticGraph<T>(dependencyGraph: Node<T>): Node<T>;
+    static getEstimateFromSimulation(simulationResult: Lantern.Simulation.Result, extras: Extras): Lantern.Simulation.Result;
+    static compute(data: Lantern.Simulation.MetricComputationDataInput, extras?: Omit<Extras, 'optimistic'>): Promise<Lantern.Metrics.Result>;
+    static getLastLongTaskEndTime(nodeTimings: Lantern.Simulation.Result['nodeTimings'], duration?: number): number;
+}
+export { Interactive };

package/models/trace/lantern/metrics/Interactive.js

@@ -0,0 +1,68 @@
+// Copyright 2024 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+import { BaseNode } from '../BaseNode.js';
+import { Metric } from './Metric.js';
+// Any CPU task of 20 ms or more will end up being a critical long task on mobile
+const CRITICAL_LONG_TASK_THRESHOLD = 20;
+class Interactive extends Metric {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    static get coefficients() {
+        return {
+            intercept: 0,
+            optimistic: 0.45,
+            pessimistic: 0.55,
+        };
+    }
+    static getOptimisticGraph(dependencyGraph) {
+        // Adjust the critical long task threshold for microseconds
+        const minimumCpuTaskDuration = CRITICAL_LONG_TASK_THRESHOLD * 1000;
+        return dependencyGraph.cloneWithRelationships(node => {
+            // Include everything that might be a long task
+            if (node.type === BaseNode.types.CPU) {
+                return node.duration > minimumCpuTaskDuration;
+            }
+            // Include all scripts and high priority requests, exclude all images
+            const isImage = node.request.resourceType === 'Image';
+            const isScript = node.request.resourceType === 'Script';
+            return (!isImage && (isScript || node.request.priority === 'High' || node.request.priority === 'VeryHigh'));
+        });
+    }
+    static getPessimisticGraph(dependencyGraph) {
+        return dependencyGraph;
+    }
+    static getEstimateFromSimulation(simulationResult, extras) {
+        if (!extras.lcpResult) {
+            throw new Error('missing lcpResult');
+        }
+        const lastTaskAt = Interactive.getLastLongTaskEndTime(simulationResult.nodeTimings);
+        const minimumTime = extras.optimistic ? extras.lcpResult.optimisticEstimate.timeInMs :
+            extras.lcpResult.pessimisticEstimate.timeInMs;
+        return {
+            timeInMs: Math.max(minimumTime, lastTaskAt),
+            nodeTimings: simulationResult.nodeTimings,
+        };
+    }
+    static async compute(data, extras) {
+        const lcpResult = extras?.lcpResult;
+        if (!lcpResult) {
+            throw new Error('LCP is required to calculate the Interactive metric');
+        }
+        const metricResult = await super.compute(data, extras);
+        metricResult.timing = Math.max(metricResult.timing, lcpResult.timing);
+        return metricResult;
+    }
+    static getLastLongTaskEndTime(nodeTimings, duration = 50) {
+        return Array.from(nodeTimings.entries())
+            .filter(([node, timing]) => {
+            if (node.type !== BaseNode.types.CPU) {
+                return false;
+            }
+            return timing.duration > duration;
+        })
+            .map(([_, timing]) => timing.endTime)
+            .reduce((max, x) => Math.max(max || 0, x || 0), 0);
+    }
+}
+export { Interactive };
+//# sourceMappingURL=Interactive.js.map

package/models/trace/lantern/metrics/Interactive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Interactive.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/metrics/Interactive.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,EAAC,QAAQ,EAAY,MAAM,gBAAgB,CAAC;AAGnD,OAAO,EAAc,MAAM,EAAC,MAAM,aAAa,CAAC;AAEhD,iFAAiF;AACjF,MAAM,4BAA4B,GAAG,EAAE,CAAC;AAExC,MAAM,WAAY,SAAQ,MAAM;IAC9B,gEAAgE;IAChE,MAAM,KAAc,YAAY;QAC9B,OAAO;YACL,SAAS,EAAE,CAAC;YACZ,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,IAAI;SAClB,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,kBAAkB,CAAI,eAAwB;QAC5D,2DAA2D;QAC3D,MAAM,sBAAsB,GAAG,4BAA4B,GAAG,IAAI,CAAC;QAEnE,OAAO,eAAe,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE;YACnD,+CAA+C;YAC/C,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;gBACrC,OAAO,IAAI,CAAC,QAAQ,GAAG,sBAAsB,CAAC;YAChD,CAAC;YAED,qEAAqE;YACrE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,KAAK,OAAO,CAAC;YACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,KAAK,QAAQ,CAAC;YACxD,OAAO,CAAC,CAAC,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC;QAC9G,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAU,mBAAmB,CAAI,eAAwB;QAC7D,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,MAAM,CAAU,yBAAyB,CAAC,gBAA2C,EAAE,MAAc;QAEnG,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QAED,MAAM,UAAU,GAAG,WAAW,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QACpF,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC,QAAQ,CAAC;QACtF,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC;YAC3C,WAAW,EAAE,gBAAgB,CAAC,WAAW;SAC1C,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CACzB,IAAmD,EACnD,MAAmC;QACrC,MAAM,SAAS,GAAG,MAAM,EAAE,SAAS,CAAC;QACpC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACvD,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QACtE,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,MAAM,CAAC,sBAAsB,CAAC,WAAqD,EAAE,QAAQ,GAAG,EAAE;QAChG,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;aACnC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;YACzB,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;gBACrC,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACpC,CAAC,CAAC;aACD,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC;aACpC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD,CAAC;CACF;AAED,OAAO,EAAC,WAAW,EAAC,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 {BaseNode, type Node} from '../BaseNode.js';\nimport type * as Lantern from '../types/lantern.js';\n\nimport {type Extras, Metric} from './Metric.js';\n\n// Any CPU task of 20 ms or more will end up being a critical long task on mobile\nconst CRITICAL_LONG_TASK_THRESHOLD = 20;\n\nclass Interactive extends Metric {\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  static override get coefficients(): Lantern.Simulation.MetricCoefficients {\n    return {\n      intercept: 0,\n      optimistic: 0.45,\n      pessimistic: 0.55,\n    };\n  }\n\n  static override getOptimisticGraph<T>(dependencyGraph: Node<T>): Node<T> {\n    // Adjust the critical long task threshold for microseconds\n    const minimumCpuTaskDuration = CRITICAL_LONG_TASK_THRESHOLD * 1000;\n\n    return dependencyGraph.cloneWithRelationships(node => {\n      // Include everything that might be a long task\n      if (node.type === BaseNode.types.CPU) {\n        return node.duration > minimumCpuTaskDuration;\n      }\n\n      // Include all scripts and high priority requests, exclude all images\n      const isImage = node.request.resourceType === 'Image';\n      const isScript = node.request.resourceType === 'Script';\n      return (!isImage && (isScript || node.request.priority === 'High' || node.request.priority === 'VeryHigh'));\n    });\n  }\n\n  static override getPessimisticGraph<T>(dependencyGraph: Node<T>): Node<T> {\n    return dependencyGraph;\n  }\n\n  static override getEstimateFromSimulation(simulationResult: Lantern.Simulation.Result, extras: Extras):\n      Lantern.Simulation.Result {\n    if (!extras.lcpResult) {\n      throw new Error('missing lcpResult');\n    }\n\n    const lastTaskAt = Interactive.getLastLongTaskEndTime(simulationResult.nodeTimings);\n    const minimumTime = extras.optimistic ? extras.lcpResult.optimisticEstimate.timeInMs :\n                                            extras.lcpResult.pessimisticEstimate.timeInMs;\n    return {\n      timeInMs: Math.max(minimumTime, lastTaskAt),\n      nodeTimings: simulationResult.nodeTimings,\n    };\n  }\n\n  static override async compute(\n      data: Lantern.Simulation.MetricComputationDataInput,\n      extras?: Omit<Extras, 'optimistic'>): Promise<Lantern.Metrics.Result> {\n    const lcpResult = extras?.lcpResult;\n    if (!lcpResult) {\n      throw new Error('LCP is required to calculate the Interactive metric');\n    }\n\n    const metricResult = await super.compute(data, extras);\n    metricResult.timing = Math.max(metricResult.timing, lcpResult.timing);\n    return metricResult;\n  }\n\n  static getLastLongTaskEndTime(nodeTimings: Lantern.Simulation.Result['nodeTimings'], duration = 50): number {\n    return Array.from(nodeTimings.entries())\n        .filter(([node, timing]) => {\n          if (node.type !== BaseNode.types.CPU) {\n            return false;\n          }\n          return timing.duration > duration;\n        })\n        .map(([_, timing]) => timing.endTime)\n        .reduce((max, x) => Math.max(max || 0, x || 0), 0);\n  }\n}\n\nexport {Interactive};\n"]}

package/models/trace/lantern/metrics/LargestContentfulPaint.d.ts

@@ -0,0 +1,16 @@
+import { type Node } from '../BaseNode.js';
+import type * as Lantern from '../types/lantern.js';
+import { type Extras, Metric } from './Metric.js';
+declare class LargestContentfulPaint extends Metric {
+    static get coefficients(): Lantern.Simulation.MetricCoefficients;
+    /**
+     * Low priority image nodes are usually offscreen and very unlikely to be the
+     * resource that is required for LCP. Our LCP graphs include everything except for these images.
+     */
+    static isNotLowPriorityImageNode(node: Node): boolean;
+    static getOptimisticGraph(dependencyGraph: Node, processedNavigation: Lantern.Simulation.ProcessedNavigation): Node;
+    static getPessimisticGraph(dependencyGraph: Node, processedNavigation: Lantern.Simulation.ProcessedNavigation): Node;
+    static getEstimateFromSimulation(simulationResult: Lantern.Simulation.Result): Lantern.Simulation.Result;
+    static compute(data: Lantern.Simulation.MetricComputationDataInput, extras?: Omit<Extras, 'optimistic'>): Promise<Lantern.Metrics.Result>;
+}
+export { LargestContentfulPaint };

package/models/trace/lantern/metrics/LargestContentfulPaint.js

@@ -0,0 +1,70 @@
+// Copyright 2024 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+import { LanternError } from '../LanternError.js';
+import { FirstContentfulPaint } from './FirstContentfulPaint.js';
+import { Metric } from './Metric.js';
+class LargestContentfulPaint extends Metric {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    static get coefficients() {
+        return {
+            intercept: 0,
+            optimistic: 0.5,
+            pessimistic: 0.5,
+        };
+    }
+    /**
+     * Low priority image nodes are usually offscreen and very unlikely to be the
+     * resource that is required for LCP. Our LCP graphs include everything except for these images.
+     */
+    static isNotLowPriorityImageNode(node) {
+        if (node.type !== 'network') {
+            return true;
+        }
+        const isImage = node.request.resourceType === 'Image';
+        const isLowPriority = node.request.priority === 'Low' || node.request.priority === 'VeryLow';
+        return !isImage || !isLowPriority;
+    }
+    static getOptimisticGraph(dependencyGraph, processedNavigation) {
+        const lcp = processedNavigation.timestamps.largestContentfulPaint;
+        if (!lcp) {
+            throw new LanternError('NO_LCP');
+        }
+        return FirstContentfulPaint.getFirstPaintBasedGraph(dependencyGraph, {
+            cutoffTimestamp: lcp,
+            treatNodeAsRenderBlocking: LargestContentfulPaint.isNotLowPriorityImageNode,
+        });
+    }
+    static getPessimisticGraph(dependencyGraph, processedNavigation) {
+        const lcp = processedNavigation.timestamps.largestContentfulPaint;
+        if (!lcp) {
+            throw new LanternError('NO_LCP');
+        }
+        return FirstContentfulPaint.getFirstPaintBasedGraph(dependencyGraph, {
+            cutoffTimestamp: lcp,
+            treatNodeAsRenderBlocking: _ => true,
+            // For pessimistic LCP we'll include *all* layout nodes
+            additionalCpuNodesToTreatAsRenderBlocking: node => node.didPerformLayout(),
+        });
+    }
+    static getEstimateFromSimulation(simulationResult) {
+        const nodeTimesNotOffscreenImages = Array.from(simulationResult.nodeTimings.entries())
+            .filter(entry => LargestContentfulPaint.isNotLowPriorityImageNode(entry[0]))
+            .map(entry => entry[1].endTime);
+        return {
+            timeInMs: Math.max(...nodeTimesNotOffscreenImages),
+            nodeTimings: simulationResult.nodeTimings,
+        };
+    }
+    static async compute(data, extras) {
+        const fcpResult = extras?.fcpResult;
+        if (!fcpResult) {
+            throw new Error('FCP is required to calculate the LCP metric');
+        }
+        const metricResult = await super.compute(data, extras);
+        metricResult.timing = Math.max(metricResult.timing, fcpResult.timing);
+        return metricResult;
+    }
+}
+export { LargestContentfulPaint };
+//# sourceMappingURL=LargestContentfulPaint.js.map

package/models/trace/lantern/metrics/LargestContentfulPaint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LargestContentfulPaint.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/metrics/LargestContentfulPaint.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAG7B,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAGhD,OAAO,EAAC,oBAAoB,EAAC,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAc,MAAM,EAAC,MAAM,aAAa,CAAC;AAEhD,MAAM,sBAAuB,SAAQ,MAAM;IACzC,gEAAgE;IAChE,MAAM,KAAc,YAAY;QAC9B,OAAO;YACL,SAAS,EAAE,CAAC;YACZ,UAAU,EAAE,GAAG;YACf,WAAW,EAAE,GAAG;SACjB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,yBAAyB,CAAC,IAAU;QACzC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,KAAK,OAAO,CAAC;QACtD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC;QAC7F,OAAO,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC;IACpC,CAAC;IAED,MAAM,CAAU,kBAAkB,CAC9B,eAAqB,EAAE,mBAA2D;QACpF,MAAM,GAAG,GAAG,mBAAmB,CAAC,UAAU,CAAC,sBAAsB,CAAC;QAClE,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,oBAAoB,CAAC,uBAAuB,CAAC,eAAe,EAAE;YACnE,eAAe,EAAE,GAAG;YACpB,yBAAyB,EAAE,sBAAsB,CAAC,yBAAyB;SAC5E,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAU,mBAAmB,CAC/B,eAAqB,EAAE,mBAA2D;QACpF,MAAM,GAAG,GAAG,mBAAmB,CAAC,UAAU,CAAC,sBAAsB,CAAC;QAClE,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,oBAAoB,CAAC,uBAAuB,CAAC,eAAe,EAAE;YACnE,eAAe,EAAE,GAAG;YACpB,yBAAyB,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI;YACpC,uDAAuD;YACvD,yCAAyC,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE;SAC3E,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAU,yBAAyB,CAAC,gBAA2C;QACnF,MAAM,2BAA2B,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;aAC7C,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,sBAAsB,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;aAC3E,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAExE,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,2BAA2B,CAAC;YAClD,WAAW,EAAE,gBAAgB,CAAC,WAAW;SAC1C,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,OAAO,CACzB,IAAmD,EACnD,MAAmC;QACrC,MAAM,SAAS,GAAG,MAAM,EAAE,SAAS,CAAC;QACpC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACvD,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QACtE,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AAED,OAAO,EAAC,sBAAsB,EAAC,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 {type Node} from '../BaseNode.js';\nimport {LanternError} from '../LanternError.js';\nimport type * as Lantern from '../types/lantern.js';\n\nimport {FirstContentfulPaint} from './FirstContentfulPaint.js';\nimport {type Extras, Metric} from './Metric.js';\n\nclass LargestContentfulPaint extends Metric {\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  static override get coefficients(): Lantern.Simulation.MetricCoefficients {\n    return {\n      intercept: 0,\n      optimistic: 0.5,\n      pessimistic: 0.5,\n    };\n  }\n\n  /**\n   * Low priority image nodes are usually offscreen and very unlikely to be the\n   * resource that is required for LCP. Our LCP graphs include everything except for these images.\n   */\n  static isNotLowPriorityImageNode(node: Node): boolean {\n    if (node.type !== 'network') {\n      return true;\n    }\n    const isImage = node.request.resourceType === 'Image';\n    const isLowPriority = node.request.priority === 'Low' || node.request.priority === 'VeryLow';\n    return !isImage || !isLowPriority;\n  }\n\n  static override getOptimisticGraph(\n      dependencyGraph: Node, processedNavigation: Lantern.Simulation.ProcessedNavigation): Node {\n    const lcp = processedNavigation.timestamps.largestContentfulPaint;\n    if (!lcp) {\n      throw new LanternError('NO_LCP');\n    }\n\n    return FirstContentfulPaint.getFirstPaintBasedGraph(dependencyGraph, {\n      cutoffTimestamp: lcp,\n      treatNodeAsRenderBlocking: LargestContentfulPaint.isNotLowPriorityImageNode,\n    });\n  }\n\n  static override getPessimisticGraph(\n      dependencyGraph: Node, processedNavigation: Lantern.Simulation.ProcessedNavigation): Node {\n    const lcp = processedNavigation.timestamps.largestContentfulPaint;\n    if (!lcp) {\n      throw new LanternError('NO_LCP');\n    }\n\n    return FirstContentfulPaint.getFirstPaintBasedGraph(dependencyGraph, {\n      cutoffTimestamp: lcp,\n      treatNodeAsRenderBlocking: _ => true,\n      // For pessimistic LCP we'll include *all* layout nodes\n      additionalCpuNodesToTreatAsRenderBlocking: node => node.didPerformLayout(),\n    });\n  }\n\n  static override getEstimateFromSimulation(simulationResult: Lantern.Simulation.Result): Lantern.Simulation.Result {\n    const nodeTimesNotOffscreenImages = Array.from(simulationResult.nodeTimings.entries())\n                                            .filter(entry => LargestContentfulPaint.isNotLowPriorityImageNode(entry[0]))\n                                            .map(entry => entry[1].endTime);\n\n    return {\n      timeInMs: Math.max(...nodeTimesNotOffscreenImages),\n      nodeTimings: simulationResult.nodeTimings,\n    };\n  }\n\n  static override async compute(\n      data: Lantern.Simulation.MetricComputationDataInput,\n      extras?: Omit<Extras, 'optimistic'>): Promise<Lantern.Metrics.Result> {\n    const fcpResult = extras?.fcpResult;\n    if (!fcpResult) {\n      throw new Error('FCP is required to calculate the LCP metric');\n    }\n\n    const metricResult = await super.compute(data, extras);\n    metricResult.timing = Math.max(metricResult.timing, fcpResult.timing);\n    return metricResult;\n  }\n}\n\nexport {LargestContentfulPaint};\n"]}

package/models/trace/lantern/metrics/MaxPotentialFID.d.ts

@@ -0,0 +1,14 @@
+import { type Node } from '../BaseNode.js';
+import type * as Lantern from '../types/lantern.js';
+import { type Extras, Metric } from './Metric.js';
+declare class MaxPotentialFID extends Metric {
+    static get coefficients(): Lantern.Simulation.MetricCoefficients;
+    static getOptimisticGraph(dependencyGraph: Node): Node;
+    static getPessimisticGraph(dependencyGraph: Node): Node;
+    static getEstimateFromSimulation(simulation: Lantern.Simulation.Result, extras: Extras): Lantern.Simulation.Result;
+    static compute(data: Lantern.Simulation.MetricComputationDataInput, extras?: Omit<Extras, 'optimistic'>): Promise<Lantern.Metrics.Result>;
+    static getTimingsAfterFCP(nodeTimings: Lantern.Simulation.Result['nodeTimings'], fcpTimeInMs: number): Array<{
+        duration: number;
+    }>;
+}
+export { MaxPotentialFID };