devtools-tracing 1.2.0 → 1.2.2

package/dist/lib/front_end/models/cpu_profile/CPUProfileDataModel.d.ts

@@ -0,0 +1,104 @@
+import type * as Protocol from '../../generated/protocol.js';
+import { ProfileNode, ProfileTreeModel } from './ProfileTreeModel.js';
+export declare class CPUProfileNode extends ProfileNode {
+    id: number;
+    self: number;
+    positionTicks: Protocol.Profiler.PositionTickInfo[] | undefined;
+    deoptReason: string | null;
+    constructor(node: Protocol.Profiler.ProfileNode, samplingInterval: number);
+}
+export declare class CPUProfileDataModel extends ProfileTreeModel {
+    #private;
+    profileStartTime: number;
+    profileEndTime: number;
+    timestamps: number[];
+    samples: number[] | undefined;
+    /**
+     * Contains trace ids assigned to samples, if any. Trace ids are
+     * keyed by the sample index in the profile. These are only created
+     * for CPU profiles coming from traces.
+     */
+    traceIds?: Record<string, number>;
+    /**
+     * Each item in the `lines` array contains the script line executing
+     * when the sample in that array position was taken.
+     */
+    lines?: number[];
+    /**
+     * Same as `lines` above, but with the script column.
+     */
+    columns?: number[];
+    totalHitCount: number;
+    profileHead: CPUProfileNode;
+    gcNode?: ProfileNode;
+    programNode?: ProfileNode;
+    idleNode?: ProfileNode;
+    constructor(profile: ExtendedProfile);
+    private compatibilityConversionHeadToNodes;
+    /**
+     * Calculate timestamps using timeDeltas. Some CPU profile formats,
+     * like the ones contained in traces have timeDeltas instead of
+     * timestamps.
+     */
+    private convertTimeDeltas;
+    /**
+     * Creates a Tree of CPUProfileNodes using the Protocol.Profiler.ProfileNodes.
+     * As the tree is built, samples of native code (prefixed with "native ") are
+     * filtered out. Samples of filtered nodes are replaced with the parent of the
+     * node being filtered.
+     *
+     * This function supports legacy and new definitions of the CDP Profiler.Profile
+     * type.
+     */
+    private translateProfileTree;
+    /**
+     * Sorts the samples array using the timestamps array (there is a one
+     * to one matching by index between the two).
+     */
+    private sortSamples;
+    /**
+     * Fills in timestamps and/or time deltas from legacy profiles where
+     * they could be missing.
+     */
+    private normalizeTimestamps;
+    /**
+     * Some nodes do not refer to JS samples but to V8 system tasks, AKA
+     * "meta" nodes. This function extracts those nodes from the profile.
+     */
+    private extractMetaNodes;
+    private fixMissingSamples;
+    /**
+     * Traverses the call tree derived from the samples calling back when a call is opened
+     * and when it's closed
+     */
+    forEachFrame(openFrameCallback: (depth: number, node: ProfileNode, sampleIndex: number, timestamp: number) => void, closeFrameCallback: (depth: number, node: ProfileNode, sampleIndex: number, timestamp: number, dur: number, selfTime: number) => void, startTime?: number, stopTime?: number): void;
+    /**
+     * Returns the node that corresponds to a given index of a sample.
+     */
+    nodeByIndex(index: number): ProfileNode | null;
+    /**
+     * Returns the node that corresponds to a given node id.
+     */
+    nodeById(nodeId: number): ProfileNode | null;
+    nodes(): ProfileNode[] | null;
+}
+/** Format used by profiles coming from traces. **/
+export type ExtendedProfileNode = Protocol.Profiler.ProfileNode & {
+    parent?: number;
+};
+export type ExtendedProfile = Protocol.Profiler.Profile & {
+    nodes: Protocol.Profiler.ProfileNode[] | ExtendedProfileNode[];
+    lines?: number[];
+    columns?: number[];
+    /**
+     * A sample can be manually collected with v8::CpuProfiler::collectSample.
+     * When this is done an id (trace id) can be passed to the API to
+     * identify the collected sample in the resulting CPU profile. We
+     * do this for several trace events, to efficiently calculate their
+     * stack trace and improve the JS flamechart we build.
+     *
+     * This property, only present if there's any trace id provided within profileChunks,
+     * contains the mapping of the trace ids with the shape traceId -> nodeId.
+     */
+    traceIds?: Record<string, number>;
+};

package/dist/lib/front_end/models/cpu_profile/ProfileTreeModel.d.ts

@@ -0,0 +1,29 @@
+import type * as Platform from '../../core/platform/platform.js';
+import type * as Protocol from '../../generated/protocol.js';
+export declare class ProfileNode {
+    callFrame: Protocol.Runtime.CallFrame;
+    callUID: string;
+    self: number;
+    total: number;
+    id: number;
+    parent: ProfileNode | null;
+    children: this[];
+    originalFunctionName: string | null;
+    depth: number;
+    deoptReason: string | null;
+    constructor(callFrame: Protocol.Runtime.CallFrame);
+    get scriptId(): Protocol.Runtime.ScriptId;
+    get url(): Platform.DevToolsPath.UrlString;
+    get lineNumber(): number;
+    get columnNumber(): number;
+    get functionName(): string;
+    setOriginalFunctionName(name: string | null): void;
+}
+export declare class ProfileTreeModel {
+    root: ProfileNode;
+    total: number;
+    maxDepth: number;
+    initialize(root: ProfileNode): void;
+    private assignDepthsAndParents;
+    private calculateTotals;
+}

package/dist/lib/front_end/models/cpu_profile/cpu_profile.d.ts

@@ -0,0 +1,3 @@
+import * as CPUProfileDataModel from './CPUProfileDataModel.js';
+import * as ProfileTreeModel from './ProfileTreeModel.js';
+export { CPUProfileDataModel, ProfileTreeModel, };

package/dist/lib/front_end/models/crux-manager/CrUXManager.d.ts

