Files
tubestation/devtools/client/webconsole/components/Message.js

352 lines
11 KiB
JavaScript

/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set ft=javascript ts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
// React & Redux
const { Component, createFactory, createElement } = require("devtools/client/shared/vendor/react");
const dom = require("devtools/client/shared/vendor/react-dom-factories");
const { l10n } = require("devtools/client/webconsole/utils/messages");
const actions = require("devtools/client/webconsole/actions/index");
const { MESSAGE_SOURCE, MESSAGE_TYPE } = require("devtools/client/webconsole/constants");
const { MessageIndent } = require("devtools/client/webconsole/components/MessageIndent");
const MessageIcon = require("devtools/client/webconsole/components/MessageIcon");
const FrameView = createFactory(require("devtools/client/shared/components/Frame"));
loader.lazyRequireGetter(this, "CollapseButton", "devtools/client/webconsole/components/CollapseButton");
loader.lazyRequireGetter(this, "MessageRepeat", "devtools/client/webconsole/components/MessageRepeat");
loader.lazyRequireGetter(this, "PropTypes", "devtools/client/shared/vendor/react-prop-types");
loader.lazyRequireGetter(this, "SmartTrace", "devtools/client/shared/components/SmartTrace");
ChromeUtils.defineModuleGetter(this, "pointPrecedes", "resource://devtools/shared/execution-point-utils.js");
class Message extends Component {
static get propTypes() {
return {
open: PropTypes.bool,
collapsible: PropTypes.bool,
collapseTitle: PropTypes.string,
onToggle: PropTypes.func,
source: PropTypes.string.isRequired,
type: PropTypes.string.isRequired,
level: PropTypes.string.isRequired,
indent: PropTypes.number.isRequired,
inWarningGroup: PropTypes.bool,
topLevelClasses: PropTypes.array.isRequired,
messageBody: PropTypes.any.isRequired,
repeat: PropTypes.any,
frame: PropTypes.any,
attachment: PropTypes.any,
stacktrace: PropTypes.any,
messageId: PropTypes.string,
executionPoint: PropTypes.object,
pausedExecutionPoint: PropTypes.object,
scrollToMessage: PropTypes.bool,
exceptionDocURL: PropTypes.string,
request: PropTypes.object,
dispatch: PropTypes.func,
timeStamp: PropTypes.number,
timestampsVisible: PropTypes.bool.isRequired,
serviceContainer: PropTypes.shape({
emitNewMessage: PropTypes.func.isRequired,
onViewSourceInDebugger: PropTypes.func,
onViewSourceInScratchpad: PropTypes.func,
onViewSourceInStyleEditor: PropTypes.func,
openContextMenu: PropTypes.func.isRequired,
openLink: PropTypes.func.isRequired,
sourceMapService: PropTypes.any,
}),
notes: PropTypes.arrayOf(PropTypes.shape({
messageBody: PropTypes.string.isRequired,
frame: PropTypes.any,
})),
isPaused: PropTypes.bool,
maybeScrollToBottom: PropTypes.func,
};
}
static get defaultProps() {
return {
indent: 0,
};
}
constructor(props) {
super(props);
this.onLearnMoreClick = this.onLearnMoreClick.bind(this);
this.toggleMessage = this.toggleMessage.bind(this);
this.onContextMenu = this.onContextMenu.bind(this);
this.onMouseEvent = this.onMouseEvent.bind(this);
this.renderIcon = this.renderIcon.bind(this);
}
componentDidMount() {
if (this.messageNode) {
if (this.props.scrollToMessage) {
this.messageNode.scrollIntoView();
}
// Event used in tests. Some message types don't pass it in because existing tests
// did not emit for them.
if (this.props.serviceContainer) {
this.props.serviceContainer.emitNewMessage(
this.messageNode, this.props.messageId, this.props.timeStamp);
}
}
}
onLearnMoreClick(e) {
const {exceptionDocURL} = this.props;
this.props.serviceContainer.openLink(exceptionDocURL, e);
}
toggleMessage(e) {
const { open, dispatch, messageId, onToggle } = this.props;
// If defined on props, we let the onToggle() method handle the toggling,
// otherwise we toggle the message open/closed ourselves.
if (onToggle) {
onToggle(messageId, e);
} else if (open) {
dispatch(actions.messageClose(messageId));
} else {
dispatch(actions.messageOpen(messageId));
}
}
onContextMenu(e) {
const { serviceContainer, source, request, messageId } = this.props;
const messageInfo = {
source,
request,
messageId,
};
serviceContainer.openContextMenu(e, messageInfo);
e.stopPropagation();
e.preventDefault();
}
onMouseEvent(ev) {
const {messageId, serviceContainer, executionPoint} = this.props;
if (serviceContainer.canRewind() && executionPoint) {
serviceContainer.onMessageHover(ev.type, messageId);
}
}
renderIcon() {
const {
level,
messageId,
executionPoint,
serviceContainer,
inWarningGroup,
type,
} = this.props;
if (inWarningGroup) {
return undefined;
}
return MessageIcon({
level,
onRewindClick: (serviceContainer.canRewind() && executionPoint)
? () => serviceContainer.jumpToExecutionPoint(executionPoint, messageId)
: null,
type,
});
}
render() {
const {
open,
collapsible,
collapseTitle,
source,
type,
isPaused,
level,
indent,
inWarningGroup,
topLevelClasses,
messageBody,
frame,
stacktrace,
serviceContainer,
exceptionDocURL,
timeStamp = Date.now(),
timestampsVisible,
executionPoint,
pausedExecutionPoint,
messageId,
notes,
} = this.props;
topLevelClasses.push("message", source, type, level);
if (open) {
topLevelClasses.push("open");
}
if (isPaused) {
topLevelClasses.push("paused");
if (pausedExecutionPoint
&& executionPoint
&& !pointPrecedes(executionPoint, pausedExecutionPoint)) {
topLevelClasses.push("paused-before");
}
}
let timestampEl;
if (timestampsVisible === true) {
timestampEl = dom.span({
className: "timestamp devtools-monospace",
}, l10n.timestampString(timeStamp));
}
const icon = this.renderIcon();
// Figure out if there is an expandable part to the message.
let attachment = null;
if (this.props.attachment) {
attachment = this.props.attachment;
} else if (stacktrace && open) {
attachment = dom.div(
{
className: "stacktrace devtools-monospace",
},
createElement(SmartTrace, {
stacktrace,
onViewSourceInDebugger: serviceContainer.onViewSourceInDebugger
|| serviceContainer.onViewSource,
onViewSourceInScratchpad: serviceContainer.onViewSourceInScratchpad
|| serviceContainer.onViewSource,
onViewSource: serviceContainer.onViewSource,
onReady: this.props.maybeScrollToBottom,
sourceMapService: serviceContainer.sourceMapService,
}),
);
}
// If there is an expandable part, make it collapsible.
let collapse = null;
if (collapsible) {
collapse = createElement(CollapseButton, {
open,
title: collapseTitle,
onClick: this.toggleMessage,
});
}
let notesNodes;
if (notes) {
notesNodes = notes.map(note => dom.span(
{ className: "message-flex-body error-note" },
dom.span({ className: "message-body devtools-monospace" },
"note: " + note.messageBody
),
dom.span({ className: "message-location devtools-monospace" },
note.frame ? FrameView({
frame: note.frame,
onClick: serviceContainer
? serviceContainer.onViewSourceInDebugger || serviceContainer.onViewSource
: undefined,
showEmptyPathAsHost: true,
sourceMapService: serviceContainer
? serviceContainer.sourceMapService
: undefined,
}) : null
)));
} else {
notesNodes = [];
}
const repeat = this.props.repeat && this.props.repeat > 1
? createElement(MessageRepeat, {repeat: this.props.repeat})
: null;
let onFrameClick;
if (serviceContainer && frame) {
if (source === MESSAGE_SOURCE.CSS) {
onFrameClick = serviceContainer.onViewSourceInStyleEditor
|| serviceContainer.onViewSource;
} else if (/^Scratchpad\/\d+$/.test(frame.source)) {
onFrameClick = serviceContainer.onViewSourceInScratchpad
|| serviceContainer.onViewSource;
} else {
// Point everything else to debugger, if source not available,
// it will fall back to view-source.
onFrameClick = serviceContainer.onViewSourceInDebugger
|| serviceContainer.onViewSource;
}
}
// Configure the location.
const location = dom.span({ className: "message-location devtools-monospace" },
frame ? FrameView({
frame,
onClick: onFrameClick,
showEmptyPathAsHost: true,
sourceMapService:
serviceContainer ? serviceContainer.sourceMapService : undefined,
}) : null
);
let learnMore;
if (exceptionDocURL) {
learnMore = dom.a({
className: "learn-more-link webconsole-learn-more-link",
title: exceptionDocURL.split("?")[0],
onClick: this.onLearnMoreClick,
}, `[${l10n.getStr("webConsoleMoreInfoLabel")}]`);
}
const bodyElements = Array.isArray(messageBody) ? messageBody : [messageBody];
const mouseEvents = serviceContainer.canRewind() && executionPoint
? { onMouseEnter: this.onMouseEvent, onMouseLeave: this.onMouseEvent }
: {};
return dom.div({
className: topLevelClasses.join(" "),
onContextMenu: this.onContextMenu,
...mouseEvents,
ref: node => {
this.messageNode = node;
},
"data-message-id": messageId,
"aria-live": type === MESSAGE_TYPE.COMMAND ? "off" : "polite",
},
timestampEl,
MessageIndent({
indent,
inWarningGroup,
}),
icon,
collapse,
dom.span({ className: "message-body-wrapper" },
dom.span({
className: "message-flex-body",
onClick: collapsible ? this.toggleMessage : undefined,
},
// Add whitespaces for formatting when copying to the clipboard.
timestampEl ? " " : null,
dom.span({ className: "message-body devtools-monospace" },
...bodyElements,
learnMore,
),
repeat ? " " : null,
repeat,
" ", location
),
attachment,
...notesNodes
),
// If an attachment is displayed, the final newline is handled by the attachment.
attachment ? null : dom.br(),
);
}
}
module.exports = Message;