Refactor production blocks registration 4 #33667

monsieur-z · 2023-10-18T19:07:10Z

Proposed changes:

Registers the following production blocks by specifying the path to their block.json file: Paywall, Pinterest, Podcast Player, Rating Star, Recurring Payments.

This was made possible by #32697. The goal is to avoid the duplication of block metadata and use block.json as the source of truth.

In more details, for each block (when needed):

Write reading direction-agnostic CSS
Remove the editorScript property from block.json (automatically added during the build)
Convert icon from dashicon to SVG in the icon property of block.json
Remove icon.js
Import icon helpers from the shared-extension-utils package
Register the block client and server sides with block.json
Move data from index.js to block.json and editor.js and delete the file
Move data from attributes.js to block.json and delete the file
Fix JS tests

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:

Spin up a test site
Create a new post and open the block inserter
Test that the aforementioned blocks behave as in trunk. This PR shouldn't change anything from a user's standpoint. You'll need to activate subscriptions to test the Paywall block.

Note: I couldn't test the Recurring Payments block.

github-actions · 2023-10-18T19:08:22Z

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.
✅ 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 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:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen daily.
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for November 7, 2023 (scheduled code freeze on October 30, 2023).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

github-actions · 2023-10-18T19:08:34Z

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, select your plugin, and enable the refactor/production-blocks-registration-4 branch.

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

bin/jetpack-downloader test jetpack refactor/production-blocks-registration-4

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

andrii-lysenko · 2023-10-24T15:09:11Z

projects/plugins/jetpack/extensions/blocks/pinterest/pinterest.php

-const FEATURE_NAME = 'pinterest';
-const BLOCK_NAME   = 'jetpack/' . FEATURE_NAME;
-const URL_PATTERN  = '#^https?://(?:www\.)?(?:[a-z]{2}\.)?pinterest\.[a-z.]+/pin/(?P<pin_id>[^/]+)/?#i'; // Taken from AMP plugin, originally from Jetpack.
+const URL_PATTERN = '#^https?://(?:www\.)?(?:[a-z]{2}\.)?pinterest\.[a-z.]+/pin/(?P<pin_id>[^/]+)/?#i'; // Taken from AMP plugin, originally from Jetpack.


Is it the same as URL_REGEX in constants ? Could it be reused?

Oh, or it's the one below

jeherve · 2023-10-24T16:51:14Z

projects/plugins/jetpack/extensions/blocks/payment-buttons/index.js

Would this be a rebase issue with #33604? The Payments button is modified there.

jeherve · 2023-10-24T16:59:52Z

projects/plugins/jetpack/extensions/blocks/podcast-player/edit.js

@@ -69,7 +69,7 @@ const PodcastPlayerEdit = ( {
 	replaceWithEmbedBlock,
 } ) => {
 	// Validated attributes.
-	const validatedAttributes = getValidatedAttributes( attributesValidation, attributes );
+	const validatedAttributes = getValidatedAttributes( metadata.attributes, attributes );


This causes the block to break. You can try to add a podcast URL to the block and you will get the following errors:

jeherve · 2023-10-24T17:01:35Z

projects/plugins/jetpack/extensions/blocks/rating-star/rating-star.php

I believe this may be causing a notice:

Warning: Undefined array key "ratingStyle" in /wp-content/plugins/jetpack-dev/extensions/blocks/rating-star/rating-meta.php on line 123

jeherve · 2023-10-24T17:03:32Z

projects/plugins/jetpack/extensions/blocks/recurring-payments/block.json

@@ -65,5 +65,5 @@
 			"type": "string"
 		}
 	},
-	"editorScript": "file:../editor.js"
+	"parent": [ "jetpack/payment-buttons" ]


This block is currently broken for me:

I also noticed this in console:

jeherve

Looks like the tests in extensions/blocks/rating-star/test/validate.js will need to be updated?

This reverts commit 4329dd4.

* Revert "Refactor production blocks registration 4 (#33667)" This reverts commit 4329dd4. * Remove removeInvalidProducts unused function * Remove entry from ESLint exclude list

monsieur-z added [Focus] Blocks Issues related to the block editor, aka Gutenberg, and its extensions developed in Jetpack [Status] Needs Team Review labels Oct 18, 2023

monsieur-z requested a review from a team October 18, 2023 19:07

