@paulirish/trace_engine 0.0.25 → 0.0.26

package/models/trace/lantern/simulation/TCPConnection.js

@@ -0,0 +1,158 @@
+// 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.
+const INITIAL_CONGESTION_WINDOW = 10;
+const TCP_SEGMENT_SIZE = 1460;
+class TCPConnection {
+    _warmed;
+    _ssl;
+    _h2;
+    _rtt;
+    _throughput;
+    _serverLatency;
+    _congestionWindow;
+    _h2OverflowBytesDownloaded;
+    constructor(rtt, throughput, serverLatency = 0, ssl = true, h2 = false) {
+        this._warmed = false;
+        this._ssl = ssl;
+        this._h2 = h2;
+        this._rtt = rtt;
+        this._throughput = throughput;
+        this._serverLatency = serverLatency;
+        this._congestionWindow = INITIAL_CONGESTION_WINDOW;
+        this._h2OverflowBytesDownloaded = 0;
+    }
+    static maximumSaturatedConnections(rtt, availableThroughput) {
+        const roundTripsPerSecond = 1000 / rtt;
+        const bytesPerRoundTrip = TCP_SEGMENT_SIZE;
+        const bytesPerSecond = roundTripsPerSecond * bytesPerRoundTrip;
+        const minimumThroughputRequiredPerRequest = bytesPerSecond * 8;
+        return Math.floor(availableThroughput / minimumThroughputRequiredPerRequest);
+    }
+    _computeMaximumCongestionWindowInSegments() {
+        const bytesPerSecond = this._throughput / 8;
+        const secondsPerRoundTrip = this._rtt / 1000;
+        const bytesPerRoundTrip = bytesPerSecond * secondsPerRoundTrip;
+        return Math.floor(bytesPerRoundTrip / TCP_SEGMENT_SIZE);
+    }
+    setThroughput(throughput) {
+        this._throughput = throughput;
+    }
+    setCongestionWindow(congestion) {
+        this._congestionWindow = congestion;
+    }
+    setWarmed(warmed) {
+        this._warmed = warmed;
+    }
+    isWarm() {
+        return this._warmed;
+    }
+    isH2() {
+        return this._h2;
+    }
+    get congestionWindow() {
+        return this._congestionWindow;
+    }
+    /**
+     * Sets the number of excess bytes that are available to this connection on future downloads, only
+     * applies to H2 connections.
+     */
+    setH2OverflowBytesDownloaded(bytes) {
+        if (!this._h2) {
+            return;
+        }
+        this._h2OverflowBytesDownloaded = bytes;
+    }
+    clone() {
+        return Object.assign(new TCPConnection(this._rtt, this._throughput), this);
+    }
+    /**
+     * Simulates a network download of a particular number of bytes over an optional maximum amount of time
+     * and returns information about the ending state.
+     *
+     * See https://hpbn.co/building-blocks-of-tcp/#three-way-handshake and
+     *  https://hpbn.co/transport-layer-security-tls/#tls-handshake for details.
+     */
+    simulateDownloadUntil(bytesToDownload, options) {
+        const { timeAlreadyElapsed = 0, maximumTimeToElapse = Infinity, dnsResolutionTime = 0 } = options || {};
+        if (this._warmed && this._h2) {
+            bytesToDownload -= this._h2OverflowBytesDownloaded;
+        }
+        const twoWayLatency = this._rtt;
+        const oneWayLatency = twoWayLatency / 2;
+        const maximumCongestionWindow = this._computeMaximumCongestionWindowInSegments();
+        let handshakeAndRequest = oneWayLatency;
+        if (!this._warmed) {
+            handshakeAndRequest =
+                // DNS lookup
+                dnsResolutionTime +
+                    // SYN
+                    oneWayLatency +
+                    // SYN ACK
+                    oneWayLatency +
+                    // ACK + initial request
+                    oneWayLatency +
+                    // ClientHello/ServerHello assuming TLS False Start is enabled (https://istlsfastyet.com/#server-performance).
+                    (this._ssl ? twoWayLatency : 0);
+        }
+        let roundTrips = Math.ceil(handshakeAndRequest / twoWayLatency);
+        let timeToFirstByte = handshakeAndRequest + this._serverLatency + oneWayLatency;
+        if (this._warmed && this._h2) {
+            timeToFirstByte = 0;
+        }
+        const timeElapsedForTTFB = Math.max(timeToFirstByte - timeAlreadyElapsed, 0);
+        const maximumDownloadTimeToElapse = maximumTimeToElapse - timeElapsedForTTFB;
+        let congestionWindow = Math.min(this._congestionWindow, maximumCongestionWindow);
+        let totalBytesDownloaded = 0;
+        if (timeElapsedForTTFB > 0) {
+            totalBytesDownloaded = congestionWindow * TCP_SEGMENT_SIZE;
+        }
+        else {
+            roundTrips = 0;
+        }
+        let downloadTimeElapsed = 0;
+        let bytesRemaining = bytesToDownload - totalBytesDownloaded;
+        while (bytesRemaining > 0 && downloadTimeElapsed <= maximumDownloadTimeToElapse) {
+            roundTrips++;
+            downloadTimeElapsed += twoWayLatency;
+            congestionWindow = Math.max(Math.min(maximumCongestionWindow, congestionWindow * 2), 1);
+            const bytesDownloadedInWindow = congestionWindow * TCP_SEGMENT_SIZE;
+            totalBytesDownloaded += bytesDownloadedInWindow;
+            bytesRemaining -= bytesDownloadedInWindow;
+        }
+        const timeElapsed = timeElapsedForTTFB + downloadTimeElapsed;
+        const extraBytesDownloaded = this._h2 ? Math.max(totalBytesDownloaded - bytesToDownload, 0) : 0;
+        const bytesDownloaded = Math.max(Math.min(totalBytesDownloaded, bytesToDownload), 0);
+        let connectionTiming;
+        if (!this._warmed) {
+            connectionTiming = {
+                dnsResolutionTime,
+                connectionTime: handshakeAndRequest - dnsResolutionTime,
+                sslTime: this._ssl ? twoWayLatency : undefined,
+                timeToFirstByte,
+            };
+        }
+        else if (this._h2) {
+            // TODO: timing information currently difficult to model for warm h2 connections.
+            connectionTiming = {
+                timeToFirstByte,
+            };
+        }
+        else {
+            connectionTiming = {
+                connectionTime: handshakeAndRequest,
+                timeToFirstByte,
+            };
+        }
+        return {
+            roundTrips,
+            timeElapsed,
+            bytesDownloaded,
+            extraBytesDownloaded,
+            congestionWindow,
+            connectionTiming,
+        };
+    }
+}
+export { TCPConnection };
+//# sourceMappingURL=TCPConnection.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TCPConnection.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/simulation/TCPConnection.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAmB7B,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAE9B,MAAM,aAAa;IACjB,OAAO,CAAU;IACjB,IAAI,CAAU;IACd,GAAG,CAAU;IACb,IAAI,CAAS;IACb,WAAW,CAAS;IACpB,cAAc,CAAS;IACvB,iBAAiB,CAAS;IAC1B,0BAA0B,CAAS;IAEnC,YAAY,GAAW,EAAE,UAAkB,EAAE,aAAa,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,EAAE,EAAE,GAAG,KAAK;QACpF,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,iBAAiB,GAAG,yBAAyB,CAAC;QACnD,IAAI,CAAC,0BAA0B,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,2BAA2B,CAAC,GAAW,EAAE,mBAA2B;QACzE,MAAM,mBAAmB,GAAG,IAAI,GAAG,GAAG,CAAC;QACvC,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;QAC3C,MAAM,cAAc,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;QAC/D,MAAM,mCAAmC,GAAG,cAAc,GAAG,CAAC,CAAC;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,GAAG,mCAAmC,CAAC,CAAC;IAC/E,CAAC;IAED,yCAAyC;QACvC,MAAM,cAAc,GAAG,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;QAC5C,MAAM,mBAAmB,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAC7C,MAAM,iBAAiB,GAAG,cAAc,GAAG,mBAAmB,CAAC;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,CAAC;IAC1D,CAAC;IAED,aAAa,CAAC,UAAkB;QAC9B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,mBAAmB,CAAC,UAAkB;QACpC,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;IACtC,CAAC;IAED,SAAS,CAAC,MAAe;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAAC,KAAa;QACxC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACd,OAAO;QACT,CAAC;QACD,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC;IAC1C,CAAC;IAED,KAAK;QACH,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,qBAAqB,CAAC,eAAuB,EAAE,OAAyB;QACtE,MAAM,EAAC,kBAAkB,GAAG,CAAC,EAAE,mBAAmB,GAAG,QAAQ,EAAE,iBAAiB,GAAG,CAAC,EAAC,GAAG,OAAO,IAAI,EAAE,CAAC;QAEtG,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,eAAe,IAAI,IAAI,CAAC,0BAA0B,CAAC;QACrD,CAAC;QACD,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC;QAChC,MAAM,aAAa,GAAG,aAAa,GAAG,CAAC,CAAC;QACxC,MAAM,uBAAuB,GAAG,IAAI,CAAC,yCAAyC,EAAE,CAAC;QAEjF,IAAI,mBAAmB,GAAG,aAAa,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,mBAAmB;gBACf,aAAa;gBACb,iBAAiB;oBACjB,MAAM;oBACN,aAAa;oBACb,UAAU;oBACV,aAAa;oBACb,wBAAwB;oBACxB,aAAa;oBACb,8GAA8G;oBAC9G,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,mBAAmB,GAAG,aAAa,CAAC,CAAC;QAChE,IAAI,eAAe,GAAG,mBAAmB,GAAG,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QAChF,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,eAAe,GAAG,CAAC,CAAC;QACtB,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAAC,eAAe,GAAG,kBAAkB,EAAE,CAAC,CAAC,CAAC;QAC7E,MAAM,2BAA2B,GAAG,mBAAmB,GAAG,kBAAkB,CAAC;QAE7E,IAAI,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,uBAAuB,CAAC,CAAC;QACjF,IAAI,oBAAoB,GAAG,CAAC,CAAC;QAC7B,IAAI,kBAAkB,GAAG,CAAC,EAAE,CAAC;YAC3B,oBAAoB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAC7D,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,CAAC,CAAC;QACjB,CAAC;QAED,IAAI,mBAAmB,GAAG,CAAC,CAAC;QAC5B,IAAI,cAAc,GAAG,eAAe,GAAG,oBAAoB,CAAC;QAC5D,OAAO,cAAc,GAAG,CAAC,IAAI,mBAAmB,IAAI,2BAA2B,EAAE,CAAC;YAChF,UAAU,EAAE,CAAC;YACb,mBAAmB,IAAI,aAAa,CAAC;YACrC,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,gBAAgB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAExF,MAAM,uBAAuB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;YACpE,oBAAoB,IAAI,uBAAuB,CAAC;YAChD,cAAc,IAAI,uBAAuB,CAAC;QAC5C,CAAC;QAED,MAAM,WAAW,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;QAC7D,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,GAAG,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChG,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;QAErF,IAAI,gBAAkC,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,gBAAgB,GAAG;gBACjB,iBAAiB;gBACjB,cAAc,EAAE,mBAAmB,GAAG,iBAAiB;gBACvD,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;gBAC9C,eAAe;aAChB,CAAC;QACJ,CAAC;aAAM,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACpB,iFAAiF;YACjF,gBAAgB,GAAG;gBACjB,eAAe;aAChB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,gBAAgB,GAAG;gBACjB,cAAc,EAAE,mBAAmB;gBACnC,eAAe;aAChB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,UAAU;YACV,WAAW;YACX,eAAe;YACf,oBAAoB;YACpB,gBAAgB;YAChB,gBAAgB;SACjB,CAAC;IACJ,CAAC;CACF;AAED,OAAO,EAAC,aAAa,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 ConnectionTiming} from './SimulationTimingMap.js';\n\ninterface DownloadOptions {\n  dnsResolutionTime?: number;\n  timeAlreadyElapsed?: number;\n  maximumTimeToElapse?: number;\n}\n\ninterface DownloadResults {\n  roundTrips: number;\n  timeElapsed: number;\n  bytesDownloaded: number;\n  extraBytesDownloaded: number;\n  congestionWindow: number;\n  connectionTiming: ConnectionTiming;\n}\n\nconst INITIAL_CONGESTION_WINDOW = 10;\nconst TCP_SEGMENT_SIZE = 1460;\n\nclass TCPConnection {\n  _warmed: boolean;\n  _ssl: boolean;\n  _h2: boolean;\n  _rtt: number;\n  _throughput: number;\n  _serverLatency: number;\n  _congestionWindow: number;\n  _h2OverflowBytesDownloaded: number;\n\n  constructor(rtt: number, throughput: number, serverLatency = 0, ssl = true, h2 = false) {\n    this._warmed = false;\n    this._ssl = ssl;\n    this._h2 = h2;\n    this._rtt = rtt;\n    this._throughput = throughput;\n    this._serverLatency = serverLatency;\n    this._congestionWindow = INITIAL_CONGESTION_WINDOW;\n    this._h2OverflowBytesDownloaded = 0;\n  }\n\n  static maximumSaturatedConnections(rtt: number, availableThroughput: number): number {\n    const roundTripsPerSecond = 1000 / rtt;\n    const bytesPerRoundTrip = TCP_SEGMENT_SIZE;\n    const bytesPerSecond = roundTripsPerSecond * bytesPerRoundTrip;\n    const minimumThroughputRequiredPerRequest = bytesPerSecond * 8;\n    return Math.floor(availableThroughput / minimumThroughputRequiredPerRequest);\n  }\n\n  _computeMaximumCongestionWindowInSegments(): number {\n    const bytesPerSecond = this._throughput / 8;\n    const secondsPerRoundTrip = this._rtt / 1000;\n    const bytesPerRoundTrip = bytesPerSecond * secondsPerRoundTrip;\n    return Math.floor(bytesPerRoundTrip / TCP_SEGMENT_SIZE);\n  }\n\n  setThroughput(throughput: number): void {\n    this._throughput = throughput;\n  }\n\n  setCongestionWindow(congestion: number): void {\n    this._congestionWindow = congestion;\n  }\n\n  setWarmed(warmed: boolean): void {\n    this._warmed = warmed;\n  }\n\n  isWarm(): boolean {\n    return this._warmed;\n  }\n\n  isH2(): boolean {\n    return this._h2;\n  }\n\n  get congestionWindow(): number {\n    return this._congestionWindow;\n  }\n\n  /**\n   * Sets the number of excess bytes that are available to this connection on future downloads, only\n   * applies to H2 connections.\n   */\n  setH2OverflowBytesDownloaded(bytes: number): void {\n    if (!this._h2) {\n      return;\n    }\n    this._h2OverflowBytesDownloaded = bytes;\n  }\n\n  clone(): TCPConnection {\n    return Object.assign(new TCPConnection(this._rtt, this._throughput), this);\n  }\n\n  /**\n   * Simulates a network download of a particular number of bytes over an optional maximum amount of time\n   * and returns information about the ending state.\n   *\n   * See https://hpbn.co/building-blocks-of-tcp/#three-way-handshake and\n   *  https://hpbn.co/transport-layer-security-tls/#tls-handshake for details.\n   */\n  simulateDownloadUntil(bytesToDownload: number, options?: DownloadOptions): DownloadResults {\n    const {timeAlreadyElapsed = 0, maximumTimeToElapse = Infinity, dnsResolutionTime = 0} = options || {};\n\n    if (this._warmed && this._h2) {\n      bytesToDownload -= this._h2OverflowBytesDownloaded;\n    }\n    const twoWayLatency = this._rtt;\n    const oneWayLatency = twoWayLatency / 2;\n    const maximumCongestionWindow = this._computeMaximumCongestionWindowInSegments();\n\n    let handshakeAndRequest = oneWayLatency;\n    if (!this._warmed) {\n      handshakeAndRequest =\n          // DNS lookup\n          dnsResolutionTime +\n          // SYN\n          oneWayLatency +\n          // SYN ACK\n          oneWayLatency +\n          // ACK + initial request\n          oneWayLatency +\n          // ClientHello/ServerHello assuming TLS False Start is enabled (https://istlsfastyet.com/#server-performance).\n          (this._ssl ? twoWayLatency : 0);\n    }\n\n    let roundTrips = Math.ceil(handshakeAndRequest / twoWayLatency);\n    let timeToFirstByte = handshakeAndRequest + this._serverLatency + oneWayLatency;\n    if (this._warmed && this._h2) {\n      timeToFirstByte = 0;\n    }\n\n    const timeElapsedForTTFB = Math.max(timeToFirstByte - timeAlreadyElapsed, 0);\n    const maximumDownloadTimeToElapse = maximumTimeToElapse - timeElapsedForTTFB;\n\n    let congestionWindow = Math.min(this._congestionWindow, maximumCongestionWindow);\n    let totalBytesDownloaded = 0;\n    if (timeElapsedForTTFB > 0) {\n      totalBytesDownloaded = congestionWindow * TCP_SEGMENT_SIZE;\n    } else {\n      roundTrips = 0;\n    }\n\n    let downloadTimeElapsed = 0;\n    let bytesRemaining = bytesToDownload - totalBytesDownloaded;\n    while (bytesRemaining > 0 && downloadTimeElapsed <= maximumDownloadTimeToElapse) {\n      roundTrips++;\n      downloadTimeElapsed += twoWayLatency;\n      congestionWindow = Math.max(Math.min(maximumCongestionWindow, congestionWindow * 2), 1);\n\n      const bytesDownloadedInWindow = congestionWindow * TCP_SEGMENT_SIZE;\n      totalBytesDownloaded += bytesDownloadedInWindow;\n      bytesRemaining -= bytesDownloadedInWindow;\n    }\n\n    const timeElapsed = timeElapsedForTTFB + downloadTimeElapsed;\n    const extraBytesDownloaded = this._h2 ? Math.max(totalBytesDownloaded - bytesToDownload, 0) : 0;\n    const bytesDownloaded = Math.max(Math.min(totalBytesDownloaded, bytesToDownload), 0);\n\n    let connectionTiming: ConnectionTiming;\n    if (!this._warmed) {\n      connectionTiming = {\n        dnsResolutionTime,\n        connectionTime: handshakeAndRequest - dnsResolutionTime,\n        sslTime: this._ssl ? twoWayLatency : undefined,\n        timeToFirstByte,\n      };\n    } else if (this._h2) {\n      // TODO: timing information currently difficult to model for warm h2 connections.\n      connectionTiming = {\n        timeToFirstByte,\n      };\n    } else {\n      connectionTiming = {\n        connectionTime: handshakeAndRequest,\n        timeToFirstByte,\n      };\n    }\n\n    return {\n      roundTrips,\n      timeElapsed,\n      bytesDownloaded,\n      extraBytesDownloaded,\n      congestionWindow,\n      connectionTiming,\n    };\n  }\n}\n\nexport {TCPConnection};\n"]}

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

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { type AnyNetworkObject, type Simulation } from '../types/lantern.js';
+export { ConnectionPool } from './ConnectionPool.js';
+export { Constants } from './Constants.js';
+export { DNSCache } from './DNSCache.js';
+export { NetworkAnalyzer } from './NetworkAnalyzer.js';
+export { SimulatorTimingMap, type CompleteNodeTiming } from './SimulationTimingMap.js';
+export { Simulator } from './Simulator.js';
+export { TCPConnection } from './TCPConnection.js';
+export type MetricCoefficients = Simulation.MetricCoefficients;
+export type MetricComputationDataInput = Simulation.MetricComputationDataInput;
+export type NodeTiming = Simulation.NodeTiming;
+export type Options = Simulation.Options;
+export type ProcessedNavigation = Simulation.ProcessedNavigation;
+export type Result<T = AnyNetworkObject> = Simulation.Result<T>;
+export type Settings = Simulation.Settings;
+export type URL = Simulation.URL;

