@paulirish/trace_engine 0.0.61 → 0.0.62

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

@@ -49,6 +49,7 @@ export interface Event {
     tdur?: Micro;
     dur?: Micro;
 }
+export declare function objectIsEvent(obj: object): obj is Event;
 export interface Args {
     data?: ArgsData;
     sampleTraceId?: number;
@@ -59,6 +60,8 @@ export interface ArgsData {
     sampleTraceId?: number;
     url?: string;
     navigationId?: string;
+    /** For soft navs. */
+    performanceTimelineNavigationId?: number;
     frame?: string;
 }
 export interface CallFrame {
@@ -104,6 +107,7 @@ export interface Profile extends Sample {
     args: Args & {
         data: ArgsData & {
             startTime: Micro;
+            source?: ProfileSource;
         };
     };
 }
@@ -114,7 +118,9 @@ export interface ProfileChunk extends Sample {
         data?: ArgsData & {
             cpuProfile?: PartialProfile;
             timeDeltas?: Micro[];
-            lines?: Micro[];
+            lines?: number[];
+            source?: ProfileSource;
+            columns?: number[];
         };
     };
 }
@@ -128,6 +134,18 @@ export interface PartialProfile {
      */
     trace_ids?: Record<string, number>;
 }
+/**
+ * Source of profile data, used to select the most relevant profile when
+ * multiple profiles exist for the same thread.
+ *
+ * - 'Inspector': User-initiated via console.profile()/profileEnd().
+ * - 'Internal': Browser-initiated during performance traces.
+ * - 'SelfProfiling': Page-initiated via JS Self-Profiling API.
+ *
+ * Selection priority (see PROFILE_SOURCES_BY_PRIORITY in SamplesHandler.ts).
+ */
+export type ProfileSource = 'Inspector' | 'SelfProfiling' | 'Internal';
+export declare const VALID_PROFILE_SOURCES: readonly ProfileSource[];
 export interface PartialNode {
     callFrame: CallFrame;
     id: CallFrameID;
@@ -511,7 +529,7 @@ export interface Mark extends Event {
     ph: Phase.MARK;
 }
 export interface NavigationStart extends Mark {
-    name: 'navigationStart';
+    name: Name.NAVIGATION_START;
     args: Args & {
         frame: string;
         data?: ArgsData & {
@@ -536,6 +554,24 @@ export interface NavigationStart extends Mark {
         };
     };
 }
+export interface SoftNavigationStart extends Event {
+    name: Name.SOFT_NAVIGATION_START;
+    ph: Phase.ASYNC_NESTABLE_INSTANT;
+    args: Args & {
+        frame: string;
+        context: {
+            softNavContextId: number;
+            URL: string;
+            timeOrigin: number;
+            domModifications: number;
+            firstContentfulPaint: number;
+            paintedArea: number;
+            performanceTimelineNavigationId: number;
+            repaintedArea: number;
+        };
+    };
+}
+export declare function isSoftNavigationStart(event: Event): event is SoftNavigationStart;
 export interface FirstContentfulPaint extends Mark {
     name: Name.MARK_FCP;
     args: Args & {
@@ -546,7 +582,7 @@ export interface FirstContentfulPaint extends Mark {
     };
 }
 export interface FirstPaint extends Mark {
-    name: 'firstPaint';
+    name: Name.MARK_FIRST_PAINT;
     args: Args & {
         frame: string;
         data?: ArgsData & {
@@ -554,11 +590,7 @@ export interface FirstPaint extends Mark {
         };
     };
 }
-export type PageLoadEvent = FirstContentfulPaint | MarkDOMContent | InteractiveTime | LargestContentfulPaintCandidate | LayoutShift | FirstPaint | MarkLoad | NavigationStart;
-export declare const MarkerName: readonly ["MarkDOMContent", "MarkLoad", "firstPaint", "firstContentfulPaint", "largestContentfulPaint::Candidate"];
-export interface MarkerEvent extends Event {
-    name: typeof MarkerName[number];
-}
+export type PageLoadEvent = FirstContentfulPaint | MarkDOMContent | InteractiveTime | AnyLargestContentfulPaintCandidate | LayoutShift | FirstPaint | MarkLoad | NavigationStart | SoftNavigationStart;
 export declare function isMarkerEvent(event: Event): event is MarkerEvent;
 export declare function eventIsPageLoadEvent(event: Event): event is PageLoadEvent;
 export interface LargestContentfulPaintCandidate extends Mark {
@@ -577,6 +609,23 @@ export interface LargestContentfulPaintCandidate extends Mark {
         };
     };
 }
+export interface LargestContentfulPaintCandidateForSoftNavigation extends Mark {
+    name: Name.MARK_LCP_CANDIDATE_FOR_SOFT_NAVIGATION;
+    args: Args & {
+        frame: string;
+        data?: ArgsData & {
+            candidateIndex: number;
+            isOutermostMainFrame: boolean;
+            isMainFrame: boolean;
+            nodeId: Protocol.DOM.BackendNodeId;
+            loadingAttr: string;
+            performanceTimelineNavigationId: number;
+            type?: string;
+            nodeName?: string;
+        };
+    };
+}
+export type AnyLargestContentfulPaintCandidate = LargestContentfulPaintCandidate | LargestContentfulPaintCandidateForSoftNavigation;
 export interface LargestImagePaintCandidate extends Mark {
     name: 'LargestImagePaint::Candidate';
     args: Args & {
@@ -697,7 +746,7 @@ export interface CommitLoad extends Instant {
     };
 }
 export interface MarkDOMContent extends Instant {
-    name: 'MarkDOMContent';
+    name: Name.MARK_DOM_CONTENT;
     args: Args & {
         data?: ArgsData & {
             frame: string;
@@ -708,7 +757,7 @@ export interface MarkDOMContent extends Instant {
     };
 }
 export interface MarkLoad extends Instant {
-    name: 'MarkLoad';
+    name: Name.MARK_LOAD;
     args: Args & {
         data?: ArgsData & {
             frame: string;
@@ -728,7 +777,7 @@ export interface TraceImpactedNode {
     old_rect: TraceRect;
     debug_name?: string;
 }
-type LayoutShiftData = ArgsData & {
+export type LayoutShiftData = ArgsData & {
     cumulative_score: number;
     frame_max_distance: number;
     had_recent_input: boolean;
@@ -781,7 +830,7 @@ export declare const NO_NAVIGATION = "NO_NAVIGATION";
  * portion of the trace for which we don't have any navigation event for (as it happeneded prior
  * to the trace start).
  */
-export type NavigationId = string | typeof NO_NAVIGATION;
+export type NavigationId = string;
 /**
  * This is a synthetic Layout shift cluster. The rawSourceEvent is the worst layout shift event
  * in the cluster.
@@ -1031,6 +1080,17 @@ export interface ParseMetaViewport extends Instant {
     };
 }
 export declare function isParseMetaViewport(event: Event): event is ParseMetaViewport;
+export type MetaCharsetDisposition = 'found-in-first-1024-bytes' | 'found-after-first-1024-bytes' | 'not-found';
+export interface MetaCharsetCheck extends Instant {
+    name: Name.META_CHARSET_CHECK;
+    args: Args & {
+        data: {
+            frame: string;
+            disposition: MetaCharsetDisposition;
+        };
+    };
+}
+export declare function isMetaCharsetCheck(event: Event): event is MetaCharsetCheck;
 export interface LinkPreconnect extends Instant {
     name: Name.LINK_PRECONNECT;
     args: Args & {
@@ -1414,6 +1474,7 @@ export interface SyntheticJSSample extends Event {
     };
     ph: Phase.INSTANT;
 }
+export declare function isJSSample(event: Event): event is SyntheticJSSample;
 export declare function isSyntheticInteraction(event: Event): event is SyntheticInteractionPair;
 export interface DrawFrame extends Instant {
     name: Name.DRAW_FRAME;
@@ -1649,7 +1710,8 @@ export declare function isSyntheticAnimation(event: Event): event is SyntheticAn
 export declare function isLayoutShift(event: Event): event is LayoutShift;
 export declare function isLayoutInvalidationTracking(event: Event): event is LayoutInvalidationTracking;
 export declare function isFirstContentfulPaint(event: Event): event is FirstContentfulPaint;
-export declare function isLargestContentfulPaintCandidate(event: Event): event is LargestContentfulPaintCandidate;
+export declare function isAnyLargestContentfulPaintCandidate(event: Event): event is AnyLargestContentfulPaintCandidate;
+export declare function isSoftLargestContentfulPaintCandidate(event: Event): event is AnyLargestContentfulPaintCandidate;
 export declare function isLargestImagePaintCandidate(event: Event): event is LargestImagePaintCandidate;
 export declare function isLargestTextPaintCandidate(event: Event): event is LargestTextPaintCandidate;
 export declare function isMarkLoad(event: Event): event is MarkLoad;
@@ -2014,7 +2076,7 @@ export interface FunctionCall extends Complete {
     args: Args & {
         data?: Partial<CallFrame> & {
             frame?: string;
-            isolate?: number;
+            isolate?: string;
         };
     };
 }
@@ -2175,6 +2237,7 @@ export declare enum Name {
     SELECTOR_STATS = "SelectorStats",
     BEGIN_COMMIT_COMPOSITOR_FRAME = "BeginCommitCompositorFrame",
     PARSE_META_VIEWPORT = "ParseMetaViewport",
+    META_CHARSET_CHECK = "MetaCharsetCheck",
     SCROLL_LAYER = "ScrollLayer",
     UPDATE_LAYER = "UpdateLayer",
     PAINT_SETUP = "PaintSetup",
@@ -2208,8 +2271,10 @@ export declare enum Name {
     MARK_FIRST_PAINT = "firstPaint",
     MARK_FCP = "firstContentfulPaint",
     MARK_LCP_CANDIDATE = "largestContentfulPaint::Candidate",
+    MARK_LCP_CANDIDATE_FOR_SOFT_NAVIGATION = "largestContentfulPaint::CandidateForSoftNavigation",
     MARK_LCP_INVALIDATE = "largestContentfulPaint::Invalidate",
     NAVIGATION_START = "navigationStart",
+    SOFT_NAVIGATION_START = "SoftNavigationStart",
     CONSOLE_TIME = "ConsoleTime",
     USER_TIMING = "UserTiming",
     INTERACTIVE_TIME = "InteractiveTime",
@@ -2262,7 +2327,12 @@ export declare enum Name {
     ANIMATION_FRAME_PRESENTATION = "AnimationFrame::Presentation",
     SYNTHETIC_NETWORK_REQUEST = "SyntheticNetworkRequest",
     USER_TIMING_MEASURE = "UserTiming::Measure",
-    LINK_PRECONNECT = "LinkPreconnect"
+    LINK_PRECONNECT = "LinkPreconnect",
+    PRELOAD_RENDER_BLOCKING_STATUS_CHANGE = "PreloadRenderBlockingStatusChange"
+}
+export declare const MarkerName: readonly [Name.MARK_DOM_CONTENT, Name.MARK_LOAD, Name.MARK_FIRST_PAINT, Name.MARK_FCP, Name.MARK_LCP_CANDIDATE, Name.MARK_LCP_CANDIDATE_FOR_SOFT_NAVIGATION, Name.NAVIGATION_START, Name.SOFT_NAVIGATION_START];
+export interface MarkerEvent extends Event {
+    name: typeof MarkerName[number];
 }
 /**
  * NOT AN EXHAUSTIVE LIST: just some categories we use and refer
@@ -2367,4 +2437,16 @@ export interface RundownScriptStub extends Event {
     };
 }
 export declare function isAnyScriptSourceEvent(event: Event): event is RundownScriptSource | RundownScriptSourceLarge | RundownScriptStub;
+export interface PreloadRenderBlockingStatusChangeEvent extends Instant {
+    name: Name.PRELOAD_RENDER_BLOCKING_STATUS_CHANGE;
+    cat: 'devtools.timeline';
+    args: Args & {
+        data: {
+            requestId: string;
+            url: string;
+            renderBlocking?: RenderBlocking;
+        };
+    };
+}
+export declare function isPreloadRenderBlockingStatusChangeEvent(event: Event): event is PreloadRenderBlockingStatusChangeEvent;
 export {};

package/models/trace/types/TraceEvents.js

@@ -55,6 +55,9 @@ export var Scope;
     Scope["PROCESS"] = "p";
     Scope["GLOBAL"] = "g";
 })(Scope || (Scope = {}));
+export function objectIsEvent(obj) {
+    return 'cat' in obj && 'name' in obj && 'ts' in obj;
+}
 export function objectIsCallFrame(object) {
     return ('functionName' in object && typeof object.functionName === 'string') &&
         ('scriptId' in object && (typeof object.scriptId === 'string' || typeof object.scriptId === 'number')) &&
@@ -62,6 +65,7 @@ export function objectIsCallFrame(object) {
         ('lineNumber' in object && typeof object.lineNumber === 'number') &&
         ('url' in object && typeof object.url === 'string');
 }
+export const VALID_PROFILE_SOURCES = ['Inspector', 'SelfProfiling', 'Internal'];
 export function isRunTask(event) {
     return event.name === Name.RUN_TASK && event.ph === Phase.COMPLETE;
 }
@@ -88,17 +92,20 @@ export function isLegacySyntheticScreenshot(event) {
 export function isScreenshot(event) {
     return event.name === Name.SCREENSHOT && 'source_id' in (event.args ?? {});
 }
+export function isSoftNavigationStart(event) {
+    return event.name === Name.SOFT_NAVIGATION_START;
+}
 const markerTypeGuards = [
     isMarkDOMContent,
     isMarkLoad,
     isFirstPaint,
     isFirstContentfulPaint,
-    isLargestContentfulPaintCandidate,
+    isAnyLargestContentfulPaintCandidate,
     isNavigationStart,
+    isSoftNavigationStart,
 ];
-export const MarkerName = ['MarkDOMContent', 'MarkLoad', 'firstPaint', 'firstContentfulPaint', 'largestContentfulPaint::Candidate'];
 export function isMarkerEvent(event) {
-    if (event.ph === Phase.INSTANT || event.ph === Phase.MARK) {
+    if (event.ph === Phase.INSTANT || Phase.ASYNC_NESTABLE_INSTANT || event.ph === Phase.MARK) {
         return markerTypeGuards.some(fn => fn(event));
     }
     return false;
@@ -108,7 +115,7 @@ const pageLoadEventTypeGuards = [
     isInteractiveTime,
 ];
 export function eventIsPageLoadEvent(event) {
-    if (event.ph === Phase.INSTANT || event.ph === Phase.MARK) {
+    if (event.ph === Phase.INSTANT || Phase.ASYNC_NESTABLE_INSTANT || event.ph === Phase.MARK) {
         return pageLoadEventTypeGuards.some(fn => fn(event));
     }
     return false;
@@ -148,6 +155,9 @@ export function isBeginCommitCompositorFrame(event) {
 export function isParseMetaViewport(event) {
     return event.name === Name.PARSE_META_VIEWPORT;
 }
+export function isMetaCharsetCheck(event) {
+    return event.name === Name.META_CHARSET_CHECK;
+}
 export function isLinkPreconnect(event) {
     return event.name === Name.LINK_PRECONNECT;
 }
@@ -184,6 +194,9 @@ export function isPipelineReporter(event) {
 export function isSyntheticBased(event) {
     return 'rawSourceEvent' in event;
 }
+export function isJSSample(event) {
+    return event.name === Name.JS_SAMPLE;
+}
 export function isSyntheticInteraction(event) {
     return Boolean('interactionId' in event && event.args?.data && 'beginEvent' in event.args.data && 'endEvent' in event.args.data);
 }
@@ -356,10 +369,13 @@ export function isLayoutInvalidationTracking(event) {
     return event.name === Name.LAYOUT_INVALIDATION_TRACKING;
 }
 export function isFirstContentfulPaint(event) {
-    return event.name === 'firstContentfulPaint';
+    return event.name === Name.MARK_FCP;
 }
-export function isLargestContentfulPaintCandidate(event) {
-    return event.name === Name.MARK_LCP_CANDIDATE;
+export function isAnyLargestContentfulPaintCandidate(event) {
+    return event.name === Name.MARK_LCP_CANDIDATE || event.name === Name.MARK_LCP_CANDIDATE_FOR_SOFT_NAVIGATION;
+}
+export function isSoftLargestContentfulPaintCandidate(event) {
+    return event.name === Name.MARK_LCP_CANDIDATE_FOR_SOFT_NAVIGATION;
 }
 export function isLargestImagePaintCandidate(event) {
     return event.name === 'LargestImagePaint::Candidate';
@@ -368,13 +384,13 @@ export function isLargestTextPaintCandidate(event) {
     return event.name === 'LargestTextPaint::Candidate';
 }
 export function isMarkLoad(event) {
-    return event.name === 'MarkLoad';
+    return event.name === Name.MARK_LOAD;
 }
 export function isFirstPaint(event) {
-    return event.name === 'firstPaint';
+    return event.name === Name.MARK_FIRST_PAINT;
 }
 export function isMarkDOMContent(event) {
-    return event.name === 'MarkDOMContent';
+    return event.name === Name.MARK_DOM_CONTENT;
 }
 export function isInteractiveTime(event) {
     return event.name === 'InteractiveTime';
@@ -440,7 +456,7 @@ export function isPrePaint(event) {
 }
 /** A VALID navigation start (as it has a populated documentLoaderURL) */
 export function isNavigationStart(event) {
-    return event.name === 'navigationStart' && event.args?.data?.documentLoaderURL !== '';
+    return event.name === Name.NAVIGATION_START && event.args?.data?.documentLoaderURL !== '';
 }
 export function isDidCommitSameDocumentNavigation(event) {
     return event.name === 'RenderFrameHostImpl::DidCommitSameDocumentNavigation' && event.ph === Phase.COMPLETE;
@@ -723,6 +739,7 @@ export var Name;
     Name["SELECTOR_STATS"] = "SelectorStats";
     Name["BEGIN_COMMIT_COMPOSITOR_FRAME"] = "BeginCommitCompositorFrame";
     Name["PARSE_META_VIEWPORT"] = "ParseMetaViewport";
+    Name["META_CHARSET_CHECK"] = "MetaCharsetCheck";
     /* Paint */
     Name["SCROLL_LAYER"] = "ScrollLayer";
     Name["UPDATE_LAYER"] = "UpdateLayer";
@@ -762,8 +779,10 @@ export var Name;
     Name["MARK_FIRST_PAINT"] = "firstPaint";
     Name["MARK_FCP"] = "firstContentfulPaint";
     Name["MARK_LCP_CANDIDATE"] = "largestContentfulPaint::Candidate";
+    Name["MARK_LCP_CANDIDATE_FOR_SOFT_NAVIGATION"] = "largestContentfulPaint::CandidateForSoftNavigation";
     Name["MARK_LCP_INVALIDATE"] = "largestContentfulPaint::Invalidate";
     Name["NAVIGATION_START"] = "navigationStart";
+    Name["SOFT_NAVIGATION_START"] = "SoftNavigationStart";
     Name["CONSOLE_TIME"] = "ConsoleTime";
     Name["USER_TIMING"] = "UserTiming";
     Name["INTERACTIVE_TIME"] = "InteractiveTime";
@@ -822,7 +841,18 @@ export var Name;
     Name["SYNTHETIC_NETWORK_REQUEST"] = "SyntheticNetworkRequest";
     Name["USER_TIMING_MEASURE"] = "UserTiming::Measure";
     Name["LINK_PRECONNECT"] = "LinkPreconnect";
+    Name["PRELOAD_RENDER_BLOCKING_STATUS_CHANGE"] = "PreloadRenderBlockingStatusChange";
 })(Name || (Name = {}));
+export const MarkerName = [
+    Name.MARK_DOM_CONTENT,
+    Name.MARK_LOAD,
+    Name.MARK_FIRST_PAINT,
+    Name.MARK_FCP,
+    Name.MARK_LCP_CANDIDATE,
+    Name.MARK_LCP_CANDIDATE_FOR_SOFT_NAVIGATION,
+    Name.NAVIGATION_START,
+    Name.SOFT_NAVIGATION_START,
+];
 /**
  * NOT AN EXHAUSTIVE LIST: just some categories we use and refer
  * to in multiple places.
@@ -850,4 +880,7 @@ export function isRundownScriptSourceLarge(event) {
 export function isAnyScriptSourceEvent(event) {
     return event.cat === 'disabled-by-default-devtools.v8-source-rundown-sources';
 }
+export function isPreloadRenderBlockingStatusChangeEvent(event) {
+    return event.name === Name.PRELOAD_RENDER_BLOCKING_STATUS_CHANGE;
+}
 //# sourceMappingURL=TraceEvents.js.map