@paulirish/trace_engine 0.0.36 → 0.0.37

package/models/trace/extras/TimelineJSProfile.d.ts

@@ -0,0 +1,13 @@
+import type * as Protocol from '../../../generated/protocol.js';
+import * as Types from '../types/types.js';
+export declare class TimelineJSProfileProcessor {
+    static isNativeRuntimeFrame(frame: Protocol.Runtime.CallFrame): boolean;
+    static nativeGroup(nativeName: string): string | null;
+    static createFakeTraceFromCpuProfile(profile: Protocol.Profiler.Profile, tid: Types.Events.ThreadID): Types.Events.Event[];
+}
+export declare namespace TimelineJSProfileProcessor {
+    const enum NativeGroups {
+        COMPILE = "Compile",
+        PARSE = "Parse"
+    }
+}

package/models/trace/extras/TimelineJSProfile.js

@@ -0,0 +1,55 @@
+// Copyright 2014 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 Types from '../types/types.js';
+// TODO(paulirish): Delete this file.
+//   - Move isNativeRuntimeFrame and nativeGroup to TraceEvents.d.ts (or TraceTree)
+//   - Move createFakeTraceFromCpuProfile to TimelineLoader
+export class TimelineJSProfileProcessor {
+    static isNativeRuntimeFrame(frame) {
+        return frame.url === 'native V8Runtime';
+    }
+    static nativeGroup(nativeName) {
+        if (nativeName.startsWith('Parse')) {
+            return "Parse" /* TimelineJSProfileProcessor.NativeGroups.PARSE */;
+        }
+        if (nativeName.startsWith('Compile') || nativeName.startsWith('Recompile')) {
+            return "Compile" /* TimelineJSProfileProcessor.NativeGroups.COMPILE */;
+        }
+        return null;
+    }
+    static createFakeTraceFromCpuProfile(profile, tid) {
+        const events = [];
+        const threadName = `Thread ${tid}`;
+        appendEvent('TracingStartedInPage', { data: { sessionId: '1' } }, 0, 0, "M" /* Types.Events.Phase.METADATA */);
+        appendEvent("thread_name" /* Types.Events.Name.THREAD_NAME */, { name: threadName }, 0, 0, "M" /* Types.Events.Phase.METADATA */, '__metadata');
+        if (!profile) {
+            return events;
+        }
+        // Append a root to show the start time of the profile (which is earlier than first sample), so the Performance
+        // panel won't truncate this time period.
+        // 'JSRoot' doesn't exist in the new engine and is not the name of an actual trace event, but changing it might break other trace processing tools that rely on this, so we stick with this name.
+        // TODO(crbug.com/341234884): consider removing this or clarify why it's required.
+        appendEvent('JSRoot', {}, profile.startTime, profile.endTime - profile.startTime, "X" /* Types.Events.Phase.COMPLETE */, 'toplevel');
+        // TODO: create a `Profile` event instead, as `cpuProfile` is legacy
+        appendEvent('CpuProfile', { data: { cpuProfile: profile } }, profile.endTime, 0, "X" /* Types.Events.Phase.COMPLETE */);
+        return events;
+        function appendEvent(name, args, ts, dur, ph, cat) {
+            const event = {
+                cat: cat || 'disabled-by-default-devtools.timeline',
+                name,
+                ph: ph || "X" /* Types.Events.Phase.COMPLETE */,
+                pid: Types.Events.ProcessID(1),
+                tid,
+                ts: Types.Timing.MicroSeconds(ts),
+                args,
+            };
+            if (dur) {
+                event.dur = Types.Timing.MicroSeconds(dur);
+            }
+            events.push(event);
+            return event;
+        }
+    }
+}
+//# sourceMappingURL=TimelineJSProfile.js.map

