chore(webonyx/graphql): Update GraphQL PHP dependency to v14.3.0 (drupal-graphql#1086)

Author: Kingdutch

.travis.yml

@@ -95,7 +95,7 @@ install:
   # Require redirect module to prevent PHPStan error on an optional dependency.
   # Install PHPStan to check for Drupal standards.
   - composer --no-interaction --working-dir=$DRUPAL_BUILD_DIR require \
-    webonyx/graphql-php:^0.13.1 \
+    webonyx/graphql-php:^14.3 \
     drupal/typed_data:^1.0 \
     drupal/redirect:^1.6 \
     phpstan/phpstan:^0.12.50 \

composer.json

@@ -6,7 +6,7 @@
   "license": "GPL-2.0+",
   "require": {
     "php": ">=7.2",
-    "webonyx/graphql-php": "^0.13.1"
+    "webonyx/graphql-php": "^14.3.0"
   },
   "minimum-stability": "dev"
 }

config/schema/graphql.schema.yml

@@ -11,9 +11,9 @@ graphql.graphql_servers.*:
     endpoint:
       type: string
       label: 'Endpoint'
-    debug:
-      type: boolean
-      label: 'Debug'
+    debug_flag:
+      type: integer
+      label: 'Debug Flag'
     schema:
       type: string
       label: 'Schema'

graphql.install

@@ -5,6 +5,9 @@
  * Install, update and uninstall functions for the GraphQL module.
  */
 
+use Drupal\graphql\Entity\Server;
+use GraphQL\Error\DebugFlag;
+
 /**
  * Implements hook_requirements().
  */
@@ -39,3 +42,24 @@ function graphql_uninstall() {
   }
   $languageTypes->set('negotiation', $negotiation)->save();
 }
+
+/**
+ * Update GraphQL Server debug configuration value.
+ */
+function graphql_update_8001() {
+  // The `debug` config item has changed to `debug_flag`. It is no longer a
+  // boolean toggle but instead a set of flags providing more control. In this
+  // case we default to debug messages and a backtrace in case debugging was
+  // enabled and just unselect all flags otherwise.
+  $servers = Server::loadMultiple();
+  foreach ($servers as $server) {
+    // There is no need to unset `debug` as its property no longer exists so it
+    // will not get persisted.
+    $debugEnabled = (bool) $server->get('debug');
+    $server->set(
+      'debug_flag',
+      $debugEnabled ? DebugFlag::INCLUDE_DEBUG_MESSAGE | DebugFlag::INCLUDE_TRACE : DebugFlag::NONE
+    );
+    $server->save();
+  }
+}

src/Entity/Server.php

@@ -10,6 +10,7 @@
 use Drupal\graphql\GraphQL\Execution\ExecutionResult as CacheableExecutionResult;
 use Drupal\graphql\GraphQL\Execution\FieldContext;
 use Drupal\graphql\Plugin\PersistedQueryPluginInterface;
+use GraphQL\Error\DebugFlag;
 use GraphQL\Server\OperationParams;
 use Drupal\graphql\GraphQL\Execution\ResolveContext;
 use GraphQL\Server\ServerConfig;
@@ -51,7 +52,7 @@
  *     "schema_configuration",
  *     "persisted_queries_settings",
  *     "endpoint",
- *     "debug",
+ *     "debug_flag",
  *     "caching",
  *     "batching"
  *   },
