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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
const { ExtensionStorageIDB } = ChromeUtils.importESModule(
"resource://gre/modules/ExtensionStorageIDB.sys.mjs"
);
const { getTrimmedString } = ChromeUtils.importESModule(
"resource://gre/modules/ExtensionTelemetry.sys.mjs"
);
const { TelemetryController } = ChromeUtils.importESModule(
"resource://gre/modules/TelemetryController.sys.mjs"
);
const { TelemetryTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/TelemetryTestUtils.sys.mjs"
);
const HISTOGRAM_JSON_IDS = [
"WEBEXT_STORAGE_LOCAL_SET_MS",
"WEBEXT_STORAGE_LOCAL_GET_MS",
];
const KEYED_HISTOGRAM_JSON_IDS = [
"WEBEXT_STORAGE_LOCAL_SET_MS_BY_ADDONID",
"WEBEXT_STORAGE_LOCAL_GET_MS_BY_ADDONID",
];
const HISTOGRAM_IDB_IDS = [
"WEBEXT_STORAGE_LOCAL_IDB_SET_MS",
"WEBEXT_STORAGE_LOCAL_IDB_GET_MS",
];
const KEYED_HISTOGRAM_IDB_IDS = [
"WEBEXT_STORAGE_LOCAL_IDB_SET_MS_BY_ADDONID",
"WEBEXT_STORAGE_LOCAL_IDB_GET_MS_BY_ADDONID",
];
const HISTOGRAM_IDS = [].concat(HISTOGRAM_JSON_IDS, HISTOGRAM_IDB_IDS);
const KEYED_HISTOGRAM_IDS = [].concat(
KEYED_HISTOGRAM_JSON_IDS,
KEYED_HISTOGRAM_IDB_IDS
);
const EXTENSION_ID1 = "@test-extension1";
const EXTENSION_ID2 = "@test-extension2";
async function test_telemetry_background() {
const expectedEmptyHistograms = ExtensionStorageIDB.isBackendEnabled
? HISTOGRAM_JSON_IDS
: HISTOGRAM_IDB_IDS;
const expectedEmptyKeyedHistograms = ExtensionStorageIDB.isBackendEnabled
? KEYED_HISTOGRAM_JSON_IDS
: KEYED_HISTOGRAM_IDB_IDS;
const expectedNonEmptyHistograms = ExtensionStorageIDB.isBackendEnabled
? HISTOGRAM_IDB_IDS
: HISTOGRAM_JSON_IDS;
const expectedNonEmptyKeyedHistograms = ExtensionStorageIDB.isBackendEnabled
? KEYED_HISTOGRAM_IDB_IDS
: KEYED_HISTOGRAM_JSON_IDS;
const server = createHttpServer();
server.registerDirectory("/data/", do_get_file("data"));
const BASE_URL = `http://localhost:${server.identity.primaryPort}/data`;
async function contentScript() {
await browser.storage.local.set({ a: "b" });
await browser.storage.local.get("a");
browser.test.sendMessage("contentDone");
}
let baseManifest = {
permissions: ["storage"],
content_scripts: [
{
matches: ["http://*/*/file_sample.html"],
js: ["content_script.js"],
},
],
};
let baseExtInfo = {
async background() {
await browser.storage.local.set({ a: "b" });
await browser.storage.local.get("a");
browser.test.sendMessage("backgroundDone");
},
files: {
"content_script.js": contentScript,
},
};
let extension1 = ExtensionTestUtils.loadExtension({
...baseExtInfo,
manifest: {
...baseManifest,
browser_specific_settings: {
gecko: { id: EXTENSION_ID1 },
},
},
});
let extension2 = ExtensionTestUtils.loadExtension({
...baseExtInfo,
manifest: {
...baseManifest,
browser_specific_settings: {
gecko: { id: EXTENSION_ID2 },
},
},
});
clearHistograms();
let process = IS_OOP ? "extension" : "parent";
let snapshots = getSnapshots(process);
let keyedSnapshots = getKeyedSnapshots(process);
for (let id of HISTOGRAM_IDS) {
ok(!(id in snapshots), `No data recorded for histogram: ${id}.`);
}
for (let id of KEYED_HISTOGRAM_IDS) {
Assert.deepEqual(
Object.keys(keyedSnapshots[id] || {}),
[],
`No data recorded for histogram: ${id}.`
);
}
await extension1.startup();
await extension1.awaitMessage("backgroundDone");
for (let id of expectedNonEmptyHistograms) {
await promiseTelemetryRecorded(id, process, 1);
}
for (let id of expectedNonEmptyKeyedHistograms) {
await promiseKeyedTelemetryRecorded(id, process, EXTENSION_ID1, 1);
}
// Telemetry from extension1's background page should be recorded.
snapshots = getSnapshots(process);
keyedSnapshots = getKeyedSnapshots(process);
for (let id of expectedNonEmptyHistograms) {
equal(
valueSum(snapshots[id].values),
1,
`Data recorded for histogram: ${id}.`
);
}
for (let id of expectedNonEmptyKeyedHistograms) {
Assert.deepEqual(
Object.keys(keyedSnapshots[id]),
[EXTENSION_ID1],
`Data recorded for histogram: ${id}.`
);
equal(
valueSum(keyedSnapshots[id][EXTENSION_ID1].values),
1,
`Data recorded for histogram: ${id}.`
);
}
await extension2.startup();
await extension2.awaitMessage("backgroundDone");
for (let id of expectedNonEmptyHistograms) {
await promiseTelemetryRecorded(id, process, 2);
}
for (let id of expectedNonEmptyKeyedHistograms) {
await promiseKeyedTelemetryRecorded(id, process, EXTENSION_ID2, 1);
}
// Telemetry from extension2's background page should be recorded.
snapshots = getSnapshots(process);
keyedSnapshots = getKeyedSnapshots(process);
for (let id of expectedNonEmptyHistograms) {
equal(
valueSum(snapshots[id].values),
2,
`Additional data recorded for histogram: ${id}.`
);
}
for (let id of expectedNonEmptyKeyedHistograms) {
Assert.deepEqual(
Object.keys(keyedSnapshots[id]).sort(),
[EXTENSION_ID1, EXTENSION_ID2],
`Additional data recorded for histogram: ${id}.`
);
equal(
valueSum(keyedSnapshots[id][EXTENSION_ID2].values),
1,
`Additional data recorded for histogram: ${id}.`
);
}
await extension2.unload();
// Run a content script.
process = IS_OOP ? "content" : "parent";
let expectedCount = IS_OOP ? 1 : 3;
let expectedKeyedCount = IS_OOP ? 1 : 2;
let contentPage = await ExtensionTestUtils.loadContentPage(
`${BASE_URL}/file_sample.html`
);
await extension1.awaitMessage("contentDone");
for (let id of expectedNonEmptyHistograms) {
await promiseTelemetryRecorded(id, process, expectedCount);
}
for (let id of expectedNonEmptyKeyedHistograms) {
await promiseKeyedTelemetryRecorded(
id,
process,
EXTENSION_ID1,
expectedKeyedCount
);
}
// Telemetry from extension1's content script should be recorded.
snapshots = getSnapshots(process);
keyedSnapshots = getKeyedSnapshots(process);
for (let id of expectedNonEmptyHistograms) {
equal(
valueSum(snapshots[id].values),
expectedCount,
`Data recorded in content script for histogram: ${id}.`
);
}
for (let id of expectedNonEmptyKeyedHistograms) {
Assert.deepEqual(
Object.keys(keyedSnapshots[id]).sort(),
IS_OOP ? [EXTENSION_ID1] : [EXTENSION_ID1, EXTENSION_ID2],
`Additional data recorded for histogram: ${id}.`
);
equal(
valueSum(keyedSnapshots[id][EXTENSION_ID1].values),
expectedKeyedCount,
`Additional data recorded for histogram: ${id}.`
);
}
await extension1.unload();
// Telemetry for histograms that we expect to be empty.
for (let id of expectedEmptyHistograms) {
ok(!(id in snapshots), `No data recorded for histogram: ${id}.`);
}
for (let id of expectedEmptyKeyedHistograms) {
Assert.deepEqual(
Object.keys(keyedSnapshots[id] || {}),
[],
`No data recorded for histogram: ${id}.`
);
}
await contentPage.close();
}
add_task(async function setup() {
// Telemetry test setup needed to ensure that the builtin events are defined
// and they can be collected and verified.
await TelemetryController.testSetup();
// This is actually only needed on Android, because it does not properly support unified telemetry
// and so, if not enabled explicitly here, it would make these tests to fail when running on a
// non-Nightly build.
const oldCanRecordBase = Services.telemetry.canRecordBase;
Services.telemetry.canRecordBase = true;
registerCleanupFunction(() => {
Services.telemetry.canRecordBase = oldCanRecordBase;
});
});
add_task(function test_telemetry_background_file_backend() {
return runWithPrefs(
[[ExtensionStorageIDB.BACKEND_ENABLED_PREF, false]],
test_telemetry_background
);
});
add_task(function test_telemetry_background_idb_backend() {
return runWithPrefs(
[
[ExtensionStorageIDB.BACKEND_ENABLED_PREF, true],
// Set the migrated preference for the two test extension, because the
// first storage.local call fallbacks to run in the parent process when we
// don't know which is the selected backend during the extension startup
// and so we can't choose the telemetry histogram to use.
[
`${ExtensionStorageIDB.IDB_MIGRATED_PREF_BRANCH}.${EXTENSION_ID1}`,
true,
],
[
`${ExtensionStorageIDB.IDB_MIGRATED_PREF_BRANCH}.${EXTENSION_ID2}`,
true,
],
],
test_telemetry_background
);
});
// This test verifies that we do record the expected telemetry event when we
// normalize the error message for an unexpected error (an error raised internally
// by the QuotaManager and/or IndexedDB, which it is being normalized into the generic
// "An unexpected error occurred" error message).
add_task(async function test_telemetry_storage_local_unexpected_error() {
// Clear any telemetry events collected so far.
Services.telemetry.clearEvents();
const methods = ["clear", "get", "remove", "set"];
const veryLongErrorName = `VeryLongErrorName${Array(200).fill(0).join("")}`;
const otherError = new Error("an error recorded as OtherError");
const recordedErrors = [
new DOMException("error message", "UnexpectedDOMException"),
new DOMException("error message", veryLongErrorName),
otherError,
];
// We expect the following errors to not be recorded in telemetry (because they
// are raised on scenarios that we already expect).
const nonRecordedErrors = [
new DOMException("error message", "QuotaExceededError"),
new DOMException("error message", "DataCloneError"),
];
const expectedEvents = [];
const errors = [].concat(recordedErrors, nonRecordedErrors);
for (let i = 0; i < errors.length; i++) {
const error = errors[i];
const storageMethod = methods[i] || "set";
ExtensionStorageIDB.normalizeStorageError({
error: errors[i],
extensionId: EXTENSION_ID1,
storageMethod,
});
if (recordedErrors.includes(error)) {
let error_name =
error === otherError ? "OtherError" : getTrimmedString(error.name);
expectedEvents.push({
value: EXTENSION_ID1,
object: storageMethod,
extra: { error_name },
});
}
}
await TelemetryTestUtils.assertEvents(expectedEvents, {
category: "extensions.data",
method: "storageLocalError",
});
});
|