This repository has been archived by the owner on Feb 26, 2022. It is now read-only.
/
test-selection.js
760 lines (560 loc) · 20.6 KB
/
test-selection.js
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
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
const HTML = "<html>\
<body>\
<div>foo</div>\
<div>and</div>\
<textarea>noodles</textarea>\
</body>\
</html>";
const URL = "data:text/html;charset=utf-8," + encodeURIComponent(HTML);
const { defer } = require("sdk/core/promise");
const tabs = require("sdk/tabs");
const { getActiveTab, getTabContentWindow, closeTab } = require("sdk/tabs/utils")
const { getMostRecentBrowserWindow } = require("sdk/window/utils");
const { Loader } = require("sdk/test/loader");
const { setTimeout } = require("sdk/timers");
// General purpose utility functions
/**
* Opens the url given and return a promise, that will be resolved with the
* content window when the document is ready.
*
* I believe this approach could be useful in most of our unit test, that
* requires to open a tab and need to access to its content.
*/
function open(url) {
let { promise, resolve } = defer();
tabs.open({
url: url,
onReady: function(tab) {
// Unfortunately there is no way to get a XUL Tab from SDK Tab on Firefox,
// only on Fennec. We should implement `tabNS` also on Firefox in order
// to have that.
// Here we assuming that the most recent browser window is the one we're
// doing the test, and the active tab is the one we just opened.
let window = getTabContentWindow(getActiveTab(getMostRecentBrowserWindow()));
resolve(window);
}
});
return promise;
};
/**
* Close the Active Tab
*/
function close() {
// Here we assuming that the most recent browser window is the one we're
// doing the test, and the active tab is the one we just opened.
closeTab(getActiveTab(getMostRecentBrowserWindow()));
}
/**
* Reload the window given and return a promise, that will be resolved with the
* content window after a small delay.
*/
function reload(window) {
let { promise, resolve } = defer();
window.location.reload(true);
setTimeout(resolve, 250, window);
return promise;
}
// Selection's unit test utility function
/**
* Select the first div in the page, adding the range to the selection.
*/
function selectFirstDiv(window) {
let div = window.document.querySelector("div");
let selection = window.getSelection();
let range = window.document.createRange();
if (selection.rangeCount > 0)
selection.removeAllRanges();
range.selectNode(div);
selection.addRange(range);
return window;
}
/**
* Select all divs in the page, adding the ranges to the selection.
*/
function selectAllDivs(window) {
let divs = window.document.getElementsByTagName("div");
let selection = window.getSelection();
if (selection.rangeCount > 0)
selection.removeAllRanges();
for (let i = 0; i < divs.length; i++) {
let range = window.document.createRange();
range.selectNode(divs[i]);
selection.addRange(range);
}
return window;
}
/**
* Select the textarea content
*/
function selectTextarea(window) {
let selection = window.getSelection();
let textarea = window.document.querySelector("textarea");
if (selection.rangeCount > 0)
selection.removeAllRanges();
textarea.setSelectionRange(0, textarea.value.length);
textarea.focus();
return window;
}
/**
* Select the content of the first div
*/
function selectContentFirstDiv(window) {
let div = window.document.querySelector("div");
let selection = window.getSelection();
let range = window.document.createRange();
if (selection.rangeCount > 0)
selection.removeAllRanges();
range.selectNodeContents(div);
selection.addRange(range);
return window;
}
/**
* Dispatch the selection event for the selection listener added by
* `nsISelectionPrivate.addSelectionListener`
*/
function dispatchSelectionEvent(window) {
// We modify the selection in order to dispatch the selection's event, by
// contract the selection by one character. So if the text selected is "foo"
// will be "fo".
window.getSelection().modify("extend", "backward", "character");
}
/**
* Dispatch the selection event for the selection listener added by
* `window.onselect` / `window.addEventListener`
*/
function dispatchOnSelectEvent(window) {
let { document } = window;
let textarea = document.querySelector("textarea");
let event = document.createEvent("UIEvents");
event.initUIEvent("select", true, true, window, 1);
textarea.dispatchEvent(event)
}
/**
* Creates empty ranges and add them to selections
*/
function createEmptySelections(window) {
selectAllDivs(window);
let selection = window.getSelection();
for (let i = 0; i < selection.rangeCount; i++)
selection.getRangeAt(i).collapse(true);
}
// Test cases
exports["test No Selection"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(function() {
assert.equal(selection.isContiguous, false,
"selection.isContiguous without selection works.");
assert.strictEqual(selection.text, null,
"selection.text without selection works.");
assert.strictEqual(selection.html, null,
"selection.html without selection works.");
let selectionCount = 0;
for each (let sel in selection)
selectionCount++;
assert.equal(selectionCount, 0,
"No iterable selections");
}).then(close).then(loader.unload).then(done);
};
exports["test Single DOM Selection"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(selectFirstDiv).then(function() {
assert.equal(selection.isContiguous, true,
"selection.isContiguous with single DOM Selection works.");
assert.equal(selection.text, "foo",
"selection.text with single DOM Selection works.");
assert.equal(selection.html, "<div>foo</div>",
"selection.html with single DOM Selection works.");
let selectionCount = 0;
for each (let sel in selection) {
selectionCount++;
assert.equal(sel.text, "foo",
"iterable selection.text with single DOM Selection works.");
assert.equal(sel.html, "<div>foo</div>",
"iterable selection.html with single DOM Selection works.");
}
assert.equal(selectionCount, 1,
"One iterable selection");
}).then(close).then(loader.unload).then(done);
};
exports["test Multiple DOM Selection"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(selectAllDivs).then(function() {
let expectedText = ["foo", "and"];
let expectedHTML = ["<div>foo</div>", "<div>and</div>"];
assert.equal(selection.isContiguous, false,
"selection.isContiguous with multiple DOM Selection works.");
assert.equal(selection.text, expectedText[0],
"selection.text with multiple DOM Selection works.");
assert.equal(selection.html, expectedHTML[0],
"selection.html with multiple DOM Selection works.");
let selectionCount = 0;
for each (let sel in selection) {
assert.equal(sel.text, expectedText[selectionCount],
"iterable selection.text with multiple DOM Selection works.");
assert.equal(sel.html, expectedHTML[selectionCount],
"iterable selection.text with multiple DOM Selection works.");
selectionCount++;
}
assert.equal(selectionCount, 2,
"Two iterable selections");
}).then(close).then(loader.unload).then(done);
};
exports["test Textarea Selection"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(selectTextarea).then(function() {
assert.equal(selection.isContiguous, true,
"selection.isContiguous with Textarea Selection works.");
assert.equal(selection.text, "noodles",
"selection.text with Textarea Selection works.");
assert.strictEqual(selection.html, null,
"selection.html with Textarea Selection works.");
let selectionCount = 0;
for each (let sel in selection) {
selectionCount++;
assert.equal(sel.text, "noodles",
"iterable selection.text with Textarea Selection works.");
assert.strictEqual(sel.html, null,
"iterable selection.html with Textarea Selection works.");
}
assert.equal(selectionCount, 1,
"One iterable selection");
}).then(close).then(loader.unload).then(done);
};
exports["test Set Text in Multiple DOM Selection"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(selectAllDivs).then(function() {
let expectedText = ["bar", "and"];
let expectedHTML = ["bar", "<div>and</div>"];
selection.text = "bar";
assert.equal(selection.text, expectedText[0],
"set selection.text with single DOM Selection works.");
assert.equal(selection.html, expectedHTML[0],
"selection.html with single DOM Selection works.");
let selectionCount = 0;
for each (let sel in selection) {
assert.equal(sel.text, expectedText[selectionCount],
"iterable selection.text with multiple DOM Selection works.");
assert.equal(sel.html, expectedHTML[selectionCount],
"iterable selection.html with multiple DOM Selection works.");
selectionCount++;
}
assert.equal(selectionCount, 2,
"Two iterable selections");
}).then(close).then(loader.unload).then(done);
};
exports["test Set HTML in Multiple DOM Selection"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(selectAllDivs).then(function() {
let html = "<span>b<b>a</b>r</span>";
let expectedText = ["bar", "and"];
let expectedHTML = [html, "<div>and</div>"];
selection.html = html;
assert.equal(selection.text, expectedText[0],
"set selection.text with DOM Selection works.");
assert.equal(selection.html, expectedHTML[0],
"selection.html with DOM Selection works.");
let selectionCount = 0;
for each (let sel in selection) {
assert.equal(sel.text, expectedText[selectionCount],
"iterable selection.text with multiple DOM Selection works.");
assert.equal(sel.html, expectedHTML[selectionCount],
"iterable selection.html with multiple DOM Selection works.");
selectionCount++;
}
assert.equal(selectionCount, 2,
"Two iterable selections");
}).then(close).then(loader.unload).then(done);
};
exports["test Set HTML as text in Multiple DOM Selection"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(selectAllDivs).then(function() {
let text = "<span>b<b>a</b>r</span>";
let html = "<span>b<b>a</b>r</span>";
let expectedText = [text, "and"];
let expectedHTML = [html, "<div>and</div>"];
selection.text = text;
assert.equal(selection.text, expectedText[0],
"set selection.text with DOM Selection works.");
assert.equal(selection.html, expectedHTML[0],
"selection.html with DOM Selection works.");
let selectionCount = 0;
for each (let sel in selection) {
assert.equal(sel.text, expectedText[selectionCount],
"iterable selection.text with multiple DOM Selection works.");
assert.equal(sel.html, expectedHTML[selectionCount],
"iterable selection.html with multiple DOM Selection works.");
selectionCount++;
}
assert.equal(selectionCount, 2,
"Two iterable selections");
}).then(close).then(loader.unload).then(done);
};
exports["test Set Text in Textarea Selection"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(selectTextarea).then(function() {
let text = "bar";
selection.text = text;
assert.equal(selection.text, text,
"set selection.text with Textarea Selection works.");
assert.strictEqual(selection.html, null,
"selection.html with Textarea Selection works.");
let selectionCount = 0;
for each (let sel in selection) {
selectionCount++;
assert.equal(sel.text, text,
"iterable selection.text with Textarea Selection works.");
assert.strictEqual(sel.html, null,
"iterable selection.html with Textarea Selection works.");
}
assert.equal(selectionCount, 1,
"One iterable selection");
}).then(close).then(loader.unload).then(done);
};
exports["test Set HTML in Textarea Selection"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(selectTextarea).then(function() {
let html = "<span>b<b>a</b>r</span>";
// Textarea can't have HTML so set `html` property is equals to set `text`
// property
selection.html = html;
assert.equal(selection.text, html,
"set selection.text with Textarea Selection works.");
assert.strictEqual(selection.html, null,
"selection.html with Textarea Selection works.");
let selectionCount = 0;
for each (let sel in selection) {
selectionCount++;
assert.equal(sel.text, html,
"iterable selection.text with Textarea Selection works.");
assert.strictEqual(sel.html, null,
"iterable selection.html with Textarea Selection works.");
}
assert.equal(selectionCount, 1,
"One iterable selection");
}).then(close).then(loader.unload).then(done);
};
exports["test Empty Selections"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(createEmptySelections).then(function(){
assert.equal(selection.isContiguous, false,
"selection.isContiguous with empty selections works.");
assert.strictEqual(selection.text, null,
"selection.text with empty selections works.");
assert.strictEqual(selection.html, null,
"selection.html with empty selections works.");
let selectionCount = 0;
for each (let sel in selection)
selectionCount++;
assert.equal(selectionCount, 0,
"No iterable selections");
}).then(close).then(loader.unload).then(done);
}
exports["test No Selection Exception"] = function(assert, done) {
const NO_SELECTION = /It isn't possible to change the selection/;
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(function() {
// We're trying to change a selection when there is no selection
assert.throws(function() {
selection.text = "bar";
}, NO_SELECTION);
assert.throws(function() {
selection.html = "bar";
}, NO_SELECTION);
}).then(close).then(loader.unload).then(done);
};
exports["test for...of without selections"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(function() {
let selectionCount = 0;
for (let sel of selection)
selectionCount++;
assert.equal(selectionCount, 0,
"No iterable selections");
}).then(close).then(loader.unload).then(null, function(error) {
// iterable are not supported yet in Firefox 16, for example, but
// they are in Firefox 17.
if (error.message.indexOf("is not iterable") > -1)
assert.pass("`iterable` method not supported in this application");
else
assert.fail(error);
}).then(done);
}
exports["test for...of with selections"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
open(URL).then(selectAllDivs).then(function(){
let expectedText = ["foo", "and"];
let expectedHTML = ["<div>foo</div>", "<div>and</div>"];
let selectionCount = 0;
for (let sel of selection) {
assert.equal(sel.text, expectedText[selectionCount],
"iterable selection.text with for...of works.");
assert.equal(sel.html, expectedHTML[selectionCount],
"iterable selection.text with for...of works.");
selectionCount++;
}
assert.equal(selectionCount, 2,
"Two iterable selections");
}).then(close).then(loader.unload).then(null, function(error) {
// iterable are not supported yet in Firefox 16, for example, but
// they are in Firefox 17.
if (error.message.indexOf("is not iterable") > -1)
assert.pass("`iterable` method not supported in this application");
else
assert.fail(error);
}).then(done)
}
exports["test Selection Listener"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
selection.once("select", function() {
assert.equal(selection.text, "fo");
done();
});
open(URL).then(selectContentFirstDiv).
then(dispatchSelectionEvent).
then(close).
then(loader.unload);
};
exports["test Textarea OnSelect Listener"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
selection.once("select", function() {
assert.equal(selection.text, "noodles");
done();
});
open(URL).then(selectTextarea).
then(dispatchOnSelectEvent).
then(close).
then(loader.unload);
};
exports["test Selection listener removed on unload"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
selection.once("select", function() {
assert.fail("Shouldn't be never called");
});
loader.unload();
assert.pass();
open(URL).
then(selectContentFirstDiv).
then(dispatchSelectionEvent).
then(close).
then(done)
};
exports["test Textarea onSelect Listener removed on unload"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
selection.once("select", function() {
assert.fail("Shouldn't be never called");
});
loader.unload();
assert.pass();
open(URL).
then(selectTextarea).
then(dispatchOnSelectEvent).
then(close).
then(done)
};
exports["test Selection Listener on existing document"] = function(assert, done) {
let loader = Loader(module);
open(URL).then(function(window){
let selection = loader.require("sdk/selection");
selection.once("select", function() {
assert.equal(selection.text, "fo");
done();
});
return window;
}).then(selectContentFirstDiv).
then(dispatchSelectionEvent).
then(close).
then(loader.unload)
};
exports["test Textarea OnSelect Listener on existing document"] = function(assert, done) {
let loader = Loader(module);
open(URL).then(function(window){
let selection = loader.require("sdk/selection");
selection.once("select", function() {
assert.equal(selection.text, "noodles");
done();
});
return window;
}).then(selectTextarea).
then(dispatchOnSelectEvent).
then(close).
then(loader.unload)
};
exports["test Selection Listener on document reload"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
selection.once("select", function() {
assert.equal(selection.text, "fo");
done();
});
open(URL).
then(reload).
then(selectContentFirstDiv).
then(dispatchSelectionEvent).
then(close).
then(loader.unload);
};
exports["test Textarea OnSelect Listener on document reload"] = function(assert, done) {
let loader = Loader(module);
let selection = loader.require("sdk/selection");
selection.once("select", function() {
assert.equal(selection.text, "noodles");
done();
});
open(URL).
then(reload).
then(selectTextarea).
then(dispatchOnSelectEvent).
then(close).
then(loader.unload);
};
// TODO: test Selection Listener on long-held connection (Bug 661884)
//
// I didn't find a way to do so with httpd, using `processAsync` I'm able to
// Keep the connection but not to flush the buffer to the client in two steps,
// that is what I need for this test (e.g. flush "Hello" to the client, makes
// selection when the connection is still hold, and check that the listener
// is executed before the server send "World" and close the connection).
//
// Because this test is needed to the refactoring of context-menu as well, I
// believe we will find a proper solution quickly.
/*
exports["test Selection Listener on long-held connection"] = function(assert, done) {
};
*/
// If the module doesn't support the app we're being run in, require() will
// throw. In that case, remove all tests above from exports, and add one dummy
// test that passes.
try {
require("sdk/selection");
}
catch (err) {
if (err.message.indexOf("Unsupported Application:") !== 0)
throw err;
module.exports = {
"test Unsupported Application": function Unsupported (assert) {
assert.pass(err.message);
}
}
}
require("test").run(exports)