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

Refactor production blocks registration 5 #33682

Merged
merged 10 commits into from
Oct 30, 2023

Conversation

monsieur-z
Copy link
Contributor

@monsieur-z monsieur-z commented Oct 19, 2023

Proposed changes:

Registers the following production blocks by specifying the path to their block.json file: Related Posts, Repeat Visitor, Slideshow, Story.

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.

@monsieur-z 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 19, 2023
@monsieur-z monsieur-z requested a review from a team October 19, 2023 13:46
@monsieur-z monsieur-z self-assigned this Oct 19, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 19, 2023

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-5 branch.

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

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

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
Copy link
Contributor

github-actions bot commented Oct 19, 2023

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.

Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

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

This tests well. I only have a small question.

@@ -43,6 +43,7 @@
'wp-html-entities',
'wp-i18n',
'wp-is-shallow-equal',
'wp-plugins',
Copy link
Member

Choose a reason for hiding this comment

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

Did you add this in for the Story block? If we need to add this in here, maybe we could allow it just for the Story block, with a change to $allowed?

@monsieur-z monsieur-z force-pushed the refactor/production-blocks-registration-5 branch 2 times, most recently from f440ca4 to e0106b9 Compare October 26, 2023 19:13
Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

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

I'll let someone else review that one (@andrii-lysenko maybe), because I'm running into an issue with the Pay with PayPal block, and I'm not sure if it's something to do with my setup. I am experiencing the same problem when on trunk, and only on self-hosted (a new JN site and an existing WoA site). It works well on wpcom simple.

The block seems to work well in the editor, but I do not see it on the frontend. And when refreshing the block editor, the data in the block disappears.

This reverts commit e0106b9.
@monsieur-z monsieur-z force-pushed the refactor/production-blocks-registration-5 branch from 550e890 to 4721590 Compare October 27, 2023 18:05
@monsieur-z
Copy link
Contributor Author

UPDATE: I moved all payment-related changes to a separate PR. This PR now effectively changes the following blocks: Related Posts, Repeat Visitor, Slideshow, Story.

@jeherve jeherve merged commit 73e4112 into trunk Oct 30, 2023
56 checks passed
@jeherve jeherve deleted the refactor/production-blocks-registration-5 branch October 30, 2023 12:06
@github-actions github-actions bot added this to the jetpack/12.9 milestone Oct 30, 2023
@ice9js ice9js modified the milestones: jetpack/12.9, jetpack/12.8 Oct 31, 2023
jeherve added a commit that referenced this pull request Nov 7, 2023
Fixes #33958

In #33682, we removed FEATURE_NAME, even though we still relied on that constant downer in the file. This should now fix things.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Pay With Paypal aka Simple Payments [Block] Related Posts [Block] Repeat Visitor [Block] Slideshow [Block] Story [Focus] Blocks Issues related to the block editor, aka Gutenberg, and its extensions developed in Jetpack [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests
Projects
No open projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

None yet

3 participants