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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
loadTestSubscript("head_devtools.js");
/**
* Helper that returns the id of the last additional/extension tool for a provided
* toolbox.
*
* @param {object} toolbox
* The DevTools toolbox object.
* @param {string} label
* The expected label for the additional tool.
* @returns {string} the id of the last additional panel.
*/
function getAdditionalPanelId(toolbox, label) {
// Copy the tools array and pop the last element from it.
const panelDef = toolbox.getAdditionalTools().slice().pop();
is(panelDef.label, label, "Additional panel label is the expected label");
return panelDef.id;
}
/**
* Helper that returns the number of existing target actors for the content browserId
*
* @param {Tab} tab
* @returns {Integer} the number of targets
*/
function getTargetActorsCount(tab) {
return SpecialPowers.spawn(tab.linkedBrowser, [], () => {
const { TargetActorRegistry } = ChromeUtils.importESModule(
"resource://devtools/server/actors/targets/target-actor-registry.sys.mjs"
);
// Retrieve the target actor instances
return TargetActorRegistry.getTargetActorsCountForBrowserElement(
content.browsingContext.browserId
);
});
}
/**
* this test file ensures that:
*
* - the devtools page gets only a subset of the runtime API namespace.
* - devtools.inspectedWindow.tabId is the same tabId that we can retrieve
* in the background page using the tabs API namespace.
* - devtools API is available in the devtools page sub-frames when a valid
* extension URL has been loaded.
* - devtools.inspectedWindow.eval:
* - returns a serialized version of the evaluation result.
* - returns the expected error object when the return value serialization raises a
* "TypeError: cyclic object value" exception.
* - returns the expected exception when an exception has been raised from the evaluated
* javascript code.
*/
add_task(async function test_devtools_inspectedWindow_tabId() {
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
"http://mochi.test:8888/"
);
async function background() {
browser.test.assertEq(
undefined,
browser.devtools,
"No devtools APIs should be available in the background page"
);
const tabs = await browser.tabs.query({
active: true,
lastFocusedWindow: true,
});
browser.test.sendMessage("current-tab-id", tabs[0].id);
}
function devtools_page() {
browser.test.assertEq(
undefined,
browser.runtime.getBackgroundPage,
"The `runtime.getBackgroundPage` API method should be missing in a devtools_page context"
);
try {
let tabId = browser.devtools.inspectedWindow.tabId;
browser.test.sendMessage("inspectedWindow-tab-id", tabId);
} catch (err) {
browser.test.sendMessage("inspectedWindow-tab-id", undefined);
throw err;
}
}
function devtools_page_iframe() {
try {
let tabId = browser.devtools.inspectedWindow.tabId;
browser.test.sendMessage(
"devtools_page_iframe.inspectedWindow-tab-id",
tabId
);
} catch (err) {
browser.test.fail(`Error: ${err} :: ${err.stack}`);
browser.test.sendMessage(
"devtools_page_iframe.inspectedWindow-tab-id",
undefined
);
}
}
let extension = ExtensionTestUtils.loadExtension({
background,
manifest: {
devtools_page: "devtools_page.html",
},
files: {
"devtools_page.html": `<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body>
<iframe src="/devtools_page_iframe.html"></iframe>
<script src="devtools_page.js"></script>
</body>
</html>`,
"devtools_page.js": devtools_page,
"devtools_page_iframe.html": `<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body>
<script src="devtools_page_iframe.js"></script>
</body>
</html>`,
"devtools_page_iframe.js": devtools_page_iframe,
},
});
await extension.startup();
let backgroundPageCurrentTabId = await extension.awaitMessage(
"current-tab-id"
);
await openToolboxForTab(tab);
let devtoolsInspectedWindowTabId = await extension.awaitMessage(
"inspectedWindow-tab-id"
);
is(
devtoolsInspectedWindowTabId,
backgroundPageCurrentTabId,
"Got the expected tabId from devtool.inspectedWindow.tabId"
);
let devtoolsPageIframeTabId = await extension.awaitMessage(
"devtools_page_iframe.inspectedWindow-tab-id"
);
is(
devtoolsPageIframeTabId,
backgroundPageCurrentTabId,
"Got the expected tabId from devtool.inspectedWindow.tabId called in a devtool_page iframe"
);
await closeToolboxForTab(tab);
await extension.unload();
BrowserTestUtils.removeTab(tab);
});
add_task(async function test_devtools_inspectedWindow_eval() {
const TEST_TARGET_URL = "http://mochi.test:8888/";
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
TEST_TARGET_URL
);
function devtools_page() {
browser.test.onMessage.addListener(async (msg, ...args) => {
if (msg !== "inspectedWindow-eval-request") {
browser.test.fail(`Unexpected test message received: ${msg}`);
return;
}
try {
const [evalResult, errorResult] =
await browser.devtools.inspectedWindow.eval(...args);
browser.test.sendMessage("inspectedWindow-eval-result", {
evalResult,
errorResult,
});
} catch (err) {
browser.test.sendMessage("inspectedWindow-eval-result");
browser.test.fail(`Error: ${err} :: ${err.stack}`);
}
});
browser.test.sendMessage("devtools-page-loaded");
}
let extension = ExtensionTestUtils.loadExtension({
manifest: {
devtools_page: "devtools_page.html",
},
files: {
"devtools_page.html": `<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<script text="text/javascript" src="devtools_page.js"></script>
</head>
<body>
</body>
</html>`,
"devtools_page.js": devtools_page,
},
});
await extension.startup();
await openToolboxForTab(tab);
info("Wait the devtools page load");
await extension.awaitMessage("devtools-page-loaded");
const evalTestCases = [
// Successful evaluation results.
{
args: ["window.location.href"],
expectedResults: { evalResult: TEST_TARGET_URL, errorResult: undefined },
},
// Error evaluation results.
{
args: ["window"],
expectedResults: {
evalResult: undefined,
errorResult: {
isError: true,
code: "E_PROTOCOLERROR",
description: "Inspector protocol error: %s",
details: ["TypeError: cyclic object value"],
},
},
},
// Exception evaluation results.
{
args: ["throw new Error('fake eval exception');"],
expectedResults: {
evalResult: undefined,
errorResult: {
isException: true,
value: /Error: fake eval exception\n.*moz-extension:\/\//,
},
},
},
];
for (let testCase of evalTestCases) {
info(`test inspectedWindow.eval with ${JSON.stringify(testCase)}`);
const { args, expectedResults } = testCase;
extension.sendMessage(`inspectedWindow-eval-request`, ...args);
const { evalResult, errorResult } = await extension.awaitMessage(
`inspectedWindow-eval-result`
);
Assert.deepEqual(
evalResult,
expectedResults.evalResult,
"Got the expected eval result"
);
if (errorResult) {
for (const errorPropName of Object.keys(expectedResults.errorResult)) {
const expected = expectedResults.errorResult[errorPropName];
const actual = errorResult[errorPropName];
if (expected instanceof RegExp) {
ok(
expected.test(actual),
`Got exceptionInfo.${errorPropName} value ${actual} matches ${expected}`
);
} else {
Assert.deepEqual(
actual,
expected,
`Got the expected exceptionInfo.${errorPropName} value`
);
}
}
}
}
await closeToolboxForTab(tab);
await extension.unload();
BrowserTestUtils.removeTab(tab);
});
/**
* This test asserts that both the page and the panel can use devtools.inspectedWindow.
* See regression in Bug https://bugzilla.mozilla.org/show_bug.cgi?id=1392531
*/
add_task(async function test_devtools_inspectedWindow_eval_in_page_and_panel() {
const TEST_TARGET_URL = "http://mochi.test:8888/";
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
TEST_TARGET_URL
);
async function devtools_page() {
await browser.devtools.panels.create(
"test-eval",
"fake-icon.png",
"devtools_panel.html"
);
browser.test.onMessage.addListener(async (msg, ...args) => {
switch (msg) {
case "inspectedWindow-page-eval-request": {
const [evalResult, errorResult] =
await browser.devtools.inspectedWindow.eval(...args);
browser.test.sendMessage("inspectedWindow-page-eval-result", {
evalResult,
errorResult,
});
break;
}
case "inspectedWindow-panel-eval-request":
// Ignore the test message expected by the devtools panel.
break;
default:
browser.test.fail(`Unexpected test message received: ${msg}`);
}
});
browser.test.sendMessage("devtools_panel_created");
}
function devtools_panel() {
browser.test.onMessage.addListener(async (msg, ...args) => {
switch (msg) {
case "inspectedWindow-panel-eval-request": {
const [evalResult, errorResult] =
await browser.devtools.inspectedWindow.eval(...args);
browser.test.sendMessage("inspectedWindow-panel-eval-result", {
evalResult,
errorResult,
});
break;
}
case "inspectedWindow-page-eval-request":
// Ignore the test message expected by the devtools page.
break;
default:
browser.test.fail(`Unexpected test message received: ${msg}`);
}
});
browser.test.sendMessage("devtools_panel_initialized");
}
let extension = ExtensionTestUtils.loadExtension({
manifest: {
devtools_page: "devtools_page.html",
},
files: {
"devtools_page.html": `<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<script text="text/javascript" src="devtools_page.js"></script>
</head>
<body>
</body>
</html>`,
"devtools_page.js": devtools_page,
"devtools_panel.html": `<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body>
DEVTOOLS PANEL
<script src="devtools_panel.js"></script>
</body>
</html>`,
"devtools_panel.js": devtools_panel,
},
});
await extension.startup();
const toolbox = await openToolboxForTab(tab);
info("Wait for devtools_panel_created event");
await extension.awaitMessage("devtools_panel_created");
info("Switch to the extension test panel");
await openToolboxForTab(tab, getAdditionalPanelId(toolbox, "test-eval"));
info("Wait for devtools_panel_initialized event");
await extension.awaitMessage("devtools_panel_initialized");
info(
`test inspectedWindow.eval with eval(window.location.href) from the devtools page`
);
extension.sendMessage(
`inspectedWindow-page-eval-request`,
"window.location.href"
);
info("Wait for response from the page");
let { evalResult } = await extension.awaitMessage(
`inspectedWindow-page-eval-result`
);
Assert.deepEqual(
evalResult,
TEST_TARGET_URL,
"Got the expected eval result in the page"
);
info(
`test inspectedWindow.eval with eval(window.location.href) from the devtools panel`
);
extension.sendMessage(
`inspectedWindow-panel-eval-request`,
"window.location.href"
);
info("Wait for response from the panel");
({ evalResult } = await extension.awaitMessage(
`inspectedWindow-panel-eval-result`
));
Assert.deepEqual(
evalResult,
TEST_TARGET_URL,
"Got the expected eval result in the panel"
);
// Cleanup
await closeToolboxForTab(tab);
await extension.unload();
BrowserTestUtils.removeTab(tab);
});
/**
* This test asserts that there's only one target created by the extension, and that
* closing the DevTools toolbox destroys it.
* See Bug 1652016
*/
add_task(async function test_devtools_inspectedWindow_eval_target_lifecycle() {
const TEST_TARGET_URL = "http://mochi.test:8888/";
let tab = await BrowserTestUtils.openNewForegroundTab(
gBrowser,
TEST_TARGET_URL
);
function devtools_page() {
browser.test.onMessage.addListener(async (msg, ...args) => {
if (msg !== "inspectedWindow-eval-requests") {
browser.test.fail(`Unexpected test message received: ${msg}`);
return;
}
const promises = [];
for (let i = 0; i < 10; i++) {
promises.push(browser.devtools.inspectedWindow.eval(`${i * 2}`));
}
await Promise.all(promises);
browser.test.sendMessage("inspectedWindow-eval-requests-done");
});
browser.test.sendMessage("devtools-page-loaded");
}
let extension = ExtensionTestUtils.loadExtension({
manifest: {
devtools_page: "devtools_page.html",
},
files: {
"devtools_page.html": `<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<script text="text/javascript" src="devtools_page.js"></script>
</head>
<body>
</body>
</html>`,
"devtools_page.js": devtools_page,
},
});
await extension.startup();
await openToolboxForTab(tab);
await extension.awaitMessage("devtools-page-loaded");
let targetsCount = await getTargetActorsCount(tab);
is(
targetsCount,
1,
"There's only one target for the content page, the one for DevTools Toolbox"
);
info("Check that evaluating multiple times doesn't create multiple targets");
const onEvalRequestsDone = extension.awaitMessage(
`inspectedWindow-eval-requests-done`
);
extension.sendMessage(`inspectedWindow-eval-requests`);
info("Wait for response from the panel");
await onEvalRequestsDone;
targetsCount = await getTargetActorsCount(tab);
is(
targetsCount,
2,
"Only 1 additional target was created when calling inspectedWindow.eval"
);
info(
"Close the toolbox and make sure the extension gets unloaded, and the target destroyed"
);
await closeToolboxForTab(tab);
targetsCount = await getTargetActorsCount(tab);
is(targetsCount, 0, "All targets were removed as toolbox was closed");
await extension.unload();
BrowserTestUtils.removeTab(tab);
});
|
