Enable block registration by specifying the path to block.json #32697

monsieur-z · 2023-08-25T19:29:35Z

Proposed changes:

Allows the registration of blocks by passing the path to the block.json metadata file to Blocks::jetpack_register_block.

In more details:

In PHP
- Update Blocks::jetpack_register_block and Jetpack_Gutenberg::load_assets_as_required to accept a path as first argument
- Add helper methods
- Add unit tests
In JS
- Make sure the beta mention is only rendered once
- Make registerJetpackBlock accept both prefixed and unprefixed names

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

pedMtX-RS-p2

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

Regression testing:

Check that Jetpack blocks are still working as expected

Functional testing:

Test in coordination with Refactor: register business hours block with block.json path #32698

github-actions · 2023-08-25T19:30:26Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta > Jetpack and enable the add/enable-block-registration-by-path branch.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack add/enable-block-registration-by-path

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

github-actions · 2023-08-25T19:30:57Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
⚠️ All commits were linted before commit.
✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Jetpack plugin:

Next scheduled release: September 19, 2023.
Scheduled code freeze: September 11, 2023.

projects/plugins/jetpack/extensions/shared/register-jetpack-block.js

projects/plugins/jetpack/extensions/editor.js

andrii-lysenko · 2023-08-28T19:06:31Z

projects/packages/blocks/src/class-blocks.php

@@ -99,7 +115,53 @@ function () use ( $feature_name, $method_name ) {
 			}
 		}

-		return register_block_type( $slug, $args );
+		return register_block_type( isset( $block_type ) ? $block_type : $slug, $args );


Just a small nitpick, maybe we could avoid using the ternary operator inside the function call and instead declare some new variable using it there.

Sure thing. I'm just curious why: is it a WordPress or A8C best practice?

I'm not sure if it is a formal "best practice", but I can see where it is harder to parse while reading what is being returned with the operator in there.

projects/packages/blocks/src/class-blocks.php

andrii-lysenko

The changes looks reasonable and good aside of some questions. However, I'm not having as much experience so suggest for an additional pair of eyes on this one. Maybe @jeherve or @kraftbj could take a look?

projects/packages/blocks/src/class-blocks.php

projects/plugins/jetpack/extensions/editor.js

projects/plugins/jetpack/extensions/shared/register-jetpack-block.js

kraftbj · 2023-09-01T20:25:43Z

Unit test failures

Unexpected incorrect usage notice for jetpack_register_block.
Prefix the block with jetpack/ (This message was added in version Jetpack 9.0.0.)
Unexpected incorrect usage notice for WP_Block_Type_Registry::register.
Block type names must contain a namespace prefix. Example: my-plugin/my-custom-block-type (This message was added in version 5.0.0.)
Failed asserting that an array is empty.

jeherve

This looks good to me now, it should be good to go imo!

projects/packages/blocks/src/class-blocks.php

Co-authored-by: Jeremy Herve <jeremy@jeremy.hu>

Following #32697, 'registerJetpackBlockFromMetadata' is now used to register some Jetpack blocks from metadata. As such, we need to support that functionality on native. With this commit, the function has been copied/pasted to the native file for use registering Jetpack blocks in the app.

github-actions bot added [Package] Blocks [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Aug 25, 2023

monsieur-z commented Aug 25, 2023

View reviewed changes

projects/plugins/jetpack/extensions/shared/register-jetpack-block.js Show resolved Hide resolved

monsieur-z commented Aug 25, 2023

View reviewed changes

projects/plugins/jetpack/extensions/editor.js Show resolved Hide resolved

monsieur-z mentioned this pull request Aug 25, 2023

Refactor: register business hours block with block.json path #32698

Merged

3 tasks

monsieur-z requested a review from a team August 25, 2023 20:40

monsieur-z self-assigned this Aug 25, 2023

monsieur-z added the [Status] Needs Team Review label Aug 25, 2023

monsieur-z marked this pull request as ready for review August 25, 2023 20:40

monsieur-z removed the [Status] In Progress label Aug 25, 2023

github-actions bot added the [Status] In Progress label Aug 25, 2023

monsieur-z removed the [Status] In Progress label Aug 28, 2023

monsieur-z force-pushed the add/enable-block-registration-by-path branch from 2d37e5e to 61f2abf Compare August 28, 2023 17:55

andrii-lysenko reviewed Aug 28, 2023

View reviewed changes

projects/packages/blocks/src/class-blocks.php Show resolved Hide resolved

andrii-lysenko reviewed Aug 28, 2023

View reviewed changes

kraftbj self-requested a review August 28, 2023 19:32

jeherve reviewed Aug 29, 2023

View reviewed changes

jeherve added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Pri] Normal labels Aug 29, 2023

