chore: Add compatibility for WPGraphQL 2.3.3 and lazy-loaded descriptions. (#457)

* fix: check for missing `$context->gfField` before use

* dev: support WPGraphQL 2.3.3

* dev: lazy-load `description` strings

* chore: headers bump

Author: justlevine

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [Unreleased]
+
+- dev: Add support for lazy-loaded descriptions.
+- ci: Test compatibility against WPGraphWL v2.3.3.
+
 ## [v0.13.1]
 
 This _minor_ release tests compatibility against WordPress 6.8.x and WPGraphQL 1.31.x.

composer.lock

@@ -40,7 +40,7 @@ install_gf || true
 
 # Install WPGraphQL and Activate
 if ! $( wp plugin is-installed wp-graphql --allow-root ); then
-	wp plugin install wp-graphql --version=1.32.1 --allow-root
+	wp plugin install wp-graphql --allow-root
 fi
 wp plugin activate wp-graphql --allow-root
 

docker/app.post-setup.sh

@@ -18,7 +18,7 @@ For example:
 register_graphql_input_type(
 	'MyCustomFieldValueInput',
 	[
-		'description' => __( 'The `fieldValues` input for a MyCustomField field.', 'my-plugin' ),
+		'description' => static fn () => __( 'The `fieldValues` input for a MyCustomField field.', 'my-plugin' ),
 		'fields' => [ 
 			//see https://www.wpgraphql.com/functions/register_graphql_input_type/
 		],
@@ -37,7 +37,7 @@ add_filter(
 	function( array $fields ) : array {
 		$fields['myCustomFieldValues'] = [ // The field value name.
 			'type' => 'MyCustomFieldValueInput', // This is registered above.
-			'description' => __( 'The form field values for MyCustomField fields.', 'my-plugin'),
+			'description' => static fn () => __( 'The form field values for MyCustomField fields.', 'my-plugin'),
 		];
 	}
 );

docs/recipes/register-custom-field-value-inputs.md

@@ -22,7 +22,7 @@ register_graphql_field(
   'myCustomProperty',
   [
     'type' => 'String',
-    'description' => __( 'This is a custom property that exists on my custom GF field', 'my-plugin' ),
+    'description' => static fn () => __( 'This is a custom property that exists on my custom GF field', 'my-plugin' ),
     'resolve' => fn( $source ) => $source->my_custom_property // if the GF_Field property is the same name as the GraphQL field, this can be ommitted.
   ]
 );
@@ -36,7 +36,7 @@ register_graphql_field(
   'myCustomFormFieldValue',
   [
     'type' => 'MyCustomFormFieldValueObject',
-    'description' => __( 'The Field Value object for my custom GF field.', 'my-plugin'),
+    'description' => static fn () => __( 'The Field Value object for my custom GF field.', 'my-plugin'),
     'resolve' => function( $source ){
       /**
        * Usually, the entry is saved in the formField's context/
@@ -78,7 +78,7 @@ add_filter(
     // Add `myCustomField` to the GraphQL type.
     $fields['myCustomField'] = [
       'type'        => 'String',
-      'description' => __( 'The autocomplete attribute for the field.', 'wp-graphql-gravity-forms' ),
+      'description' => static fn () => __( 'The autocomplete attribute for the field.', 'wp-graphql-gravity-forms' ),
     ];
 
     return $fields;

docs/recipes/register-custom-form-field.md

@@ -27,7 +27,7 @@ function my_add_form_to_post() {
     'form', // The field name to add.
     // The config object:
     [
-      'description' => __( 'The Gravity Forms form for the post', 'my-plugin' ),
+      'description' => static fn () => __( 'The Gravity Forms form for the post', 'my-plugin' ),
       'type' => \WPGraphQL\GF\Type\WPObject\Form\Form::$type,
       'resolve' => static function( $source, array $args, \WPGraphQL\AppContext $context ){
         // Get the form id from the post meta.

docs/recipes/register-form-to-custom-field.md

@@ -6,10 +6,31 @@ class SubmittedEntry {}
 class DraftEntry {}
 class FormField {}
 
+namespace WPGraphQL\Data\Loader;
+abstract class AbstractDataLoader {}
+
+namespace WPGraphQL\GF\Data\Loader;
+class DraftEntriesLoader {}
+class EntriesLoader {}
+class FormsLoader {}
+class FormFieldsLoader {}
+
 namespace WPGraphQL;
 /**
  * @property ?\WPGraphQL\GF\Model\Form $gfForm
  * @property \WPGraphQL\GF\Model\SubmittedEntry|\WPGraphQL\GF\Model\DraftEntry|null $gfEntry
  * @property ?\WPGraphQL\GF\Model\FormField $gfField
  */
-class AppContext {}
+class AppContext {
+	/**
+	 * @param string $key
+	 * @return ( $key is 'gf_draft_entry' ? \WPGraphQL\GF\Data\Loader\DraftEntriesLoader :
+	 *                  ( $key is 'gf_entry' ? \WPGraphQL\GF\Data\Loader\EntriesLoader :
+	 *                   ( $key is 'gf_form' ? \WPGraphQL\GF\Data\Loader\FormsLoader :
+	 *                    ( $key is 'gf_form_field' ? \WPGraphQL\GF\Data\Loader\FormFieldsLoader : \WPGraphQL\Data\Loader\AbstractDataLoader )
+	 *                   )
+	 *                  )
+	 *                 )
+	 */
+	public function get_loader($key){}
+}

phpstan/class-app-context.php

@@ -23,19 +23,19 @@
  *   toType?: string,
  *   connectionArgs?: array<string,array{
  *     type: string|array<string,string | array<string,string>>,
- *     description: string,
+ *     description: callable():string,
  *     defaultValue?: mixed
  *   }>,
  *   connectionFields?: array<string,array{
  *     type: string|array<string,string | array<string,string>>,
- *     description: string,
+ *     description: callable():string,
  *     args?: array<string,array{
  *       type: string|array<string,string | array<string,string>>,
- *       description: string,
+ *       description: callable():string,
  *       defaultValue?: mixed,
  *     }>,
  *     resolve?: callable,
- *     deprecationReason?: string,
+ *     deprecationReason?: callable():string,
  *   }>,
  * }
  */
@@ -57,7 +57,7 @@ public static function register_hooks(): void {
 	/**
 	 * Gets custom connection configuration arguments, such as the resolver, edgeFields, connectionArgs, etc.
 	 *
-	 * @return array<string,array{type:string|array<string,string|array<string,string>>,description:string,defaultValue?:mixed}>
+	 * @return array<string,array{type:string|array<string,string|array<string,string>>,description:callable():string,defaultValue?:mixed}>
 	 */
 	public static function get_connection_args(): array {
 		return [];
@@ -68,7 +68,7 @@ public static function get_connection_args(): array {
 	 *
 	 * @param ?string[] $filter_by an array of specific connections to return.
 	 *
-	 * @return array<string,array{type:string|array<string,string|array<string,string>>,description:string,defaultValue?:mixed}>
+	 * @return array<string,array{type:string|array<string,string|array<string,string>>,description:callable():string,defaultValue?:mixed}>
 	 */
 	public static function get_filtered_connection_args( ?array $filter_by = null ): array {
 		$connection_args = static::get_connection_args();