feat: add APQ plugin

graphql.services.yml

@@ -39,6 +39,14 @@ services:
     tags:
       - { name: cache.context }
 
+  # Cache bin for the persisted queries.
+  cache.graphql.apq:
+    class: Drupal\Core\Cache\CacheBackendInterface
+    tags:
+      - { name: cache.bin }
+    factory: cache_factory:get
+    arguments: [graphql_apq]
+
   # Cache bin for the parsed sdl ast.
   cache.graphql.ast:
     class: Drupal\Core\Cache\CacheBackendInterface
@@ -108,6 +116,13 @@ services:
     tags:
       - { name: event_subscriber }
 
+  # Cache the queries to be persistent.
+  graphql.apq_subscriber:
+    class: Drupal\graphql\EventSubscriber\ApqSubscriber
+    arguments: ['@cache.graphql.apq']
+    tags:
+      - { name: event_subscriber }
+
   # Plugin manager for schemas
   plugin.manager.graphql.schema:
     class: Drupal\graphql\Plugin\SchemaPluginManager

src/Entity/ServerInterface.php

@@ -60,7 +60,7 @@ public function removeAllPersistedQueryInstances();
   /**
    * Returns the current persisted queries set.
    *
-   * @return \Drupal\graphql\Plugin\PersistedQueryPluginInterface[]
+   * @return \Drupal\graphql\Plugin\PersistedQueryPluginInterface[]|null
    */
   public function getPersistedQueryInstances();
 