monsieur-z self-assigned this Oct 18, 2023

monsieur-z mentioned this pull request Oct 18, 2023

Refactor/prod blocks registration 4 #33022

Closed

3 tasks

monsieur-z force-pushed the refactor/production-blocks-registration-4 branch from c0f755f to ab580cc Compare October 19, 2023 13:52

jeherve mentioned this pull request Oct 20, 2023

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

Closed

andrii-lysenko reviewed Oct 24, 2023

View reviewed changes

jeherve reviewed Oct 24, 2023

View reviewed changes

jeherve 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 Oct 24, 2023

monsieur-z force-pushed the refactor/production-blocks-registration-4 branch from ab580cc to 2bf0f75 Compare October 24, 2023 19:21

monsieur-z changed the base branch from trunk to refactor/production-blocks-registration-3 October 24, 2023 19:21

jeherve requested changes Oct 25, 2023

View reviewed changes

Base automatically changed from refactor/production-blocks-registration-3 to trunk October 25, 2023 12:29

github-actions bot added [Block] Donations [Block] Eventbrite [Block] GIF [Block] Google Calendar labels Oct 25, 2023

monsieur-z force-pushed the refactor/production-blocks-registration-4 branch from a4d1be2 to 4d6da24 Compare October 26, 2023 18:19

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

monsieur-z added 13 commits October 26, 2023 15:14

Refactor Donations block registration

763429a

Refactor OpenTable block registration

d433665

Fix OpenTable restaurant preview

73a17b8

Refactor Paywall block registration

5fff7bb

Refactor Pinterest block registration

594e35d

Refactor Podcast Player block registration

d184d93

Refactor Rating Star block registration

f555fa7

Refactor Recurring Payments block registration

cd96795

Add changelog

07adb1e

Fix Podcast Player rendering error

d584493

Add missing Rating Star block attributes

849932e

Fix Recurring Payments block rendering

a56f6d8

Update Rating Star test fixture

f9834de

monsieur-z force-pushed the refactor/production-blocks-registration-4 branch from 4d6da24 to f9834de Compare October 26, 2023 19:15

monsieur-z requested review from jeherve and andrii-lysenko October 26, 2023 19:15

jeherve approved these changes Oct 27, 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 Oct 27, 2023

jeherve merged commit 4329dd4 into trunk Oct 27, 2023
54 of 56 checks passed

jeherve deleted the refactor/production-blocks-registration-4 branch October 27, 2023 13:01

github-actions bot added this to the jetpack/12.8 milestone Oct 27, 2023

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

monsieur-z added a commit that referenced this pull request Oct 27, 2023

Revert "Refactor production blocks registration 4 (#33667)"

868f9c5

This reverts commit 4329dd4.

monsieur-z mentioned this pull request Oct 27, 2023

Revert "Refactor production blocks registration 4" #33837

Merged

monsieur-z mentioned this pull request Oct 27, 2023

Refactor blocks registration 4 #33840

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor production blocks registration 4 #33667

Refactor production blocks registration 4 #33667

monsieur-z commented Oct 18, 2023

github-actions bot commented Oct 18, 2023 •

edited

github-actions bot commented Oct 18, 2023 •

edited

andrii-lysenko Oct 24, 2023

andrii-lysenko Oct 24, 2023

jeherve Oct 24, 2023

jeherve Oct 24, 2023

jeherve Oct 24, 2023

jeherve Oct 24, 2023

andrii-lysenko Oct 24, 2023

jeherve left a comment

Refactor production blocks registration 4 #33667

Refactor production blocks registration 4 #33667

Conversation

monsieur-z commented Oct 18, 2023

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 Oct 18, 2023 • edited

github-actions bot commented Oct 18, 2023 • edited

andrii-lysenko Oct 24, 2023

Choose a reason for hiding this comment

andrii-lysenko Oct 24, 2023

Choose a reason for hiding this comment

jeherve Oct 24, 2023

Choose a reason for hiding this comment

jeherve Oct 24, 2023

Choose a reason for hiding this comment

jeherve Oct 24, 2023

Choose a reason for hiding this comment

jeherve Oct 24, 2023

Choose a reason for hiding this comment

andrii-lysenko Oct 24, 2023

Choose a reason for hiding this comment

jeherve left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 18, 2023 •

edited

github-actions bot commented Oct 18, 2023 •

edited