feat(server): Add Persisted Queries support (#707)

Author: chindris

config/schema/graphql.schema.yml

@@ -25,6 +25,13 @@ graphql.graphql_servers.*:
       label: 'Batching'
     schema_configuration:
       type: 'graphql.schema.[%parent.schema]'
+    persisted_queries_settings:
+      type: sequence
+      label: 'Persisted queries settings'
+      orderby: key
+      sequence:
+        type: plugin.plugin_configuration.persisted_query.[%key]
+        label: 'The configuration for a single persisted query plugin.'
 
 graphql.schema.*:
   type: mapping
@@ -39,3 +46,14 @@ graphql.schema.composable:
       type: sequence
       sequence:
         type: boolean
+
+graphql.default_persisted_query_configuration:
+  type: mapping
+  label: 'Persisted query settings'
+  mapping:
+    weight:
+      type: integer
+      label: 'The weight'
+
+plugin.plugin_configuration.persisted_query.*:
+  type: graphql.default_persisted_query_configuration

graphql.libraries.yml

@@ -24,3 +24,12 @@ voyager:
     - core/drupal
     - core/jquery
     - core/jquery.once
+
+persisted_queries:
+  version: VERSION
+  js:
+    js/persisted_queries.js: {}
+  dependencies:
+    - core/drupal
+    - core/jquery
+    - core/jquery.once

graphql.links.task.yml

@@ -9,6 +9,11 @@ entity.graphql_server.delete_form:
   title: Delete
   weight: 10
 
+entity.graphql_server.persisted_queries_form:
+  route_name: entity.graphql_server.persisted_queries_form
+  base_route: entity.graphql_server.edit_form
+  title: Persisted queries
+
 graphql.explorer:
   route_name: graphql.explorer
   base_route: entity.graphql_server.edit_form

graphql.routing.yml

@@ -28,6 +28,16 @@ entity.graphql_server.edit_form:
   options:
     _admin_route: TRUE
 
+entity.graphql_server.persisted_queries_form:
+  path: '/admin/config/graphql/servers/manage/{graphql_server}/persisted_queries'
+  defaults:
+    _entity_form: 'graphql_server.persisted_queries'
+    _title: 'Persisted queries'
+  requirements:
+    _permission: 'administer graphql configuration'
+  options:
+    _admin_route: TRUE
+
 graphql.explorer:
   path: '/admin/config/graphql/servers/manage/{graphql_server}/explorer'
   defaults:

graphql.services.yml

@@ -141,6 +141,17 @@ services:
       - '\Drupal\graphql\Annotation\DataProducer'
       - '%graphql.config%'
 
+  plugin.manager.graphql.persisted_query:
+    class: Drupal\graphql\Plugin\PersistedQueryPluginManager
+    arguments:
+      - 'Plugin/GraphQL/PersistedQuery'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '@cache.graphql.definitions'
+      - '\Drupal\graphql\Plugin\PersistedQueryPluginInterface'
+      - '\Drupal\graphql\Annotation\PersistedQuery'
+      - '%graphql.config%'
+
   # Buffers.
   graphql.buffer.entity:
     class: Drupal\graphql\GraphQL\Buffers\EntityBuffer

js/persisted_queries.js

@@ -0,0 +1,50 @@
+/**
+ * @file
+ * Attaches the show/hide functionality to checkboxes in the "Persisted queries"
+ * form.
+ */
+
+(function ($) {
+
+  'use strict';
+
+  Drupal.behaviors.persistedQueries = {
+    attach: function (context, settings) {
+      $('.persisted-queries-enabled-wrapper input.form-checkbox', context).each(function () {
+        var $checkbox = $(this);
+        var plugin_id = $checkbox.data('id');
+
+        var $rows = $('.persisted-queries-weight--' + plugin_id, context);
+        var tab = $('.persisted-queries-settings--' + plugin_id, context).data('verticalTab');
+
+        // Bind a click handler to this checkbox to conditionally show and hide
+        // the processor's table row and vertical tab pane.
+        $checkbox.on('click.persistedQueryUpdate', function () {
+          if ($checkbox.is(':checked')) {
+            $rows.show();
+            if (tab) {
+              tab.tabShow().updateSummary();
+            }
+          }
+          else {
+            $rows.hide();
+            if (tab) {
+              tab.tabHide().updateSummary();
+            }
+          }
+        });
+
+        // Attach summary for configurable items (only for screen-readers).
+        /*if (tab) {
+          tab.details.drupalSetSummary(function () {
+            return $checkbox.is(':checked') ? Drupal.t('Enabled') : Drupal.t('Disabled');
+          });
+        }*/
+
+        // Trigger our bound click handler to update elements to initial state.
+        $checkbox.triggerHandler('click.persistedQueryUpdate');
+      });
+    }
+  };
+
+})(jQuery);

src/Annotation/PersistedQuery.php

@@ -0,0 +1,55 @@
+<?php
+
+
+namespace Drupal\graphql\Annotation;
+
+
+use Doctrine\Common\Annotations\AnnotationException;
+use Drupal\Component\Annotation\Plugin;
+
+/**
+ * Annotation for persisted query plugins.
+ *
+ * @Annotation
+ * @codeCoverageIgnore
+ */
+class PersistedQuery extends Plugin {
+
+  /**
+   * The plugin ID.
+   *
+   * @var string
+   */
+  public $id;
+
+  /**
+   * The component label.
+   *
+   * @var string
+   */
+  public $label;
+
+  /**
+   * The component description.
+   *
+   * @var string
+   */
+  public $description = '';
+
+  /**
+   * PersistedQuery constructor.
+   *
+   * @param $values
+   *   The plugin annotation values.
+   *
+   * @throws \Doctrine\Common\Annotations\AnnotationException
+   *   In case of missing required annotation values.
+   */
+  public function __construct($values) {
+    if (!array_key_exists('id', $values) || !$values['id']) {
+      throw new AnnotationException('The plugin is missing an "id" property.');
+    }
+
+    parent::__construct($values);
+  }
+}

src/Controller/ServerListBuilder.php

@@ -56,6 +56,14 @@ public function getDefaultOperations(EntityInterface $entity) {
       ];
     }
 
+    if (\Drupal::currentUser()->hasPermission("administer graphql configuration")) {
+      $operations['persisted_queries'] = [
+        'title' => 'Persisted queries',
+        'weight' => 10,
+        'url' => Url::fromRoute('entity.graphql_server.persisted_queries_form', ['graphql_server' => $id]),
+      ];
+    }
+
     return $operations;
   }