@paulirish/trace_engine 0.0.54 → 0.0.55

package/models/trace/insights/ThirdPartyWeb.js

@@ -1,42 +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 * as ThirdPartyWeb from '../../../third_party/third-party-web/third-party-web.js';
-import * as Extras from '../extras/extras.js';
-import * as Helpers from '../helpers/helpers.js';
-export function deps() {
-    return ['Meta', 'NetworkRequests', 'Renderer', 'ImagePainting'];
-}
-function getRelatedEvents(summaries, firstPartyEntity) {
-    const events = [];
-    for (const [entity, requests] of summaries.requestsByEntity.entries()) {
-        if (entity !== firstPartyEntity) {
-            events.push(...requests);
-        }
-    }
-    return events;
-}
-export function generateInsight(parsedTrace, context) {
-    const networkRequests = parsedTrace.NetworkRequests.byTime.filter(event => {
-        if (!context.navigation) {
-            return false;
-        }
-        if (event.args.data.frame !== context.frameId) {
-            return false;
-        }
-        return Helpers.Timing.eventIsInBounds(event, context.bounds);
-    });
-    const { entityByRequest, madeUpEntityCache, summaries } = Extras.ThirdParties.getSummariesAndEntitiesForTraceBounds(parsedTrace, context.bounds, networkRequests);
-    const firstPartyUrl = context.navigation?.args.data?.documentLoaderURL ?? parsedTrace.Meta.mainFrameURL;
-    const firstPartyEntity = ThirdPartyWeb.ThirdPartyWeb.getEntity(firstPartyUrl) ||
-        Extras.ThirdParties.makeUpEntity(madeUpEntityCache, firstPartyUrl);
-    return {
-        relatedEvents: getRelatedEvents(summaries, firstPartyEntity),
-        entityByRequest,
-        requestsByEntity: summaries.requestsByEntity,
-        summaryByRequest: summaries.byRequest,
-        summaryByEntity: summaries.byEntity,
-        firstPartyEntity,
-    };
-}
-//# sourceMappingURL=ThirdPartyWeb.js.map

package/models/trace/insights/ThirdPartyWeb.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ThirdPartyWeb.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/insights/ThirdPartyWeb.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAE7B,OAAO,KAAK,aAAa,MAAM,yDAAyD,CAAC;AACzF,OAAO,KAAK,MAAM,MAAM,qBAAqB,CAAC;AAE9C,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AAKjD,MAAM,UAAU,IAAI;IAClB,OAAO,CAAC,MAAM,EAAE,iBAAiB,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;AAClE,CAAC;AAWD,SAAS,gBAAgB,CACrB,SAA0C,EAC1C,gBAAsD;IACxD,MAAM,MAAM,GAAG,EAAE,CAAC;IAElB,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,EAAE,CAAC;QACtE,IAAI,MAAM,KAAK,gBAAgB,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,eAAe,CAC3B,WAAsC,EAAE,OAA0B;IACpE,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;QACxE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC;YAC9C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,MAAM,EAAC,eAAe,EAAE,iBAAiB,EAAE,SAAS,EAAC,GAAG,MAAM,CAAC,YAAY,CAAC,qCAAqC,CAC7G,WAAyC,EAAE,OAAO,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEhF,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,iBAAiB,IAAI,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC;IACxG,MAAM,gBAAgB,GAAG,aAAa,CAAC,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC;QACzE,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;IAEvE,OAAO;QACL,aAAa,EAAE,gBAAgB,CAAC,SAAS,EAAE,gBAAgB,CAAC;QAC5D,eAAe;QACf,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;QAC5C,gBAAgB,EAAE,SAAS,CAAC,SAAS;QACrC,eAAe,EAAE,SAAS,CAAC,QAAQ;QACnC,gBAAgB;KACjB,CAAC;AACJ,CAAC","sourcesContent":["// Copyright 2024 The Chromium Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\nimport * as ThirdPartyWeb from '../../../third_party/third-party-web/third-party-web.js';\nimport * as Extras from '../extras/extras.js';\nimport type * as Handlers from '../handlers/handlers.js';\nimport * as Helpers from '../helpers/helpers.js';\nimport type * as Types from '../types/types.js';\n\nimport type {InsightResult, InsightSetContext, RequiredData} from './types.js';\n\nexport function deps(): ['Meta', 'NetworkRequests', 'Renderer', 'ImagePainting'] {\n  return ['Meta', 'NetworkRequests', 'Renderer', 'ImagePainting'];\n}\n\nexport type ThirdPartyWebInsightResult = InsightResult<{\n  entityByRequest: Map<Types.Events.SyntheticNetworkRequest, Extras.ThirdParties.Entity>,\n  requestsByEntity: Map<Extras.ThirdParties.Entity, Types.Events.SyntheticNetworkRequest[]>,\n  summaryByRequest: Map<Types.Events.SyntheticNetworkRequest, Extras.ThirdParties.Summary>,\n  summaryByEntity: Map<Extras.ThirdParties.Entity, Extras.ThirdParties.Summary>,\n  /** The entity for this navigation's URL. Any other entity is from a third party. */\n  firstPartyEntity?: Extras.ThirdParties.Entity,\n}>;\n\nfunction getRelatedEvents(\n    summaries: Extras.ThirdParties.SummaryMaps,\n    firstPartyEntity: Extras.ThirdParties.Entity|undefined): Types.Events.Event[] {\n  const events = [];\n\n  for (const [entity, requests] of summaries.requestsByEntity.entries()) {\n    if (entity !== firstPartyEntity) {\n      events.push(...requests);\n    }\n  }\n\n  return events;\n}\n\nexport function generateInsight(\n    parsedTrace: RequiredData<typeof deps>, context: InsightSetContext): ThirdPartyWebInsightResult {\n  const networkRequests = parsedTrace.NetworkRequests.byTime.filter(event => {\n    if (!context.navigation) {\n      return false;\n    }\n\n    if (event.args.data.frame !== context.frameId) {\n      return false;\n    }\n\n    return Helpers.Timing.eventIsInBounds(event, context.bounds);\n  });\n\n  const {entityByRequest, madeUpEntityCache, summaries} = Extras.ThirdParties.getSummariesAndEntitiesForTraceBounds(\n      parsedTrace as Handlers.Types.ParsedTrace, context.bounds, networkRequests);\n\n  const firstPartyUrl = context.navigation?.args.data?.documentLoaderURL ?? parsedTrace.Meta.mainFrameURL;\n  const firstPartyEntity = ThirdPartyWeb.ThirdPartyWeb.getEntity(firstPartyUrl) ||\n      Extras.ThirdParties.makeUpEntity(madeUpEntityCache, firstPartyUrl);\n\n  return {\n    relatedEvents: getRelatedEvents(summaries, firstPartyEntity),\n    entityByRequest,\n    requestsByEntity: summaries.requestsByEntity,\n    summaryByRequest: summaries.byRequest,\n    summaryByEntity: summaries.byEntity,\n    firstPartyEntity,\n  };\n}\n"]}

package/models/trace/root-causes/LayoutShift.d.ts

@@ -1,125 +0,0 @@
-import type * as Protocol from '../../../generated/protocol.js';
-import type { ParsedTrace } from '../handlers/types.js';
-import * as Types from '../types/types.js';
-import type { RootCauseProtocolInterface } from './RootCauses.js';
-export type CSSDimensions = {
-    width?: string;
-    height?: string;
-    aspectRatio?: string;
-};
-export interface UnsizedMedia {
-    node: Protocol.DOM.Node;
-    authoredDimensions?: CSSDimensions;
-    computedDimensions: CSSDimensions;
-}
-export interface InjectedIframe {
-    iframe: Protocol.DOM.Node;
-}
-export interface RootCauseRequest {
-    request: Types.Events.SyntheticNetworkRequest;
-    initiator?: Protocol.Network.Initiator;
-}
-export interface FontChange extends RootCauseRequest {
-    fontFace: Protocol.CSS.FontFace;
-}
-export interface RenderBlockingRequest extends RootCauseRequest {
-}
-export interface LayoutShiftRootCausesData {
-    unsizedMedia: UnsizedMedia[];
-    iframes: InjectedIframe[];
-    fontChanges: FontChange[];
-    renderBlockingRequests: RenderBlockingRequest[];
-    scriptStackTrace: Types.Events.CallFrame[];
-}
-interface Options {
-    /** Checking iframe root causes can be an expensive operation, so it is disabled by default. */
-    enableIframeRootCauses?: boolean;
-}
-export declare class LayoutShiftRootCauses {
-    #private;
-    constructor(protocolInterface: RootCauseProtocolInterface, options?: Options);
-    /**
-     * Calculates the potential root causes for a given layout shift event. Once
-     * calculated, this data is cached.
-     * Note: because you need all layout shift data at once to calculate these
-     * correctly, this function will parse the root causes for _all_ layout shift
-     * events the first time that it's called. That then populates the cache for
-     * each shift, so any subsequent calls are just a constant lookup.
-     */
-    rootCausesForEvent(modelData: ParsedTrace, event: Types.Events.LayoutShift): Promise<Readonly<LayoutShiftRootCausesData> | null>;
-    /**
-     * Determines potential root causes for shifts
-     */
-    blameShifts(layoutShifts: Types.Events.LayoutShift[], modelData: ParsedTrace): Promise<void>;
-    /**
-     * "LayoutInvalidations" are a set of trace events dispatched in Blink under the name
-     * "layoutInvalidationTracking", which track invalidations on the "Layout"stage of the
-     * rendering pipeline. This function utilizes this event to flag potential root causes
-     * to layout shifts.
-     */
-    linkShiftsToLayoutInvalidations(layoutShifts: Types.Events.LayoutShift[], modelData: ParsedTrace): Promise<void>;
-    /**
-     * For every shift looks up the initiator of its corresponding Layout event. This initiator
-     * is assigned by the RendererHandler and contains the stack trace of the point in a script
-     * that caused a style recalculation or a relayout. This stack trace is added to the shift's
-     * potential root causes.
-     * Note that a Layout cannot always be linked to a script, in that case, we cannot add a
-     * "script causing reflow" as a potential root cause to the corresponding shift.
-     */
-    linkShiftsToLayoutEvents(layoutShifts: Types.Events.LayoutShift[], modelData: ParsedTrace): void;
-    /**
-     * Given a LayoutInvalidation trace event, determines if it was dispatched
-     * because a media element without dimensions was resized.
-     */
-    getUnsizedMediaRootCause(layoutInvalidation: Types.Events.LayoutInvalidationTracking, layoutInvalidationNodeId: Protocol.DOM.NodeId): Promise<UnsizedMedia | null>;
-    /**
-     * Given a LayoutInvalidation trace event, determines if it was dispatched
-     * because a node, which is an ancestor to an iframe, was injected.
-     */
-    getIframeRootCause(layoutInvalidation: Types.Events.LayoutInvalidationTracking, layoutInvalidationNodeId: Protocol.DOM.NodeId): Promise<InjectedIframe | null>;
-    getNodeDetails(nodeId: Protocol.DOM.NodeId): Promise<Protocol.DOM.Node | null>;
-    /**
-     * Given a layout invalidation event and a sorted array, returns the subset of requests that arrived within a
-     * 500ms window before the layout invalidation.
-     */
-    requestsInInvalidationWindow(layoutInvalidation: Types.Events.LayoutInvalidationTracking | Types.Events.ScheduleStyleInvalidationTracking, modelData: ParsedTrace): RootCauseRequest[];
-    /**
-     * Given a LayoutInvalidation trace event, determines if it was dispatched
-     * because fonts were changed and if so returns the information of all network
-     * request with which the fonts were possibly fetched, if any. The computed
-     * network requests are cached for the corresponding prepaint event, meaning
-     * that other LayoutInvalidation events that correspond to the same prepaint
-     * are not processed and the cached network requests for the prepaint is
-     * returned instead.
-     */
-    getFontChangeRootCause(layoutInvalidation: Types.Events.LayoutInvalidationTracking | Types.Events.ScheduleStyleInvalidationTracking, nextPrePaint: Types.Events.PrePaint, modelData: ParsedTrace): FontChange[] | null;
-    /**
-     * Given the requests that arrived within a 500ms window before the layout invalidation, returns the font
-     * requests of them.
-     */
-    getFontRequestsInInvalidationWindow(requestsInInvalidationWindow: RootCauseRequest[]): FontChange[];
-    /**
-     * Given a LayoutInvalidation trace event, determines if it arrived within a 500ms window before the layout
-     * invalidation and if so returns the information of all network request, if any. The computed network
-     * requests are cached for the corresponding prepaint event, meaning that other LayoutInvalidation events
-     * that correspond to the same prepaint are not processed and the cached network requests for the prepaint is
-     *  returned instead.
-     */
-    getRenderBlockRootCause(layoutInvalidation: Types.Events.LayoutInvalidationTracking | Types.Events.ScheduleStyleInvalidationTracking, nextPrePaint: Types.Events.PrePaint, modelData: ParsedTrace): RenderBlockingRequest[] | null;
-    /**
-     * Returns a function that retrieves the active value of a given
-     * CSS property within the matched styles of the param node.
-     * The first occurence within the matched styles is returned and the
-     * value is looked up in the following order, which follows CSS
-     * specificity:
-     * 1. Inline styles.
-     * 2. CSS rules matching this node, from all applicable stylesheets.
-     * 3. Attribute defined styles.
-     */
-    nodeMatchedStylesPropertyGetter(node: Protocol.DOM.Node): Promise<((property: string) => string | null)>;
-    /**
-     * Returns the CSS dimensions set to the node from its matched styles.
-     */
-    getNodeAuthoredDimensions(node: Protocol.DOM.Node): Promise<CSSDimensions>;
-}
-export {};