github-actions bot added the [Tests] Includes Tests label Aug 29, 2023

monsieur-z requested a review from jeherve August 29, 2023 22:10

monsieur-z force-pushed the add/enable-block-registration-by-path branch 2 times, most recently from bfcfea7 to 100c54d Compare August 31, 2023 17:07

kraftbj added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Team Review labels Sep 1, 2023

jeherve previously approved these changes Sep 6, 2023

View reviewed changes

jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Team Review labels Sep 6, 2023

jeherve reviewed Sep 6, 2023

View reviewed changes

projects/packages/blocks/src/class-blocks.php Outdated Show resolved Hide resolved

Use Exception root namespace

e7c4f98

Co-authored-by: Jeremy Herve <jeremy@jeremy.hu>

monsieur-z dismissed jeherve’s stale review via e7c4f98 September 6, 2023 13:55

jeherve approved these changes Sep 6, 2023

View reviewed changes

monsieur-z merged commit 97c70c3 into trunk Sep 6, 2023
53 of 54 checks passed

monsieur-z deleted the add/enable-block-registration-by-path branch September 6, 2023 14:37

github-actions bot added this to the jetpack/12.6 milestone Sep 6, 2023

github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Sep 6, 2023

This was referenced Sep 7, 2023

Refactor beta blocks registration #32815

Merged

Refactor registration of experimental blocks #32942

Closed

Refactor registration of experimental blocks #33073

Merged

Refactor production blocks registration 1 #33086

Merged

This was referenced Sep 19, 2023

Update jetpack CLI command to generate new blocks using block.json #33173

Closed

Blocks: Switch all Production blocks to be registered via their block.json file #33174

Closed

This was referenced Oct 11, 2023

Refactor production blocks registration 2 #33573

Merged

Refactor production blocks registration 3 #33604

Merged

Refactor production blocks registration 4 #33667

Merged

This was referenced Oct 19, 2023

Refactor production blocks registration 5 #33682

Merged

Refactor production blocks registration 6 #33689

Merged

Refactor production blocks registration 7 #33694

Merged

This was referenced Oct 27, 2023

Refactor blocks registration 4 #33840

Merged

Refactor payment-related blocks registration #33842

Merged

Refactor Instagram Gallery block registration #33884

Merged

This was referenced Oct 31, 2023

[RNMobile] Fix broken block registration #33890

Merged

Fix broken Jetpack block registration wordpress-mobile/gutenberg-mobile#6342

Merged

monsieur-z mentioned this pull request Nov 2, 2023

Refactor payment-related blocks registration #33941

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable block registration by specifying the path to block.json #32697

Enable block registration by specifying the path to block.json #32697

monsieur-z commented Aug 25, 2023 •

edited

github-actions bot commented Aug 25, 2023 •

edited

github-actions bot commented Aug 25, 2023 •

edited

andrii-lysenko Aug 28, 2023

monsieur-z Aug 29, 2023

kraftbj Aug 29, 2023

andrii-lysenko left a comment

kraftbj commented Sep 1, 2023

jeherve left a comment

Enable block registration by specifying the path to block.json #32697

Enable block registration by specifying the path to block.json #32697

Conversation

monsieur-z commented Aug 25, 2023 • edited

Proposed changes:

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

github-actions bot commented Aug 25, 2023 • edited

github-actions bot commented Aug 25, 2023 • edited

andrii-lysenko Aug 28, 2023

Choose a reason for hiding this comment

monsieur-z Aug 29, 2023

Choose a reason for hiding this comment

kraftbj Aug 29, 2023

Choose a reason for hiding this comment

andrii-lysenko left a comment

Choose a reason for hiding this comment

kraftbj commented Sep 1, 2023

jeherve left a comment

Choose a reason for hiding this comment

monsieur-z commented Aug 25, 2023 •

edited

github-actions bot commented Aug 25, 2023 •

edited

github-actions bot commented Aug 25, 2023 •

edited