@paulirish/trace_engine 0.0.42 → 0.0.43

package/models/trace/lantern/MetricsModule.js

@@ -1,14 +0,0 @@
-// Copyright 2024 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-// TODO(crbug.com/348449529): refactor to proper devtools module
-import { FirstContentfulPaint } from './metrics/FirstContentfulPaint.js';
-import { Interactive } from './metrics/Interactive.js';
-import { LargestContentfulPaint } from './metrics/LargestContentfulPaint.js';
-import { MaxPotentialFID } from './metrics/MaxPotentialFID.js';
-import { Metric } from './metrics/Metric.js';
-import { SpeedIndex } from './metrics/SpeedIndex.js';
-import { TotalBlockingTime } from './metrics/TotalBlockingTime.js';
-export { FirstContentfulPaint, Interactive, LargestContentfulPaint, MaxPotentialFID, Metric, SpeedIndex, TotalBlockingTime, };
-export * as TBTUtils from './metrics/TBTUtils.js';
-//# sourceMappingURL=MetricsModule.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"MetricsModule.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/lantern/MetricsModule.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,gEAAgE;AAEhE,OAAO,EAAC,oBAAoB,EAAC,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAC,WAAW,EAAC,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAC,sBAAsB,EAAC,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAC,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAc,MAAM,EAAC,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAC,UAAU,EAAC,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAC,iBAAiB,EAAC,MAAM,gCAAgC,CAAC;AAKjE,OAAO,EACL,oBAAoB,EACpB,WAAW,EACX,sBAAsB,EACtB,eAAe,EAEf,MAAM,EACN,UAAU,EACV,iBAAiB,GAClB,CAAC;AAEF,OAAO,KAAK,QAAQ,MAAM,uBAAuB,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\n// TODO(crbug.com/348449529): refactor to proper devtools module\n\nimport {FirstContentfulPaint} from './metrics/FirstContentfulPaint.js';\nimport {Interactive} from './metrics/Interactive.js';\nimport {LargestContentfulPaint} from './metrics/LargestContentfulPaint.js';\nimport {MaxPotentialFID} from './metrics/MaxPotentialFID.js';\nimport {type Extras, Metric} from './metrics/Metric.js';\nimport {SpeedIndex} from './metrics/SpeedIndex.js';\nimport {TotalBlockingTime} from './metrics/TotalBlockingTime.js';\nimport type * as Lantern from './types/lantern.js';\n\nexport type Result<T = Lantern.AnyNetworkObject> = Lantern.Metrics.Result<T>;\n\nexport {\n  FirstContentfulPaint,\n  Interactive,\n  LargestContentfulPaint,\n  MaxPotentialFID,\n  Extras,\n  Metric,\n  SpeedIndex,\n  TotalBlockingTime,\n};\n\nexport * as TBTUtils from './metrics/TBTUtils.js';\n"]}

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

@@ -1,22 +0,0 @@
-import { BaseNode } from './BaseNode.js';
-import type * as Lantern from './types/lantern.js';
-declare class NetworkNode<T = Lantern.AnyNetworkObject> extends BaseNode<T> {
-    _request: Lantern.NetworkRequest<T>;
-    constructor(networkRequest: Lantern.NetworkRequest<T>);
-    get type(): 'network';
-    get startTime(): number;
-    get endTime(): number;
-    get rawRequest(): Readonly<T>;
-    get request(): Lantern.NetworkRequest<T>;
-    get initiatorType(): string;
-    get fromDiskCache(): boolean;
-    get isNonNetworkProtocol(): boolean;
-    /**
-     * Returns whether this network request can be downloaded without a TCP connection.
-     * During simulation we treat data coming in over a network connection separately from on-device data.
-     */
-    get isConnectionless(): boolean;
-    hasRenderBlockingPriority(): boolean;
-    cloneWithoutRelationships(): NetworkNode<T>;
-}
-export { NetworkNode };

package/models/trace/lantern/NetworkNode.js

@@ -1,83 +0,0 @@
-// Copyright 2024 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-import { BaseNode } from './BaseNode.js';
-const NON_NETWORK_SCHEMES = [
-    'blob', // @see https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL
-    'data', // @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
-    'intent', // @see https://developer.chrome.com/docs/multidevice/android/intents/
-    'file', // @see https://en.wikipedia.org/wiki/File_URI_scheme
-    'filesystem', // @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystem
-    'chrome-extension',
-];
-/**
- * Note: the `protocol` field from CDP can be 'h2', 'http', (not 'https'!) or it'll be url's scheme.
- *   https://source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/protocol/network_handler.cc;l=598-611;drc=56d4a9a9deb30be73adcee8737c73bcb2a5ab64f
- * However, a `new URL(href).protocol` has a colon suffix.
- *   https://url.spec.whatwg.org/#dom-url-protocol
- * A URL's `scheme` is specced as the `protocol` sans-colon, but isn't exposed on a URL object.
- * This method can take all 3 of these string types as a parameter.
- *
- * @param protocol Either a networkRequest's `protocol` per CDP or a `new URL(href).protocol`
- */
-function isNonNetworkProtocol(protocol) {
-    // Strip off any colon
-    const urlScheme = protocol.includes(':') ? protocol.slice(0, protocol.indexOf(':')) : protocol;
-    return NON_NETWORK_SCHEMES.includes(urlScheme);
-}
-class NetworkNode extends BaseNode {
-    _request;
-    constructor(networkRequest) {
-        super(networkRequest.requestId);
-        this._request = networkRequest;
-    }
-    get type() {
-        return BaseNode.types.NETWORK;
-    }
-    get startTime() {
-        return this._request.rendererStartTime * 1000;
-    }
-    get endTime() {
-        return this._request.networkEndTime * 1000;
-    }
-    get rawRequest() {
-        return this._request.rawRequest;
-    }
-    get request() {
-        return this._request;
-    }
-    get initiatorType() {
-        return this._request.initiator && this._request.initiator.type;
-    }
-    get fromDiskCache() {
-        return Boolean(this._request.fromDiskCache);
-    }
-    get isNonNetworkProtocol() {
-        // The 'protocol' field in devtools a string more like a `scheme`
-        return isNonNetworkProtocol(this.request.protocol) ||
-            // But `protocol` can fail to be populated if the request fails, so fallback to scheme.
-            isNonNetworkProtocol(this.request.parsedURL.scheme);
-    }
-    /**
-     * Returns whether this network request can be downloaded without a TCP connection.
-     * During simulation we treat data coming in over a network connection separately from on-device data.
-     */
-    get isConnectionless() {
-        return this.fromDiskCache || this.isNonNetworkProtocol;
-    }
-    hasRenderBlockingPriority() {
-        const priority = this._request.priority;
-        const isScript = this._request.resourceType === 'Script';
-        const isDocument = this._request.resourceType === 'Document';
-        const isBlockingScript = priority === 'High' && isScript;
-        const isBlockingHtmlImport = priority === 'High' && isDocument;
-        return priority === 'VeryHigh' || isBlockingScript || isBlockingHtmlImport;
-    }
-    cloneWithoutRelationships() {
-        const node = new NetworkNode(this._request);
-        node.setIsMainDocument(this._isMainDocument);
-        return node;
-    }
-}
-export { NetworkNode };
-//# sourceMappingURL=NetworkNode.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"NetworkNode.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/lantern/NetworkNode.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AAGvC,MAAM,mBAAmB,GAAG;IAC1B,MAAM,EAAS,4EAA4E;IAC3F,MAAM,EAAS,kFAAkF;IACjG,QAAQ,EAAO,sEAAsE;IACrF,MAAM,EAAS,qDAAqD;IACpE,YAAY,EAAG,mEAAmE;IAClF,kBAAkB;CACnB,CAAC;AAEF;;;;;;;;;GASG;AACH,SAAS,oBAAoB,CAAC,QAAgB;IAC5C,sBAAsB;IACtB,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC/F,OAAO,mBAAmB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,WAA0C,SAAQ,QAAW;IACjE,QAAQ,CAA4B;IAEpC,YAAY,cAAyC;QACnD,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,cAAc,CAAC;IACjC,CAAC;IAED,IAAa,IAAI;QACf,OAAO,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;IAChC,CAAC;IAED,IAAa,SAAS;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAChD,CAAC;IAED,IAAa,OAAO;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7C,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAyB,CAAC;IACjD,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC;IACjE,CAAC;IAED,IAAI,aAAa;QACf,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,oBAAoB;QACtB,iEAAiE;QACjE,OAAO,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC9C,uFAAuF;YACvF,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,oBAAoB,CAAC;IACzD,CAAC;IAED,yBAAyB;QACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,KAAK,QAAQ,CAAC;QACzD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,KAAK,UAAU,CAAC;QAC7D,MAAM,gBAAgB,GAAG,QAAQ,KAAK,MAAM,IAAI,QAAQ,CAAC;QACzD,MAAM,oBAAoB,GAAG,QAAQ,KAAK,MAAM,IAAI,UAAU,CAAC;QAC/D,OAAO,QAAQ,KAAK,UAAU,IAAI,gBAAgB,IAAI,oBAAoB,CAAC;IAC7E,CAAC;IAEQ,yBAAyB;QAChC,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,OAAO,EAAC,WAAW,EAAC,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nimport {BaseNode} from './BaseNode.js';\nimport type * as Lantern from './types/lantern.js';\n\nconst NON_NETWORK_SCHEMES = [\n  'blob',        // @see https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL\n  'data',        // @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs\n  'intent',      // @see https://developer.chrome.com/docs/multidevice/android/intents/\n  'file',        // @see https://en.wikipedia.org/wiki/File_URI_scheme\n  'filesystem',  // @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystem\n  'chrome-extension',\n];\n\n/**\n * Note: the `protocol` field from CDP can be 'h2', 'http', (not 'https'!) or it'll be url's scheme.\n *   https://source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/protocol/network_handler.cc;l=598-611;drc=56d4a9a9deb30be73adcee8737c73bcb2a5ab64f\n * However, a `new URL(href).protocol` has a colon suffix.\n *   https://url.spec.whatwg.org/#dom-url-protocol\n * A URL's `scheme` is specced as the `protocol` sans-colon, but isn't exposed on a URL object.\n * This method can take all 3 of these string types as a parameter.\n *\n * @param protocol Either a networkRequest's `protocol` per CDP or a `new URL(href).protocol`\n */\nfunction isNonNetworkProtocol(protocol: string): boolean {\n  // Strip off any colon\n  const urlScheme = protocol.includes(':') ? protocol.slice(0, protocol.indexOf(':')) : protocol;\n  return NON_NETWORK_SCHEMES.includes(urlScheme);\n}\n\nclass NetworkNode<T = Lantern.AnyNetworkObject> extends BaseNode<T> {\n  _request: Lantern.NetworkRequest<T>;\n\n  constructor(networkRequest: Lantern.NetworkRequest<T>) {\n    super(networkRequest.requestId);\n    this._request = networkRequest;\n  }\n\n  override get type(): 'network' {\n    return BaseNode.types.NETWORK;\n  }\n\n  override get startTime(): number {\n    return this._request.rendererStartTime * 1000;\n  }\n\n  override get endTime(): number {\n    return this._request.networkEndTime * 1000;\n  }\n\n  get rawRequest(): Readonly<T> {\n    return this._request.rawRequest as Required<T>;\n  }\n\n  get request(): Lantern.NetworkRequest<T> {\n    return this._request;\n  }\n\n  get initiatorType(): string {\n    return this._request.initiator && this._request.initiator.type;\n  }\n\n  get fromDiskCache(): boolean {\n    return Boolean(this._request.fromDiskCache);\n  }\n\n  get isNonNetworkProtocol(): boolean {\n    // The 'protocol' field in devtools a string more like a `scheme`\n    return isNonNetworkProtocol(this.request.protocol) ||\n        // But `protocol` can fail to be populated if the request fails, so fallback to scheme.\n        isNonNetworkProtocol(this.request.parsedURL.scheme);\n  }\n\n  /**\n   * Returns whether this network request can be downloaded without a TCP connection.\n   * During simulation we treat data coming in over a network connection separately from on-device data.\n   */\n  get isConnectionless(): boolean {\n    return this.fromDiskCache || this.isNonNetworkProtocol;\n  }\n\n  hasRenderBlockingPriority(): boolean {\n    const priority = this._request.priority;\n    const isScript = this._request.resourceType === 'Script';\n    const isDocument = this._request.resourceType === 'Document';\n    const isBlockingScript = priority === 'High' && isScript;\n    const isBlockingHtmlImport = priority === 'High' && isDocument;\n    return priority === 'VeryHigh' || isBlockingScript || isBlockingHtmlImport;\n  }\n\n  override cloneWithoutRelationships(): NetworkNode<T> {\n    const node = new NetworkNode(this._request);\n    node.setIsMainDocument(this._isMainDocument);\n    return node;\n  }\n}\n\nexport {NetworkNode};\n"]}

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

@@ -1,43 +0,0 @@
-import { type Node } from './BaseNode.js';
-import { CPUNode } from './CPUNode.js';
-import { NetworkNode } from './NetworkNode.js';
-import type * as Lantern from './types/lantern.js';
-interface NetworkNodeOutput {
-    nodes: Array<NetworkNode>;
-    idToNodeMap: Map<string, NetworkNode>;
-    urlToNodeMap: Map<string, Array<NetworkNode>>;
-    frameIdToNodeMap: Map<string, NetworkNode | null>;
-}
-declare class PageDependencyGraph {
-    static getNetworkInitiators(request: Lantern.NetworkRequest): string[];
-    static getNetworkNodeOutput(networkRequests: Lantern.NetworkRequest[]): NetworkNodeOutput;
-    static isScheduleableTask(evt: Lantern.TraceEvent): boolean;
-    /**
-     * There should *always* be at least one top level event, having 0 typically means something is
-     * drastically wrong with the trace and we should just give up early and loudly.
-     */
-    static assertHasToplevelEvents(events: Lantern.TraceEvent[]): void;
-    static getCPUNodes(mainThreadEvents: Lantern.TraceEvent[]): CPUNode[];
-    static linkNetworkNodes(rootNode: NetworkNode, networkNodeOutput: NetworkNodeOutput): void;
-    static linkCPUNodes(rootNode: Node, networkNodeOutput: NetworkNodeOutput, cpuNodes: CPUNode[]): void;
-    /**
-     * Removes the given node from the graph, but retains all paths between its dependencies and
-     * dependents.
-     */
-    static _pruneNode(node: Node): void;
-    /**
-     * TODO: remove when CDT backend in Lighthouse is gone. Until then, this is a useful debugging tool
-     * to find delta between using CDP or the trace to create the network requests.
-     *
-     * When a test fails using the trace backend, I enabled this debug method and copied the network
-     * requests when CDP was used, then when trace is used, and diff'd them. This method helped
-     * remove non-logical differences from the comparison (order of properties, slight rounding
-     * discrepancies, removing object cycles, etc).
-     *
-     * When using for a unit test, make sure to do `.only` so you are getting what you expect.
-     */
-    static _debugNormalizeRequests(lanternRequests: Lantern.NetworkRequest[]): void;
-    static createGraph(mainThreadEvents: Lantern.TraceEvent[], networkRequests: Lantern.NetworkRequest[], url: Lantern.Simulation.URL): Node;
-    static printGraph(rootNode: Node, widthInCharacters?: number): void;
-}
-export { PageDependencyGraph };