package/models/trace/lantern/simulation/simulation.js

@@ -0,0 +1,11 @@
+// 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.
+export { ConnectionPool } from './ConnectionPool.js';
+export { Constants } from './Constants.js';
+export { DNSCache } from './DNSCache.js';
+export { NetworkAnalyzer } from './NetworkAnalyzer.js';
+export { SimulatorTimingMap } from './SimulationTimingMap.js';
+export { Simulator } from './Simulator.js';
+export { TCPConnection } from './TCPConnection.js';
+//# sourceMappingURL=simulation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"simulation.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/simulation/simulation.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAU7B,OAAO,EAAC,cAAc,EAAC,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AACvC,OAAO,EAAC,eAAe,EAAC,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAC,kBAAkB,EAA0B,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAC,aAAa,EAAC,MAAM,oBAAoB,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/**\n * @license\n * Copyright 2024 Google LLC\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport {type AnyNetworkObject, type Simulation} from '../types/lantern.js';\n\nexport {ConnectionPool} from './ConnectionPool.js';\nexport {Constants} from './Constants.js';\nexport {DNSCache} from './DNSCache.js';\nexport {NetworkAnalyzer} from './NetworkAnalyzer.js';\nexport {SimulatorTimingMap, type CompleteNodeTiming} from './SimulationTimingMap.js';\nexport {Simulator} from './Simulator.js';\nexport {TCPConnection} from './TCPConnection.js';\n\nexport type MetricCoefficients = Simulation.MetricCoefficients;\nexport type MetricComputationDataInput = Simulation.MetricComputationDataInput;\nexport type NodeTiming = Simulation.NodeTiming;\nexport type Options = Simulation.Options;\nexport type ProcessedNavigation = Simulation.ProcessedNavigation;\nexport type Result<T = AnyNetworkObject> = Simulation.Result<T>;\nexport type Settings = Simulation.Settings;\nexport type URL = Simulation.URL;\n"]}

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

