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
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
|
/* eslint max-len: ["error", 80] */
const { AddonTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/AddonTestUtils.sys.mjs"
);
const { ExtensionParent } = ChromeUtils.importESModule(
"resource://gre/modules/ExtensionParent.sys.mjs"
);
AddonTestUtils.initMochitest(this);
// This test function helps to detect when an addon options browser have been
// inserted in the about:addons page.
function waitOptionsBrowserInserted() {
return new Promise(resolve => {
async function listener(eventName, browser) {
// wait for a webextension XUL browser element that is owned by the
// "about:addons" page.
if (browser.ownerGlobal.top.location.href == "about:addons") {
ExtensionParent.apiManager.off("extension-browser-inserted", listener);
resolve(browser);
}
}
ExtensionParent.apiManager.on("extension-browser-inserted", listener);
});
}
add_task(async function enableHtmlViews() {
await SpecialPowers.pushPrefEnv({
set: [["extensions.htmlaboutaddons.inline-options.enabled", true]],
});
});
add_task(async function testInlineOptions() {
const HEIGHT_SHORT = 300;
const HEIGHT_TALL = 600;
let id = "inline@mochi.test";
let extension = ExtensionTestUtils.loadExtension({
manifest: {
browser_specific_settings: { gecko: { id } },
options_ui: {
page: "options.html",
},
},
files: {
"options.html": `
<html>
<head>
<style type="text/css">
body > p { height: ${HEIGHT_SHORT}px; margin: 0; }
body.bigger > p { height: ${HEIGHT_TALL}px; }
</style>
<script src="options.js"></script>
</head>
<body>
<p>Some text</p>
</body>
</html>
`,
"options.js": () => {
browser.test.onMessage.addListener(msg => {
if (msg == "toggle-class") {
document.body.classList.toggle("bigger");
} else if (msg == "get-height") {
browser.test.sendMessage("height", document.body.clientHeight);
}
});
browser.test.sendMessage("options-loaded", window.location.href);
},
},
useAddonManager: "temporary",
});
await extension.startup();
let win = await loadInitialView("extension");
let doc = win.document;
// Make sure we found the right card.
let card = getAddonCard(win, id);
ok(card, "Found the card");
// The preferences option should be visible.
let preferences = card.querySelector('[action="preferences"]');
ok(!preferences.hidden, "The preferences option is visible");
// Open the preferences page.
let loaded = waitForViewLoad(win);
preferences.click();
await loaded;
// Verify we're on the preferences tab.
card = doc.querySelector("addon-card");
is(card.addon.id, id, "The right page was loaded");
let { deck, tabGroup } = card.details;
let { selectedViewName } = deck;
is(selectedViewName, "preferences", "The preferences tab is shown");
info("Check that there are two buttons and they're visible");
let detailsBtn = tabGroup.querySelector('[name="details"]');
ok(!detailsBtn.hidden, "The details button is visible");
let prefsBtn = tabGroup.querySelector('[name="preferences"]');
ok(!prefsBtn.hidden, "The preferences button is visible");
// Wait for the browser to load.
let url = await extension.awaitMessage("options-loaded");
// Check the attributes of the options browser.
let browser = card.querySelector("inline-options-browser browser");
ok(browser, "The visible view has a browser");
is(
browser.currentURI.spec,
card.addon.optionsURL,
"The browser has the expected options URL"
);
is(url, card.addon.optionsURL, "Browser has the expected options URL loaded");
let stack = browser.closest("stack");
is(
browser.clientWidth,
stack.clientWidth,
"Browser should be the same width as its direct parent"
);
ok(stack.clientWidth > 0, "The stack has a width");
ok(
card.querySelector('[action="preferences"]').hidden,
"The preferences option is hidden now"
);
let waitForHeightChange = expectedHeight =>
TestUtils.waitForCondition(() => browser.clientHeight === expectedHeight);
await waitForHeightChange(HEIGHT_SHORT);
// Check resizing the browser through extension CSS.
await extension.sendMessage("get-height");
let height = await extension.awaitMessage("height");
is(height, HEIGHT_SHORT, "The height is smaller to start");
is(height, browser.clientHeight, "The browser is the same size");
info("Resize the browser to be taller");
await extension.sendMessage("toggle-class");
await waitForHeightChange(HEIGHT_TALL);
await extension.sendMessage("get-height");
height = await extension.awaitMessage("height");
is(height, HEIGHT_TALL, "The height is bigger now");
is(height, browser.clientHeight, "The browser is the same size");
info("Shrink the browser again");
await extension.sendMessage("toggle-class");
await waitForHeightChange(HEIGHT_SHORT);
await extension.sendMessage("get-height");
height = await extension.awaitMessage("height");
is(height, HEIGHT_SHORT, "The browser shrunk back");
is(height, browser.clientHeight, "The browser is the same size");
info("Switching to details view");
detailsBtn.click();
info("Check the browser dimensions to make sure it's hidden");
is(browser.clientWidth, 0, "The browser is hidden now");
info("Switch back, check browser is shown");
prefsBtn.click();
is(browser.clientWidth, stack.clientWidth, "The browser width is set again");
ok(stack.clientWidth > 0, "The stack has a width");
await closeView(win);
await extension.unload();
});
// Regression test against bug 1409697
add_task(async function testCardRerender() {
let id = "rerender@mochi.test";
let extension = ExtensionTestUtils.loadExtension({
manifest: {
browser_specific_settings: { gecko: { id } },
options_ui: {
page: "options.html",
},
},
files: {
"options.html": `
<html>
<body>
<p>Some text</p>
</body>
</html>
`,
},
useAddonManager: "permanent",
});
await extension.startup();
let win = await loadInitialView("extension");
let doc = win.document;
let card = getAddonCard(win, id);
let loaded = waitForViewLoad(win);
card.querySelector('[action="expand"]').click();
await loaded;
card = doc.querySelector("addon-card");
let browserAdded = waitOptionsBrowserInserted();
card.querySelector('.tab-button[name="preferences"]').click();
await browserAdded;
is(
doc.querySelectorAll("inline-options-browser").length,
1,
"There is 1 inline-options-browser"
);
is(doc.querySelectorAll("browser").length, 1, "There is 1 browser");
info("Reload the add-on and ensure there's still only one browser");
let updated = BrowserTestUtils.waitForEvent(card, "update");
card.addon.reload();
await updated;
// Since the add-on was disabled, we'll be on the details tab.
is(card.details.deck.selectedViewName, "details", "View changed to details");
is(
doc.querySelectorAll("inline-options-browser").length,
1,
"There is 1 inline-options-browser"
);
is(doc.querySelectorAll("browser").length, 0, "The browser was destroyed");
// Load the permissions tab again.
browserAdded = waitOptionsBrowserInserted();
card.querySelector('.tab-button[name="preferences"]').click();
await browserAdded;
// Switching to preferences will create a new browser element.
is(
card.details.deck.selectedViewName,
"preferences",
"View switched to preferences"
);
is(
doc.querySelectorAll("inline-options-browser").length,
1,
"There is 1 inline-options-browser"
);
is(doc.querySelectorAll("browser").length, 1, "There is a new browser");
info("Re-rendering card to ensure a second browser isn't added");
updated = BrowserTestUtils.waitForEvent(card, "update");
card.render();
await updated;
is(
card.details.deck.selectedViewName,
"details",
"Rendering reverted to the details view"
);
is(
doc.querySelectorAll("inline-options-browser").length,
1,
"There is still only 1 inline-options-browser after re-render"
);
is(doc.querySelectorAll("browser").length, 0, "There is no browser");
let newBrowserAdded = waitOptionsBrowserInserted();
card.showPrefs();
await newBrowserAdded;
is(
doc.querySelectorAll("inline-options-browser").length,
1,
"There is still only 1 inline-options-browser after opening preferences"
);
is(doc.querySelectorAll("browser").length, 1, "There is 1 browser");
await closeView(win);
await extension.unload();
});
add_task(async function testRemovedOnDisable() {
let id = "disable@mochi.test";
const xpiFile = AddonTestUtils.createTempWebExtensionFile({
manifest: {
browser_specific_settings: { gecko: { id } },
options_ui: {
page: "options.html",
},
},
files: {
"options.html": "<h1>Options!</h1>",
},
});
let addon = await AddonManager.installTemporaryAddon(xpiFile);
let win = await loadInitialView("extension");
let doc = win.document;
// Opens the prefs page.
let loaded = waitForViewLoad(win);
getAddonCard(win, id).querySelector("[action=preferences]").click();
await loaded;
let inlineOptions = doc.querySelector("inline-options-browser");
ok(inlineOptions, "There's an inline-options-browser element");
ok(inlineOptions.querySelector("browser"), "The browser exists");
let card = getAddonCard(win, id);
let { deck } = card.details;
is(deck.selectedViewName, "preferences", "Preferences are the active tab");
info("Disabling the add-on");
let updated = BrowserTestUtils.waitForEvent(card, "update");
await addon.disable();
await updated;
is(deck.selectedViewName, "details", "Details are now the active tab");
ok(inlineOptions, "There's an inline-options-browser element");
ok(!inlineOptions.querySelector("browser"), "The browser has been removed");
info("Enabling the add-on");
updated = BrowserTestUtils.waitForEvent(card, "update");
await addon.enable();
await updated;
is(deck.selectedViewName, "details", "Details are still the active tab");
ok(inlineOptions, "There's an inline-options-browser element");
ok(!inlineOptions.querySelector("browser"), "The browser is not created yet");
info("Switching to preferences tab");
let changed = BrowserTestUtils.waitForEvent(deck, "view-changed");
let browserAdded = waitOptionsBrowserInserted();
deck.selectedViewName = "preferences";
await changed;
await browserAdded;
is(deck.selectedViewName, "preferences", "Preferences are selected");
ok(inlineOptions, "There's an inline-options-browser element");
ok(inlineOptions.querySelector("browser"), "The browser is re-created");
await closeView(win);
await addon.uninstall();
});
add_task(async function testUpgradeTemporary() {
let id = "upgrade-temporary@mochi.test";
async function loadExtension(version) {
let extension = ExtensionTestUtils.loadExtension({
manifest: {
browser_specific_settings: { gecko: { id } },
version,
options_ui: {
page: "options.html",
},
},
files: {
"options.html": `
<html>
<head>
<script src="options.js"></script>
</head>
<body>
<p>Version <pre>${version}</pre></p>
</body>
</html>
`,
"options.js": () => {
browser.test.onMessage.addListener(msg => {
if (msg === "get-version") {
let version = document.querySelector("pre").textContent;
browser.test.sendMessage("version", version);
}
});
window.onload = () => browser.test.sendMessage("options-loaded");
},
},
useAddonManager: "temporary",
});
await extension.startup();
return extension;
}
let firstExtension = await loadExtension("1");
let win = await loadInitialView("extension");
let doc = win.document;
let card = getAddonCard(win, id);
let loaded = waitForViewLoad(win);
card.querySelector('[action="expand"]').click();
await loaded;
card = doc.querySelector("addon-card");
let browserAdded = waitOptionsBrowserInserted();
card.querySelector('.tab-button[name="preferences"]').click();
await browserAdded;
await firstExtension.awaitMessage("options-loaded");
await firstExtension.sendMessage("get-version");
let version = await firstExtension.awaitMessage("version");
is(version, "1", "Version 1 page is loaded");
let updated = BrowserTestUtils.waitForEvent(card, "update");
browserAdded = waitOptionsBrowserInserted();
let secondExtension = await loadExtension("2");
await updated;
await browserAdded;
await secondExtension.awaitMessage("options-loaded");
await secondExtension.sendMessage("get-version");
version = await secondExtension.awaitMessage("version");
is(version, "2", "Version 2 page is loaded");
let { deck } = card.details;
is(deck.selectedViewName, "preferences", "Preferences are still shown");
await closeView(win);
await firstExtension.unload();
await secondExtension.unload();
});
add_task(async function testReloadExtension() {
let id = "reload@mochi.test";
let xpiFile = AddonTestUtils.createTempWebExtensionFile({
manifest: {
browser_specific_settings: { gecko: { id } },
options_ui: {
page: "options.html",
},
},
files: {
"options.html": `
<html>
<head>
</head>
<body>
<p>Options</p>
</body>
</html>
`,
},
});
let addon = await AddonManager.installTemporaryAddon(xpiFile);
let win = await loadInitialView("extension");
let doc = win.document;
let card = getAddonCard(win, id);
let loaded = waitForViewLoad(win);
card.querySelector('[action="expand"]').click();
await loaded;
card = doc.querySelector("addon-card");
let { deck } = card.details;
is(deck.selectedViewName, "details", "Details load first");
let browserAdded = waitOptionsBrowserInserted();
card.querySelector('.tab-button[name="preferences"]').click();
await browserAdded;
is(deck.selectedViewName, "preferences", "Preferences are shown");
let updated = BrowserTestUtils.waitForEvent(card, "update");
browserAdded = waitOptionsBrowserInserted();
let addonStarted = AddonTestUtils.promiseWebExtensionStartup(id);
await addon.reload();
await addonStarted;
await updated;
await browserAdded;
is(deck.selectedViewName, "preferences", "Preferences are still shown");
await closeView(win);
await addon.uninstall();
});
async function testSelectPosition(optionsBrowser, zoom) {
let popupShownPromise = BrowserTestUtils.waitForSelectPopupShown(window);
await BrowserTestUtils.synthesizeMouseAtCenter("select", {}, optionsBrowser);
let popup = await popupShownPromise;
let popupLeft = popup.shadowRoot.querySelector(
".menupopup-arrowscrollbox"
).screenX;
let browserLeft = optionsBrowser.screenX * zoom;
ok(
Math.abs(popupLeft - browserLeft) <= 1,
`Popup should be correctly positioned: ${popupLeft} vs. ${browserLeft}`
);
popup.hidePopup();
}
async function testOptionsZoom(type = "full") {
let id = `${type}-zoom@mochi.test`;
let zoomProp = `${type}Zoom`;
let extension = ExtensionTestUtils.loadExtension({
manifest: {
browser_specific_settings: { gecko: { id } },
options_ui: {
page: "options.html",
},
},
files: {
"options.html": `
<!doctype html>
<script src="options.js"></script>
<body style="height: 500px">
<p>Some text</p>
<p>
<select>
<option>A</option>
<option>B</option>
</select>
</p>
</body>
`,
"options.js": () => {
window.addEventListener("load", function () {
browser.test.sendMessage("options-loaded");
});
},
},
useAddonManager: "permanent",
});
await extension.startup();
let win = await loadInitialView("extension");
let doc = win.document;
gBrowser.selectedBrowser[zoomProp] = 2;
let card = getAddonCard(win, id);
let loaded = waitForViewLoad(win);
card.querySelector('[action="expand"]').click();
await loaded;
card = doc.querySelector("addon-card");
let browserAdded = waitOptionsBrowserInserted();
card.querySelector('.tab-button[name="preferences"]').click();
let optionsBrowser = await browserAdded;
// Wait for the browser to load.
await extension.awaitMessage("options-loaded");
is(optionsBrowser[zoomProp], 2, `Options browser inherited ${zoomProp}`);
await testSelectPosition(optionsBrowser, type == "full" ? 2 : 1);
gBrowser.selectedBrowser[zoomProp] = 0.5;
is(
optionsBrowser[zoomProp],
0.5,
`Options browser reacts to ${zoomProp} change`
);
await closeView(win);
await extension.unload();
}
add_task(function testOptionsFullZoom() {
return testOptionsZoom("full");
});
add_task(function testOptionsTextZoom() {
return testOptionsZoom("text");
});
add_task(async function testInputAndQuickFind() {
let extension = ExtensionTestUtils.loadExtension({
manifest: {
options_ui: {
page: "options.html",
},
},
files: {
"options.html": `
<html>
<body>
<input name="some-input" type="text">
<script src="options.js"></script>
</body>
</html>
`,
"options.js": () => {
let input = document.querySelector("input");
browser.test.assertEq(
"some-input",
input.getAttribute("name"),
"Expected options page input"
);
input.addEventListener("input", event => {
browser.test.sendMessage("input-changed", event.target.value);
});
browser.test.sendMessage("options-loaded", window.location.href);
},
},
useAddonManager: "temporary",
});
await extension.startup();
let win = await loadInitialView("extension");
let doc = win.document;
// Make sure we found the right card.
let card = getAddonCard(win, extension.id);
ok(card, "Found the card");
// The preferences option should be visible.
let preferences = card.querySelector('[action="preferences"]');
ok(!preferences.hidden, "The preferences option is visible");
// Open the preferences page.
let loaded = waitForViewLoad(win);
preferences.click();
await loaded;
// Verify we're on the preferences tab.
card = doc.querySelector("addon-card");
is(card.addon.id, extension.id, "The right page was loaded");
// Wait for the browser to load.
let url = await extension.awaitMessage("options-loaded");
// Check the attributes of the options browser.
let browser = card.querySelector("inline-options-browser browser");
ok(browser, "The visible view has a browser");
ok(card.addon.optionsURL.length, "Options URL is not empty");
is(
browser.currentURI.spec,
card.addon.optionsURL,
"The browser has the expected options URL"
);
is(url, card.addon.optionsURL, "Browser has the expected options URL loaded");
// Focus the options browser.
browser.focus();
// Focus the input in the options page.
await SpecialPowers.spawn(browser, [], () => {
content.document.querySelector("input").focus();
});
info("input in options page should be focused, typing...");
// Type '/'.
EventUtils.synthesizeKey("/");
let inputValue = await extension.awaitMessage("input-changed");
is(inputValue, "/", "Expected input to contain a slash");
await closeView(win);
await extension.unload();
});
|