@@ -96,11 +97,12 @@ class Server extends ConfigEntityBase implements ServerInterface {
   public $schema_configuration = [];
 
   /**
-   * Whether the server is in debug mode.
+   * The debug settings for this server.
    *
-   * @var bool
+   * @var int
+   * @see \GraphQL\Error\DebugFlag
    */
-  public $debug = FALSE;
+  public $debug_flag = DebugFlag::NONE;
 
   /**
    * Whether the server should cache its results.
@@ -211,7 +213,7 @@ public function configuration() {
     // Create the server config.
     $registry = $plugin->getResolverRegistry();
     $server = ServerConfig::create();
-    $server->setDebug(!!$this->get('debug'));
+    $server->setDebugFlag($this->get('debug_flag'));
     $server->setQueryBatching(!!$this->get('batching'));
     $server->setValidationRules($this->getValidationRules());
     $server->setPersistentQueryLoader($this->getPersistedQueryLoader());

src/Form/ServerForm.php

@@ -13,6 +13,7 @@
 use Drupal\Core\Plugin\PluginFormInterface;
 use Drupal\Core\Routing\RequestContext;
 use Drupal\graphql\Plugin\SchemaPluginManager;
+use GraphQL\Error\DebugFlag;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -181,11 +182,23 @@ public function form(array $form, FormStateInterface $formState) {
       '#description' => $this->t('Whether caching of queries and partial results is enabled.'),
     ];
 
-    $form['debug'] = [
-      '#title' => $this->t('Enable debugging'),
-      '#type' => 'checkbox',
-      '#default_value' => !!$server->get('debug'),
-      '#description' => $this->t('In debugging mode, error messages contain more verbose information in the query response.'),
+    $debug_flags = $server->get('debug_flag') ?? 0;
+    $form['debug_flag'] = [
+      '#title' => $this->t('Debug settings'),
+      '#type' => 'checkboxes',
+      '#options' => [
+        DebugFlag::INCLUDE_DEBUG_MESSAGE => $this->t("Add debugMessage key containing the exception message to errors."),
+        DebugFlag::INCLUDE_TRACE => $this->t("Include the formatted original backtrace in errors."),
+        DebugFlag::RETHROW_INTERNAL_EXCEPTIONS => $this->t("Rethrow the internal GraphQL exceptions"),
+        DebugFlag::RETHROW_UNSAFE_EXCEPTIONS => $this->t("Rethrow unsafe GraphQL exceptions, these are exceptions that have not been marked as safe to expose to clients."),
+      ],
+      '#default_value' => array_keys(array_filter([
+        DebugFlag::INCLUDE_DEBUG_MESSAGE => (bool) ($debug_flags & DebugFlag::INCLUDE_DEBUG_MESSAGE),
+        DebugFlag::INCLUDE_TRACE => (bool) ($debug_flags & DebugFlag::INCLUDE_TRACE),
+        DebugFlag::RETHROW_INTERNAL_EXCEPTIONS => (bool) ($debug_flags & DebugFlag::RETHROW_INTERNAL_EXCEPTIONS),
+        DebugFlag::RETHROW_UNSAFE_EXCEPTIONS => (bool) ($debug_flags & DebugFlag::RETHROW_UNSAFE_EXCEPTIONS),
+      ])),
+      '#description' => $this->t("It is recommended to disable all debugging in production. During development you can enable the information that you need above."),
     ];
 
     $form['actions'] = [
@@ -231,6 +244,9 @@ public function validateForm(array &$form, FormStateInterface $formState) {
    * {@inheritdoc}
    */
   public function submitForm(array &$form, FormStateInterface $formState) {
+    // Translate the debug flag from individual checkboxes to the enum value
+    // that the GraphQL library expects.
+    $formState->setValue('debug_flag', array_sum($formState->getValue('debug_flag')));
     parent::submitForm($form, $formState);
 
     $schema = $formState->getValue('schema');

src/GraphQL/Resolver/Composite.php

@@ -3,7 +3,7 @@
 namespace Drupal\graphql\GraphQL\Resolver;
 
 use Drupal\graphql\GraphQL\Execution\FieldContext;
-use GraphQL\Deferred;
+use GraphQL\Executor\Promise\Adapter\SyncPromise;
 use Drupal\graphql\GraphQL\Utility\DeferredUtility;
 use Drupal\graphql\GraphQL\Execution\ResolveContext;
 use GraphQL\Type\Definition\ResolveInfo;
@@ -44,7 +44,7 @@ public function resolve($value, $args, ResolveContext $context, ResolveInfo $inf
     while ($resolver = array_shift($resolvers)) {
       $value = $resolver->resolve($value, $args, $context, $info, $field);
 
-      if ($value instanceof Deferred) {
+      if ($value instanceof SyncPromise) {
         return DeferredUtility::returnFinally($value, function ($value) use ($resolvers, $args, $context, $info, $field) {
           return isset($value) ? (new Composite($resolvers))->resolve($value, $args, $context, $info, $field) : NULL;
         });

src/GraphQL/Resolver/Condition.php

@@ -5,7 +5,7 @@
 use Drupal\graphql\GraphQL\Execution\FieldContext;
 use Drupal\graphql\GraphQL\Execution\ResolveContext;
 use Drupal\graphql\GraphQL\Utility\DeferredUtility;
-use GraphQL\Deferred;
+use GraphQL\Executor\Promise\Adapter\SyncPromise;
 use GraphQL\Type\Definition\ResolveInfo;
 
 /**
@@ -45,7 +45,7 @@ public function resolve($value, $args, ResolveContext $context, ResolveInfo $inf
         }
       }
 
-      if ($condition instanceof Deferred) {
+      if ($condition instanceof SyncPromise) {
         return DeferredUtility::returnFinally($condition, function ($cond) use ($branches, $resolver, $value, $args, $context, $info, $field) {
           array_unshift($branches, [$cond, $resolver]);
           return (new Condition($branches))->resolve($value, $args, $context, $info, $field);

src/GraphQL/Resolver/DefaultValue.php

@@ -5,7 +5,7 @@
 use Drupal\graphql\GraphQL\Execution\FieldContext;
 use Drupal\graphql\GraphQL\Execution\ResolveContext;
 use Drupal\graphql\GraphQL\Utility\DeferredUtility;
-use GraphQL\Deferred;
+use GraphQL\Executor\Promise\Adapter\SyncPromise;
 use GraphQL\Type\Definition\ResolveInfo;
 
 /**
@@ -57,7 +57,7 @@ public function resolve(
       return $this->default->resolve($value, $args, $context, $info, $field);
     }
 
-    if ($result instanceof Deferred) {
+    if ($result instanceof SyncPromise) {
       return DeferredUtility::returnFinally($result, function ($current) use ($value, $args, $context, $info, $field) {
         if ($current === NULL) {
           return $this->default->resolve($value, $args, $context, $info, $field);

src/GraphQL/Utility/DeferredUtility.php

@@ -3,6 +3,7 @@
 namespace Drupal\graphql\GraphQL\Utility;
 
 use GraphQL\Deferred;
+use GraphQL\Executor\Promise\Adapter\SyncPromise;
 use GraphQL\Executor\Promise\Adapter\SyncPromiseAdapter;
 
 class DeferredUtility {
@@ -35,7 +36,7 @@ public static function promiseAdapter() {
    * @return mixed
    */
   public static function applyFinally($value, callable $callback) {
-    if ($value instanceof Deferred) {
+    if ($value instanceof SyncPromise) {
       // Recursively apply this function to deferred results.
       $value->then(function ($inner) use ($callback) {
         return static::applyFinally($inner, $callback);
@@ -52,14 +53,12 @@ public static function applyFinally($value, callable $callback) {
    * @param mixed $value
    * @param callable $callback
    *
-   * @return \GraphQL\Deferred|mixed
+   * @return \GraphQL\Executor\Promise\Adapter\SyncPromise|mixed
    */
   public static function returnFinally($value, callable $callback) {
-    if ($value instanceof Deferred) {
-      return new Deferred(function () use ($value, $callback) {
-        return $value->then(function ($value) use ($callback) {
-          return $callback($value);
-        });
+    if ($value instanceof SyncPromise) {
+      return $value->then(function ($value) use ($callback) {
+        return $callback($value);
       });
     }
 
@@ -85,7 +84,7 @@ public static function waitAll(array $values) {
       return new Deferred(function () use ($values) {
         $adapter = static::promiseAdapter();
         return $adapter->all(array_map(function ($value) use ($adapter) {
-          if ($value instanceof Deferred) {
+          if ($value instanceof SyncPromise) {
             return $adapter->convertThenable($value);
           }
 
@@ -108,7 +107,7 @@ public static function waitAll(array $values) {
    */
   public static function containsDeferred(array $values) {
     foreach ($values as $value) {
-      if ($value instanceof Deferred) {
+      if ($value instanceof SyncPromise) {
         return TRUE;
       }
     }

tests/src/Traits/DataProducerExecutionTrait.php

@@ -3,7 +3,7 @@
 namespace Drupal\Tests\graphql\Traits;
 
 use Drupal\graphql\GraphQL\Execution\FieldContext;
-use GraphQL\Deferred;
+use GraphQL\Executor\Promise\Adapter\SyncPromise;
 use GraphQL\Executor\Promise\Adapter\SyncPromiseAdapter;
 use Prophecy\Argument;
 
@@ -35,7 +35,7 @@ protected function executeDataProducer($id, array $contexts = []) {
     $context->hasContextValue(Argument::any())->willReturn(FALSE);
 
     $result = $plugin->resolveField($context->reveal());
-    if (!$result instanceof Deferred) {
+    if (!$result instanceof SyncPromise) {
       return $result;
     }