@@ -0,0 +1,205 @@
+import type * as Protocol from '../../../../generated/protocol.js';
+import { type Node } from '../BaseNode.js';
+import { type Simulator } from '../simulation/Simulator.js';
+export type TraceEvent = {
+    name: string;
+    args: {
+        name?: string;
+        data?: {
+            frame?: string;
+            readyState?: number;
+            stackTrace?: {
+                url: string;
+            }[];
+            url?: string;
+        };
+    };
+    pid: number;
+    tid: number;
+    /** Timestamp of the event in microseconds. */
+    ts: number;
+    dur: number;
+};
+export type Trace = {
+    traceEvents: TraceEvent[];
+};
+export type ResourcePriority = ('VeryLow' | 'Low' | 'Medium' | 'High' | 'VeryHigh');
+export type ResourceType = ('Document' | 'Stylesheet' | 'Image' | 'Media' | 'Font' | 'Script' | 'TextTrack' | 'XHR' | 'Fetch' | 'Prefetch' | 'EventSource' | 'WebSocket' | 'Manifest' | 'SignedExchange' | 'Ping' | 'CSPViolationReport' | 'Preflight' | 'Other');
+type InitiatorType = ('parser' | 'script' | 'preload' | 'SignedExchange' | 'preflight' | 'other');
+export type ResourceTiming = Protocol.Network.ResourceTiming;
+type CallStack = {
+    callFrames: Array<{
+        scriptId: string;
+        url: string;
+        lineNumber: number;
+        columnNumber: number;
+        functionName: string;
+    }>;
+    parent?: CallStack;
+};
+export type ParsedURL = {
+    /**
+     * Equivalent to a `new URL(url).protocol` BUT w/o the trailing colon (:)
+     */
+    scheme: string;
+    /**
+     * Equivalent to a `new URL(url).hostname`
+     */
+    host: string;
+    securityOrigin: string;
+};
+export type AnyNetworkObject = any;
+export type NetworkRequest<T = AnyNetworkObject> = {
+    requestId: string;
+    connectionId: number;
+    connectionReused: boolean;
+    url: string;
+    protocol: string;
+    parsedURL: ParsedURL;
+    documentURL: string;
+    /** When the renderer process initially discovers a network request, in milliseconds. */
+    rendererStartTime: number;
+    /**
+     * When the network service is about to handle a request, ie. just before going to the
+     * HTTP cache or going to the network for DNS/connection setup, in milliseconds.
+     */
+    networkRequestTime: number;
+    /**
+     * When the last byte of the response headers is received, in milliseconds.
+     * Equal to networkRequestTime if no data is recieved over the
+     * network (ex: cached requests or data urls).
+     */
+    responseHeadersEndTime: number;
+    /** When the last byte of the response body is received, in milliseconds. */
+    networkEndTime: number;
+    transferSize: number;
+    resourceSize: number;
+    fromDiskCache: boolean;
+    fromMemoryCache: boolean;
+    isLinkPreload: boolean;
+    finished: boolean;
+    failed: boolean;
+    statusCode: number;
+    /** The network request that redirected to this one */
+    redirectSource: NetworkRequest<T> | undefined;
+    /** The network request that this one redirected to */
+    redirectDestination: NetworkRequest<T> | undefined;
+    initiator: {
+        type: InitiatorType;
+        url?: string;
+        stack?: CallStack;
+    };
+    initiatorRequest: NetworkRequest<T> | undefined;
+    /** The chain of network requests that redirected to this one */
+    redirects: NetworkRequest[] | undefined;
+    timing: Protocol.Network.ResourceTiming | undefined;
+    resourceType: ResourceType | undefined;
+    mimeType: string;
+    priority: ResourcePriority;
+    frameId: string | undefined;
+    fromWorker: boolean;
+    /**
+     * Optional value for how long the server took to respond to this request.
+     * When not provided, the server response time is derived from the timing object.
+     */
+    serverResponseTime?: number;
+    /**
+     * Implementation-specific canoncial data structure that this Lantern NetworkRequest
+     * was derived from.
+     * Users of Lantern create a NetworkRequest matching this interface,
+     * but can store the source-of-truth for their network model in this property.
+     * This is then accessible as a read-only property on NetworkNode.
+     */
+    rawRequest?: T;
+};
+export declare namespace Simulation {
+    interface URL {
+        /** URL of the initially requested URL */
+        requestedUrl?: string;
+        /** URL of the last document request */
+        mainDocumentUrl?: string;
+    }
+    /** Simulation settings that control the amount of network & cpu throttling in the run. */
+    interface ThrottlingSettings {
+        /** The round trip time in milliseconds. */
+        rttMs?: number;
+        /** The network throughput in kilobits per second. */
+        throughputKbps?: number;
+        /** The network request latency in milliseconds. */
+        requestLatencyMs?: number;
+        /** The network download throughput in kilobits per second. */
+        downloadThroughputKbps?: number;
+        /** The network upload throughput in kilobits per second. */
+        uploadThroughputKbps?: number;
+        /** The amount of slowdown applied to the cpu (1/<cpuSlowdownMultiplier>). */
+        cpuSlowdownMultiplier?: number;
+    }
+    interface PrecomputedLanternData {
+        additionalRttByOrigin: {
+            [origin: string]: number;
+        };
+        serverResponseTimeByOrigin: {
+            [origin: string]: number;
+        };
+    }
+    interface Settings {
+        networkAnalysis: {
+            rtt: number;
+            additionalRttByOrigin: Map<string, number>;
+            serverResponseTimeByOrigin: Map<string, number>;
+            throughput: number;
+        };
+        /** The method used to throttle the network. */
+        throttlingMethod: 'devtools' | 'simulate' | 'provided';
+        /** The throttling config settings. */
+        throttling: Required<ThrottlingSettings>;
+        /** Precomputed lantern estimates to use instead of observed analysis. */
+        precomputedLanternData?: PrecomputedLanternData | null;
+    }
+    interface Options {
+        rtt?: number;
+        throughput?: number;
+        observedThroughput: number;
+        maximumConcurrentRequests?: number;
+        cpuSlowdownMultiplier?: number;
+        layoutTaskMultiplier?: number;
+        additionalRttByOrigin?: Map<string, number>;
+        serverResponseTimeByOrigin?: Map<string, number>;
+    }
+    interface ProcessedNavigation {
+        timestamps: {
+            firstContentfulPaint: number;
+            largestContentfulPaint?: number;
+        };
+    }
+    interface MetricComputationDataInput {
+        simulator: Simulator;
+        graph: Node<unknown>;
+        processedNavigation: ProcessedNavigation;
+    }
+    interface MetricCoefficients {
+        intercept: number;
+        optimistic: number;
+        pessimistic: number;
+    }
+    interface NodeTiming {
+        startTime: number;
+        endTime: number;
+        duration: number;
+    }
+    interface Result<T = AnyNetworkObject> {
+        timeInMs: number;
+        nodeTimings: Map<Node<T>, NodeTiming>;
+    }
+}
+export declare namespace Metrics {
+    interface Result<T = AnyNetworkObject> {
+        timing: number;
+        timestamp?: never;
+        optimisticEstimate: Simulation.Result<T>;
+        pessimisticEstimate: Simulation.Result<T>;
+        optimisticGraph: Node<T>;
+        pessimisticGraph: Node<T>;
+    }
+}
+export {};

