Merge pull request #415 from justlevine/feat/narrow-choice-input-inte…

…rface-types feat!: Narrow `FormField.choices` and `.inputs` types to their implemations
AxeWP · May 13, 2024 · 2be7e1e · 2be7e1e
2 parents 36e6e2a + 0930429
commit 2be7e1e
Show file tree

Hide file tree

Showing 35 changed files with 202 additions and 240 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## [Unreleased]
 
 - feat!: Refactor `FormsConnectionResolver` and `EntriesConnectionResolver` for compatibility with WPGraphQL v1.26.0 improvements.
+- feat!: Narrow `FormField.choices` and `FormField.inputs` field types to their implementations.
 - chore!: Bump minimum WPGraphQL version to v1.26.0.
 - chore!: Bump minimum WordPress version to v6.0.0.
 - chore!: Bump minimum Gravity Forms version to v2.7.0.

diff --git a/docs/querying-formfields.md b/docs/querying-formfields.md
@@ -144,6 +144,9 @@ As of v0.10.0, all `formFields` have access to the `value` GraphQL field, which
           checkboxValues {
             inputId
             value
+            ... on CheckboxFieldChoice {
+              isSelected
+            }
           }
         }
         ... on NameField {

diff --git a/src/Registry/FieldChoiceRegistry.php b/src/Registry/FieldChoiceRegistry.php
@@ -18,6 +18,7 @@
 use WPGraphQL\GF\Type\WPInterface\FieldChoice;
 use WPGraphQL\GF\Utils\Utils;
 
+
 /**
  * Class - FieldChoiceRegistry
  */
@@ -88,6 +89,9 @@ static function () use ( $field, $settings, $as_interface ) {
 					register_graphql_object_type( $choice_name, $config );
 				}
 
+				// Overload the field type with the new choice type.
+				Utils::overload_graphql_field_type( $field->graphql_single_name, 'choices', [ 'list_of' => $choice_name ] );
+
 				// Store in static array to prevent duplicate registration.
 				self::$registered_types[] = $choice_name;
 			}

diff --git a/src/Registry/FieldInputRegistry.php b/src/Registry/FieldInputRegistry.php
@@ -90,6 +90,8 @@ static function () use ( $field, $settings, $as_interface ) {
 					register_graphql_object_type( $input_name, $config );
 				}
 
+				Utils::overload_graphql_field_type( $field->graphql_single_name, 'inputs', [ 'list_of' => $input_name ] );
+
 				// Store in static array to prevent duplicate registration.
 				self::$registered_types[] = $input_name;
 			}

diff --git a/src/Utils/Utils.php b/src/Utils/Utils.php
@@ -387,4 +387,30 @@ protected static function get_database_id_from_id( $id, $type ): int {
 
 		return absint( $id_parts['id'] );
 	}
+
+	/**
+	 * Overloads the field type of an existing GraphQL field.
+	 *
+	 * This is necessary because register_graphql_field() doesn't have a way to check inheritance.
+	 *
+	 * @see https://github.com/wp-graphql/wp-graphql/issues/3096
+	 *
+	 * @param string                      $object_type The WPGraphQL object type name where the field is located.
+	 * @param string                      $field_name  The field name to overload.
+	 * @param string|array<string|string> $new_type_name The new GraphQL type name to use.
+	 */
+	public static function overload_graphql_field_type( string $object_type, string $field_name, $new_type_name ): void {
+		add_filter(
+			'graphql_' . $object_type . '_fields',
+			static function ( array $fields ) use ( $field_name, $new_type_name ) {
+				if ( isset( $fields[ $field_name ] ) ) {
+					$fields[ $field_name ]['type'] = $new_type_name;
+				}
+
+				return $fields;
+			},
+			10,
+			1
+		);
+	}
 }
diff --git a/tests/wpunit/AddressFieldTest.php b/tests/wpunit/AddressFieldTest.php
@@ -134,17 +134,15 @@ public function field_query(): string {
 				errorMessage
 				hasAutocomplete
 				inputs {
-					... on AddressInputProperty {
-						customLabel
-						defaultValue
-						id
-						isHidden
-						key
-						label
-						name
-						placeholder
-						autocompleteAttribute
-					}
+					customLabel
+					defaultValue
+					id
+					isHidden
+					key
+					label
+					name
+					placeholder
+					autocompleteAttribute
 				}
 				isRequired
 				label

diff --git a/tests/wpunit/ChainedSelectFieldTest.php b/tests/wpunit/ChainedSelectFieldTest.php
@@ -138,25 +138,19 @@ public function field_query(): string {
 				canPrepopulate
 				chainedSelectsAlignment
 				choices {
-					... on ChainedSelectFieldChoice {
+					choices {
 						choices {
-							... on ChainedSelectFieldChoice {
-								choices {
-									... on ChainedSelectFieldChoice {
-										isSelected
-										text
-										value
-									}
-								}
 								isSelected
 								text
 								value
 							}
-						}
 						isSelected
 						text
 						value
 					}
+					isSelected
+					text
+					value
 				}
 				conditionalLogic {
 					actionType
@@ -174,11 +168,9 @@ public function field_query(): string {
 				hasChoiceValue
 				inputName
 				inputs {
-					... on ChainedSelectInputProperty {
-						label
-						id
-						name
-					}
+					label
+					id
+					name
 				}
 				isRequired
 				label

diff --git a/tests/wpunit/CheckboxFieldTest.php b/tests/wpunit/CheckboxFieldTest.php
@@ -210,11 +210,9 @@ public function field_query(): string {
 					}
 				}
 				choices {
-					... on CheckboxFieldChoice {
-						isSelected
-						text
-						value
-					}
+					isSelected
+					text
+					value
 				}
 				conditionalLogic {
 					actionType
@@ -234,11 +232,9 @@ public function field_query(): string {
 				hasSelectAll
 				inputName
 				inputs {
-					... on CheckboxInputProperty {
-						id
-						label
-						name
-					}
+					id
+					label
+					name
 				}
 				isRequired
 				label

diff --git a/tests/wpunit/DateFieldTest.php b/tests/wpunit/DateFieldTest.php
@@ -109,14 +109,12 @@ public function field_query(): string {
 				errorMessage
 				inputName
 				inputs {
-					... on DateInputProperty {
-						autocompleteAttribute
-						customLabel
-						defaultValue
-						id
-						label
-						placeholder
-					}
+					autocompleteAttribute
+					customLabel
+					defaultValue
+					id
+					label
+					placeholder
 				}
 				isRequired
 				label

diff --git a/tests/wpunit/EmailFieldTest.php b/tests/wpunit/EmailFieldTest.php
@@ -128,15 +128,13 @@ public function field_query(): string {
 				hasAutocomplete
 				hasEmailConfirmation
 				inputs {
-					... on EmailInputProperty {
-						autocompleteAttribute
-						customLabel
-						defaultValue
-						id
-						label
-						name
-						placeholder
-					}
+					autocompleteAttribute
+					customLabel
+					defaultValue
+					id
+					label
+					name
+					placeholder
 				}
 				isRequired
 				label

diff --git a/tests/wpunit/MultiSelectFieldTest.php b/tests/wpunit/MultiSelectFieldTest.php
@@ -96,11 +96,9 @@ public function field_query(): string {
 				adminLabel
 				canPrepopulate
 				choices {
-					... on MultiSelectFieldChoice {
 					isSelected
 					text
 					value
-					}
 				}
 				conditionalLogic {
 					actionType

diff --git a/tests/wpunit/NameFieldTest.php b/tests/wpunit/NameFieldTest.php
@@ -130,23 +130,21 @@ public function field_query(): string {
 				hasAutocomplete
 				inputName
 				inputs {
-					... on NameInputProperty {
-						autocompleteAttribute
-						choices {
-							isSelected
-							text
-							value
-						}
-						customLabel
-						defaultValue
-						hasChoiceValue
-						id
-						isHidden
-						key
-						label
-						name
-						placeholder
+					autocompleteAttribute
+					choices {
+						isSelected
+						text
+						value
 					}
+					customLabel
+					defaultValue
+					hasChoiceValue
+					id
+					isHidden
+					key
+					label
+					name
+					placeholder
 				}
 				isRequired
 				labelPlacement

diff --git a/tests/wpunit/OptionCheckboxFieldTest.php b/tests/wpunit/OptionCheckboxFieldTest.php
@@ -271,13 +271,11 @@ public function field_query(): string {
 				adminLabel
 				canPrepopulate
 				choices{
-					... on OptionFieldChoice {
-						formattedPrice
-						isSelected
-						price
-						text
-						value
-					}
+					formattedPrice
+					isSelected
+					price
+					text
+					value
 				}
 				cssClass
 				defaultValue
@@ -322,11 +320,9 @@ public function field_query(): string {
 					}
 					hasSelectAll
 					inputs {
-						... on OptionCheckboxInputProperty {
-							id
-							label
-							name
-						}
+						id
+						label
+						name
 					}
 				}
 			}

diff --git a/tests/wpunit/OptionRadioFieldTest.php b/tests/wpunit/OptionRadioFieldTest.php
@@ -153,14 +153,12 @@ public function field_query(): string {
 			... on OptionField {
 				adminLabel
 				canPrepopulate
-				choices{
-					... on OptionFieldChoice {
-						formattedPrice
-						isSelected
-						price
-						text
-						value
-					}
+				choices {
+					formattedPrice
+					isSelected
+					price
+					text
+					value
 				}
 				cssClass
 				defaultValue

diff --git a/tests/wpunit/OptionSelectFieldTest.php b/tests/wpunit/OptionSelectFieldTest.php
@@ -160,14 +160,12 @@ public function field_query(): string {
 			... on OptionField {
 				adminLabel
 				canPrepopulate
-				choices{
-					... on OptionFieldChoice {
-						formattedPrice
-						isSelected
-						price
-						text
-						value
-					}
+				choices {
+					formattedPrice
+					isSelected
+					price
+					text
+					value
 				}
 				cssClass
 				defaultValue

diff --git a/tests/wpunit/PostCategoryCheckboxFieldTest.php b/tests/wpunit/PostCategoryCheckboxFieldTest.php
@@ -293,11 +293,9 @@ public function field_query(): string {
 				adminLabel
 				canPrepopulate
 				choices {
-					... on PostCategoryFieldChoice {
-						isSelected
-						text
-						value
-					}
+					isSelected
+					text
+					value
 				}
 				conditionalLogic {
 					actionType
@@ -349,11 +347,9 @@ public function field_query(): string {
 					}
 					hasSelectAll
 					inputs {
-						... on PostCategoryCheckboxInputProperty {
-							id
-							label
-							name
-						}
+						id
+						label
+						name
 					}
 				}
 			}

diff --git a/tests/wpunit/PostCategoryMultiSelectFieldTest.php b/tests/wpunit/PostCategoryMultiSelectFieldTest.php
@@ -161,11 +161,9 @@ public function field_query(): string {
 				adminLabel
 				canPrepopulate
 				choices {
-					... on PostCategoryFieldChoice {
-						isSelected
-						text
-						value
-					}
+					isSelected
+					text
+					value
 				}
 				conditionalLogic {
 					actionType