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

Form: Remove old block editor back-compat code and improve code quality #41348

Merged
merged 7 commits into from
Jan 28, 2025

Conversation

talldan
Copy link
Contributor

@talldan talldan commented Jan 28, 2025

Follows up on code review comments from @ntsekouras in #41274

Again, this is a fairly big diff, but most of it is moving code 😅

Proposed changes:

  • Remove old back compat code from the form block (e.g. checking whether APIs like getDefaultBlockVariation exist before using them). These APIs have been in the WordPress codebase for many versions now.
  • Switch to using imported store names (import { store as blockEditorStore } from '@wordpress/block-editor';) instead of hard coded store names 'core/block-editor'.
  • Extract the variation placeholder code into a separate component
  • Use the useInnerBlocksProps hook instead of the InnerBlocks components. This removes one of the <div> elements from the editor markup.

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)?

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

No

Testing instructions:

  1. Add a 'Form' block
  2. Check that all the placeholder options work - selecting different form variations and inserting patterns
  3. Insert 'Contact Form' or other variations directly and check that still works.

Copy link
Contributor

github-actions bot commented Jan 28, 2025

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 update/contact-form-block-code-quality branch.

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

    bin/jetpack-downloader test jetpack update/contact-form-block-code-quality
    

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 github-actions bot added the [Block] Contact Form Form block (also see Contact Form label) label Jan 28, 2025
Copy link
Contributor

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@talldan talldan requested a review from ntsekouras January 28, 2025 07:34
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.

Tests well for me. 🚢

@jeherve jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Team Review labels Jan 28, 2025
@kraftbj kraftbj merged commit fd115d1 into trunk Jan 28, 2025
66 checks passed
@kraftbj kraftbj deleted the update/contact-form-block-code-quality branch January 28, 2025 17:53
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Jan 28, 2025
@ntsekouras
Copy link
Member

Thank you Dan!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants