Allow loading of entity revisions. (#496)

Author: fubhy

modules/graphql_core/src/Plugin/Deriver/Fields/EntityByIdDeriver.php

@@ -10,9 +10,6 @@
 use Drupal\graphql\Utility\StringHelper;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
-/**
- * Create GraphQL entityById fields based on available Drupal entity types.
- */
 class EntityByIdDeriver extends DeriverBase implements ContainerDeriverInterface {
 
   use StringTranslationTrait;
@@ -28,17 +25,13 @@ class EntityByIdDeriver extends DeriverBase implements ContainerDeriverInterface
    * {@inheritdoc}
    */
   public static function create(ContainerInterface $container, $basePluginId) {
-    return new static(
-      $container->get('entity_type.manager')
-    );
+    return new static($container->get('entity_type.manager'));
   }
 
   /**
    * {@inheritdoc}
    */
-  public function __construct(
-    EntityTypeManagerInterface $entityTypeManager
-  ) {
+  public function __construct(EntityTypeManagerInterface $entityTypeManager) {
     $this->entityTypeManager = $entityTypeManager;
   }
 

modules/graphql_core/src/Plugin/Deriver/Fields/EntityFieldPropertyDeriver.php

@@ -10,9 +10,6 @@
 use Drupal\graphql\Utility\StringHelper;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
-/**
- * Attach new properties to field types.
- */
 class EntityFieldPropertyDeriver extends DeriverBase implements ContainerDeriverInterface {
 
   /**

modules/graphql_core/src/Plugin/Deriver/Fields/EntityQueryDeriver.php

@@ -12,9 +12,6 @@
 use Drupal\graphql\Utility\StringHelper;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
-/**
- * Create GraphQL entityQuery fields based on available Drupal entity types.
- */
 class EntityQueryDeriver extends DeriverBase implements ContainerDeriverInterface {
   use StringTranslationTrait;
 

modules/graphql_core/src/Plugin/Deriver/Fields/EntityRevisionByIdDeriver.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Drupal\graphql_core\Plugin\Deriver\Fields;
+
+use Drupal\Component\Plugin\Derivative\DeriverBase;
+use Drupal\Core\Entity\ContentEntityTypeInterface;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Drupal\graphql\Utility\StringHelper;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+class EntityRevisionByIdDeriver extends DeriverBase implements ContainerDeriverInterface {
+
+  use StringTranslationTrait;
+
+  /**
+   * The entity type manager service.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, $basePluginId) {
+    return new static($container->get('entity_type.manager'));
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function __construct(EntityTypeManagerInterface $entityTypeManager) {
+    $this->entityTypeManager = $entityTypeManager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getDerivativeDefinitions($basePluginDefinition) {
+    foreach ($this->entityTypeManager->getDefinitions() as $id => $type) {
+      if ($type instanceof ContentEntityTypeInterface && $type->isRevisionable()) {
+        $derivative = [
+          'name' => StringHelper::propCase($id, 'revision', 'by', 'id'),
+          'type' => "entity:$id",
+          'description' => $this->t("Loads '@type' entity revision by their revision id.", ['@type' => $type->getLabel()]),
+          'entity_type' => $id,
+        ] + $basePluginDefinition;
+
+        if ($type->isTranslatable()) {
+          $derivative['arguments']['language'] = [
+            'type' => 'LanguageId',
+          ];
+        }
+
+        $this->derivatives["entity:$id"] = $derivative;
+      }
+    }
+
+    return parent::getDerivativeDefinitions($basePluginDefinition);
+  }
+
+}

modules/graphql_core/src/Plugin/GraphQL/Enums/EntityQuery/EntityQueryRevisionMode.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Drupal\graphql_core\Plugin\GraphQL\Enums\EntityQuery;
+
+use Drupal\graphql\Plugin\GraphQL\Enums\EnumPluginBase;
+
+/**
+ * @GraphQLEnum(
+ *   id = "entity_query_revision_mode",
+ *   name = "EntityQueryRevisionMode",
+ *   values = {
+ *     "default" = {
+ *       "name" = "default",
+ *       "description" = @Translation("Loads the current (default) revisions."),
+ *     },
+ *     "all" = {
+ *       "name" = "all",
+ *       "description" = @Translation("Loads all revisions."),
+ *     }
+ *   }
+ * )
+ */
+class EntityQueryRevisionMode extends EnumPluginBase {
+
+}

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityById.php

@@ -18,8 +18,6 @@
  * @GraphQLField(
  *   id = "entity_by_id",
  *   secure = true,
- *   name = "entityById",
- *   weight = -1,
  *   arguments = {
  *     "id" = "String!"
  *   },

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityRevisionById.php

@@ -0,0 +1,104 @@
+<?php
+
+namespace Drupal\graphql_core\Plugin\GraphQL\Fields\Entity;
+
+use Drupal\Core\Cache\CacheableMetadata;
+use Drupal\Core\DependencyInjection\DependencySerializationTrait;
+use Drupal\Core\Entity\EntityRepositoryInterface;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\graphql\GraphQL\Buffers\EntityBuffer;
+use Drupal\graphql\GraphQL\Cache\CacheableValue;
+use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Youshido\GraphQL\Execution\ResolveInfo;
+
+/**
+ * @GraphQLField(
+ *   id = "entity_revision_by_id",
+ *   secure = true,
+ *   arguments = {
+ *     "id" = "String!"
+ *   },
+ *   deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\EntityRevisionByIdDeriver"
+ * )
+ */
+class EntityRevisionById extends FieldPluginBase implements ContainerFactoryPluginInterface {
+  use DependencySerializationTrait;
+
+  /**
+   * The entity type manager service.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * The entity repository service.
+   *
+   * @var \Drupal\Core\Entity\EntityRepositoryInterface
+   */
+  protected $entityRepository;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function __construct(
+    array $configuration,
+    $pluginId,
+    $pluginDefinition,
+    EntityTypeManagerInterface $entityTypeManager,
+    EntityRepositoryInterface $entityRepository
+  ) {
+    parent::__construct($configuration, $pluginId, $pluginDefinition);
+    $this->entityTypeManager = $entityTypeManager;
+    $this->entityRepository = $entityRepository;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
+    return new static(
+      $configuration,
+      $pluginId,
+      $pluginDefinition,
+      $container->get('entity_type.manager'),
+      $container->get('entity.repository')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function resolveValues($value, array $args, ResolveInfo $info) {
+    $definition = $this->getPluginDefinition();
+    $storage = $this->entityTypeManager->getStorage($definition['entity_type']);
+
+    if (!$entity = $storage->loadRevision($args['id'])) {
+      // If there is no entity with this id, add the list cache tags so that the
+      // cache entry is purged whenever a new entity of this type is saved.
+      $pluginDefinition = $this->getPluginDefinition();
+      $entityType = $this->entityTypeManager->getDefinition($pluginDefinition['entity_type']);
+      $metadata = new CacheableMetadata();
+      $metadata->addCacheTags($entityType->getListCacheTags());
+
+      yield new CacheableValue(NULL, [$metadata]);
+    }
+    /** @var \Drupal\Core\Access\AccessResultInterface $access */
+    else if (($access = $entity->access('view', NULL, TRUE)) && $access->isAllowed()) {
+      if (isset($args['language']) && $args['language'] != $entity->language()->getId()) {
+        $entity = $this->entityRepository->getTranslationFromContext($entity, $args['language']);
+      }
+
+      yield new CacheableValue($entity, [$access]);
+    }
+    else {
+      // If the entity exists but we do not grant access to it, we still want
+      // to have it's cache metadata in the output because future changes to
+      // the entity might affect its visibility for the user.
+      yield new CacheableValue(NULL, [$access]);
+    }
+  }
+
+}

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityTranslation.php

@@ -17,7 +17,6 @@
  *   id = "entity_translation",
  *   secure = true,
  *   name = "entityTranslation",
- *   weight = -1,
  *   type = "Entity",
  *   parents = {"Entity"},
  *   arguments = {

modules/graphql_core/src/Plugin/GraphQL/Fields/EntityQuery/EntityQuery.php

@@ -11,14 +11,10 @@
 use Youshido\GraphQL\Execution\ResolveInfo;
 
 /**
- * Retrieve a list of entities through an entity query.
- *
  * @GraphQLField(
  *   id = "entity_query",
  *   secure = true,
- *   name = "entityQuery",
  *   type = "EntityQueryResult!",
- *   weight = -1,
  *   arguments = {
  *     "offset" = {
  *       "type" = "Int",
@@ -27,6 +23,10 @@
  *     "limit" = {
  *       "type" = "Int",
  *       "default" = 10
+ *     },
+ *     "revisions" = {
+ *       "type" = "EntityQueryRevisionMode",
+ *       "default" = "default"
  *     }
  *   },
  *   deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\EntityQueryDeriver"
@@ -106,6 +106,14 @@ protected function getQuery($value, array $args, ResolveInfo $info) {
     $query->sort($entityType->getKey('id'));
     $query->accessCheck(TRUE);
 
+    // Check if this is a query for all entity revisions.
+    if (!empty($args['revisions']) && $args['revisions'] === 'all') {
+      // Mark the query as such and sort by the revision id too.
+      $query->allRevisions();
+      $query->addTag('revisions');
+      $query->sort($entityType->getKey('revision'));
+    }
+
     if (!empty($args['filter'])) {
       /** @var \Youshido\GraphQL\Type\Object\AbstractObjectType $filter */
       $filter = $info->getField()->getArgument('filter')->getType();