/
multi-entity-saving.test.js
286 lines (244 loc) · 10 KB
/
multi-entity-saving.test.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
/**
* WordPress dependencies
*/
import {
createNewPost,
disablePrePublishChecks,
insertBlock,
publishPost,
trashAllPosts,
activateTheme,
clickButton,
} from '@wordpress/e2e-test-utils';
/**
* Internal dependencies
*/
import { siteEditor } from '../../experimental-features';
describe( 'Multi-entity save flow', () => {
// Selectors - usable between Post/Site editors.
const checkedBoxSelector = '.components-checkbox-control__checked';
const checkboxInputSelector = '.components-checkbox-control__input';
const entitiesSaveSelector = '.editor-entities-saved-states__save-button';
const templatePartSelector = '*[data-type="core/template-part"]';
const activatedTemplatePartSelector = `${ templatePartSelector }.block-editor-block-list__layout`;
const savePanelSelector = '.entities-saved-states__panel';
const closePanelButtonSelector =
'.editor-post-publish-panel__header-cancel-button button';
const createNewButtonSelector =
'//button[contains(text(), "New template part")]';
// Reusable assertions across Post/Site editors.
const assertAllBoxesChecked = async () => {
const checkedBoxes = await page.$$( checkedBoxSelector );
const checkboxInputs = await page.$$( checkboxInputSelector );
expect( checkedBoxes.length - checkboxInputs.length ).toBe( 0 );
};
const assertExistance = async ( selector, shouldBePresent ) => {
const element = await page.$( selector );
if ( shouldBePresent ) {
expect( element ).not.toBeNull();
} else {
expect( element ).toBeNull();
}
};
beforeAll( async () => {
await activateTheme( 'tt1-blocks' );
await trashAllPosts( 'wp_template' );
await trashAllPosts( 'wp_template_part' );
} );
afterAll( async () => {
await activateTheme( 'twentytwentyone' );
} );
describe( 'Post Editor', () => {
// Selectors - Post editor specific.
const draftSavedSelector = '.editor-post-saved-state.is-saved';
const multiSaveSelector =
'.editor-post-publish-button__button.has-changes-dot';
const savePostSelector = '.editor-post-publish-button__button';
const enabledSavePostSelector = `${ savePostSelector }[aria-disabled=false]`;
const publishA11ySelector =
'.edit-post-layout__toggle-publish-panel-button';
const saveA11ySelector =
'.edit-post-layout__toggle-entities-saved-states-panel-button';
const publishPanelSelector = '.editor-post-publish-panel';
const confirmTitleButtonSelector =
'.wp-block-template-part__placeholder-create-new__title-form .components-button.is-primary';
// Reusable assertions inside Post editor.
const assertMultiSaveEnabled = async () => {
const multiSaveButton = await page.waitForSelector(
multiSaveSelector
);
expect( multiSaveButton ).not.toBeNull();
};
const assertMultiSaveDisabled = async () => {
const multiSaveButton = await page.waitForSelector(
multiSaveSelector,
{ hidden: true }
);
expect( multiSaveButton ).toBeNull();
};
it( 'Save flow should work as expected.', async () => {
await createNewPost();
// Edit the page some.
await page.click( '.editor-post-title' );
await page.keyboard.type( 'Test Post...' );
await page.keyboard.press( 'Enter' );
// Should not trigger multi-entity save button with only post edited
await assertMultiSaveDisabled();
// Should only have publish panel a11y button active with only post edited.
await assertExistance( publishA11ySelector, true );
await assertExistance( saveA11ySelector, false );
await assertExistance( publishPanelSelector, false );
await assertExistance( savePanelSelector, false );
// Add a template part and edit it.
await insertBlock( 'Template Part' );
const createNewButton = await page.waitForXPath(
createNewButtonSelector
);
await createNewButton.click();
const confirmTitleButton = await page.waitForSelector(
confirmTitleButtonSelector
);
await confirmTitleButton.click();
await page.waitForSelector( activatedTemplatePartSelector );
await page.click( '.block-editor-button-block-appender' );
await page.click( '.editor-block-list-item-paragraph' );
await page.keyboard.type( 'some words...' );
// Should trigger multi-entity save button once template part edited.
await assertMultiSaveEnabled();
// Should only have save panel a11y button active after child entities edited.
await assertExistance( publishA11ySelector, false );
await assertExistance( saveA11ySelector, true );
await assertExistance( publishPanelSelector, false );
await assertExistance( savePanelSelector, false );
// Opening panel has boxes checked by default.
await page.click( savePostSelector );
await page.waitForSelector( savePanelSelector );
await assertAllBoxesChecked();
// Should not show other panels (or their a11y buttons) while save panel opened.
await assertExistance( publishA11ySelector, false );
await assertExistance( saveA11ySelector, false );
await assertExistance( publishPanelSelector, false );
// Publish panel should open after saving.
await page.click( entitiesSaveSelector );
await page.waitForSelector( publishPanelSelector );
// No other panels (or their a11y buttons) should be present with publish panel open.
await assertExistance( publishA11ySelector, false );
await assertExistance( saveA11ySelector, false );
await assertExistance( savePanelSelector, false );
// Close publish panel.
await page.click( closePanelButtonSelector );
// Verify saving is disabled.
const draftSaved = await page.waitForSelector( draftSavedSelector );
expect( draftSaved ).not.toBeNull();
await assertMultiSaveDisabled();
await assertExistance( saveA11ySelector, false );
await publishPost();
// Update the post.
await page.click( '.editor-post-title' );
await page.keyboard.type( '...more title!' );
// Verify update button is enabled.
const enabledSaveButton = await page.$( enabledSavePostSelector );
expect( enabledSaveButton ).not.toBeNull();
// Verify multi-entity saving not enabled.
await assertMultiSaveDisabled();
await assertExistance( saveA11ySelector, false );
// Update template part.
await page.click( templatePartSelector );
await page.click(
`${ templatePartSelector } .wp-block[data-type="core/paragraph"]`
);
await page.keyboard.type( '...some more words...' );
await page.keyboard.press( 'Enter' );
// Multi-entity saving should be enabled.
await assertMultiSaveEnabled();
await assertExistance( saveA11ySelector, true );
} );
it( 'Site blocks should save individually', async () => {
await createNewPost();
await disablePrePublishChecks();
await insertBlock( 'Site Title' );
// Ensure title is retrieved before typing.
await page.waitForXPath( '//a[contains(text(), "gutenberg")]' );
const editableSiteTitleSelector =
'.wp-block-site-title a[contenteditable="true"]';
await page.waitForSelector( editableSiteTitleSelector );
await page.focus( editableSiteTitleSelector );
await page.keyboard.type( '...' );
await insertBlock( 'Site Tagline' );
// Ensure tagline is retrieved before typing.
await page.waitForXPath(
'//p[contains(text(), "Just another WordPress site")]'
);
const editableSiteTagLineSelector =
'.wp-block-site-tagline[contenteditable="true"]';
await page.waitForSelector( editableSiteTagLineSelector );
await page.focus( editableSiteTagLineSelector );
await page.keyboard.type( '...' );
await clickButton( 'Publish' );
await page.waitForSelector( savePanelSelector );
let checkboxInputs = await page.$$( checkboxInputSelector );
expect( checkboxInputs ).toHaveLength( 3 );
await checkboxInputs[ 1 ].click();
await page.click( entitiesSaveSelector );
await clickButton( 'Update…' );
await page.waitForSelector( savePanelSelector );
checkboxInputs = await page.$$( checkboxInputSelector );
expect( checkboxInputs ).toHaveLength( 1 );
// Reset site entity to default value to not affect other tests.
await page.evaluate( () => {
wp.data
.dispatch( 'core' )
.editEntityRecord( 'root', 'site', undefined, {
title: 'gutenberg',
description: 'Just another WordPress site',
} );
wp.data
.dispatch( 'core' )
.saveEditedEntityRecord( 'root', 'site', undefined );
} );
} );
} );
describe( 'Site Editor', () => {
// Selectors - Site editor specific.
const saveSiteSelector = '.edit-site-save-button__button';
const activeSaveSiteSelector = `${ saveSiteSelector }[aria-disabled=false]`;
const disabledSaveSiteSelector = `${ saveSiteSelector }[aria-disabled=true]`;
const saveA11ySelector = '.edit-site-editor__toggle-save-panel-button';
it( 'Save flow should work as expected', async () => {
// Navigate to site editor.
await siteEditor.visit( {
postId: 'tt1-blocks//index',
postType: 'wp_template',
} );
await siteEditor.disableWelcomeGuide();
// Select the header template part via list view.
await page.click( '.edit-site-header-toolbar__list-view-toggle' );
const headerTemplatePartListViewButton = await page.waitForXPath(
'//a[contains(@class, "block-editor-list-view-block-select-button")][contains(., "Header")]'
);
headerTemplatePartListViewButton.click();
await page.click( 'button[aria-label="Close list view sidebar"]' );
// Insert something to dirty the editor.
await insertBlock( 'Paragraph' );
const enabledButton = await page.waitForSelector(
activeSaveSiteSelector
);
// Should be enabled after edits.
expect( enabledButton ).not.toBeNull();
// Save a11y button should be present.
await assertExistance( saveA11ySelector, true );
// Clicking button should open panel with boxes checked.
await page.click( activeSaveSiteSelector );
await page.waitForSelector( savePanelSelector );
await assertAllBoxesChecked();
// Save a11y button should not be present with save panel open.
await assertExistance( saveA11ySelector, false );
// Saving should result in items being saved.
await page.click( entitiesSaveSelector );
const disabledButton = await page.waitForSelector(
disabledSaveSiteSelector
);
expect( disabledButton ).not.toBeNull();
} );
} );
} );