UNPKG

debug-server-next

Version:

Dev server for hippy-core.

1,108 lines 82.9 kB
// Copyright 2020 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. /* * Copyright (C) 2011 Google Inc. All rights reserved. * Copyright (C) 2007, 2008 Apple Inc. All rights reserved. * Copyright (C) 2009 Joseph Pecoraro * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. 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. * 3. Neither the name of Apple Computer, Inc. ("Apple") 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 APPLE AND ITS 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 APPLE OR ITS 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. */ /* eslint-disable rulesdir/no_underscored_properties */ import * as Common from '../../core/common/common.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 * as Bindings from '../../models/bindings/bindings.js'; import * as Logs from '../../models/logs/logs.js'; import * as TextUtils from '../../models/text_utils/text_utils.js'; import * as Workspace from '../../models/workspace/workspace.js'; import * as IssueCounter from '../../ui/components/issue_counter/issue_counter.js'; import * as RequestLinkIcon from '../../ui/components/request_link_icon/request_link_icon.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 TextEditor from '../../ui/legacy/components/text_editor/text_editor.js'; import * as Components from '../../ui/legacy/components/utils/utils.js'; import * as UI from '../../ui/legacy/legacy.js'; import * as ThemeSupport from '../../ui/legacy/theme_support/theme_support.js'; const UIStrings = { /** * @description Message element text content in Console View Message of the Console panel. Shown * when the user tried to run console.clear() but the 'Preserve log' option is enabled, which stops * the log from being cleared. */ consoleclearWasPreventedDueTo: '`console.clear()` was prevented due to \'Preserve log\'', /** * @description Text shown in the Console panel after the user has cleared the console, which * removes all messages from the console so that it is empty. */ consoleWasCleared: 'Console was cleared', /** *@description Message element title in Console View Message of the Console panel *@example {Ctrl+L} PH1 */ clearAllMessagesWithS: 'Clear all messages with {PH1}', /** *@description Message prefix in Console View Message of the Console panel */ assertionFailed: 'Assertion failed: ', /** *@description Message text in Console View Message of the Console panel *@example {console.log(1)} PH1 */ violationS: '`[Violation]` {PH1}', /** *@description Message text in Console View Message of the Console panel *@example {console.log(1)} PH1 */ interventionS: '`[Intervention]` {PH1}', /** *@description Message text in Console View Message of the Console panel *@example {console.log(1)} PH1 */ deprecationS: '`[Deprecation]` {PH1}', /** *@description Note title in Console View Message of the Console panel */ thisValueWillNotBeCollectedUntil: 'This value will not be collected until console is cleared.', /** *@description Note title in Console View Message of the Console panel */ thisValueWasEvaluatedUponFirst: 'This value was evaluated upon first expanding. It may have changed since then.', /** *@description Note title in Console View Message of the Console panel */ functionWasResolvedFromBound: 'Function was resolved from bound function.', /** * @description Shown in the Console panel when an exception is thrown when trying to access a * property on an object. Should be translated. */ exception: '<exception>', /** *@description Text to indicate an item is a warning */ warning: 'Warning', /** *@description Text for errors */ error: 'Error', /** * @description Announced by the screen reader to indicate how many times a particular message in * the console was repeated. */ repeatS: '{n, plural, =1 {Repeated # time} other {Repeated # times}}', /** * @description Announced by the screen reader to indicate how many times a particular warning * message in the console was repeated. */ warningS: '{n, plural, =1 {Warning, Repeated # time} other {Warning, Repeated # times}}', /** * @description Announced by the screen reader to indicate how many times a particular error * message in the console was repeated. */ errorS: '{n, plural, =1 {Error, Repeated # time} other {Error, Repeated # times}}', /** *@description Text appended to grouped console messages that are related to URL requests */ url: '<URL>', /** *@description Text appended to grouped console messages about tasks that took longer than N ms */ tookNms: 'took <N>ms', /** *@description Text appended to grouped console messages about tasks that are related to some DOM event */ someEvent: '<some> event', /** *@description Text appended to grouped console messages about tasks that are related to a particular milestone */ Mxx: ' M<XX>', /** *@description Text appended to grouped console messages about tasks that are related to autofill completions */ attribute: '<attribute>', /** *@description Text for the index of something */ index: '(index)', /** *@description Text for the value of something */ value: 'Value', /** *@description Title of the Console tool */ console: 'Console', }; const str_ = i18n.i18n.registerUIStrings('panels/console/ConsoleViewMessage.ts', UIStrings); const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_); const elementToMessage = new WeakMap(); export const getMessageForElement = (element) => { return elementToMessage.get(element); }; // This value reflects the 18px min-height of .console-message, plus the // 1px border of .console-message-wrapper. Keep in sync with consoleView.css. const defaultConsoleRowHeight = 19; const parameterToRemoteObject = (runtimeModel) => (parameter) => { if (parameter instanceof SDK.RemoteObject.RemoteObject) { return parameter; } if (!runtimeModel) { return SDK.RemoteObject.RemoteObject.fromLocalObject(parameter); } if (typeof parameter === 'object') { return runtimeModel.createRemoteObject(parameter); } return runtimeModel.createRemoteObjectFromPrimitiveValue(parameter); }; export class ConsoleViewMessage { _message; _linkifier; _repeatCount; _closeGroupDecorationCount; _nestingLevel; _selectableChildren; _messageResized; _element; _previewFormatter; _searchRegex; _messageLevelIcon; _traceExpanded; _expandTrace; _anchorElement; _contentElement; _nestingLevelMarkers; _searchHighlightNodes; _searchHighlightNodeChanges; _isVisible; _cachedHeight; _messagePrefix; _timestampElement; _inSimilarGroup; _similarGroupMarker; _lastInSimilarGroup; _groupKey; _repeatCountElement; requestResolver; issueResolver; constructor(consoleMessage, linkifier, requestResolver, issueResolver, nestingLevel, onResize) { this._message = consoleMessage; this._linkifier = linkifier; this.requestResolver = requestResolver; this.issueResolver = issueResolver; this._repeatCount = 1; this._closeGroupDecorationCount = 0; this._nestingLevel = nestingLevel; this._selectableChildren = []; this._messageResized = onResize; this._element = null; this._previewFormatter = new ObjectUI.RemoteObjectPreviewFormatter.RemoteObjectPreviewFormatter(); this._searchRegex = null; this._messageLevelIcon = null; this._traceExpanded = false; this._expandTrace = null; this._anchorElement = null; this._contentElement = null; this._nestingLevelMarkers = null; this._searchHighlightNodes = []; this._searchHighlightNodeChanges = []; this._isVisible = false; this._cachedHeight = 0; this._messagePrefix = ''; this._timestampElement = null; this._inSimilarGroup = false; this._similarGroupMarker = null; this._lastInSimilarGroup = false; this._groupKey = ''; this._repeatCountElement = null; } element() { return this.toMessageElement(); } wasShown() { this._isVisible = true; } onResize() { } willHide() { this._isVisible = false; this._cachedHeight = this.element().offsetHeight; } isVisible() { return this._isVisible; } fastHeight() { if (this._cachedHeight) { return this._cachedHeight; } return this.approximateFastHeight(); } approximateFastHeight() { return defaultConsoleRowHeight; } consoleMessage() { return this._message; } _buildMessage() { let messageElement; let messageText = this._message.messageText; if (this._message.source === SDK.ConsoleModel.FrontendMessageSource.ConsoleAPI) { switch (this._message.type) { case "trace" /* Trace */: messageElement = this._format(this._message.parameters || ['console.trace']); break; case "clear" /* Clear */: messageElement = document.createElement('span'); messageElement.classList.add('console-info'); if (Common.Settings.Settings.instance().moduleSetting('preserveConsoleLog').get()) { messageElement.textContent = i18nString(UIStrings.consoleclearWasPreventedDueTo); } else { messageElement.textContent = i18nString(UIStrings.consoleWasCleared); } UI.Tooltip.Tooltip.install(messageElement, i18nString(UIStrings.clearAllMessagesWithS, { PH1: String(UI.ShortcutRegistry.ShortcutRegistry.instance().shortcutTitleForAction('console.clear')), })); break; case "dir" /* Dir */: { const obj = this._message.parameters ? this._message.parameters[0] : undefined; const args = ['%O', obj]; messageElement = this._format(args); break; } case "profile" /* Profile */: case "profileEnd" /* ProfileEnd */: messageElement = this._format([messageText]); break; default: { if (this._message.type === "assert" /* Assert */) { this._messagePrefix = i18nString(UIStrings.assertionFailed); } if (this._message.parameters && this._message.parameters.length === 1) { const parameter = this._message.parameters[0]; if (typeof parameter !== 'string' && parameter.type === 'string') { messageElement = this._tryFormatAsError(parameter.value); } } const args = this._message.parameters || [messageText]; messageElement = messageElement || this._format(args); } } } else { if (this._message.source === "network" /* Network */) { messageElement = this._formatAsNetworkRequest() || this._format([messageText]); } else { const messageInParameters = this._message.parameters && messageText === this._message.parameters[0]; // These terms are locked because the console message will not be translated anyway. if (this._message.source === "violation" /* Violation */) { messageText = i18nString(UIStrings.violationS, { PH1: messageText }); } else if (this._message.source === "intervention" /* Intervention */) { messageText = i18nString(UIStrings.interventionS, { PH1: messageText }); } else if (this._message.source === "deprecation" /* Deprecation */) { messageText = i18nString(UIStrings.deprecationS, { PH1: messageText }); } const args = this._message.parameters || [messageText]; if (messageInParameters) { args[0] = messageText; } messageElement = this._format(args); } } messageElement.classList.add('console-message-text'); const formattedMessage = document.createElement('span'); formattedMessage.classList.add('source-code'); this._anchorElement = this._buildMessageAnchor(); if (this._anchorElement) { formattedMessage.appendChild(this._anchorElement); } formattedMessage.appendChild(messageElement); return formattedMessage; } _formatAsNetworkRequest() { const request = Logs.NetworkLog.NetworkLog.requestForConsoleMessage(this._message); if (!request) { return null; } const messageElement = document.createElement('span'); if (this._message.level === "error" /* Error */) { UI.UIUtils.createTextChild(messageElement, request.requestMethod + ' '); const linkElement = Components.Linkifier.Linkifier.linkifyRevealable(request, request.url(), request.url()); // Focus is handled by the viewport. linkElement.tabIndex = -1; this._selectableChildren.push({ element: linkElement, forceSelect: () => linkElement.focus() }); messageElement.appendChild(linkElement); if (request.failed) { UI.UIUtils.createTextChildren(messageElement, ' ', request.localizedFailDescription || ''); } if (request.statusCode !== 0) { UI.UIUtils.createTextChildren(messageElement, ' ', String(request.statusCode)); } if (request.statusText) { UI.UIUtils.createTextChildren(messageElement, ' (', request.statusText, ')'); } } else { const messageText = this._message.messageText; const fragment = this._linkifyWithCustomLinkifier(messageText, (text, url, lineNumber, columnNumber) => { const linkElement = url === request.url() ? Components.Linkifier.Linkifier.linkifyRevealable(request, url, request.url()) : Components.Linkifier.Linkifier.linkifyURL(url, { text, lineNumber, columnNumber }); linkElement.tabIndex = -1; this._selectableChildren.push({ element: linkElement, forceSelect: () => linkElement.focus() }); return linkElement; }); messageElement.appendChild(fragment); } return messageElement; } createAffectedResourceLinks() { const elements = []; const requestId = this._message.getAffectedResources()?.requestId; if (requestId) { const icon = new RequestLinkIcon.RequestLinkIcon.RequestLinkIcon(); icon.classList.add('resource-links'); icon.data = { affectedRequest: { requestId }, requestResolver: this.requestResolver, displayURL: false, }; elements.push(icon); } const issueId = this._message.getAffectedResources()?.issueId; if (issueId) { const icon = new IssueCounter.IssueLinkIcon.IssueLinkIcon(); icon.classList.add('resource-links'); icon.data = { issueId, issueResolver: this.issueResolver }; elements.push(icon); } return elements; } _buildMessageAnchor() { const linkify = (message) => { if (message.scriptId) { return this._linkifyScriptId(message.scriptId, message.url || '', message.line, message.column); } if (message.stackTrace && message.stackTrace.callFrames.length) { return this._linkifyStackTraceTopFrame(message.stackTrace); } if (message.url && message.url !== 'undefined') { return this._linkifyLocation(message.url, message.line, message.column); } return null; }; const anchorElement = linkify(this._message); // Append a space to prevent the anchor text from being glued to the console message when the user selects and copies the console messages. if (anchorElement) { anchorElement.tabIndex = -1; this._selectableChildren.push({ element: anchorElement, forceSelect: () => anchorElement.focus(), }); const anchorWrapperElement = document.createElement('span'); anchorWrapperElement.classList.add('console-message-anchor'); anchorWrapperElement.appendChild(anchorElement); for (const element of this.createAffectedResourceLinks()) { UI.UIUtils.createTextChild(anchorWrapperElement, ' '); anchorWrapperElement.append(element); } UI.UIUtils.createTextChild(anchorWrapperElement, ' '); return anchorWrapperElement; } return null; } _buildMessageWithStackTrace(runtimeModel) { const toggleElement = document.createElement('div'); toggleElement.classList.add('console-message-stack-trace-toggle'); const contentElement = toggleElement.createChild('div', 'console-message-stack-trace-wrapper'); UI.ARIAUtils.markAsTree(contentElement); const messageElement = this._buildMessage(); const icon = UI.Icon.Icon.create('smallicon-triangle-right', 'console-message-expand-icon'); const clickableElement = contentElement.createChild('div'); UI.ARIAUtils.markAsTreeitem(clickableElement); UI.ARIAUtils.setExpanded(clickableElement, false); clickableElement.appendChild(icon); // Intercept focus to avoid highlight on click. clickableElement.tabIndex = -1; clickableElement.appendChild(messageElement); const stackTraceElement = contentElement.createChild('div'); const stackTracePreview = Components.JSPresentationUtils.buildStackTracePreviewContents(runtimeModel.target(), this._linkifier, { stackTrace: this._message.stackTrace, tabStops: undefined }); stackTraceElement.appendChild(stackTracePreview.element); for (const linkElement of stackTracePreview.links) { this._selectableChildren.push({ element: linkElement, forceSelect: () => linkElement.focus() }); } stackTraceElement.classList.add('hidden'); UI.ARIAUtils.markAsGroup(stackTraceElement); this._expandTrace = (expand) => { icon.setIconType(expand ? 'smallicon-triangle-down' : 'smallicon-triangle-right'); stackTraceElement.classList.toggle('hidden', !expand); UI.ARIAUtils.setExpanded(clickableElement, expand); this._traceExpanded = expand; }; const toggleStackTrace = (event) => { if (UI.UIUtils.isEditing() || contentElement.hasSelection()) { return; } this._expandTrace && this._expandTrace(stackTraceElement.classList.contains('hidden')); event.consume(); }; clickableElement.addEventListener('click', toggleStackTrace, false); if (this._message.type === "trace" /* Trace */) { this._expandTrace(true); } // @ts-ignore toggleElement._expandStackTraceForTest = this._expandTrace.bind(this, true); return toggleElement; } _linkifyLocation(url, lineNumber, columnNumber) { const runtimeModel = this._message.runtimeModel(); if (!runtimeModel) { return null; } return this._linkifier.linkifyScriptLocation(runtimeModel.target(), /* scriptId */ null, url, lineNumber, { columnNumber, className: undefined, tabStop: undefined, inlineFrameIndex: 0 }); } _linkifyStackTraceTopFrame(stackTrace) { const runtimeModel = this._message.runtimeModel(); if (!runtimeModel) { return null; } return this._linkifier.linkifyStackTraceTopFrame(runtimeModel.target(), stackTrace); } _linkifyScriptId(scriptId, url, lineNumber, columnNumber) { const runtimeModel = this._message.runtimeModel(); if (!runtimeModel) { return null; } return this._linkifier.linkifyScriptLocation(runtimeModel.target(), scriptId, url, lineNumber, { columnNumber, className: undefined, tabStop: undefined, inlineFrameIndex: 0 }); } _format(rawParameters) { // This node is used like a Builder. Values are continually appended onto it. const formattedResult = document.createElement('span'); if (this._messagePrefix) { formattedResult.createChild('span').textContent = this._messagePrefix; } if (!rawParameters.length) { return formattedResult; } // Formatting code below assumes that parameters are all wrappers whereas frontend console // API allows passing arbitrary values as messages (strings, numbers, etc.). Wrap them here. // FIXME: Only pass runtime wrappers here. let parameters = rawParameters.map(parameterToRemoteObject(this._message.runtimeModel())); // There can be string log and string eval result. We distinguish between them based on message type. const shouldFormatMessage = SDK.RemoteObject.RemoteObject.type(parameters[0]) === 'string' && (this._message.type !== SDK.ConsoleModel.FrontendMessageType.Result || this._message.level === "error" /* Error */); // Multiple parameters with the first being a format string. Save unused substitutions. if (shouldFormatMessage) { const result = this._formatWithSubstitutionString(parameters[0].description, parameters.slice(1), formattedResult); parameters = Array.from(result.unusedSubstitutions || []); if (parameters.length) { UI.UIUtils.createTextChild(formattedResult, ' '); } } // Single parameter, or unused substitutions from above. for (let i = 0; i < parameters.length; ++i) { // Inline strings when formatting. if (shouldFormatMessage && parameters[i].type === 'string') { formattedResult.appendChild(this._linkifyStringAsFragment(parameters[i].description || '')); } else { formattedResult.appendChild(this._formatParameter(parameters[i], false, true)); } if (i < parameters.length - 1) { UI.UIUtils.createTextChild(formattedResult, ' '); } } return formattedResult; } _formatParameter(output, forceObjectFormat, includePreview) { if (output.customPreview()) { return new ObjectUI.CustomPreviewComponent.CustomPreviewComponent(output).element; } const outputType = forceObjectFormat ? 'object' : (output.subtype || output.type); let element; switch (outputType) { case 'error': element = this._formatParameterAsError(output); break; case 'function': element = this._formatParameterAsFunction(output, includePreview); break; case 'array': case 'arraybuffer': case 'blob': case 'dataview': case 'generator': case 'iterator': case 'map': case 'object': case 'promise': case 'proxy': case 'set': case 'typedarray': case 'wasmvalue': case 'weakmap': case 'weakset': case 'webassemblymemory': element = this._formatParameterAsObject(output, includePreview); break; case 'node': element = output.isNode() ? this._formatParameterAsNode(output) : this._formatParameterAsObject(output, false); break; case 'trustedtype': element = this._formatParameterAsObject(output, false); break; case 'string': element = this._formatParameterAsString(output); break; case 'boolean': case 'date': case 'null': case 'number': case 'regexp': case 'symbol': case 'undefined': case 'bigint': element = this._formatParameterAsValue(output); break; default: element = this._formatParameterAsValue(output); console.error(`Tried to format remote object of unknown type ${outputType}.`); } element.classList.add(`object-value-${outputType}`); element.classList.add('source-code'); return element; } _formatParameterAsValue(obj) { const result = document.createElement('span'); const description = obj.description || ''; if (description.length > getMaxTokenizableStringLength()) { const propertyValue = new ObjectUI.ObjectPropertiesSection.ExpandableTextPropertyValue(document.createElement('span'), description, getLongStringVisibleLength()); result.appendChild(propertyValue.element); } else { UI.UIUtils.createTextChild(result, description); } result.addEventListener('contextmenu', this._contextMenuEventFired.bind(this, obj), false); return result; } _formatParameterAsTrustedType(obj) { const result = document.createElement('span'); const trustedContentSpan = document.createElement('span'); trustedContentSpan.appendChild(this._formatParameterAsString(obj)); trustedContentSpan.classList.add('object-value-string'); UI.UIUtils.createTextChild(result, `${obj.className} `); result.appendChild(trustedContentSpan); return result; } _formatParameterAsObject(obj, includePreview) { const titleElement = document.createElement('span'); titleElement.classList.add('console-object'); if (includePreview && obj.preview) { titleElement.classList.add('console-object-preview'); this._previewFormatter.appendObjectPreview(titleElement, obj.preview, false /* isEntry */); } else if (obj.type === 'function') { const functionElement = titleElement.createChild('span'); ObjectUI.ObjectPropertiesSection.ObjectPropertiesSection.formatObjectAsFunction(obj, functionElement, false); titleElement.classList.add('object-value-function'); } else if (obj.subtype === 'trustedtype') { titleElement.appendChild(this._formatParameterAsTrustedType(obj)); } else { UI.UIUtils.createTextChild(titleElement, obj.description || ''); } if (!obj.hasChildren || obj.customPreview()) { return titleElement; } const note = titleElement.createChild('span', 'object-state-note info-note'); if (this._message.type === SDK.ConsoleModel.FrontendMessageType.QueryObjectResult) { UI.Tooltip.Tooltip.install(note, i18nString(UIStrings.thisValueWillNotBeCollectedUntil)); } else { UI.Tooltip.Tooltip.install(note, i18nString(UIStrings.thisValueWasEvaluatedUponFirst)); } const section = new ObjectUI.ObjectPropertiesSection.ObjectPropertiesSection(obj, titleElement, this._linkifier); section.element.classList.add('console-view-object-properties-section'); section.enableContextMenu(); section.setShowSelectionOnKeyboardFocus(true, true); this._selectableChildren.push(section); section.addEventListener(UI.TreeOutline.Events.ElementAttached, this._messageResized); section.addEventListener(UI.TreeOutline.Events.ElementExpanded, this._messageResized); section.addEventListener(UI.TreeOutline.Events.ElementCollapsed, this._messageResized); return section.element; } _formatParameterAsFunction(func, includePreview) { const result = document.createElement('span'); SDK.RemoteObject.RemoteFunction.objectAsFunction(func).targetFunction().then(formatTargetFunction.bind(this)); return result; function formatTargetFunction(targetFunction) { const functionElement = document.createElement('span'); const promise = ObjectUI.ObjectPropertiesSection.ObjectPropertiesSection.formatObjectAsFunction(targetFunction, functionElement, true, includePreview); result.appendChild(functionElement); if (targetFunction !== func) { const note = result.createChild('span', 'object-info-state-note'); UI.Tooltip.Tooltip.install(note, i18nString(UIStrings.functionWasResolvedFromBound)); } result.addEventListener('contextmenu', this._contextMenuEventFired.bind(this, targetFunction), false); promise.then(() => this._formattedParameterAsFunctionForTest()); } } _formattedParameterAsFunctionForTest() { } _contextMenuEventFired(obj, event) { const contextMenu = new UI.ContextMenu.ContextMenu(event); contextMenu.appendApplicableItems(obj); contextMenu.show(); } _renderPropertyPreviewOrAccessor(object, property, propertyPath) { if (property.type === 'accessor') { return this._formatAsAccessorProperty(object, propertyPath.map(property => property.name.toString()), false); } return this._previewFormatter.renderPropertyPreview(property.type, 'subtype' in property ? property.subtype : undefined, null, property.value); } _formatParameterAsNode(remoteObject) { const result = document.createElement('span'); const domModel = remoteObject.runtimeModel().target().model(SDK.DOMModel.DOMModel); if (!domModel) { return result; } domModel.pushObjectAsNodeToFrontend(remoteObject).then(async (node) => { if (!node) { result.appendChild(this._formatParameterAsObject(remoteObject, false)); return; } const renderResult = await UI.UIUtils.Renderer.render(node); if (renderResult) { if (renderResult.tree) { this._selectableChildren.push(renderResult.tree); renderResult.tree.addEventListener(UI.TreeOutline.Events.ElementAttached, this._messageResized); renderResult.tree.addEventListener(UI.TreeOutline.Events.ElementExpanded, this._messageResized); renderResult.tree.addEventListener(UI.TreeOutline.Events.ElementCollapsed, this._messageResized); } result.appendChild(renderResult.node); } else { result.appendChild(this._formatParameterAsObject(remoteObject, false)); } this._formattedParameterAsNodeForTest(); }); return result; } _formattedParameterAsNodeForTest() { } _formatParameterAsString(output) { const description = output.description ?? ''; const text = Platform.StringUtilities.formatAsJSLiteral(description); const result = document.createElement('span'); result.addEventListener('contextmenu', this._contextMenuEventFired.bind(this, output), false); result.appendChild(this._linkifyStringAsFragment(text)); return result; } _formatParameterAsError(output) { const result = document.createElement('span'); const errorSpan = this._tryFormatAsError(output.description || ''); result.appendChild(errorSpan ? errorSpan : this._linkifyStringAsFragment(output.description || '')); return result; } _formatAsArrayEntry(output) { return this._previewFormatter.renderPropertyPreview(output.type, output.subtype, output.className, output.description); } _formatAsAccessorProperty(object, propertyPath, isArrayEntry) { const rootElement = ObjectUI.ObjectPropertiesSection.ObjectPropertyTreeElement.createRemoteObjectAccessorPropertySpan(object, propertyPath, onInvokeGetterClick.bind(this)); function onInvokeGetterClick(result) { const wasThrown = result.wasThrown; const object = result.object; if (!object) { return; } rootElement.removeChildren(); if (wasThrown) { const element = rootElement.createChild('span'); element.textContent = i18nString(UIStrings.exception); UI.Tooltip.Tooltip.install(element, object.description); } else if (isArrayEntry) { rootElement.appendChild(this._formatAsArrayEntry(object)); } else { // Make a PropertyPreview from the RemoteObject similar to the backend logic. const maxLength = 100; const type = object.type; const subtype = object.subtype; let description = ''; if (type !== 'function' && object.description) { if (type === 'string' || subtype === 'regexp' || subtype === 'trustedtype') { description = Platform.StringUtilities.trimMiddle(object.description, maxLength); } else { description = Platform.StringUtilities.trimEndWithMaxLength(object.description, maxLength); } } rootElement.appendChild(this._previewFormatter.renderPropertyPreview(type, subtype, object.className, description)); } } return rootElement; } _formatWithSubstitutionString(format, parameters, formattedResult) { function parameterFormatter(force, includePreview, obj) { if (obj instanceof SDK.RemoteObject.RemoteObject) { return this._formatParameter(obj, force, includePreview); } return stringFormatter(obj); } function stringFormatter(obj) { if (obj === undefined) { return undefined; } if (typeof obj === 'string') { return obj; } return obj.description; } function floatFormatter(obj) { if (obj instanceof SDK.RemoteObject.RemoteObject) { if (typeof obj.value !== 'number') { return 'NaN'; } return obj.value; } return undefined; } function integerFormatter(obj) { if (obj instanceof SDK.RemoteObject.RemoteObject) { if (obj.type === 'bigint') { return obj.description; } if (typeof obj.value !== 'number') { return 'NaN'; } return Math.floor(obj.value); } return undefined; } function bypassFormatter(obj) { return (obj instanceof Node) ? obj : ''; } let currentStyle = null; function styleFormatter(obj) { currentStyle = new Map(); const buffer = document.createElement('span'); if (obj === undefined) { return; } if (typeof obj === 'string' || !obj.description) { return; } buffer.setAttribute('style', obj.description); for (const property of buffer.style) { if (isAllowedProperty(property)) { const info = { value: buffer.style.getPropertyValue(property), priority: buffer.style.getPropertyPriority(property), }; currentStyle.set(property, info); } } } function isAllowedProperty(property) { // Make sure that allowed properties do not interfere with link visibility. const prefixes = [ 'background', 'border', 'color', 'font', 'line', 'margin', 'padding', 'text', '-webkit-background', '-webkit-border', '-webkit-font', '-webkit-margin', '-webkit-padding', '-webkit-text', ]; for (const prefix of prefixes) { if (property.startsWith(prefix)) { return true; } } return false; } // TODO(crbug.com/1172300) Ignored during the jsdoc to ts migration) // eslint-disable-next-line @typescript-eslint/no-explicit-any const formatters = {}; // Firebug uses %o for formatting objects. formatters.o = parameterFormatter.bind(this, false /* force */, true /* includePreview */); formatters.s = stringFormatter; formatters.f = floatFormatter; // Firebug allows both %i and %d for formatting integers. formatters.i = integerFormatter; formatters.d = integerFormatter; // Firebug uses %c for styling the message. formatters.c = styleFormatter; // Support %O to force object formatting, instead of the type-based %o formatting. formatters.O = parameterFormatter.bind(this, true /* force */, false /* includePreview */); formatters._ = bypassFormatter; function append(a, b) { if (b instanceof Node) { a.appendChild(b); return a; } if (typeof b === 'undefined') { return a; } if (!currentStyle) { a.appendChild(this._linkifyStringAsFragment(String(b))); return a; } const lines = String(b).split('\n'); for (let i = 0; i < lines.length; i++) { const line = lines[i]; const lineFragment = this._linkifyStringAsFragment(line); const wrapper = document.createElement('span'); wrapper.style.setProperty('contain', 'paint'); wrapper.style.setProperty('display', 'inline-block'); wrapper.style.setProperty('max-width', '100%'); wrapper.appendChild(lineFragment); applyCurrentStyle(wrapper); for (const child of wrapper.children) { if (child.classList.contains('devtools-link') && child instanceof HTMLElement) { this._applyForcedVisibleStyle(child); } } a.appendChild(wrapper); if (i < lines.length - 1) { a.appendChild(document.createElement('br')); } } return a; } function applyCurrentStyle(element) { if (!currentStyle) { return; } for (const [property, { value, priority }] of currentStyle.entries()) { element.style.setProperty(property, value, priority); } } // Platform.StringUtilities.format does treat formattedResult like a Builder, result is an object. return Platform.StringUtilities.format(format, parameters, formatters, formattedResult, append.bind(this)); } _applyForcedVisibleStyle(element) { element.style.setProperty('-webkit-text-stroke', '0', 'important'); element.style.setProperty('text-decoration', 'underline', 'important'); const themedColor = ThemeSupport.ThemeSupport.instance().patchColorText('rgb(33%, 33%, 33%)', ThemeSupport.ThemeSupport.ColorUsage.Foreground); element.style.setProperty('color', themedColor, 'important'); let backgroundColor = 'hsl(0, 0%, 100%)'; if (this._message.level === "error" /* Error */) { backgroundColor = 'hsl(0, 100%, 97%)'; } else if (this._message.level === "warning" /* Warning */ || this._shouldRenderAsWarning()) { backgroundColor = 'hsl(50, 100%, 95%)'; } const themedBackgroundColor = ThemeSupport.ThemeSupport.instance().patchColorText(backgroundColor, ThemeSupport.ThemeSupport.ColorUsage.Background); element.style.setProperty('background-color', themedBackgroundColor, 'important'); } matchesFilterRegex(regexObject) { regexObject.lastIndex = 0; const contentElement = this.contentElement(); const anchorText = this._anchorElement ? this._anchorElement.deepTextContent() : ''; return (Boolean(anchorText) && regexObject.test(anchorText.trim())) || regexObject.test(contentElement.deepTextContent().slice(anchorText.length)); } matchesFilterText(filter) { const text = this.contentElement().deepTextContent(); return text.toLowerCase().includes(filter.toLowerCase()); } updateTimestamp() { if (!this._contentElement) { return; } if (Common.Settings.Settings.instance().moduleSetting('consoleTimestampsEnabled').get()) { if (!this._timestampElement) { this._timestampElement = document.createElement('span'); this._timestampElement.classList.add('console-timestamp'); } this._timestampElement.textContent = UI.UIUtils.formatTimestamp(this._message.timestamp, false) + ' '; UI.Tooltip.Tooltip.install(this._timestampElement, UI.UIUtils.formatTimestamp(this._message.timestamp, true)); this._contentElement.insertBefore(this._timestampElement, this._contentElement.firstChild); } else if (this._timestampElement) { this._timestampElement.remove(); this._timestampElement = null; } } nestingLevel() { return this._nestingLevel; } setInSimilarGroup(inSimilarGroup, isLast) { this._inSimilarGroup = inSimilarGroup; this._lastInSimilarGroup = inSimilarGroup && Boolean(isLast); if (this._similarGroupMarker && !inSimilarGroup) { this._similarGroupMarker.remove(); this._similarGroupMarker = null; } else if (this._element && !this._similarGroupMarker && inSimilarGroup) { this._similarGroupMarker = document.createElement('div'); this._similarGroupMarker.classList.add('nesting-level-marker'); this._element.insertBefore(this._similarGroupMarker, this._element.firstChild); this._similarGroupMarker.classList.toggle('group-closed', this._lastInSimilarGroup); } } isLastInSimilarGroup() { return Boolean(this._inSimilarGroup) && Boolean(this._lastInSimilarGroup); } resetCloseGroupDecorationCount() { if (!this._closeGroupDecorationCount) { return; } this._closeGroupDecorationCount = 0; this._updateCloseGroupDecorations(); } incrementCloseGroupDecorationCount() { ++this._closeGroupDecorationCount; this._updateCloseGroupDecorations(); } _updateCloseGroupDecorations() { if (!this._nestingLevelMarkers) { return; } for (let i = 0, n = this._nestingLevelMarkers.length; i < n; ++i) { const marker = this._nestingLevelMarkers[i]; marker.classList.toggle('group-closed', n - i <= this._closeGroupDecorationCount); } } _focusedChildIndex() { if (!this._selectableChildren.length) { return -1; } return this._selectableChildren.findIndex(child => child.element.hasFocus()); } _onKeyDown(event) { if (UI.UIUtils.isEditing() || !this._element || !this._element.hasFocus() || this._element.hasSelection()) { return; } if (this.maybeHandleOnKeyDown(event)) { event.consume(true); } } maybeHandleOnKeyDown(event) { // Handle trace expansion. const focusedChildIndex = this._focusedChildIndex(); const isWrapperFocused = focusedChildIndex === -1; if (this._expandTrace && isWrapperFocused) { if ((event.key === 'ArrowLeft' && this._traceExpanded) || (event.key === 'ArrowRight' && !this._traceExpanded)) { this._expandTrace(!this._traceExpanded); return true; } } if (!this._selectableChildren.length) { return false; } if (event.key === 'ArrowLeft') { this._element && this._element.focus(); return true; } if (event.key === 'ArrowRight') { if (isWrapperFocused && this._selectNearestVisibleChild(0)) { return true; } } if (event.key === 'ArrowUp') { const firstVisibleChild = this._nearestVisibleChild(0); if (this._selectableChildren[focusedChildIndex] === firstVisibleChild && firstVisibleChild) { this._element && this._element.focus(); return true; } if (this._selectNearestVisibleChild(focusedChildIndex - 1, true /* backwards */)) { return true; } } if (event.key === 'ArrowDown') { if (isWrapperFocused && this._selectNearestVisibleChild(0)) { return true; } if (!isWrapperFocused && this._selectNearestVisibleChild(focusedChildIndex + 1)) { return true; } } return false; } _selectNearestVisibleChild(fromIndex, backwards) { const nearestChild = this._nearestVisibleChild(fromIndex, backwards); if (nearestChild) { nearestChild.forceSelect(); return true; } return false; } _nearestVisibleChild(fromIndex, backwards) { const childCount = this._selectableChildren.length; if (fromIndex < 0 || fromIndex >= childCount) { return null; } const direction = backwards ? -1 : 1; let index = fromIndex; while (!this._selectableChildren[index].element.offsetParent) { index += direction; if (index < 0 || index >= childCount) { return null; } } return this._selectableChildren[index]; } focusLastChildOrSelf() { if (this._element && !this._selectNearestVisibleChild(this._selectableChildren.length - 1, true /* backwards */)) { this._element.focus(); } } setContentElement(element) { console.assert(!this._contentElement, 'Cannot set content element twice'); this._contentElement = element; } getContentElement() { return this._contentElement; } contentElement() { if (this._contentElement) { return this._contentElement; } const contentElement = document.createElement('div'); contentElement.classList.add('console-message'); if (this._messageLevelIcon) { contentElement.appendChild(this._messageLevelIcon); } this._contentElement = contentElement; const runtimeModel = this._message.runtimeModel(); let formattedMessage; const shouldIncludeTrace = Boolean(this._message.stackTrace) && (this._message.source === "network" /* Network */ || t