@@ -0,0 +1,104 @@
+import * as Common from '../../core/common/common.js';
+export type StandardMetricNames = 'cumulative_layout_shift' | 'first_contentful_paint' | 'first_input_delay' | 'interaction_to_next_paint' | 'largest_contentful_paint' | 'experimental_time_to_first_byte' | 'round_trip_time' | 'largest_contentful_paint_image_time_to_first_byte' | 'largest_contentful_paint_image_resource_load_delay' | 'largest_contentful_paint_image_resource_load_duration' | 'largest_contentful_paint_image_element_render_delay';
+export type MetricNames = StandardMetricNames | 'form_factors';
+export type FormFactor = 'DESKTOP' | 'PHONE' | 'TABLET';
+export type DeviceScope = FormFactor | 'ALL';
+export type DeviceOption = DeviceScope | 'AUTO';
+export type PageScope = 'url' | 'origin';
+export interface Scope {
+    pageScope: PageScope;
+    deviceScope: DeviceScope;
+}
+export type ConnectionType = 'offline' | 'slow-2G' | '2G' | '3G' | '4G';
+export interface CrUXRequest {
+    effectiveConnectionType?: ConnectionType;
+    formFactor?: FormFactor;
+    metrics?: MetricNames[];
+    origin?: string;
+    url?: string;
+}
+export interface MetricResponse {
+    histogram?: Array<{
+        start: number;
+        end?: number;
+        density?: number;
+    }>;
+    percentiles?: {
+        p75: number | string;
+    };
+}
+export interface FormFactorsResponse {
+    fractions?: {
+        desktop: number;
+        phone: number;
+        tablet: number;
+    };
+}
+interface CollectionDate {
+    year: number;
+    month: number;
+    day: number;
+}
+interface CrUXRecord {
+    key: Omit<CrUXRequest, 'metrics'>;
+    metrics: Partial<Record<StandardMetricNames, MetricResponse>> & {
+        form_factors?: FormFactorsResponse;
+    };
+    collectionPeriod: {
+        firstDate: CollectionDate;
+        lastDate: CollectionDate;
+    };
+}
+export interface CrUXResponse {
+    record: CrUXRecord;
+    urlNormalizationDetails?: {
+        originalUrl: string;
+        normalizedUrl: string;
+    };
+}
+export type PageResult = Record<`${PageScope}-${DeviceScope}`, CrUXResponse | null> & {
+    warnings: string[];
+    normalizedUrl: string;
+};
+export interface OriginMapping {
+    developmentOrigin: string;
+    productionOrigin: string;
+}
+export interface ConfigSetting {
+    enabled: boolean;
+    override?: string;
+    overrideEnabled?: boolean;
+    originMappings?: OriginMapping[];
+}
+/** TODO: Potentially support `TABLET`. Tablet field data will always be `null` until then. **/
+export declare const DEVICE_SCOPE_LIST: DeviceScope[];
+export declare class CrUXManager extends Common.ObjectWrapper.ObjectWrapper<EventTypes> {
+    #private;
+    fieldDeviceOption: DeviceOption;
+    fieldPageScope: PageScope;
+    private constructor();
+    static instance(opts?: {
+        forceNew: boolean | null;
+    }): CrUXManager;
+    /** The most recent page result from the CrUX service. */
+    get pageResult(): PageResult | undefined;
+    getConfigSetting(): Common.Settings.Setting<ConfigSetting>;
+    isEnabled(): boolean;
+    getFieldDataForPage(pageUrl: string): Promise<PageResult>;
+    getFieldDataForCurrentPageForTesting(): Promise<PageResult>;
+    refresh(): Promise<void>;
+    resolveDeviceOptionToScope(option: DeviceOption): DeviceScope;
+    getSelectedDeviceScope(): DeviceScope;
+    getSelectedScope(): Scope;
+    getSelectedFieldResponse(): CrUXResponse | null | undefined;
+    getSelectedFieldMetricData(fieldMetric: StandardMetricNames): MetricResponse | undefined;
+    getFieldResponse(pageScope: PageScope, deviceScope: DeviceScope): CrUXResponse | null | undefined;
+    setEndpointForTesting(endpoint: string): void;
+}
+export declare const enum Events {
+    FIELD_DATA_CHANGED = "field-data-changed"
+}
+interface EventTypes {
+    [Events.FIELD_DATA_CHANGED]: PageResult | undefined;
+}
+export {};

package/dist/lib/front_end/models/crux-manager/crux-manager.d.ts

@@ -0,0 +1 @@
+export * from './CrUXManager.js';

package/dist/lib/front_end/models/emulation/DeviceModeModel.d.ts

