@paulirish/trace_engine 0.0.32 → 0.0.34

package/models/trace/types/Configuration.js

@@ -5,6 +5,7 @@ export const defaults = () => ({
     includeRuntimeCallStats: false,
     showAllEvents: false,
     debugMode: false,
+    maxInvalidationEventsPerEvent: 20,
 });
 /**
  * Generates a key that can be used to represent this config in a cache. This is

package/models/trace/types/Configuration.js.map

@@ -1 +1 @@
-{"version":3,"file":"Configuration.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/Configuration.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAiB7B,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAkB,EAAE,CAAC,CAAC;IAC5C,uBAAuB,EAAE,KAAK;IAC9B,aAAa,EAAE,KAAK;IACpB,SAAS,EAAE,KAAK;CACjB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAqB;IACpD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC","sourcesContent":["// Copyright 2023 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\nexport type Configuration = {\n  /**\n   * Include V8 RCS functions in the JS stacks\n   */\n  includeRuntimeCallStats: boolean,\n  /**\n   * Show all events: disable the default filtering which hides and excludes some events.\n   */\n  showAllEvents: boolean,\n  /**\n   * Extra detail for RPP developers (eg Trace Event json in Summary, and individual JS Sample events)\n   */\n  debugMode: boolean,\n};\n\nexport const defaults = (): Configuration => ({\n  includeRuntimeCallStats: false,\n  showAllEvents: false,\n  debugMode: false,\n});\n\n/**\n * Generates a key that can be used to represent this config in a cache. This is\n * used mainly in tests, where we want to avoid re-parsing a file if we have\n * already processed it with the same configuration.\n */\nexport function configToCacheKey(config: Configuration): string {\n  return JSON.stringify(config);\n}\n"]}
+{"version":3,"file":"Configuration.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/Configuration.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAiC7B,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAkB,EAAE,CAAC,CAAC;IAC5C,uBAAuB,EAAE,KAAK;IAC9B,aAAa,EAAE,KAAK;IACpB,SAAS,EAAE,KAAK;IAChB,6BAA6B,EAAE,EAAE;CAClC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAqB;IACpD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC","sourcesContent":["// Copyright 2023 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\nexport type Configuration = {\n  /**\n   * Include V8 RCS functions in the JS stacks\n   */\n  includeRuntimeCallStats: boolean,\n  /**\n   * Show all events: disable the default filtering which hides and excludes some events.\n   */\n  showAllEvents: boolean,\n  /**\n   * Extra detail for RPP developers (eg Trace Event json in Summary, and individual JS Sample events)\n   */\n  debugMode: boolean,\n  /**\n   * How many invalidation events will be stored for a layout (or similar) event.\n   * On large sites with a lot of DOM there can be thousands of invalidations\n   * associated with any given event. It is not useful to show the user 1000s of\n   * invalidations in the UI, but it is also expensive for us to hold onto them\n   * all, and it helps prevents OOM issues when running in NodeJS\n   * [https://github.com/GoogleChrome/lighthouse/issues/16111].\n   * Therefore, instead, we store only the latest 20 per event. We do also store\n   * the total count, so we can show that, but we'll only ever hold on to the\n   * last 20 invalidations (in DESC trace order - so the latest 20 in the trace file)\n   *\n   * If you set this to 0, we will skip the Invalidations processing entirely.\n   * 0 effectively disables the InvalidationsHandler and it will not even\n   * attempt to gather or track invalidations.\n   */\n  maxInvalidationEventsPerEvent: number,\n};\n\nexport const defaults = (): Configuration => ({\n  includeRuntimeCallStats: false,\n  showAllEvents: false,\n  debugMode: false,\n  maxInvalidationEventsPerEvent: 20,\n});\n\n/**\n * Generates a key that can be used to represent this config in a cache. This is\n * used mainly in tests, where we want to avoid re-parsing a file if we have\n * already processed it with the same configuration.\n */\nexport function configToCacheKey(config: Configuration): string {\n  return JSON.stringify(config);\n}\n"]}

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

@@ -1,6 +1,6 @@
-import { type TraceEventArgs, type TraceEventData } from './TraceEvents.js';
+import type { Args, Event, Phase, SyntheticBased } from './TraceEvents.js';
 export type ExtensionEntryType = 'track-entry' | 'marker';
-declare const extensionPalette: readonly ["primary", "primary-light", "primary-dark", "secondary", "secondary-light", "secondary-dark", "tertiary", "tertiary-light", "tertiary-dark", "error"];
+export declare const extensionPalette: readonly ["primary", "primary-light", "primary-dark", "secondary", "secondary-light", "secondary-dark", "tertiary", "tertiary-light", "tertiary-dark", "error", "warning"];
 export type ExtensionColorFromPalette = typeof extensionPalette[number];
 export declare function colorIsValid(color: string): boolean;
 export interface ExtensionDataPayloadBase {
@@ -20,18 +20,16 @@ export interface ExtensionMarkerPayload extends ExtensionDataPayloadBase {
 /**
  * Synthetic events created for extension tracks.
  */
-export interface SyntheticExtensionTrackChartEntry extends TraceEventData {
-    args: TraceEventArgs & ExtensionTrackEntryPayload;
-    cat: 'devtools.extension';
+export interface SyntheticExtensionTrackEntry extends SyntheticBased<Phase.COMPLETE> {
+    args: Args & ExtensionTrackEntryPayload;
 }
 /**
  * Synthetic events created for extension marks.
  */
-export interface SyntheticExtensionMarker extends TraceEventData {
-    args: TraceEventArgs & ExtensionMarkerPayload;
-    cat: 'devtools.extension';
+export interface SyntheticExtensionMarker extends SyntheticBased<Phase.COMPLETE> {
+    args: Args & ExtensionMarkerPayload;
 }
-export type SyntheticExtensionEntry = SyntheticExtensionTrackChartEntry | SyntheticExtensionMarker;
+export type SyntheticExtensionEntry = SyntheticExtensionTrackEntry | SyntheticExtensionMarker;
 export declare function isExtensionPayloadMarker(payload: {
     dataType?: string;
 }): payload is ExtensionMarkerPayload;
@@ -43,12 +41,11 @@ export declare function isValidExtensionPayload(payload: {
     track?: string;
     dataType?: string;
 }): payload is ExtensionDataPayload;
-export declare function isSyntheticExtensionEntry(entry: TraceEventData): entry is SyntheticExtensionEntry;
+export declare function isSyntheticExtensionEntry(entry: Event): entry is SyntheticExtensionEntry;
 export interface ExtensionTrackData {
     name: string;
     isTrackGroup: boolean;
     entriesByTrack: {
-        [x: string]: SyntheticExtensionTrackChartEntry[];
+        [x: string]: SyntheticExtensionTrackEntry[];
     };
 }
-export {};

package/models/trace/types/Extensions.js

@@ -1,7 +1,7 @@
 // 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.
-const extensionPalette = [
+export const extensionPalette = [
     'primary',
     'primary-light',
     'primary-dark',
@@ -12,6 +12,7 @@ const extensionPalette = [
     'tertiary-light',
     'tertiary-dark',
     'error',
+    'warning',
 ];
 export function colorIsValid(color) {
     return extensionPalette.includes(color);

package/models/trace/types/Extensions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/Extensions.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAS7B,MAAM,gBAAgB,GAAG;IACvB,SAAS;IACT,eAAe;IACf,cAAc;IACd,WAAW;IACX,iBAAiB;IACjB,gBAAgB;IAChB,UAAU;IACV,gBAAgB;IAChB,eAAe;IACf,OAAO;CACC,CAAC;AAIX,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAQ,gBAAsC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AAgDD,MAAM,UAAU,wBAAwB,CAAC,OAA4B;IACnE,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,OAA4C;IAEvF,MAAM,QAAQ,GAAG,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,KAAK,aAAa,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC;IAC5F,OAAO,cAAc,IAAI,QAAQ,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,OAA4C;IAClF,OAAO,wBAAwB,CAAC,OAAO,CAAC,IAAI,4BAA4B,CAAC,OAAO,CAAC,CAAC;AACpF,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAqB;IAC7D,OAAO,KAAK,CAAC,GAAG,KAAK,oBAAoB,CAAC;AAC5C,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 {\n  type TraceEventArgs,\n  type TraceEventData,\n} from './TraceEvents.js';\n\nexport type ExtensionEntryType = 'track-entry'|'marker';\n\nconst extensionPalette = [\n  'primary',\n  'primary-light',\n  'primary-dark',\n  'secondary',\n  'secondary-light',\n  'secondary-dark',\n  'tertiary',\n  'tertiary-light',\n  'tertiary-dark',\n  'error',\n] as const;\n\nexport type ExtensionColorFromPalette = typeof extensionPalette[number];\n\nexport function colorIsValid(color: string): boolean {\n  return (extensionPalette as readonly string[]).includes(color);\n}\n\nexport interface ExtensionDataPayloadBase {\n  color?: ExtensionColorFromPalette;\n  properties?: [string, string][];\n  tooltipText?: string;\n}\n\nexport type ExtensionDataPayload = ExtensionTrackEntryPayload|ExtensionMarkerPayload;\n\nexport interface ExtensionTrackEntryPayload extends ExtensionDataPayloadBase {\n  // Typed as possibly undefined since when no data type is provided\n  // the entry is defaulted to a track entry\n  dataType?: 'track-entry';\n  // The name of the track the entry will be displayed in.\n  // Entries intended to be displayed in the same track must contain the\n  // same value in this property.\n  // If undefined, measurement is added to the Timings track\n  track: string;\n  // The track group an entry’s track belongs to.\n  // Entries intended to be displayed in the same track must contain the\n  // same value in this property as well as the same value in the track\n  // property.\n  trackGroup?: string;\n}\n\nexport interface ExtensionMarkerPayload extends ExtensionDataPayloadBase {\n  dataType: 'marker';\n}\n\n/**\n * Synthetic events created for extension tracks.\n */\nexport interface SyntheticExtensionTrackChartEntry extends TraceEventData {\n  args: TraceEventArgs&ExtensionTrackEntryPayload;\n  cat: 'devtools.extension';\n}\n\n/**\n * Synthetic events created for extension marks.\n */\nexport interface SyntheticExtensionMarker extends TraceEventData {\n  args: TraceEventArgs&ExtensionMarkerPayload;\n  cat: 'devtools.extension';\n}\n\nexport type SyntheticExtensionEntry = SyntheticExtensionTrackChartEntry|SyntheticExtensionMarker;\n\nexport function isExtensionPayloadMarker(payload: {dataType?: string}): payload is ExtensionMarkerPayload {\n  return payload.dataType === 'marker';\n}\n\nexport function isExtensionPayloadTrackEntry(payload: {track?: string, dataType?: string}):\n    payload is ExtensionTrackEntryPayload {\n  const hasTrack = 'track' in payload && Boolean(payload.track);\n  const validEntryType = payload.dataType === 'track-entry' || payload.dataType === undefined;\n  return validEntryType && hasTrack;\n}\n\nexport function isValidExtensionPayload(payload: {track?: string, dataType?: string}): payload is ExtensionDataPayload {\n  return isExtensionPayloadMarker(payload) || isExtensionPayloadTrackEntry(payload);\n}\n\nexport function isSyntheticExtensionEntry(entry: TraceEventData): entry is SyntheticExtensionEntry {\n  return entry.cat === 'devtools.extension';\n}\n\nexport interface ExtensionTrackData {\n  // Name of the top level track. If it's a track group then this value\n  // has the name of the group, otherwise it has the name of the track.\n  name: string;\n  isTrackGroup: boolean;\n  // If this contains the data of a track group, this property contains\n  // the entries of each of the tracks in the the group. If this is a\n  // standalone track, then this contains that track's entries only.\n  entriesByTrack: {\n    [x: string]: SyntheticExtensionTrackChartEntry[],\n  };\n}\n"]}
+{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/Extensions.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,yEAAyE;AACzE,6BAA6B;AAM7B,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,SAAS;IACT,eAAe;IACf,cAAc;IACd,WAAW;IACX,iBAAiB;IACjB,gBAAgB;IAChB,UAAU;IACV,gBAAgB;IAChB,eAAe;IACf,OAAO;IACP,SAAS;CACD,CAAC;AAIX,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAQ,gBAAsC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AA8CD,MAAM,UAAU,wBAAwB,CAAC,OAA4B;IACnE,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,OAA4C;IAEvF,MAAM,QAAQ,GAAG,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,KAAK,aAAa,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC;IAC5F,OAAO,cAAc,IAAI,QAAQ,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,OAA4C;IAClF,OAAO,wBAAwB,CAAC,OAAO,CAAC,IAAI,4BAA4B,CAAC,OAAO,CAAC,CAAC;AACpF,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAY;IACpD,OAAO,KAAK,CAAC,GAAG,KAAK,oBAAoB,CAAC;AAC5C,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 type {Args, Event, Phase, SyntheticBased} from './TraceEvents.js';\n\nexport type ExtensionEntryType = 'track-entry'|'marker';\n\nexport const extensionPalette = [\n  'primary',\n  'primary-light',\n  'primary-dark',\n  'secondary',\n  'secondary-light',\n  'secondary-dark',\n  'tertiary',\n  'tertiary-light',\n  'tertiary-dark',\n  'error',\n  'warning',\n] as const;\n\nexport type ExtensionColorFromPalette = typeof extensionPalette[number];\n\nexport function colorIsValid(color: string): boolean {\n  return (extensionPalette as readonly string[]).includes(color);\n}\n\nexport interface ExtensionDataPayloadBase {\n  color?: ExtensionColorFromPalette;\n  properties?: [string, string][];\n  tooltipText?: string;\n}\n\nexport type ExtensionDataPayload = ExtensionTrackEntryPayload|ExtensionMarkerPayload;\n\nexport interface ExtensionTrackEntryPayload extends ExtensionDataPayloadBase {\n  // Typed as possibly undefined since when no data type is provided\n  // the entry is defaulted to a track entry\n  dataType?: 'track-entry';\n  // The name of the track the entry will be displayed in.\n  // Entries intended to be displayed in the same track must contain the\n  // same value in this property.\n  // If undefined, measurement is added to the Timings track\n  track: string;\n  // The track group an entry’s track belongs to.\n  // Entries intended to be displayed in the same track must contain the\n  // same value in this property as well as the same value in the track\n  // property.\n  trackGroup?: string;\n}\n\nexport interface ExtensionMarkerPayload extends ExtensionDataPayloadBase {\n  dataType: 'marker';\n}\n\n/**\n * Synthetic events created for extension tracks.\n */\nexport interface SyntheticExtensionTrackEntry extends SyntheticBased<Phase.COMPLETE> {\n  args: Args&ExtensionTrackEntryPayload;\n}\n\n/**\n * Synthetic events created for extension marks.\n */\nexport interface SyntheticExtensionMarker extends SyntheticBased<Phase.COMPLETE> {\n  args: Args&ExtensionMarkerPayload;\n}\n\nexport type SyntheticExtensionEntry = SyntheticExtensionTrackEntry|SyntheticExtensionMarker;\n\nexport function isExtensionPayloadMarker(payload: {dataType?: string}): payload is ExtensionMarkerPayload {\n  return payload.dataType === 'marker';\n}\n\nexport function isExtensionPayloadTrackEntry(payload: {track?: string, dataType?: string}):\n    payload is ExtensionTrackEntryPayload {\n  const hasTrack = 'track' in payload && Boolean(payload.track);\n  const validEntryType = payload.dataType === 'track-entry' || payload.dataType === undefined;\n  return validEntryType && hasTrack;\n}\n\nexport function isValidExtensionPayload(payload: {track?: string, dataType?: string}): payload is ExtensionDataPayload {\n  return isExtensionPayloadMarker(payload) || isExtensionPayloadTrackEntry(payload);\n}\n\nexport function isSyntheticExtensionEntry(entry: Event): entry is SyntheticExtensionEntry {\n  return entry.cat === 'devtools.extension';\n}\n\nexport interface ExtensionTrackData {\n  // Name of the top level track. If it's a track group then this value\n  // has the name of the group, otherwise it has the name of the track.\n  name: string;\n  isTrackGroup: boolean;\n  // If this contains the data of a track group, this property contains\n  // the entries of each of the tracks in the the group. If this is a\n  // standalone track, then this contains that track's entries only.\n  entriesByTrack: {\n    [x: string]: SyntheticExtensionTrackEntry[],\n  };\n}\n"]}

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

@@ -1,8 +1,8 @@
 import type * as Protocol from '../../../generated/protocol.js';
-import { type TraceWindowMicroSeconds } from './Timing.js';
-import { type ProcessID, type SampleIndex, type ThreadID, type TraceEventData } from './TraceEvents.js';
+import type { TraceWindowMicroSeconds } from './Timing.js';
+import type { Event, LegacyTimelineFrame, ProcessID, SampleIndex, ThreadID } from './TraceEvents.js';
 export type TraceFile = {
-    traceEvents: readonly TraceEventData[];
+    traceEvents: readonly Event[];
     metadata: MetaData;
 };
 export interface Breadcrumb {
@@ -10,13 +10,25 @@ export interface Breadcrumb {
     child: Breadcrumb | null;
 }
 export declare const enum DataOrigin {
-    CPUProfile = "CPUProfile",
-    TraceEvents = "TraceEvents"
+    CPU_PROFILE = "CPUProfile",
+    TRACE_EVENTS = "TraceEvents"
+}
+/**
+ * The Entries link can have 3 stated:
+ *  1. The Link creation is not started yet, meaning only the button that needs to be clicked to start creating the link is visible.
+ *  2. Pending to event - the creation is started, but the entry that the link points to has not been chosen yet
+ *  3. Link connected - final state, both entries present
+ */
+export declare const enum EntriesLinkState {
+    CREATION_NOT_STARTED = "creation_not_started",
+    PENDING_TO_EVENT = "pending_to_event",
+    CONNECTED = "connected"
 }
 export declare const enum EventKeyType {
-    RawEvent = "r",
-    SyntheticEvent = "s",
-    ProfileCall = "p"
+    RAW_EVENT = "r",
+    SYNTHETIC_EVENT = "s",
+    PROFILE_CALL = "p",
+    LEGACY_TIMELINE_FRAME = "l"
 }
 /**
  * Represents an object that is saved in the file when user created annotations in the timeline.
@@ -26,13 +38,14 @@ export declare const enum EventKeyType {
 export interface SerializedAnnotations {
     entryLabels: EntryLabelAnnotationSerialized[];
     labelledTimeRanges: TimeRangeAnnotationSerialized[];
+    linksBetweenEntries: EntriesLinkAnnotationSerialized[];
 }
 /**
  * Represents an object that is used to store the Entry Label annotation that is created when a user creates a label for an entry in the timeline.
  */
 export interface EntryLabelAnnotation {
     type: 'ENTRY_LABEL';
-    entry: TraceEventData;
+    entry: Event | LegacyTimelineFrame;
     label: string;
 }
 /**
@@ -43,11 +56,17 @@ export interface TimeRangeAnnotation {
     label: string;
     bounds: TraceWindowMicroSeconds;
 }
+export interface EntriesLinkAnnotation {
+    type: 'ENTRIES_LINK';
+    state: EntriesLinkState;
+    entryFrom: Event;
+    entryTo?: Event;
+}
 /**
  * Represents an object that is saved in the file when a user creates a label for an entry in the timeline.
  */
 export interface EntryLabelAnnotationSerialized {
-    entry: TraceEventSerializableKey;
+    entry: SerializableKey;
     label: string;
 }
 /**
@@ -57,6 +76,13 @@ export interface TimeRangeAnnotationSerialized {
     bounds: TraceWindowMicroSeconds;
     label: string;
 }
+/**
+ * Represents an object that is saved in the file when a user creates a link between entries in the timeline.
+ */
+export interface EntriesLinkAnnotationSerialized {
+    entryFrom: SerializableKey;
+    entryTo: SerializableKey;
+}
 /**
  * `Annotation` are the user-created annotations that are saved into the metadata.
  * Those annotations are rendered on the timeline by `Overlays.ts`
@@ -64,33 +90,39 @@ export interface TimeRangeAnnotationSerialized {
  * TODO: Implement other OverlayAnnotations (annotated time ranges, links between entries).
  * TODO: Save/load overlay annotations to/from the trace file.
  */
-export type Annotation = EntryLabelAnnotation | TimeRangeAnnotation;
+export type Annotation = EntryLabelAnnotation | TimeRangeAnnotation | EntriesLinkAnnotation;
 export declare function isTimeRangeAnnotation(annotation: Annotation): annotation is TimeRangeAnnotation;
 export declare function isEntryLabelAnnotation(annotation: Annotation): annotation is EntryLabelAnnotation;
-export type RawEventKey = `${EventKeyType.RawEvent}-${number}`;
-export type SyntheticEventKey = `${EventKeyType.SyntheticEvent}-${number}`;
-export type ProfileCallKey = `${EventKeyType.ProfileCall}-${ProcessID}-${ThreadID}-${SampleIndex}-${Protocol.integer}`;
-export type TraceEventSerializableKey = RawEventKey | ProfileCallKey | SyntheticEventKey;
+export declare function isEntriesLinkAnnotation(annotation: Annotation): annotation is EntriesLinkAnnotation;
+export type RawEventKey = `${EventKeyType.RAW_EVENT}-${number}`;
+export type SyntheticEventKey = `${EventKeyType.SYNTHETIC_EVENT}-${number}`;
+export type ProfileCallKey = `${EventKeyType.PROFILE_CALL}-${ProcessID}-${ThreadID}-${SampleIndex}-${Protocol.integer}`;
+export type LegacyTimelineFrameKey = `${EventKeyType.LEGACY_TIMELINE_FRAME}-${number}`;
+export type SerializableKey = RawEventKey | ProfileCallKey | SyntheticEventKey | LegacyTimelineFrameKey;
 export type RawEventKeyValues = {
-    type: EventKeyType.RawEvent;
+    type: EventKeyType.RAW_EVENT;
     rawIndex: number;
 };
 export type SyntheticEventKeyValues = {
-    type: EventKeyType.SyntheticEvent;
+    type: EventKeyType.SYNTHETIC_EVENT;
     rawIndex: number;
 };
 export type ProfileCallKeyValues = {
-    type: EventKeyType.ProfileCall;
+    type: EventKeyType.PROFILE_CALL;
     processID: ProcessID;
     threadID: ThreadID;
     sampleIndex: SampleIndex;
     protocol: Protocol.integer;
 };
-export type TraceEventSerializableKeyValues = RawEventKeyValues | ProfileCallKeyValues | SyntheticEventKeyValues;
+export type LegacyTimelineFrameKeyValues = {
+    type: EventKeyType.LEGACY_TIMELINE_FRAME;
+    rawIndex: number;
+};
+export type SerializableKeyValues = RawEventKeyValues | ProfileCallKeyValues | SyntheticEventKeyValues | LegacyTimelineFrameKeyValues;
 export interface Modifications {
     entriesModifications: {
-        hiddenEntries: TraceEventSerializableKey[];
-        expandableEntries: TraceEventSerializableKey[];
+        hiddenEntries: SerializableKey[];
+        expandableEntries: SerializableKey[];
     };
     initialBreadcrumb: Breadcrumb;
     annotations: SerializedAnnotations;
@@ -110,5 +142,5 @@ export interface MetaData {
     modifications?: Modifications;
     enhancedTraceVersion?: number;
 }
-export type Contents = TraceFile | TraceEventData[];
-export declare function traceEventKeyToValues(key: TraceEventSerializableKey): TraceEventSerializableKeyValues;
+export type Contents = TraceFile | Event[];
+export declare function traceEventKeyToValues(key: SerializableKey): SerializableKeyValues;

package/models/trace/types/File.js

@@ -4,11 +4,14 @@ export function isTimeRangeAnnotation(annotation) {
 export function isEntryLabelAnnotation(annotation) {
     return annotation.type === 'ENTRY_LABEL';
 }
+export function isEntriesLinkAnnotation(annotation) {
+    return annotation.type === 'ENTRIES_LINK';
+}
 export function traceEventKeyToValues(key) {
     const parts = key.split('-');
     const type = parts[0];
     switch (type) {
-        case "p" /* EventKeyType.ProfileCall */:
+        case "p" /* EventKeyType.PROFILE_CALL */:
             if (parts.length !== 5 ||
                 !(parts.every((part, i) => i === 0 || typeof part === 'number' || !isNaN(parseInt(part, 10))))) {
                 throw new Error(`Invalid ProfileCallKey: ${key}`);
@@ -20,7 +23,7 @@ export function traceEventKeyToValues(key) {
                 sampleIndex: parseInt(parts[3], 10),
                 protocol: parseInt(parts[4], 10),
             };
-        case "r" /* EventKeyType.RawEvent */:
+        case "r" /* EventKeyType.RAW_EVENT */:
             if (parts.length !== 2 || !(typeof parts[1] === 'number' || !isNaN(parseInt(parts[1], 10)))) {
                 throw new Error(`Invalid RawEvent Key: ${key}`);
             }
@@ -28,7 +31,7 @@ export function traceEventKeyToValues(key) {
                 type: parts[0],
                 rawIndex: parseInt(parts[1], 10),
             };
-        case "s" /* EventKeyType.SyntheticEvent */:
+        case "s" /* EventKeyType.SYNTHETIC_EVENT */:
             if (parts.length !== 2 || !(typeof parts[1] === 'number' || !isNaN(parseInt(parts[1], 10)))) {
                 throw new Error(`Invalid SyntheticEvent Key: ${key}`);
             }
@@ -36,6 +39,15 @@ export function traceEventKeyToValues(key) {
                 type: parts[0],
                 rawIndex: parseInt(parts[1], 10),
             };
+        case "l" /* EventKeyType.LEGACY_TIMELINE_FRAME */: {
+            if (parts.length !== 2 || Number.isNaN(parseInt(parts[1], 10))) {
+                throw new Error(`Invalid LegacyTimelineFrame Key: ${key}`);
+            }
+            return {
+                type,
+                rawIndex: parseInt(parts[1], 10),
+            };
+        }
         default:
             throw new Error(`Unknown trace event key: ${key}`);
     }

package/models/trace/types/File.js.map

@@ -1 +1 @@
-{"version":3,"file":"File.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/File.ts"],"names":[],"mappings":"AAkFA,MAAM,UAAU,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,UAAU,CAAC,IAAI,KAAK,YAAY,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,UAAsB;IAC3D,OAAO,UAAU,CAAC,IAAI,KAAK,aAAa,CAAC;AAC3C,CAAC;AA6DD,MAAM,UAAU,qBAAqB,CAAC,GAA8B;IAClE,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAEtB,QAAQ,IAAI,EAAE,CAAC;QACb;YACE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAClB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnG,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;YACpD,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACd,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBACjC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBAChC,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBACnC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;aACT,CAAC;QAC5B;YACE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5F,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,EAAE,CAAC,CAAC;YAClD,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACd,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;aACZ,CAAC;QACzB;YACE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5F,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,EAAE,CAAC,CAAC;YACxD,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACd,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;aACN,CAAC;QAC/B;YACE,MAAM,IAAI,KAAK,CAAC,4BAA4B,GAAG,EAAE,CAAC,CAAC;IACvD,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2023 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.\nimport type * as Protocol from '../../../generated/protocol.js';\n\nimport {type TraceWindowMicroSeconds} from './Timing.js';\nimport {type ProcessID, type SampleIndex, type ThreadID, type TraceEventData} from './TraceEvents.js';\n\nexport type TraceFile = {\n  traceEvents: readonly TraceEventData[],\n  metadata: MetaData,\n};\n\nexport interface Breadcrumb {\n  window: TraceWindowMicroSeconds;\n  child: Breadcrumb|null;\n}\n\nexport const enum DataOrigin {\n  CPUProfile = 'CPUProfile',\n  TraceEvents = 'TraceEvents',\n}\n\nexport const enum EventKeyType {\n  RawEvent = 'r',\n  SyntheticEvent = 's',\n  ProfileCall = 'p',\n}\n\n/**\n * Represents an object that is saved in the file when user created annotations in the timeline.\n *\n * Expected to add more annotations.\n */\nexport interface SerializedAnnotations {\n  entryLabels: EntryLabelAnnotationSerialized[];\n  labelledTimeRanges: TimeRangeAnnotationSerialized[];\n}\n\n/**\n * Represents an object that is used to store the Entry Label annotation that is created when a user creates a label for an entry in the timeline.\n */\nexport interface EntryLabelAnnotation {\n  type: 'ENTRY_LABEL';\n  entry: TraceEventData;\n  label: string;\n}\n\n/**\n * Represents an object that is used to store the Labelled Time Range Annotation that is created when a user creates a Time Range Selection in the timeline.\n */\nexport interface TimeRangeAnnotation {\n  type: 'TIME_RANGE';\n  label: string;\n  bounds: TraceWindowMicroSeconds;\n}\n\n/**\n * Represents an object that is saved in the file when a user creates a label for an entry in the timeline.\n */\nexport interface EntryLabelAnnotationSerialized {\n  entry: TraceEventSerializableKey;\n  label: string;\n}\n\n/**\n * Represents an object that is saved in the file when a user creates a time range with a label in the timeline.\n */\nexport interface TimeRangeAnnotationSerialized {\n  bounds: TraceWindowMicroSeconds;\n  label: string;\n}\n\n/**\n * `Annotation` are the user-created annotations that are saved into the metadata.\n * Those annotations are rendered on the timeline by `Overlays.ts`\n *\n * TODO: Implement other OverlayAnnotations (annotated time ranges, links between entries).\n * TODO: Save/load overlay annotations to/from the trace file.\n */\nexport type Annotation = EntryLabelAnnotation|TimeRangeAnnotation;\n\nexport function isTimeRangeAnnotation(annotation: Annotation): annotation is TimeRangeAnnotation {\n  return annotation.type === 'TIME_RANGE';\n}\n\nexport function isEntryLabelAnnotation(annotation: Annotation): annotation is EntryLabelAnnotation {\n  return annotation.type === 'ENTRY_LABEL';\n}\n\n// Serializable keys are created for trace events to be able to save\n// references to timeline events in a trace file. These keys enable\n// user modifications that can be saved. See go/cpq:event-data-json for\n// more details on the key format.\nexport type RawEventKey = `${EventKeyType.RawEvent}-${number}`;\nexport type SyntheticEventKey = `${EventKeyType.SyntheticEvent}-${number}`;\nexport type ProfileCallKey = `${EventKeyType.ProfileCall}-${ProcessID}-${ThreadID}-${SampleIndex}-${Protocol.integer}`;\nexport type TraceEventSerializableKey = RawEventKey|ProfileCallKey|SyntheticEventKey;\n\n// Serializable keys values objects contain data that maps the keys to original Trace Events\nexport type RawEventKeyValues = {\n  type: EventKeyType.RawEvent,\n  rawIndex: number,\n};\n\nexport type SyntheticEventKeyValues = {\n  type: EventKeyType.SyntheticEvent,\n  rawIndex: number,\n};\n\nexport type ProfileCallKeyValues = {\n  type: EventKeyType.ProfileCall,\n  processID: ProcessID,\n  threadID: ThreadID,\n  sampleIndex: SampleIndex,\n  protocol: Protocol.integer,\n};\n\nexport type TraceEventSerializableKeyValues = RawEventKeyValues|ProfileCallKeyValues|SyntheticEventKeyValues;\n\nexport interface Modifications {\n  entriesModifications: {\n    // Entries hidden by the user\n    hiddenEntries: TraceEventSerializableKey[],\n    // Entries that parent a hiddenEntry\n    expandableEntries: TraceEventSerializableKey[],\n  };\n  initialBreadcrumb: Breadcrumb;\n  annotations: SerializedAnnotations;\n}\n\n/**\n * Trace metadata that we persist to the file. This will allow us to\n * store specifics for the trace, e.g., which tracks should be visible\n * on load.\n */\nexport interface MetaData {\n  source?: 'DevTools';\n  startTime?: string;\n  networkThrottling?: string;\n  cpuThrottling?: number;\n  hardwareConcurrency?: number;\n  dataOrigin?: DataOrigin;\n  modifications?: Modifications;\n  enhancedTraceVersion?: number;\n}\n\nexport type Contents = TraceFile|TraceEventData[];\n\nexport function traceEventKeyToValues(key: TraceEventSerializableKey): TraceEventSerializableKeyValues {\n  const parts = key.split('-');\n  const type = parts[0];\n\n  switch (type) {\n    case EventKeyType.ProfileCall:\n      if (parts.length !== 5 ||\n          !(parts.every((part, i) => i === 0 || typeof part === 'number' || !isNaN(parseInt(part, 10))))) {\n        throw new Error(`Invalid ProfileCallKey: ${key}`);\n      }\n      return {\n        type: parts[0],\n        processID: parseInt(parts[1], 10),\n        threadID: parseInt(parts[2], 10),\n        sampleIndex: parseInt(parts[3], 10),\n        protocol: parseInt(parts[4], 10),\n      } as ProfileCallKeyValues;\n    case EventKeyType.RawEvent:\n      if (parts.length !== 2 || !(typeof parts[1] === 'number' || !isNaN(parseInt(parts[1], 10)))) {\n        throw new Error(`Invalid RawEvent Key: ${key}`);\n      }\n      return {\n        type: parts[0],\n        rawIndex: parseInt(parts[1], 10),\n      } as RawEventKeyValues;\n    case EventKeyType.SyntheticEvent:\n      if (parts.length !== 2 || !(typeof parts[1] === 'number' || !isNaN(parseInt(parts[1], 10)))) {\n        throw new Error(`Invalid SyntheticEvent Key: ${key}`);\n      }\n      return {\n        type: parts[0],\n        rawIndex: parseInt(parts[1], 10),\n      } as SyntheticEventKeyValues;\n    default:\n      throw new Error(`Unknown trace event key: ${key}`);\n  }\n}\n"]}
+{"version":3,"file":"File.js","sourceRoot":"","sources":["../../../../../../../front_end/models/trace/types/File.ts"],"names":[],"mappings":"AA+GA,MAAM,UAAU,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,UAAU,CAAC,IAAI,KAAK,YAAY,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,UAAsB;IAC3D,OAAO,UAAU,CAAC,IAAI,KAAK,aAAa,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,UAAsB;IAC5D,OAAO,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC;AAC5C,CAAC;AAoED,MAAM,UAAU,qBAAqB,CAAC,GAAoB;IACxD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAEtB,QAAQ,IAAI,EAAE,CAAC;QACb;YACE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAClB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnG,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;YACpD,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACd,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBACjC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBAChC,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBACnC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;aACT,CAAC;QAC5B;YACE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5F,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,EAAE,CAAC,CAAC;YAClD,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACd,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;aACZ,CAAC;QACzB;YACE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5F,MAAM,IAAI,KAAK,CAAC,+BAA+B,GAAG,EAAE,CAAC,CAAC;YACxD,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBACd,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;aACN,CAAC;QAC/B,iDAAuC,CAAC,CAAC,CAAC;YACxC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC;gBAC/D,MAAM,IAAI,KAAK,CAAC,oCAAoC,GAAG,EAAE,CAAC,CAAC;YAC7D,CAAC;YACD,OAAO;gBACL,IAAI;gBACJ,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;aACjC,CAAC;QACJ,CAAC;QAED;YACE,MAAM,IAAI,KAAK,CAAC,4BAA4B,GAAG,EAAE,CAAC,CAAC;IACvD,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2023 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.\nimport type * as Protocol from '../../../generated/protocol.js';\n\nimport type {TraceWindowMicroSeconds} from './Timing.js';\nimport type {Event, LegacyTimelineFrame, ProcessID, SampleIndex, ThreadID} from './TraceEvents.js';\n\nexport type TraceFile = {\n  traceEvents: readonly Event[],\n  metadata: MetaData,\n};\n\nexport interface Breadcrumb {\n  window: TraceWindowMicroSeconds;\n  child: Breadcrumb|null;\n}\n\nexport const enum DataOrigin {\n  CPU_PROFILE = 'CPUProfile',\n  TRACE_EVENTS = 'TraceEvents',\n}\n\n/**\n * The Entries link can have 3 stated:\n *  1. The Link creation is not started yet, meaning only the button that needs to be clicked to start creating the link is visible.\n *  2. Pending to event - the creation is started, but the entry that the link points to has not been chosen yet\n *  3. Link connected - final state, both entries present\n */\nexport const enum EntriesLinkState {\n  CREATION_NOT_STARTED = 'creation_not_started',\n  PENDING_TO_EVENT = 'pending_to_event',\n  CONNECTED = 'connected',\n}\n\nexport const enum EventKeyType {\n  RAW_EVENT = 'r',\n  SYNTHETIC_EVENT = 's',\n  PROFILE_CALL = 'p',\n  LEGACY_TIMELINE_FRAME = 'l',\n}\n\n/**\n * Represents an object that is saved in the file when user created annotations in the timeline.\n *\n * Expected to add more annotations.\n */\nexport interface SerializedAnnotations {\n  entryLabels: EntryLabelAnnotationSerialized[];\n  labelledTimeRanges: TimeRangeAnnotationSerialized[];\n  linksBetweenEntries: EntriesLinkAnnotationSerialized[];\n}\n\n/**\n * Represents an object that is used to store the Entry Label annotation that is created when a user creates a label for an entry in the timeline.\n */\nexport interface EntryLabelAnnotation {\n  type: 'ENTRY_LABEL';\n  entry: Event|LegacyTimelineFrame;\n  label: string;\n}\n\n/**\n * Represents an object that is used to store the Labelled Time Range Annotation that is created when a user creates a Time Range Selection in the timeline.\n */\nexport interface TimeRangeAnnotation {\n  type: 'TIME_RANGE';\n  label: string;\n  bounds: TraceWindowMicroSeconds;\n}\n\nexport interface EntriesLinkAnnotation {\n  type: 'ENTRIES_LINK';\n  state: EntriesLinkState;\n  entryFrom: Event;\n  entryTo?: Event;\n}\n\n/**\n * Represents an object that is saved in the file when a user creates a label for an entry in the timeline.\n */\nexport interface EntryLabelAnnotationSerialized {\n  entry: SerializableKey;\n  label: string;\n}\n\n/**\n * Represents an object that is saved in the file when a user creates a time range with a label in the timeline.\n */\nexport interface TimeRangeAnnotationSerialized {\n  bounds: TraceWindowMicroSeconds;\n  label: string;\n}\n\n/**\n * Represents an object that is saved in the file when a user creates a link between entries in the timeline.\n */\nexport interface EntriesLinkAnnotationSerialized {\n  entryFrom: SerializableKey;\n  entryTo: SerializableKey;\n}\n\n/**\n * `Annotation` are the user-created annotations that are saved into the metadata.\n * Those annotations are rendered on the timeline by `Overlays.ts`\n *\n * TODO: Implement other OverlayAnnotations (annotated time ranges, links between entries).\n * TODO: Save/load overlay annotations to/from the trace file.\n */\nexport type Annotation = EntryLabelAnnotation|TimeRangeAnnotation|EntriesLinkAnnotation;\n\nexport function isTimeRangeAnnotation(annotation: Annotation): annotation is TimeRangeAnnotation {\n  return annotation.type === 'TIME_RANGE';\n}\n\nexport function isEntryLabelAnnotation(annotation: Annotation): annotation is EntryLabelAnnotation {\n  return annotation.type === 'ENTRY_LABEL';\n}\n\nexport function isEntriesLinkAnnotation(annotation: Annotation): annotation is EntriesLinkAnnotation {\n  return annotation.type === 'ENTRIES_LINK';\n}\n\n// Serializable keys are created for trace events to be able to save\n// references to timeline events in a trace file. These keys enable\n// user modifications that can be saved. See go/cpq:event-data-json for\n// more details on the key format.\nexport type RawEventKey = `${EventKeyType.RAW_EVENT}-${number}`;\nexport type SyntheticEventKey = `${EventKeyType.SYNTHETIC_EVENT}-${number}`;\nexport type ProfileCallKey = `${EventKeyType.PROFILE_CALL}-${ProcessID}-${ThreadID}-${SampleIndex}-${Protocol.integer}`;\nexport type LegacyTimelineFrameKey = `${EventKeyType.LEGACY_TIMELINE_FRAME}-${number}`;\nexport type SerializableKey = RawEventKey|ProfileCallKey|SyntheticEventKey|LegacyTimelineFrameKey;\n\n// Serializable keys values objects contain data that maps the keys to original Trace Events\nexport type RawEventKeyValues = {\n  type: EventKeyType.RAW_EVENT,\n  rawIndex: number,\n};\n\nexport type SyntheticEventKeyValues = {\n  type: EventKeyType.SYNTHETIC_EVENT,\n  rawIndex: number,\n};\n\nexport type ProfileCallKeyValues = {\n  type: EventKeyType.PROFILE_CALL,\n  processID: ProcessID,\n  threadID: ThreadID,\n  sampleIndex: SampleIndex,\n  protocol: Protocol.integer,\n};\n\nexport type LegacyTimelineFrameKeyValues = {\n  type: EventKeyType.LEGACY_TIMELINE_FRAME,\n  rawIndex: number,\n};\n\nexport type SerializableKeyValues =\n    RawEventKeyValues|ProfileCallKeyValues|SyntheticEventKeyValues|LegacyTimelineFrameKeyValues;\n\nexport interface Modifications {\n  entriesModifications: {\n    // Entries hidden by the user\n    hiddenEntries: SerializableKey[],\n    // Entries that parent a hiddenEntry\n    expandableEntries: SerializableKey[],\n  };\n  initialBreadcrumb: Breadcrumb;\n  annotations: SerializedAnnotations;\n}\n\n/**\n * Trace metadata that we persist to the file. This will allow us to\n * store specifics for the trace, e.g., which tracks should be visible\n * on load.\n */\nexport interface MetaData {\n  source?: 'DevTools';\n  startTime?: string;\n  networkThrottling?: string;\n  cpuThrottling?: number;\n  hardwareConcurrency?: number;\n  dataOrigin?: DataOrigin;\n  modifications?: Modifications;\n  enhancedTraceVersion?: number;\n}\n\nexport type Contents = TraceFile|Event[];\n\nexport function traceEventKeyToValues(key: SerializableKey): SerializableKeyValues {\n  const parts = key.split('-');\n  const type = parts[0];\n\n  switch (type) {\n    case EventKeyType.PROFILE_CALL:\n      if (parts.length !== 5 ||\n          !(parts.every((part, i) => i === 0 || typeof part === 'number' || !isNaN(parseInt(part, 10))))) {\n        throw new Error(`Invalid ProfileCallKey: ${key}`);\n      }\n      return {\n        type: parts[0],\n        processID: parseInt(parts[1], 10),\n        threadID: parseInt(parts[2], 10),\n        sampleIndex: parseInt(parts[3], 10),\n        protocol: parseInt(parts[4], 10),\n      } as ProfileCallKeyValues;\n    case EventKeyType.RAW_EVENT:\n      if (parts.length !== 2 || !(typeof parts[1] === 'number' || !isNaN(parseInt(parts[1], 10)))) {\n        throw new Error(`Invalid RawEvent Key: ${key}`);\n      }\n      return {\n        type: parts[0],\n        rawIndex: parseInt(parts[1], 10),\n      } as RawEventKeyValues;\n    case EventKeyType.SYNTHETIC_EVENT:\n      if (parts.length !== 2 || !(typeof parts[1] === 'number' || !isNaN(parseInt(parts[1], 10)))) {\n        throw new Error(`Invalid SyntheticEvent Key: ${key}`);\n      }\n      return {\n        type: parts[0],\n        rawIndex: parseInt(parts[1], 10),\n      } as SyntheticEventKeyValues;\n    case EventKeyType.LEGACY_TIMELINE_FRAME: {\n      if (parts.length !== 2 || Number.isNaN(parseInt(parts[1], 10))) {\n        throw new Error(`Invalid LegacyTimelineFrame Key: ${key}`);\n      }\n      return {\n        type,\n        rawIndex: parseInt(parts[1], 10),\n      };\n    }\n\n    default:\n      throw new Error(`Unknown trace event key: ${key}`);\n  }\n}\n"]}