@paulirish/trace_engine 0.0.58 → 0.0.60

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

@@ -1 +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,MAAM,CAAU;IAChB,GAAG,CAAU;IACb,EAAE,CAAU;IACZ,GAAG,CAAS;IACZ,UAAU,CAAS;IACnB,aAAa,CAAS;IACtB,iBAAiB,CAAS;IAC1B,yBAAyB,CAAS;IAElC,YAAY,GAAW,EAAE,UAAkB,EAAE,aAAa,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,EAAE,EAAE,GAAG,KAAK;QACpF,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,yBAAyB,CAAC;QACnD,IAAI,CAAC,yBAAyB,GAAG,CAAC,CAAC;IACrC,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,wCAAwC;QACtC,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QAC3C,MAAM,mBAAmB,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;QAC5C,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,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,mBAAmB,CAAC,UAAkB;QACpC,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;IACtC,CAAC;IAED,SAAS,CAAC,MAAe;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAAC,KAAa;QACxC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QACD,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAC;IACzC,CAAC;IAED,KAAK;QACH,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3E,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,MAAM,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YAC3B,eAAe,IAAI,IAAI,CAAC,yBAAyB,CAAC;QACpD,CAAC;QACD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC;QAC/B,MAAM,aAAa,GAAG,aAAa,GAAG,CAAC,CAAC;QACxC,MAAM,uBAAuB,GAAG,IAAI,CAAC,wCAAwC,EAAE,CAAC;QAEhF,IAAI,mBAAmB,GAAG,aAAa,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,mBAAmB;gBACf,aAAa;gBACb,iBAAiB;oBACjB,MAAM;oBACN,aAAa;oBACb,UAAU;oBACV,aAAa;oBACb,wBAAwB;oBACxB,aAAa;oBACb,8GAA8G;oBAC9G,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,mBAAmB,GAAG,aAAa,CAAC,CAAC;QAChE,IAAI,eAAe,GAAG,mBAAmB,GAAG,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAC/E,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YAC3B,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,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,GAAG,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/F,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,MAAM,EAAE,CAAC;YACjB,gBAAgB,GAAG;gBACjB,iBAAiB;gBACjB,cAAc,EAAE,mBAAmB,GAAG,iBAAiB;gBACvD,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;gBAC7C,eAAe;aAChB,CAAC;QACJ,CAAC;aAAM,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACnB,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  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"]}
+{"version":3,"file":"TCPConnection.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/simulation/TCPConnection.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,6BAA6B;AAmB7B,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAE9B,MAAM,aAAa;IACjB,MAAM,CAAU;IAChB,GAAG,CAAU;IACb,EAAE,CAAU;IACZ,GAAG,CAAS;IACZ,UAAU,CAAS;IACnB,aAAa,CAAS;IACtB,iBAAiB,CAAS;IAC1B,yBAAyB,CAAS;IAElC,YAAY,GAAW,EAAE,UAAkB,EAAE,aAAa,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,EAAE,EAAE,GAAG,KAAK;QACpF,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,yBAAyB,CAAC;QACnD,IAAI,CAAC,yBAAyB,GAAG,CAAC,CAAC;IACrC,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,wCAAwC;QACtC,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QAC3C,MAAM,mBAAmB,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;QAC5C,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,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,mBAAmB,CAAC,UAAkB;QACpC,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC;IACtC,CAAC;IAED,SAAS,CAAC,MAAe;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAAC,KAAa;QACxC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QACD,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAC;IACzC,CAAC;IAED,KAAK;QACH,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3E,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,MAAM,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YAC3B,eAAe,IAAI,IAAI,CAAC,yBAAyB,CAAC;QACpD,CAAC;QACD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC;QAC/B,MAAM,aAAa,GAAG,aAAa,GAAG,CAAC,CAAC;QACxC,MAAM,uBAAuB,GAAG,IAAI,CAAC,wCAAwC,EAAE,CAAC;QAEhF,IAAI,mBAAmB,GAAG,aAAa,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,mBAAmB;gBACf,aAAa;gBACb,iBAAiB;oBACjB,MAAM;oBACN,aAAa;oBACb,UAAU;oBACV,aAAa;oBACb,wBAAwB;oBACxB,aAAa;oBACb,8GAA8G;oBAC9G,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,mBAAmB,GAAG,aAAa,CAAC,CAAC;QAChE,IAAI,eAAe,GAAG,mBAAmB,GAAG,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAC/E,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YAC3B,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,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,GAAG,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/F,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,MAAM,EAAE,CAAC;YACjB,gBAAgB,GAAG;gBACjB,iBAAiB;gBACjB,cAAc,EAAE,mBAAmB,GAAG,iBAAiB;gBACvD,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;gBAC7C,eAAe;aAChB,CAAC;QACJ,CAAC;aAAM,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACnB,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\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  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/devtools_entrypoint-bundle-typescript-tsconfig.json

@@ -8,7 +8,11 @@
     "forceConsistentCasingInFileNames": true,
     "inlineSources": true,
     "lib": [
-      "esnext",
+      "ES2023",
+      "ES2024.Promise",
+      "ESNext.Iterator",
+      "ESNext.Collection",
+      "ESNext.Array",
       "dom",
       "dom.iterable"
     ],
@@ -24,7 +28,7 @@
     "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
-    "target": "esnext",
+    "target": "ES2023",
     "tsBuildInfoFile": "devtools_entrypoint-bundle-typescript-tsconfig.json.tsbuildinfo",
     "typeRoots": [],
     "useUnknownInCatchVariables": false

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

@@ -8,7 +8,11 @@
     "forceConsistentCasingInFileNames": true,
     "inlineSources": true,
     "lib": [
-      "esnext",
+      "ES2023",
+      "ES2024.Promise",
+      "ESNext.Iterator",
+      "ESNext.Collection",
+      "ESNext.Array",
       "dom",
       "dom.iterable"
     ],
@@ -24,7 +28,7 @@
     "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
-    "target": "esnext",
+    "target": "ES2023",
     "tsBuildInfoFile": "simulation-tsconfig.json.tsbuildinfo",
     "typeRoots": [],
     "useUnknownInCatchVariables": false

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

@@ -1,4 +1,4 @@
-// Copyright 2024 The Chromium Authors. All rights reserved.
+// Copyright 2024 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 export * from './ConnectionPool.js';

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

@@ -1 +1 @@
-{"version":3,"file":"simulation.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/simulation/simulation.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,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\nexport * from './ConnectionPool.js';\nexport * from './Constants.js';\nexport * from './DNSCache.js';\nexport * from './SimulationTimingMap.js';\nexport * from './Simulator.js';\nexport * from './TCPConnection.js';\n"]}
+{"version":3,"file":"simulation.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/simulation/simulation.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,6BAA6B;AAE7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nexport * from './ConnectionPool.js';\nexport * from './Constants.js';\nexport * from './DNSCache.js';\nexport * from './SimulationTimingMap.js';\nexport * from './Simulator.js';\nexport * from './TCPConnection.js';\n"]}

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

