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

Forms: Make file upload field block available in beta and refine its behavior #41586

Merged
merged 6 commits into from
Feb 5, 2025

Conversation

lezama
Copy link
Contributor

@lezama lezama commented Feb 5, 2025

Fixes #

Proposed changes:

  • Updates the file upload field block from experimental to beta status
  • Uses the WordPress upload icon for better visual consistency
  • Prevents the file dialog from opening when clicking the field in the editor
  • Simplifies block registration to only handle beta blocks, removing experimental block handling
  • Updates PHP registration to match JavaScript block registration
  • Improves code organization by keeping the file upload field in the childBlocks array

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?

Testing instructions:

  1. Enable beta blocks by adding this to your 0-sandbox.php:

    define( 'JETPACK_BLOCKS_VARIATION', 'beta' );

    Or by using the filter:

    add_filter( 'jetpack_blocks_variation', function () { return 'beta'; } );
  2. Create or edit a post with the Jetpack Form block

  3. Add a new field to the form

  4. Verify that:

    • The File Upload field is available in the field options
    • The field uses the WordPress upload icon (instead of a custom icon)
    • The field appears correctly in the editor
    • Clicking the field in the editor does not trigger the file dialog (it should only be interactive on the frontend)
    • The field preview behaves consistently with other form fields

This PR builds upon the work done in #41582, which introduced the initial file upload field implementation. The main changes are moving the block from experimental to beta status and refining its behavior in the editor to be more consistent with WordPress patterns.

Refine the file upload field block to use the WordPress upload icon and follow consistent field patterns in the editor. This includes using the standard field type handling and removing the disabled state to match other fields' behavior.
Prevent the file upload dialog from opening in the editor by preventing the default click behavior.
@lezama lezama requested a review from a team February 5, 2025 22:52
Copy link
Contributor

github-actions bot commented Feb 5, 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/forms-file-upload-field-refinements branch.

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

    bin/jetpack-downloader test jetpack update/forms-file-upload-field-refinements
    

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 Feb 5, 2025

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.


🔴 Action required: We would recommend that you add a section to the PR description to specify whether this PR includes any changes to data or privacy, like so:

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

My PR adds *x* and *y*.

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!

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Feb 5, 2025
Copy link
Contributor

github-actions bot commented Feb 5, 2025

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/packages/forms/src/blocks/contact-form/components/jetpack-field.js 0/18 (0.00%) 0.00% 1 💔

Full summary · PHP report · JS report

@enejb
Copy link
Member

enejb commented Feb 5, 2025

The PR tested as expected for me.

When I have the define( 'JETPACK_BLOCKS_VARIATION', 'beta' ); the block shows up for me and when I have
define( 'JETPACK_BLOCKS_VARIATION', 'experimental' ); it does not.

@lezama lezama merged commit ff6b4dd into trunk Feb 5, 2025
64 checks passed
@lezama lezama deleted the update/forms-file-upload-field-refinements branch February 5, 2025 23:27
@github-actions github-actions bot removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] Needs Team Review labels Feb 5, 2025
talldan added a commit that referenced this pull request Feb 6, 2025
@talldan talldan mentioned this pull request Feb 6, 2025
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants