feat: Add FieldError.connectedFormField connection (#424)

* feat: Add `FieldError.connectedFormField` connection

* chore: add missing param to docblock

Author: justlevine

CHANGELOG.md

@@ -8,6 +8,7 @@
 - fix!: Keep `PageField` with previous page data when filtering `formFields` by `pageNumber`. H/t @SamuelHadsall .
 - fix: Handle RadioField submission values when using a custom "other" choice. H/t @Gytjarek .
 - fix: Check for Submission Confirmation url before attempting to get the associated post ID.
+- feat: Add `FieldError.connectedFormField` connection to `FieldError` type.
 - dev: Use `FormFieldsDataLoader` to resolve fields instead of instantiating a new `Model`.
 - chore: Add iterable type hints.
 - chore!: Bump minimum WPGraphQL version to v1.26.0.

docs/submitting-forms.md

@@ -121,8 +121,12 @@ The `fieldValues` input takes an array of objects containing the `id` of the fie
       url     # The redirect URL - if the confirmation type is a "REDIRECT".
     }
     errors {
-      id # The field that failed validation.
+      id # The field ID that failed validation.
       message
+      connectedFormField { # The full FormField object if you need more info.
+        database
+        type
+      }
     }
     entry {
       # See docs on querying Entries.
@@ -150,7 +154,11 @@ If the field is NOT updated successfully, such as when a field validation error
 "errors": [
   {
     "id": "1",
-    "message": "The text entered exceeds the maximum number of characters."
+    "message": "The text entered exceeds the maximum number of characters.",
+    "connectedFormField": {
+      "database": 1,
+      "type": "TEXT"
+    }
   }
 ]
 ```

docs/updating-entries.md

@@ -27,8 +27,12 @@ You can update a [Gravity Forms entry](https://docs.gravityforms.com/entry-objec
     }
   ) {
     errors {
-      id # The field that failed validation.
+      id # The field ID that failed validation.
       message
+      connectedFormField { # The full FormField object if you need more info.
+        id
+        type
+      }
     }
     entry {
       # See above section on querying Entries.

src/Data/EntryObjectMutation.php

@@ -116,15 +116,17 @@ public static function get_field_value_input( array $args, array $form, bool $is
 	 * Generates array of field errors from the submission.
 	 *
 	 * @param array<int|string,string> $messages The Gravity Forms submission validation messages.
+	 * @param int                      $form_id  The ID of the form.
 	 *
 	 * @return array{message:string,id:int|string}[]
 	 */
-	public static function get_submission_errors( array $messages ): array {
+	public static function get_submission_errors( array $messages, int $form_id ): array {
 		return array_map(
-			static function ( $id, $message ): array {
+			static function ( $id, $message ) use ( $form_id ): array {
 				return [
 					'id'      => $id,
 					'message' => $message,
+					'formId'  => $form_id,
 				];
 			},
 			array_keys( $messages ),

src/Mutation/SubmitDraftEntry.php

@@ -106,7 +106,7 @@ public static function mutate_and_get_payload(): callable {
 			return [
 				'confirmation' => isset( $result['confirmation_type'] ) ? EntryObjectMutation::get_submission_confirmation( $result ) : null,
 				'entryId'      => ! empty( $result['entry_id'] ) ? absint( $result['entry_id'] ) : null,
-				'errors'       => isset( $result['validation_messages'] ) ? EntryObjectMutation::get_submission_errors( $result['validation_messages'] ) : null,
+				'errors'       => isset( $result['validation_messages'] ) ? EntryObjectMutation::get_submission_errors( $result['validation_messages'], (int) $form['id'] ) : null,
 			];
 		};
 	}

src/Mutation/SubmitForm.php

@@ -165,7 +165,7 @@ public static function mutate_and_get_payload(): callable {
 			return [
 				'confirmation' => isset( $submission['confirmation_type'] ) ? EntryObjectMutation::get_submission_confirmation( $submission ) : null,
 				'entryId'      => ! empty( $submission['entry_id'] ) ? absint( $submission['entry_id'] ) : null,
-				'errors'       => isset( $submission['validation_messages'] ) ? EntryObjectMutation::get_submission_errors( $submission['validation_messages'] ) : null,
+				'errors'       => isset( $submission['validation_messages'] ) ? EntryObjectMutation::get_submission_errors( $submission['validation_messages'], $form_id ) : null,
 				'resumeToken'  => $submission['resume_token'] ?? null,
 				'resumeUrl'    => isset( $submission['resume_token'] ) ? GFUtils::get_resume_url( $submission['resume_token'], $entry_data['source_url'] ?? '', $form ) : null,
 				'submission'   => $submission,

src/Type/WPObject/FieldError.php

@@ -11,6 +11,9 @@
 
 namespace WPGraphQL\GF\Type\WPObject;
 
+use WPGraphQL\AppContext;
+use WPGraphQL\GF\Data\Loader\FormFieldsLoader;
+use WPGraphQL\GF\Type\WPInterface\FormField;
 use WPGraphQL\GF\Type\WPObject\AbstractObject;
 
 /**
@@ -36,14 +39,27 @@ public static function get_description(): string {
 	 */
 	public static function get_fields(): array {
 		return [
-			'id'      => [
+			'id'                 => [
 				'type'        => 'Float',
 				'description' => __( 'The field with the associated error message.', 'wp-graphql-gravity-forms' ),
 			],
-			'message' => [
+			'message'            => [
 				'type'        => 'String',
 				'description' => __( 'Error message.', 'wp-graphql-gravity-forms' ),
 			],
+			'connectedFormField' => [
+				'type'        => FormField::$type,
+				'description' => __( 'The form field that the error is connected to.', 'wp-graphql-gravity-forms' ),
+				'resolve'     => static function ( $source, array $args, AppContext $context ) {
+					if ( ! isset( $source['id'] ) || ! isset( $source['formId'] ) ) {
+						return null;
+					}
+
+					$id_for_loader = (string) $source['formId'] . ':' . (string) $source['id'];
+
+					return $context->get_loader( FormFieldsLoader::$name )->load_deferred( $id_for_loader );
+				},
+			],
 		];
 	}
 }

tests/wpunit/AddressFieldTest.php

@@ -177,6 +177,10 @@ public function submit_form_mutation(): string {
 					errors {
 						id
 						message
+						connectedFormField {
+							databaseId
+							type
+						}
 					}
 					entry {
 						formFields {
@@ -215,6 +219,10 @@ public function update_entry_mutation(): string {
 					errors {
 						id
 						message
+						connectedFormField {
+							databaseId
+							type
+						}
 					}
 					entry {
 						formFields {
@@ -247,6 +255,10 @@ public function update_draft_entry_mutation(): string {
 					errors {
 						id
 						message
+						connectedFormField {
+							databaseId
+							type
+						}
 					}
 					entry: draftEntry {
 						formFields {

tests/wpunit/CaptchaFieldTest.php

@@ -182,6 +182,10 @@ public function submit_form_mutation(): string {
 					errors {
 						id
 						message
+						connectedFormField {
+							databaseId
+							type
+						}
 					}
 					entry {
 						formFields(where:{fieldTypes:TEXT}) {
@@ -213,6 +217,10 @@ public function update_entry_mutation(): string {
 					errors {
 						id
 						message
+						connectedFormField {
+							databaseId
+							type
+						}
 					}
 					entry {
 						formFields {
@@ -238,6 +246,10 @@ public function update_draft_entry_mutation(): string {
 					errors {
 						id
 						message
+						connectedFormField {
+							databaseId
+							type
+						}
 					}
 					entry: draftEntry {
 						formFields (where:{fieldTypes:TEXT}){

tests/wpunit/ChainedSelectFieldTest.php

@@ -198,6 +198,10 @@ public function submit_form_mutation(): string {
 					errors {
 						id
 						message
+						connectedFormField {
+							databaseId
+							type
+						}
 					}
 					entry {
 						formFields {
@@ -229,6 +233,10 @@ public function update_entry_mutation(): string {
 					errors {
 						id
 						message
+						connectedFormField {
+							databaseId
+							type
+						}
 					}
 					entry {
 						formFields {
@@ -254,6 +262,10 @@ public function update_draft_entry_mutation(): string {
 					errors {
 						id
 						message
+						connectedFormField {
+							databaseId
+							type
+						}
 					}
 					entry: draftEntry {
 						formFields {