UNPKG

chrome-devtools-frontend

Version:
674 lines (605 loc) • 27.1 kB
// Copyright 2021 The Chromium Authors // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. /* eslint-disable @devtools/no-imperative-dom-api */ /* * Copyright (C) IBM Corp. 2009 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 IBM Corp. 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 SDK from '../../core/sdk/sdk.js'; import type * as Protocol from '../../generated/protocol.js'; import * as Formatter from '../../models/formatter/formatter.js'; import * as SourceMapScopes from '../../models/source_map_scopes/source_map_scopes.js'; import * as StackTrace from '../../models/stack_trace/stack_trace.js'; import * as Buttons from '../../ui/components/buttons/buttons.js'; import * as TextEditor from '../../ui/components/text_editor/text_editor.js'; import * as ObjectUI from '../../ui/legacy/components/object_ui/object_ui.js'; // eslint-disable-next-line @devtools/es-modules-import import objectValueStyles from '../../ui/legacy/components/object_ui/objectValue.css.js'; import * as Components from '../../ui/legacy/components/utils/utils.js'; import * as UI from '../../ui/legacy/legacy.js'; import {Directives, html, render, type TemplateResult} from '../../ui/lit/lit.js'; import * as VisualLogging from '../../ui/visual_logging/visual_logging.js'; import {UISourceCodeFrame} from './UISourceCodeFrame.js'; import watchExpressionsSidebarPaneStyles from './watchExpressionsSidebarPane.css.js'; const UIStrings = { /** * @description A context menu item in the Watch Expressions Sidebar Pane of the Sources panel */ addWatchExpression: 'Add watch expression', /** * @description Tooltip/screen reader label of a button in the Sources panel that refreshes all watch expressions. */ refreshWatchExpressions: 'Refresh watch expressions', /** * @description Empty element text content in Watch Expressions Sidebar Pane of the Sources panel */ noWatchExpressions: 'No watch expressions', /** * @description A context menu item in the Watch Expressions Sidebar Pane of the Sources panel */ deleteAllWatchExpressions: 'Delete all watch expressions', /** * @description A context menu item in the Watch Expressions Sidebar Pane of the Sources panel */ addPropertyPathToWatch: 'Add property path to watch', /** * @description A context menu item in the Watch Expressions Sidebar Pane of the Sources panel */ deleteWatchExpression: 'Delete watch expression', /** * @description Value element text content in Watch Expressions Sidebar Pane of the Sources panel */ notAvailable: '<not available>', /** * @description A context menu item in the Watch Expressions Sidebar Pane of the Sources panel and Network pane request. */ copyValue: 'Copy value', /** * @description announcement for when watch expression is deleted */ watchExpressionDeleted: 'Watch expression deleted', } as const; const str_ = i18n.i18n.registerUIStrings('panels/sources/WatchExpressionsSidebarPane.ts', UIStrings); const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_); let watchExpressionsSidebarPaneInstance: WatchExpressionsSidebarPane; const {repeat} = Directives; interface ViewInput { onCopyWatchExpression(watchExpression: WatchExpression): void; onDeleteAll(): unknown; onAddExpression(): unknown; watchExpressions: WatchExpression[]; } type View = (input: ViewInput, output: object, target: HTMLElement) => void; export const DEFAULT_VIEW: View = (input, output, target) => { const onContextMenu = (watchExpression: WatchExpression|undefined, event: Event): void => { const contextMenu = new UI.ContextMenu.ContextMenu(event); const isEditing = input.watchExpressions.some(e => e.isEditing()); if (!isEditing) { contextMenu.debugSection().appendItem( i18nString(UIStrings.addWatchExpression), input.onAddExpression, {jslogContext: 'add-watch-expression'}); } if (input.watchExpressions.length > 1) { contextMenu.debugSection().appendItem( i18nString(UIStrings.deleteAllWatchExpressions), input.onDeleteAll, {jslogContext: 'delete-all-watch-expressions'}); } if (watchExpression) { if (!watchExpression.isEditing()) { contextMenu.editSection().appendItem( i18nString(UIStrings.deleteWatchExpression), watchExpression.updateExpression.bind(watchExpression, null), {jslogContext: 'delete-watch-expression'}); } if (!watchExpression.isEditing() && watchExpression.result && (watchExpression.result.type === 'number' || watchExpression.result.type === 'string')) { contextMenu.clipboardSection().appendItem( i18nString(UIStrings.copyValue), () => input.onCopyWatchExpression(watchExpression), {jslogContext: 'copy-watch-expression-value'}); } contextMenu.appendApplicableItems(watchExpression.result); } void contextMenu.show(); event.consume(); }; for (const watchExpression of input.watchExpressions) { watchExpression.treeElement().listItemElement.oncontextmenu = onContextMenu.bind(undefined, watchExpression); watchExpression.treeElement().childrenListElement.oncontextmenu = onContextMenu.bind(undefined, watchExpression); } render( // clang-format off html` ${input.watchExpressions.length === 0 ? html`<div class=gray-info-message tabindex=-1 > ${i18nString(UIStrings.noWatchExpressions)} </div>` : html`<devtools-tree hide-overflow show-selection-on-keyboard-focus .template=${html` <ul role=tree class="source-code object-properties-section"> <style>${ObjectUI.ObjectPropertiesSection.objectValueStyles}</style> <style>${ObjectUI.ObjectPropertiesSection.objectPropertiesSectionStyles}</style> <style>${watchExpressionsSidebarPaneStyles}</style> ${repeat(input.watchExpressions, e => html`<devtools-tree-wrapper .treeElement=${e.treeElement()}></devtools-tree-wrapper>`)} </ul>`}> </devtools-tree>` }`, // clang-format on target, { container: { classes: ['watch-expressions'], attributes: { jslog: `${VisualLogging.section('sources.watch')}`, 'aria-label': i18nString(UIStrings.addWatchExpression) }, listeners: {contextmenu: onContextMenu.bind(undefined, undefined)} } }); }; export class WatchExpressionsSidebarPane extends UI.Widget.VBox implements UI.ActionRegistration.ActionDelegate, UI.Toolbar.ItemsProvider { #watchExpressions: WatchExpression[]; #watchExpressionsSetting: Common.Settings.Setting<string[]>; private readonly linkifier: Components.Linkifier.Linkifier; #view: View; #expandControllers = new Map<string, ObjectUI.ObjectPropertiesSection.ObjectTreeExpansionTracker>(); constructor() { super({useShadowDom: true}); this.registerRequiredCSS(watchExpressionsSidebarPaneStyles, objectValueStyles); this.#watchExpressions = []; this.#watchExpressionsSetting = Common.Settings.Settings.instance().createLocalSetting<string[]>('watch-expressions', []); UI.Context.Context.instance().addFlavorChangeListener( SDK.RuntimeModel.ExecutionContext, this.#refreshExpressions, this); UI.Context.Context.instance().addFlavorChangeListener( StackTrace.StackTrace.DebuggableFrameFlavor, this.#refreshExpressions, this); this.linkifier = new Components.Linkifier.Linkifier(); this.#view = DEFAULT_VIEW; this.#refreshExpressions(); } static instance(): WatchExpressionsSidebarPane { if (!watchExpressionsSidebarPaneInstance) { watchExpressionsSidebarPaneInstance = new WatchExpressionsSidebarPane(); } return watchExpressionsSidebarPaneInstance; } get watchExpressions(): WatchExpression[] { return this.#watchExpressions; } toolbarItems(): TemplateResult { // clang-format off return html` <devtools-button .data=${{ variant: Buttons.Button.Variant.TOOLBAR, iconName: 'plus', size: Buttons.Button.Size.SMALL, title: i18nString(UIStrings.addWatchExpression), jslogContext: 'add-watch-expression', } as Buttons.Button.ButtonData} @click=${(e: Event) => this.addButtonClicked(e)}></devtools-button> <devtools-button .data=${{ variant: Buttons.Button.Variant.TOOLBAR, iconName: 'refresh', size: Buttons.Button.Size.SMALL, title: i18nString(UIStrings.refreshWatchExpressions), jslogContext: 'refresh-watch-expressions', } as Buttons.Button.ButtonData} @click=${(e: Event) => this.refreshButtonClicked(e)}></devtools-button> `; // clang-format on } private saveExpressions(): void { const toSave = []; for (let i = 0; i < this.#watchExpressions.length; i++) { const expression = this.#watchExpressions[i].expression(); if (expression) { toSave.push(expression); } } this.#watchExpressionsSetting.set(toSave); } private async addButtonClicked(event?: Event): Promise<void> { event?.consume(true); await UI.ViewManager.ViewManager.instance().showView('sources.watch'); const watchExpression = this.createWatchExpression(null); this.requestUpdate(); // This synchronization is only needed because startEditing is imperative and // requires the tree element to be in the DOM. This can be removed once the // prompt is migrated to Lit. await this.updateComplete; watchExpression.startEditing(); } private refreshButtonClicked(event: Event): void { event.consume(true); this.#refreshExpressions(); } #refreshExpressions(): void { this.linkifier.reset(); for (const expression of this.#watchExpressions) { expression.removeEventListener(Events.EXPRESSION_UPDATED, this.watchExpressionUpdated, this); } this.#watchExpressions = []; const watchExpressionStrings = this.#watchExpressionsSetting.get(); const oldExpandControllers = this.#expandControllers; this.#expandControllers = new Map(); for (let i = 0; i < watchExpressionStrings.length; ++i) { const expression = watchExpressionStrings[i]; if (!expression) { continue; } const controller = oldExpandControllers.get(expression); if (controller) { this.#expandControllers.set(expression, controller); } this.createWatchExpression(expression); } this.requestUpdate(); } override async performUpdate(): Promise<void> { await Promise.all(this.#watchExpressions.map(we => we.updateComplete)); this.#view( { watchExpressions: this.watchExpressions, onDeleteAll: this.deleteAllButtonClicked.bind(this), onAddExpression: this.addButtonClicked.bind(this), onCopyWatchExpression: watchExpression => { if (watchExpression.result?.description) { Host.InspectorFrontendHost.InspectorFrontendHostInstance.copyText(watchExpression.result.description); } } }, {}, this.contentElement); } #getExpandController(expression: string|null): ObjectUI.ObjectPropertiesSection.ObjectTreeExpansionTracker { if (expression === null) { return new ObjectUI.ObjectPropertiesSection.ObjectTreeExpansionTracker(); } let expandController = this.#expandControllers.get(expression); if (!expandController) { expandController = new ObjectUI.ObjectPropertiesSection.ObjectTreeExpansionTracker(); this.#expandControllers.set(expression, expandController); } return expandController; } private createWatchExpression(expression: string|null): WatchExpression { const expandController = this.#getExpandController(expression); const watchExpression = new WatchExpression(expression, expandController, this.linkifier); watchExpression.addEventListener(Events.EXPRESSION_UPDATED, this.watchExpressionUpdated, this); this.#watchExpressions.push(watchExpression); return watchExpression; } private watchExpressionUpdated({data: watchExpression}: Common.EventTarget.EventTargetEvent<WatchExpression>): void { const expression = watchExpression.expression(); if (!expression) { Platform.ArrayUtilities.removeElement(this.#watchExpressions, watchExpression); } this.saveExpressions(); this.requestUpdate(); } private deleteAllButtonClicked(): void { this.#watchExpressions = []; this.saveExpressions(); this.#refreshExpressions(); } private async focusAndAddExpressionToWatch(expression: string): Promise<void> { await UI.ViewManager.ViewManager.instance().showView('sources.watch'); this.createWatchExpression(expression); this.saveExpressions(); this.#refreshExpressions(); } handleAction(_context: UI.Context.Context, _actionId: string): boolean { const frame = UI.Context.Context.instance().flavor(UISourceCodeFrame); if (!frame) { return false; } const {state} = frame.textEditor; const text = state.sliceDoc(state.selection.main.from, state.selection.main.to); void this.focusAndAddExpressionToWatch(text); return true; } appendApplicableItems( _event: Event, contextMenu: UI.ContextMenu.ContextMenu, target: ObjectUI.ObjectPropertiesSection.ObjectPropertyTreeElement|UISourceCodeFrame): void { if (target instanceof ObjectUI.ObjectPropertiesSection.ObjectPropertyTreeElement) { if (!target.property.property.synthetic) { contextMenu.debugSection().appendItem( i18nString(UIStrings.addPropertyPathToWatch), () => this.focusAndAddExpressionToWatch(target.path()), {jslogContext: 'add-property-path-to-watch'}); } return; } if (target.textEditor.state.selection.main.empty) { return; } contextMenu.debugSection().appendAction('sources.add-to-watch'); } } class ObjectPropertyPrompt extends UI.TextPrompt.TextPrompt { constructor() { super(); this.initialize(TextEditor.JavaScript.completeInContext); } } export class WatchExpression extends Common.ObjectWrapper.ObjectWrapper<EventTypes> { #treeElement!: UI.TreeOutline.TreeElement; private nameElement!: Element; private valueElement!: Element; #expression: string|null; readonly #expandController: ObjectUI.ObjectPropertiesSection.ObjectTreeExpansionTracker; private element: HTMLDivElement; private editing: boolean; private linkifier: Components.Linkifier.Linkifier; private textPrompt?: ObjectPropertyPrompt; #result?: SDK.RemoteObject.RemoteObject|null; private preventClickTimeout?: number; #updateComplete: Promise<void> = Promise.resolve(); constructor( expression: string|null, expandController: ObjectUI.ObjectPropertiesSection.ObjectTreeExpansionTracker, linkifier: Components.Linkifier.Linkifier) { super(); this.#expression = expression; this.#expandController = expandController; this.element = document.createElement('div'); this.element.classList.add('watch-expression'); this.element.classList.add('monospace'); this.editing = false; this.linkifier = linkifier; void this.createWatchExpression(); this.update(); } get result(): SDK.RemoteObject.RemoteObject|null { return this.#result ?? null; } get updateComplete(): Promise<void> { return this.#updateComplete; } treeElement(): UI.TreeOutline.TreeElement { return this.#treeElement; } expression(): string|null { return this.#expression; } async #evaluateExpression(executionContext: SDK.RuntimeModel.ExecutionContext, expression: string): Promise<SDK.RuntimeModel.EvaluationResult> { const callFrame = executionContext.debuggerModel.selectedCallFrame(); if (callFrame?.script.isJavaScript()) { const nameMap = await SourceMapScopes.NamesResolver.allVariablesInCallFrame(callFrame); try { expression = await Formatter.FormatterWorkerPool.formatterWorkerPool().javaScriptSubstitute(expression, nameMap); } catch { } } return await executionContext.evaluate( { expression, objectGroup: WatchExpression.watchObjectGroupId, includeCommandLineAPI: false, silent: true, returnByValue: false, generatePreview: false, }, /* userGesture */ false, /* awaitPromise */ false); } update(): void { const currentExecutionContext = UI.Context.Context.instance().flavor(SDK.RuntimeModel.ExecutionContext); if (currentExecutionContext && this.#expression) { this.#updateComplete = this.#evaluateExpression(currentExecutionContext, this.#expression) .then(async result => { if ('object' in result) { await this.createWatchExpression(result.object, result.exceptionDetails); } else { await this.createWatchExpression(); } }) .catch(() => {}); } else { this.#updateComplete = this.createWatchExpression(); } } startEditing(): void { this.editing = true; this.#treeElement.setDisableSelectFocus(true); this.element.removeChildren(); const newDiv = this.element.createChild('div'); newDiv.textContent = this.nameElement.textContent; this.textPrompt = new ObjectPropertyPrompt(); this.textPrompt.renderAsBlock(); const proxyElement = (this.textPrompt.attachAndStartEditing(newDiv, this.finishEditing.bind(this)) as HTMLElement); this.#treeElement.listItemElement.classList.add('watch-expression-editing'); this.#treeElement.collapse(); proxyElement.classList.add('watch-expression-text-prompt-proxy'); proxyElement.addEventListener('keydown', this.promptKeyDown.bind(this), false); const selection = this.element.getComponentSelection(); if (selection) { selection.selectAllChildren(newDiv); } } isEditing(): boolean { return Boolean(this.editing); } private finishEditing(event: Event, canceled?: boolean): void { if (event) { event.consume(canceled); } this.editing = false; this.#treeElement.setDisableSelectFocus(false); this.#treeElement.listItemElement.classList.remove('watch-expression-editing'); if (this.textPrompt) { const text = this.textPrompt.text(); this.textPrompt.detach(); const newExpression = canceled ? this.#expression : text; this.textPrompt = undefined; this.element.removeChildren(); this.updateExpression(newExpression); } } private dblClickOnWatchExpression(event: Event): void { event.consume(); if (!this.isEditing()) { this.startEditing(); } } updateExpression(newExpression: string|null): void { if (this.#expression !== newExpression && newExpression) { this.#expandController.clear(); } this.#expression = newExpression; this.update(); this.dispatchEventToListeners(Events.EXPRESSION_UPDATED, this); } private deleteWatchExpression(event: Event): void { event.consume(true); UI.ARIAUtils.LiveAnnouncer.alert(i18nString(UIStrings.watchExpressionDeleted)); this.updateExpression(null); } async createWatchExpression( result?: SDK.RemoteObject.RemoteObject, exceptionDetails?: Protocol.Runtime.ExceptionDetails): Promise<void> { this.#result = result || null; this.element.removeChildren(); const oldTreeElement = this.#treeElement; await this.#createWatchExpressionTreeElement(result, exceptionDetails); if (oldTreeElement?.parent) { const root = oldTreeElement.parent; const index = root.indexOfChild(oldTreeElement); root.removeChild(oldTreeElement); root.insertChild(this.#treeElement, index); } this.#treeElement.select(); } private createWatchExpressionHeader( expressionValue?: SDK.RemoteObject.RemoteObject, exceptionDetails?: Protocol.Runtime.ExceptionDetails): Element { const headerElement = this.element.createChild('div', 'watch-expression-header'); const deleteButton = new Buttons.Button.Button(); deleteButton.data = { variant: Buttons.Button.Variant.ICON, iconName: 'bin', size: Buttons.Button.Size.SMALL, jslogContext: 'delete-watch-expression', }; deleteButton.className = 'watch-expression-delete-button'; UI.Tooltip.Tooltip.install(deleteButton, i18nString(UIStrings.deleteWatchExpression)); deleteButton.addEventListener('click', this.deleteWatchExpression.bind(this), false); deleteButton.addEventListener('keydown', event => { if (event.key === 'Enter') { this.deleteWatchExpression(event); } }); const titleElement = headerElement.createChild('div', 'watch-expression-title tree-element-title'); titleElement.appendChild(deleteButton); this.nameElement = ObjectUI.ObjectPropertiesSection.ObjectPropertiesSection.createNameElement(this.#expression); UI.Tooltip.Tooltip.install(this.nameElement as HTMLElement, this.#expression); if (Boolean(exceptionDetails) || !expressionValue) { this.valueElement = document.createElement('span'); this.valueElement.classList.add('watch-expression-error'); this.valueElement.classList.add('value'); titleElement.classList.add('dimmed'); this.valueElement.textContent = i18nString(UIStrings.notAvailable); if (exceptionDetails?.exception?.description !== undefined) { UI.Tooltip.Tooltip.install(this.valueElement as HTMLElement, exceptionDetails.exception.description); } } else { const propertyValue = ObjectUI.ObjectPropertiesSection.ObjectPropertiesSection.createPropertyValueWithCustomSupport( expressionValue, Boolean(exceptionDetails), false /* showPreview */, this.linkifier); this.valueElement = propertyValue; } const separatorElement = document.createElement('span'); separatorElement.classList.add('watch-expressions-separator'); separatorElement.textContent = ': '; titleElement.append(this.nameElement, separatorElement, this.valueElement); return headerElement; } async #createWatchExpressionTreeElement( expressionValue?: SDK.RemoteObject.RemoteObject, exceptionDetails?: Protocol.Runtime.ExceptionDetails): Promise<void> { const headerElement = this.createWatchExpressionHeader(expressionValue, exceptionDetails); if (!exceptionDetails && expressionValue && expressionValue.hasChildren && !expressionValue.customPreview()) { headerElement.classList.add('watch-expression-object-header'); const objectTree = new ObjectUI.ObjectPropertiesSection.ObjectTree(expressionValue, { readOnly: true, propertiesMode: ObjectUI.ObjectPropertiesSection.ObjectPropertiesMode.OWN_AND_INTERNAL_AND_INHERITED, expansionTracker: this.#expandController, }); await this.#expandController.apply(objectTree); this.#treeElement = new ObjectUI.ObjectPropertiesSection.RootElement(objectTree, this.linkifier); this.#treeElement.toggleOnClick = false; this.#treeElement.listItemElement.addEventListener('click', this.onSectionClick.bind(this), false); this.#treeElement.listItemElement.addEventListener('dblclick', this.dblClickOnWatchExpression.bind(this)); } else { headerElement.addEventListener('dblclick', this.dblClickOnWatchExpression.bind(this)); this.#treeElement = new UI.TreeOutline.TreeElement(); } this.#treeElement.title = this.element; this.#treeElement.listItemElement.classList.add('watch-expression-tree-item'); this.#treeElement.listItemElement.addEventListener('keydown', event => { if (event.key === 'Enter' && !this.isEditing()) { this.startEditing(); event.consume(true); } else if (event.key === 'Delete' && !this.isEditing()) { this.deleteWatchExpression(event); } }); } private onSectionClick(event: MouseEvent): void { event.consume(true); const mouseEvent = event; if (mouseEvent.detail === 1) { this.preventClickTimeout = window.setTimeout(handleClick.bind(this), 333); } else if (this.preventClickTimeout !== undefined) { window.clearTimeout(this.preventClickTimeout); this.preventClickTimeout = undefined; } function handleClick(this: WatchExpression): void { if (!this.#treeElement) { return; } if (this.#treeElement.expanded) { this.#treeElement.collapse(); } else if (!this.editing) { this.#treeElement.expand(); } } } private promptKeyDown(event: KeyboardEvent): void { const isEscapeKey = Platform.KeyboardUtilities.isEscKey(event); if (event.key === 'Enter' || isEscapeKey) { this.finishEditing(event, isEscapeKey); } } private static readonly watchObjectGroupId = 'watch-group'; } const enum Events { EXPRESSION_UPDATED = 'ExpressionUpdated', } interface EventTypes { [Events.EXPRESSION_UPDATED]: WatchExpression; }