-
Notifications
You must be signed in to change notification settings - Fork 843
Forms: Add Feedback and Feedback_Field classes and start using them to display data #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
Conversation
|
Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.
Interested in more tips and information?
|
|
Thank you for your PR! When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
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:
If you have questions about anything, reach out in #jetpack-developers for guidance! |
There was a problem hiding this 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_Fieldclass with accompanying unit tests. - Adds a
Form_Responseclass with unit tests and a test utility for legacy feedback. - Cleans up a typo in
Contact_Form_Testand 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_datafor 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_contentvalue; 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_Fieldhandles.
* Handles the
projects/packages/forms/src/contact-form/class-response-field.php:108
- The docblock says
@return stringbutget_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_contentshould beparsed_contentfor 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|nullbutget_ip()returns a string or null; update the return type tostring|null.
* @return WP_Post|null
projects/packages/forms/src/contact-form/class-response-field.php
Outdated
Show resolved
Hide resolved
Code Coverage SummaryCoverage changed in 3 files.
4 files are newly checked for coverage.
Full summary · PHP report · JS report If appropriate, add one of these labels to override the failing coverage check:
Covered by non-unit tests
|
e522488 to
faf67b2
Compare
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
97f7860 to
1dc60fd
Compare
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:
Feedback::get( $post_id )orFeedback::from_submission( $post_data, $form, $current_post, $current_page_number )that works the same as before being persistent to the DB and after.Other information:
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.