src/EventSubscriber/ApqSubscriber.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Drupal\graphql\EventSubscriber;
+
+use Drupal\Core\Cache\CacheBackendInterface;
+use Drupal\graphql\Event\OperationEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use GraphQL\Error\Error;
+
+/**
+ * Save persisted queries to cache.
+ */
+class ApqSubscriber implements EventSubscriberInterface {
+
+  /**
+   * The cache to store persisted queries.
+   *
+   * @var \Drupal\Core\Cache\CacheBackendInterface
+   */
+  protected $cache;
+
+  /**
+   * Constructs a ApqSubscriber object.
+   *
+   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
+   *   The cache to store persisted queries.
+   */
+  public function __construct(CacheBackendInterface $cache) {
+    $this->cache = $cache;
+  }
+
+  /**
+   * Handle operation start events.
+   *
+   * @param \Drupal\graphql\Event\OperationEvent $event
+   *   The kernel event object.
+   *
+   * @throws \GraphQL\Error\Error
+   */
+  public function onBeforeOperation(OperationEvent $event): void {
+    if (!array_key_exists('automatic_persisted_query', $event->getContext()->getServer()->getPersistedQueryInstances() ?? [])) {
+      return;
+    }
+    $query = $event->getContext()->getOperation()->query;
+    $queryHash = $event->getContext()->getOperation()->extensions['persistedQuery']['sha256Hash'] ?? '';
+
+    if ($query && $queryHash) {
+      $computedQueryHash = hash('sha256', $query);
+      if ($queryHash !== $computedQueryHash) {
+        throw new Error('Provided sha does not match query');
+      }
+      $this->cache->set($queryHash, $query);
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function getSubscribedEvents() {
+    return [
+      OperationEvent::GRAPHQL_OPERATION_BEFORE => 'onBeforeOperation',
+    ];
+  }
+
+}

src/Plugin/GraphQL/PersistedQuery/AutomaticPersistedQuery.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Drupal\graphql\Plugin\GraphQL\PersistedQuery;
+
+use Drupal\Core\Cache\CacheBackendInterface;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\graphql\PersistedQuery\PersistedQueryPluginBase;
+use GraphQL\Server\OperationParams;
+use GraphQL\Server\RequestError;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Load persisted queries from the cache.
+ *
+ * @PersistedQuery(
+ *   id = "automatic_persisted_query",
+ *   label = "Automatic Persisted Query",
+ *   description = "Load persisted queries from the cache."
+ * )
+ */
+class AutomaticPersistedQuery extends PersistedQueryPluginBase implements ContainerFactoryPluginInterface {
+
+  /**
+   * The cache to store persisted queries.
+   *
+   * @var \Drupal\Core\Cache\CacheBackendInterface
+   */
+  protected $cache;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, CacheBackendInterface $cache) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+
+    $this->cache = $cache;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static($configuration, $plugin_id, $plugin_definition, $container->get('cache.graphql.apq'));
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getQuery($id, OperationParams $operation) {
+    if ($query = $this->cache->get($id)) {
+      return $query->data;
+    }
+    throw new RequestError('PersistedQueryNotFound');
+  }
+
+}

tests/src/Kernel/Framework/AutomaticPersistedQueriesTest.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace Drupal\Tests\graphql\Kernel\Framework;
+
+use Drupal\Tests\graphql\Kernel\GraphQLTestBase;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Tests the automatic persisted query plugin.
+ *
+ * @group graphql
+ */
+class AutomaticPersistedQueriesTest extends GraphQLTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp(): void {
+    parent::setUp();
+    $schema = <<<GQL
+      schema {
+        query: Query
+      }
+      type Query {
+        field_one: String
+      }
+  GQL;
+
+    $this->setUpSchema($schema);
+    $this->mockResolver('Query', 'field_one', 'this is the field one');
+
+    /** @var \Drupal\graphql\Plugin\DataProducerPluginManager $manager */
+    $manager = $this->container->get('plugin.manager.graphql.persisted_query');
+
+    $this->plugin_apq = $manager->createInstance('automatic_persisted_query');
+  }
+
+  /**
+   * Test the automatic persisted queries plugin.
+   */
+  public function testAutomaticPersistedQueries(): void {
+    // Before adding the persisted query plugins to the server, we want to make
+    // sure that there are no existing plugins already there.
+    $this->server->removeAllPersistedQueryInstances();
+    $this->server->addPersistedQueryInstance($this->plugin_apq);
+    $this->server->save();
+
+    $endpoint = $this->server->get('endpoint');
+
+    $query = 'query { field_one } ';
+    $parameters['extensions']['persistedQuery']['sha256Hash'] = 'some random hash';
+
+    // Check we get PersistedQueryNotFound.
+    $request = Request::create($endpoint, 'GET', $parameters);
+    $result = $this->container->get('http_kernel')->handle($request);
+    $this->assertSame(200, $result->getStatusCode());
+    $this->assertSame([
+      'errors' => [
+        [
+          'message' => 'PersistedQueryNotFound',
+          'extensions' => ['category' => 'request'],
+        ],
+      ],
+    ], json_decode($result->getContent(), TRUE));
+
+    // Post query to endpoint with a not matching hash.
+    $content = json_encode(['query' => $query] + $parameters);
+    $request = Request::create($endpoint, 'POST', [], [], [], [], $content);
+    $result = $this->container->get('http_kernel')->handle($request);
+    $this->assertSame(200, $result->getStatusCode());
+    $this->assertSame([
+      'errors' => [
+        [
+          'message' => 'Provided sha does not match query',
+          'extensions' => ['category' => 'graphql'],
+        ],
+      ],
+    ], json_decode($result->getContent(), TRUE));
+
+    // Post query to endpoint to get the result and cache it.
+    $parameters['extensions']['persistedQuery']['sha256Hash'] = hash('sha256', $query);
+
+    $content = json_encode(['query' => $query] + $parameters);
+    $request = Request::create($endpoint, 'POST', [], [], [], [], $content);
+    $result = $this->container->get('http_kernel')->handle($request);
+    $this->assertSame(200, $result->getStatusCode());
+    $this->assertSame(['data' => ['field_one' => 'this is the field one']], json_decode($result->getContent(), TRUE));
+
+    // Execute first request again.
+    $request = Request::create($endpoint, 'GET', $parameters);
+    $result = $this->container->get('http_kernel')->handle($request);
+    $this->assertSame(200, $result->getStatusCode());
+    $this->assertSame(['data' => ['field_one' => 'this is the field one']], json_decode($result->getContent(), TRUE));
+  }
+
+}