Skip to content
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.

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

Apply default attributes on block migration #53120

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

ajlende
Copy link
Contributor

@ajlende ajlende commented Jul 28, 2023

What?

Applies block attribute defaults when migrating blocks.

Why?

When I was running a block deprecation where new attributes were added with defaults (Automattic/block-experiments#334), I expected the defaults to be passed into the migration, but they weren't.

See the example below in Testing Instructions.

Attribute added.

{
	attr2: {
		type: 'string',
		default: 'attr2'
	}
}

Deprecated block.

<!-- wp:example-migration {"attr1":"modified attr1"} -->
<div class="wp-block-example-migration">modified attr1</div>
<!-- /wp:example-migration -->

Actual Migration.

<!-- wp:example-migration {"attr1":"modified attr1"} -->
<div class="wp-block-example-migration">modified attr1<br/></div>
<!-- /wp:example-migration -->

Expected migration. This includes the default attr2 value after the <br/>.

<!-- wp:example-migration {"attr1":"modified attr1"} -->
<div class="wp-block-example-migration">modified attr1<br/>attr2</div>
<!-- /wp:example-migration -->

How?

Calls getBlockAttributes (which applies the defaults) to the migratedAttributes when applying block deprecated versions.

Testing Instructions

Use the SSCCE below or try a block that you know has a deprecation that adds new attributes with defaults.

Sample block with deprecation.

var { registerBlockType } = wp.blocks;
var { createElement: h } = wp.element;

registerBlockType( 'core/example-migration', {
	title: 'Example migration',
	description: 'Example block to demo migration bug.',
	attributes: {
		attr1: {
			type: 'string',
			default: 'attr1',
		},
		attr2: {
			type: 'string',
			default: 'attr2',
		},
	},
	edit: ( { attributes: { attr1, attr2 } } ) =>
		h( 'div', null, [ attr1, h( 'br', null, null ), attr2 ] ),
	save: ( { attributes: { attr1, attr2 } } ) =>
		h( 'div', null, [ attr1, h( 'br', null, null ), attr2 ] ),
	deprecated: [ {
		attributes: {
			attr1: {
				type: 'string',
				default: 'attr1',
			},
		},
		save: ( { attributes: { attr1 } } ) =>
			h( 'div', null, attr1 ),
	} ]
} );

Deprecated block.

<!-- wp:example-migration {"attr1":"modified attr1"} -->
<div class="wp-block-example-migration">modified attr1</div>
<!-- /wp:example-migration -->

Correct migration.

<!-- wp:example-migration {"attr1":"modified attr1"} -->
<div class="wp-block-example-migration">modified attr1<br/>attr2</div>
<!-- /wp:example-migration -->
  1. Register the example block by pasting the registration code in the console.
  2. Paste the deprecated block into the block editor.
  3. View the migration result in the code editor.

Testing Instructions for Keyboard

N/A

Screenshots or screencast

N/A

@ajlende ajlende added the [Type] Bug An existing feature does not function as intended label Jul 28, 2023
@ajlende ajlende requested a review from youknowriad July 28, 2023 15:07
@ajlende ajlende self-assigned this Jul 28, 2023
@github-actions
Copy link

github-actions bot commented Jul 28, 2023

Size Change: +44 B (0%)

Total Size: 1.51 MB

Filename Size Change
build/blocks/index.min.js 51.2 kB +44 B (0%)
ℹ️ View Unchanged
Filename Size
build/a11y/index.min.js 955 B
build/annotations/index.min.js 2.69 kB
build/api-fetch/index.min.js 2.28 kB
build/autop/index.min.js 2.1 kB
build/blob/index.min.js 451 B
build/block-directory/index.min.js 7.01 kB
build/block-directory/style-rtl.css 1.02 kB
build/block-directory/style.css 1.02 kB
build/block-editor/content-rtl.css 4.27 kB
build/block-editor/content.css 4.26 kB
build/block-editor/default-editor-styles-rtl.css 381 B
build/block-editor/default-editor-styles.css 381 B
build/block-editor/index.min.js 213 kB
build/block-editor/style-rtl.css 15 kB
build/block-editor/style.css 15 kB
build/block-library/blocks/archives/editor-rtl.css 61 B
build/block-library/blocks/archives/editor.css 60 B
build/block-library/blocks/archives/style-rtl.css 90 B
build/block-library/blocks/archives/style.css 90 B
build/block-library/blocks/audio/editor-rtl.css 150 B
build/block-library/blocks/audio/editor.css 150 B
build/block-library/blocks/audio/style-rtl.css 122 B
build/block-library/blocks/audio/style.css 122 B
build/block-library/blocks/audio/theme-rtl.css 126 B
build/block-library/blocks/audio/theme.css 126 B
build/block-library/blocks/avatar/editor-rtl.css 116 B
build/block-library/blocks/avatar/editor.css 116 B
build/block-library/blocks/avatar/style-rtl.css 104 B
build/block-library/blocks/avatar/style.css 104 B
build/block-library/blocks/block/editor-rtl.css 305 B
build/block-library/blocks/block/editor.css 305 B
build/block-library/blocks/button/editor-rtl.css 584 B
build/block-library/blocks/button/editor.css 582 B
build/block-library/blocks/button/style-rtl.css 629 B
build/block-library/blocks/button/style.css 628 B
build/block-library/blocks/buttons/editor-rtl.css 337 B
build/block-library/blocks/buttons/editor.css 337 B
build/block-library/blocks/buttons/style-rtl.css 332 B
build/block-library/blocks/buttons/style.css 332 B
build/block-library/blocks/calendar/style-rtl.css 239 B
build/block-library/blocks/calendar/style.css 239 B
build/block-library/blocks/categories/editor-rtl.css 113 B
build/block-library/blocks/categories/editor.css 112 B
build/block-library/blocks/categories/style-rtl.css 124 B
build/block-library/blocks/categories/style.css 124 B
build/block-library/blocks/code/editor-rtl.css 53 B
build/block-library/blocks/code/editor.css 53 B
build/block-library/blocks/code/style-rtl.css 121 B
build/block-library/blocks/code/style.css 121 B
build/block-library/blocks/code/theme-rtl.css 124 B
build/block-library/blocks/code/theme.css 124 B
build/block-library/blocks/columns/editor-rtl.css 108 B
build/block-library/blocks/columns/editor.css 108 B
build/block-library/blocks/columns/style-rtl.css 421 B
build/block-library/blocks/columns/style.css 421 B
build/block-library/blocks/comment-author-avatar/editor-rtl.css 125 B
build/block-library/blocks/comment-author-avatar/editor.css 125 B
build/block-library/blocks/comment-content/style-rtl.css 92 B
build/block-library/blocks/comment-content/style.css 92 B
build/block-library/blocks/comment-template/style-rtl.css 199 B
build/block-library/blocks/comment-template/style.css 198 B
build/block-library/blocks/comments-pagination-numbers/editor-rtl.css 123 B
build/block-library/blocks/comments-pagination-numbers/editor.css 121 B
build/block-library/blocks/comments-pagination/editor-rtl.css 222 B
build/block-library/blocks/comments-pagination/editor.css 209 B
build/block-library/blocks/comments-pagination/style-rtl.css 235 B
build/block-library/blocks/comments-pagination/style.css 231 B
build/block-library/blocks/comments-title/editor-rtl.css 75 B
build/block-library/blocks/comments-title/editor.css 75 B
build/block-library/blocks/comments/editor-rtl.css 840 B
build/block-library/blocks/comments/editor.css 839 B
build/block-library/blocks/comments/style-rtl.css 637 B
build/block-library/blocks/comments/style.css 636 B
build/block-library/blocks/cover/editor-rtl.css 647 B
build/block-library/blocks/cover/editor.css 650 B
build/block-library/blocks/cover/style-rtl.css 1.63 kB
build/block-library/blocks/cover/style.css 1.62 kB
build/block-library/blocks/details/editor-rtl.css 65 B
build/block-library/blocks/details/editor.css 65 B
build/block-library/blocks/details/style-rtl.css 98 B
build/block-library/blocks/details/style.css 98 B
build/block-library/blocks/embed/editor-rtl.css 293 B
build/block-library/blocks/embed/editor.css 293 B
build/block-library/blocks/embed/style-rtl.css 410 B
build/block-library/blocks/embed/style.css 410 B
build/block-library/blocks/embed/theme-rtl.css 126 B
build/block-library/blocks/embed/theme.css 126 B
build/block-library/blocks/file/editor-rtl.css 316 B
build/block-library/blocks/file/editor.css 316 B
build/block-library/blocks/file/style-rtl.css 280 B
build/block-library/blocks/file/style.css 281 B
build/block-library/blocks/file/view-interactivity.min.js 317 B
build/block-library/blocks/file/view.min.js 375 B
build/block-library/blocks/footnotes/style-rtl.css 201 B
build/block-library/blocks/footnotes/style.css 199 B
build/block-library/blocks/freeform/editor-rtl.css 2.61 kB
build/block-library/blocks/freeform/editor.css 2.61 kB
build/block-library/blocks/gallery/editor-rtl.css 947 B
build/block-library/blocks/gallery/editor.css 952 B
build/block-library/blocks/gallery/style-rtl.css 1.53 kB
build/block-library/blocks/gallery/style.css 1.53 kB
build/block-library/blocks/gallery/theme-rtl.css 108 B
build/block-library/blocks/gallery/theme.css 108 B
build/block-library/blocks/group/editor-rtl.css 654 B
build/block-library/blocks/group/editor.css 654 B
build/block-library/blocks/group/style-rtl.css 57 B
build/block-library/blocks/group/style.css 57 B
build/block-library/blocks/group/theme-rtl.css 78 B
build/block-library/blocks/group/theme.css 78 B
build/block-library/blocks/heading/style-rtl.css 76 B
build/block-library/blocks/heading/style.css 76 B
build/block-library/blocks/html/editor-rtl.css 336 B
build/block-library/blocks/html/editor.css 337 B
build/block-library/blocks/image/editor-rtl.css 834 B
build/block-library/blocks/image/editor.css 833 B
build/block-library/blocks/image/style-rtl.css 1.42 kB
build/block-library/blocks/image/style.css 1.41 kB
build/block-library/blocks/image/theme-rtl.css 126 B
build/block-library/blocks/image/theme.css 126 B
build/block-library/blocks/image/view-interactivity.min.js 1.83 kB
build/block-library/blocks/latest-comments/style-rtl.css 357 B
build/block-library/blocks/latest-comments/style.css 357 B
build/block-library/blocks/latest-posts/editor-rtl.css 213 B
build/block-library/blocks/latest-posts/editor.css 212 B
build/block-library/blocks/latest-posts/style-rtl.css 478 B
build/block-library/blocks/latest-posts/style.css 478 B
build/block-library/blocks/list/style-rtl.css 88 B
build/block-library/blocks/list/style.css 88 B
build/block-library/blocks/media-text/editor-rtl.css 266 B
build/block-library/blocks/media-text/editor.css 263 B
build/block-library/blocks/media-text/style-rtl.css 505 B
build/block-library/blocks/media-text/style.css 503 B
build/block-library/blocks/more/editor-rtl.css 431 B
build/block-library/blocks/more/editor.css 431 B
build/block-library/blocks/navigation-link/editor-rtl.css 712 B
build/block-library/blocks/navigation-link/editor.css 711 B
build/block-library/blocks/navigation-link/style-rtl.css 115 B
build/block-library/blocks/navigation-link/style.css 115 B
build/block-library/blocks/navigation-submenu/editor-rtl.css 296 B
build/block-library/blocks/navigation-submenu/editor.css 295 B
build/block-library/blocks/navigation/editor-rtl.css 2.26 kB
build/block-library/blocks/navigation/editor.css 2.26 kB
build/block-library/blocks/navigation/style-rtl.css 2.23 kB
build/block-library/blocks/navigation/style.css 2.22 kB
build/block-library/blocks/navigation/view-interactivity.min.js 988 B
build/block-library/blocks/navigation/view-modal.min.js 2.85 kB
build/block-library/blocks/navigation/view.min.js 469 B
build/block-library/blocks/nextpage/editor-rtl.css 395 B
build/block-library/blocks/nextpage/editor.css 395 B
build/block-library/blocks/page-list/editor-rtl.css 401 B
build/block-library/blocks/page-list/editor.css 401 B
build/block-library/blocks/page-list/style-rtl.css 175 B
build/block-library/blocks/page-list/style.css 175 B
build/block-library/blocks/paragraph/editor-rtl.css 174 B
build/block-library/blocks/paragraph/editor.css 174 B
build/block-library/blocks/paragraph/style-rtl.css 279 B
build/block-library/blocks/paragraph/style.css 281 B
build/block-library/blocks/post-author/style-rtl.css 175 B
build/block-library/blocks/post-author/style.css 176 B
build/block-library/blocks/post-comments-form/editor-rtl.css 96 B
build/block-library/blocks/post-comments-form/editor.css 96 B
build/block-library/blocks/post-comments-form/style-rtl.css 508 B
build/block-library/blocks/post-comments-form/style.css 508 B
build/block-library/blocks/post-date/style-rtl.css 61 B
build/block-library/blocks/post-date/style.css 61 B
build/block-library/blocks/post-excerpt/editor-rtl.css 71 B
build/block-library/blocks/post-excerpt/editor.css 71 B
build/block-library/blocks/post-excerpt/style-rtl.css 141 B
build/block-library/blocks/post-excerpt/style.css 141 B
build/block-library/blocks/post-featured-image/editor-rtl.css 588 B
build/block-library/blocks/post-featured-image/editor.css 586 B
build/block-library/blocks/post-featured-image/style-rtl.css 319 B
build/block-library/blocks/post-featured-image/style.css 319 B
build/block-library/blocks/post-navigation-link/style-rtl.css 153 B
build/block-library/blocks/post-navigation-link/style.css 153 B
build/block-library/blocks/post-template/editor-rtl.css 99 B
build/block-library/blocks/post-template/editor.css 98 B
build/block-library/blocks/post-template/style-rtl.css 314 B
build/block-library/blocks/post-template/style.css 314 B
build/block-library/blocks/post-terms/style-rtl.css 96 B
build/block-library/blocks/post-terms/style.css 96 B
build/block-library/blocks/post-time-to-read/style-rtl.css 69 B
build/block-library/blocks/post-time-to-read/style.css 69 B
build/block-library/blocks/post-title/style-rtl.css 100 B
build/block-library/blocks/post-title/style.css 100 B
build/block-library/blocks/preformatted/style-rtl.css 125 B
build/block-library/blocks/preformatted/style.css 125 B
build/block-library/blocks/pullquote/editor-rtl.css 135 B
build/block-library/blocks/pullquote/editor.css 135 B
build/block-library/blocks/pullquote/style-rtl.css 335 B
build/block-library/blocks/pullquote/style.css 335 B
build/block-library/blocks/pullquote/theme-rtl.css 168 B
build/block-library/blocks/pullquote/theme.css 168 B
build/block-library/blocks/query-pagination-numbers/editor-rtl.css 122 B
build/block-library/blocks/query-pagination-numbers/editor.css 121 B
build/block-library/blocks/query-pagination/editor-rtl.css 221 B
build/block-library/blocks/query-pagination/editor.css 211 B
build/block-library/blocks/query-pagination/style-rtl.css 302 B
build/block-library/blocks/query-pagination/style.css 299 B
build/block-library/blocks/query-title/style-rtl.css 63 B
build/block-library/blocks/query-title/style.css 63 B
build/block-library/blocks/query/editor-rtl.css 450 B
build/block-library/blocks/query/editor.css 449 B
build/block-library/blocks/quote/style-rtl.css 222 B
build/block-library/blocks/quote/style.css 222 B
build/block-library/blocks/quote/theme-rtl.css 223 B
build/block-library/blocks/quote/theme.css 226 B
build/block-library/blocks/read-more/style-rtl.css 132 B
build/block-library/blocks/read-more/style.css 132 B
build/block-library/blocks/rss/editor-rtl.css 149 B
build/block-library/blocks/rss/editor.css 149 B
build/block-library/blocks/rss/style-rtl.css 289 B
build/block-library/blocks/rss/style.css 288 B
build/block-library/blocks/search/editor-rtl.css 178 B
build/block-library/blocks/search/editor.css 178 B
build/block-library/blocks/search/style-rtl.css 607 B
build/block-library/blocks/search/style.css 607 B
build/block-library/blocks/search/theme-rtl.css 114 B
build/block-library/blocks/search/theme.css 114 B
build/block-library/blocks/search/view.min.js 631 B
build/block-library/blocks/separator/editor-rtl.css 146 B
build/block-library/blocks/separator/editor.css 146 B
build/block-library/blocks/separator/style-rtl.css 234 B
build/block-library/blocks/separator/style.css 234 B
build/block-library/blocks/separator/theme-rtl.css 194 B
build/block-library/blocks/separator/theme.css 194 B
build/block-library/blocks/shortcode/editor-rtl.css 323 B
build/block-library/blocks/shortcode/editor.css 323 B
build/block-library/blocks/site-logo/editor-rtl.css 754 B
build/block-library/blocks/site-logo/editor.css 754 B
build/block-library/blocks/site-logo/style-rtl.css 204 B
build/block-library/blocks/site-logo/style.css 204 B
build/block-library/blocks/site-tagline/editor-rtl.css 86 B
build/block-library/blocks/site-tagline/editor.css 86 B
build/block-library/blocks/site-title/editor-rtl.css 116 B
build/block-library/blocks/site-title/editor.css 116 B
build/block-library/blocks/site-title/style-rtl.css 57 B
build/block-library/blocks/site-title/style.css 57 B
build/block-library/blocks/social-link/editor-rtl.css 184 B
build/block-library/blocks/social-link/editor.css 184 B
build/block-library/blocks/social-links/editor-rtl.css 682 B
build/block-library/blocks/social-links/editor.css 681 B
build/block-library/blocks/social-links/style-rtl.css 1.44 kB
build/block-library/blocks/social-links/style.css 1.43 kB
build/block-library/blocks/spacer/editor-rtl.css 348 B
build/block-library/blocks/spacer/editor.css 348 B
build/block-library/blocks/spacer/style-rtl.css 48 B
build/block-library/blocks/spacer/style.css 48 B
build/block-library/blocks/table/editor-rtl.css 432 B
build/block-library/blocks/table/editor.css 432 B
build/block-library/blocks/table/style-rtl.css 639 B
build/block-library/blocks/table/style.css 639 B
build/block-library/blocks/table/theme-rtl.css 146 B
build/block-library/blocks/table/theme.css 146 B
build/block-library/blocks/tag-cloud/style-rtl.css 251 B
build/block-library/blocks/tag-cloud/style.css 253 B
build/block-library/blocks/template-part/editor-rtl.css 403 B
build/block-library/blocks/template-part/editor.css 403 B
build/block-library/blocks/template-part/theme-rtl.css 101 B
build/block-library/blocks/template-part/theme.css 101 B
build/block-library/blocks/term-description/style-rtl.css 111 B
build/block-library/blocks/term-description/style.css 111 B
build/block-library/blocks/text-columns/editor-rtl.css 95 B
build/block-library/blocks/text-columns/editor.css 95 B
build/block-library/blocks/text-columns/style-rtl.css 166 B
build/block-library/blocks/text-columns/style.css 166 B
build/block-library/blocks/verse/style-rtl.css 99 B
build/block-library/blocks/verse/style.css 99 B
build/block-library/blocks/video/editor-rtl.css 552 B
build/block-library/blocks/video/editor.css 555 B
build/block-library/blocks/video/style-rtl.css 185 B
build/block-library/blocks/video/style.css 185 B
build/block-library/blocks/video/theme-rtl.css 126 B
build/block-library/blocks/video/theme.css 126 B
build/block-library/classic-rtl.css 179 B
build/block-library/classic.css 179 B
build/block-library/common-rtl.css 1.1 kB
build/block-library/common.css 1.1 kB
build/block-library/editor-elements-rtl.css 75 B
build/block-library/editor-elements.css 75 B
build/block-library/editor-rtl.css 12.1 kB
build/block-library/editor.css 12.1 kB
build/block-library/elements-rtl.css 54 B
build/block-library/elements.css 54 B
build/block-library/index.min.js 203 kB
build/block-library/reset-rtl.css 478 B
build/block-library/reset.css 478 B
build/block-library/style-rtl.css 13.8 kB
build/block-library/style.css 13.8 kB
build/block-library/theme-rtl.css 688 B
build/block-library/theme.css 693 B
build/block-serialization-default-parser/index.min.js 1.12 kB
build/block-serialization-spec-parser/index.min.js 2.87 kB
build/commands/index.min.js 15.5 kB
build/commands/style-rtl.css 932 B
build/commands/style.css 929 B
build/components/index.min.js 246 kB
build/components/style-rtl.css 11.8 kB
build/components/style.css 11.8 kB
build/compose/index.min.js 12.1 kB
build/core-commands/index.min.js 2.72 kB
build/core-data/index.min.js 16.8 kB
build/customize-widgets/index.min.js 12 kB
build/customize-widgets/style-rtl.css 1.46 kB
build/customize-widgets/style.css 1.45 kB
build/data-controls/index.min.js 640 B
build/data/index.min.js 8.38 kB
build/date/index.min.js 17.8 kB
build/deprecated/index.min.js 451 B
build/dom-ready/index.min.js 324 B
build/dom/index.min.js 4.64 kB
build/edit-post/classic-rtl.css 544 B
build/edit-post/classic.css 545 B
build/edit-post/index.min.js 35.4 kB
build/edit-post/style-rtl.css 7.62 kB
build/edit-post/style.css 7.62 kB
build/edit-site/index.min.js 91.1 kB
build/edit-site/style-rtl.css 13.2 kB
build/edit-site/style.css 13.2 kB
build/edit-widgets/index.min.js 16.9 kB
build/edit-widgets/style-rtl.css 4.52 kB
build/edit-widgets/style.css 4.52 kB
build/editor/index.min.js 45.5 kB
build/editor/style-rtl.css 3.53 kB
build/editor/style.css 3.52 kB
build/element/index.min.js 4.82 kB
build/escape-html/index.min.js 537 B
build/format-library/index.min.js 7.59 kB
build/format-library/style-rtl.css 554 B
build/format-library/style.css 553 B
build/hooks/index.min.js 1.55 kB
build/html-entities/index.min.js 448 B
build/i18n/index.min.js 3.58 kB
build/interactivity/index.min.js 10.9 kB
build/is-shallow-equal/index.min.js 527 B
build/keyboard-shortcuts/index.min.js 1.64 kB
build/keycodes/index.min.js 1.87 kB
build/list-reusable-blocks/index.min.js 2.2 kB
build/list-reusable-blocks/style-rtl.css 836 B
build/list-reusable-blocks/style.css 836 B
build/media-utils/index.min.js 2.9 kB
build/notices/index.min.js 948 B
build/nux/index.min.js 1.99 kB
build/nux/style-rtl.css 735 B
build/nux/style.css 732 B
build/patterns/index.min.js 2.71 kB
build/patterns/style-rtl.css 240 B
build/patterns/style.css 240 B
build/plugins/index.min.js 1.79 kB
build/preferences-persistence/index.min.js 1.84 kB
build/preferences/index.min.js 1.24 kB
build/primitives/index.min.js 943 B
build/priority-queue/index.min.js 1.52 kB
build/private-apis/index.min.js 958 B
build/react-i18n/index.min.js 615 B
build/react-refresh-entry/index.min.js 9.47 kB
build/react-refresh-runtime/index.min.js 7.31 kB
build/redux-routine/index.min.js 2.7 kB
build/reusable-blocks/index.min.js 2.7 kB
build/reusable-blocks/style-rtl.css 243 B
build/reusable-blocks/style.css 243 B
build/rich-text/index.min.js 11 kB
build/router/index.min.js 1.78 kB
build/server-side-render/index.min.js 1.94 kB
build/shortcode/index.min.js 1.39 kB
build/style-engine/index.min.js 1.85 kB
build/sync/index.min.js 53.8 kB
build/token-list/index.min.js 582 B
build/url/index.min.js 3.73 kB
build/vendors/inert-polyfill.min.js 2.48 kB
build/vendors/react-dom.min.js 41.8 kB
build/vendors/react.min.js 4.02 kB
build/viewport/index.min.js 958 B
build/warning/index.min.js 249 B
build/widgets/index.min.js 7.16 kB
build/widgets/style-rtl.css 1.15 kB
build/widgets/style.css 1.16 kB
build/wordcount/index.min.js 1.02 kB

compressed-size-action

@github-actions
Copy link

github-actions bot commented Jul 28, 2023

Flaky tests detected in bf5f6a3.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5693725917
📝 Reported issues:

Comment on lines 115 to 116
...block,
attributes: migratedAttributes,
attributes: getBlockAttributes(
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The problem with using getBlockAttributes here is that migratedBlock.originalContent is still the old block's content, so any blocks sourcing block attributes from the HTML will be incorrect.

Maybe we need a new function to skip those in this step.

Copy link
Member

Choose a reason for hiding this comment

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

we're trying to source the new attributes here from the migrated block's new save output?

I'm missing something on what the problem is here, but it seems like we should be able to resolve it whatever it is

Copy link
Member

Choose a reason for hiding this comment

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

this is all really confusing to me, and applyBlockDeprecatedVersions seems like it would benefit from drawing new terms and avoiding conflating names.

migratedBlock.originalContent is still the old block's content, so any blocks sourcing block attributes from the HTML will be incorrect.

there could be a few ways this goes: the block's HTML doesn't contain the thing that the new attribute definitions are looking for, or it does, or it doesn't have the structure those attribute definitions are looking for.

  • for source[src] with <img src="…"> we hopefully is undefined and an invalid parse.
  • for img[src] with <img> we get '' which is a valid parse but wrong because it provides an empty string instead of an undefined value.
  • for p:content with <p>This used to match everything.</p> we get 'This used to match everything.' which is a valid parse.

after creating migratedBlock we should be sourcing the new attributes from the old HTML, leaving us with missing or empty parameters that should be supplied by defaults if they aren't there. I'm reminded of the list block which at one point wiped out an entire list of save because the deprecation process returned an empty string instead of saying the block was invalid. I think in those cases changing <ul> to <ult> or some other typo was enough to trigger this flow.

we could also be hitting this backwards: HTML that was generated in a newer version of the block than we currently support. again, we could fail to parse structure and result in an empty value that wipes out content on save instead of preserving it.

maybe the most important piece is knowing if the original content was newer or older than the block in the editor, which actually is impossible due to the lack of versioning.

I think that the idea in this function is to re-attempt to parse the original content using the newer attribute definitions, and I think this PR is saying, "if after that re-parse we are missing attributes, supply the defaults." if that's the case it seems like we should call addDefaultAttributes() inside the deprecation loop and not after it, but I'm not sure that's still what we want.

  • migratedBlock sources attributes from new definitions
  • it's sent to validateBlock, which re-serializes the block with the newly-sourced attributes, then saves it, then compares if it matches the originalContent. it's it's valid it implies that the right data was there; probably the attribute definitions had a minor update.
  • if it's not validated it goes to the next deprecation in the list. this implies that loading and saving led to a different outcome; something is probably missing.
  • if it is valid we look for a migrate function to transform it further. at this point we can read and write the block and get the same thing we started with.

the validateBlock function calls save with missing attributes, so it seems like we need to supply defaults to migratedBlock but also refrain from persisting them until deprecation/migration is over, since the next deprecation in the loop could supply a default that's missing from the current one.

let migratedBlock = {
	...block,
	attributes: getBlockAttributes(
		deprecatedBlockType,
		block.originalContent,
		parsedAttributes
	),
};

const withDefaultAttributes = withDefaultsForMissingAttributes( deprecatedBlockType, migratedBlock );

let [ isValid ] = validateBlock( withDefaultAttributes, deprecatedBlockType );

if ( ! isValid ) {

}

migratedBlock = withDefaultAttributes;

@scruffian
Copy link
Contributor

This makes sense to me but it would be good to have a review from someone who is more familiar with the code.

@ajlende ajlende force-pushed the fix/apply-default-attributes-on-migration branch from bf5f6a3 to be4c574 Compare August 28, 2023 20:33
);

return blockAttributes;
}
Copy link
Member

Choose a reason for hiding this comment

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

this feels like some kind of withDefaultsForMissingAttributes function.

also I think that it could make sense to move to a more imperative approach in this function, both for efficiency sake (no need to allocate the extra maps/arrays or break shallow-equality for attributes with all the required values) and from a clarity standpoint, to highlight the fill-if-missing-logic

export function withDefaultsForMissingAttributes( blockTypeOrName, attributes = {} ) {
	const blockType = normalizeBlockType( blockTypeOrName );
	if ( ! blockType.attributes ) {
		return attributes;
	}

	let allAttributes = null;

	for ( const key in blockType.attributes ) {
		if ( undefined !== attributes[ key ] ) {
			continue;
		}

		if ( null === allAttributes ) {
			allAttributes = { ...attributes };
		}

		allAttributes[ key ] = blockType.attributes[ key ].default;
	}

	// Only return a new object if default values were supplied.
	return null !== allAttributes
		? allAttributes
		: attributes;
}

Copy link
Contributor Author

@ajlende ajlende Aug 29, 2023

Choose a reason for hiding this comment

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

also I think that it could make sense to move to a more imperative approach in this function, both for efficiency sake (no need to allocate the extra maps/arrays or break shallow-equality for attributes with all the required values) and from a clarity standpoint, to highlight the fill-if-missing-logic

Yeah, it was just a quick copy of getBlockAttributes that didn't try to source values from the block content. Looks like everywhere that used to use _.mapValues uses the Object.entries style since #50285. It's easy enough to change here. getBlockAttributes should also probably be changed for better performance at some point too.

Comment on lines 115 to 116
...block,
attributes: migratedAttributes,
attributes: getBlockAttributes(
Copy link
Member

Choose a reason for hiding this comment

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

this is all really confusing to me, and applyBlockDeprecatedVersions seems like it would benefit from drawing new terms and avoiding conflating names.

migratedBlock.originalContent is still the old block's content, so any blocks sourcing block attributes from the HTML will be incorrect.

there could be a few ways this goes: the block's HTML doesn't contain the thing that the new attribute definitions are looking for, or it does, or it doesn't have the structure those attribute definitions are looking for.

  • for source[src] with <img src="…"> we hopefully is undefined and an invalid parse.
  • for img[src] with <img> we get '' which is a valid parse but wrong because it provides an empty string instead of an undefined value.
  • for p:content with <p>This used to match everything.</p> we get 'This used to match everything.' which is a valid parse.

after creating migratedBlock we should be sourcing the new attributes from the old HTML, leaving us with missing or empty parameters that should be supplied by defaults if they aren't there. I'm reminded of the list block which at one point wiped out an entire list of save because the deprecation process returned an empty string instead of saying the block was invalid. I think in those cases changing <ul> to <ult> or some other typo was enough to trigger this flow.

we could also be hitting this backwards: HTML that was generated in a newer version of the block than we currently support. again, we could fail to parse structure and result in an empty value that wipes out content on save instead of preserving it.

maybe the most important piece is knowing if the original content was newer or older than the block in the editor, which actually is impossible due to the lack of versioning.

I think that the idea in this function is to re-attempt to parse the original content using the newer attribute definitions, and I think this PR is saying, "if after that re-parse we are missing attributes, supply the defaults." if that's the case it seems like we should call addDefaultAttributes() inside the deprecation loop and not after it, but I'm not sure that's still what we want.

  • migratedBlock sources attributes from new definitions
  • it's sent to validateBlock, which re-serializes the block with the newly-sourced attributes, then saves it, then compares if it matches the originalContent. it's it's valid it implies that the right data was there; probably the attribute definitions had a minor update.
  • if it's not validated it goes to the next deprecation in the list. this implies that loading and saving led to a different outcome; something is probably missing.
  • if it is valid we look for a migrate function to transform it further. at this point we can read and write the block and get the same thing we started with.

the validateBlock function calls save with missing attributes, so it seems like we need to supply defaults to migratedBlock but also refrain from persisting them until deprecation/migration is over, since the next deprecation in the loop could supply a default that's missing from the current one.

let migratedBlock = {
	...block,
	attributes: getBlockAttributes(
		deprecatedBlockType,
		block.originalContent,
		parsedAttributes
	),
};

const withDefaultAttributes = withDefaultsForMissingAttributes( deprecatedBlockType, migratedBlock );

let [ isValid ] = validateBlock( withDefaultAttributes, deprecatedBlockType );

if ( ! isValid ) {

}

migratedBlock = withDefaultAttributes;

@ajlende
Copy link
Contributor Author

ajlende commented Aug 30, 2023

this is all really confusing to me, and applyBlockDeprecatedVersions seems like it would benefit from drawing new terms and avoiding conflating names.

@dmsnell I feel the same way about a lot of the stuff in the parser.

I think that the idea in this function is to re-attempt to parse the original content using the newer attribute definitions, and I think this PR is saying, "if after that re-parse we are missing attributes, supply the defaults." if that's the case it seems like we should call addDefaultAttributes() inside the deprecation loop and not after it, but I'm not sure that's still what we want.

The important thing is that the new default attributes are passed to save when the migrated block is re-serialized. I figured doing that in the same place as migrate is called made sense, but maybe there's a better place for it?


I worked on some refactoring this afternoon, but didn't quite finish. I'll keep with it and ping you again when it's ready.

@ajlende
Copy link
Contributor Author

ajlende commented Aug 31, 2023

I worked on some refactoring this afternoon, but didn't quite finish. I'll keep with it and ping you again when it's ready.

The refactoring hasn't gone well. Once I started renaming things, I realized that a lot of the JSDoc types were wrong. Some of them looked like they could be replaced by types from DefinitelyTyped or @wordpress/block-serialization-default-parser. Unfortunately I found that those other sources for types were often wrong or incomplete. Best I can do is run through the code line-by-line in a debugger and update the types everywhere to be more correct.

Here's a table of some of the more confusing type/variable name mappings. I'll probably keep it updated as I come across more.

Gutenberg packages/blocks JSDoc Gutenberg packages/blocks variable(s) DefinitelyTyped @types/wordpress__blocks @wordpress/block-serialization-default-parser exported types
WPRawBlock rawBlock, normalizedBlock - ParsedBlock
WPBlock parsedBlock, validatedBlock, updatedBlock BlockInstance -
WPBlockType blockType Block -
Object attributeSchema BlockAttribute -

@gziolo gziolo added the [Feature] Block API API that allows to express the block paradigm. label Aug 31, 2023
@artemiomorales artemiomorales requested review from oandregal and removed request for oandregal November 11, 2023 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Block API API that allows to express the block paradigm. [Type] Bug An existing feature does not function as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants