Configurable composable schemas. (#838)

Author: LennardWesterveld

config/schema/graphql.display.schema.yml

@@ -23,3 +23,19 @@ graphql.graphql_servers.*:
     batching:
       type: boolean
       label: 'Batching'
+    schema_configuration:
+      type: 'graphql.schema.[%parent.schema]'
+
+graphql.schema.*:
+  type: mapping
+  label: 'Schema settings'
+
+graphql.schema.composable:
+  type: mapping
+  label: 'Composable schema'
+  mapping:
+    extensions:
+      label: Enabled extensions
+      type: sequence
+      sequence:
+        type: boolean

…chema/graphql.graphql_servers.schema.yml config/schema/graphql.schema.ymlconfig/schema/graphql.graphql_servers.schema.yml renamed to config/schema/graphql.schema.yml config/schema/graphql.graphql_servers.schema.yml renamed to config/schema/graphql.schema.yml

@@ -8,7 +8,9 @@
 
 /**
  * @SchemaExtension(
- *   id = "example.ext",
+ *   id = "example_extension",
+ *   name = "Example extension",
+ *   description = "A simple extension that adds node related fields.",
  *   schema = "example"
  * )
  */

…amples/graphql/example.ext.base.graphqls …/graphql/example_extension.base.graphqlsexamples/graphql/example.ext.base.graphqls renamed to examples/graphql/example_extension.base.graphqls examples/graphql/example.ext.base.graphqls renamed to examples/graphql/example_extension.base.graphqls

@@ -20,6 +20,20 @@ class SchemaExtension extends Plugin {
    */
   public $id;
 
+  /**
+   * The plugin name.
+   *
+   * @var string
+   */
+  public $name;
+
+  /**
+   * The plugin description.
+   *
+   * @var string
+   */
+  public $description = '';
+
   /**
    * The id of the schema plugin to extend.
    *

…s/graphql/example.ext.extension.graphqls …hql/example_extension.extension.graphqlsexamples/graphql/example.ext.extension.graphqls renamed to examples/graphql/example_extension.extension.graphqls examples/graphql/example.ext.extension.graphqls renamed to examples/graphql/example_extension.extension.graphqls

@@ -2,6 +2,7 @@
 
 namespace Drupal\graphql\Entity;
 
+use Drupal\Component\Plugin\ConfigurableInterface;
 use Drupal\Core\Cache\CacheableDependencyInterface;
 use Drupal\Core\Config\Entity\ConfigEntityBase;
 use Drupal\Core\DependencyInjection\DependencySerializationTrait;
@@ -46,6 +47,7 @@
  *     "name",
  *     "label",
  *     "schema",
+ *     "schema_configuration",
  *     "endpoint",
  *     "debug",
  *     "caching",
@@ -83,6 +85,13 @@ class Server extends ConfigEntityBase implements ServerInterface {
    */
   public $schema;
 
+  /**
+   * Schema configuration.
+   *
+   * @var array
+   */
+  public $schema_configuration = [];
+
   /**
    * Whether the server is in debug mode.
    *
@@ -156,27 +165,34 @@ public function executeBatch($operations) {
 
   /**
    * {@inheritdoc}
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginException
    */
   public function configuration() {
     $params = \Drupal::getContainer()->getParameter('graphql.config');
+    /** @var \Drupal\graphql\Plugin\SchemaPluginManager $manager */
     $manager = \Drupal::service('plugin.manager.graphql.schema');
+    $schema = $this->get('schema');
 
     /** @var \Drupal\graphql\Plugin\SchemaPluginInterface $plugin */
-    $plugin = $manager->createInstance($this->get('schema'));
-    $registry = $plugin->getResolverRegistry();
+    $plugin = $manager->createInstance($schema);
+    if ($plugin instanceof ConfigurableInterface && $config = $this->get('schema_configuration')) {
+      $plugin->setConfiguration($config[$schema] ?? []);
+    }
 
     // Create the server config.
-    $config = ServerConfig::create();
-    $config->setDebug(!!$this->get('debug'));
-    $config->setQueryBatching(!!$this->get('batching'));
-    $config->setValidationRules($this->getValidationRules());
-    $config->setPersistentQueryLoader($this->getPersistedQueryLoader());
-    $config->setContext($this->getContext($plugin, $params));
-    $config->setFieldResolver($this->getFieldResolver($registry));
-    $config->setSchema($plugin->getSchema($registry));
-    $config->setPromiseAdapter(new SyncPromiseAdapter());
-
-    return $config;
+    $registry = $plugin->getResolverRegistry();
+    $server = ServerConfig::create();
+    $server->setDebug(!!$this->get('debug'));
+    $server->setQueryBatching(!!$this->get('batching'));
+    $server->setValidationRules($this->getValidationRules());
+    $server->setPersistentQueryLoader($this->getPersistedQueryLoader());
+    $server->setContext($this->getContext($plugin, $params));
+    $server->setFieldResolver($this->getFieldResolver($registry));
+    $server->setSchema($plugin->getSchema($registry));
+    $server->setPromiseAdapter(new SyncPromiseAdapter());
+
+    return $server;
   }
 
   /**
@@ -290,10 +306,10 @@ protected function getFieldResolver(ResolverRegistryInterface $registry) {
    * essential when there is a need to adjust error format, for instance
    * to add an additional fields or remove some of the default ones.
    *
-   * @see \GraphQL\Error\FormattedError::prepareFormatter
-   *
    * @return mixed|callable
    *   The error formatter.
+   *
+   * @see \GraphQL\Error\FormattedError::prepareFormatter
    */
   protected function getErrorFormatter() {
     return function (Error $error) {
@@ -309,10 +325,10 @@ protected function getErrorFormatter() {
    * Allows to replace the default error handler with a custom one. For example
    * when there is a need to handle specific errors differently.
    *
-   * @see \GraphQL\Executor\ExecutionResult::toArray
-   *
    * @return mixed|callable
    *   The error handler.
+   *
+   * @see \GraphQL\Executor\ExecutionResult::toArray
    */
   protected function getErrorHandler() {
     return function (array $errors, callable $formatter) {

examples/src/Plugin/GraphQL/SchemaExtension/ExampleSchemaExtension.php

@@ -2,10 +2,15 @@
 
 namespace Drupal\graphql\Form;
 
+use Drupal\Component\Plugin\ConfigurableInterface;
 use Drupal\Component\Utility\UrlHelper;
+use Drupal\Core\Ajax\AjaxResponse;
+use Drupal\Core\Ajax\ReplaceCommand;
 use Drupal\Core\Entity\EntityForm;
 use Drupal\Core\Entity\EntityTypeInterface;
 use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Form\SubformState;
+use Drupal\Core\Plugin\PluginFormInterface;
 use Drupal\Core\Routing\RequestContext;
 use Drupal\graphql\Plugin\SchemaPluginManager;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -59,13 +64,33 @@ public static function create(ContainerInterface $container) {
   }
 
   /**
-   * {@inheritdoc}
+   * Ajax callback triggered by the type schema select element.
+   *
+   * @param array $form
+   *   The form array.
+   *
+   * @return \Drupal\Core\Ajax\AjaxResponse
+   *   The ajax response.
    */
-  public function form(array $form, FormStateInterface $formStaet) {
-    $form = parent::form($form, $formStaet);
+  public function ajaxSchemaConfigurationForm(array $form) {
+    $response = new AjaxResponse();
+    $response->addCommand(new ReplaceCommand('#edit-schema-configuration-plugin-wrapper', $form['schema_configuration']));
 
+    return $response;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function form(array $form, FormStateInterface $formState) {
+    $form = parent::form($form, $formState);
     /** @var \Drupal\graphql\Entity\ServerInterface $server */
     $server = $this->entity;
+    $schemas = array_map(function ($definition) {
+      return $definition['name'] ?? $definition['id'];
+    }, $this->schemaManager->getDefinitions());
+    $schema = ($formState->getUserInput()['schema'] ?: $server->get('schema')) ?: reset(array_keys($schemas));
+
     if ($this->operation == 'add') {
       $form['#title'] = $this->t('Add server');
     }
@@ -96,13 +121,39 @@ public function form(array $form, FormStateInterface $formStaet) {
     $form['schema'] = [
       '#title' => t('Schema'),
       '#type' => 'select',
-      '#options' => array_map(function ($definition) {
-        return $definition['name'] ?? $definition['id'];
-      }, $this->schemaManager->getDefinitions()),
-      '#default_value' => $server->get('schema'),
+      '#options' => $schemas,
+      '#default_value' => $schema,
       '#description' => t('The schema to use with this server.'),
+      '#ajax' => [
+        'callback' => '::ajaxSchemaConfigurationForm',
+        'progress' => [
+          'type' => 'throbber',
+          'message' => $this->t('Updating schema configuration form.'),
+        ],
+      ],
+    ];
+
+    $form['schema_configuration'] = [
+      '#type' => 'container',
+      '#prefix' => '<div id="edit-schema-configuration-plugin-wrapper">',
+      '#suffix' => '</div>',
+      '#tree' => TRUE,
     ];
 
+    /* @var \Drupal\graphql\Plugin\SchemaPluginInterface $instance */
+    $instance = $schema ? $this->schemaManager->createInstance($schema) : NULL;
+    if ($instance instanceof PluginFormInterface && $instance instanceof ConfigurableInterface) {
+      $instance->setConfiguration($server->get('schema_configuration')[$schema] ?? []);
+
+      $form['schema_configuration'][$schema] = [
+        '#type' => 'fieldset',
+        '#title' => $this->t('Schema configuration'),
+        '#tree' => TRUE,
+      ];
+
+      $form['schema_configuration'][$schema] += $instance->buildConfigurationForm([], $formState);
+    }
+
     $form['endpoint'] = [
       '#title' => t('Endpoint'),
       '#type' => 'textfield',
@@ -148,6 +199,8 @@ public function form(array $form, FormStateInterface $formStaet) {
 
   /**
    * {@inheritdoc}
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginException
    */
   public function validateForm(array &$form, FormStateInterface $formState) {
     $endpoint = &$formState->getValue('endpoint');
@@ -158,13 +211,35 @@ public function validateForm(array &$form, FormStateInterface $formState) {
     if ($endpoint[0] !== '/') {
       $formState->setErrorByName('endpoint', 'The endpoint path has to start with a forward slash.');
     }
-    else if (!UrlHelper::isValid($endpoint)) {
+    elseif (!UrlHelper::isValid($endpoint)) {
       $formState->setErrorByName('endpoint', 'The endpoint path contains invalid characters.');
     }
+
+    /* @var \Drupal\graphql\Plugin\SchemaPluginInterface $instance */
+    $schema = $formState->getValue('schema');
+    $instance = $this->schemaManager->createInstance($schema);
+    if (!empty($form['schema_configuration'][$schema]) && $instance instanceof PluginFormInterface && $instance instanceof ConfigurableInterface) {
+      $state = SubformState::createForSubform($form['schema_configuration'][$schema], $form, $formState);
+      $instance->validateConfigurationForm($form['schema_configuration'][$schema], $state);
+    }
+  }
+
+  public function submitForm(array &$form, FormStateInterface $formState) {
+    parent::submitForm($form, $formState);
+
+    /* @var \Drupal\graphql\Plugin\SchemaPluginInterface $instance */
+    $schema = $formState->getValue('schema');
+    $instance = $this->schemaManager->createInstance($schema);
+    if ($instance instanceof PluginFormInterface && $instance instanceof  ConfigurableInterface) {
+      $state = SubformState::createForSubform($form['schema_configuration'][$schema], $form, $formState);
+      $instance->submitConfigurationForm($form['schema_configuration'][$schema], $state);
+    }
   }
 
   /**
    * {@inheritdoc}
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginException
    */
   public function save(array $form, FormStateInterface $formState) {
     parent::save($form, $formState);