Add context properties to block types REST endpoint #22686

aduth · 2020-05-27T22:17:40Z

This pull request seeks to add block context properties to the block types REST controller originally implemented in #21065. Block context documentation was created as part of #21925, but not incorporated into the existing Block Type RFC document. It has been included here alongside the necessary revisions to include the properties in the REST controller.

Status: The implementation should work well enough, though it may warrant being considered blocked by one or both of:

A decision at Block API: Extend register_block_type_from_metadata to handle assets #22519 (comment) in regards to registering block types using snake-cased provides_context, rather than camel-cased providesContext.
A solution to provide provides_context as an empty object {}, rather than incorrect array [], related to the comment at https://github.com/WordPress/gutenberg/pull/21065/files#r431468417.

Testing Instructions:

Ensure tests pass:

./packages/env/bin/wp-env run composer 'composer install'
npm run test-unit-php

Test scenario from #21467 is helpful as well:

Given that this pull request only ports the Post Title experimental full-site editing block, testing can be a bit cumbersome at the moment, especially if you've not yet defined templates for full-site editing mode.

My recommendation for testing is as follows:

Navigate to Gutenberg > Experiments

Enable "Full Site Editing" and click "Save Changes"

Navigate to Posts > Add New

Insert a Post Title block

Observe that the block inherits the title of the post and updates if you change the title

Preview the post in a separate tab

Note: If you don't have templates on your site, you may see a message "No template found". This is expected, and can be disregarded for now.

Navigate to Gutenberg > Experiments

Disable "Full Site Editing" and click "Save Changes"

In your separate preview tab, refresh the page.

Observe that the Post Title block displays the title of the current post

github-actions · 2020-05-27T22:24:02Z

Size Change: +218 B (0%)

Total Size: 1.12 MB

Filename	Size	Change
`build/block-editor/index.js`	106 kB	+133 B (0%)
`build/block-editor/style-rtl.css`	10.7 kB	+6 B (0%)
`build/block-editor/style.css`	10.7 kB	+5 B (0%)
`build/block-library/editor-rtl.css`	7.87 kB	+6 B (0%)
`build/block-library/editor.css`	7.87 kB	+5 B (0%)
`build/block-library/index.js`	129 kB	+3 B (0%)
`build/components/style-rtl.css`	15.9 kB	+11 B (0%)
`build/components/style.css`	15.8 kB	+11 B (0%)
`build/edit-post/style-rtl.css`	5.5 kB	+4 B (0%)
`build/edit-post/style.css`	5.5 kB	+5 B (0%)
`build/editor/style-rtl.css`	3.81 kB	+4 B (0%)
`build/editor/style.css`	3.81 kB	+3 B (0%)
`build/format-library/style-rtl.css`	547 B	+5 B (0%)
`build/format-library/style.css`	548 B	+5 B (0%)
`build/list-reusable-blocks/style-rtl.css`	450 B	+4 B (0%)
`build/list-reusable-blocks/style.css`	451 B	+4 B (0%)
`build/nux/style-rtl.css`	663 B	+1 B
`build/nux/style.css`	660 B	+3 B (0%)

ℹ️ View Unchanged

Filename	Size	Change
`build/a11y/index.js`	1.14 kB	0 B
`build/annotations/index.js`	3.62 kB	0 B
`build/api-fetch/index.js`	3.4 kB	0 B
`build/autop/index.js`	2.83 kB	0 B
`build/blob/index.js`	620 B	0 B
`build/block-directory/index.js`	7.26 kB	0 B
`build/block-directory/style-rtl.css`	937 B	0 B
`build/block-directory/style.css`	937 B	0 B
`build/block-library/style-rtl.css`	8 kB	0 B
`build/block-library/style.css`	8.01 kB	0 B
`build/block-library/theme-rtl.css`	730 B	0 B
`build/block-library/theme.css`	732 B	0 B
`build/block-serialization-default-parser/index.js`	1.88 kB	0 B
`build/block-serialization-spec-parser/index.js`	3.1 kB	0 B
`build/blocks/index.js`	48.1 kB	0 B
`build/components/index.js`	196 kB	0 B
`build/compose/index.js`	9.6 kB	0 B
`build/core-data/index.js`	11.4 kB	0 B
`build/data-controls/index.js`	1.29 kB	0 B
`build/data/index.js`	8.44 kB	0 B
`build/date/index.js`	5.47 kB	0 B
`build/deprecated/index.js`	772 B	0 B
`build/dom-ready/index.js`	569 B	0 B
`build/dom/index.js`	3.17 kB	0 B
`build/edit-navigation/index.js`	8.26 kB	0 B
`build/edit-navigation/style-rtl.css`	1.02 kB	0 B
`build/edit-navigation/style.css`	1.02 kB	0 B
`build/edit-post/index.js`	303 kB	0 B
`build/edit-site/index.js`	16.6 kB	0 B
`build/edit-site/style-rtl.css`	3.03 kB	0 B
`build/edit-site/style.css`	3.03 kB	0 B
`build/edit-widgets/index.js`	9.33 kB	0 B
`build/edit-widgets/style-rtl.css`	2.43 kB	0 B
`build/edit-widgets/style.css`	2.43 kB	0 B
`build/editor/editor-styles-rtl.css`	468 B	0 B
`build/editor/editor-styles.css`	469 B	0 B
`build/editor/index.js`	44.8 kB	0 B
`build/element/index.js`	4.65 kB	0 B
`build/escape-html/index.js`	733 B	0 B
`build/format-library/index.js`	7.72 kB	0 B
`build/hooks/index.js`	2.13 kB	0 B
`build/html-entities/index.js`	622 B	0 B
`build/i18n/index.js`	3.56 kB	0 B
`build/is-shallow-equal/index.js`	711 B	0 B
`build/keyboard-shortcuts/index.js`	2.51 kB	0 B
`build/keycodes/index.js`	1.94 kB	0 B
`build/list-reusable-blocks/index.js`	3.12 kB	0 B
`build/media-utils/index.js`	5.29 kB	0 B
`build/notices/index.js`	1.79 kB	0 B
`build/nux/index.js`	3.4 kB	0 B
`build/plugins/index.js`	2.56 kB	0 B
`build/primitives/index.js`	1.5 kB	0 B
`build/priority-queue/index.js`	788 B	0 B
`build/redux-routine/index.js`	2.85 kB	0 B
`build/rich-text/index.js`	14 kB	0 B
`build/server-side-render/index.js`	2.68 kB	0 B
`build/shortcode/index.js`	1.7 kB	0 B
`build/token-list/index.js`	1.28 kB	0 B
`build/url/index.js`	4.06 kB	0 B
`build/viewport/index.js`	1.85 kB	0 B
`build/warning/index.js`	1.14 kB	0 B
`build/wordcount/index.js`	1.17 kB	0 B

_{compressed-size-action}

spacedmonkey · 2020-05-27T22:34:24Z

docs/rfc/block-registration.md

+* Type: `object`
+* Optional
+* Localized: No
+* Property: `providesContext`


Does this property map to provides_context in PHP?

Does this property map to provides_context in PHP?

Technically there's no mapping today, but I've mentioned it in the original comment as a potential blocking decision:

A decision at #22519 (comment) in regards to registering block types using snake-cased provides_context, rather than camel-cased providesContext.

spacedmonkey · 2020-05-27T22:36:06Z

docs/rfc/block-registration.md

+* Type: `string[]`
+* Optional
+* Localized: No
+* Property: `context`


I don't like this naming. Context is already in use in the REST API and it reusing this naming is super confusing.
If I make a request to /wp/v2/block-type/?context=edit what do I get. The request in an edit context and block files by context === edit. Confusing. Can we use another name here?

How about the naming block_context?

Interesting, it's a completely different concept from what REST API uses. It didn't occur to me earlier that the name might be too general, it's more like:

dataContext or externalAttributes

providesAttributes

I'm curious to hear how @aduth views it.

I'd consider "context" a fairly generic term of the likes of "type", and the relationship between blocks and the REST API is incidental enough that—outside this specific collision—I can't imagine there'd be a high likelihood for confusion of the two.

Conversely, as I understand from some of early discussions like in #19685, there's an intentional overlap of the name it and the concept of Context in React which it mimics (and uses for implementation in the client).

I'm not especially attached to the name, but it wasn't really the intent of the pull request to be introducing the concept, moreso to bring this document into alignment with what had already been implemented across discussions and iterations of #19685, #19572, and #21467.

There's some interesting merit to thinking about this in terms of "attributes provided from some ancestor" and potentially naming around that, though even that may restrict some options for how context could expand in the future (see #19685 (comment), #19685 (comment)).

Since there's far more impact to a decision than what's affected here, I'd rather weigh it in its own dedicated space (an issue or editor meeting discussion).

Context is already in use in core and to add this here would be really confusing. Please can we just rename it?

docs/rfc/block-registration.md

gziolo

Thank you for adding missing support for the block context. Overall it looks good. We just need to decide whether context is a good fit here 👍

aduth · 2020-05-28T18:31:48Z

Per #22686 (comment) and #22686 (comment), I documented default values in d255bb0.

A couple additional notes:

There's no precedent elsewhere in the document for specifying default values. That said, it seems like it would be a good thing to do, assuming there are sensible defaults, like what are now provided through the REST endpoint.
It will also depend on effort like in Trac#48529 to ensure those default are in-fact applied.

lib/class-wp-rest-block-types-controller.php

gziolo · 2020-06-15T16:09:01Z

@spacedmonkey, I applied changes to unblock this PR per your feedback. Does it work as is?

We still need to decide on about the block registry:

A decision at #22519 (comment) in regards to registering block types using snake-cased provides_context, rather than camel-cased providesContext.

I believe it can be tackled separately though. From the perspective of the REST API endpoint. everything seems fine.

lib/class-wp-rest-block-types-controller.php

spacedmonkey · 2020-06-16T09:34:31Z

@aduth Should we be able to filter the block by these context? So add ?use_context=widgets? It would be a nice tweak.

lib/class-wp-rest-block-types-controller.php

…_context`

Co-authored-by: Miguel Fonseca <[email protected]>

mcsf · 2020-06-19T14:19:54Z

gziolo merged commit

🎉

Nice collab here.

New block context related fields were added as part of WordPress/gutenberg#22686. This changest backports them to WP_Block_Type class. Props aduth, spacedmonkey, mcsf, epiqueras. Fixes #47656. git-svn-id: https://develop.svn.wordpress.org/trunk@48117 602fd350-edb4-49c9-b593-d223f7449a82

New block context related fields were added as part of WordPress/gutenberg#22686. This changest backports them to WP_Block_Type class. Props aduth, spacedmonkey, mcsf, epiqueras. Fixes #47656. Built from https://develop.svn.wordpress.org/trunk@48117 git-svn-id: http://core.svn.wordpress.org/trunk@47886 1a063a9b-81f0-0310-95a4-ce76da25c4cd

New block context related fields were added as part of WordPress/gutenberg#22686. This changest backports them to WP_Block_Type class. Props aduth, spacedmonkey, mcsf, epiqueras. Fixes #47656. Built from https://develop.svn.wordpress.org/trunk@48117 git-svn-id: https://core.svn.wordpress.org/trunk@47886 1a063a9b-81f0-0310-95a4-ce76da25c4cd

New block context related fields were added as part of WordPress/gutenberg#22686. This changest backports them to WP_Block_Type class. Props aduth, spacedmonkey, mcsf, epiqueras. Fixes #47656. git-svn-id: https://develop.svn.wordpress.org/trunk@48117 602fd350-edb4-49c9-b593-d223f7449a82

aduth added [Type] Enhancement A suggestion for improvement. REST API Interaction Related to REST API labels May 27, 2020

aduth requested review from spacedmonkey and gziolo May 27, 2020 22:17

aduth requested review from ajitbohra, chrisvanpatten and TimothyBJacobs as code owners May 27, 2020 22:17

spacedmonkey reviewed May 27, 2020

View reviewed changes

docs/rfc/block-registration.md Outdated Show resolved Hide resolved

spacedmonkey reviewed May 27, 2020

View reviewed changes

docs/rfc/block-registration.md Outdated Show resolved Hide resolved

gziolo reviewed May 28, 2020

View reviewed changes

docs/rfc/block-registration.md Outdated Show resolved Hide resolved

gziolo reviewed May 28, 2020

View reviewed changes

spacedmonkey reviewed Jun 15, 2020

View reviewed changes

lib/class-wp-rest-block-types-controller.php Outdated Show resolved Hide resolved

gziolo force-pushed the add/block-types-context-fields branch from d255bb0 to d438cac Compare June 15, 2020 15:58

gziolo self-assigned this Jun 15, 2020

spacedmonkey reviewed Jun 16, 2020

View reviewed changes

lib/class-wp-rest-block-types-controller.php Outdated Show resolved Hide resolved

gziolo mentioned this pull request Jun 16, 2020

Add back providesContext block attribute #23212

Closed

6 tasks

spacedmonkey reviewed Jun 16, 2020

View reviewed changes

lib/class-wp-rest-block-types-controller.php Outdated Show resolved Hide resolved

gziolo mentioned this pull request Jun 17, 2020

Add parsing and validation for block.json files tellyworth/plugin-directory-old-experiment#2

Merged

gziolo force-pushed the add/block-types-context-fields branch 2 times, most recently from e760fd1 to e5a946c Compare June 18, 2020 11:06

aduth requested review from mkaz, nerrad, ntwb and Soean as code owners June 18, 2020 11:06

aduth and others added 12 commits June 19, 2020 13:55

RFC: Add default context properties

fdcc588

Rename context to use_context when using inside REST API

3a20c98

Include context properties in the RFC example

fdb4102

Go with uses_context in REST API

c7110db

Follow PHP convention for naming fields: provides_context and `uses…

117cadd

…_context`

Fix the usage of blockType.context in JS code

a955672

Docs: Add deprecation entry for Block Context changes

f470394

Fix missed places where context was not renamed to usesContext

4d65160

Add deprecation logic

92340dc

Remove an empty line

e5d0df3

Add more deprecation details

8c831ef

Apply suggestions from code review

18002bb

Co-authored-by: Miguel Fonseca <[email protected]>

gziolo force-pushed the add/block-types-context-fields branch from e098182 to 18002bb Compare June 19, 2020 11:56

gziolo requested a review from epiqueras June 19, 2020 11:58

Update compat.php

6843314

gziolo merged commit c33a5a5 into master Jun 19, 2020

gziolo deleted the add/block-types-context-fields branch June 19, 2020 13:58

github-actions bot added this to the Gutenberg 8.4 milestone Jun 19, 2020

gziolo added the Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Jun 22, 2020

gziolo mentioned this pull request Jun 22, 2020

Blocks: Update block registration default values #23348

Merged

This was referenced Jun 24, 2020

Release/8.4 #23410

Closed

Bump plugin version to 8.4.0-rc.2 #23412

Merged

gziolo removed the Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Jul 8, 2020

kwight mentioned this pull request Jul 15, 2020

Premium Content: Tidy up deprecation errors. Automattic/wp-calypso#44192

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add context properties to block types REST endpoint #22686

Add context properties to block types REST endpoint #22686

aduth commented May 27, 2020 •

edited by gziolo

Loading

github-actions bot commented May 27, 2020 •

edited

Loading

spacedmonkey May 27, 2020

aduth May 28, 2020

spacedmonkey May 27, 2020

spacedmonkey May 27, 2020

gziolo May 28, 2020

aduth May 28, 2020

spacedmonkey Jun 16, 2020

gziolo left a comment

aduth commented May 28, 2020

gziolo commented Jun 15, 2020

spacedmonkey commented Jun 16, 2020

mcsf commented Jun 19, 2020

Add context properties to block types REST endpoint #22686

Add context properties to block types REST endpoint #22686

Conversation

aduth commented May 27, 2020 • edited by gziolo Loading

github-actions bot commented May 27, 2020 • edited Loading

spacedmonkey May 27, 2020

Choose a reason for hiding this comment

aduth May 28, 2020

Choose a reason for hiding this comment

spacedmonkey May 27, 2020

Choose a reason for hiding this comment

spacedmonkey May 27, 2020

Choose a reason for hiding this comment

gziolo May 28, 2020

Choose a reason for hiding this comment

aduth May 28, 2020

Choose a reason for hiding this comment

spacedmonkey Jun 16, 2020

Choose a reason for hiding this comment

gziolo left a comment

Choose a reason for hiding this comment

aduth commented May 28, 2020

gziolo commented Jun 15, 2020

spacedmonkey commented Jun 16, 2020

mcsf commented Jun 19, 2020

aduth commented May 27, 2020 •

edited by gziolo

Loading

github-actions bot commented May 27, 2020 •

edited

Loading