Skip to content

Conversation

@enejb
Copy link
Member

@enejb enejb commented Jun 27, 2025

This PR add a few of new classes that make dealing with form responses easier.

Fixes FORMS-231

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 response object (Feedback::get( $post_id ) or Feedback::from_submission( $post_data, $form, $current_post, $current_page_number ) that works the same as before being persistent to the DB and after.
  • Update all the different place to use the new class. ( Endpoint, On submission, csv export, export personal data )
  • In this PR we are not saving thew new format but has tests that show that reading the new format will be the same as saving when we save it.
  • This PR also tries to make it easier to write unit and integration 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

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

No

Testing instructions:

Do the tests pass?

Add a new form with all the fields.
Save the form. Does it work as expected?
Notice that you got the email as expected.

Visit the form responses. This Should work as before.

Export the form responses. Do they work like you would expected them to?
Export the persona data visiting Tools > Export Personal Data and entering an email address.
Notice that beside the field we also supply the IP address. Consent, Date and URL where the form was submitted from.

@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
@github-actions
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

@github-actions
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 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

@jp-launch-control
Copy link

jp-launch-control bot commented Jun 27, 2025

Code Coverage Summary

Coverage changed in 3 files.

File Coverage Δ% Δ Uncovered
projects/packages/forms/src/contact-form/class-contact-form-plugin.php 417/1169 (35.67%) -2.27% 16 💔
projects/packages/forms/src/contact-form/class-contact-form-endpoint.php 459/540 (85.00%) -0.69% -1 💚
projects/packages/forms/src/contact-form/class-contact-form.php 583/1064 (54.79%) -0.51% -21 💚

4 files are newly checked for coverage.

File Coverage
projects/packages/forms/src/contact-form/class-feedback.php 320/330 (96.97%) 💚
projects/packages/forms/src/contact-form/class-feedback-field.php 68/69 (98.55%) 💚
projects/packages/forms/src/contact-form/class-feedback-author.php 24/24 (100.00%) 💚
projects/packages/forms/src/contact-form/class-feedback-entry.php 28/28 (100.00%) 💚

Full summary · PHP report · JS report

If appropriate, add one of these labels to override the failing coverage check: Covered by non-unit tests Use to ignore the Code coverage requirement check when E2Es or other non-unit tests cover the code Coverage tests to be added later Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage.

enejb and others added 23 commits July 24, 2025 09:08
Modularized the parse_legacy_content method by extracting logic into helper methods for splitting content, extracting values and lines, parsing JSON and array formats, and processing fields. This improves readability, maintainability, and separation of concerns in legacy feedback parsing.
Refactored Feedback_Field to support context-aware rendering via get_render_value($context), and made get_render_api_value() private. Updated Feedback to allow flexible compiled field output shapes and context. Adjusted endpoint and tests to use the new API, improving clarity and extensibility for field rendering in different contexts.
Renamed get_computer_author_info to get_computed_author_info in Feedback_Author to correct a typo and ensure consistency in method naming.
Renamed $feedback_id and $feedback_title to $legacy_feedback_id and $legacy_feedback_title throughout the Feedback class to clarify their legacy status and indicate they are not used in the new feedback system. Updated all references, getters, and related logic accordingly.
Extended the test_get_render_value method to include assertions for the get_value method, ensuring both scalar and array values are correctly returned by Feedback_Field.
Replaces is_file_field() with a more generic is_of_type() method in Feedback_Field, simplifying type checks. Updates legacy file upload handling in Feedback to explicitly set the field type to 'file'. Adjusts and expands related unit tests to cover new logic and ensure correct file field behavior.
- Fix "lable" → "label" in Feedback_Field class
- Fix "recieved" → "received" in Feedback class
- Fix "invividual" → "individual" in Feedback_Field class
- Complete incomplete class docblock for Feedback_Field
@enejb enejb force-pushed the update/form-response-storage branch from 97f7860 to 1dc60fd Compare July 24, 2025 16:09
@enejb enejb merged commit 85f7b97 into trunk Jul 24, 2025
66 of 67 checks passed
@enejb enejb deleted the update/form-response-storage branch July 24, 2025 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Feature] Contact Form [Package] Forms [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.

4 participants