Skip to content

Forms: Add Form_Response class #44121

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

Draft
wants to merge 8 commits into
base: trunk
Choose a base branch
from
Draft

Conversation

enejb
Copy link
Member

@enejb enejb commented Jun 27, 2025

This PR add a couple of new classes that make dealing with form seponses easier.

Fixes FORMS-NEW

Currently we don't have a structure way that we deal with Form Responses. This PR in an attempt to improve this.
And also add more test to the code base.
We are also attempting to deal

Proposed changes:

  • Make it easier to deal with from responses by creating form reponse object that works the same as before being persistet to the DB and after.

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

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

Testing instructions:

Do the tests pass?

@enejb enejb requested a review from a team June 27, 2025 04:47
@enejb enejb added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Package] Forms labels Jun 27, 2025
@enejb enejb requested a review from Copilot June 27, 2025 04:47
Copy link
Contributor

github-actions bot commented Jun 27, 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 WoA dev 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 (Jetpack), and enable the update/form-response-storage branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack update/form-response-storage

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 Jun 27, 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 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 🤖


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Jun 27, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces structured classes and tests to standardize handling of form responses before and after persistence.

  • Adds a Response_Field class with accompanying unit tests.
  • Adds a Form_Response class with unit tests and a test utility for legacy feedback.
  • Cleans up a typo in Contact_Form_Test and updates the changelog.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
projects/packages/forms/tests/php/contact-form/class-utility.php Added a test utility for creating legacy feedback posts.
projects/packages/forms/tests/php/contact-form/Response_Field_Test.php Added unit tests for the Response_Field class.
projects/packages/forms/tests/php/contact-form/Form_Response_Test.php Added unit tests for the Form_Response class.
projects/packages/forms/tests/php/contact-form/Contact_Form_Test.php Removed a typo in test data setup (post_contnt).
projects/packages/forms/src/contact-form/class-response-field.php Introduced the Response_Field class.
projects/packages/forms/src/contact-form/class-form-response.php Introduced the Form_Response class.
projects/packages/forms/changelog/update-form-response-storage Added changelog entry for the new form response classes.
Comments suppressed due to low confidence (6)

projects/packages/forms/tests/php/contact-form/Form_Response_Test.php:56

  • [nitpick] The test method name has an extra 'is'; rename to test_form_response_matches_empty_data for clarity and consistency.
	public function test_form_response_is_matches_empty_data() {

projects/packages/forms/tests/php/contact-form/Contact_Form_Test.php:762

  • The test removed the typo key but no longer provides a post_content value; add a correct 'post_content' => 'testing' to ensure the test inserts content.
				'post_title'  => 'testing',

projects/packages/forms/src/contact-form/class-response-field.php:11

  • [nitpick] The class docblock summary is incomplete; provide a full description of what Response_Field handles.
 * Handles the

projects/packages/forms/src/contact-form/class-response-field.php:108

  • The docblock says @return string but get_meta() returns an array; update it to @return array.
	 * @return string

projects/packages/forms/src/contact-form/class-form-response.php:133

  • Variable name typo: parese_content should be parsed_content for readability.
			$parese_content = static::parse_content( $this->post->post_content, $this->post->page_template );

projects/packages/forms/src/contact-form/class-form-response.php:241

  • The docblock indicates @return WP_Post|null but get_ip() returns a string or null; update the return type to string|null.
	 * @return WP_Post|null

Copy link

jp-launch-control bot commented Jun 27, 2025

Code Coverage Summary

Cannot generate coverage summary while tests are failing. 🤐

Please fix the tests, or re-run the Code coverage job if it was something being flaky.

Full summary · PHP report · JS report

enejb and others added 5 commits June 27, 2025 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Contact Form [Package] Forms [Status] In Progress [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Tests] Includes Tests [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant