Extensions: add a new option to deliver an "Experimental" subset of blocks. #14104

jeherve · 2019-11-22T12:18:45Z

Changes proposed in this Pull Request:

We currently have 2 options when building and loading Jetpack blocks in the editor:
- Production blocks
- Beta blocks (loading production blocks and a small set of Beta blocks), available when using the JETPACK_BETA_BLOCKS constant.

This PR introduces a third option, aka variation, named "Experimental". This option loads both production blocks and a set of experimental blocks. It is automatically enabled if you use the Gutenberg plugin or the Full Site Editing plugin on your site. In practice, that would make that option available on all Atomic sites right away. The option can also be used when you don't use those plugins, via the JETPACK_EXPERIMENTAL_BLOCKS constant.

Is this a new feature or does it add/remove features to an existing part of Jetpack?

Internal reference: p4hfux-50G-p2#comment-7336

cc @dereksmart @kraftbj since we recently discussed different options.

Testing instructions:

Check out this PR.
Add define( 'JETPACK_BETA_BLOCKS', true ); to your site's wp-config.php file and make sure you can still see all blocks, including the Pinterest block (currently in Beta).
Remove that line.
Add define( 'JETPACK_EXPERIMENTAL_BLOCKS', true ); to your site's wp-config.php file and make sure you cannot still see the Pinterest block (currently in Beta).
Remove that line.
Activate the Gutenberg plugin.
Make sure you still cannot see the Pinterest block (currently in Beta).
Use yarn docker:wp jetpack scaffold block jeremy --variation="experimental" to create a brand new block.
Run yarn build-extensions to build that new block.
Make sure that:
- that block was added to the experimental subset in extensions/index.json
- that block is available to you as long as the Gutenberg plugin is active.
- that block disappears from the block picker as soon as you deactivate Gutenberg.

Proposed changelog entry for your changes:

Extensions: add a new option to deliver an "Experimental" subset of blocks.

This will allow one to get a different list of extensions based on different parameters: - plugin active - constant - filter

We now build 3 bundles: - The default production bundle with just the production blocks. - The experimental bundle with production blocks as well as experimental blocks. - The beta bundle with all the blocks: production, experimental, and beta.

- When using the experimental variation, we need both prod and experimental blocks. - When using beta blocks, we need all blocks.

jetpackbot · 2019-11-22T12:21:56Z

Thank you for the great PR description!

When this PR is ready for review, please apply the [Status] Needs Review label. If you are an a11n, please have someone from your team review the code if possible. The Jetpack team will also review this PR and merge it to be included in the next Jetpack release.

Scheduled Jetpack release: January 14, 2020.
Scheduled code freeze: January 7, 2020

Generated by 🚫 dangerJS against 8f12adb

extensions/README.md

see https://github.com/Automattic/jetpack/pull/14104/files#r349585798

class.jetpack-gutenberg.php

See #14104 (comment)

kraftbj

This all works well with virtually all documentation suggestions. Once the confirmation text on the CLI command is updated at least, ready to merge.

class.jetpack-cli.php

kraftbj · 2019-12-19T00:58:56Z

webpack.config.extensions.js

+	...presetProductionBlocks,
+	..._.get( presetIndex, [ 'experimental' ], [] ),
+];
+const presetBetaBlocks = [ ...presetExperimentalBlocks, ..._.get( presetIndex, [ 'beta' ], [] ) ];


To me, when I hear "experimental", I think almost like it is "alpha" code and so seeing that experimental blocks are included in beta at first feels like the opposite of expectation.

With the block set meant to roll on special platforms (e.g. our Atomic infra), it makes sense since we don't want to roll beta out to them.

If there isn't a better word other than experimental, let's be very explicit that beta blocks includes experimental everywhere we discuss the concept or the constant.

Yeah, "experimental" may not be the best word for it. That's all I could come up with though :\

extensions/README.md

kraftbj

This all works well with virtually all documentation suggestions. Once the confirmation text on the CLI command is updated at least, ready to merge.

kraftbj · 2019-12-19T01:08:21Z

Also, in thinking about this as a set of blocks expecting the latest version of WP and/or the Gutenberg plugin, should we just call a spade and a spade and check for that?

Ensure the latest version of Gutenberg is installed (as a MVP we can hardcode the version and document that it should be bumped as new code is merged) before loading the experimental set? Since the beta package would have the same requirement, do we need to do that?

Or is that something that we document is the expectation (beta or experimental blocks expect Gutenberg and expect it to be kept up to date?)

See #14104 (comment)

kraftbj · 2019-12-19T16:18:47Z

Thanks for the updates! I'm good with this, so merge when you're happy!

jeherve · 2019-12-19T16:24:57Z

in thinking about this as a set of blocks expecting the latest version of WP and/or the Gutenberg plugin, should we just call a spade and a spade and check for that?

This was my first thought as well, but I ended up rollbacking based on our discussion in #14104 (comment)

I am happy to take a third approach though: have experimental blocks enabled if you use the constant AND the latest version of WP AND the latest version of Gutenberg. This way we wouldn't have to take any extra precautions when working on those blocks?

I'll merge this for now and we can iterate later.

matticbot · 2019-12-19T16:29:43Z

Caution: This PR has changes that must be merged to WordPress.com
Hello jeherve! These changes need to be synced to WordPress.com - If you 're an a11n, please commandeer, review, and approve D36968-code before merging this PR. Thank you!

kraftbj · 2019-12-19T17:00:02Z

Sounds good. I don't have a dog in the fight, just want to be sure we're setting the stage right if those blocks realistically are expecting latest Gutenberg.

Follow-up from #14104. In some environments (like on WordPress.com), it may be easier to use a filter to change the way we load blocks.

jeherve added 6 commits November 22, 2019 12:36

Extensions: allow fetching a different subset of extensions

f371077

This will allow one to get a different list of extensions based on different parameters: - plugin active - constant - filter

Load a different extensions bundle based on your block variation

23bfd93

Update readme to mention new experimental blocks variation

8cf336b

Fix typo in extension scaffolding command

fb33c1f

Make sure we whitelist all necessary blocks

7c52d16

- When using the experimental variation, we need both prod and experimental blocks. - When using beta blocks, we need all blocks.

jeherve added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] In Progress [Pri] Normal [Focus] Blocks Issues related to the block editor, aka Gutenberg, and its extensions developed in Jetpack Build labels Nov 22, 2019

jeherve added this to the 8.1 milestone Nov 22, 2019

jeherve requested a review from a team as a code owner November 22, 2019 12:18

jeherve self-assigned this Nov 22, 2019

matticbot added the Touches WP.com Files label Nov 22, 2019

Add new variation option to scaffold block CLI tool

36bb004

jeherve added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] In Progress labels Nov 22, 2019

simison reviewed Nov 22, 2019

View reviewed changes

extensions/README.md Outdated Show resolved Hide resolved

mkaz mentioned this pull request Nov 22, 2019

Add Event Countdown and Timeline blocks Automattic/wp-calypso#37889

Merged

Only load experimental blocks when using the constant.

ce966f4

see https://github.com/Automattic/jetpack/pull/14104/files#r349585798

kraftbj requested changes Dec 16, 2019

View reviewed changes

class.jetpack-gutenberg.php Outdated Show resolved Hide resolved

Allow filter to overwrite any block variation

258350b

See #14104 (comment)

kraftbj requested changes Dec 19, 2019

View reviewed changes

jeherve added 2 commits December 19, 2019 16:48

Display different success message depending on block variation

be04755

See #14104 (comment)

Clarify contents of experimental bundle in comments and readme

8f12adb

See #14104 (comment)

kraftbj approved these changes Dec 19, 2019

View reviewed changes

kraftbj added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Dec 19, 2019

jeherve merged commit c9e2901 into master Dec 19, 2019

jeherve deleted the add/experimental-block-variation branch December 19, 2019 16:31

matticbot added [Status] Needs Changelog and removed [Status] Ready to Merge Go ahead, you can push that green button! labels Dec 19, 2019

jeherve mentioned this pull request Dec 19, 2019

Experimental blocks: gate the block availability behind WP and Gutenberg checks #14267

Open

jeherve removed the [Status] Needs Changelog label Dec 20, 2019

jeherve added a commit that referenced this pull request Mar 6, 2020

Blocks: allow enabling Experimental blocks via a filter

240af35

Follow-up from #14104. In some environments (like on WordPress.com), it may be easier to use a filter to change the way we load blocks.

jeherve mentioned this pull request Mar 6, 2020

Blocks: allow enabling Experimental blocks via a filter #14908

Merged

kraftbj pushed a commit that referenced this pull request Mar 6, 2020

Blocks: allow enabling Experimental blocks via a filter (#14908)

557a85a

Follow-up from #14104. In some environments (like on WordPress.com), it may be easier to use a filter to change the way we load blocks.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extensions: add a new option to deliver an "Experimental" subset of blocks. #14104

Extensions: add a new option to deliver an "Experimental" subset of blocks. #14104

jeherve commented Nov 22, 2019 •

edited

Loading

jetpackbot commented Nov 22, 2019 •

edited

Loading

kraftbj left a comment

kraftbj Dec 19, 2019

jeherve Dec 19, 2019

kraftbj left a comment

kraftbj commented Dec 19, 2019

kraftbj commented Dec 19, 2019

jeherve commented Dec 19, 2019

matticbot commented Dec 19, 2019

kraftbj commented Dec 19, 2019

Extensions: add a new option to deliver an "Experimental" subset of blocks. #14104

Extensions: add a new option to deliver an "Experimental" subset of blocks. #14104

Conversation

jeherve commented Nov 22, 2019 • edited Loading

Changes proposed in this Pull Request:

Is this a new feature or does it add/remove features to an existing part of Jetpack?

Testing instructions:

Proposed changelog entry for your changes:

jetpackbot commented Nov 22, 2019 • edited Loading

kraftbj left a comment

Choose a reason for hiding this comment

kraftbj Dec 19, 2019

Choose a reason for hiding this comment

jeherve Dec 19, 2019

Choose a reason for hiding this comment

kraftbj left a comment

Choose a reason for hiding this comment

kraftbj commented Dec 19, 2019

kraftbj commented Dec 19, 2019

jeherve commented Dec 19, 2019

matticbot commented Dec 19, 2019

kraftbj commented Dec 19, 2019

jeherve commented Nov 22, 2019 •

edited

Loading

jetpackbot commented Nov 22, 2019 •

edited

Loading