UNPKG

chrome-devtools-frontend

Version:
1,267 lines (1,112 loc) 73.3 kB
/* * Copyright (C) 2011 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 type * as Protocol from '../../generated/protocol.js'; import * as Bindings from '../../models/bindings/bindings.js'; import * as HeapSnapshotModel from '../../models/heap_snapshot_model/heap_snapshot_model.js'; import * as DataGrid from '../../ui/legacy/components/data_grid/data_grid.js'; import * as ObjectUI from '../../ui/legacy/components/object_ui/object_ui.js'; import * as PerfUI from '../../ui/legacy/components/perf_ui/perf_ui.js'; import * as Components from '../../ui/legacy/components/utils/utils.js'; import * as UI from '../../ui/legacy/legacy.js'; import { AllocationDataGrid, HeapSnapshotSortableDataGridEvents, HeapSnapshotConstructorsDataGrid, HeapSnapshotDiffDataGrid, HeapSnapshotRetainmentDataGrid, HeapSnapshotContainmentDataGrid, type HeapSnapshotSortableDataGrid, } from './HeapSnapshotDataGrids.js'; import { HeapSnapshotGenericObjectNode, type AllocationGridNode, type HeapSnapshotGridNode, } from './HeapSnapshotGridNodes.js'; import {HeapSnapshotWorkerProxy, type HeapSnapshotProxy} from './HeapSnapshotProxy.js'; import {HeapTimelineOverview, Events, Samples, type IdsRangeChangedEvent} from './HeapTimelineOverview.js'; import * as ModuleUIStrings from './ModuleUIStrings.js'; import { Events as ProfileHeaderEvents, ProfileEvents as ProfileTypeEvents, ProfileHeader, ProfileType, type DataDisplayDelegate, } from './ProfileHeader.js'; import {ProfileSidebarTreeElement} from './ProfileSidebarTreeElement.js'; import {instance} from './ProfileTypeRegistry.js'; const UIStrings = { /** *@description Text to find an item */ find: 'Find', /** *@description Text in Heap Snapshot View of a profiler tool */ containment: 'Containment', /** *@description Retaining paths title text content in Heap Snapshot View of a profiler tool */ retainers: 'Retainers', /** *@description Text in Heap Snapshot View of a profiler tool */ allocationStack: 'Allocation stack', /** *@description Screen reader label for a select box that chooses the perspective in the Memory panel when vieweing a Heap Snapshot */ perspective: 'Perspective', /** *@description Screen reader label for a select box that chooses the snapshot to use as a base in the Memory panel when vieweing a Heap Snapshot */ baseSnapshot: 'Base snapshot', /** *@description Text to filter result items */ filter: 'Filter', /** * @description Filter label text in the Memory tool to filter by JavaScript class names for a heap * snapshot. */ classFilter: 'Class filter', /** *@description Text in Heap Snapshot View of a profiler tool */ code: 'Code', /** *@description Text in Heap Snapshot View of a profiler tool */ strings: 'Strings', /** *@description Label on a pie chart in the statistics view for the Heap Snapshot tool */ jsArrays: 'JS arrays', /** *@description Label on a pie chart in the statistics view for the Heap Snapshot tool */ typedArrays: 'Typed arrays', /** *@description Label on a pie chart in the statistics view for the Heap Snapshot tool */ systemObjects: 'System objects', /** *@description The reported total size used in the selected time frame of the allocation sampling profile *@example {3 MB} PH1 */ selectedSizeS: 'Selected size: {PH1}', /** *@description Text in Heap Snapshot View of a profiler tool */ allObjects: 'All objects', /** *@description Title in Heap Snapshot View of a profiler tool *@example {Profile 2} PH1 */ objectsAllocatedBeforeS: 'Objects allocated before {PH1}', /** *@description Title in Heap Snapshot View of a profiler tool *@example {Profile 1} PH1 *@example {Profile 2} PH2 */ objectsAllocatedBetweenSAndS: 'Objects allocated between {PH1} and {PH2}', /** *@description Text for the summary view */ summary: 'Summary', /** *@description Text in Heap Snapshot View of a profiler tool */ comparison: 'Comparison', /** *@description Text in Heap Snapshot View of a profiler tool */ allocation: 'Allocation', /** *@description Title text content in Heap Snapshot View of a profiler tool */ liveObjects: 'Live objects', /** *@description Text in Heap Snapshot View of a profiler tool */ statistics: 'Statistics', /** *@description Text in Heap Snapshot View of a profiler tool */ heapSnapshot: 'Heap snapshot', /** *@description Text in Heap Snapshot View of a profiler tool */ takeHeapSnapshot: 'Take heap snapshot', /** *@description Text in Heap Snapshot View of a profiler tool */ heapSnapshots: 'HEAP SNAPSHOTS', /** *@description Text in Heap Snapshot View of a profiler tool */ heapSnapshotProfilesShowMemory: 'Heap snapshot profiles show memory distribution among your page\'s JavaScript objects and related DOM nodes.', /** *@description Label for a checkbox in the heap snapshot view of the profiler tool. The "heap snapshot" contains the * current state of JavaScript memory. With this checkbox enabled, the snapshot also includes internal data that is * specific to Chrome (hence implementation-specific). */ exposeInternals: 'Expose internals (includes additional implementation-specific details)', /** *@description Text in Heap Snapshot View of a profiler tool * This option turns on inclusion of numerical values in the heap snapshot. */ captureNumericValue: 'Include numerical values in capture', /** *@description Progress update that the profiler is capturing a snapshot of the heap */ snapshotting: 'Snapshotting…', /** *@description Profile title in Heap Snapshot View of a profiler tool *@example {1} PH1 */ snapshotD: 'Snapshot {PH1}', /** *@description Text for a percentage value *@example {13.0} PH1 */ percentagePlaceholder: '{PH1}%', /** *@description Text in Heap Snapshot View of a profiler tool */ allocationInstrumentationOn: 'Allocation instrumentation on timeline', /** *@description Text in Heap Snapshot View of a profiler tool */ stopRecordingHeapProfile: 'Stop recording heap profile', /** *@description Text in Heap Snapshot View of a profiler tool */ startRecordingHeapProfile: 'Start recording heap profile', /** *@description Text in Heap Snapshot View of a profiler tool. * A stack trace is a list of functions that were called. * This option turns on recording of a stack trace at each allocation. * The recording itself is a somewhat expensive operation, so turning this option on, the website's performance may be affected negatively (e.g. everything becomes slower). */ recordAllocationStacksExtra: 'Record stack traces of allocations (extra performance overhead)', /** *@description Text in CPUProfile View of a profiler tool */ recording: 'Recording…', /** *@description Text in Heap Snapshot View of a profiler tool */ allocationTimelines: 'ALLOCATION TIMELINES', /** *@description Description for the 'Allocation timeline' tool in the Memory panel. */ AllocationTimelinesShowInstrumented: 'Allocation timelines show instrumented JavaScript memory allocations over time. Once profile is recorded you can select a time interval to see objects that were allocated within it and still alive by the end of recording. Use this profile type to isolate memory leaks.', /** *@description Text when something is loading */ loading: 'Loading…', /** *@description Text in Heap Snapshot View of a profiler tool *@example {30} PH1 */ savingD: 'Saving… {PH1}%', /** *@description Text in Heap Snapshot View of a profiler tool *@example {1,021} PH1 */ sKb: '{PH1} kB', /** *@description Text in Heap Snapshot View of a profiler tool */ heapMemoryUsage: 'Heap memory usage', /** *@description Text of a DOM element in Heap Snapshot View of a profiler tool */ stackWasNotRecordedForThisObject: 'Stack was not recorded for this object because it had been allocated before this profile recording started.', }; const str_ = i18n.i18n.registerUIStrings('panels/profiler/HeapSnapshotView.ts', UIStrings); const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_); // The way this is handled is to workaround the strings inside the heap_snapshot_worker // If strings are removed from inside the worker strings can be declared in this module // as any other. // eslint-disable-next-line @typescript-eslint/naming-convention const moduleUIstr_ = i18n.i18n.registerUIStrings('panels/profiler/ModuleUIStrings.ts', ModuleUIStrings.UIStrings); const moduleI18nString = i18n.i18n.getLocalizedString.bind(undefined, moduleUIstr_); export class HeapSnapshotView extends UI.View.SimpleView implements DataDisplayDelegate, UI.SearchableView.Searchable { searchResults: number[]; profile: HeapProfileHeader; readonly linkifier: Components.Linkifier.Linkifier; readonly parentDataDisplayDelegate: DataDisplayDelegate; readonly searchableViewInternal: UI.SearchableView.SearchableView; readonly splitWidget: UI.SplitWidget.SplitWidget; readonly containmentDataGrid: HeapSnapshotContainmentDataGrid; readonly containmentWidget: DataGrid.DataGrid.DataGridWidget<HeapSnapshotGridNode>; readonly statisticsView: HeapSnapshotStatisticsView; readonly constructorsDataGrid: HeapSnapshotConstructorsDataGrid; readonly constructorsWidget: DataGrid.DataGrid.DataGridWidget<HeapSnapshotGridNode>; readonly diffDataGrid: HeapSnapshotDiffDataGrid; readonly diffWidget: DataGrid.DataGrid.DataGridWidget<HeapSnapshotGridNode>; readonly allocationDataGrid: AllocationDataGrid|null; readonly allocationWidget: DataGrid.DataGrid.DataGridWidget<HeapSnapshotGridNode>|undefined; readonly allocationStackView: HeapAllocationStackView|undefined; readonly tabbedPane: UI.TabbedPane.TabbedPane|undefined; readonly retainmentDataGrid: HeapSnapshotRetainmentDataGrid; readonly retainmentWidget: DataGrid.DataGrid.DataGridWidget<HeapSnapshotGridNode>; readonly objectDetailsView: UI.Widget.VBox; readonly perspectives: (SummaryPerspective|ComparisonPerspective|ContainmentPerspective|AllocationPerspective| StatisticsPerspective)[]; readonly comparisonPerspective: ComparisonPerspective; readonly perspectiveSelect: UI.Toolbar.ToolbarComboBox; baseSelect: UI.Toolbar.ToolbarComboBox; readonly filterSelect: UI.Toolbar.ToolbarComboBox; readonly classNameFilter: UI.Toolbar.ToolbarInput; readonly selectedSizeText: UI.Toolbar.ToolbarText; readonly popoverHelper: UI.PopoverHelper.PopoverHelper; currentPerspectiveIndex: number; currentPerspective: SummaryPerspective|ComparisonPerspective|ContainmentPerspective|AllocationPerspective| StatisticsPerspective; dataGrid: HeapSnapshotSortableDataGrid|null; readonly searchThrottler: Common.Throttler.Throttler; baseProfile!: HeapProfileHeader|null; trackingOverviewGrid?: HeapTimelineOverview; currentSearchResultIndex: number = -1; currentQuery?: HeapSnapshotModel.HeapSnapshotModel.SearchConfig; constructor(dataDisplayDelegate: DataDisplayDelegate, profile: HeapProfileHeader) { super(i18nString(UIStrings.heapSnapshot)); this.searchResults = []; this.element.classList.add('heap-snapshot-view'); this.profile = profile; this.linkifier = new Components.Linkifier.Linkifier(); const profileType = profile.profileType(); profileType.addEventListener(HeapSnapshotProfileTypeEvents.SnapshotReceived, this.onReceiveSnapshot, this); profileType.addEventListener(ProfileTypeEvents.RemoveProfileHeader, this.onProfileHeaderRemoved, this); const isHeapTimeline = profileType.id === TrackingHeapSnapshotProfileType.TypeId; if (isHeapTimeline) { this.createOverview(); } const hasAllocationStacks = instance.trackingHeapSnapshotProfileType.recordAllocationStacksSetting().get(); this.parentDataDisplayDelegate = dataDisplayDelegate; this.searchableViewInternal = new UI.SearchableView.SearchableView(this, null); this.searchableViewInternal.setPlaceholder(i18nString(UIStrings.find), i18nString(UIStrings.find)); this.searchableViewInternal.show(this.element); this.splitWidget = new UI.SplitWidget.SplitWidget(false, true, 'heapSnapshotSplitViewState', 200, 200); this.splitWidget.show(this.searchableViewInternal.element); const heapProfilerModel = profile.heapProfilerModel(); this.containmentDataGrid = new HeapSnapshotContainmentDataGrid( heapProfilerModel, this, /* displayName */ i18nString(UIStrings.containment)); this.containmentDataGrid.addEventListener(DataGrid.DataGrid.Events.SelectedNode, this.selectionChanged, this); this.containmentWidget = this.containmentDataGrid.asWidget(); this.containmentWidget.setMinimumSize(50, 25); this.statisticsView = new HeapSnapshotStatisticsView(); this.constructorsDataGrid = new HeapSnapshotConstructorsDataGrid(heapProfilerModel, this); this.constructorsDataGrid.addEventListener(DataGrid.DataGrid.Events.SelectedNode, this.selectionChanged, this); this.constructorsWidget = this.constructorsDataGrid.asWidget(); this.constructorsWidget.setMinimumSize(50, 25); this.diffDataGrid = new HeapSnapshotDiffDataGrid(heapProfilerModel, this); this.diffDataGrid.addEventListener(DataGrid.DataGrid.Events.SelectedNode, this.selectionChanged, this); this.diffWidget = this.diffDataGrid.asWidget(); this.diffWidget.setMinimumSize(50, 25); this.allocationDataGrid = null; if (isHeapTimeline && hasAllocationStacks) { this.allocationDataGrid = new AllocationDataGrid(heapProfilerModel, this); this.allocationDataGrid.addEventListener( DataGrid.DataGrid.Events.SelectedNode, this.onSelectAllocationNode, this); this.allocationWidget = this.allocationDataGrid.asWidget(); this.allocationWidget.setMinimumSize(50, 25); this.allocationStackView = new HeapAllocationStackView(heapProfilerModel); this.allocationStackView.setMinimumSize(50, 25); this.tabbedPane = new UI.TabbedPane.TabbedPane(); } this.retainmentDataGrid = new HeapSnapshotRetainmentDataGrid(heapProfilerModel, this); this.retainmentWidget = this.retainmentDataGrid.asWidget(); this.retainmentWidget.setMinimumSize(50, 21); this.retainmentWidget.element.classList.add('retaining-paths-view'); let splitWidgetResizer; if (this.allocationStackView) { this.tabbedPane = new UI.TabbedPane.TabbedPane(); this.tabbedPane.appendTab('retainers', i18nString(UIStrings.retainers), this.retainmentWidget); this.tabbedPane.appendTab('allocation-stack', i18nString(UIStrings.allocationStack), this.allocationStackView); splitWidgetResizer = this.tabbedPane.headerElement(); this.objectDetailsView = this.tabbedPane; } else { const retainmentViewHeader = document.createElement('div'); retainmentViewHeader.classList.add('heap-snapshot-view-resizer'); const retainingPathsTitleDiv = retainmentViewHeader.createChild('div', 'title'); retainmentViewHeader.createChild('div', 'verticalResizerIcon'); const retainingPathsTitle = retainingPathsTitleDiv.createChild('span'); retainingPathsTitle.textContent = i18nString(UIStrings.retainers); splitWidgetResizer = retainmentViewHeader; this.objectDetailsView = new UI.Widget.VBox(); this.objectDetailsView.element.appendChild(retainmentViewHeader); this.retainmentWidget.show(this.objectDetailsView.element); } this.splitWidget.hideDefaultResizer(); this.splitWidget.installResizer(splitWidgetResizer); this.retainmentDataGrid.addEventListener(DataGrid.DataGrid.Events.SelectedNode, this.inspectedObjectChanged, this); this.retainmentDataGrid.reset(); this.perspectives = []; this.comparisonPerspective = new ComparisonPerspective(); this.perspectives.push(new SummaryPerspective()); if (profile.profileType() !== instance.trackingHeapSnapshotProfileType) { this.perspectives.push(this.comparisonPerspective); } this.perspectives.push(new ContainmentPerspective()); if (this.allocationWidget) { this.perspectives.push(new AllocationPerspective()); } this.perspectives.push(new StatisticsPerspective()); this.perspectiveSelect = new UI.Toolbar.ToolbarComboBox(this.onSelectedPerspectiveChanged.bind(this), i18nString(UIStrings.perspective)); this.updatePerspectiveOptions(); this.baseSelect = new UI.Toolbar.ToolbarComboBox(this.changeBase.bind(this), i18nString(UIStrings.baseSnapshot)); this.baseSelect.setVisible(false); this.updateBaseOptions(); this.filterSelect = new UI.Toolbar.ToolbarComboBox(this.changeFilter.bind(this), i18nString(UIStrings.filter)); this.filterSelect.setVisible(false); this.updateFilterOptions(); this.classNameFilter = new UI.Toolbar.ToolbarInput(i18nString(UIStrings.classFilter)); this.classNameFilter.setVisible(false); this.constructorsDataGrid.setNameFilter(this.classNameFilter); this.diffDataGrid.setNameFilter(this.classNameFilter); this.selectedSizeText = new UI.Toolbar.ToolbarText(); this.popoverHelper = new UI.PopoverHelper.PopoverHelper(this.element, this.getPopoverRequest.bind(this)); this.popoverHelper.setDisableOnClick(true); this.popoverHelper.setHasPadding(true); this.element.addEventListener('scroll', this.popoverHelper.hidePopover.bind(this.popoverHelper), true); this.currentPerspectiveIndex = 0; this.currentPerspective = this.perspectives[0]; this.currentPerspective.activate(this); this.dataGrid = this.currentPerspective.masterGrid(this); void this.populate(); this.searchThrottler = new Common.Throttler.Throttler(0); for (const existingProfile of this.profiles()) { existingProfile.addEventListener(ProfileHeaderEvents.ProfileTitleChanged, this.updateControls, this); } } createOverview(): void { const profileType = this.profile.profileType(); this.trackingOverviewGrid = new HeapTimelineOverview(); this.trackingOverviewGrid.addEventListener(Events.IdsRangeChanged, this.onIdsRangeChanged.bind(this)); if (!this.profile.fromFile() && profileType.profileBeingRecorded() === this.profile) { (profileType as TrackingHeapSnapshotProfileType) .addEventListener(TrackingHeapSnapshotProfileTypeEvents.HeapStatsUpdate, this.onHeapStatsUpdate, this); (profileType as TrackingHeapSnapshotProfileType) .addEventListener(TrackingHeapSnapshotProfileTypeEvents.TrackingStopped, this.onStopTracking, this); this.trackingOverviewGrid.start(); } } onStopTracking(): void { const profileType = this.profile.profileType() as TrackingHeapSnapshotProfileType; profileType.removeEventListener( TrackingHeapSnapshotProfileTypeEvents.HeapStatsUpdate, this.onHeapStatsUpdate, this); profileType.removeEventListener(TrackingHeapSnapshotProfileTypeEvents.TrackingStopped, this.onStopTracking, this); if (this.trackingOverviewGrid) { this.trackingOverviewGrid.stop(); } } onHeapStatsUpdate({data: samples}: Common.EventTarget.EventTargetEvent<Samples>): void { if (this.trackingOverviewGrid) { this.trackingOverviewGrid.setSamples(samples); } } searchableView(): UI.SearchableView.SearchableView { return this.searchableViewInternal; } showProfile(profile: ProfileHeader|null): UI.Widget.Widget|null { return this.parentDataDisplayDelegate.showProfile(profile); } showObject(snapshotObjectId: string, perspectiveName: string): void { if (Number(snapshotObjectId) <= this.profile.maxJSObjectId) { void this.selectLiveObject(perspectiveName, snapshotObjectId); } else { this.parentDataDisplayDelegate.showObject(snapshotObjectId, perspectiveName); } } async linkifyObject(nodeIndex: number): Promise<Element|null> { const heapProfilerModel = this.profile.heapProfilerModel(); // heapProfilerModel is null if snapshot was loaded from file if (!heapProfilerModel) { return null; } const location = await this.profile.getLocation(nodeIndex); if (!location) { return null; } const debuggerModel = heapProfilerModel.runtimeModel().debuggerModel(); const rawLocation = debuggerModel.createRawLocationByScriptId( String(location.scriptId) as Protocol.Runtime.ScriptId, location.lineNumber, location.columnNumber); if (!rawLocation) { return null; } const script = rawLocation.script(); const sourceURL = script && script.sourceURL; return sourceURL && this.linkifier ? this.linkifier.linkifyRawLocation(rawLocation, sourceURL) : null; } async populate(): Promise<void> { const heapSnapshotProxy = await this.profile.loadPromise; void this.retrieveStatistics(heapSnapshotProxy); if (this.dataGrid) { void this.dataGrid.setDataSource(heapSnapshotProxy, 0); } if (this.profile.profileType().id === TrackingHeapSnapshotProfileType.TypeId && this.profile.fromFile()) { const samples = await heapSnapshotProxy.getSamples(); if (samples) { console.assert(Boolean(samples.timestamps.length)); const profileSamples = new Samples(); profileSamples.sizes = samples.sizes; profileSamples.ids = samples.lastAssignedIds; profileSamples.timestamps = samples.timestamps; profileSamples.max = samples.sizes; profileSamples.totalTime = Math.max(samples.timestamps[samples.timestamps.length - 1] || 0, 10000); if (this.trackingOverviewGrid) { this.trackingOverviewGrid.setSamples(profileSamples); } } } const list = this.profiles(); const profileIndex = list.indexOf(this.profile); this.baseSelect.setSelectedIndex(Math.max(0, profileIndex - 1)); if (this.trackingOverviewGrid) { this.trackingOverviewGrid.updateGrid(); } } async retrieveStatistics(heapSnapshotProxy: HeapSnapshotProxy): Promise<HeapSnapshotModel.HeapSnapshotModel.Statistics> { const statistics = await heapSnapshotProxy.getStatistics(); const records = [ {value: statistics.code, color: '#f77', title: i18nString(UIStrings.code)}, {value: statistics.strings, color: '#5e5', title: i18nString(UIStrings.strings)}, {value: statistics.jsArrays, color: '#7af', title: i18nString(UIStrings.jsArrays)}, {value: statistics.native, color: '#fc5', title: i18nString(UIStrings.typedArrays)}, {value: statistics.system, color: '#98f', title: i18nString(UIStrings.systemObjects)}, ]; this.statisticsView.setTotalAndRecords(statistics.total, records); return statistics; } onIdsRangeChanged(event: Common.EventTarget.EventTargetEvent<IdsRangeChangedEvent>): void { const {minId, maxId} = event.data; this.selectedSizeText.setText( i18nString(UIStrings.selectedSizeS, {PH1: Platform.NumberUtilities.bytesToString(event.data.size)})); if (this.constructorsDataGrid.snapshot) { this.constructorsDataGrid.setSelectionRange(minId, maxId); } } override async toolbarItems(): Promise<UI.Toolbar.ToolbarItem[]> { const result: UI.Toolbar.ToolbarItem[] = [this.perspectiveSelect, this.classNameFilter]; if (this.profile.profileType() !== instance.trackingHeapSnapshotProfileType) { result.push(this.baseSelect, this.filterSelect); } result.push(this.selectedSizeText); return result; } override willHide(): void { this.currentSearchResultIndex = -1; this.popoverHelper.hidePopover(); } supportsCaseSensitiveSearch(): boolean { return true; } supportsRegexSearch(): boolean { return false; } onSearchCanceled(): void { this.currentSearchResultIndex = -1; this.searchResults = []; } selectRevealedNode(node: HeapSnapshotGridNode|null): void { if (node) { node.select(); } } performSearch(searchConfig: UI.SearchableView.SearchConfig, shouldJump: boolean, jumpBackwards?: boolean): void { const nextQuery = new HeapSnapshotModel.HeapSnapshotModel.SearchConfig( searchConfig.query.trim(), searchConfig.caseSensitive, searchConfig.isRegex, shouldJump, jumpBackwards || false); void this.searchThrottler.schedule(this.performSearchInternal.bind(this, nextQuery)); } async performSearchInternal(nextQuery: HeapSnapshotModel.HeapSnapshotModel.SearchConfig): Promise<void> { // Call onSearchCanceled since it will reset everything we need before doing a new search. this.onSearchCanceled(); if (!this.currentPerspective.supportsSearch()) { return; } this.currentQuery = nextQuery; const query = nextQuery.query.trim(); if (!query) { return; } if (query.charAt(0) === '@') { const snapshotNodeId = parseInt(query.substring(1), 10); if (isNaN(snapshotNodeId)) { return; } if (!this.dataGrid) { return; } const node = await this.dataGrid.revealObjectByHeapSnapshotId(String(snapshotNodeId)); this.selectRevealedNode(node); return; } if (!this.profile.snapshotProxy || !this.dataGrid) { return; } const filter = this.dataGrid.nodeFilter(); this.searchResults = filter ? await this.profile.snapshotProxy.search(this.currentQuery, filter) : []; this.searchableViewInternal.updateSearchMatchesCount(this.searchResults.length); if (this.searchResults.length) { this.currentSearchResultIndex = nextQuery.jumpBackward ? this.searchResults.length - 1 : 0; } await this.jumpToSearchResult(this.currentSearchResultIndex); } jumpToNextSearchResult(): void { if (!this.searchResults.length) { return; } this.currentSearchResultIndex = (this.currentSearchResultIndex + 1) % this.searchResults.length; void this.searchThrottler.schedule(this.jumpToSearchResult.bind(this, this.currentSearchResultIndex)); } jumpToPreviousSearchResult(): void { if (!this.searchResults.length) { return; } this.currentSearchResultIndex = (this.currentSearchResultIndex + this.searchResults.length - 1) % this.searchResults.length; void this.searchThrottler.schedule(this.jumpToSearchResult.bind(this, this.currentSearchResultIndex)); } async jumpToSearchResult(searchResultIndex: number): Promise<void> { this.searchableViewInternal.updateCurrentMatchIndex(searchResultIndex); if (searchResultIndex === -1) { return; } if (!this.dataGrid) { return; } const node = await this.dataGrid.revealObjectByHeapSnapshotId(String(this.searchResults[searchResultIndex])); this.selectRevealedNode(node); } refreshVisibleData(): void { if (!this.dataGrid) { return; } let child: (HeapSnapshotGridNode|null) = (this.dataGrid.rootNode().children[0] as HeapSnapshotGridNode | null); while (child) { child.refresh(); child = (child.traverseNextNode(false, null, true) as HeapSnapshotGridNode | null); } } changeBase(): void { if (this.baseProfile === this.profiles()[this.baseSelect.selectedIndex()]) { return; } this.baseProfile = (this.profiles()[this.baseSelect.selectedIndex()] as HeapProfileHeader); const dataGrid = (this.dataGrid as HeapSnapshotDiffDataGrid); // Change set base data source only if main data source is already set. if (dataGrid.snapshot) { void this.baseProfile.loadPromise.then(dataGrid.setBaseDataSource.bind(dataGrid)); } if (!this.currentQuery || !this.searchResults) { return; } // The current search needs to be performed again. First negate out previous match // count by calling the search finished callback with a negative number of matches. // Then perform the search again with the same query and callback. this.performSearch(this.currentQuery, false); } changeFilter(): void { const profileIndex = this.filterSelect.selectedIndex() - 1; if (!this.dataGrid) { return; } (this.dataGrid as HeapSnapshotConstructorsDataGrid) .filterSelectIndexChanged((this.profiles() as HeapProfileHeader[]), profileIndex); if (!this.currentQuery || !this.searchResults) { return; } // The current search needs to be performed again. First negate out previous match // count by calling the search finished callback with a negative number of matches. // Then perform the search again with the same query and callback. this.performSearch(this.currentQuery, false); } profiles(): ProfileHeader[] { return this.profile.profileType().getProfiles(); } selectionChanged(event: Common.EventTarget.EventTargetEvent<DataGrid.DataGrid.DataGridNode<HeapSnapshotGridNode>>): void { const selectedNode = (event.data as HeapSnapshotGridNode); this.setSelectedNodeForDetailsView(selectedNode); this.inspectedObjectChanged(event); } onSelectAllocationNode( event: Common.EventTarget.EventTargetEvent<DataGrid.DataGrid.DataGridNode<HeapSnapshotGridNode>>): void { const selectedNode = (event.data as AllocationGridNode); this.constructorsDataGrid.setAllocationNodeId(selectedNode.allocationNodeId()); this.setSelectedNodeForDetailsView(null); } inspectedObjectChanged( event: Common.EventTarget.EventTargetEvent<DataGrid.DataGrid.DataGridNode<HeapSnapshotGridNode>>): void { const selectedNode = (event.data as HeapSnapshotGridNode); const heapProfilerModel = this.profile.heapProfilerModel(); if (heapProfilerModel && selectedNode instanceof HeapSnapshotGenericObjectNode) { void heapProfilerModel.addInspectedHeapObject( String(selectedNode.snapshotNodeId) as Protocol.HeapProfiler.HeapSnapshotObjectId); } } setSelectedNodeForDetailsView(nodeItem: HeapSnapshotGridNode|null): void { const dataSource = nodeItem && nodeItem.retainersDataSource(); if (dataSource) { void this.retainmentDataGrid.setDataSource(dataSource.snapshot, dataSource.snapshotNodeIndex); if (this.allocationStackView) { void this.allocationStackView.setAllocatedObject(dataSource.snapshot, dataSource.snapshotNodeIndex); } } else { if (this.allocationStackView) { this.allocationStackView.clear(); } this.retainmentDataGrid.reset(); } } async changePerspectiveAndWait(perspectiveTitle: string): Promise<void> { const perspectiveIndex = this.perspectives.findIndex(perspective => perspective.title() === perspectiveTitle); if (perspectiveIndex === -1 || this.currentPerspectiveIndex === perspectiveIndex) { return; } const dataGrid = this.perspectives[perspectiveIndex].masterGrid(this); if (!dataGrid) { return; } const promise = dataGrid.once(HeapSnapshotSortableDataGridEvents.ContentShown); const option = this.perspectiveSelect.options().find(option => option.value === String(perspectiveIndex)); this.perspectiveSelect.select((option as Element)); this.changePerspective(perspectiveIndex); await promise; } async updateDataSourceAndView(): Promise<void> { const dataGrid = this.dataGrid; if (!dataGrid || dataGrid.snapshot) { return; } const snapshotProxy = await this.profile.loadPromise; if (this.dataGrid !== dataGrid) { return; } if (dataGrid.snapshot !== snapshotProxy) { void dataGrid.setDataSource(snapshotProxy, 0); } if (dataGrid !== this.diffDataGrid) { return; } if (!this.baseProfile) { this.baseProfile = (this.profiles()[this.baseSelect.selectedIndex()] as HeapProfileHeader); } const baseSnapshotProxy = await this.baseProfile.loadPromise; if (this.diffDataGrid.baseSnapshot !== baseSnapshotProxy) { this.diffDataGrid.setBaseDataSource(baseSnapshotProxy); } } onSelectedPerspectiveChanged(event: Event): void { this.changePerspective(Number((event.target as HTMLSelectElement).selectedOptions[0].value)); } changePerspective(selectedIndex: number): void { if (selectedIndex === this.currentPerspectiveIndex) { return; } this.currentPerspectiveIndex = selectedIndex; this.currentPerspective.deactivate(this); const perspective = this.perspectives[selectedIndex]; this.currentPerspective = perspective; this.dataGrid = (perspective.masterGrid(this) as HeapSnapshotSortableDataGrid); perspective.activate(this); this.refreshVisibleData(); if (this.dataGrid) { this.dataGrid.updateWidths(); } void this.updateDataSourceAndView(); if (!this.currentQuery || !this.searchResults) { return; } // The current search needs to be performed again. First negate out previous match // count by calling the search finished callback with a negative number of matches. // Then perform the search again the with same query and callback. this.performSearch(this.currentQuery, false); } async selectLiveObject(perspectiveName: string, snapshotObjectId: string): Promise<void> { await this.changePerspectiveAndWait(perspectiveName); if (!this.dataGrid) { return; } const node = await this.dataGrid.revealObjectByHeapSnapshotId(snapshotObjectId); if (node) { node.select(); } else { Common.Console.Console.instance().error('Cannot find corresponding heap snapshot node'); } } getPopoverRequest(event: Event): UI.PopoverHelper.PopoverRequest|null { const span = UI.UIUtils.enclosingNodeOrSelfWithNodeName((event.target as Node), 'span'); const row = UI.UIUtils.enclosingNodeOrSelfWithNodeName((event.target as Node), 'tr'); if (!row) { return null; } if (!this.dataGrid) { return null; } const node = this.dataGrid.dataGridNodeFromNode(row) || this.containmentDataGrid.dataGridNodeFromNode(row) || this.constructorsDataGrid.dataGridNodeFromNode(row) || this.diffDataGrid.dataGridNodeFromNode(row) || (this.allocationDataGrid && this.allocationDataGrid.dataGridNodeFromNode(row)) || this.retainmentDataGrid.dataGridNodeFromNode(row); const heapProfilerModel = this.profile.heapProfilerModel(); if (!node || !span || !heapProfilerModel) { return null; } let objectPopoverHelper: ObjectUI.ObjectPopoverHelper.ObjectPopoverHelper|null; return { // TODO(crbug.com/1172300) Ignored during the jsdoc to ts migration) // @ts-expect-error box: span.boxInWindow(), show: async(popover: UI.GlassPane.GlassPane): Promise<boolean> => { if (!heapProfilerModel) { return false; } const remoteObject = await (node as HeapSnapshotGridNode).queryObjectContent(heapProfilerModel, 'popover'); if (!remoteObject) { return false; } objectPopoverHelper = await ObjectUI.ObjectPopoverHelper.ObjectPopoverHelper.buildObjectPopover(remoteObject, popover); if (!objectPopoverHelper) { heapProfilerModel.runtimeModel().releaseObjectGroup('popover'); return false; } return true; }, hide: (): void => { heapProfilerModel.runtimeModel().releaseObjectGroup('popover'); if (objectPopoverHelper) { objectPopoverHelper.dispose(); } }, }; } updatePerspectiveOptions(): void { const multipleSnapshots = this.profiles().length > 1; this.perspectiveSelect.removeOptions(); this.perspectives.forEach((perspective, index) => { if (multipleSnapshots || perspective !== this.comparisonPerspective) { this.perspectiveSelect.createOption(perspective.title(), String(index)); } }); } updateBaseOptions(): void { const list = this.profiles(); const selectedIndex = this.baseSelect.selectedIndex(); this.baseSelect.removeOptions(); for (const item of list) { this.baseSelect.createOption(item.title); } if (selectedIndex > -1) { this.baseSelect.setSelectedIndex(selectedIndex); } } updateFilterOptions(): void { const list = this.profiles(); const selectedIndex = this.filterSelect.selectedIndex(); this.filterSelect.removeOptions(); this.filterSelect.createOption(i18nString(UIStrings.allObjects)); for (let i = 0; i < list.length; ++i) { let title; if (!i) { title = i18nString(UIStrings.objectsAllocatedBeforeS, {PH1: list[i].title}); } else { title = i18nString(UIStrings.objectsAllocatedBetweenSAndS, {PH1: list[i - 1].title, PH2: list[i].title}); } this.filterSelect.createOption(title); } if (selectedIndex > -1) { this.filterSelect.setSelectedIndex(selectedIndex); } } updateControls(): void { this.updatePerspectiveOptions(); this.updateBaseOptions(); this.updateFilterOptions(); } onReceiveSnapshot(event: Common.EventTarget.EventTargetEvent<ProfileHeader>): void { this.updateControls(); const profile = event.data; profile.addEventListener(ProfileHeaderEvents.ProfileTitleChanged, this.updateControls, this); } onProfileHeaderRemoved(event: Common.EventTarget.EventTargetEvent<ProfileHeader>): void { const profile = event.data; profile.removeEventListener(ProfileHeaderEvents.ProfileTitleChanged, this.updateControls, this); if (this.profile === profile) { this.detach(); this.profile.profileType().removeEventListener( HeapSnapshotProfileTypeEvents.SnapshotReceived, this.onReceiveSnapshot, this); this.profile.profileType().removeEventListener( ProfileTypeEvents.RemoveProfileHeader, this.onProfileHeaderRemoved, this); this.dispose(); } else { this.updateControls(); } } dispose(): void { this.linkifier.dispose(); this.popoverHelper.dispose(); if (this.allocationStackView) { this.allocationStackView.clear(); if (this.allocationDataGrid) { this.allocationDataGrid.dispose(); } } this.onStopTracking(); if (this.trackingOverviewGrid) { this.trackingOverviewGrid.removeEventListener(Events.IdsRangeChanged, this.onIdsRangeChanged.bind(this)); } } } export class Perspective { readonly titleInternal: string; constructor(title: string) { this.titleInternal = title; } activate(_heapSnapshotView: HeapSnapshotView): void { } deactivate(heapSnapshotView: HeapSnapshotView): void { heapSnapshotView.baseSelect.setVisible(false); heapSnapshotView.filterSelect.setVisible(false); heapSnapshotView.classNameFilter.setVisible(false); if (heapSnapshotView.trackingOverviewGrid) { heapSnapshotView.trackingOverviewGrid.detach(); } if (heapSnapshotView.allocationWidget) { heapSnapshotView.allocationWidget.detach(); } if (heapSnapshotView.statisticsView) { heapSnapshotView.statisticsView.detach(); } heapSnapshotView.splitWidget.detach(); heapSnapshotView.splitWidget.detachChildWidgets(); } masterGrid(_heapSnapshotView: HeapSnapshotView): HeapSnapshotSortableDataGrid|null { return null; } title(): string { return this.titleInternal; } supportsSearch(): boolean { return false; } } export class SummaryPerspective extends Perspective { constructor() { super(i18nString(UIStrings.summary)); } override activate(heapSnapshotView: HeapSnapshotView): void { heapSnapshotView.splitWidget.setMainWidget(heapSnapshotView.constructorsWidget); heapSnapshotView.splitWidget.setSidebarWidget(heapSnapshotView.objectDetailsView); heapSnapshotView.splitWidget.show(heapSnapshotView.searchableViewInternal.element); heapSnapshotView.filterSelect.setVisible(true); heapSnapshotView.classNameFilter.setVisible(true); if (!heapSnapshotView.trackingOverviewGrid) { return; } heapSnapshotView.trackingOverviewGrid.show( heapSnapshotView.searchableViewInternal.element, heapSnapshotView.splitWidget.element); heapSnapshotView.trackingOverviewGrid.update(); heapSnapshotView.trackingOverviewGrid.updateGrid(); } override masterGrid(heapSnapshotView: HeapSnapshotView): HeapSnapshotSortableDataGrid { return heapSnapshotView.constructorsDataGrid; } override supportsSearch(): boolean { return true; } } export class ComparisonPerspective extends Perspective { constructor() { super(i18nString(UIStrings.comparison)); } override activate(heapSnapshotView: HeapSnapshotView): void { heapSnapshotView.splitWidget.setMainWidget(heapSnapshotView.diffWidget); heapSnapshotView.splitWidget.setSidebarWidget(heapSnapshotView.objectDetailsView); heapSnapshotView.splitWidget.show(heapSnapshotView.searchableViewInternal.element); heapSnapshotView.baseSelect.setVisible(true); heapSnapshotView.classNameFilter.setVisible(true); } override masterGrid(heapSnapshotView: HeapSnapshotView): HeapSnapshotSortableDataGrid { return heapSnapshotView.diffDataGrid; } override supportsSearch(): boolean { return true; } } export class ContainmentPerspective extends Perspective { constructor() { super(i18nString(UIStrings.containment)); } override activate(heapSnapshotView: HeapSnapshotView): void { heapSnapshotView.splitWidget.setMainWidget(heapSnapshotView.containmentWidget); heapSnapshotView.splitWidget.setSidebarWidget(heapSnapshotView.objectDetailsView); heapSnapshotView.splitWidget.show(heapSnapshotView.searchableViewInternal.element); } override masterGrid(heapSnapshotView: HeapSnapshotView): HeapSnapshotSortableDataGrid { return heapSnapshotView.containmentDataGrid; } } export class AllocationPerspective extends Perspective { readonly allocationSplitWidget: UI.SplitWidget.SplitWidget; constructor() { super(i18nString(UIStrings.allocation)); this.allocationSplitWidget = new UI.SplitWidget.SplitWidget(false, true, 'heapSnapshotAllocationSplitViewState', 200, 200); this.allocationSplitWidget.setSidebarWidget(new UI.Widget.VBox()); } override activate(heapSnapshotView: HeapSnapshotView): void { if (heapSnapshotView.allocationWidget) { this.allocationSplitWidget.setMainWidget(heapSnapshotView.allocationWidget); } heapSnapshotView.splitWidget.setMainWidget(heapSnapshotView.constructorsWidget); heapSnapshotView.splitWidget.setSidebarWidget(heapSnapshotView.objectDetailsView); const allocatedObjectsView = new UI.Widget.VBox(); const resizer = document.createElement('div'); resizer.classList.add('heap-snapshot-view-resizer'); const title = resizer.createChild('div', 'title').createChild('span'); resizer.createChild('div', 'verticalResizerIcon'); title.textContent = i18nString(UIStrings.liveObjects); this.allocationSplitWidget.hideDefaultResizer(); this.allocationSplitWidget.installResizer(resizer); allocatedObjectsView.element.appendChild(resizer); heapSnapshotView.splitWidget.show(allocatedObjectsView.element); this.allocationSplitWidget.setSidebarWidget(allocatedObjectsView); this.allocationSplitWidget.show(heapSnapshotView.searchableViewInternal.element); heapSnapshotView.constructorsDataGrid.clear(); if (heapSnapshotView.allocationDataGrid) { const selectedNode = (heapSnapshotView.allocationDataGrid.selectedNode as AllocationGridNode); if (selectedNode) { heapSnapshotView.constructorsDataGrid.setAllocationNodeId(selectedNode.allocationNodeId()); } } } override deactivate(heapSnapshotView: HeapSnapshotView): void { this.allocationSplitWidget.detach(); super.deactivate(heapSnapshotView); } override masterGrid(heapSnapshotView: HeapSnapshotView): HeapSnapshotSortableDataGrid|null { return heapSnapshotView.allocationDataGrid; } } export class StatisticsPerspective extends Perspective { constructor() { super(i18nString(UIStrings.statistics)); } override activate(heapSnapshotView: HeapSnapshotView): void { heapSnapshotView.statisticsView.show(heapSnapshotView.searchableViewInternal.element); } override masterGrid(_heapSnapshotView: HeapSnapshotView): HeapSnapshotSortableDataGrid|null { return null; } } export class HeapSnapshotProfileType extends Common.ObjectWrapper.eventMixin<HeapSnapshotProfileTypeEventTypes, typeof ProfileType>(ProfileType) implements SDK.TargetManager.SDKModelObserver<SDK.HeapProfilerModel.HeapProfilerModel> { readonly exposeInternals: Common.Settings.Setting<boolean>; readonly captureNumericValue: Common.Settings.Setting<boolean>; customContentInternal: HTMLElement|null; constructor(id?: string, title?: string) { super(id || HeapSnapshotProfileType.TypeId, title || i18nString(UIStrings.heapSnapshot)); SDK.TargetManager.TargetManager.instance().observeModels(SDK.HeapProfilerModel.HeapProfilerModel, this); SDK.TargetManager.TargetManager.instance().addModelListener( SDK.HeapProfilerModel.HeapProfilerModel, SDK.HeapProfilerModel.Events.ResetProfiles, this.resetProfiles, this); SDK.TargetManager.TargetManager.instance().addModelListener( SDK.HeapProfilerModel.HeapProfilerModel, SDK.HeapProfilerModel.Events.AddHeapSnapshotChunk, this.addHeapSnapshotChunk, this); SDK.TargetManager.TargetManager.instance().addModelListener( SDK.HeapProfilerModel.HeapProfilerModel, SDK.HeapProfilerModel.Events.ReportHeapSnapshotProgress, this.reportHeapSnapshotProgress, this); this.exposeInternals = Common.Settings.Settings.instance().createSetting('exposeInternals', false); this.captureNumericValue = Common.Settings.Settings.instance().createSetting('captureNumericValue', false); this.customContentInternal = null; } modelAdded(heapProfilerModel: SDK.HeapProfilerModel.HeapProfilerModel): void { void heapProfilerModel.enable(); } modelRemoved(_heapProfilerModel: SDK.HeapProfilerModel.HeapProfilerModel): void { } override getProfiles(): HeapProfileHeader[] { return super.getProfiles() as HeapProfileHeader[]; } override fileExtension(): string { return '.heapsnapshot'; } override get buttonTooltip(): Common.UIString.LocalizedString { return i18nString(UIStrings.takeHeapSnapshot); } override isInstantProfile(): boolean { return true; } override buttonClicked(): boolean { void this.takeHeapSnapshot(); Host.userMetrics.actionTaken(Host.UserMetrics.Action.ProfilesHeapProfileTaken); return false; } override get treeItemTitle(): Common.UIString.LocalizedString { return i18nString(UIStrings.heapSnapshots); } override get description(): Common.UIString.LocalizedString { return i18nString(UIStrings.heapSnapshotProfilesShowMemory); } override customContent(): Element|null { const optionsContainer = document.createElement('div'); const showOptionToExposeInternalsInHeapSnapshot = Root.Runtime.experiments.isEnabled('showOptionToExposeInternalsInHeapSnapshot'); const omitParagraphElement = !showOptionToExposeInternalsInHeapSnapshot; if (showOptionToExposeInternalsInHeapSnapshot) { const exposeInternalsInHeapSnapshotCheckbox = UI.SettingsUI.createSettingCheckbox( i18nString(UIStrings.exposeInternals), this.exposeInternals, omitParagraphElement); optionsContainer.appendChild(exposeInternalsInHeapSnapshotCheckbox); } const captureNumericValueCheckbox = UI.SettingsUI.createSettingCheckbox( i18nString(UIStrings.captureNumericValue), this.captureNumericValue, omitParagraphElement); optionsContainer.appendChild(captureNumericValueCheckbox); this.customContentInternal = optionsContainer; return optionsContainer; } override setCustomContentEnabled(enable: boolean): void { if (this.customContentInternal) { this.customContentInternal.querySelectorAll('[is=dt-checkbox]').forEach(label => { (label as UI.UIUtils.CheckboxLabel).checkboxElement.disabled = !e