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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
const TIMING_HISTOGRAM = "WEBEXT_BROWSERACTION_POPUP_OPEN_MS";
const TIMING_HISTOGRAM_KEYED = "WEBEXT_BROWSERACTION_POPUP_OPEN_MS_BY_ADDONID";
const RESULT_HISTOGRAM = "WEBEXT_BROWSERACTION_POPUP_PRELOAD_RESULT_COUNT";
const RESULT_HISTOGRAM_KEYED =
"WEBEXT_BROWSERACTION_POPUP_PRELOAD_RESULT_COUNT_BY_ADDONID";
const EXTENSION_ID1 = "@test-extension1";
const EXTENSION_ID2 = "@test-extension2";
// Keep this in sync with the order in Histograms.json for
// WEBEXT_BROWSERACTION_POPUP_PRELOAD_RESULT_COUNT
const CATEGORIES = ["popupShown", "clearAfterHover", "clearAfterMousedown"];
/**
* Takes a Telemetry histogram snapshot and makes sure
* that the index for that value (as defined by CATEGORIES)
* has a count of 1, and that it's the only value that
* has been incremented.
*
* @param {object} snapshot
* The Telemetry histogram snapshot to examine.
* @param {string} category
* The category in CATEGORIES whose index we expect to have
* been set to 1.
*/
function assertOnlyOneTypeSet(snapshot, category) {
let categoryIndex = CATEGORIES.indexOf(category);
Assert.equal(
snapshot.values[categoryIndex],
1,
`Should have seen the ${category} count increment.`
);
// Use Array.prototype.reduce to sum up all of the
// snapshot.count entries
Assert.equal(
Object.values(snapshot.values).reduce((a, b) => a + b, 0),
1,
"Should only be 1 collected value."
);
}
add_task(async function testBrowserActionTelemetryTiming() {
let extensionOptions = {
manifest: {
browser_action: {
default_popup: "popup.html",
default_area: "navbar",
browser_style: true,
},
},
files: {
"popup.html": `<!DOCTYPE html><html><head><meta charset="utf-8"></head><body><div></div></body></html>`,
},
};
let extension1 = ExtensionTestUtils.loadExtension({
...extensionOptions,
manifest: {
...extensionOptions.manifest,
browser_specific_settings: {
gecko: { id: EXTENSION_ID1 },
},
},
});
let extension2 = ExtensionTestUtils.loadExtension({
...extensionOptions,
manifest: {
...extensionOptions.manifest,
browser_specific_settings: {
gecko: { id: EXTENSION_ID2 },
},
},
});
let histogram = Services.telemetry.getHistogramById(TIMING_HISTOGRAM);
let histogramKeyed = Services.telemetry.getKeyedHistogramById(
TIMING_HISTOGRAM_KEYED
);
histogram.clear();
histogramKeyed.clear();
is(
histogram.snapshot().sum,
0,
`No data recorded for histogram: ${TIMING_HISTOGRAM}.`
);
is(
Object.keys(histogramKeyed).length,
0,
`No data recorded for histogram: ${TIMING_HISTOGRAM_KEYED}.`
);
await extension1.startup();
await extension2.startup();
is(
histogram.snapshot().sum,
0,
`No data recorded for histogram after startup: ${TIMING_HISTOGRAM}.`
);
is(
Object.keys(histogramKeyed).length,
0,
`No data recorded for histogram after startup: ${TIMING_HISTOGRAM_KEYED}.`
);
clickBrowserAction(extension1);
await awaitExtensionPanel(extension1);
let sumOld = histogram.snapshot().sum;
ok(
sumOld > 0,
`Data recorded for first extension for histogram: ${TIMING_HISTOGRAM}.`
);
let oldKeyedSnapshot = histogramKeyed.snapshot();
Assert.deepEqual(
Object.keys(oldKeyedSnapshot),
[EXTENSION_ID1],
`Data recorded for first extension for histogram: ${TIMING_HISTOGRAM_KEYED}.`
);
ok(
oldKeyedSnapshot[EXTENSION_ID1].sum > 0,
`Data recorded for first extension for histogram: ${TIMING_HISTOGRAM_KEYED}.`
);
await closeBrowserAction(extension1);
clickBrowserAction(extension2);
await awaitExtensionPanel(extension2);
let sumNew = histogram.snapshot().sum;
ok(
sumNew > sumOld,
`Data recorded for second extension for histogram: ${TIMING_HISTOGRAM}.`
);
sumOld = sumNew;
let newKeyedSnapshot = histogramKeyed.snapshot();
Assert.deepEqual(
Object.keys(newKeyedSnapshot).sort(),
[EXTENSION_ID1, EXTENSION_ID2],
`Data recorded for second extension for histogram: ${TIMING_HISTOGRAM_KEYED}.`
);
ok(
newKeyedSnapshot[EXTENSION_ID2].sum > 0,
`Data recorded for second extension for histogram: ${TIMING_HISTOGRAM_KEYED}.`
);
is(
newKeyedSnapshot[EXTENSION_ID1].sum,
oldKeyedSnapshot[EXTENSION_ID1].sum,
`Data recorded for first extension should not change for histogram: ${TIMING_HISTOGRAM_KEYED}.`
);
oldKeyedSnapshot = newKeyedSnapshot;
await closeBrowserAction(extension2);
clickBrowserAction(extension2);
await awaitExtensionPanel(extension2);
sumNew = histogram.snapshot().sum;
ok(
sumNew > sumOld,
`Data recorded for second opening of popup for histogram: ${TIMING_HISTOGRAM}.`
);
sumOld = sumNew;
newKeyedSnapshot = histogramKeyed.snapshot();
ok(
newKeyedSnapshot[EXTENSION_ID2].sum > oldKeyedSnapshot[EXTENSION_ID2].sum,
`Data recorded for second opening of popup for histogram: ${TIMING_HISTOGRAM_KEYED}.`
);
is(
newKeyedSnapshot[EXTENSION_ID1].sum,
oldKeyedSnapshot[EXTENSION_ID1].sum,
`Data recorded for first extension should not change for histogram: ${TIMING_HISTOGRAM_KEYED}.`
);
oldKeyedSnapshot = newKeyedSnapshot;
await closeBrowserAction(extension2);
clickBrowserAction(extension1);
await awaitExtensionPanel(extension1);
sumNew = histogram.snapshot().sum;
ok(
sumNew > sumOld,
`Data recorded for second opening of popup for histogram: ${TIMING_HISTOGRAM}.`
);
newKeyedSnapshot = histogramKeyed.snapshot();
ok(
newKeyedSnapshot[EXTENSION_ID1].sum > oldKeyedSnapshot[EXTENSION_ID1].sum,
`Data recorded for second opening of popup for histogram: ${TIMING_HISTOGRAM_KEYED}.`
);
is(
newKeyedSnapshot[EXTENSION_ID2].sum,
oldKeyedSnapshot[EXTENSION_ID2].sum,
`Data recorded for second extension should not change for histogram: ${TIMING_HISTOGRAM_KEYED}.`
);
await closeBrowserAction(extension1);
await extension1.unload();
await extension2.unload();
});
add_task(async function testBrowserActionTelemetryResults() {
let extensionOptions = {
manifest: {
browser_specific_settings: {
gecko: { id: EXTENSION_ID1 },
},
browser_action: {
default_popup: "popup.html",
default_area: "navbar",
browser_style: true,
},
},
files: {
"popup.html": `<!DOCTYPE html><html><head><meta charset="utf-8"></head><body><div></div></body></html>`,
},
};
let extension = ExtensionTestUtils.loadExtension(extensionOptions);
let histogram = Services.telemetry.getHistogramById(RESULT_HISTOGRAM);
let histogramKeyed = Services.telemetry.getKeyedHistogramById(
RESULT_HISTOGRAM_KEYED
);
histogram.clear();
histogramKeyed.clear();
is(
histogram.snapshot().sum,
0,
`No data recorded for histogram: ${RESULT_HISTOGRAM}.`
);
is(
Object.keys(histogramKeyed).length,
0,
`No data recorded for histogram: ${RESULT_HISTOGRAM_KEYED}.`
);
await extension.startup();
// Make sure the mouse isn't hovering over the browserAction widget to start.
EventUtils.synthesizeMouseAtCenter(
gURLBar.textbox,
{ type: "mouseover" },
window
);
let widget = getBrowserActionWidget(extension).forWindow(window);
// Hover the mouse over the browserAction widget and then move it away.
EventUtils.synthesizeMouseAtCenter(
widget.node,
{ type: "mouseover", button: 0 },
window
);
EventUtils.synthesizeMouseAtCenter(
widget.node,
{ type: "mouseout", button: 0 },
window
);
EventUtils.synthesizeMouseAtCenter(
document.documentElement,
{ type: "mousemove" },
window
);
assertOnlyOneTypeSet(histogram.snapshot(), "clearAfterHover");
let keyedSnapshot = histogramKeyed.snapshot();
Assert.deepEqual(
Object.keys(keyedSnapshot),
[EXTENSION_ID1],
`Data recorded for histogram: ${RESULT_HISTOGRAM_KEYED}.`
);
assertOnlyOneTypeSet(keyedSnapshot[EXTENSION_ID1], "clearAfterHover");
histogram.clear();
histogramKeyed.clear();
// TODO: Create a test for cancel after mousedown.
// This is tricky because calling mouseout after mousedown causes a
// "Hover" event to be added to the queue in ext-browserAction.js.
clickBrowserAction(extension);
await awaitExtensionPanel(extension);
assertOnlyOneTypeSet(histogram.snapshot(), "popupShown");
keyedSnapshot = histogramKeyed.snapshot();
Assert.deepEqual(
Object.keys(keyedSnapshot),
[EXTENSION_ID1],
`Data recorded for histogram: ${RESULT_HISTOGRAM_KEYED}.`
);
assertOnlyOneTypeSet(keyedSnapshot[EXTENSION_ID1], "popupShown");
await closeBrowserAction(extension);
await extension.unload();
});
|
