Forms: Add Feedback and Feedback_Field classes and start using them to display data (#44121)

* Forms: Adds a new Form_Responses class

* Add tests for Form_Response::strip_tags method

* Make endpoint rendering work

* Make for submission work with the new response data

* Add test for get_render_value

* Update has_file tests

* Add tests for get_render_api_value method

* rename for clarity

* Simplify things

* Fix rendering on submit

* Rename Form_Response => Feedback

* Rename Response_Field => Feedback_Field

* Implement CSV Export

* minor update test method name

* Minor fixes

* Add reprecation

* Update the code coverage

* minor: test fixes

* Introduce Feedback_Entry class

* split constructore up, refactor form

* Add Feedback_Author Class

* Fix phan issue

* Add tests for Feedback_Author

* Fix tests

* minor refactor

* Refactor legacy content parsing in Feedback class

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.

* Refactor feedback field rendering and API output

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.

* Add context csv

* Add more context

* Fixing php phan issues

* Improve test coverage

* Fix typo in method name for author info retrieval

Renamed get_computer_author_info to get_computed_author_info in Feedback_Author to correct a typo and ensure consistency in method naming.

* Rename legacy feedback properties in Feedback class

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.

* Add more Feedback tests

* Add form count test

* Move the test

* More tests and phan fixes

* update baseline

* Add get_value assertions to Feedback_Field tests

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.

* Add feedback field tests

* remove unused method

* Refactor file field type handling in feedback forms

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.

* Don't reimplement strip_tags method

* Export personal Data update to use FeedBack Class

* Fix typos in docblocks

- 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

* Making ajax work.

* Add a test for label|value format

* Add test for get_json_data

---------

Co-authored-by: Miguel Lezama <[email protected]>

Author: enejb

projects/packages/forms/.phan/baseline.php

@@ -15,10 +15,10 @@
     // PhanTypeMismatchArgumentInternal : 6 occurrences
     // PhanTypeMismatchArgumentProbablyReal : 6 occurrences
     // PhanPluginDuplicateAdjacentStatement : 2 occurrences
-    // PhanPluginRedundantAssignment : 2 occurrences
     // PhanTypeConversionFromArray : 2 occurrences
     // PhanTypeMismatchReturn : 2 occurrences
     // PhanPluginMixedKeyNoKey : 1 occurrence
+    // PhanPluginRedundantAssignment : 1 occurrence
     // PhanPossiblyNullTypeMismatchProperty : 1 occurrence
     // PhanTypeArraySuspiciousNullable : 1 occurrence
     // PhanTypeMismatchReturnNullable : 1 occurrence
@@ -28,7 +28,7 @@
     'file_suppressions' => [
         'src/contact-form/class-admin.php' => ['PhanPluginDuplicateConditionalNullCoalescing', 'PhanTypeArraySuspiciousNullable', 'PhanTypeMismatchArgument', 'PhanTypeMismatchArgumentInternal', 'PhanTypeMismatchArgumentProbablyReal', 'PhanTypeMismatchReturn'],
         'src/contact-form/class-contact-form-field.php' => ['PhanPluginDuplicateConditionalNullCoalescing', 'PhanPossiblyNullTypeMismatchProperty', 'PhanTypeConversionFromArray', 'PhanTypeMismatchArgument', 'PhanTypeMismatchReturnProbablyReal'],
-        'src/contact-form/class-contact-form-plugin.php' => ['PhanPluginDuplicateAdjacentStatement', 'PhanPluginDuplicateConditionalNullCoalescing', 'PhanPluginRedundantAssignment', 'PhanTypeMismatchArgument', 'PhanTypeMismatchArgumentInternal', 'PhanTypeMismatchArgumentProbablyReal', 'PhanTypeMismatchReturnProbablyReal'],
+        'src/contact-form/class-contact-form-plugin.php' => ['PhanPluginDuplicateAdjacentStatement', 'PhanPluginDuplicateConditionalNullCoalescing', 'PhanTypeMismatchArgument', 'PhanTypeMismatchArgumentInternal', 'PhanTypeMismatchArgumentProbablyReal', 'PhanTypeMismatchReturnProbablyReal'],
         'src/contact-form/class-contact-form-shortcode.php' => ['PhanPluginDuplicateConditionalNullCoalescing', 'PhanTypeMismatchReturnProbablyReal'],
         'src/contact-form/class-contact-form.php' => ['PhanPluginDuplicateConditionalNullCoalescing', 'PhanPluginRedundantAssignment', 'PhanTypeMismatchArgument', 'PhanTypeMismatchReturnNullable', 'PhanTypeMismatchReturnProbablyReal'],
         'src/dashboard/class-dashboard-view-switch.php' => ['PhanUnreferencedUseNormal'],

projects/packages/forms/changelog/update-form-response-storage

@@ -0,0 +1,5 @@
+Significance: patch
+Type: fixed
+
+Forms: Adds a new Feedback and Feedback_Field class that keeps consistency between DB form response and the one before we submit it.
+

projects/packages/forms/src/contact-form/class-contact-form-endpoint.php

@@ -530,100 +530,48 @@ public function prepare_item_for_response( $item, $request ) {
 		$data     = $response->get_data();
 		$fields   = $this->get_fields_for_response( $request );
 
-		$has_file    = false;
-		$base_fields = array(
-			'email_marketing_consent' => '',
-			'entry_title'             => '',
-			'entry_permalink'         => '',
-			'feedback_id'             => '',
-		);
-
-		$data_defaults = array(
-			'_feedback_author'       => '',
-			'_feedback_author_email' => '',
-			'_feedback_author_url'   => '',
-			'_feedback_all_fields'   => array(),
-			'_feedback_ip'           => '',
-			'_feedback_subject'      => '',
-		);
-
-		$feedback_data = array_merge(
-			$data_defaults,
-			\Automattic\Jetpack\Forms\ContactForm\Contact_Form_Plugin::parse_fields_from_content( $item->ID )
-		);
-
-		$all_fields = array_merge( $base_fields, $feedback_data['_feedback_all_fields'] );
+		$response = Feedback::get( $item->ID );
 
 		$data['date'] = get_the_date( 'c', $data['id'] );
 		if ( rest_is_field_included( 'uid', $fields ) ) {
-			$data['uid'] = $all_fields['feedback_id'];
+			$data['uid'] = $response->get_feedback_id();
 		}
 		if ( rest_is_field_included( 'author_name', $fields ) ) {
-			$data['author_name'] = $feedback_data['_feedback_author'];
+			$data['author_name'] = $response->get_author();
 		}
 		if ( rest_is_field_included( 'author_email', $fields ) ) {
-			$data['author_email'] = $feedback_data['_feedback_author_email'];
+			$data['author_email'] = $response->get_author_email();
 		}
 		if ( rest_is_field_included( 'author_url', $fields ) ) {
-			$data['author_url'] = $feedback_data['_feedback_author_url'];
+			$data['author_url'] = $response->get_author_url();
 		}
 		if ( rest_is_field_included( 'author_avatar', $fields ) ) {
-			$data['author_avatar'] = empty( $feedback_data['_feedback_author_email'] ) ? '' : get_avatar_url( $feedback_data['_feedback_author_email'] );
+			$data['author_avatar'] = $response->get_author_avatar();
 		}
 		if ( rest_is_field_included( 'email_marketing_consent', $fields ) ) {
-			$data['email_marketing_consent'] = $all_fields['email_marketing_consent'];
+			$data['email_marketing_consent'] = $response->has_consent() ? __( 'Yes', 'jetpack-forms' ) : __( 'No', 'jetpack-forms' );
 		}
 		if ( rest_is_field_included( 'ip', $fields ) ) {
-			$data['ip'] = $feedback_data['_feedback_ip'];
+			$data['ip'] = $response->get_ip_address();
 		}
 		if ( rest_is_field_included( 'entry_title', $fields ) ) {
-			$data['entry_title'] = $all_fields['entry_title'];
+			$data['entry_title'] = $response->get_entry_title();
 		}
 		if ( rest_is_field_included( 'entry_permalink', $fields ) ) {
-			$data['entry_permalink'] = $all_fields['entry_permalink'];
+			$data['entry_permalink'] = $response->get_entry_permalink();
 		}
 		if ( rest_is_field_included( 'subject', $fields ) ) {
-			$data['subject'] = $feedback_data['_feedback_subject'];
+			$data['subject'] = $response->get_subject();
 		}
 		if ( rest_is_field_included( 'fields', $fields ) ) {
-			$fields_data = array_diff_key( $all_fields, $base_fields );
-
-			foreach ( $fields_data as &$field ) {
-				if ( Contact_Form::is_file_upload_field( $field ) ) {
-
-					foreach ( $field['files'] as &$file ) {
-						if ( ! isset( $file['size'] ) || ! isset( $file['file_id'] ) ) {
-							// this shouldn't happen, todo: log this
-							continue;
-						}
-						$file_id                = absint( $file['file_id'] );
-						$file['file_id']        = $file_id;
-						$file['size']           = size_format( $file['size'] );
-						$file['url']            = apply_filters( 'jetpack_unauth_file_download_url', '', $file_id );
-						$file['is_previewable'] = self::is_previewable_file( $file );
-						$has_file               = true;
-					}
-				}
-			}
+			$data['fields'] = $response->get_compiled_fields( 'api', 'key-value' );
+		}
 
-			$data['fields']   = $fields_data;
-			$data['has_file'] = $has_file;
+		if ( rest_is_field_included( 'has_file', $fields ) ) {
+			$data['has_file'] = $response->has_file();
 		}
 		return rest_ensure_response( $data );
 	}
-	/**
-	 * Checks if the file is previewable based on its type or extension.
-	 *
-	 * @param array $file File data.
-	 * @return bool True if the file is previewable, false otherwise.
-	 */
-	private static function is_previewable_file( $file ) {
-		$file_type = strtolower( pathinfo( $file['name'], PATHINFO_EXTENSION ) );
-		// Check if the file is previewable based on its type or extension.
-		// Note: This is a simplified check and does not match if the file is allowed to be uploaded by the server.
-		$previewable_types = array( 'jpg', 'jpeg', 'png', 'gif', 'webp' );
-		return in_array( $file_type, $previewable_types, true );
-	}
 
 	/**
 	 * Retrieves the query params for the feedback collection.