package/models/trace/extras/TimelineJSProfile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimelineJSProfile.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/extras/TimelineJSProfile.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAK7B,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAE3C,qCAAqC;AACrC,mFAAmF;AACnF,2DAA2D;AAC3D,MAAM,OAAO,0BAA0B;IACrC,MAAM,CAAC,oBAAoB,CAAC,KAAiC;QAC3D,OAAO,KAAK,CAAC,GAAG,KAAK,kBAAkB,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,UAAkB;QACnC,IAAI,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACnC,mEAAqD;QACvD,CAAC;QACD,IAAI,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3E,uEAAuD;QACzD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,6BAA6B,CAAC,OAAkC,EAAE,GAA0B;QAEjG,MAAM,MAAM,GAAyB,EAAE,CAAC;QAExC,MAAM,UAAU,GAAG,UAAU,GAAG,EAAE,CAAC;QACnC,WAAW,CAAC,sBAAsB,EAAE,EAAC,IAAI,EAAE,EAAC,SAAS,EAAE,GAAG,EAAC,EAAC,EAAE,CAAC,EAAE,CAAC,wCAA8B,CAAC;QACjG,WAAW,oDAAgC,EAAC,IAAI,EAAE,UAAU,EAAC,EAAE,CAAC,EAAE,CAAC,yCAA+B,YAAY,CAAC,CAAC;QAChH,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,+GAA+G;QAC/G,yCAAyC;QACzC,iMAAiM;QACjM,kFAAkF;QAClF,WAAW,CACP,QAAQ,EAAE,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,SAAS,yCAA+B,UAAU,CAAC,CAAC;QAEnH,oEAAoE;QACpE,WAAW,CAAC,YAAY,EAAE,EAAC,IAAI,EAAE,EAAC,UAAU,EAAE,OAAO,EAAC,EAAC,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,wCAA8B,CAAC;QAC1G,OAAO,MAAM,CAAC;QAEd,SAAS,WAAW,CAChB,IAAY,EAAE,IAAS,EAAE,EAAU,EAAE,GAAY,EAAE,EAAuB,EAAE,GAAY;YAC1F,MAAM,KAAK,GAAuB;gBAChC,GAAG,EAAE,GAAG,IAAI,uCAAuC;gBACnD,IAAI;gBACJ,EAAE,EAAE,EAAE,yCAA+B;gBACrC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC9B,GAAG;gBACH,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBACjC,IAAI;aACL,CAAC;YAEF,IAAI,GAAG,EAAE,CAAC;gBACR,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YAC7C,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;CACF","sourcesContent":["// Copyright 2014 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/* eslint-disable @typescript-eslint/no-explicit-any */\n\nimport type * as Protocol from '../../../generated/protocol.js';\nimport * as Types from '../types/types.js';\n\n// TODO(paulirish): Delete this file.\n//   - Move isNativeRuntimeFrame and nativeGroup to TraceEvents.d.ts (or TraceTree)\n//   - Move createFakeTraceFromCpuProfile to TimelineLoader\nexport class TimelineJSProfileProcessor {\n  static isNativeRuntimeFrame(frame: Protocol.Runtime.CallFrame): boolean {\n    return frame.url === 'native V8Runtime';\n  }\n\n  static nativeGroup(nativeName: string): string|null {\n    if (nativeName.startsWith('Parse')) {\n      return TimelineJSProfileProcessor.NativeGroups.PARSE;\n    }\n    if (nativeName.startsWith('Compile') || nativeName.startsWith('Recompile')) {\n      return TimelineJSProfileProcessor.NativeGroups.COMPILE;\n    }\n    return null;\n  }\n\n  static createFakeTraceFromCpuProfile(profile: Protocol.Profiler.Profile, tid: Types.Events.ThreadID):\n      Types.Events.Event[] {\n    const events: Types.Events.Event[] = [];\n\n    const threadName = `Thread ${tid}`;\n    appendEvent('TracingStartedInPage', {data: {sessionId: '1'}}, 0, 0, Types.Events.Phase.METADATA);\n    appendEvent(Types.Events.Name.THREAD_NAME, {name: threadName}, 0, 0, Types.Events.Phase.METADATA, '__metadata');\n    if (!profile) {\n      return events;\n    }\n\n    // Append a root to show the start time of the profile (which is earlier than first sample), so the Performance\n    // panel won't truncate this time period.\n    // 'JSRoot' doesn't exist in the new engine and is not the name of an actual trace event, but changing it might break other trace processing tools that rely on this, so we stick with this name.\n    // TODO(crbug.com/341234884): consider removing this or clarify why it's required.\n    appendEvent(\n        'JSRoot', {}, profile.startTime, profile.endTime - profile.startTime, Types.Events.Phase.COMPLETE, 'toplevel');\n\n    // TODO: create a `Profile` event instead, as `cpuProfile` is legacy\n    appendEvent('CpuProfile', {data: {cpuProfile: profile}}, profile.endTime, 0, Types.Events.Phase.COMPLETE);\n    return events;\n\n    function appendEvent(\n        name: string, args: any, ts: number, dur?: number, ph?: Types.Events.Phase, cat?: string): Types.Events.Event {\n      const event: Types.Events.Event = {\n        cat: cat || 'disabled-by-default-devtools.timeline',\n        name,\n        ph: ph || Types.Events.Phase.COMPLETE,\n        pid: Types.Events.ProcessID(1),\n        tid,\n        ts: Types.Timing.MicroSeconds(ts),\n        args,\n      };\n\n      if (dur) {\n        event.dur = Types.Timing.MicroSeconds(dur);\n      }\n      events.push(event);\n      return event;\n    }\n  }\n}\n\nexport namespace TimelineJSProfileProcessor {\n  export const enum NativeGroups {\n    COMPILE = 'Compile',\n    PARSE = 'Parse',\n  }\n}\n"]}

package/models/trace/extras/TraceFilter.d.ts

@@ -0,0 +1,21 @@
+import type * as Handlers from '../handlers/handlers.js';
+import * as Types from '../types/types.js';
+export declare abstract class TraceFilter {
+    abstract accept(_event: Types.Events.Event, parsedTrace?: Handlers.Types.ParsedTrace): boolean;
+}
+export declare class VisibleEventsFilter extends TraceFilter {
+    private readonly visibleTypes;
+    constructor(visibleTypes: string[]);
+    accept(event: Types.Events.Event): boolean;
+    static eventType(event: Types.Events.Event): Types.Events.Name;
+}
+export declare class InvisibleEventsFilter extends TraceFilter {
+    #private;
+    constructor(invisibleTypes: Types.Events.Name[]);
+    accept(event: Types.Events.Event): boolean;
+}
+export declare class ExclusiveNameFilter extends TraceFilter {
+    #private;
+    constructor(excludeNames: Types.Events.Name[]);
+    accept(event: Types.Events.Event): boolean;
+}

package/models/trace/extras/TraceFilter.js

@@ -0,0 +1,51 @@
+// Copyright 2017 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 Types from '../types/types.js';
+export class TraceFilter {
+}
+export class VisibleEventsFilter extends TraceFilter {
+    visibleTypes;
+    constructor(visibleTypes) {
+        super();
+        this.visibleTypes = new Set(visibleTypes);
+    }
+    accept(event) {
+        if (Types.Extensions.isSyntheticExtensionEntry(event)) {
+            return true;
+        }
+        return this.visibleTypes.has(VisibleEventsFilter.eventType(event));
+    }
+    static eventType(event) {
+        // Any blink.console category events are treated as ConsoleTime events
+        if (event.cat.includes('blink.console')) {
+            return "ConsoleTime" /* Types.Events.Name.CONSOLE_TIME */;
+        }
+        // Any blink.user_timing egory events are treated as UserTiming events
+        if (event.cat.includes('blink.user_timing')) {
+            return "UserTiming" /* Types.Events.Name.USER_TIMING */;
+        }
+        return event.name;
+    }
+}
+export class InvisibleEventsFilter extends TraceFilter {
+    #invisibleTypes;
+    constructor(invisibleTypes) {
+        super();
+        this.#invisibleTypes = new Set(invisibleTypes);
+    }
+    accept(event) {
+        return !this.#invisibleTypes.has(VisibleEventsFilter.eventType(event));
+    }
+}
+export class ExclusiveNameFilter extends TraceFilter {
+    #excludeNames;
+    constructor(excludeNames) {
+        super();
+        this.#excludeNames = new Set(excludeNames);
+    }
+    accept(event) {
+        return !this.#excludeNames.has(event.name);
+    }
+}
+//# sourceMappingURL=TraceFilter.js.map

package/models/trace/extras/TraceFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TraceFilter.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/extras/TraceFilter.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAG7B,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAE3C,MAAM,OAAgB,WAAW;CAEhC;AAED,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IACjC,YAAY,CAAc;IAC3C,YAAY,YAAsB;QAChC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,YAAY,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,KAAyB;QAC9B,IAAI,KAAK,CAAC,UAAU,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC;YACtD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,KAAyB;QACxC,sEAAsE;QACtE,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YACxC,0DAAsC;QACxC,CAAC;QACD,sEAAsE;QACtE,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAC5C,wDAAqC;QACvC,CAAC;QACD,OAAO,KAAK,CAAC,IAAyB,CAAC;IACzC,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IACpD,eAAe,CAAyB;IAExC,YAAY,cAAmC;QAC7C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,eAAe,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,CAAC,KAAyB;QAC9B,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,mBAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACzE,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAClD,aAAa,CAAyB;IACtC,YAAY,YAAiC;QAC3C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,CAAC,KAAyB;QAC9B,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,IAAyB,CAAC,CAAC;IAClE,CAAC;CACF","sourcesContent":["// Copyright 2017 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 Handlers from '../handlers/handlers.js';\nimport * as Types from '../types/types.js';\n\nexport abstract class TraceFilter {\n  abstract accept(_event: Types.Events.Event, parsedTrace?: Handlers.Types.ParsedTrace): boolean;\n}\n\nexport class VisibleEventsFilter extends TraceFilter {\n  private readonly visibleTypes: Set<string>;\n  constructor(visibleTypes: string[]) {\n    super();\n    this.visibleTypes = new Set(visibleTypes);\n  }\n\n  accept(event: Types.Events.Event): boolean {\n    if (Types.Extensions.isSyntheticExtensionEntry(event)) {\n      return true;\n    }\n    return this.visibleTypes.has(VisibleEventsFilter.eventType(event));\n  }\n\n  static eventType(event: Types.Events.Event): Types.Events.Name {\n    // Any blink.console category events are treated as ConsoleTime events\n    if (event.cat.includes('blink.console')) {\n      return Types.Events.Name.CONSOLE_TIME;\n    }\n    // Any blink.user_timing egory events are treated as UserTiming events\n    if (event.cat.includes('blink.user_timing')) {\n      return Types.Events.Name.USER_TIMING;\n    }\n    return event.name as Types.Events.Name;\n  }\n}\n\nexport class InvisibleEventsFilter extends TraceFilter {\n  #invisibleTypes: Set<Types.Events.Name>;\n\n  constructor(invisibleTypes: Types.Events.Name[]) {\n    super();\n    this.#invisibleTypes = new Set(invisibleTypes);\n  }\n\n  accept(event: Types.Events.Event): boolean {\n    return !this.#invisibleTypes.has(VisibleEventsFilter.eventType(event));\n  }\n}\n\nexport class ExclusiveNameFilter extends TraceFilter {\n  #excludeNames: Set<Types.Events.Name>;\n  constructor(excludeNames: Types.Events.Name[]) {\n    super();\n    this.#excludeNames = new Set(excludeNames);\n  }\n\n  accept(event: Types.Events.Event): boolean {\n    return !this.#excludeNames.has(event.name as Types.Events.Name);\n  }\n}\n"]}

package/models/trace/extras/TraceTree.d.ts

@@ -0,0 +1,91 @@
+import type * as Protocol from '../../../generated/protocol.js';
+import * as Types from '../types/types.js';
+import type { TraceFilter } from './TraceFilter.js';
+export declare class Node {
+    totalTime: number;
+    selfTime: number;
+    id: string | symbol;
+    event: Types.Events.Event | null;
+    parent: Node | null;
+    groupId: string;
+    isGroupNodeInternal: boolean;
+    depth: number;
+    constructor(id: string | symbol, event: Types.Events.Event | null);
+    isGroupNode(): boolean;
+    hasChildren(): boolean;
+    setHasChildren(_value: boolean): void;
+    /**
+     * Returns the direct descendants of this node.
+     * @returns a map with ordered <nodeId, Node> tuples.
+     */
+    children(): ChildrenCache;
+    searchTree(matchFunction: (arg0: Types.Events.Event) => boolean, results?: Node[]): Node[];
+}
+export declare class TopDownNode extends Node {
+    root: TopDownRootNode | null;
+    private hasChildrenInternal;
+    childrenInternal: ChildrenCache | null;
+    parent: TopDownNode | null;
+    constructor(id: string | symbol, event: Types.Events.Event | null, parent: TopDownNode | null);
+    hasChildren(): boolean;
+    setHasChildren(value: boolean): void;
+    children(): ChildrenCache;
+    private buildChildren;
+    getRoot(): TopDownRootNode | null;
+}
+export declare class TopDownRootNode extends TopDownNode {
+    readonly filter: (e: Types.Events.Event) => boolean;
+    /** This is all events passed in to create the tree, and it's very likely that it included events outside of the passed startTime/endTime as that filtering is done in `Helpers.Trace.forEachEvent` */
+    readonly events: Types.Events.Event[];
+    readonly startTime: Types.Timing.MilliSeconds;
+    readonly endTime: Types.Timing.MilliSeconds;
+    eventGroupIdCallback: ((arg0: Types.Events.Event) => string) | null | undefined;
+    /** Default behavior is to aggregate similar trace events into one Node based on generateEventID(), eventGroupIdCallback(), etc. Set true to keep nodes 1:1 with events. */
+    readonly doNotAggregate: boolean | undefined;
+    readonly includeInstantEvents?: boolean;
+    totalTime: number;
+    selfTime: number;
+    constructor(events: Types.Events.Event[], filters: TraceFilter[], startTime: Types.Timing.MilliSeconds, endTime: Types.Timing.MilliSeconds, doNotAggregate?: boolean, eventGroupIdCallback?: ((arg0: Types.Events.Event) => string) | null, includeInstantEvents?: boolean);
+    children(): ChildrenCache;
+    private grouppedTopNodes;
+    getEventGroupIdCallback(): ((arg0: Types.Events.Event) => string) | null | undefined;
+}
+export declare class BottomUpRootNode extends Node {
+    private childrenInternal;
+    readonly events: Types.Events.Event[];
+    private textFilter;
+    readonly filter: (e: Types.Events.Event) => boolean;
+    readonly startTime: Types.Timing.MilliSeconds;
+    readonly endTime: Types.Timing.MilliSeconds;
+    private eventGroupIdCallback;
+    totalTime: number;
+    constructor(events: Types.Events.Event[], textFilter: TraceFilter, filters: TraceFilter[], startTime: Types.Timing.MilliSeconds, endTime: Types.Timing.MilliSeconds, eventGroupIdCallback: ((arg0: Types.Events.Event) => string) | null);
+    hasChildren(): boolean;
+    filterChildren(children: ChildrenCache): ChildrenCache;
+    children(): ChildrenCache;
+    private ungrouppedTopNodes;
+    private grouppedTopNodes;
+}
+export declare class GroupNode extends Node {
+    private readonly childrenInternal;
+    isGroupNodeInternal: boolean;
+    constructor(id: string, parent: BottomUpRootNode | TopDownRootNode, event: Types.Events.Event);
+    addChild(child: BottomUpNode, selfTime: number, totalTime: number): void;
+    hasChildren(): boolean;
+    children(): ChildrenCache;
+}
+export declare class BottomUpNode extends Node {
+    parent: Node;
+    private root;
+    depth: number;
+    private cachedChildren;
+    private hasChildrenInternal;
+    constructor(root: BottomUpRootNode, id: string, event: Types.Events.Event, hasChildren: boolean, parent: Node);
+    hasChildren(): boolean;
+    setHasChildren(value: boolean): void;
+    children(): ChildrenCache;
+    searchTree(matchFunction: (arg0: Types.Events.Event) => boolean, results?: Node[]): Node[];
+}
+export declare function eventStackFrame(event: Types.Events.Event): Protocol.Runtime.CallFrame | null;
+export declare function generateEventID(event: Types.Events.Event): string;
+export type ChildrenCache = Map<string | symbol, Node>;