@@ -1,4 +1,4 @@
-// Copyright 2024 The Chromium Authors. All rights reserved.
+// Copyright 2024 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 export const NetworkRequestTypes = {

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

@@ -1 +1 @@
-{"version":3,"file":"Lantern.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/types/Lantern.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAI7B,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;IACpB,KAAK,EAAE,OAAO;CACN,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 * as Protocol from '../../../../generated/protocol.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  FedCM: 'FedCM',\n} as const;\n\nexport interface TraceEvent {\n  name: string;\n  args: {\n    name?: string,\n    data?: {\n      frame?: string,\n      readyState?: number,\n      stackTrace?: Array<{\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 interface Trace {\n  traceEvents: TraceEvent[];\n}\nexport type ResourcePriority = ('VeryLow'|'Low'|'Medium'|'High'|'VeryHigh');\nexport type ResourceType = keyof typeof NetworkRequestTypes;\ntype InitiatorType = ('parser'|'script'|'preload'|'SignedExchange'|'preflight'|'other');\nexport type ResourceTiming = Protocol.Network.ResourceTiming;\nexport interface 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 interface 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 interface 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 received 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, in ms.\n   * When not provided, the server response time is derived from the timing object.\n   */\n  serverResponseTime?: number;\n  /**\n   * Implementation-specific canonical 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: Record<string, number>;\n    serverResponseTimeByOrigin: Record<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 NodeTiming {\n    startTime: number;\n    endTime: number;\n    duration: number;\n  }\n}\n"]}
+{"version":3,"file":"Lantern.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/types/Lantern.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,6BAA6B;AAI7B,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;IACpB,KAAK,EAAE,OAAO;CACN,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors\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';\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  FedCM: 'FedCM',\n} as const;\n\nexport interface TraceEvent {\n  name: string;\n  args: {\n    name?: string,\n    data?: {\n      frame?: string,\n      readyState?: number,\n      stackTrace?: Array<{\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 interface Trace {\n  traceEvents: TraceEvent[];\n}\nexport type ResourcePriority = ('VeryLow'|'Low'|'Medium'|'High'|'VeryHigh');\nexport type ResourceType = keyof typeof NetworkRequestTypes;\ntype InitiatorType = ('parser'|'script'|'preload'|'SignedExchange'|'preflight'|'other');\nexport type ResourceTiming = Protocol.Network.ResourceTiming;\nexport interface 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 interface 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 interface 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 received 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, in ms.\n   * When not provided, the server response time is derived from the timing object.\n   */\n  serverResponseTime?: number;\n  /**\n   * Implementation-specific canonical 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: Record<string, number>;\n    serverResponseTimeByOrigin: Record<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 NodeTiming {\n    startTime: number;\n    endTime: number;\n    duration: number;\n  }\n}\n"]}

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

@@ -8,7 +8,11 @@
     "forceConsistentCasingInFileNames": true,
     "inlineSources": true,
     "lib": [
-      "esnext",
+      "ES2023",
+      "ES2024.Promise",
+      "ESNext.Iterator",
+      "ESNext.Collection",
+      "ESNext.Array",
       "dom",
       "dom.iterable"
     ],
@@ -24,7 +28,7 @@
     "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
-    "target": "esnext",
+    "target": "ES2023",
     "tsBuildInfoFile": "devtools_entrypoint-bundle-typescript-tsconfig.json.tsbuildinfo",
     "typeRoots": [],
     "useUnknownInCatchVariables": false

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

@@ -8,7 +8,11 @@
     "forceConsistentCasingInFileNames": true,
     "inlineSources": true,
     "lib": [
-      "esnext",
+      "ES2023",
+      "ES2024.Promise",
+      "ESNext.Iterator",
+      "ESNext.Collection",
+      "ESNext.Array",
       "dom",
       "dom.iterable"
     ],
@@ -24,7 +28,7 @@
     "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
-    "target": "esnext",
+    "target": "ES2023",
     "tsBuildInfoFile": "types-tsconfig.json.tsbuildinfo",
     "typeRoots": [],
     "useUnknownInCatchVariables": false

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

@@ -1,4 +1,4 @@
-// Copyright 2024 The Chromium Authors. All rights reserved.
+// Copyright 2024 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 export * from './Lantern.js';

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/types/types.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,cAAc,cAAc,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nexport * from './Lantern.js';\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../../../front_end/models/trace/lantern/types/types.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,6BAA6B;AAE7B,cAAc,cAAc,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nexport * from './Lantern.js';\n"]}

package/models/trace/trace-tsconfig.json

@@ -8,7 +8,11 @@
     "forceConsistentCasingInFileNames": true,
     "inlineSources": true,
     "lib": [
-      "esnext",
+      "ES2023",
+      "ES2024.Promise",
+      "ESNext.Iterator",
+      "ESNext.Collection",
+      "ESNext.Array",
       "dom",
       "dom.iterable"
     ],
