/
index.js
540 lines (509 loc) · 18.9 KB
/
index.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
/**
* External dependencies
*/
import { mount } from 'enzyme';
import { Component } from '../../../element';
/**
* WordPress dependencies
*/
import { keycodes } from '@wordpress/utils';
/**
* Internal dependencies
*/
import Autocomplete from '../';
const { ENTER, ESCAPE, UP, DOWN, SPACE } = keycodes;
class FakeEditor extends Component {
// we want to change the editor contents manually so don't let react update it
shouldComponentUpdate() {
return false;
}
render() {
const { children, ...other } = this.props;
return (
<div
className="fake-editor"
contentEditable
suppressContentEditableWarning
{ ...other }>
{ children }
</div>
);
}
}
/**
* Create a text node
* @param {String} text text of text node.
* @returns {Node} a text node.
*/
function tx( text ) {
return document.createTextNode( text );
}
/**
* Create a paragraph node with the arguments as children
* @returns {Node} a paragraph node.
*/
function par( /* arguments */ ) {
const p = document.createElement( 'p' );
Array.from( arguments ).forEach( ( element ) => p.appendChild( element ) );
return p;
}
/**
* Simulate typing into the fake editor by updating the content and simulating
* an input event. It also updates the data-cursor attribute which is used to
* simulate the cursor position in the test mocks.
* @param {*} wrapper enzyme wrapper around react node containing a FakeEditor.
* @param {Array.<Node>} nodeList array of dom nodes.
* @param {Array.<Number>} cursorPosition array specifying the child indexes and offset of the cursor
*/
function simulateInput( wrapper, nodeList, cursorPosition ) {
// update the editor content
const fakeEditor = wrapper.getDOMNode().querySelector( '.fake-editor' );
fakeEditor.innerHTML = '';
nodeList.forEach( ( element ) => fakeEditor.appendChild( element ) );
if ( cursorPosition && cursorPosition.length >= 1 ) {
fakeEditor.setAttribute( 'data-cursor', cursorPosition.join( ',' ) );
} else {
fakeEditor.removeAttribute( 'data-cursor' );
}
// simulate input event
wrapper.find( '.fake-editor' ).simulate( 'input', {
target: fakeEditor,
} );
wrapper.update();
}
/**
* Fire a native keydown event on the fake editor in the wrapper.
* @param {*} wrapper the wrapper containing the FakeEditor where the event will be dispatched.
* @param {*} keyCode the keycode of the key event.
*/
function simulateKeydown( wrapper, keyCode ) {
const fakeEditor = wrapper.getDOMNode().querySelector( '.fake-editor' );
const event = new KeyboardEvent( 'keydown', { keyCode } ); // eslint-disable-line
fakeEditor.dispatchEvent( event );
wrapper.update();
}
/**
* Check that the autocomplete matches the initial state.
* @param {*} wrapper the enzyme react wrapper.
*/
function expectInitialState( wrapper ) {
expect( wrapper.state( 'open' ) ).toBeUndefined();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
expect( wrapper.state( 'query' ) ).toBeUndefined();
expect( wrapper.state( 'search' ) ).toEqual( /./ );
expect( wrapper.instance().getFilteredOptions() ).toEqual( [] );
expect( wrapper.find( 'Popover' ).prop( 'isOpen' ) ).toBe( false );
expect( wrapper.find( '.components-autocomplete__result' ) ).toHaveLength( 0 );
}
describe( 'Autocomplete', () => {
const options = [
{
value: 1,
label: 'Bananas',
keywords: [ 'fruit' ],
},
{
value: 2,
label: 'Apple',
keywords: [ 'fruit' ],
},
];
const basicCompleter = {
getOptions: () => Promise.resolve( options ),
};
const slashCompleter = {
triggerPrefix: '/',
getOptions: () => Promise.resolve( options ),
};
let realGetCursor, realCreateRange;
beforeAll( () => {
realGetCursor = Autocomplete.prototype.getCursor;
Autocomplete.prototype.getCursor = jest.fn( ( container ) => {
if ( container.hasAttribute( 'data-cursor' ) ) {
// the cursor position is specified by a list of child indexes (relative to the container) and the offset
const path = container.getAttribute( 'data-cursor' ).split( ',' ).map( ( val ) => parseInt( val, 10 ) );
const offset = path.pop();
let node = container;
for ( let i = 0; i < path.length; i++ ) {
node = container.childNodes[ path[ i ] ];
}
return { node, offset };
}
// by default we say the cursor is at the end of the editor
return {
node: container,
offset: container.childNodes.length,
};
} );
realCreateRange = Autocomplete.prototype.createRange;
Autocomplete.prototype.createRange = jest.fn( ( startNode, startOffset, endNode, endOffset ) => {
const fakeBounds = { x: 0, y: 0, width: 1, height: 1, top: 0, right: 1, bottom: 1, left: 0 };
return {
startNode,
startOffset,
endNode,
endOffset,
getClientRects: () => [ fakeBounds ],
getBoundingClientRect: () => fakeBounds,
};
} );
} );
afterAll( () => {
Autocomplete.prototype.getCursor = realGetCursor;
Autocomplete.prototype.createRange = realCreateRange;
} );
describe( 'render()', () => {
it( 'renders children', () => {
const wrapper = mount(
<Autocomplete completers={ [ ] }>
<FakeEditor />
</Autocomplete>
);
expect( wrapper.state().open ).toBeUndefined();
expect( wrapper.find( 'Popover' ).prop( 'focusOnOpen' ) ).toBe( false );
expect( wrapper.childAt( 0 ).hasClass( 'components-autocomplete' ) ).toBe( true );
expect( wrapper.find( '.fake-editor' ) ).toHaveLength( 1 );
} );
it( 'opens on absent trigger prefix search', ( done ) => {
const wrapper = mount(
<Autocomplete completers={ [ basicCompleter ] }>
<FakeEditor />
</Autocomplete>
);
expectInitialState( wrapper );
// simulate typing 'b'
simulateInput( wrapper, [ par( tx( 'b' ) ) ] );
// wait for getOptions promise
process.nextTick( function() {
wrapper.update();
expect( wrapper.state( 'open' ) ).toBeDefined();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
expect( wrapper.state( 'query' ) ).toEqual( 'b' );
expect( wrapper.state( 'search' ) ).toEqual( /b/i );
expect( wrapper.instance().getFilteredOptions() ).toEqual( [
{ key: '0_0', value: 1, label: 'Bananas', keywords: [ 'fruit' ] },
] );
expect( wrapper.find( 'Popover' ).prop( 'isOpen' ) ).toBe( true );
expect( wrapper.find( '.components-autocomplete__result' ) ).toHaveLength( 1 );
done();
} );
} );
it( 'does not render popover as open if no results', ( done ) => {
const wrapper = mount(
<Autocomplete completers={ [ basicCompleter ] }>
<FakeEditor />
</Autocomplete>
);
expectInitialState( wrapper );
// simulate typing 'zzz'
simulateInput( wrapper, [ tx( 'zzz' ) ] );
// wait for getOptions promise
process.nextTick( () => {
wrapper.update();
// now check that we've opened the popup and filtered the options to empty
expect( wrapper.state( 'open' ) ).toBeDefined();
expect( wrapper.state( 'query' ) ).toEqual( 'zzz' );
expect( wrapper.state( 'search' ) ).toEqual( /zzz/i );
expect( wrapper.instance().getFilteredOptions() ).toEqual( [] );
expect( wrapper.find( 'Popover' ).prop( 'isOpen' ) ).toBe( false );
expect( wrapper.find( '.components-autocomplete__result' ) ).toHaveLength( 0 );
done();
} );
} );
it( 'does not open without trigger prefix', ( done ) => {
const wrapper = mount(
<Autocomplete completers={ [ slashCompleter ] }>
<FakeEditor />
</Autocomplete>
);
expectInitialState( wrapper );
// simulate typing 'b'
simulateInput( wrapper, [ par( tx( 'b' ) ) ] );
// wait for getOptions promise
process.nextTick( () => {
wrapper.update();
// now check that the popup is not open
expectInitialState( wrapper );
done();
} );
} );
it( 'opens on trigger prefix search', ( done ) => {
const wrapper = mount(
<Autocomplete completers={ [ slashCompleter ] }>
<FakeEditor />
</Autocomplete>
);
expectInitialState( wrapper );
// simulate typing '/'
simulateInput( wrapper, [ par( tx( '/' ) ) ] );
// wait for getOptions promise
process.nextTick( () => {
wrapper.update();
// now check that we've opened the popup and filtered the options
expect( wrapper.state( 'open' ) ).toBeDefined();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
expect( wrapper.state( 'query' ) ).toEqual( '' );
expect( wrapper.state( 'search' ) ).toEqual( new RegExp( '', 'i' ) );
expect( wrapper.instance().getFilteredOptions() ).toEqual( [
{ key: '0_0', value: 1, label: 'Bananas', keywords: [ 'fruit' ] },
{ key: '0_1', value: 2, label: 'Apple', keywords: [ 'fruit' ] },
] );
expect( wrapper.find( 'Popover' ).prop( 'isOpen' ) ).toBe( true );
expect( wrapper.find( '.components-autocomplete__result' ) ).toHaveLength( 2 );
done();
} );
} );
it( 'searches by keywords', ( done ) => {
const wrapper = mount(
<Autocomplete completers={ [ basicCompleter ] }>
<FakeEditor />
</Autocomplete>
);
expectInitialState( wrapper );
// simulate typing fruit (split over 2 text nodes because these things happen)
simulateInput( wrapper, [ par( tx( 'fru' ), tx( 'it' ) ) ] );
// wait for getOptions promise
process.nextTick( () => {
wrapper.update();
// now check that we've opened the popup and filtered the options
expect( wrapper.state( 'open' ) ).toBeDefined();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
expect( wrapper.state( 'query' ) ).toEqual( 'fruit' );
expect( wrapper.state( 'search' ) ).toEqual( /fruit/i );
expect( wrapper.instance().getFilteredOptions() ).toEqual( [
{ key: '0_0', value: 1, label: 'Bananas', keywords: [ 'fruit' ] },
{ key: '0_1', value: 2, label: 'Apple', keywords: [ 'fruit' ] },
] );
expect( wrapper.find( 'Popover' ).prop( 'isOpen' ) ).toBe( true );
expect( wrapper.find( '.components-autocomplete__result' ) ).toHaveLength( 2 );
done();
} );
} );
it( 'closes when search ends (whitespace)', ( done ) => {
const wrapper = mount(
<Autocomplete completers={ [ basicCompleter ] }>
<FakeEditor />
</Autocomplete>
);
expectInitialState( wrapper );
// simulate typing 'a'
simulateInput( wrapper, [ tx( 'a' ) ] );
// wait for getOptions promise
process.nextTick( () => {
wrapper.update();
// now check that we've opened the popup and all options are displayed
expect( wrapper.state( 'open' ) ).toBeDefined();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
expect( wrapper.state( 'query' ) ).toEqual( 'a' );
expect( wrapper.state( 'search' ) ).toEqual( /a/i );
expect( wrapper.instance().getFilteredOptions() ).toEqual( [
{ key: '0_0', value: 1, label: 'Bananas', keywords: [ 'fruit' ] },
{ key: '0_1', value: 2, label: 'Apple', keywords: [ 'fruit' ] },
] );
expect( wrapper.find( 'Popover' ).prop( 'isOpen' ) ).toBe( true );
expect( wrapper.find( '.components-autocomplete__result' ) ).toHaveLength( 2 );
// simulate typing 'p'
simulateInput( wrapper, [ tx( 'ap' ) ] );
// now check that the popup is still open and we've filtered the options to just the apple
expect( wrapper.state( 'open' ) ).toBeDefined();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
expect( wrapper.state( 'query' ) ).toEqual( 'ap' );
expect( wrapper.state( 'search' ) ).toEqual( /ap/i );
expect( wrapper.instance().getFilteredOptions() ).toEqual( [
{ key: '0_1', value: 2, label: 'Apple', keywords: [ 'fruit' ] },
] );
expect( wrapper.find( 'Popover' ).prop( 'isOpen' ) ).toBe( true );
expect( wrapper.find( '.components-autocomplete__result' ) ).toHaveLength( 1 );
// simulate typing ' '
simulateInput( wrapper, [ tx( 'ap ' ) ] );
// check the popup closes
expectInitialState( wrapper );
done();
} );
} );
it( 'navigates options by arrow keys', ( done ) => {
const wrapper = mount(
<Autocomplete completers={ [ slashCompleter ] }>
<FakeEditor />
</Autocomplete>
);
// listen to keydown events on the editor to see if it gets them
const editorKeydown = jest.fn();
const fakeEditor = wrapper.getDOMNode().querySelector( '.fake-editor' );
fakeEditor.addEventListener( 'keydown', editorKeydown, false );
expectInitialState( wrapper );
// the menu is not open so press an arrow and see if the editor gets it
expect( editorKeydown ).not.toHaveBeenCalled();
simulateKeydown( wrapper, DOWN );
expect( editorKeydown ).toHaveBeenCalledTimes( 1 );
// clear the call count
editorKeydown.mockClear();
// simulate typing '/', the menu is open so the editor should not get key down events
simulateInput( wrapper, [ par( tx( '/' ) ) ] );
// wait for getOptions promise
process.nextTick( () => {
wrapper.update();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
simulateKeydown( wrapper, DOWN );
expect( wrapper.state( 'selectedIndex' ) ).toBe( 1 );
simulateKeydown( wrapper, DOWN );
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
simulateKeydown( wrapper, UP );
expect( wrapper.state( 'selectedIndex' ) ).toBe( 1 );
simulateKeydown( wrapper, UP );
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
expect( editorKeydown ).not.toHaveBeenCalled();
done();
} );
} );
it( 'resets selected index on subsequent search', ( done ) => {
const wrapper = mount(
<Autocomplete completers={ [ slashCompleter ] }>
<FakeEditor />
</Autocomplete>
);
expectInitialState( wrapper );
// simulate typing '/'
simulateInput( wrapper, [ par( tx( '/' ) ) ] );
// wait for getOptions promise
process.nextTick( () => {
wrapper.update();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
simulateKeydown( wrapper, DOWN );
expect( wrapper.state( 'selectedIndex' ) ).toBe( 1 );
// simulate typing 'f
simulateInput( wrapper, [ par( tx( '/f' ) ) ] );
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
done();
} );
} );
it( 'closes by escape', ( done ) => {
const wrapper = mount(
<Autocomplete completers={ [ slashCompleter ] }>
<FakeEditor />
</Autocomplete>
);
// listen to keydown events on the editor to see if it gets them
const editorKeydown = jest.fn();
const fakeEditor = wrapper.getDOMNode().querySelector( '.fake-editor' );
fakeEditor.addEventListener( 'keydown', editorKeydown, false );
expectInitialState( wrapper );
// the menu is not open so press escape and see if the editor gets it
expect( editorKeydown ).not.toHaveBeenCalled();
simulateKeydown( wrapper, ESCAPE );
expect( editorKeydown ).toHaveBeenCalledTimes( 1 );
// clear the call count
editorKeydown.mockClear();
// simulate typing '/'
simulateInput( wrapper, [ par( tx( '/' ) ) ] );
// wait for getOptions promise
process.nextTick( () => {
wrapper.update();
// menu should be open with all options
expect( wrapper.state( 'open' ) ).toBeDefined();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
expect( wrapper.state( 'query' ) ).toEqual( '' );
expect( wrapper.state( 'search' ) ).toEqual( new RegExp( '', 'i' ) );
expect( wrapper.instance().getFilteredOptions() ).toEqual( [
{ key: '0_0', value: 1, label: 'Bananas', keywords: [ 'fruit' ] },
{ key: '0_1', value: 2, label: 'Apple', keywords: [ 'fruit' ] },
] );
// pressing escape should close everything
simulateKeydown( wrapper, ESCAPE );
expectInitialState( wrapper );
// the editor should not have gotten the event
expect( editorKeydown ).not.toHaveBeenCalled();
done();
} );
} );
it( 'selects by enter', ( done ) => {
const onSelect = jest.fn();
const wrapper = mount(
<Autocomplete completers={ [ { ...slashCompleter, onSelect } ] }>
<FakeEditor />
</Autocomplete>
);
// listen to keydown events on the editor to see if it gets them
const editorKeydown = jest.fn();
const fakeEditor = wrapper.getDOMNode().querySelector( '.fake-editor' );
fakeEditor.addEventListener( 'keydown', editorKeydown, false );
expectInitialState( wrapper );
// the menu is not open so press enter and see if the editor gets it
expect( editorKeydown ).not.toHaveBeenCalled();
simulateKeydown( wrapper, ENTER );
expect( editorKeydown ).toHaveBeenCalledTimes( 1 );
// clear the call count
editorKeydown.mockClear();
// simulate typing '/'
simulateInput( wrapper, [ par( tx( '/' ) ) ] );
// wait for getOptions promise
process.nextTick( () => {
wrapper.update();
// menu should be open with all options
expect( wrapper.state( 'open' ) ).toBeDefined();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
expect( wrapper.state( 'query' ) ).toEqual( '' );
expect( wrapper.state( 'search' ) ).toEqual( new RegExp( '', 'i' ) );
expect( wrapper.instance().getFilteredOptions() ).toEqual( [
{ key: '0_0', value: 1, label: 'Bananas', keywords: [ 'fruit' ] },
{ key: '0_1', value: 2, label: 'Apple', keywords: [ 'fruit' ] },
] );
// pressing enter should reset and call onSelect
simulateKeydown( wrapper, ENTER );
expectInitialState( wrapper );
expect( onSelect ).toHaveBeenCalled();
// the editor should not have gotten the event
expect( editorKeydown ).not.toHaveBeenCalled();
done();
} );
} );
it( 'doesn\'t otherwise interfere with keydown behavior', ( done ) => {
const wrapper = mount(
<Autocomplete completers={ [ slashCompleter ] }>
<FakeEditor />
</Autocomplete>
);
// listen to keydown events on the editor to see if it gets them
const editorKeydown = jest.fn();
const fakeEditor = wrapper.getDOMNode().querySelector( '.fake-editor' );
fakeEditor.addEventListener( 'keydown', editorKeydown, false );
expectInitialState( wrapper );
[ UP, DOWN, ENTER, ESCAPE, SPACE ].forEach( ( keyCode, i ) => {
simulateKeydown( wrapper, keyCode );
expect( editorKeydown ).toHaveBeenCalledTimes( i + 1 );
} );
expect( editorKeydown ).toHaveBeenCalledTimes( 5 );
done();
} );
it( 'selects by click on result', ( done ) => {
const onSelect = jest.fn();
const wrapper = mount(
<Autocomplete completers={ [ { ...slashCompleter, onSelect } ] }>
<FakeEditor />
</Autocomplete>
);
expectInitialState( wrapper );
// simulate typing '/'
simulateInput( wrapper, [ par( tx( '/' ) ) ] );
// wait for getOptions promise
process.nextTick( () => {
wrapper.update();
// menu should be open with all options
expect( wrapper.state( 'open' ) ).toBeDefined();
expect( wrapper.state( 'selectedIndex' ) ).toBe( 0 );
expect( wrapper.state( 'query' ) ).toEqual( '' );
expect( wrapper.state( 'search' ) ).toEqual( new RegExp( '', 'i' ) );
expect( wrapper.instance().getFilteredOptions() ).toEqual( [
{ key: '0_0', value: 1, label: 'Bananas', keywords: [ 'fruit' ] },
{ key: '0_1', value: 2, label: 'Apple', keywords: [ 'fruit' ] },
] );
// clicking should reset and select the item
wrapper.find( '.components-autocomplete__result Button' ).at( 0 ).simulate( 'click' );
wrapper.update();
expectInitialState( wrapper );
expect( onSelect ).toHaveBeenCalled();
done();
} );
} );
} );
} );