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 payment-related blocks registration #33941

Merged
merged 15 commits into from
Nov 8, 2023

Conversation

monsieur-z
Copy link
Contributor

@monsieur-z monsieur-z commented Nov 2, 2023

Proposed changes:

This PR is a follow up of #33842, which was reverted in #33895. The differences between the 2 PRs are the following:

  • The simple payments block API version was set to 1 (this was done in Fix unresponsive Simple Payment block #33889).
  • The default value of the currency attribute for the same block was set to USD (replacing an invalid value).

See p1698765346173339-slack-C052XEUUBL4 for more details.

Below's the description of the original PR.

Registers the following production blocks by specifying the path to their block.json file: Payments Intro, Paywall, Premium Content, Recurring Payment, Simple Payment, Subscriptions.

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.
  • Optionally, test these blocks on a simple site

Copy link
Contributor

github-actions bot commented Nov 2, 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/payment-blocks-registration-2 branch.

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

    bin/jetpack-downloader test jetpack refactor/payment-blocks-registration-2
    

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

Copy link
Contributor

github-actions bot commented Nov 2, 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 December 5, 2023 (scheduled code freeze on November 28, 2023).

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

@monsieur-z monsieur-z requested a review from a team November 2, 2023 19:51
@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 and removed [Status] In Progress labels Nov 2, 2023
@monsieur-z monsieur-z self-assigned this Nov 2, 2023
@monsieur-z monsieur-z added this to the jetpack/12.9 milestone Nov 2, 2023
@monsieur-z monsieur-z changed the title Refactor/payment blocks registration 2 Refactor payment-related blocks registration Nov 2, 2023
@monsieur-z monsieur-z marked this pull request as ready for review November 2, 2023 19:53
@anomiex
Copy link
Contributor

anomiex commented Nov 2, 2023

LGTM, the issue with the payment block is fixed now in some manual tests. Remind me to approve this after 12.8 is cut, it's too close right now for me to feel comfortable trying this again now.

@anomiex
Copy link
Contributor

anomiex commented Nov 6, 2023

Ok, 12.8 is out. This needs a trunk merge now, then we can give it a try.

@monsieur-z monsieur-z force-pushed the refactor/payment-blocks-registration-2 branch from 86667ea to 06f1820 Compare November 7, 2023 15:31
anomiex
anomiex previously approved these changes Nov 7, 2023
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 for me. 🚢

@jeherve jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] In Progress [Status] Needs Team Review labels Nov 8, 2023
@jeherve jeherve merged commit 560ba86 into trunk Nov 8, 2023
53 of 55 checks passed
@jeherve jeherve deleted the refactor/payment-blocks-registration-2 branch November 8, 2023 14:23
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Nov 8, 2023
@@ -1,8 +1,12 @@
import { unregisterBlockType } from '@wordpress/blocks';
import { subscribe, select } from '@wordpress/data';
import { store as editorStore } from '@wordpress/editor';
import registerJetpackBlock from '../../shared/register-jetpack-block';
import { name, settings } from '.';
Copy link
Contributor

@fluiddot fluiddot Nov 23, 2023

Choose a reason for hiding this comment

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

👋 @monsieur-z, I noticed that name is being used in line 21:

unregisterBlockType( 'jetpack/' + name );

This produces a crash in the Jetpack app. Could we revert this change and keep the name property?
Thanks 🙇 !

Copy link
Contributor

Choose a reason for hiding this comment

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

I went ahead and created a PR to fix this: #34274.
Let me know if you could take a quick look, thanks 🙇 !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Paid Content aka Premium Content [Block] Pay With Paypal aka Simple Payments [Block] Payments Intro [Block] Payments aka Unified Intro [Block] Paywall [Block] Subscriptions [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
None yet
Development

Successfully merging this pull request may close these issues.

4 participants