Skip to content

Mark applying block templates not persistent #45843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 25, 2022
Merged

Mark applying block templates not persistent #45843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
980a8fa
mark applying templates as a not persistent change
draganescu Nov 17, 2022
87efa23
Add a test
scruffian Nov 24, 2022
b28c09c
Update e2e test
talldan Nov 25, 2022
6c08063
Fix tests
talldan Nov 25, 2022
862f4d7
make more explicit assetions
scruffian Nov 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/block-editor/src/components/inner-blocks/use-inner-block-template-sync.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ export default function useInnerBlockTemplateSync(
) {
const { getSelectedBlocksInitialCaretPosition, isBlockSelected } =
useSelect( blockEditorStore );
const { replaceInnerBlocks } = useDispatch( blockEditorStore );
const { replaceInnerBlocks, __unstableMarkNextChangeAsNotPersistent } =
useDispatch( blockEditorStore );
const innerBlocks = useSelect(
( select ) => select( blockEditorStore ).getBlocks( clientId ),
[ clientId ]
Expand Down Expand Up @@ -81,6 +82,7 @@ export default function useInnerBlockTemplateSync(
);

if ( ! isEqual( nextBlocks, currentInnerBlocks ) ) {
__unstableMarkNextChangeAsNotPersistent();
replaceInnerBlocks(
clientId,
nextBlocks,
Expand Down
29 changes: 29 additions & 0 deletions packages/e2e-tests/plugins/inner-blocks-templates/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
const createBlock = wp.blocks.createBlock;
const el = wp.element.createElement;
const InnerBlocks = wp.blockEditor.InnerBlocks;
const useState = window.wp.element.useState;

const TEMPLATE = [
[
'core/paragraph',
Expand Down Expand Up @@ -171,4 +173,31 @@

save,
} );


function InnerBlocksAsyncTemplateEdit() {
const [ template, setTemplate ] = useState( [] );

setInterval( () => {
setTemplate( TEMPLATE_TWO_PARAGRAPHS );
}, 1000 );

return el( InnerBlocks, {
template,
} );
}

registerBlockType(
'test/test-inner-blocks-async-template',
{
title: 'Test Inner Blocks Async Template',
icon: 'cart',
category: 'text',

edit: InnerBlocksAsyncTemplateEdit,

// Purposely do not save inner blocks so that it's possible to test template resolution.
save() {},
}
);
} )();
0 ...with-a-predefined-template-1-chromium.txt → ...with-a-predefined-template-1-chromium.txt
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...2e/specs/editor/plugins/templates.spec.js → ...ditor/plugins/post-type-templates.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/
const { test, expect } = require( '@wordpress/e2e-test-utils-playwright' );

test.describe( 'templates', () => {
test.describe( 'Post type templates', () => {
test.describe( 'Using a CPT with a predefined template', () => {
test.beforeAll( async ( { requestUtils } ) => {
await requestUtils.activatePlugin(
Expand Down
56 changes: 56 additions & 0 deletions test/e2e/specs/editor/various/inner-blocks-templates.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/**
* WordPress dependencies
*/
const { test, expect } = require( '@wordpress/e2e-test-utils-playwright' );

test.describe( 'Inner blocks templates', () => {
test.beforeAll( async ( { requestUtils } ) => {
await requestUtils.activatePlugin(
'gutenberg-test-inner-blocks-templates'
Copy link
Contributor

@talldan talldan Nov 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test plugin seems to have been unused. Not sure how that happened. Probably a good chance to cull much of its code, but I won't do that in this PR.

);
} );

test.beforeEach( async ( { admin } ) => {
await admin.createNewPost();
} );

test.afterAll( async ( { requestUtils } ) => {
await requestUtils.deactivatePlugin(
'gutenberg-test-inner-blocks-templates'
);
} );

test( 'applying block templates asynchronously does not create a persistent change in the editor', async ( {
editor,
page,
} ) => {
await editor.insertBlock( {
name: 'test/test-inner-blocks-async-template',
} );

const blockWithTemplateContent = page.locator(
'role=document[name="Block: Test Inner Blocks Async Template"i] >> text=OneTwo'
);

// The block template content appears asynchronously, so wait for it.
await expect( blockWithTemplateContent ).toBeVisible();

// Publish the post, then reload.
await editor.publishPost();
await page.reload();

// Wait for the block that was inserted to appear with its templated content.
await expect( blockWithTemplateContent ).toBeVisible();

// The template resolution shouldn't cause the post to be dirty.
const editorTopBar = page.locator(
'role=region[name="Editor top bar"i]'
);
const undoButton = editorTopBar.locator( 'role=button[name="Undo"i]' );
const updateButton = editorTopBar.locator(
'role=button[name="Update"i]'
);
await expect( undoButton ).toHaveAttribute( 'aria-disabled', 'true' );
await expect( updateButton ).toHaveAttribute( 'aria-disabled', 'true' );
} );
} );