tenfourfox/devtools/client/performance/performance-view.js
Cameron Kaiser c9b2922b70 hello FPR
2017-04-19 00:56:45 -07:00

327 lines
11 KiB
JavaScript

/* 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/. */
/* import-globals-from performance-controller.js */
"use strict";
/**
* Master view handler for the performance tool.
*/
var PerformanceView = {
_state: null,
// Set to true if the front emits a "buffer-status" event, indicating
// that the server has support for determining buffer status.
_bufferStatusSupported: false,
// Mapping of state to selectors for different properties and their values,
// from the main profiler view. Used in `PerformanceView.setState()`
states: {
"unavailable": [
{ sel: "#performance-view", opt: "selectedPanel", val: () => $("#unavailable-notice") },
],
"empty": [
{ sel: "#performance-view", opt: "selectedPanel", val: () => $("#empty-notice") }
],
"recording": [
{ sel: "#performance-view", opt: "selectedPanel", val: () => $("#performance-view-content") },
{ sel: "#details-pane-container", opt: "selectedPanel", val: () => $("#recording-notice") }
],
"console-recording": [
{ sel: "#performance-view", opt: "selectedPanel", val: () => $("#performance-view-content") },
{ sel: "#details-pane-container", opt: "selectedPanel", val: () => $("#console-recording-notice") }
],
"recorded": [
{ sel: "#performance-view", opt: "selectedPanel", val: () => $("#performance-view-content") },
{ sel: "#details-pane-container", opt: "selectedPanel", val: () => $("#details-pane") }
],
"loading": [
{ sel: "#performance-view", opt: "selectedPanel", val: () => $("#performance-view-content") },
{ sel: "#details-pane-container", opt: "selectedPanel", val: () => $("#loading-notice") }
]
},
/**
* Sets up the view with event binding and main subviews.
*/
initialize: Task.async(function* () {
this._recordButton = $("#main-record-button");
this._importButton = $("#import-button");
this._clearButton = $("#clear-button");
this._onRecordButtonClick = this._onRecordButtonClick.bind(this);
this._onImportButtonClick = this._onImportButtonClick.bind(this);
this._onClearButtonClick = this._onClearButtonClick.bind(this);
this._onRecordingSelected = this._onRecordingSelected.bind(this);
this._onProfilerStatusUpdated = this._onProfilerStatusUpdated.bind(this);
this._onRecordingStateChange = this._onRecordingStateChange.bind(this);
this._onNewRecordingFailed = this._onNewRecordingFailed.bind(this);
for (let button of $$(".record-button")) {
button.addEventListener("click", this._onRecordButtonClick);
}
this._importButton.addEventListener("click", this._onImportButtonClick);
this._clearButton.addEventListener("click", this._onClearButtonClick);
// Bind to controller events to unlock the record button
PerformanceController.on(EVENTS.RECORDING_SELECTED, this._onRecordingSelected);
PerformanceController.on(EVENTS.PROFILER_STATUS_UPDATED, this._onProfilerStatusUpdated);
PerformanceController.on(EVENTS.RECORDING_STATE_CHANGE, this._onRecordingStateChange);
PerformanceController.on(EVENTS.NEW_RECORDING, this._onRecordingStateChange);
PerformanceController.on(EVENTS.NEW_RECORDING_FAILED, this._onNewRecordingFailed);
if (yield PerformanceController.canCurrentlyRecord()) {
this.setState("empty");
} else {
this.setState("unavailable");
}
// Initialize the ToolbarView first, because other views may need access
// to the OptionsView via the controller, to read prefs.
yield ToolbarView.initialize();
yield RecordingsView.initialize();
yield OverviewView.initialize();
yield DetailsView.initialize();
}),
/**
* Unbinds events and destroys subviews.
*/
destroy: Task.async(function* () {
for (let button of $$(".record-button")) {
button.removeEventListener("click", this._onRecordButtonClick);
}
this._importButton.removeEventListener("click", this._onImportButtonClick);
this._clearButton.removeEventListener("click", this._onClearButtonClick);
PerformanceController.off(EVENTS.RECORDING_SELECTED, this._onRecordingSelected);
PerformanceController.off(EVENTS.PROFILER_STATUS_UPDATED, this._onProfilerStatusUpdated);
PerformanceController.off(EVENTS.RECORDING_STATE_CHANGE, this._onRecordingStateChange);
PerformanceController.off(EVENTS.NEW_RECORDING, this._onRecordingStateChange);
PerformanceController.off(EVENTS.NEW_RECORDING_FAILED, this._onNewRecordingFailed);
yield ToolbarView.destroy();
yield RecordingsView.destroy();
yield OverviewView.destroy();
yield DetailsView.destroy();
}),
/**
* Sets the state of the profiler view. Possible options are "unavailable",
* "empty", "recording", "console-recording", "recorded".
*/
setState: function (state) {
let viewConfig = this.states[state];
if (!viewConfig) {
throw new Error(`Invalid state for PerformanceView: ${state}`);
}
for (let { sel, opt, val } of viewConfig) {
for (let el of $$(sel)) {
el[opt] = val();
}
}
this._state = state;
if (state === "console-recording") {
let recording = PerformanceController.getCurrentRecording();
let label = recording.getLabel() || "";
// Wrap the label in quotes if it exists for the commands.
label = label ? `"${label}"` : "";
let startCommand = $(".console-profile-recording-notice .console-profile-command");
let stopCommand = $(".console-profile-stop-notice .console-profile-command");
startCommand.value = `console.profile(${label})`;
stopCommand.value = `console.profileEnd(${label})`;
}
this.updateBufferStatus();
this.emit(EVENTS.UI_STATE_CHANGED, state);
},
/**
* Returns the state of the PerformanceView.
*/
getState: function () {
return this._state;
},
/**
* Updates the displayed buffer status.
*/
updateBufferStatus: function () {
// If we've never seen a "buffer-status" event from the front, ignore
// and keep the buffer elements hidden.
if (!this._bufferStatusSupported) {
return;
}
let recording = PerformanceController.getCurrentRecording();
if (!recording || !recording.isRecording()) {
return;
}
let bufferUsage = PerformanceController.getBufferUsageForRecording(recording) || 0;
// Normalize to a percentage value
let percent = Math.floor(bufferUsage * 100);
let $container = $("#details-pane-container");
let $bufferLabel = $(".buffer-status-message", $container.selectedPanel);
// Be a little flexible on the buffer status, although not sure how
// this could happen, as RecordingModel clamps.
if (percent >= 99) {
$container.setAttribute("buffer-status", "full");
} else {
$container.setAttribute("buffer-status", "in-progress");
}
$bufferLabel.value = L10N.getFormatStr("profiler.bufferFull", percent);
this.emit(EVENTS.UI_BUFFER_STATUS_UPDATED, percent);
},
/**
* Toggles the `locked` attribute on the record buttons based
* on `lock`.
*
* @param {boolean} lock
*/
_lockRecordButtons: function (lock) {
for (let button of $$(".record-button")) {
if (lock) {
button.setAttribute("locked", "true");
} else {
button.removeAttribute("locked");
}
}
},
/*
* Toggles the `checked` attribute on the record buttons based
* on `activate`.
*
* @param {boolean} activate
*/
_toggleRecordButtons: function (activate) {
for (let button of $$(".record-button")) {
if (activate) {
button.setAttribute("checked", "true");
} else {
button.removeAttribute("checked");
}
}
},
/**
* When a recording has started.
*/
_onRecordingStateChange: function () {
let currentRecording = PerformanceController.getCurrentRecording();
let recordings = PerformanceController.getRecordings();
this._toggleRecordButtons(recordings.find(r => !r.isConsole() && r.isRecording()));
this._lockRecordButtons(recordings.find(r => !r.isConsole() && r.isFinalizing()));
if (currentRecording && currentRecording.isFinalizing()) {
this.setState("loading");
}
if (currentRecording && currentRecording.isCompleted()) {
this.setState("recorded");
}
if (currentRecording && currentRecording.isRecording()) {
this.updateBufferStatus();
}
},
/**
* When starting a recording has failed.
*/
_onNewRecordingFailed: function (e) {
this._lockRecordButtons(false);
this._toggleRecordButtons(false);
},
/**
* Handler for clicking the clear button.
*/
_onClearButtonClick: function (e) {
this.emit(EVENTS.UI_CLEAR_RECORDINGS);
},
/**
* Handler for clicking the record button.
*/
_onRecordButtonClick: function (e) {
if (this._recordButton.hasAttribute("checked")) {
this.emit(EVENTS.UI_STOP_RECORDING);
} else {
this._lockRecordButtons(true);
this._toggleRecordButtons(true);
this.emit(EVENTS.UI_START_RECORDING);
}
},
/**
* Handler for clicking the import button.
*/
_onImportButtonClick: function(e) {
let fp = Cc["@mozilla.org/filepicker;1"].createInstance(Ci.nsIFilePicker);
fp.init(window, L10N.getStr("recordingsList.importDialogTitle"), Ci.nsIFilePicker.modeOpen);
fp.appendFilter(L10N.getStr("recordingsList.saveDialogJSONFilter"), "*.json");
fp.appendFilter(L10N.getStr("recordingsList.saveDialogAllFilter"), "*.*");
if (fp.show() == Ci.nsIFilePicker.returnOK) {
this.emit(EVENTS.UI_IMPORT_RECORDING, fp.file);
}
},
/**
* Fired when a recording is selected. Used to toggle the profiler view state.
*/
_onRecordingSelected: function (_, recording) {
if (!recording) {
this.setState("empty");
} else if (recording.isRecording() && recording.isConsole()) {
this.setState("console-recording");
} else if (recording.isRecording()) {
this.setState("recording");
} else {
this.setState("recorded");
}
},
/**
* Fired when the controller has updated information on the buffer's status.
* Update the buffer status display if shown.
*/
_onProfilerStatusUpdated: function (_, data) {
// We only care about buffer status here, so check to see
// if it has position.
if (!data || data.position === void 0) {
return;
}
// If this is our first buffer event, set the status and add a class
if (!this._bufferStatusSupported) {
this._bufferStatusSupported = true;
$("#details-pane-container").setAttribute("buffer-status", "in-progress");
}
if (!this.getState("recording") && !this.getState("console-recording")) {
return;
}
this.updateBufferStatus();
},
toString: () => "[object PerformanceView]"
};
/**
* Convenient way of emitting events from the view.
*/
EventEmitter.decorate(PerformanceView);