package/models/trace/lantern/types/lantern.js

@@ -0,0 +1,5 @@
+// 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.
+export {};
+//# sourceMappingURL=lantern.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lantern.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/types/lantern.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B","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 * as Protocol from '../../../../generated/protocol.js';\nimport {type Node} from '../BaseNode.js';\nimport {type Simulator} from '../simulation/Simulator.js';\n\nexport type TraceEvent = {\n  name: string,\n  args: {\n    name?: string,\n    data?: {\n      frame?: string,\n      readyState?: number,\n      stackTrace?: {\n        url: string,\n      }[],\n      url?: string,\n    },\n  },\n  pid: number,\n  tid: number,\n  /** Timestamp of the event in microseconds. */\n  ts: number,\n  dur: number,\n};\nexport type Trace = {\n  traceEvents: TraceEvent[],\n};\nexport type ResourcePriority = ('VeryLow'|'Low'|'Medium'|'High'|'VeryHigh');\nexport type ResourceType =\n    ('Document'|'Stylesheet'|'Image'|'Media'|'Font'|'Script'|'TextTrack'|'XHR'|'Fetch'|'Prefetch'|'EventSource'|\n     'WebSocket'|'Manifest'|'SignedExchange'|'Ping'|'CSPViolationReport'|'Preflight'|'Other');\ntype InitiatorType = ('parser'|'script'|'preload'|'SignedExchange'|'preflight'|'other');\nexport type ResourceTiming = Protocol.Network.ResourceTiming;\ntype CallStack = {\n  callFrames: Array<{\n    scriptId: string,\n    url: string,\n    lineNumber: number,\n    columnNumber: number,\n    functionName: string,\n  }>,\n  parent?: CallStack,\n};\n\nexport type ParsedURL = {\n  /**\n   * Equivalent to a `new URL(url).protocol` BUT w/o the trailing colon (:)\n   */\n  scheme: string,\n  /**\n   * Equivalent to a `new URL(url).hostname`\n   */\n  host: string,\n  securityOrigin: string,\n};\n\n// When Lantern NetworkRequests are constructed, the source-of-truth of the network record is given as `rawRequest`.\n// Internally Lantern doesn't care about the type of this field, so a default type is given to simplify internal code\n// by avoiding unnecessary typescript overhead.\n// If callers want to access the underlying network record, they are expected to make use of this generic on top-level\n// interfaces like Simulator.\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type AnyNetworkObject = any;\n\nexport type NetworkRequest<T = AnyNetworkObject> = {\n  requestId: string,\n  connectionId: number,\n  connectionReused: boolean,\n  url: string,\n  protocol: string,\n  parsedURL: ParsedURL,\n  documentURL: string,\n  /** When the renderer process initially discovers a network request, in milliseconds. */\n  rendererStartTime: number,\n  /**\n   * When the network service is about to handle a request, ie. just before going to the\n   * HTTP cache or going to the network for DNS/connection setup, in milliseconds.\n   */\n  networkRequestTime: number,\n  /**\n   * When the last byte of the response headers is received, in milliseconds.\n   * Equal to networkRequestTime if no data is recieved over the\n   * network (ex: cached requests or data urls).\n   */\n  responseHeadersEndTime: number,\n  /** When the last byte of the response body is received, in milliseconds. */\n  networkEndTime: number,\n  transferSize: number,\n  resourceSize: number,\n  fromDiskCache: boolean,\n  fromMemoryCache: boolean,\n  isLinkPreload: boolean,\n  finished: boolean,\n  failed: boolean,\n  statusCode: number,\n  /** The network request that redirected to this one */\n  redirectSource: NetworkRequest<T>|undefined,\n  /** The network request that this one redirected to */\n  redirectDestination: NetworkRequest<T>|undefined,\n  // TODO: can't use Protocol.Network.Initiator because of type mismatch in Lighthouse initiator.\n  initiator: {\n    type: InitiatorType,\n    url?: string,\n    stack?: CallStack,\n  },\n  initiatorRequest: NetworkRequest<T>|undefined,\n  /** The chain of network requests that redirected to this one */\n  redirects: NetworkRequest[]|undefined,\n  timing: Protocol.Network.ResourceTiming|undefined,\n  resourceType: ResourceType|undefined,\n  mimeType: string,\n  priority: ResourcePriority,\n  frameId: string|undefined,\n  fromWorker: boolean,\n  /**\n   * Optional value for how long the server took to respond to this request.\n   * When not provided, the server response time is derived from the timing object.\n   */\n  serverResponseTime?: number,\n  /**\n   * Implementation-specific canoncial data structure that this Lantern NetworkRequest\n   * was derived from.\n   * Users of Lantern create a NetworkRequest matching this interface,\n   * but can store the source-of-truth for their network model in this property.\n   * This is then accessible as a read-only property on NetworkNode.\n   */\n  rawRequest?: T,\n};\n\nexport namespace Simulation {\n  export interface URL {\n    /** URL of the initially requested URL */\n    requestedUrl?: string;\n    /** URL of the last document request */\n    mainDocumentUrl?: string;\n  }\n\n  /** Simulation settings that control the amount of network & cpu throttling in the run. */\n  export interface ThrottlingSettings {\n    /** The round trip time in milliseconds. */\n    rttMs?: number;\n    /** The network throughput in kilobits per second. */\n    throughputKbps?: number;\n    // devtools settings\n    /** The network request latency in milliseconds. */\n    requestLatencyMs?: number;\n    /** The network download throughput in kilobits per second. */\n    downloadThroughputKbps?: number;\n    /** The network upload throughput in kilobits per second. */\n    uploadThroughputKbps?: number;\n    // used by both\n    /** The amount of slowdown applied to the cpu (1/<cpuSlowdownMultiplier>). */\n    cpuSlowdownMultiplier?: number;\n  }\n\n  export interface PrecomputedLanternData {\n    additionalRttByOrigin: {[origin: string]: number};\n    serverResponseTimeByOrigin: {[origin: string]: number};\n  }\n\n  export interface Settings {\n    networkAnalysis: {\n      rtt: number,\n      additionalRttByOrigin: Map<string, number>,\n      serverResponseTimeByOrigin: Map<string, number>,\n      throughput: number,\n    };\n    /** The method used to throttle the network. */\n    throttlingMethod: 'devtools'|'simulate'|'provided';\n    /** The throttling config settings. */\n    throttling: Required<ThrottlingSettings>;\n    /** Precomputed lantern estimates to use instead of observed analysis. */\n    precomputedLanternData?: PrecomputedLanternData|null;\n  }\n\n  export interface Options {\n    rtt?: number;\n    throughput?: number;\n    observedThroughput: number;\n    maximumConcurrentRequests?: number;\n    cpuSlowdownMultiplier?: number;\n    layoutTaskMultiplier?: number;\n    additionalRttByOrigin?: Map<string, number>;\n    serverResponseTimeByOrigin?: Map<string, number>;\n  }\n\n  export interface ProcessedNavigation {\n    timestamps: {\n      firstContentfulPaint: number,\n      largestContentfulPaint?: number,\n    };\n  }\n\n  export interface MetricComputationDataInput {\n    simulator: Simulator;\n    graph: Node<unknown>;\n    processedNavigation: ProcessedNavigation;\n  }\n\n  export interface MetricCoefficients {\n    intercept: number;\n    optimistic: number;\n    pessimistic: number;\n  }\n\n  export interface NodeTiming {\n    startTime: number;\n    endTime: number;\n    duration: number;\n  }\n\n  export interface Result<T = AnyNetworkObject> {\n    timeInMs: number;\n    nodeTimings: Map<Node<T>, NodeTiming>;\n  }\n}\n\nexport namespace Metrics {\n  export interface Result<T = AnyNetworkObject> {\n    timing: number;\n    timestamp?: never;\n    optimisticEstimate: Simulation.Result<T>;\n    pessimisticEstimate: Simulation.Result<T>;\n    optimisticGraph: Node<T>;\n    pessimisticGraph: Node<T>;\n  }\n}\n"]}

package/models/trace/root-causes/devtools_entrypoint-bundle-typescript-tsconfig.json

@@ -32,7 +32,6 @@
     "../../../../../../../front_end/models/trace/root-causes/root-causes.ts",
     "../../../../../../../front_end/legacy/legacy-defs.d.ts",
     "../../../../../../../front_end/global_typings/global_defs.d.ts",
-    "../../../../../../../front_end/global_typings/request_idle_callback.d.ts",
     "../../../../../../../node_modules/@types/filesystem/index.d.ts"
   ],
   "references": [

package/models/trace/root-causes/root-causes-tsconfig.json

@@ -33,7 +33,6 @@
     "../../../../../../../front_end/models/trace/root-causes/RootCauses.ts",
     "../../../../../../../front_end/legacy/legacy-defs.d.ts",
     "../../../../../../../front_end/global_typings/global_defs.d.ts",
-    "../../../../../../../front_end/global_typings/request_idle_callback.d.ts",
     "../../../../../../../node_modules/@types/filesystem/index.d.ts"
   ],
   "references": [

package/models/trace/trace-tsconfig.json

@@ -30,12 +30,12 @@
   },
   "files": [
     "../../../../../../front_end/models/trace/EntriesFilter.ts",
+    "../../../../../../front_end/models/trace/LanternComputationData.ts",
     "../../../../../../front_end/models/trace/ModelImpl.ts",
     "../../../../../../front_end/models/trace/Processor.ts",
     "../../../../../../front_end/models/trace/TracingManager.ts",
     "../../../../../../front_end/legacy/legacy-defs.d.ts",
     "../../../../../../front_end/global_typings/global_defs.d.ts",
-    "../../../../../../front_end/global_typings/request_idle_callback.d.ts",
     "../../../../../../node_modules/@types/filesystem/index.d.ts"
   ],
   "references": [
@@ -60,6 +60,9 @@
     {
       "path": "insights/bundle-tsconfig.json"
     },
+    {
+      "path": "lantern/bundle-tsconfig.json"
+    },
     {
       "path": "root-causes/bundle-tsconfig.json"
     },

package/models/trace/trace.d.ts

@@ -3,9 +3,11 @@ import * as Extras from './extras/extras.js';
 import * as Handlers from './handlers/handlers.js';
 import * as Helpers from './helpers/helpers.js';
 import * as Insights from './insights/insights.js';
+import * as Lantern from './lantern/lantern.js';
+import * as LanternComputationData from './LanternComputationData.js';
 import * as TraceModel from './ModelImpl.js';
 import * as Processor from './Processor.js';
 import * as RootCauses from './root-causes/root-causes.js';
 import * as TracingManager from './TracingManager.js';
 import * as Types from './types/types.js';
-export { EntriesFilter, Extras, Handlers, Helpers, Insights, Processor, RootCauses, TraceModel, TracingManager, Types, };
+export { EntriesFilter, Extras, Handlers, Helpers, Insights, Lantern, LanternComputationData, Processor, RootCauses, TraceModel, TracingManager, Types, };

package/models/trace/trace.js

@@ -6,10 +6,12 @@ import * as Extras from './extras/extras.js';
 import * as Handlers from './handlers/handlers.js';
 import * as Helpers from './helpers/helpers.js';
 import * as Insights from './insights/insights.js';
+import * as Lantern from './lantern/lantern.js';
+import * as LanternComputationData from './LanternComputationData.js';
 import * as TraceModel from './ModelImpl.js';
 import * as Processor from './Processor.js';
 import * as RootCauses from './root-causes/root-causes.js';
 import * as TracingManager from './TracingManager.js';
 import * as Types from './types/types.js';
-export { EntriesFilter, Extras, Handlers, Helpers, Insights, Processor, RootCauses, TraceModel, TracingManager, Types, };
+export { EntriesFilter, Extras, Handlers, Helpers, Insights, Lantern, LanternComputationData, Processor, RootCauses, TraceModel, TracingManager, Types, };
 //# sourceMappingURL=trace.js.map

package/models/trace/trace.js.map

@@ -1 +1 @@
-{"version":3,"file":"trace.js","sourceRoot":"","sources":["../../../../../../front_end/models/trace/trace.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,UAAU,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EACL,aAAa,EACb,MAAM,EACN,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,SAAS,EACT,UAAU,EACV,UAAU,EACV,cAAc,EACd,KAAK,GACN,CAAC","sourcesContent":["// Copyright 2022 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 EntriesFilter from './EntriesFilter.js';\nimport * as Extras from './extras/extras.js';\nimport * as Handlers from './handlers/handlers.js';\nimport * as Helpers from './helpers/helpers.js';\nimport * as Insights from './insights/insights.js';\nimport * as TraceModel from './ModelImpl.js';\nimport * as Processor from './Processor.js';\nimport * as RootCauses from './root-causes/root-causes.js';\nimport * as TracingManager from './TracingManager.js';\nimport * as Types from './types/types.js';\n\nexport {\n  EntriesFilter,\n  Extras,\n  Handlers,\n  Helpers,\n  Insights,\n  Processor,\n  RootCauses,\n  TraceModel,\n  TracingManager,\n  Types,\n};\n"]}
+{"version":3,"file":"trace.js","sourceRoot":"","sources":["../../../../../../front_end/models/trace/trace.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAC;AAChD,OAAO,KAAK,sBAAsB,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,UAAU,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EACL,aAAa,EACb,MAAM,EACN,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,OAAO,EACP,sBAAsB,EACtB,SAAS,EACT,UAAU,EACV,UAAU,EACV,cAAc,EACd,KAAK,GACN,CAAC","sourcesContent":["// Copyright 2022 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 EntriesFilter from './EntriesFilter.js';\nimport * as Extras from './extras/extras.js';\nimport * as Handlers from './handlers/handlers.js';\nimport * as Helpers from './helpers/helpers.js';\nimport * as Insights from './insights/insights.js';\nimport * as Lantern from './lantern/lantern.js';\nimport * as LanternComputationData from './LanternComputationData.js';\nimport * as TraceModel from './ModelImpl.js';\nimport * as Processor from './Processor.js';\nimport * as RootCauses from './root-causes/root-causes.js';\nimport * as TracingManager from './TracingManager.js';\nimport * as Types from './types/types.js';\n\nexport {\n  EntriesFilter,\n  Extras,\n  Handlers,\n  Helpers,\n  Insights,\n  Lantern,\n  LanternComputationData,\n  Processor,\n  RootCauses,\n  TraceModel,\n  TracingManager,\n  Types,\n};\n"]}

package/models/trace/types/Extensions.d.ts

@@ -16,7 +16,7 @@ export interface ExtensionFlameChartEntryPayload extends ExtensionDataPayload {
     metadata: ExtensionDataPayload['metadata'] & {
         dataType: ExtensionEntryType.TRACK_ENTRY;
     };
-    color: ExtensionColorFromPalette;
+    color?: ExtensionColorFromPalette;
     track: string;
     detailsPairs?: [string, string][];
     hintText?: string;
@@ -25,7 +25,7 @@ export interface ExtensionMarkerPayload extends ExtensionDataPayload {
     metadata: ExtensionDataPayload['metadata'] & {
         dataType: ExtensionEntryType.MARKER;
     };
-    color: ExtensionColorFromPalette;
+    color?: ExtensionColorFromPalette;
     detailsPairs?: [string, string][];
     hintText?: string;
 }
@@ -36,7 +36,6 @@ export interface SyntheticExtensionMarker extends SyntheticTraceEntry {
     args: TraceEventArgs & ExtensionMarkerPayload;
 }
 export type SyntheticExtensionEntry = SyntheticExtensionFlameChartEntry | SyntheticExtensionMarker;
-export declare function validateColorInPayload(payload: ExtensionDataPayload): boolean;
 export declare function isExtensionPayloadMarker(payload: ExtensionDataPayload): payload is ExtensionMarkerPayload;
 export declare function isExtensionPayloadFlameChartEntry(payload: ExtensionDataPayload): payload is ExtensionFlameChartEntryPayload;
 export declare function isSyntheticExtensionEntry(entry: TraceEventData): entry is SyntheticExtensionEntry;

package/models/trace/types/Extensions.js

@@ -16,21 +16,12 @@ const extensionPalette = [
 export function colorIsValid(color) {
     return extensionPalette.includes(color);
 }
-export function validateColorInPayload(payload) {
-    if (!('color' in payload) || !payload.color) {
-        return false;
-    }
-    const color = payload['color'];
-    return colorIsValid(color);
-}
 export function isExtensionPayloadMarker(payload) {
-    const colorIsValid = validateColorInPayload(payload);
-    return payload.metadata.dataType === "marker" /* ExtensionEntryType.MARKER */ && colorIsValid;
+    return payload.metadata.dataType === "marker" /* ExtensionEntryType.MARKER */;
 }
 export function isExtensionPayloadFlameChartEntry(payload) {
-    const colorIsValid = validateColorInPayload(payload);
     const hasTrack = 'track' in payload && Boolean(payload.track);
-    return payload.metadata.dataType === "track-entry" /* ExtensionEntryType.TRACK_ENTRY */ && hasTrack && colorIsValid;
+    return payload.metadata.dataType === "track-entry" /* ExtensionEntryType.TRACK_ENTRY */ && hasTrack;
 }
 export function isSyntheticExtensionEntry(entry) {
     return entry.cat === 'devtools.extension';

package/models/trace/types/Extensions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/Extensions.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAa7B,MAAM,gBAAgB,GAAG;IACvB,SAAS;IACT,eAAe;IACf,cAAc;IACd,WAAW;IACX,iBAAiB;IACjB,gBAAgB;IAChB,UAAU;IACV,gBAAgB;IAChB,eAAe;IACf,OAAO;CACC,CAAC;AAIX,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAQ,gBAAsC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AA8BD,MAAM,UAAU,sBAAsB,CAAC,OAA6B;IAClE,IAAI,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAA8B,CAAC;IAC5D,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,OAA6B;IACpE,MAAM,YAAY,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACrD,OAAO,OAAO,CAAC,QAAQ,CAAC,QAAQ,6CAA8B,IAAI,YAAY,CAAC;AACjF,CAAC;AAED,MAAM,UAAU,iCAAiC,CAAC,OAA6B;IAE7E,MAAM,YAAY,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,QAAQ,GAAG,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9D,OAAO,OAAO,CAAC,QAAQ,CAAC,QAAQ,uDAAmC,IAAI,QAAQ,IAAI,YAAY,CAAC;AAClG,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAqB;IAC7D,OAAO,KAAK,CAAC,GAAG,KAAK,oBAAoB,CAAC;AAC5C,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 {\n  type SyntheticTraceEntry,\n  type TraceEventArgs,\n  type TraceEventData,\n} from './TraceEvents.js';\n\nexport const enum ExtensionEntryType {\n  TRACK_ENTRY = 'track-entry',\n  MARKER = 'marker',\n}\n\nconst extensionPalette = [\n  'primary',\n  'primary-light',\n  'primary-dark',\n  'secondary',\n  'secondary-light',\n  'secondary-dark',\n  'tertiary',\n  'tertiary-light',\n  'tertiary-dark',\n  'error',\n] as const;\n\nexport type ExtensionColorFromPalette = typeof extensionPalette[number];\n\nexport function colorIsValid(color: string): boolean {\n  return (extensionPalette as readonly string[]).includes(color);\n}\n\nexport interface ExtensionDataPayload {\n  metadata: {dataType: ExtensionEntryType, extensionName: string};\n}\nexport interface ExtensionFlameChartEntryPayload extends ExtensionDataPayload {\n  metadata: ExtensionDataPayload['metadata']&{dataType: ExtensionEntryType.TRACK_ENTRY};\n  color: ExtensionColorFromPalette;\n  track: string;\n  detailsPairs?: [string, string][];\n  hintText?: string;\n}\n\nexport interface ExtensionMarkerPayload extends ExtensionDataPayload {\n  metadata: ExtensionDataPayload['metadata']&{dataType: ExtensionEntryType.MARKER};\n  color: ExtensionColorFromPalette;\n  detailsPairs?: [string, string][];\n  hintText?: string;\n}\n\nexport interface SyntheticExtensionFlameChartEntry extends SyntheticTraceEntry {\n  args: TraceEventArgs&ExtensionFlameChartEntryPayload;\n}\n\nexport interface SyntheticExtensionMarker extends SyntheticTraceEntry {\n  args: TraceEventArgs&ExtensionMarkerPayload;\n}\n\nexport type SyntheticExtensionEntry = SyntheticExtensionFlameChartEntry|SyntheticExtensionMarker;\n\nexport function validateColorInPayload(payload: ExtensionDataPayload): boolean {\n  if (!('color' in payload) || !payload.color) {\n    return false;\n  }\n  const color = payload['color'] as ExtensionColorFromPalette;\n  return colorIsValid(color);\n}\n\nexport function isExtensionPayloadMarker(payload: ExtensionDataPayload): payload is ExtensionMarkerPayload {\n  const colorIsValid = validateColorInPayload(payload);\n  return payload.metadata.dataType === ExtensionEntryType.MARKER && colorIsValid;\n}\n\nexport function isExtensionPayloadFlameChartEntry(payload: ExtensionDataPayload):\n    payload is ExtensionFlameChartEntryPayload {\n  const colorIsValid = validateColorInPayload(payload);\n  const hasTrack = 'track' in payload && Boolean(payload.track);\n  return payload.metadata.dataType === ExtensionEntryType.TRACK_ENTRY && hasTrack && colorIsValid;\n}\n\nexport function isSyntheticExtensionEntry(entry: TraceEventData): entry is SyntheticExtensionEntry {\n  return entry.cat === 'devtools.extension';\n}\n\n/**\n * Synthetic events created for extension tracks.\n */\nexport interface SyntheticExtensionFlameChartEntry extends SyntheticTraceEntry {\n  args: TraceEventArgs&ExtensionFlameChartEntryPayload;\n  cat: 'devtools.extension';\n}\n\n/**\n * Synthetic events created for extension marks.\n */\nexport interface SyntheticExtensionMarker extends SyntheticTraceEntry {\n  args: TraceEventArgs&ExtensionMarkerPayload;\n  cat: 'devtools.extension';\n}\n\nexport interface ExtensionTrackData {\n  name: string;\n  extensionName: string;\n  flameChartEntries: SyntheticExtensionFlameChartEntry[];\n}\n"]}
+{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/Extensions.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAa7B,MAAM,gBAAgB,GAAG;IACvB,SAAS;IACT,eAAe;IACf,cAAc;IACd,WAAW;IACX,iBAAiB;IACjB,gBAAgB;IAChB,UAAU;IACV,gBAAgB;IAChB,eAAe;IACf,OAAO;CACC,CAAC;AAIX,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAQ,gBAAsC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AA8BD,MAAM,UAAU,wBAAwB,CAAC,OAA6B;IACpE,OAAO,OAAO,CAAC,QAAQ,CAAC,QAAQ,6CAA8B,CAAC;AACjE,CAAC;AAED,MAAM,UAAU,iCAAiC,CAAC,OAA6B;IAE7E,MAAM,QAAQ,GAAG,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9D,OAAO,OAAO,CAAC,QAAQ,CAAC,QAAQ,uDAAmC,IAAI,QAAQ,CAAC;AAClF,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAqB;IAC7D,OAAO,KAAK,CAAC,GAAG,KAAK,oBAAoB,CAAC;AAC5C,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 {\n  type SyntheticTraceEntry,\n  type TraceEventArgs,\n  type TraceEventData,\n} from './TraceEvents.js';\n\nexport const enum ExtensionEntryType {\n  TRACK_ENTRY = 'track-entry',\n  MARKER = 'marker',\n}\n\nconst extensionPalette = [\n  'primary',\n  'primary-light',\n  'primary-dark',\n  'secondary',\n  'secondary-light',\n  'secondary-dark',\n  'tertiary',\n  'tertiary-light',\n  'tertiary-dark',\n  'error',\n] as const;\n\nexport type ExtensionColorFromPalette = typeof extensionPalette[number];\n\nexport function colorIsValid(color: string): boolean {\n  return (extensionPalette as readonly string[]).includes(color);\n}\n\nexport interface ExtensionDataPayload {\n  metadata: {dataType: ExtensionEntryType, extensionName: string};\n}\nexport interface ExtensionFlameChartEntryPayload extends ExtensionDataPayload {\n  metadata: ExtensionDataPayload['metadata']&{dataType: ExtensionEntryType.TRACK_ENTRY};\n  color?: ExtensionColorFromPalette;\n  track: string;\n  detailsPairs?: [string, string][];\n  hintText?: string;\n}\n\nexport interface ExtensionMarkerPayload extends ExtensionDataPayload {\n  metadata: ExtensionDataPayload['metadata']&{dataType: ExtensionEntryType.MARKER};\n  color?: ExtensionColorFromPalette;\n  detailsPairs?: [string, string][];\n  hintText?: string;\n}\n\nexport interface SyntheticExtensionFlameChartEntry extends SyntheticTraceEntry {\n  args: TraceEventArgs&ExtensionFlameChartEntryPayload;\n}\n\nexport interface SyntheticExtensionMarker extends SyntheticTraceEntry {\n  args: TraceEventArgs&ExtensionMarkerPayload;\n}\n\nexport type SyntheticExtensionEntry = SyntheticExtensionFlameChartEntry|SyntheticExtensionMarker;\n\nexport function isExtensionPayloadMarker(payload: ExtensionDataPayload): payload is ExtensionMarkerPayload {\n  return payload.metadata.dataType === ExtensionEntryType.MARKER;\n}\n\nexport function isExtensionPayloadFlameChartEntry(payload: ExtensionDataPayload):\n    payload is ExtensionFlameChartEntryPayload {\n  const hasTrack = 'track' in payload && Boolean(payload.track);\n  return payload.metadata.dataType === ExtensionEntryType.TRACK_ENTRY && hasTrack;\n}\n\nexport function isSyntheticExtensionEntry(entry: TraceEventData): entry is SyntheticExtensionEntry {\n  return entry.cat === 'devtools.extension';\n}\n\n/**\n * Synthetic events created for extension tracks.\n */\nexport interface SyntheticExtensionFlameChartEntry extends SyntheticTraceEntry {\n  args: TraceEventArgs&ExtensionFlameChartEntryPayload;\n  cat: 'devtools.extension';\n}\n\n/**\n * Synthetic events created for extension marks.\n */\nexport interface SyntheticExtensionMarker extends SyntheticTraceEntry {\n  args: TraceEventArgs&ExtensionMarkerPayload;\n  cat: 'devtools.extension';\n}\n\nexport interface ExtensionTrackData {\n  name: string;\n  extensionName: string;\n  flameChartEntries: SyntheticExtensionFlameChartEntry[];\n}\n"]}

package/models/trace/types/File.d.ts

@@ -58,6 +58,7 @@ export interface MetaData {
     hardwareConcurrency?: number;
     dataOrigin?: DataOrigin;
     modifications?: Modifications;
+    enhancedTraceVersion?: number;
 }
 export type Contents = TraceFile | TraceEventData[];
 export declare function traceEventKeyToValues(key: TraceEventSerializableKey): TraceEventSerializableKeyValues;