@@ -0,0 +1,135 @@
+import * as Common from '../../core/common/common.js';
+import * as SDK from '../../core/sdk/sdk.js';
+import * as Protocol from '../../generated/protocol.js';
+import * as Geometry from '../geometry/geometry.js';
+import { type EmulatedDevice, type Mode } from './EmulatedDevices.js';
+export declare class DeviceModeModel extends Common.ObjectWrapper.ObjectWrapper<EventTypes> implements SDK.TargetManager.SDKModelObserver<SDK.EmulationModel.EmulationModel> {
+    #private;
+    private constructor();
+    static instance(opts?: {
+        forceNew: boolean;
+    }): DeviceModeModel;
+    /**
+     * This wraps `instance()` in a try/catch because in some DevTools entry points
+     * (such as worker_app.ts) the Emulation panel is not included and as such
+     * the below code fails; it tries to instantiate the model which requires
+     * reading the value of a setting which has not been registered.
+     * See crbug.com/361515458 for an example bug that this resolves.
+     */
+    static tryInstance(opts?: {
+        forceNew: boolean;
+    }): DeviceModeModel | null;
+    static widthValidator(value: string): {
+        valid: boolean;
+        errorMessage: (string | undefined);
+    };
+    static heightValidator(value: string): {
+        valid: boolean;
+        errorMessage: (string | undefined);
+    };
+    static scaleValidator(value: string): {
+        valid: boolean;
+        errorMessage: (string | undefined);
+    };
+    get scaleSettingInternal(): Common.Settings.Setting<number>;
+    setAvailableSize(availableSize: Geometry.Size, preferredSize: Geometry.Size): void;
+    emulate(type: Type, device: EmulatedDevice | null, mode: Mode | null, scale?: number): void;
+    setWidth(width: number): void;
+    setWidthAndScaleToFit(width: number): void;
+    setHeight(height: number): void;
+    setHeightAndScaleToFit(height: number): void;
+    setScale(scale: number): void;
+    device(): EmulatedDevice | null;
+    mode(): Mode | null;
+    type(): Type;
+    screenImage(): string;
+    outlineImage(): string;
+    outlineRect(): Rect | null;
+    screenRect(): Rect;
+    visiblePageRect(): Rect;
+    scale(): number;
+    fitScale(): number;
+    appliedDeviceSize(): Geometry.Size;
+    appliedDeviceScaleFactor(): number;
+    appliedUserAgentType(): UA;
+    isFullHeight(): boolean;
+    isMobile(): boolean;
+    enabledSetting(): Common.Settings.Setting<boolean>;
+    scaleSetting(): Common.Settings.Setting<number>;
+    uaSetting(): Common.Settings.Setting<UA>;
+    deviceScaleFactorSetting(): Common.Settings.Setting<number>;
+    deviceOutlineSetting(): Common.Settings.Setting<boolean>;
+    toolbarControlsEnabledSetting(): Common.Settings.Setting<boolean>;
+    reset(): void;
+    modelAdded(emulationModel: SDK.EmulationModel.EmulationModel): void;
+    modelRemoved(emulationModel: SDK.EmulationModel.EmulationModel): void;
+    inspectedURL(): string | null;
+    private onFrameChange;
+    private onScreenOrientationLockChanged;
+    private applyOrientationLock;
+    isScreenOrientationLocked(): boolean;
+    private scaleSettingChanged;
+    private widthSettingChanged;
+    private heightSettingChanged;
+    private uaSettingChanged;
+    private deviceScaleFactorSettingChanged;
+    private deviceOutlineSettingChanged;
+    private preferredScaledWidth;
+    private preferredScaledHeight;
+    private currentOutline;
+    private currentInsets;
+    private getScreenOrientationType;
+    private calculateAndEmulate;
+    private calculateFitScale;
+    setSizeAndScaleToFit(width: number, height: number): void;
+    private applyUserAgent;
+    private applyDeviceMetrics;
+    exitHingeMode(): void;
+    captureScreenshot(fullSize: boolean, clip?: Protocol.Page.Viewport): Promise<string | null>;
+    private applyTouch;
+    private showHingeIfApplicable;
+    private getDisplayFeatureOrientation;
+    private getDisplayFeature;
+}
+export declare class Insets {
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+    constructor(left: number, top: number, right: number, bottom: number);
+    isEqual(insets: Insets | null): boolean;
+}
+export declare class Rect {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    constructor(left: number, top: number, width: number, height: number);
+    isEqual(rect: Rect | null): boolean;
+    scale(scale: number): Rect;
+    relativeTo(origin: Rect): Rect;
+    rebaseTo(origin: Rect): Rect;
+}
+export declare const enum Events {
+    UPDATED = "Updated"
+}
+export interface EventTypes {
+    [Events.UPDATED]: void;
+}
+export declare enum Type {
+    None = "None",
+    Responsive = "Responsive",
+    Device = "Device"
+}
+export declare const enum UA {
+    MOBILE = "Mobile",
+    MOBILE_NO_TOUCH = "Mobile (no touch)",
+    DESKTOP = "Desktop",
+    DESKTOP_TOUCH = "Desktop (touch)"
+}
+export declare const MinDeviceSize = 50;
+export declare const MaxDeviceSize = 9999;
+export declare const MinDeviceScaleFactor = 0;
+export declare const MaxDeviceScaleFactor = 10;
+export declare const MaxDeviceNameLength = 50;
+export declare const defaultMobileScaleFactor = 2;