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
|
var gListener = null;
const kURL =
"data:text/html;charset=utf-8,Caret browsing is fun.<input id='in'>";
const kPrefShortcutEnabled = "accessibility.browsewithcaret_shortcut.enabled";
const kPrefWarnOnEnable = "accessibility.warn_on_browsewithcaret";
const kPrefCaretBrowsingOn = "accessibility.browsewithcaret";
var oldPrefs = {};
for (let pref of [
kPrefShortcutEnabled,
kPrefWarnOnEnable,
kPrefCaretBrowsingOn,
]) {
oldPrefs[pref] = Services.prefs.getBoolPref(pref);
}
Services.prefs.setBoolPref(kPrefShortcutEnabled, true);
Services.prefs.setBoolPref(kPrefWarnOnEnable, true);
Services.prefs.setBoolPref(kPrefCaretBrowsingOn, false);
registerCleanupFunction(function () {
for (let pref of [
kPrefShortcutEnabled,
kPrefWarnOnEnable,
kPrefCaretBrowsingOn,
]) {
Services.prefs.setBoolPref(pref, oldPrefs[pref]);
}
});
// NB: not using BrowserTestUtils.promiseAlertDialog here because there's no way to
// undo waiting for a dialog. If we don't want the window to be opened, and
// wait for it to verify that it indeed does not open, we need to be able to
// then "stop" waiting so that when we next *do* want it to open, our "old"
// listener doesn't fire and do things we don't want (like close the window...).
let gCaretPromptOpeningObserver;
function promiseCaretPromptOpened() {
return new Promise(resolve => {
function observer(subject) {
info("Dialog opened.");
resolve(subject);
gCaretPromptOpeningObserver();
}
Services.obs.addObserver(observer, "common-dialog-loaded");
gCaretPromptOpeningObserver = () => {
Services.obs.removeObserver(observer, "common-dialog-loaded");
gCaretPromptOpeningObserver = () => {};
};
});
}
function hitF7() {
SimpleTest.executeSoon(() => EventUtils.synthesizeKey("KEY_F7"));
}
async function toggleCaretNoDialog(expected) {
let openedDialog = false;
promiseCaretPromptOpened().then(function (win) {
openedDialog = true;
win.close(); // This will eventually return focus here and allow the test to continue...
});
// Cause the dialog to appear synchronously when focused element is in chrome,
// otherwise, i.e., when focused element is in remote content, it appears
// asynchronously.
const focusedElementInChrome = Services.focus.focusedElement;
const isAsync = focusedElementInChrome?.isRemoteBrowser;
const waitForF7KeyHandled = new Promise(resolve => {
let eventCount = 0;
const expectedEventCount = isAsync ? 2 : 1;
let listener = async event => {
if (event.key == "F7") {
info("F7 keypress is fired");
if (++eventCount == expectedEventCount) {
window.removeEventListener("keypress", listener, {
capture: true,
mozSystemGroup: true,
});
// Wait for the event handled in chrome.
await TestUtils.waitForTick();
resolve();
return;
}
info(
"Waiting for next F7 keypress which is a reply event from the remote content"
);
}
};
info(
`Synthesizing "F7" key press and wait ${expectedEventCount} keypress events...`
);
window.addEventListener("keypress", listener, {
capture: true,
mozSystemGroup: true,
});
});
hitF7();
await waitForF7KeyHandled;
let expectedStr = expected ? "on." : "off.";
ok(
!openedDialog,
"Shouldn't open a dialog to turn caret browsing " + expectedStr
);
// Need to clean up if the dialog wasn't opened, so the observer doesn't get
// re-triggered later on causing "issues".
if (!openedDialog) {
gCaretPromptOpeningObserver();
}
let prefVal = Services.prefs.getBoolPref(kPrefCaretBrowsingOn);
is(prefVal, expected, "Caret browsing should now be " + expectedStr);
}
function waitForFocusOnInput(browser) {
return SpecialPowers.spawn(browser, [], async function () {
let textEl = content.document.getElementById("in");
return ContentTaskUtils.waitForCondition(() => {
return content.document.activeElement == textEl;
}, "Input should get focused.");
});
}
function focusInput(browser) {
return SpecialPowers.spawn(browser, [], async function () {
let textEl = content.document.getElementById("in");
textEl.focus();
});
}
add_task(async function checkTogglingCaretBrowsing() {
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser, kURL);
await focusInput(tab.linkedBrowser);
let promiseGotKey = promiseCaretPromptOpened();
hitF7();
let prompt = await promiseGotKey;
let doc = prompt.document;
let dialog = doc.getElementById("commonDialog");
is(dialog.defaultButton, "cancel", "No button should be the default");
ok(
!doc.getElementById("checkbox").checked,
"Checkbox shouldn't be checked by default."
);
let promiseDialogUnloaded = BrowserTestUtils.waitForEvent(prompt, "unload");
dialog.cancelDialog();
await promiseDialogUnloaded;
info("Dialog unloaded");
await waitForFocusOnInput(tab.linkedBrowser);
ok(
!Services.prefs.getBoolPref(kPrefCaretBrowsingOn),
"Caret browsing should still be off after cancelling the dialog."
);
promiseGotKey = promiseCaretPromptOpened();
hitF7();
prompt = await promiseGotKey;
doc = prompt.document;
dialog = doc.getElementById("commonDialog");
is(dialog.defaultButton, "cancel", "No button should be the default");
ok(
!doc.getElementById("checkbox").checked,
"Checkbox shouldn't be checked by default."
);
promiseDialogUnloaded = BrowserTestUtils.waitForEvent(prompt, "unload");
dialog.acceptDialog();
await promiseDialogUnloaded;
info("Dialog unloaded");
await waitForFocusOnInput(tab.linkedBrowser);
ok(
Services.prefs.getBoolPref(kPrefCaretBrowsingOn),
"Caret browsing should be on after accepting the dialog."
);
await toggleCaretNoDialog(false);
promiseGotKey = promiseCaretPromptOpened();
hitF7();
prompt = await promiseGotKey;
doc = prompt.document;
dialog = doc.getElementById("commonDialog");
is(dialog.defaultButton, "cancel", "No button should be the default");
ok(
!doc.getElementById("checkbox").checked,
"Checkbox shouldn't be checked by default."
);
promiseDialogUnloaded = BrowserTestUtils.waitForEvent(prompt, "unload");
dialog.cancelDialog();
await promiseDialogUnloaded;
info("Dialog unloaded");
await waitForFocusOnInput(tab.linkedBrowser);
ok(
!Services.prefs.getBoolPref(kPrefCaretBrowsingOn),
"Caret browsing should still be off after cancelling the dialog."
);
Services.prefs.setBoolPref(kPrefShortcutEnabled, true);
Services.prefs.setBoolPref(kPrefWarnOnEnable, true);
Services.prefs.setBoolPref(kPrefCaretBrowsingOn, false);
BrowserTestUtils.removeTab(tab);
});
add_task(async function toggleCheckboxNoCaretBrowsing() {
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser, kURL);
await focusInput(tab.linkedBrowser);
let promiseGotKey = promiseCaretPromptOpened();
hitF7();
let prompt = await promiseGotKey;
let doc = prompt.document;
let dialog = doc.getElementById("commonDialog");
is(dialog.defaultButton, "cancel", "No button should be the default");
let checkbox = doc.getElementById("checkbox");
ok(!checkbox.checked, "Checkbox shouldn't be checked by default.");
// Check the box:
checkbox.click();
let promiseDialogUnloaded = BrowserTestUtils.waitForEvent(prompt, "unload");
// Say no:
dialog.getButton("cancel").click();
await promiseDialogUnloaded;
info("Dialog unloaded");
await waitForFocusOnInput(tab.linkedBrowser);
ok(
!Services.prefs.getBoolPref(kPrefCaretBrowsingOn),
"Caret browsing should still be off."
);
ok(
!Services.prefs.getBoolPref(kPrefShortcutEnabled),
"Shortcut should now be disabled."
);
await toggleCaretNoDialog(false);
ok(
!Services.prefs.getBoolPref(kPrefShortcutEnabled),
"Shortcut should still be disabled."
);
Services.prefs.setBoolPref(kPrefShortcutEnabled, true);
Services.prefs.setBoolPref(kPrefWarnOnEnable, true);
Services.prefs.setBoolPref(kPrefCaretBrowsingOn, false);
BrowserTestUtils.removeTab(tab);
});
add_task(async function toggleCheckboxWantCaretBrowsing() {
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser, kURL);
await focusInput(tab.linkedBrowser);
let promiseGotKey = promiseCaretPromptOpened();
hitF7();
let prompt = await promiseGotKey;
let doc = prompt.document;
let dialog = doc.getElementById("commonDialog");
is(dialog.defaultButton, "cancel", "No button should be the default");
let checkbox = doc.getElementById("checkbox");
ok(!checkbox.checked, "Checkbox shouldn't be checked by default.");
// Check the box:
checkbox.click();
let promiseDialogUnloaded = BrowserTestUtils.waitForEvent(prompt, "unload");
// Say yes:
dialog.acceptDialog();
await promiseDialogUnloaded;
info("Dialog unloaded");
await waitForFocusOnInput(tab.linkedBrowser);
ok(
Services.prefs.getBoolPref(kPrefCaretBrowsingOn),
"Caret browsing should now be on."
);
ok(
Services.prefs.getBoolPref(kPrefShortcutEnabled),
"Shortcut should still be enabled."
);
ok(
!Services.prefs.getBoolPref(kPrefWarnOnEnable),
"Should no longer warn when enabling."
);
await toggleCaretNoDialog(false);
await toggleCaretNoDialog(true);
await toggleCaretNoDialog(false);
Services.prefs.setBoolPref(kPrefShortcutEnabled, true);
Services.prefs.setBoolPref(kPrefWarnOnEnable, true);
Services.prefs.setBoolPref(kPrefCaretBrowsingOn, false);
BrowserTestUtils.removeTab(tab);
});
// Test for bug 1743878: Many repeated modal caret-browsing dialogs, if you
// accidentally hold down F7 for a few seconds
add_task(async function testF7SpamDoesNotOpenDialogs() {
let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser);
registerCleanupFunction(() => BrowserTestUtils.removeTab(tab));
let promiseGotKey = promiseCaretPromptOpened();
hitF7();
let prompt = await promiseGotKey;
let doc = prompt.document;
let dialog = doc.getElementById("commonDialog");
let promiseDialogUnloaded = BrowserTestUtils.waitForEvent(prompt, "unload");
// Listen for an additional prompt to open, which should not happen.
let promiseDialogOrTimeout = () =>
Promise.race([
promiseCaretPromptOpened(),
// eslint-disable-next-line mozilla/no-arbitrary-setTimeout
new Promise(resolve => setTimeout(resolve, 100)),
]);
let openedPromise = promiseDialogOrTimeout();
// Hit F7 two more times: once to test that _awaitingToggleCaretBrowsingPrompt
// is applied, and again to test that its value isn't somehow reset by
// pressing F7 while the dialog is open.
for (let i = 0; i < 2; i++) {
await new Promise(resolve =>
SimpleTest.executeSoon(() => {
hitF7();
resolve();
})
);
}
// Say no:
dialog.cancelDialog();
await promiseDialogUnloaded;
info("Dialog unloaded");
let openedDialog = await openedPromise;
ok(!openedDialog, "No additional dialog should have opened.");
// If the test fails, clean up any dialogs we erroneously opened so they don't
// interfere with other tests.
let extraDialogs = 0;
while (openedDialog) {
extraDialogs += 1;
let doc = openedDialog.document;
let dialog = doc.getElementById("commonDialog");
openedPromise = promiseDialogOrTimeout();
dialog.cancelDialog();
openedDialog = await openedPromise;
}
if (extraDialogs) {
info(`Closed ${extraDialogs} extra dialogs.`);
}
// Either way, we now have an extra observer, so clean it up.
gCaretPromptOpeningObserver();
Services.prefs.setBoolPref(kPrefShortcutEnabled, true);
Services.prefs.setBoolPref(kPrefWarnOnEnable, true);
Services.prefs.setBoolPref(kPrefCaretBrowsingOn, false);
});
|