1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/* 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 */
/* import-globals-from ../performance-view.js */
/* exported DetailsSubview */
"use strict";
/**
* A base class from which all detail views inherit.
*/
var DetailsSubview = {
/**
* Sets up the view with event binding.
*/
initialize: function () {
this._onRecordingStoppedOrSelected = this._onRecordingStoppedOrSelected.bind(this);
this._onOverviewRangeChange = this._onOverviewRangeChange.bind(this);
this._onDetailsViewSelected = this._onDetailsViewSelected.bind(this);
this._onPrefChanged = this._onPrefChanged.bind(this);
PerformanceController.on(EVENTS.RECORDING_STATE_CHANGE,
this._onRecordingStoppedOrSelected);
PerformanceController.on(EVENTS.RECORDING_SELECTED,
this._onRecordingStoppedOrSelected);
PerformanceController.on(EVENTS.PREF_CHANGED, this._onPrefChanged);
OverviewView.on(EVENTS.UI_OVERVIEW_RANGE_SELECTED, this._onOverviewRangeChange);
DetailsView.on(EVENTS.UI_DETAILS_VIEW_SELECTED, this._onDetailsViewSelected);
let self = this;
let originalRenderFn = this.render;
let afterRenderFn = () => {
this._wasRendered = true;
};
this.render = Task.async(function* (...args) {
let maybeRetval = yield originalRenderFn.apply(self, args);
afterRenderFn();
return maybeRetval;
});
},
/**
* Unbinds events.
*/
destroy: function () {
clearNamedTimeout("range-change-debounce");
PerformanceController.off(EVENTS.RECORDING_STATE_CHANGE,
this._onRecordingStoppedOrSelected);
PerformanceController.off(EVENTS.RECORDING_SELECTED,
this._onRecordingStoppedOrSelected);
PerformanceController.off(EVENTS.PREF_CHANGED, this._onPrefChanged);
OverviewView.off(EVENTS.UI_OVERVIEW_RANGE_SELECTED, this._onOverviewRangeChange);
DetailsView.off(EVENTS.UI_DETAILS_VIEW_SELECTED, this._onDetailsViewSelected);
},
/**
* Returns true if this view was rendered at least once.
*/
get wasRenderedAtLeastOnce() {
return !!this._wasRendered;
},
/**
* Amount of time (in milliseconds) to wait until this view gets updated,
* when the range is changed in the overview.
*/
rangeChangeDebounceTime: 0,
/**
* When the overview range changes, all details views will require a
* rerendering at a later point, determined by `shouldUpdateWhenShown` and
* `canUpdateWhileHidden` and whether or not its the current view.
* Set `requiresUpdateOnRangeChange` to false to not invalidate the view
* when the range changes.
*/
requiresUpdateOnRangeChange: true,
/**
* Flag specifying if this view should be updated when selected. This will
* be set to true, for example, when the range changes in the overview and
* this view is not currently visible.
*/
shouldUpdateWhenShown: false,
/**
* Flag specifying if this view may get updated even when it's not selected.
* Should only be used in tests.
*/
canUpdateWhileHidden: false,
/**
* An array of preferences under `devtools.performance.ui.` that the view should
* rerender and callback `this._onRerenderPrefChanged` upon change.
*/
rerenderPrefs: [],
/**
* An array of preferences under `devtools.performance.` that the view should
* observe and callback `this._onObservedPrefChange` upon change.
*/
observedPrefs: [],
/**
* Flag specifying if this view should update while the overview selection
* area is actively being dragged by the mouse.
*/
shouldUpdateWhileMouseIsActive: false,
/**
* Called when recording stops or is selected.
*/
_onRecordingStoppedOrSelected: function (_, state, recording) {
if (typeof state !== "string") {
recording = state;
}
if (arguments.length === 3 && state !== "recording-stopped") {
return;
}
if (!recording || !recording.isCompleted()) {
return;
}
if (DetailsView.isViewSelected(this) || this.canUpdateWhileHidden) {
this.render(OverviewView.getTimeInterval());
} else {
this.shouldUpdateWhenShown = true;
}
},
/**
* Fired when a range is selected or cleared in the OverviewView.
*/
_onOverviewRangeChange: function (_, interval) {
if (!this.requiresUpdateOnRangeChange) {
return;
}
if (DetailsView.isViewSelected(this)) {
let debounced = () => {
if (!this.shouldUpdateWhileMouseIsActive && OverviewView.isMouseActive) {
// Don't render yet, while the selection is still being dragged.
setNamedTimeout("range-change-debounce", this.rangeChangeDebounceTime,
debounced);
} else {
this.render(interval);
}
};
setNamedTimeout("range-change-debounce", this.rangeChangeDebounceTime, debounced);
} else {
this.shouldUpdateWhenShown = true;
}
},
/**
* Fired when a view is selected in the DetailsView.
*/
_onDetailsViewSelected: function () {
if (DetailsView.isViewSelected(this) && this.shouldUpdateWhenShown) {
this.render(OverviewView.getTimeInterval());
this.shouldUpdateWhenShown = false;
}
},
/**
* Fired when a preference in `devtools.performance.ui.` is changed.
*/
_onPrefChanged: function (_, prefName) {
if (~this.observedPrefs.indexOf(prefName) && this._onObservedPrefChange) {
this._onObservedPrefChange(_, prefName);
}
// All detail views require a recording to be complete, so do not
// attempt to render if recording is in progress or does not exist.
let recording = PerformanceController.getCurrentRecording();
if (!recording || !recording.isCompleted()) {
return;
}
if (!~this.rerenderPrefs.indexOf(prefName)) {
return;
}
if (this._onRerenderPrefChanged) {
this._onRerenderPrefChanged(_, prefName);
}
if (DetailsView.isViewSelected(this) || this.canUpdateWhileHidden) {
this.render(OverviewView.getTimeInterval());
} else {
this.shouldUpdateWhenShown = true;
}
}
};
|