@@ -24,15 +28,19 @@
     "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
-    "target": "esnext",
+    "target": "ES2023",
     "tsBuildInfoFile": "trace-tsconfig.json.tsbuildinfo",
     "typeRoots": [],
     "useUnknownInCatchVariables": false
   },
   "files": [
+    "../../../../../../front_end/models/trace/EntityMapper.ts",
+    "../../../../../../front_end/models/trace/EventsSerializer.ts",
     "../../../../../../front_end/models/trace/LanternComputationData.ts",
     "../../../../../../front_end/models/trace/ModelImpl.ts",
+    "../../../../../../front_end/models/trace/Name.ts",
     "../../../../../../front_end/models/trace/Processor.ts",
+    "../../../../../../front_end/models/trace/Styles.ts",
     "../../../../../../front_end/legacy/legacy-defs.d.ts",
     "../../../../../../front_end/global_typings/global_defs.d.ts",
     "../../../../../../node_modules/@types/filesystem/index.d.ts"

package/models/trace/trace.d.ts

@@ -1,3 +1,5 @@
+import * as EntityMapper from './EntityMapper.js';
+import * as EventsSerializer from './EventsSerializer.js';
 import * as Extras from './extras/extras.js';
 import * as Handlers from './handlers/handlers.js';
 import * as Helpers from './helpers/helpers.js';
@@ -5,6 +7,8 @@ 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 Name from './Name.js';
 import * as Processor from './Processor.js';
+import * as Styles from './Styles.js';
 import * as Types from './types/types.js';
-export { Extras, Handlers, Helpers, Insights, Lantern, LanternComputationData, Processor, TraceModel, Types, };
+export { EntityMapper, EventsSerializer, Extras, Handlers, Helpers, Insights, Lantern, LanternComputationData, Name, Processor, Styles, TraceModel, Types, };

package/models/trace/trace.js

@@ -1,6 +1,8 @@
-// Copyright 2022 The Chromium Authors. All rights reserved.
+// Copyright 2022 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
+import * as EntityMapper from './EntityMapper.js';
+import * as EventsSerializer from './EventsSerializer.js';
 import * as Extras from './extras/extras.js';
 import * as Handlers from './handlers/handlers.js';
 import * as Helpers from './helpers/helpers.js';
@@ -8,7 +10,9 @@ 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 Name from './Name.js';
 import * as Processor from './Processor.js';
+import * as Styles from './Styles.js';
 import * as Types from './types/types.js';
-export { Extras, Handlers, Helpers, Insights, Lantern, LanternComputationData, Processor, TraceModel, Types, };
+export { EntityMapper, EventsSerializer, Extras, Handlers, Helpers, Insights, Lantern, LanternComputationData, Name, Processor, Styles, TraceModel, 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,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,KAAK,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EACL,MAAM,EACN,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,OAAO,EACP,sBAAsB,EACtB,SAAS,EACT,UAAU,EACV,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 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 Types from './types/types.js';\n\nexport {\n  Extras,\n  Handlers,\n  Helpers,\n  Insights,\n  Lantern,\n  LanternComputationData,\n  Processor,\n  TraceModel,\n  Types,\n};\n"]}
+{"version":3,"file":"trace.js","sourceRoot":"","sources":["../../../../../../front_end/models/trace/trace.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAC;AAClD,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAC;AAC1D,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,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,MAAM,EACN,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,OAAO,EACP,sBAAsB,EACtB,IAAI,EACJ,SAAS,EACT,MAAM,EACN,UAAU,EACV,KAAK,GACN,CAAC","sourcesContent":["// Copyright 2022 The Chromium Authors\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 EntityMapper from './EntityMapper.js';\nimport * as EventsSerializer from './EventsSerializer.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 Name from './Name.js';\nimport * as Processor from './Processor.js';\nimport * as Styles from './Styles.js';\nimport * as Types from './types/types.js';\n\nexport {\n  EntityMapper,\n  EventsSerializer,\n  Extras,\n  Handlers,\n  Helpers,\n  Insights,\n  Lantern,\n  LanternComputationData,\n  Name,\n  Processor,\n  Styles,\n  TraceModel,\n  Types,\n};\n"]}

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

@@ -3,6 +3,7 @@ import type * as Platform from '../../../core/platform/platform.js';
 import type * as Protocol from '../../../generated/protocol.js';
 import type * as Lantern from '../lantern/lantern.js';
 import type * as File from './File.js';
+import type { Milli } from './Timing.js';
 export interface Configuration {
     /**
      * Include V8 RCS functions in the JS stacks
@@ -66,6 +67,16 @@ export interface ParseOptions {
         end: (id: string) => void;
     };
     lanternSettings?: Omit<Lantern.Types.Simulation.Settings, 'networkAnalysis'>;
+    /**
+     * Used when an Insight needs to format a time to string as part of its
+     * output. By default we use the i18n.TimeUtilities in DevTools but this
+     * enables it to be overridden, which is useful if you are consuming the trace
+     * engine outside of DevTools.
+     */
+    insightTimeFormatters?: InsightTimeFormatters;
+}
+export interface InsightTimeFormatters {
+    milli: (x: Milli) => string;
 }
 export interface ResolveSourceMapParams {
     scriptId: string;

package/models/trace/types/Configuration.js

@@ -1,4 +1,4 @@
-// Copyright 2023 The Chromium Authors. All rights reserved.
+// Copyright 2023 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 export const defaults = () => ({

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

@@ -1 +1 @@
-{"version":3,"file":"Configuration.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/Configuration.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AA+C7B,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAkB,EAAE,CAAC,CAAC;IAC5C,uBAAuB,EAAE,KAAK;IAC9B,aAAa,EAAE,KAAK;IACpB,SAAS,EAAE,KAAK;IAChB,6BAA6B,EAAE,EAAE;IACjC,4BAA4B,EAAE,KAAK;CACpC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAqB;IACpD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC","sourcesContent":["// Copyright 2023 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 Platform from '../../../core/platform/platform.js';\nimport type * as SDK from '../../../core/sdk/sdk.js';\nimport type * as Protocol from '../../../generated/protocol.js';\nimport type * as Lantern from '../lantern/lantern.js';\n\nimport type * as File from './File.js';\n\nexport interface Configuration {\n  /**\n   * Include V8 RCS functions in the JS stacks\n   */\n  includeRuntimeCallStats: boolean;\n  /**\n   * Show all events: disable the default filtering which hides and excludes some events.\n   */\n  showAllEvents: boolean;\n  /**\n   * Extra detail for RPP developers (eg Trace Event json in Summary, and individual JS Sample events)\n   */\n  debugMode: boolean;\n  /**\n   * How many invalidation events will be stored for a layout (or similar) event.\n   * On large sites with a lot of DOM there can be thousands of invalidations\n   * associated with any given event. It is not useful to show the user 1000s of\n   * invalidations in the UI, but it is also expensive for us to hold onto them\n   * all, and it helps prevents OOM issues when running in NodeJS\n   * [https://github.com/GoogleChrome/lighthouse/issues/16111].\n   * Therefore, instead, we store only the latest 20 per event. We do also store\n   * the total count, so we can show that, but we'll only ever hold on to the\n   * last 20 invalidations (in DESC trace order - so the latest 20 in the trace file)\n   *\n   * If you set this to 0, we will skip the Invalidations processing entirely.\n   * 0 effectively disables the InvalidationsHandler and it will not even\n   * attempt to gather or track invalidations.\n   */\n  maxInvalidationEventsPerEvent: number;\n  /**\n   * Determines if the AnimationFramesHandler should be enabled. Currently in\n   * DevTools we do not use it, so we disable it by default to avoid work that\n   * we do not use. If you disable it, you will still see `data.AnimationFrames`\n   * from the model, but the contents will be empty.\n   */\n  enableAnimationsFrameHandler: boolean;\n}\n\nexport const defaults = (): Configuration => ({\n  includeRuntimeCallStats: false,\n  showAllEvents: false,\n  debugMode: false,\n  maxInvalidationEventsPerEvent: 20,\n  enableAnimationsFrameHandler: false,\n});\n\n/**\n * Generates a key that can be used to represent this config in a cache. This is\n * used mainly in tests, where we want to avoid re-parsing a file if we have\n * already processed it with the same configuration.\n */\nexport function configToCacheKey(config: Configuration): string {\n  return JSON.stringify(config);\n}\n\nexport interface ParseOptions {\n  /**\n   * If the trace was just recorded on the current page, rather than an imported file.\n   * TODO(paulirish): Maybe remove. This is currently unused by the Processor and Handlers\n   * @default false\n   */\n  isFreshRecording?: boolean;\n  /**\n   * If the trace is a CPU Profile rather than a Chrome tracing trace.\n   * @default false\n   */\n  isCPUProfile?: boolean;\n  metadata?: File.MetaData;\n  resolveSourceMap?: (params: ResolveSourceMapParams) => Promise<SDK.SourceMap.SourceMap|null>;\n  logger?: {\n    start: (id: string) => void,\n    end: (id: string) => void,\n  };\n  lanternSettings?: Omit<Lantern.Types.Simulation.Settings, 'networkAnalysis'>;\n}\n\nexport interface ResolveSourceMapParams {\n  scriptId: string;\n  scriptUrl: Platform.DevToolsPath.UrlString;\n  /** The url as resolved by any sourceUrl comment. */\n  sourceUrl: Platform.DevToolsPath.UrlString;\n  sourceMapUrl: Platform.DevToolsPath.UrlString;\n  frame: Protocol.Page.FrameId;\n  /** Set only if the raw source map was found on the provided metadata. Never set for source maps from data urls. */\n  cachedRawSourceMap?: SDK.SourceMap.SourceMapV3;\n}\n"]}
+{"version":3,"file":"Configuration.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/Configuration.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,6BAA6B;AAgD7B,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAkB,EAAE,CAAC,CAAC;IAC5C,uBAAuB,EAAE,KAAK;IAC9B,aAAa,EAAE,KAAK;IACpB,SAAS,EAAE,KAAK;IAChB,6BAA6B,EAAE,EAAE;IACjC,4BAA4B,EAAE,KAAK;CACpC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAqB;IACpD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC","sourcesContent":["// Copyright 2023 The Chromium Authors\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 Platform from '../../../core/platform/platform.js';\nimport type * as SDK from '../../../core/sdk/sdk.js';\nimport type * as Protocol from '../../../generated/protocol.js';\nimport type * as Lantern from '../lantern/lantern.js';\n\nimport type * as File from './File.js';\nimport type {Milli} from './Timing.js';\n\nexport interface Configuration {\n  /**\n   * Include V8 RCS functions in the JS stacks\n   */\n  includeRuntimeCallStats: boolean;\n  /**\n   * Show all events: disable the default filtering which hides and excludes some events.\n   */\n  showAllEvents: boolean;\n  /**\n   * Extra detail for RPP developers (eg Trace Event json in Summary, and individual JS Sample events)\n   */\n  debugMode: boolean;\n  /**\n   * How many invalidation events will be stored for a layout (or similar) event.\n   * On large sites with a lot of DOM there can be thousands of invalidations\n   * associated with any given event. It is not useful to show the user 1000s of\n   * invalidations in the UI, but it is also expensive for us to hold onto them\n   * all, and it helps prevents OOM issues when running in NodeJS\n   * [https://github.com/GoogleChrome/lighthouse/issues/16111].\n   * Therefore, instead, we store only the latest 20 per event. We do also store\n   * the total count, so we can show that, but we'll only ever hold on to the\n   * last 20 invalidations (in DESC trace order - so the latest 20 in the trace file)\n   *\n   * If you set this to 0, we will skip the Invalidations processing entirely.\n   * 0 effectively disables the InvalidationsHandler and it will not even\n   * attempt to gather or track invalidations.\n   */\n  maxInvalidationEventsPerEvent: number;\n  /**\n   * Determines if the AnimationFramesHandler should be enabled. Currently in\n   * DevTools we do not use it, so we disable it by default to avoid work that\n   * we do not use. If you disable it, you will still see `data.AnimationFrames`\n   * from the model, but the contents will be empty.\n   */\n  enableAnimationsFrameHandler: boolean;\n}\n\nexport const defaults = (): Configuration => ({\n  includeRuntimeCallStats: false,\n  showAllEvents: false,\n  debugMode: false,\n  maxInvalidationEventsPerEvent: 20,\n  enableAnimationsFrameHandler: false,\n});\n\n/**\n * Generates a key that can be used to represent this config in a cache. This is\n * used mainly in tests, where we want to avoid re-parsing a file if we have\n * already processed it with the same configuration.\n */\nexport function configToCacheKey(config: Configuration): string {\n  return JSON.stringify(config);\n}\n\nexport interface ParseOptions {\n  /**\n   * If the trace was just recorded on the current page, rather than an imported file.\n   * TODO(paulirish): Maybe remove. This is currently unused by the Processor and Handlers\n   * @default false\n   */\n  isFreshRecording?: boolean;\n  /**\n   * If the trace is a CPU Profile rather than a Chrome tracing trace.\n   * @default false\n   */\n  isCPUProfile?: boolean;\n  metadata?: File.MetaData;\n  resolveSourceMap?: (params: ResolveSourceMapParams) => Promise<SDK.SourceMap.SourceMap|null>;\n  logger?: {\n    start: (id: string) => void,\n    end: (id: string) => void,\n  };\n  lanternSettings?: Omit<Lantern.Types.Simulation.Settings, 'networkAnalysis'>;\n  /**\n   * Used when an Insight needs to format a time to string as part of its\n   * output. By default we use the i18n.TimeUtilities in DevTools but this\n   * enables it to be overridden, which is useful if you are consuming the trace\n   * engine outside of DevTools.\n   */\n  insightTimeFormatters?: InsightTimeFormatters;\n}\n\nexport interface InsightTimeFormatters {\n  milli: (x: Milli) => string;\n}\n\nexport interface ResolveSourceMapParams {\n  scriptId: string;\n  scriptUrl: Platform.DevToolsPath.UrlString;\n  /** The url as resolved by any sourceUrl comment. */\n  sourceUrl: Platform.DevToolsPath.UrlString;\n  sourceMapUrl: Platform.DevToolsPath.UrlString;\n  frame: Protocol.Page.FrameId;\n  /** Set only if the raw source map was found on the provided metadata. Never set for source maps from data urls. */\n  cachedRawSourceMap?: SDK.SourceMap.SourceMapV3;\n}\n"]}

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

@@ -1,52 +1,64 @@
 import type * as Platform from '../../../core/platform/platform.js';
-import type { Args, ConsoleTimeStamp, Event, PerformanceMark, PerformanceMeasureBegin, Phase, SyntheticBased } from './TraceEvents.js';
+import type { ConsoleTimeStamp, Event, PerformanceMark, PerformanceMeasureBegin, Phase, SyntheticBased } from './TraceEvents.js';
 export type ExtensionEntryType = 'track-entry' | 'marker';
 export declare const extensionPalette: readonly ["primary", "primary-light", "primary-dark", "secondary", "secondary-light", "secondary-dark", "tertiary", "tertiary-light", "tertiary-dark", "error", "warning"];
 export type ExtensionColorFromPalette = typeof extensionPalette[number];
-export interface ExtensionDataPayloadBase {
+/**
+ * Represents any valid value that can be produced by JSON.parse()
+ * without a reviver.
+ */
+export type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export interface DevToolsObjBase {
     color?: ExtensionColorFromPalette;
     /**
      * We document to users that we support only string values here, but because
      * this is coming from user code the values could be anything, so we ensure we
      * deal with bad data by typing this as unknown.
      */
-    properties?: Array<[string, unknown]>;
+    properties?: Array<[string, JsonValue]>;
     tooltipText?: string;
 }
-export type ExtensionDataPayload = ExtensionTrackEntryPayload | ExtensionMarkerPayload;
+export type DevToolsObj = DevToolsObjEntry | DevToolsObjMarker;
 export interface ExtensionTrackEntryPayloadDeeplink {
     url: Platform.DevToolsPath.UrlString;
     description: string;
 }
-export interface ExtensionTrackEntryPayload extends ExtensionDataPayloadBase {
+export interface DevToolsObjEntry extends DevToolsObjBase {
     dataType?: 'track-entry';
     track: string;
     trackGroup?: string;
-    additionalContext?: ExtensionTrackEntryPayloadDeeplink;
+    userDetail?: JsonValue;
 }
-export interface ExtensionMarkerPayload extends ExtensionDataPayloadBase {
+export interface DevToolsObjMarker extends DevToolsObjBase {
     dataType: 'marker';
 }
 /**
  * Synthetic events created for extension tracks.
  */
 export interface SyntheticExtensionTrackEntry extends SyntheticBased<Phase.COMPLETE, PerformanceMeasureBegin | PerformanceMark | ConsoleTimeStamp> {
-    args: Args & ExtensionTrackEntryPayload;
+    devtoolsObj: DevToolsObjEntry;
+    userDetail: JsonValue | null;
 }
 /**
  * Synthetic events created for extension marks.
  */
 export interface SyntheticExtensionMarker extends SyntheticBased<Phase.INSTANT, PerformanceMark> {
-    args: Args & ExtensionMarkerPayload;
+    devtoolsObj: DevToolsObjMarker;
+    userDetail: JsonValue | null;
 }
 export type SyntheticExtensionEntry = SyntheticExtensionTrackEntry | SyntheticExtensionMarker;
+/** Returns true if this is a devtoolsObj for a marker */
 export declare function isExtensionPayloadMarker(payload: {
     dataType?: string;
-}): payload is ExtensionMarkerPayload;
-export declare function isExtensionPayloadTrackEntry(payload: {
+}): payload is DevToolsObjMarker;
+/** Returns true if this is a devtoolsObj for an entry (non-instant) */
+export declare function isExtensionEntryObj(payload: {
     track?: string;
     dataType?: string;
-}): payload is ExtensionTrackEntryPayload;
+}): payload is DevToolsObjEntry;
+/** Returns true if this is a devtoolsObj for a console.timeStamp */
 export declare function isConsoleTimestampPayloadTrackEntry(payload: {
     description?: string;
     url?: string;
@@ -56,7 +68,7 @@ export declare function isValidExtensionPayload(payload: {
     dataType?: string;
     description?: string;
     url?: string;
-}): payload is ExtensionDataPayload | ExtensionTrackEntryPayloadDeeplink;
+}): payload is DevToolsObj | ExtensionTrackEntryPayloadDeeplink;
 export declare function isSyntheticExtensionEntry(entry: Event): entry is SyntheticExtensionEntry;
 export interface ExtensionTrackData {
     name: string;

package/models/trace/types/Extensions.js

@@ -1,4 +1,4 @@
-// Copyright 2024 The Chromium Authors. All rights reserved.
+// Copyright 2024 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 export const extensionPalette = [
@@ -14,19 +14,22 @@ export const extensionPalette = [
     'error',
     'warning',
 ];
+/** Returns true if this is a devtoolsObj for a marker */
 export function isExtensionPayloadMarker(payload) {
     return payload.dataType === 'marker';
 }
-export function isExtensionPayloadTrackEntry(payload) {
+/** Returns true if this is a devtoolsObj for an entry (non-instant) */
+export function isExtensionEntryObj(payload) {
     const hasTrack = 'track' in payload && Boolean(payload.track);
     const validEntryType = payload.dataType === 'track-entry' || payload.dataType === undefined;
     return validEntryType && hasTrack;
 }
+/** Returns true if this is a devtoolsObj for a console.timeStamp */
 export function isConsoleTimestampPayloadTrackEntry(payload) {
     return payload.url !== undefined && payload.description !== undefined;
 }
 export function isValidExtensionPayload(payload) {
-    return isExtensionPayloadMarker(payload) || isExtensionPayloadTrackEntry(payload) ||
+    return isExtensionPayloadMarker(payload) || isExtensionEntryObj(payload) ||
         isConsoleTimestampPayloadTrackEntry(payload);
 }
 export function isSyntheticExtensionEntry(entry) {

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;AAU7B,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,SAAS;IACT,eAAe;IACf,cAAc;IACd,WAAW;IACX,iBAAiB;IACjB,gBAAgB;IAChB,UAAU;IACV,gBAAgB;IAChB,eAAe;IACf,OAAO;IACP,SAAS;CACD,CAAC;AAiEX,MAAM,UAAU,wBAAwB,CAAC,OAA4B;IACnE,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,OAA4C;IAEvF,MAAM,QAAQ,GAAG,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,KAAK,aAAa,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC;IAC5F,OAAO,cAAc,IAAI,QAAQ,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,mCAAmC,CAAC,OAA6C;IAE/F,OAAO,OAAO,CAAC,GAAG,KAAK,SAAS,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,uBAAuB,CACnC,OAAgF;IAElF,OAAO,wBAAwB,CAAC,OAAO,CAAC,IAAI,4BAA4B,CAAC,OAAO,CAAC;QAC7E,mCAAmC,CAAC,OAAO,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAY;IACpD,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 type * as Platform from '../../../core/platform/platform.js';\n\nimport type {\n  Args, ConsoleTimeStamp, Event, PerformanceMark, PerformanceMeasureBegin, Phase, SyntheticBased} from\n  './TraceEvents.js';\n\nexport type ExtensionEntryType = 'track-entry'|'marker';\n\nexport const 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  'warning',\n] as const;\n\nexport type ExtensionColorFromPalette = typeof extensionPalette[number];\n\nexport interface ExtensionDataPayloadBase {\n  color?: ExtensionColorFromPalette;\n  /**\n   * We document to users that we support only string values here, but because\n   * this is coming from user code the values could be anything, so we ensure we\n   * deal with bad data by typing this as unknown.\n   */\n  properties?: Array<[string, unknown]>;\n  tooltipText?: string;\n}\n\nexport type ExtensionDataPayload = ExtensionTrackEntryPayload|ExtensionMarkerPayload;\n\nexport interface ExtensionTrackEntryPayloadDeeplink {\n  // The URL (deep-link) to show in the summary for the track.\n  url: Platform.DevToolsPath.UrlString;\n  // The label to show in front of the URL when the deep-link is shown in the\n  // graph.\n  description: string;\n}\n\nexport interface ExtensionTrackEntryPayload extends ExtensionDataPayloadBase {\n  // Typed as possibly undefined since when no data type is provided\n  // the entry is defaulted to a track entry\n  dataType?: 'track-entry';\n  // The name of the track the entry will be displayed in.\n  // Entries intended to be displayed in the same track must contain the\n  // same value in this property.\n  // If undefined, measurement is added to the Timings track\n  track: string;\n  // The track group an entry’s track belongs to.\n  // Entries intended to be displayed in the same track must contain the\n  // same value in this property as well as the same value in the track\n  // property.\n  trackGroup?: string;\n  // Additional context (deep-link URL) that can be shown in the summary for the\n  // track.\n  additionalContext?: ExtensionTrackEntryPayloadDeeplink;\n}\n\nexport interface ExtensionMarkerPayload extends ExtensionDataPayloadBase {\n  dataType: 'marker';\n}\n\n/**\n * Synthetic events created for extension tracks.\n */\nexport interface SyntheticExtensionTrackEntry extends\n    SyntheticBased<Phase.COMPLETE, PerformanceMeasureBegin|PerformanceMark|ConsoleTimeStamp> {\n  args: Args&ExtensionTrackEntryPayload;\n}\n\n/**\n * Synthetic events created for extension marks.\n */\nexport interface SyntheticExtensionMarker extends SyntheticBased<Phase.INSTANT, PerformanceMark> {\n  args: Args&ExtensionMarkerPayload;\n}\n\nexport type SyntheticExtensionEntry = SyntheticExtensionTrackEntry|SyntheticExtensionMarker;\n\nexport function isExtensionPayloadMarker(payload: {dataType?: string}): payload is ExtensionMarkerPayload {\n  return payload.dataType === 'marker';\n}\n\nexport function isExtensionPayloadTrackEntry(payload: {track?: string, dataType?: string}):\n    payload is ExtensionTrackEntryPayload {\n  const hasTrack = 'track' in payload && Boolean(payload.track);\n  const validEntryType = payload.dataType === 'track-entry' || payload.dataType === undefined;\n  return validEntryType && hasTrack;\n}\n\nexport function isConsoleTimestampPayloadTrackEntry(payload: {description?: string, url?: string}):\n    payload is ExtensionTrackEntryPayloadDeeplink {\n  return payload.url !== undefined && payload.description !== undefined;\n}\n\nexport function isValidExtensionPayload(\n    payload: {track?: string, dataType?: string, description?: string, url?: string}): payload is ExtensionDataPayload|\n    ExtensionTrackEntryPayloadDeeplink {\n  return isExtensionPayloadMarker(payload) || isExtensionPayloadTrackEntry(payload) ||\n      isConsoleTimestampPayloadTrackEntry(payload);\n}\n\nexport function isSyntheticExtensionEntry(entry: Event): entry is SyntheticExtensionEntry {\n  return entry.cat === 'devtools.extension';\n}\n\nexport interface ExtensionTrackData {\n  // Name of the top level track. If it's a track group then this value\n  // has the name of the group, otherwise it has the name of the track.\n  name: string;\n  isTrackGroup: boolean;\n  // If this contains the data of a track group, this property contains\n  // the entries of each of the tracks in the the group. If this is a\n  // standalone track, then this contains that track's entries only.\n  entriesByTrack: Record<string, SyntheticExtensionTrackEntry[]>;\n}\n"]}
+{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/Extensions.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,6BAA6B;AAS7B,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,SAAS;IACT,eAAe;IACf,cAAc;IACd,WAAW;IACX,iBAAiB;IACjB,gBAAgB;IAChB,UAAU;IACV,gBAAgB;IAChB,eAAe;IACf,OAAO;IACP,SAAS;CACD,CAAC;AA0EX,yDAAyD;AACzD,MAAM,UAAU,wBAAwB,CAAC,OAA4B;IACnE,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC;AACvC,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,mBAAmB,CAAC,OAA4C;IAC9E,MAAM,QAAQ,GAAG,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,KAAK,aAAa,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC;IAC5F,OAAO,cAAc,IAAI,QAAQ,CAAC;AACpC,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,mCAAmC,CAAC,OAA6C;IAE/F,OAAO,OAAO,CAAC,GAAG,KAAK,SAAS,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,uBAAuB,CACnC,OAAgF;IAElF,OAAO,wBAAwB,CAAC,OAAO,CAAC,IAAI,mBAAmB,CAAC,OAAO,CAAC;QACpE,mCAAmC,CAAC,OAAO,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAY;IACpD,OAAO,KAAK,CAAC,GAAG,KAAK,oBAAoB,CAAC;AAC5C,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors\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 Platform from '../../../core/platform/platform.js';\n\nimport type {\n  ConsoleTimeStamp, Event, PerformanceMark, PerformanceMeasureBegin, Phase, SyntheticBased} from './TraceEvents.js';\n\nexport type ExtensionEntryType = 'track-entry'|'marker';\n\nexport const 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  'warning',\n] as const;\n\nexport type ExtensionColorFromPalette = typeof extensionPalette[number];\n\n/**\n * Represents any valid value that can be produced by JSON.parse()\n * without a reviver.\n */\nexport type JsonValue = string|number|boolean|null|JsonValue[]|{[key: string]: JsonValue};\n\nexport interface DevToolsObjBase {\n  color?: ExtensionColorFromPalette;\n  /**\n   * We document to users that we support only string values here, but because\n   * this is coming from user code the values could be anything, so we ensure we\n   * deal with bad data by typing this as unknown.\n   */\n  properties?: Array<[string, JsonValue]>;\n  tooltipText?: string;\n}\n\nexport type DevToolsObj = DevToolsObjEntry|DevToolsObjMarker;\n\nexport interface ExtensionTrackEntryPayloadDeeplink {\n  // The URL (deep-link) to show in the summary for the track.\n  url: Platform.DevToolsPath.UrlString;\n  // The label to show in front of the URL when the deep-link is shown in the\n  // graph.\n  description: string;\n}\n\nexport interface DevToolsObjEntry extends DevToolsObjBase {\n  // Typed as possibly undefined since when no data type is provided\n  // the entry is defaulted to a track entry\n  dataType?: 'track-entry';\n  // The name of the track the entry will be displayed in.\n  // Entries intended to be displayed in the same track must contain the\n  // same value in this property.\n  // If undefined, measurement is added to the Timings track\n  track: string;\n  // The track group an entry’s track belongs to.\n  // Entries intended to be displayed in the same track must contain the\n  // same value in this property as well as the same value in the track\n  // property.\n  trackGroup?: string;\n  // Additional data (e.g. deep-link URL) that can be shown in the summary\n  // In perf.mark/measure, it's anything in the `detail` object that's not the `devtools` object\n  // In console.timestamp, it's the 7th argument to console.timeStamp().\n  userDetail?: JsonValue;\n}\n\nexport interface DevToolsObjMarker extends DevToolsObjBase {\n  dataType: 'marker';\n}\n\n/**\n * Synthetic events created for extension tracks.\n */\nexport interface SyntheticExtensionTrackEntry extends\n    SyntheticBased<Phase.COMPLETE, PerformanceMeasureBegin|PerformanceMark|ConsoleTimeStamp> {\n  devtoolsObj: DevToolsObjEntry;\n  userDetail: JsonValue|null;\n}\n\n/**\n * Synthetic events created for extension marks.\n */\nexport interface SyntheticExtensionMarker extends SyntheticBased<Phase.INSTANT, PerformanceMark> {\n  devtoolsObj: DevToolsObjMarker;\n  userDetail: JsonValue|null;\n}\n\nexport type SyntheticExtensionEntry = SyntheticExtensionTrackEntry|SyntheticExtensionMarker;\n\n/** Returns true if this is a devtoolsObj for a marker */\nexport function isExtensionPayloadMarker(payload: {dataType?: string}): payload is DevToolsObjMarker {\n  return payload.dataType === 'marker';\n}\n\n/** Returns true if this is a devtoolsObj for an entry (non-instant) */\nexport function isExtensionEntryObj(payload: {track?: string, dataType?: string}): payload is DevToolsObjEntry {\n  const hasTrack = 'track' in payload && Boolean(payload.track);\n  const validEntryType = payload.dataType === 'track-entry' || payload.dataType === undefined;\n  return validEntryType && hasTrack;\n}\n\n/** Returns true if this is a devtoolsObj for a console.timeStamp */\nexport function isConsoleTimestampPayloadTrackEntry(payload: {description?: string, url?: string}):\n    payload is ExtensionTrackEntryPayloadDeeplink {\n  return payload.url !== undefined && payload.description !== undefined;\n}\n\nexport function isValidExtensionPayload(\n    payload: {track?: string, dataType?: string, description?: string, url?: string}): payload is DevToolsObj|\n    ExtensionTrackEntryPayloadDeeplink {\n  return isExtensionPayloadMarker(payload) || isExtensionEntryObj(payload) ||\n      isConsoleTimestampPayloadTrackEntry(payload);\n}\n\nexport function isSyntheticExtensionEntry(entry: Event): entry is SyntheticExtensionEntry {\n  return entry.cat === 'devtools.extension';\n}\n\nexport interface ExtensionTrackData {\n  // Name of the top level track. If it's a track group then this value\n  // has the name of the group, otherwise it has the name of the track.\n  name: string;\n  isTrackGroup: boolean;\n  // If this contains the data of a track group, this property contains\n  // the entries of each of the tracks in the the group. If this is a\n  // standalone track, then this contains that track's entries only.\n  entriesByTrack: Record<string, SyntheticExtensionTrackEntry[]>;\n}\n"]}

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

@@ -96,11 +96,18 @@ export type Annotation = EntryLabelAnnotation | TimeRangeAnnotation | EntriesLin
 export declare function isTimeRangeAnnotation(annotation: Annotation): annotation is TimeRangeAnnotation;
 export declare function isEntryLabelAnnotation(annotation: Annotation): annotation is EntryLabelAnnotation;
 export declare function isEntriesLinkAnnotation(annotation: Annotation): annotation is EntriesLinkAnnotation;
+/**
+ * Serializable keys are created for trace events to be able to save
+ * references to timeline events in a trace file. These keys enable
+ * user modifications that can be saved. See go/cpq:event-data-json for
+ * more details on the key format.
+ **/
 export type RawEventKey = `${EventKeyType.RAW_EVENT}-${number}`;
 export type SyntheticEventKey = `${EventKeyType.SYNTHETIC_EVENT}-${number}`;
 export type ProfileCallKey = `${EventKeyType.PROFILE_CALL}-${ProcessID}-${ThreadID}-${SampleIndex}-${Protocol.integer}`;
 export type LegacyTimelineFrameKey = `${EventKeyType.LEGACY_TIMELINE_FRAME}-${number}`;
 export type SerializableKey = RawEventKey | ProfileCallKey | SyntheticEventKey | LegacyTimelineFrameKey;
+/** Serializable keys values objects contain data that maps the keys to original Trace Events **/
 export interface RawEventKeyValues {
     type: EventKeyType.RAW_EVENT;
     rawIndex: number;
@@ -129,6 +136,11 @@ export interface Modifications {
     initialBreadcrumb: Breadcrumb;
     annotations: SerializedAnnotations;
 }
+/**
+ * IMPORTANT: this is the same as PerfUI.FlameChart.PersistedGroupConfig
+ * However, the PerfUI code should not depend on the model/trace, and similarly
+ * this model cannot depend on that code, so we duplicate it.
+ **/
 export interface TrackVisualConfig {
     hidden: boolean;
     expanded: boolean;
@@ -167,7 +179,7 @@ export interface MetaData {
     visualTrackConfig?: PersistedTraceVisualConfig;
     hostDPR?: number;
 }
-interface MetadataSourceMap {
+export interface MetadataSourceMap {
     url: string;
     /** If not defined, then this was a data url. */
     sourceMapUrl?: string;
@@ -175,4 +187,3 @@ interface MetadataSourceMap {
 }
 export type Contents = TraceFile | Event[];
 export declare function traceEventKeyToValues(key: SerializableKey): SerializableKeyValues;
-export {};

package/models/trace/types/File.js

@@ -1,4 +1,4 @@
-// Copyright 2023 The Chromium Authors. All rights reserved.
+// Copyright 2023 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 export var DataOrigin;