/
paragraph.spec.js
580 lines (511 loc) · 14.6 KB
/
paragraph.spec.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
/**
* External dependencies
*/
const path = require( 'path' );
/**
* WordPress dependencies
*/
const { test, expect } = require( '@wordpress/e2e-test-utils-playwright' );
test.use( {
draggingUtils: async ( { page }, use ) => {
await use( new DraggingUtils( { page } ) );
},
} );
test.describe( 'Paragraph', () => {
test.beforeEach( async ( { admin } ) => {
await admin.createNewPost();
} );
test( 'should output unwrapped editable paragraph', async ( {
editor,
page,
} ) => {
await editor.insertBlock( {
name: 'core/paragraph',
} );
await page.keyboard.type( '1' );
const firstBlockTagName = await editor.canvas
.locator( ':root' )
.evaluate( () => {
return document.querySelector( '[data-block]' ).tagName;
} );
// The outer element should be a paragraph. Blocks should never have any
// additional div wrappers so the markup remains simple and easy to
// style.
expect( firstBlockTagName ).toBe( 'P' );
} );
test.describe( 'Empty paragraph', () => {
test.use( {
// Make the viewport large enough so that a scrollbar isn't displayed.
// Otherwise, the page scrolling can interfere with the test runner's
// ability to drop a block in the right location.
viewport: {
width: 960,
height: 1024,
},
} );
test.beforeAll( async ( { requestUtils } ) => {
await requestUtils.deleteAllMedia();
} );
test.afterEach( async ( { requestUtils } ) => {
await requestUtils.deleteAllMedia();
} );
test( 'should allow dropping an image on an empty paragraph block', async ( {
editor,
pageUtils,
draggingUtils,
} ) => {
await editor.insertBlock( { name: 'core/paragraph' } );
const testImageName = '10x10_e2e_test_image_z9T8jK.png';
const testImagePath = path.join(
__dirname,
'../../../assets',
testImageName
);
const { dragOver, drop } =
await pageUtils.dragFiles( testImagePath );
await dragOver(
editor.canvas.locator( '[data-type="core/paragraph"]' )
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect( draggingUtils.insertionIndicator ).toBeHidden();
await drop(
editor.canvas.locator( '[data-type="core/paragraph"]' )
);
const imageBlock = editor.canvas.locator(
'role=document[name="Block: Image"i]'
);
await expect( imageBlock ).toBeVisible();
await expect( imageBlock.locator( 'role=img' ) ).toHaveAttribute(
'src',
new RegExp( testImageName.replace( '.', '\\.' ) )
);
} );
test( 'should allow dropping blocks on an empty paragraph block', async ( {
editor,
page,
draggingUtils,
} ) => {
await editor.insertBlock( {
name: 'core/heading',
attributes: { content: 'My Heading' },
} );
await editor.insertBlock( { name: 'core/paragraph' } );
await editor.canvas.locator( 'text=My Heading' ).focus();
await editor.showBlockToolbar();
const dragHandle = page.locator(
'role=toolbar[name="Block tools"i] >> role=button[name="Drag"i][include-hidden]'
);
await dragHandle.hover();
await page.mouse.down();
const emptyParagraph = editor.canvas.locator(
'[data-type="core/paragraph"][data-empty="true"]'
);
const boundingBox = await emptyParagraph.boundingBox();
await draggingUtils.dragOver( boundingBox.x, boundingBox.y );
await expect( draggingUtils.dropZone ).toBeVisible();
await expect( draggingUtils.insertionIndicator ).toBeHidden();
await page.mouse.up();
await expect.poll( editor.getEditedPostContent )
.toBe( `<!-- wp:heading -->
<h2 class="wp-block-heading">My Heading</h2>
<!-- /wp:heading -->` );
} );
test( 'should allow dropping HTML on an empty paragraph block', async ( {
editor,
page,
draggingUtils,
} ) => {
await editor.insertBlock( { name: 'core/paragraph' } );
await draggingUtils.simulateDraggingHTML(
'<h2 class="wp-block-heading">My Heading</h2>'
);
const emptyParagraph = editor.canvas.locator(
'[data-type="core/paragraph"][data-empty="true"]'
);
const boundingBox = await emptyParagraph.boundingBox();
await draggingUtils.dragOver( boundingBox.x, boundingBox.y );
await expect( draggingUtils.dropZone ).toBeVisible();
await expect( draggingUtils.insertionIndicator ).toBeHidden();
await page.mouse.up();
await expect.poll( editor.getEditedPostContent )
.toBe( `<!-- wp:heading -->
<h2 class="wp-block-heading">My Heading</h2>
<!-- /wp:heading -->` );
} );
test.describe( 'Dragging positions', () => {
test( 'Only the first block is an empty paragraph block', async ( {
editor,
draggingUtils,
} ) => {
await editor.setContent( `
<!-- wp:paragraph -->
<p></p>
<!-- /wp:paragraph -->
<!-- wp:heading -->
<h2>Heading</h2>
<!-- /wp:heading -->
` );
const emptyParagraph = editor.canvas.locator(
'[data-type="core/paragraph"]'
);
const heading = editor.canvas.locator( 'text=Heading' );
await draggingUtils.simulateDraggingHTML(
'<h2>Draggable</h2>'
);
const firstBlockBox = await emptyParagraph.boundingBox();
const headingBox = await heading.boundingBox();
{
// Dragging on the top half of an empty paragraph block.
await draggingUtils.dragOver(
firstBlockBox.x,
firstBlockBox.y + 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
firstBlockBox
)
)
.toBeTruthy();
}
{
// Dragging on the bottom half of an empty paragraph block.
await draggingUtils.dragOver(
firstBlockBox.x,
firstBlockBox.y + firstBlockBox.height - 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
firstBlockBox
)
)
.toBeTruthy();
}
{
// Dragging below the empty paragraph block but not yet on the second block.
await draggingUtils.dragOver(
firstBlockBox.x,
firstBlockBox.y + firstBlockBox.height + 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
firstBlockBox
)
)
.toBeTruthy();
}
{
// Dragging on the top half of the heading block.
await draggingUtils.dragOver(
headingBox.x,
headingBox.y + 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
firstBlockBox
)
)
.toBeTruthy();
}
{
// Dragging on the bottom half of the heading block.
await draggingUtils.dragOver(
headingBox.x,
headingBox.y + headingBox.height - 1
);
await expect( draggingUtils.dropZone ).toBeHidden();
await expect(
draggingUtils.insertionIndicator
).toBeVisible();
await expect
.poll( () =>
draggingUtils.insertionIndicator
.boundingBox()
.then( ( { y, height } ) => y + height )
)
.toBeGreaterThan( headingBox.y + headingBox.height );
}
} );
test( 'Only the second block is an empty paragraph block', async ( {
editor,
draggingUtils,
} ) => {
await editor.setContent( `
<!-- wp:heading -->
<h2>Heading</h2>
<!-- /wp:heading -->
<!-- wp:paragraph -->
<p></p>
<!-- /wp:paragraph -->
` );
const emptyParagraph = editor.canvas.locator(
'[data-type="core/paragraph"]'
);
const heading = editor.canvas.locator( 'text=Heading' );
await draggingUtils.simulateDraggingHTML(
'<h2>Draggable</h2>'
);
const secondBlockBox = await emptyParagraph.boundingBox();
const headingBox = await heading.boundingBox();
{
// Dragging on the top half of the heading block.
await draggingUtils.dragOver(
headingBox.x,
headingBox.y + 1
);
await expect( draggingUtils.dropZone ).toBeHidden();
await expect(
draggingUtils.insertionIndicator
).toBeVisible();
await expect
.poll( () =>
draggingUtils.insertionIndicator
.boundingBox()
.then( ( { y } ) => y )
)
.toBeLessThan( headingBox.y );
}
{
// Dragging on the bottom half of the heading block.
await draggingUtils.dragOver(
headingBox.x,
headingBox.y + headingBox.height - 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
secondBlockBox
)
)
.toBeTruthy();
}
{
// Dragging below the heading block but not yet on the empty paragraph block.
await draggingUtils.dragOver(
headingBox.x,
headingBox.y + headingBox.height + 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
secondBlockBox
)
)
.toBeTruthy();
}
{
// Dragging on the top half of the empty paragraph block.
await draggingUtils.dragOver(
secondBlockBox.x,
secondBlockBox.y + 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
secondBlockBox
)
)
.toBeTruthy();
}
{
// Dragging on the bottom half of the empty paragraph block.
await draggingUtils.dragOver(
secondBlockBox.x,
secondBlockBox.y + secondBlockBox.height - 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
secondBlockBox
)
)
.toBeTruthy();
}
} );
test( 'Both blocks are empty paragraph blocks', async ( {
editor,
draggingUtils,
} ) => {
await editor.setContent( `
<!-- wp:paragraph -->
<p></p>
<!-- /wp:paragraph -->
<!-- wp:paragraph -->
<p></p>
<!-- /wp:paragraph -->
` );
const firstEmptyParagraph = editor.canvas
.locator( '[data-type="core/paragraph"]' )
.first();
const secondEmptyParagraph = editor.canvas
.locator( '[data-type="core/paragraph"]' )
.nth( 1 );
await draggingUtils.simulateDraggingHTML(
'<h2>Draggable</h2>'
);
const firstBlockBox = await firstEmptyParagraph.boundingBox();
const secondBlockBox = await secondEmptyParagraph.boundingBox();
{
// Dragging on the top half of the first block.
await draggingUtils.dragOver(
firstBlockBox.x,
firstBlockBox.y + 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
firstBlockBox
)
)
.toBeTruthy();
}
{
// Dragging on the bottom half of the first block.
await draggingUtils.dragOver(
firstBlockBox.x,
firstBlockBox.y + firstBlockBox.height - 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
firstBlockBox
)
)
.toBeTruthy();
}
{
// Dragging slightly below the first block but not yet on the second block.
await draggingUtils.dragOver(
firstBlockBox.x,
firstBlockBox.y + firstBlockBox.height + 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
firstBlockBox
)
)
.toBeTruthy();
}
{
// Dragging slightly above the second block but not yet on the first block.
await draggingUtils.dragOver(
secondBlockBox.x,
secondBlockBox.y - 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
secondBlockBox
)
)
.toBeTruthy();
}
{
// Dragging on the top half of the second block.
await draggingUtils.dragOver(
secondBlockBox.x,
secondBlockBox.y + 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
secondBlockBox
)
)
.toBeTruthy();
}
{
// Dragging on the bottom half of the second block.
await draggingUtils.dragOver(
secondBlockBox.x,
secondBlockBox.y + secondBlockBox.height - 1
);
await expect( draggingUtils.dropZone ).toBeVisible();
await expect
.poll( () =>
draggingUtils.confirmValidDropZonePosition(
secondBlockBox
)
)
.toBeTruthy();
}
} );
} );
} );
} );
class DraggingUtils {
constructor( { page } ) {
this.page = page;
this.dropZone = page.locator( 'data-testid=block-popover-drop-zone' );
this.insertionIndicator = page.locator(
'data-testid=block-list-insertion-point-indicator'
);
}
async dragOver( x, y ) {
// Call the move function twice to make sure the `dragOver` event is sent.
// @see https://github.com/microsoft/playwright/issues/17153
for ( let i = 0; i < 2; i += 1 ) {
await this.page.mouse.move( x, y );
}
}
async simulateDraggingHTML( html ) {
// Insert a dummy draggable element on the page to simulate dragging
// HTML from other places. The dummy element will get removed once the drag starts.
await this.page.evaluate( ( _html ) => {
const draggable = document.createElement( 'div' );
draggable.draggable = true;
draggable.style.width = '10px';
draggable.style.height = '10px';
// Position it at the top left corner for convenience.
draggable.style.position = 'fixed';
draggable.style.top = 0;
draggable.style.left = 0;
draggable.style.zIndex = 999999;
draggable.addEventListener(
'dragstart',
( event ) => {
// Set the data transfer to some HTML on dragstart.
event.dataTransfer.setData( 'text/html', _html );
// Some browsers will cancel the drag if the source is immediately removed.
setTimeout( () => {
draggable.remove();
}, 0 );
},
{ once: true }
);
document.body.appendChild( draggable );
}, html );
// This is where the dummy draggable element is at.
await this.page.mouse.move( 0, 0 );
await this.page.mouse.down();
}
async confirmValidDropZonePosition( element ) {
// Check that both x and y axis of the dropzone
// have a less than 1 difference with a given target element
const box = await this.dropZone.boundingBox();
if ( ! box ) {
return false;
}
return (
Math.abs( element.x - box.x ) < 1 &&
Math.abs( element.y - box.y ) < 1
);
}
}