chrome-devtools-frontend
Version:
Chrome DevTools UI
1,296 lines (1,188 loc) • 56.3 kB
text/typescript
/*
* Copyright (C) 2014 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
import * as Common from '../../core/common/common.js';
import * as Host from '../../core/host/host.js';
import * as i18n from '../../core/i18n/i18n.js';
import * as Platform from '../../core/platform/platform.js';
import * as Root from '../../core/root/root.js';
import * as SDK from '../../core/sdk/sdk.js';
import * as Bindings from '../../models/bindings/bindings.js';
import * as TimelineModel from '../../models/timeline_model/timeline_model.js';
import * as PerfUI from '../../ui/legacy/components/perf_ui/perf_ui.js';
import * as UI from '../../ui/legacy/legacy.js';
import * as ThemeSupport from '../../ui/legacy/theme_support/theme_support.js';
import timelineFlamechartPopoverStyles from './timelineFlamechartPopover.css.js';
import type {PerformanceModel} from './PerformanceModel.js';
import {FlameChartStyle, Selection, TimelineFlameChartMarker} from './TimelineFlameChartView.js';
import {TimelineSelection} from './TimelinePanel.js';
import type {TimelineCategory} from './TimelineUIUtils.js';
import {TimelineUIUtils, assignLayoutShiftsToClusters} from './TimelineUIUtils.js';
const UIStrings = {
/**
*@description Text in Timeline Flame Chart Data Provider of the Performance panel
*/
onIgnoreList: 'On ignore list',
/**
*@description Text that refers to the animation of the web page
*/
animation: 'Animation',
/**
*@description Text in Timeline Flame Chart Data Provider of the Performance panel
*/
timings: 'Timings',
/**
*@description Title of the Console tool
*/
console: 'Console',
/**
*@description Text in Timeline Flame Chart Data Provider of the Performance panel
*@example {example.com} PH1
*/
mainS: 'Main — {PH1}',
/**
*@description Text that refers to the main target
*/
main: 'Main',
/**
*@description Text in Timeline Flame Chart Data Provider of the Performance panel
*@example {https://example.com} PH1
*/
frameS: 'Frame — {PH1}',
/**
*@description Text in Timeline Flame Chart Data Provider of the Performance panel
*/
subframe: 'Subframe',
/**
*@description Text in Timeline Flame Chart Data Provider of the Performance panel
*/
raster: 'Raster',
/**
*@description Text in Timeline Flame Chart Data Provider of the Performance panel
*@example {2} PH1
*/
rasterizerThreadS: 'Rasterizer Thread {PH1}',
/**
*@description Text in Timeline Flame Chart Data Provider of the Performance panel
*/
gpu: 'GPU',
/**
*@description Text in Timeline Flame Chart Data Provider of the Performance panel
*/
thread: 'Thread',
/**
*@description Text in Timeline for the Experience title
*/
experience: 'Experience',
/**
*@description Text for rendering frames
*/
frames: 'Frames',
/**
* @description Text in the Performance panel to show how long was spent in a particular part of the code.
* The first placeholder is the total time taken for this node and all children, the second is the self time
* (time taken in this node, without children included).
*@example {10ms} PH1
*@example {10ms} PH2
*/
sSelfS: '{PH1} (self {PH2})',
/**
*@description Tooltip text for the number of CLS occurences in Timeline
*@example {4} PH1
*/
occurrencesS: 'Occurrences: {PH1}',
/**
*@description Text in Timeline Flame Chart Data Provider of the Performance panel
*/
idleFrame: 'Idle Frame',
/**
*@description Text in Timeline Frame Chart Data Provider of the Performance panel
*/
droppedFrame: 'Dropped Frame',
/**
*@description Text in Timeline Frame Chart Data Provider of the Performance panel
*/
partiallyPresentedFrame: 'Partially Presented Frame',
/**
*@description Text for a rendering frame
*/
frame: 'Frame',
/**
*@description Warning text content in Timeline Flame Chart Data Provider of the Performance panel
*/
longFrame: 'Long frame',
/**
* @description Text for the name of a thread of the page. Used when there are multiple threads but
* a more specific name for this thread is not available. The placeholder is a number that uniquely
* identifies this thread.
* @example {1} PH1
*/
threadS: 'Thread {PH1}',
};
const str_ = i18n.i18n.registerUIStrings('panels/timeline/TimelineFlameChartDataProvider.ts', UIStrings);
const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
type TimelineFlameChartEntry = (SDK.FilmStripModel.Frame|SDK.TracingModel.Event|
TimelineModel.TimelineFrameModel.TimelineFrame|TimelineModel.TimelineIRModel.Phases);
export class TimelineFlameChartDataProvider extends Common.ObjectWrapper.ObjectWrapper<EventTypes> implements
PerfUI.FlameChart.FlameChartDataProvider {
private readonly font: string;
private droppedFramePatternCanvas: HTMLCanvasElement;
private partialFramePatternCanvas: HTMLCanvasElement;
private timelineDataInternal: PerfUI.FlameChart.TimelineData|null;
private currentLevel: number;
private performanceModel: PerformanceModel|null;
private model: TimelineModel.TimelineModel.TimelineModelImpl|null;
private minimumBoundaryInternal: number;
private readonly maximumBoundary: number;
private timeSpan: number;
private readonly consoleColorGenerator: Common.Color.Generator;
private readonly extensionColorGenerator: Common.Color.Generator;
private readonly headerLevel1: PerfUI.FlameChart.GroupStyle;
private readonly headerLevel2: PerfUI.FlameChart.GroupStyle;
private readonly staticHeader: PerfUI.FlameChart.GroupStyle;
private framesHeader: PerfUI.FlameChart.GroupStyle;
private readonly collapsibleTimingsHeader: PerfUI.FlameChart.GroupStyle;
private readonly timingsHeader: PerfUI.FlameChart.GroupStyle;
private readonly screenshotsHeader: PerfUI.FlameChart.GroupStyle;
private readonly animationsHeader: PerfUI.FlameChart.GroupStyle;
private readonly experienceHeader: PerfUI.FlameChart.GroupStyle;
private readonly flowEventIndexById: Map<string, number>;
private entryData!: TimelineFlameChartEntry[];
private entryTypeByLevel!: EntryType[];
private markers!: TimelineFlameChartMarker[];
private asyncColorByInteractionPhase!: Map<TimelineModel.TimelineIRModel.Phases, string>;
private screenshotImageCache!: Map<SDK.FilmStripModel.Frame, HTMLImageElement|null>;
private extensionInfo!: {
title: string,
model: SDK.TracingModel.TracingModel,
}[];
private entryIndexToTitle!: string[];
private asyncColorByCategory!: Map<TimelineCategory, string>;
private lastInitiatorEntry!: number;
private entryParent!: SDK.TracingModel.Event[];
private frameGroup?: PerfUI.FlameChart.Group;
private lastSelection?: Selection;
private colorForEvent?: ((arg0: SDK.TracingModel.Event) => string);
constructor() {
super();
this.reset();
this.font = '11px ' + Host.Platform.fontFamily();
this.droppedFramePatternCanvas = document.createElement('canvas');
this.partialFramePatternCanvas = document.createElement('canvas');
this.preparePatternCanvas();
this.timelineDataInternal = null;
this.currentLevel = 0;
this.performanceModel = null;
this.model = null;
this.minimumBoundaryInternal = 0;
this.maximumBoundary = 0;
this.timeSpan = 0;
this.consoleColorGenerator = new Common.Color.Generator(
{
min: 30,
max: 55,
count: undefined,
},
{min: 70, max: 100, count: 6}, 50, 0.7);
this.extensionColorGenerator = new Common.Color.Generator(
{
min: 210,
max: 300,
count: undefined,
},
{min: 70, max: 100, count: 6}, 70, 0.7);
this.headerLevel1 = this.buildGroupStyle({shareHeaderLine: false});
this.headerLevel2 = this.buildGroupStyle({padding: 2, nestingLevel: 1, collapsible: false});
this.staticHeader = this.buildGroupStyle({collapsible: false});
this.framesHeader = this.buildGroupStyle({useFirstLineForOverview: true});
this.collapsibleTimingsHeader =
this.buildGroupStyle({shareHeaderLine: true, useFirstLineForOverview: true, collapsible: true});
this.timingsHeader =
this.buildGroupStyle({shareHeaderLine: true, useFirstLineForOverview: true, collapsible: false});
this.screenshotsHeader =
this.buildGroupStyle({useFirstLineForOverview: true, nestingLevel: 1, collapsible: false, itemsHeight: 150});
this.animationsHeader = this.buildGroupStyle({useFirstLineForOverview: false});
this.experienceHeader = this.buildGroupStyle({collapsible: false});
ThemeSupport.ThemeSupport.instance().addEventListener(ThemeSupport.ThemeChangeEvent.eventName, () => {
const headers = [
this.headerLevel1,
this.headerLevel2,
this.staticHeader,
this.framesHeader,
this.collapsibleTimingsHeader,
this.timingsHeader,
this.screenshotsHeader,
this.animationsHeader,
this.experienceHeader,
];
for (const header of headers) {
header.color = ThemeSupport.ThemeSupport.instance().getComputedValue('--color-text-primary');
header.backgroundColor = ThemeSupport.ThemeSupport.instance().getComputedValue('--color-background');
}
});
this.flowEventIndexById = new Map();
}
private buildGroupStyle(extra: Object): PerfUI.FlameChart.GroupStyle {
const defaultGroupStyle = {
padding: 4,
height: 17,
collapsible: true,
color: ThemeSupport.ThemeSupport.instance().getComputedValue('--color-text-primary'),
backgroundColor: ThemeSupport.ThemeSupport.instance().getComputedValue('--color-background'),
font: this.font,
nestingLevel: 0,
shareHeaderLine: true,
};
return Object.assign(defaultGroupStyle, extra);
}
setModel(performanceModel: PerformanceModel|null): void {
this.reset();
this.performanceModel = performanceModel;
this.model = performanceModel && performanceModel.timelineModel();
}
groupTrack(group: PerfUI.FlameChart.Group): TimelineModel.TimelineModel.Track|null {
return group.track || null;
}
// TODO(crbug.com/1172300) Ignored during the jsdoc to ts migration
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// TODO(crbug.com/1172300) Ignored during the jsdoc to ts migration
// eslint-disable-next-line @typescript-eslint/no-explicit-any
navStartTimes(): Map<any, any> {
if (!this.model) {
return new Map();
}
return this.model.navStartTimes();
}
entryTitle(entryIndex: number): string|null {
const entryTypes = EntryType;
const entryType = this.entryType(entryIndex);
if (entryType === entryTypes.Event) {
const event = (this.entryData[entryIndex] as SDK.TracingModel.Event);
if (event.phase === SDK.TracingModel.Phase.AsyncStepInto ||
event.phase === SDK.TracingModel.Phase.AsyncStepPast) {
return event.name + ':' + event.args['step'];
}
if (eventToDisallowRoot.get(event)) {
return i18nString(UIStrings.onIgnoreList);
}
if (this.performanceModel && this.performanceModel.timelineModel().isMarkerEvent(event)) {
return TimelineUIUtils.markerShortTitle(event);
}
return TimelineUIUtils.eventTitle(event);
}
if (entryType === entryTypes.ExtensionEvent) {
const event = (this.entryData[entryIndex] as SDK.TracingModel.Event);
return event.name;
}
if (entryType === entryTypes.Screenshot) {
return '';
}
let title: Common.UIString.LocalizedString|string = this.entryIndexToTitle[entryIndex];
if (!title) {
title = `Unexpected entryIndex ${entryIndex}`;
console.error(title);
}
return title;
}
textColor(index: number): string {
const event = this.entryData[index];
return event && eventToDisallowRoot.get((event as SDK.TracingModel.Event)) ? '#888' : FlameChartStyle.textColor;
}
entryFont(_index: number): string|null {
return this.font;
}
reset(): void {
this.currentLevel = 0;
this.timelineDataInternal = null;
this.entryData = [];
this.entryParent = [];
this.entryTypeByLevel = [];
this.entryIndexToTitle = [];
this.markers = [];
this.asyncColorByCategory = new Map();
this.asyncColorByInteractionPhase = new Map();
this.extensionInfo = [];
this.screenshotImageCache = new Map();
}
maxStackDepth(): number {
return this.currentLevel;
}
timelineData(): PerfUI.FlameChart.TimelineData {
if (this.timelineDataInternal) {
return this.timelineDataInternal;
}
this.timelineDataInternal = new PerfUI.FlameChart.TimelineData([], [], [], []);
if (!this.model) {
return this.timelineDataInternal;
}
this.flowEventIndexById.clear();
this.minimumBoundaryInternal = this.model.minimumRecordTime();
this.timeSpan = this.model.isEmpty() ? 1000 : this.model.maximumRecordTime() - this.minimumBoundaryInternal;
this.currentLevel = 0;
if (this.model.isGenericTrace()) {
this.processGenericTrace();
} else {
this.processInspectorTrace();
}
return this.timelineDataInternal;
}
private processGenericTrace(): void {
const processGroupStyle = this.buildGroupStyle({shareHeaderLine: false});
const threadGroupStyle = this.buildGroupStyle({padding: 2, nestingLevel: 1, shareHeaderLine: false});
const eventEntryType = EntryType.Event;
const tracksByProcess =
new Platform.MapUtilities.Multimap<SDK.TracingModel.Process, TimelineModel.TimelineModel.Track>();
if (!this.model) {
return;
}
for (const track of this.model.tracks()) {
if (track.thread !== null) {
tracksByProcess.set(track.thread.process(), track);
} else {
// The Timings track can reach this point, so we should probably do something more useful.
console.error('Failed to process track');
}
}
for (const process of tracksByProcess.keysArray()) {
if (tracksByProcess.size > 1) {
const name = `${process.name()} ${process.id()}`;
this.appendHeader(name, processGroupStyle, false /* selectable */);
}
for (const track of tracksByProcess.get(process)) {
const group = this.appendSyncEvents(
track, track.events, track.name, threadGroupStyle, eventEntryType, true /* selectable */);
if (this.timelineDataInternal &&
(!this.timelineDataInternal.selectedGroup ||
track.name === TimelineModel.TimelineModel.TimelineModelImpl.BrowserMainThreadName)) {
this.timelineDataInternal.selectedGroup = group;
}
}
}
}
private processInspectorTrace(): void {
this.appendFrames();
this.appendInteractionRecords();
const eventEntryType = EntryType.Event;
const weight = (track: TimelineModel.TimelineModel.Track): 1|2|3|4|5|6|7|8|9|10|- 1 => {
switch (track.type) {
case TimelineModel.TimelineModel.TrackType.Animation:
return 1;
case TimelineModel.TimelineModel.TrackType.Timings:
return 2;
case TimelineModel.TimelineModel.TrackType.Console:
return 3;
case TimelineModel.TimelineModel.TrackType.Experience:
return 4;
case TimelineModel.TimelineModel.TrackType.MainThread:
return track.forMainFrame ? 5 : 6;
case TimelineModel.TimelineModel.TrackType.Worker:
return 7;
case TimelineModel.TimelineModel.TrackType.Raster:
return 8;
case TimelineModel.TimelineModel.TrackType.GPU:
return 9;
case TimelineModel.TimelineModel.TrackType.Other:
return 10;
default:
return -1;
}
};
if (!this.model) {
return;
}
const tracks = this.model.tracks().slice();
tracks.sort((a, b) => weight(a) - weight(b));
let rasterCount = 0;
for (const track of tracks) {
switch (track.type) {
case TimelineModel.TimelineModel.TrackType.Animation: {
this.appendAsyncEventsGroup(
track, i18nString(UIStrings.animation), track.asyncEvents, this.animationsHeader, eventEntryType,
false /* selectable */);
break;
}
case TimelineModel.TimelineModel.TrackType.Timings: {
const style = track.asyncEvents.length > 0 ? this.collapsibleTimingsHeader : this.timingsHeader;
const group = this.appendHeader(i18nString(UIStrings.timings), style, true /* selectable */);
group.track = track;
this.appendPageMetrics();
this.copyPerfMarkEvents(track);
this.appendSyncEvents(track, track.events, null, null, eventEntryType, true /* selectable */);
this.appendAsyncEventsGroup(track, null, track.asyncEvents, null, eventEntryType, true /* selectable */);
break;
}
case TimelineModel.TimelineModel.TrackType.Console: {
this.appendAsyncEventsGroup(
track, i18nString(UIStrings.console), track.asyncEvents, this.headerLevel1, eventEntryType,
true /* selectable */);
break;
}
case TimelineModel.TimelineModel.TrackType.MainThread: {
if (track.forMainFrame) {
const group = this.appendSyncEvents(
track, track.events,
track.url ? i18nString(UIStrings.mainS, {PH1: track.url}) : i18nString(UIStrings.main),
this.headerLevel1, eventEntryType, true /* selectable */);
if (group && this.timelineDataInternal) {
this.timelineDataInternal.selectedGroup = group;
}
} else {
this.appendSyncEvents(
track, track.events,
track.url ? i18nString(UIStrings.frameS, {PH1: track.url}) : i18nString(UIStrings.subframe),
this.headerLevel1, eventEntryType, true /* selectable */);
}
break;
}
case TimelineModel.TimelineModel.TrackType.Worker: {
this.appendSyncEvents(
track, track.events, track.name, this.headerLevel1, eventEntryType, true /* selectable */);
break;
}
case TimelineModel.TimelineModel.TrackType.Raster: {
if (!rasterCount) {
this.appendHeader(i18nString(UIStrings.raster), this.headerLevel1, false /* selectable */);
}
++rasterCount;
this.appendSyncEvents(
track, track.events, i18nString(UIStrings.rasterizerThreadS, {PH1: rasterCount}), this.headerLevel2,
eventEntryType, true /* selectable */);
break;
}
case TimelineModel.TimelineModel.TrackType.GPU: {
this.appendSyncEvents(
track, track.events, i18nString(UIStrings.gpu), this.headerLevel1, eventEntryType, true /* selectable */);
break;
}
case TimelineModel.TimelineModel.TrackType.Other: {
this.appendSyncEvents(
track, track.events, track.name || i18nString(UIStrings.thread), this.headerLevel1, eventEntryType,
true /* selectable */);
this.appendAsyncEventsGroup(
track, track.name, track.asyncEvents, this.headerLevel1, eventEntryType, true /* selectable */);
break;
}
case TimelineModel.TimelineModel.TrackType.Experience: {
this.appendSyncEvents(
track, track.events, i18nString(UIStrings.experience), this.experienceHeader, eventEntryType,
true /* selectable */);
break;
}
}
}
if (this.timelineDataInternal && this.timelineDataInternal.selectedGroup) {
this.timelineDataInternal.selectedGroup.expanded = true;
}
for (let extensionIndex = 0; extensionIndex < this.extensionInfo.length; extensionIndex++) {
this.innerAppendExtensionEvents(extensionIndex);
}
this.markers.sort((a, b) => a.startTime() - b.startTime());
if (this.timelineDataInternal) {
this.timelineDataInternal.markers = this.markers;
}
this.flowEventIndexById.clear();
}
minimumBoundary(): number {
return this.minimumBoundaryInternal;
}
totalTime(): number {
return this.timeSpan;
}
search(startTime: number, endTime: number, filter: TimelineModel.TimelineModelFilter.TimelineModelFilter): number[] {
const result = [];
const entryTypes = EntryType;
this.timelineData();
for (let i = 0; i < this.entryData.length; ++i) {
if (this.entryType(i) !== entryTypes.Event) {
continue;
}
const event = (this.entryData[i] as SDK.TracingModel.Event);
if (event.startTime > endTime) {
continue;
}
if ((event.endTime || event.startTime) < startTime) {
continue;
}
if (filter.accept(event)) {
result.push(i);
}
}
result.sort(
(a, b) => SDK.TracingModel.Event.compareStartTime(
(this.entryData[a] as SDK.TracingModel.Event), (this.entryData[b] as SDK.TracingModel.Event)));
return result;
}
private appendSyncEvents(
track: TimelineModel.TimelineModel.Track|null, events: SDK.TracingModel.Event[], title: string|null,
style: PerfUI.FlameChart.GroupStyle|null, entryType: EntryType, selectable: boolean): PerfUI.FlameChart.Group
|null {
if (!events.length) {
return null;
}
if (!this.performanceModel || !this.model) {
return null;
}
const isExtension = entryType === EntryType.ExtensionEvent;
const openEvents = [];
const ignoreListingEnabled = !isExtension && Root.Runtime.experiments.isEnabled('ignoreListJSFramesOnTimeline');
let maxStackDepth = 0;
let group: PerfUI.FlameChart.Group|null = null;
if (track && track.type === TimelineModel.TimelineModel.TrackType.MainThread) {
group = this.appendHeader((title as string), (style as PerfUI.FlameChart.GroupStyle), selectable);
group.track = track;
}
for (let i = 0; i < events.length; ++i) {
const e = events[i];
// Skip Layout Shifts and TTI events when dealing with the main thread.
if (this.performanceModel) {
const isInteractiveTime = this.performanceModel.timelineModel().isInteractiveTimeEvent(e);
const isLayoutShift = this.performanceModel.timelineModel().isLayoutShiftEvent(e);
const skippableEvent = isInteractiveTime || isLayoutShift;
if (track && track.type === TimelineModel.TimelineModel.TrackType.MainThread && skippableEvent) {
continue;
}
}
if (this.performanceModel && this.performanceModel.timelineModel().isLayoutShiftEvent(e)) {
// Expand layout shift events to the size of the frame in which it is situated.
for (const frame of this.performanceModel.frames()) {
// Locate the correct frame and expand the event accordingly.
if (typeof e.endTime === 'undefined') {
e.setEndTime(e.startTime);
}
const isAfterStartTime = e.startTime >= frame.startTime;
const isBeforeEndTime = e.endTime && e.endTime <= frame.endTime;
const eventIsInFrame = isAfterStartTime && isBeforeEndTime;
if (!eventIsInFrame) {
continue;
}
e.startTime = frame.startTime;
e.setEndTime(frame.endTime);
}
}
if (!isExtension && this.performanceModel.timelineModel().isMarkerEvent(e)) {
this.markers.push(new TimelineFlameChartMarker(
e.startTime, e.startTime - this.model.minimumRecordTime(), TimelineUIUtils.markerStyleForEvent(e)));
}
if (!SDK.TracingModel.TracingModel.isFlowPhase(e.phase)) {
if (!e.endTime && e.phase !== SDK.TracingModel.Phase.Instant) {
continue;
}
if (SDK.TracingModel.TracingModel.isAsyncPhase(e.phase)) {
continue;
}
if (!isExtension && !this.performanceModel.isVisible(e)) {
continue;
}
}
while (openEvents.length &&
// TODO(crbug.com/1172300) Ignored during the jsdoc to ts migration
// @ts-expect-error
((openEvents[openEvents.length - 1] as SDK.TracingModel.Event).endTime) <= e.startTime) {
openEvents.pop();
}
eventToDisallowRoot.set(e, false);
if (ignoreListingEnabled && this.isIgnoreListedEvent(e)) {
const parent = openEvents[openEvents.length - 1];
if (parent && eventToDisallowRoot.get(parent)) {
continue;
}
eventToDisallowRoot.set(e, true);
}
if (!group && title) {
group = this.appendHeader(title, (style as PerfUI.FlameChart.GroupStyle), selectable);
if (selectable) {
group.track = track;
}
}
const level = this.currentLevel + openEvents.length;
const index = this.appendEvent(e, level);
if (openEvents.length) {
this.entryParent[index] = (openEvents[openEvents.length - 1] as SDK.TracingModel.Event);
}
if (!isExtension && this.performanceModel.timelineModel().isMarkerEvent(e)) {
// @ts-ignore This is invalid code, but we should keep it for now
this.timelineDataInternal.entryTotalTimes[this.entryData.length] = undefined;
}
maxStackDepth = Math.max(maxStackDepth, openEvents.length + 1);
if (e.endTime) {
openEvents.push(e);
}
}
this.entryTypeByLevel.length = this.currentLevel + maxStackDepth;
this.entryTypeByLevel.fill(entryType, this.currentLevel);
this.currentLevel += maxStackDepth;
return group;
}
private isIgnoreListedEvent(event: SDK.TracingModel.Event): boolean {
if (event.name !== TimelineModel.TimelineModel.RecordType.JSFrame) {
return false;
}
const url = event.args['data']['url'] as Platform.DevToolsPath.UrlString;
return url && this.isIgnoreListedURL(url);
}
private isIgnoreListedURL(url: Platform.DevToolsPath.UrlString): boolean {
return Bindings.IgnoreListManager.IgnoreListManager.instance().isIgnoreListedURL(url);
}
private appendAsyncEventsGroup(
track: TimelineModel.TimelineModel.Track|null, title: string|null, events: SDK.TracingModel.AsyncEvent[],
style: PerfUI.FlameChart.GroupStyle|null, entryType: EntryType, selectable: boolean): PerfUI.FlameChart.Group
|null {
if (!events.length) {
return null;
}
const lastUsedTimeByLevel: number[] = [];
let group: PerfUI.FlameChart.Group|null = null;
for (let i = 0; i < events.length; ++i) {
const asyncEvent = events[i];
if (!this.performanceModel || !this.performanceModel.isVisible(asyncEvent)) {
continue;
}
if (!group && title) {
group = this.appendHeader(title, (style as PerfUI.FlameChart.GroupStyle), selectable);
if (selectable) {
group.track = track;
}
}
const startTime = asyncEvent.startTime;
let level;
for (level = 0; level < lastUsedTimeByLevel.length && lastUsedTimeByLevel[level] > startTime; ++level) {
}
this.appendAsyncEvent(asyncEvent, this.currentLevel + level);
lastUsedTimeByLevel[level] = (asyncEvent.endTime as number);
}
this.entryTypeByLevel.length = this.currentLevel + lastUsedTimeByLevel.length;
this.entryTypeByLevel.fill(entryType, this.currentLevel);
this.currentLevel += lastUsedTimeByLevel.length;
return group;
}
private appendInteractionRecords(): void {
if (!this.performanceModel) {
return;
}
const interactionRecords = this.performanceModel.interactionRecords();
if (!interactionRecords.length) {
return;
}
for (const segment of interactionRecords) {
const index = this.entryData.length;
this.entryData.push((segment.data as TimelineModel.TimelineIRModel.Phases));
this.entryIndexToTitle[index] = (segment.data as string);
if (this.timelineDataInternal) {
this.timelineDataInternal.entryLevels[index] = this.currentLevel;
this.timelineDataInternal.entryTotalTimes[index] = segment.end - segment.begin;
this.timelineDataInternal.entryStartTimes[index] = segment.begin;
}
}
this.entryTypeByLevel[this.currentLevel++] = EntryType.InteractionRecord;
}
private appendPageMetrics(): void {
this.entryTypeByLevel[this.currentLevel] = EntryType.Event;
if (!this.performanceModel || !this.model) {
return;
}
const metricEvents: SDK.TracingModel.Event[] = [];
const lcpEvents = [];
const layoutShifts: SDK.TracingModel.Event[] = [];
const timelineModel = this.performanceModel.timelineModel();
for (const track of this.model.tracks()) {
for (const event of track.events) {
if (timelineModel.isLayoutShiftEvent(event)) {
layoutShifts.push(event);
}
if (!timelineModel.isMarkerEvent(event)) {
continue;
}
if (timelineModel.isLCPCandidateEvent(event) || timelineModel.isLCPInvalidateEvent(event)) {
lcpEvents.push(event);
} else {
metricEvents.push(event);
}
}
}
// Only the LCP event with the largest candidate index is relevant.
// Do not record an LCP event if it is an invalidate event.
if (lcpEvents.length > 0) {
const lcpEventsByNavigationId = new Map<string, SDK.TracingModel.Event>();
for (const e of lcpEvents) {
const key = e.args['data']['navigationId'];
const previousLastEvent = lcpEventsByNavigationId.get(key);
if (!previousLastEvent || previousLastEvent.args['data']['candidateIndex'] < e.args['data']['candidateIndex']) {
lcpEventsByNavigationId.set(key, e);
}
}
const latestCandidates = Array.from(lcpEventsByNavigationId.values());
const latestEvents = latestCandidates.filter(e => timelineModel.isLCPCandidateEvent(e));
metricEvents.push(...latestEvents);
}
if (layoutShifts.length) {
assignLayoutShiftsToClusters(layoutShifts);
}
metricEvents.sort(SDK.TracingModel.Event.compareStartTime);
if (this.timelineDataInternal) {
const totalTimes = this.timelineDataInternal.entryTotalTimes;
for (const event of metricEvents) {
this.appendEvent(event, this.currentLevel);
totalTimes[totalTimes.length - 1] = Number.NaN;
}
}
++this.currentLevel;
}
/**
* This function pushes a copy of each performance.mark() event from the Main track
* into Timings so they can be appended to the performance UI.
* Performance.mark() are a part of the "blink.user_timing" category alongside
* Navigation and Resource Timing events, so we must filter them out before pushing.
*/
private copyPerfMarkEvents(timingTrack: TimelineModel.TimelineModel.Track|null): void {
this.entryTypeByLevel[this.currentLevel] = EntryType.Event;
if (!this.performanceModel || !this.model || !timingTrack) {
return;
}
const timelineModel = this.performanceModel.timelineModel();
const ResourceTimingNames = [
'workerStart',
'redirectStart',
'redirectEnd',
'fetchStart',
'domainLookupStart',
'domainLookupEnd',
'connectStart',
'connectEnd',
'secureConnectionStart',
'requestStart',
'responseStart',
'responseEnd',
];
const NavTimingNames = [
'navigationStart',
'unloadEventStart',
'unloadEventEnd',
'redirectStart',
'redirectEnd',
'fetchStart',
'domainLookupStart',
'domainLookupEnd',
'connectStart',
'connectEnd',
'secureConnectionStart',
'requestStart',
'responseStart',
'responseEnd',
'domLoading',
'domInteractive',
'domContentLoadedEventStart',
'domContentLoadedEventEnd',
'domComplete',
'loadEventStart',
'loadEventEnd',
];
const IgnoreNames = [...ResourceTimingNames, ...NavTimingNames];
for (const track of this.model.tracks()) {
if (track.type === TimelineModel.TimelineModel.TrackType.MainThread) {
for (const event of track.events) {
if (timelineModel.isUserTimingEvent(event)) {
if (IgnoreNames.includes(event.name)) {
continue;
}
if (SDK.TracingModel.TracingModel.isAsyncPhase(event.phase)) {
continue;
}
event.setEndTime(event.startTime);
timingTrack.events.push(event);
}
}
}
}
++this.currentLevel;
}
private appendFrames(): void {
if (!this.performanceModel || !this.timelineDataInternal || !this.model) {
return;
}
const screenshots = this.performanceModel.filmStripModel().frames();
const hasFilmStrip = Boolean(screenshots.length);
this.framesHeader.collapsible = hasFilmStrip;
this.appendHeader(i18nString(UIStrings.frames), this.framesHeader, false /* selectable */);
this.frameGroup = this.timelineDataInternal.groups[this.timelineDataInternal.groups.length - 1];
const style = TimelineUIUtils.markerStyleForFrame();
this.entryTypeByLevel[this.currentLevel] = EntryType.Frame;
for (const frame of this.performanceModel.frames()) {
this.markers.push(
new TimelineFlameChartMarker(frame.startTime, frame.startTime - this.model.minimumRecordTime(), style));
this.appendFrame(frame);
}
++this.currentLevel;
if (!hasFilmStrip) {
return;
}
this.appendHeader('', this.screenshotsHeader, false /* selectable */);
this.entryTypeByLevel[this.currentLevel] = EntryType.Screenshot;
let prevTimestamp: number|undefined;
for (const screenshot of screenshots) {
this.entryData.push(screenshot);
(this.timelineDataInternal.entryLevels as number[]).push(this.currentLevel);
(this.timelineDataInternal.entryStartTimes as number[]).push(screenshot.timestamp);
if (prevTimestamp) {
(this.timelineDataInternal.entryTotalTimes as number[]).push(screenshot.timestamp - prevTimestamp);
}
prevTimestamp = screenshot.timestamp;
}
if (screenshots.length && prevTimestamp !== undefined) {
(this.timelineDataInternal.entryTotalTimes as number[]).push(this.model.maximumRecordTime() - prevTimestamp);
}
++this.currentLevel;
}
private entryType(entryIndex: number): EntryType {
return this.entryTypeByLevel[(this.timelineDataInternal as PerfUI.FlameChart.TimelineData).entryLevels[entryIndex]];
}
prepareHighlightedEntryInfo(entryIndex: number): Element|null {
let time = '';
let title;
let warning;
let nameSpanTimelineInfoTime = 'timeline-info-time';
const type = this.entryType(entryIndex);
if (type === EntryType.Event) {
const event = (this.entryData[entryIndex] as SDK.TracingModel.Event);
const totalTime = event.duration;
const selfTime = event.selfTime;
const eps = 1e-6;
if (typeof totalTime === 'number') {
time = Math.abs(totalTime - selfTime) > eps && selfTime > eps ?
i18nString(UIStrings.sSelfS, {
PH1: i18n.TimeUtilities.millisToString(totalTime, true),
PH2: i18n.TimeUtilities.millisToString(selfTime, true),
}) :
i18n.TimeUtilities.millisToString(totalTime, true);
}
if (this.performanceModel && this.performanceModel.timelineModel().isMarkerEvent(event)) {
title = TimelineUIUtils.eventTitle(event);
} else {
title = this.entryTitle(entryIndex);
}
warning = TimelineUIUtils.eventWarning(event);
if (this.model && this.model.isLayoutShiftEvent(event)) {
// TODO: Update this to be dynamic when the trace data supports it.
const occurrences = 1;
time = i18nString(UIStrings.occurrencesS, {PH1: occurrences});
}
if (this.model && this.model.isParseHTMLEvent(event)) {
const startLine = event.args['beginData']['startLine'];
const endLine = event.args['endData'] && event.args['endData']['endLine'];
const url = Bindings.ResourceUtils.displayNameForURL(event.args['beginData']['url']);
const range = (endLine !== -1 || endLine === startLine) ? `${startLine}...${endLine}` : startLine;
title += ` - ${url} [${range}]`;
}
} else if (type === EntryType.Frame) {
const frame = (this.entryData[entryIndex] as TimelineModel.TimelineFrameModel.TimelineFrame);
time = i18n.TimeUtilities.preciseMillisToString(frame.duration, 1);
if (frame.idle) {
title = i18nString(UIStrings.idleFrame);
} else if (frame.dropped) {
if (frame.isPartial) {
title = i18nString(UIStrings.partiallyPresentedFrame);
} else {
title = i18nString(UIStrings.droppedFrame);
}
nameSpanTimelineInfoTime = 'timeline-info-warning';
} else {
title = i18nString(UIStrings.frame);
}
if (frame.hasWarnings()) {
warning = document.createElement('span');
warning.textContent = i18nString(UIStrings.longFrame);
}
} else {
return null;
}
const element = document.createElement('div');
const root = UI.Utils.createShadowRootWithCoreStyles(element, {
cssFile: [timelineFlamechartPopoverStyles],
delegatesFocus: undefined,
});
const contents = root.createChild('div', 'timeline-flamechart-popover');
contents.createChild('span', nameSpanTimelineInfoTime).textContent = time;
contents.createChild('span', 'timeline-info-title').textContent = title;
if (warning) {
warning.classList.add('timeline-info-warning');
contents.appendChild(warning);
}
return element;
}
entryColor(entryIndex: number): string {
function patchColorAndCache<KEY>(cache: Map<KEY, string>, key: KEY, lookupColor: (arg0: KEY) => string): string {
let color = cache.get(key);
if (color) {
return color;
}
const parsedColor = Common.Color.Color.parse(lookupColor(key));
if (!parsedColor) {
throw new Error('Could not parse color from entry');
}
color = parsedColor.setAlpha(0.7).asString(Common.Color.Format.RGBA) || '';
cache.set(key, color);
return color;
}
if (!this.performanceModel || !this.model) {
return '';
}
const entryTypes = EntryType;
const type = this.entryType(entryIndex);
if (type === entryTypes.Event) {
const event = (this.entryData[entryIndex] as SDK.TracingModel.Event);
if (this.model.isGenericTrace()) {
return this.genericTraceEventColor(event);
}
if (this.performanceModel.timelineModel().isMarkerEvent(event)) {
return TimelineUIUtils.markerStyleForEvent(event).color;
}
if (!SDK.TracingModel.TracingModel.isAsyncPhase(event.phase) && this.colorForEvent) {
return this.colorForEvent(event);
}
if (event.hasCategory(TimelineModel.TimelineModel.TimelineModelImpl.Category.Console) ||
event.hasCategory(TimelineModel.TimelineModel.TimelineModelImpl.Category.UserTiming)) {
return this.consoleColorGenerator.colorForID(event.name);
}
if (event.hasCategory(TimelineModel.TimelineModel.TimelineModelImpl.Category.LatencyInfo)) {
const phase = TimelineModel.TimelineIRModel.TimelineIRModel.phaseForEvent(event) ||
TimelineModel.TimelineIRModel.Phases.Uncategorized;
return patchColorAndCache(this.asyncColorByInteractionPhase, phase, TimelineUIUtils.interactionPhaseColor);
}
const category = TimelineUIUtils.eventStyle(event).category;
return patchColorAndCache(this.asyncColorByCategory, category, () => category.color);
}
if (type === entryTypes.Frame) {
return 'white';
}
if (type === entryTypes.InteractionRecord) {
return 'transparent';
}
if (type === entryTypes.ExtensionEvent) {
const event = (this.entryData[entryIndex] as SDK.TracingModel.Event);
return this.extensionColorGenerator.colorForID(event.name);
}
return '';
}
private genericTraceEventColor(event: SDK.TracingModel.Event): string {
const key = event.categoriesString || event.name;
return key ? `hsl(${Platform.StringUtilities.hashCode(key) % 300 + 30}, 40%, 70%)` : '#ccc';
}
private preparePatternCanvas(): void {
// Set the candy stripe pattern to 17px so it repeats well.
const size = 17;
this.droppedFramePatternCanvas.width = size;
this.droppedFramePatternCanvas.height = size;
this.partialFramePatternCanvas.width = size;
this.partialFramePatternCanvas.height = size;
const ctx = this.droppedFramePatternCanvas.getContext('2d');
if (ctx) {
// Make a dense solid-line pattern.
ctx.translate(size * 0.5, size * 0.5);
ctx.rotate(Math.PI * 0.25);
ctx.translate(-size * 0.5, -size * 0.5);
ctx.fillStyle = 'rgb(255, 255, 255)';
for (let x = -size; x < size * 2; x += 3) {
ctx.fillRect(x, -size, 1, size * 3);
}
}
const ctx2 = this.partialFramePatternCanvas.getContext('2d');
if (ctx2) {
// Make a sparse dashed-line pattern.
ctx2.strokeStyle = 'rgb(255, 255, 255)';
ctx2.lineWidth = 2;
ctx2.beginPath();
ctx2.moveTo(17, 0);
ctx2.lineTo(10, 7);
ctx2.moveTo(8, 9);
ctx2.lineTo(2, 15);
ctx2.stroke();
}
}
private drawFrame(
entryIndex: number, context: CanvasRenderingContext2D, text: string|null, barX: number, barY: number,
barWidth: number, barHeight: number): void {
const hPadding = 1;
const frame = (this.entryData[entryIndex] as TimelineModel.TimelineFrameModel.TimelineFrame);
barX += hPadding;
barWidth -= 2 * hPadding;
if (frame.idle) {
context.fillStyle = 'white';
} else if (frame.dropped) {
if (frame.isPartial) {
// For partially presented frame boxes, paint a yellow background with
// a sparse white dashed-line pattern overlay.
context.fillStyle = '#f0e442';
context.fillRect(barX, barY, barWidth, barHeight);
const overlay = context.createPattern(this.partialFramePatternCanvas, 'repeat');
context.fillStyle = overlay || context.fillStyle;
} else {
// For dropped frame boxes, paint a red background with a dense white
// solid-line pattern overlay.
context.fillStyle = '#f08080';
context.fillRect(barX, barY, barWidth, barHeight);
const overlay = context.createPattern(this.droppedFramePatternCanvas, 'repeat');
context.fillStyle = overlay || context.fillStyle;
}
} else if (frame.hasWarnings()) {
context.fillStyle = '#fad1d1';
} else {
context.fillStyle = '#d7f0d1';
}
context.fillRect(barX, barY, barWidth, barHeight);
const frameDurationText = i18n.TimeUtilities.preciseMillisToString(frame.duration, 1);
const textWidth = context.measureText(frameDurationText).width;
if (textWidth <= barWidth) {
context.fillStyle = this.textColor(entryIndex);
context.fillText(frameDurationText, barX + (barWidth - textWidth) / 2, barY + barHeight - 4);
}
}
private async drawScreenshot(
entryIndex: number, context: CanvasRenderingContext2D, barX: number, barY: number, barWidth: number,
barHeight: number): Promise<void> {
const screenshot = (this.entryData[entryIndex] as SDK.FilmStripModel.Frame);
if (!this.screenshotImageCache.has(screenshot)) {
this.screenshotImageCache.set(screenshot, null);
const data = await screenshot.imageDataPromise();
const image = await UI.UIUtils.loadImageFromData(data);
this.screenshotImageCache.set(screenshot, image);
this.dispatchEventToListeners(Events.DataChanged);
return;
}
const image = this.screenshotImageCache.get(screenshot);
if (!image) {
return;
}
const imageX = barX + 1;
const imageY = barY + 1;
const imageHeight = barHeight - 2;
const scale = imageHeight / image.naturalHeight;
const imageWidth = Math.floor(image.naturalWidth * scale);
context.save();
context.beginPath();
context.rect(barX, barY, barWidth, barHeight);
context.clip();
context.drawImage(image, imageX, imageY, imageWidth, imageHeight);
context.strokeStyle = '#ccc';
context.strokeRect(imageX - 0.5, imageY - 0.5, Math.min(barWidth - 1, imageWidth + 1), imageHeight);
context.restore();
}
decorateEntry(
entryIndex: number, context: CanvasRenderingContext2D, text: string|null, barX: number, barY: number,
barWidth: number, barHeight: number, unclippedBarX: number, timeToPixels: number): boolean {
const data = this.entryData[entryIndex];
const type = this.entryType(entryIndex);
const entryTypes = EntryType;
if (type === entryTypes.Frame) {
this.drawFrame(entryIndex, context, text, barX, barY, barWidth, barHeight);
return true;
}
if (type === entryTypes.Screenshot) {
void this.drawScreenshot(entryIndex, context, barX, barY, barWidth, barHeight);
return true;
}
if (type === entryTypes.InteractionRecord) {
const color = TimelineUIUtils.interactionPhaseColor((data as TimelineModel.TimelineIRModel.Phases));
context.fillStyle = color;
context.fillRect(barX, barY, barWidth - 1, 2);
context.fillRect(barX, barY - 3, 2, 3);
context.fillRect(barX + barWidth - 3, barY - 3, 2, 3);
return false;
}
if (type === entryTypes.Event) {
const event = (data as SDK.TracingModel.Event);
if (event.hasCategory(TimelineModel.TimelineModel.TimelineModelImpl.Category.LatencyInfo)) {
const timeWaitingForMainThread =
TimelineModel.TimelineModel.TimelineData.forEvent(event).timeWaitingForMainThread;
if (timeWaitingForMainThread) {
context.fillStyle = 'hsla(0, 70%, 60%, 1)';
const width = Math.floor(unclippedBarX - barX + timeWaitingForMainThread * timeToPixels);
context.fillRect(barX, barY + barHeight - 3, width, 2);
}
}
if (TimelineModel.TimelineModel.TimelineData.forEvent(event).warning) {
paintWarningDecoration(barX, barWidth - 1.5);
}
}
function paintWarningDecoration(x: number, width: number): void {
const /** @const */ triangleSize = 8;
context.save();
context.beginPath();
context.rect(x, barY, width, barHeight);
context.clip();
context.beginPath();
context.fillStyle = 'red';
context.moveTo(x + width - triangleSize, barY);
context.lineTo(x + width, barY);
context.lineTo(x + width, barY + triangleSize);
context.fill();
context.restore();
}
return false;
}
forceDecoration(entryIndex: number): boolean {
const entryTypes = EntryType;
const type = this.entryType(entryIndex);
if (type === entryTypes.Frame) {
return true;
}
if (type === entryTypes.Screenshot) {
return true;
}
if (type === entryTypes.Event) {
const event = (this.entryData[entryIndex] as SDK.TracingModel.Event);
return Boolean(TimelineModel.TimelineModel.TimelineData.forEvent(event).warning);
}
return false;
}
appendExtensionEvents(entry: {
title: string,
model: SDK.TracingModel.TracingModel,
}): void {
this.extensionInfo.push(entry);
if (this.timelineDataInternal) {
this.innerAppendExtensionEvents(this.extensionInfo.length - 1);
}
}
private innerAppendExtensionEvents(index: number): void {
const entry = this.extensionInfo[index];
const entryType = EntryType.ExtensionEvent;
const allThreads = [...entry.model.sortedProcesses().map(process => process.sortedThreads())].flat();
if (!allThreads.length) {
return;
}
const singleTrack =
allThreads.length === 1 && (!allThreads[0].events().length || !allThreads[0].asyncEvents().length);
if (!singleTrack) {
this.appendHeader(entry.title, this.headerLevel1, false /* selectable */);
}
const style = singleTrack ? this.headerLevel2 : this.headerLevel1;
let threadIndex = 0;
for (const thread of allThreads) {
const title = singleTrack ? entry.title : thread.name() || i18nString(UIStrings.threadS, {PH1: ++threadIndex});
this.appendAsyncEventsGroup(null, title, thread.asyncEvents(), style, entryType, false /* selectable */);
this.appendSyncEvents(null, thread.events(), title, style, entryType, false /* selectable