Allow static cache contexts. (#829)

Author: fubhy

graphql.services.yml

@@ -24,6 +24,13 @@ services:
     parent: logger.channel_base
     arguments: ['graphql']
 
+  # Allows to statically define cache contexts.
+  # TODO: This seems to be a missing feature in core.
+  cache_context.static:
+    class: Drupal\graphql\Cache\Context\StaticCacheContext
+    tags:
+      - { name: cache.context }
+
   # Cache bin for the parsed sdl ast.
   cache.graphql.ast:
     class: Drupal\Core\Cache\CacheBackendInterface

src/Cache/Context/StaticCacheContext.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Drupal\graphql\Cache\Context;
+
+use Drupal\Core\Cache\CacheableMetadata;
+use Drupal\Core\Cache\Context\CalculatedCacheContextInterface;
+
+class StaticCacheContext implements CalculatedCacheContextInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function getLabel() {
+    return t('Static');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getContext($parameter = NULL) {
+    return $parameter ?: '';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCacheableMetadata($parameter = NULL) {
+    return new CacheableMetadata();
+  }
+
+}

src/GraphQL/Execution/FieldContext.php

@@ -27,7 +27,6 @@ class FieldContext implements RefinableCacheableDependencyInterface {
    */
   public function __construct(ResolveContext $context, ResolveInfo $info) {
     $this->addCacheContexts(['user.permissions']);
-
     $this->context = $context;
     $this->info = $info;
   }

src/Plugin/GraphQL/DataProducer/Entity/EntityLoad.php

@@ -140,8 +140,9 @@ public function resolve($type, $id = NULL, $language = NULL, $bundles = NULL, Fi
         return NULL;
       }
 
-      if (isset($language) && $language != $entity->language()->getId() && $entity instanceof TranslatableInterface) {
+      if (isset($language) && $language !== $entity->language()->getId() && $entity instanceof TranslatableInterface) {
         $entity = $entity->getTranslation($language);
+        $entity->addCacheContexts(["static:language:{$language}"]);
       }
 
       return $entity;

src/Plugin/GraphQL/DataProducer/Entity/EntityLoadByUuid.php

@@ -2,12 +2,10 @@
 
 namespace Drupal\graphql\Plugin\GraphQL\DataProducer\Entity;
 
-use Drupal\Core\Cache\RefinableCacheableDependencyInterface;
 use Drupal\Core\Entity\EntityRepositoryInterface;
 use Drupal\Core\Entity\EntityTypeManager;
 use Drupal\Core\Entity\TranslatableInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
-use Drupal\graphql\GraphQL\Buffers\EntityBuffer;
 use Drupal\graphql\GraphQL\Buffers\EntityUuidBuffer;
 use Drupal\graphql\GraphQL\Execution\FieldContext;
 use Drupal\graphql\Plugin\GraphQL\DataProducer\DataProducerPluginBase;
@@ -144,6 +142,7 @@ public function resolve($type, $uuid, $language = NULL, $bundles = [], FieldCont
 
       if (isset($language) && $language != $entity->language()->getId() && $entity instanceof TranslatableInterface) {
         $entity = $entity->getTranslation($language);
+        $entity->addCacheContexts(["static:language:{$language}"]);
       }
 
       return $entity;

src/Plugin/GraphQL/DataProducer/Entity/EntityLoadMultiple.php

@@ -125,6 +125,7 @@ public function resolve($type, array $ids, $language = NULL, array $bundles = NU
     $resolver = $this->entityBuffer->add($type, $ids);
 
     return new Deferred(function () use ($type, $ids, $language, $bundles, $resolver, $context) {
+      /** @var \Drupal\Core\Entity\EntityInterface[] $entities */
       if (!$entities = $resolver()) {
         // 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.
@@ -137,16 +138,15 @@ public function resolve($type, array $ids, $language = NULL, array $bundles = NU
 
       foreach ($entities as $id => $entity) {
         $context->addCacheableDependency($entities[$id]);
-
         if (isset($bundles) && !in_array($entities[$id]->bundle(), $bundles)) {
           // If the entity is not among the allowed bundles, don't return it.
           unset($entities[$id]);
           continue;
         }
 
-        if (isset($language) && $language != $entities[$id]->language()
-            ->getId() && $entities[$id] instanceof TranslatableInterface) {
+        if (isset($language) && $language !== $entities[$id]->language()->getId() && $entities[$id] instanceof TranslatableInterface) {
           $entities[$id] = $entities[$id]->getTranslation($language);
+          $entities[$id]->addCacheContexts(["static:language:{$language}"]);
         }
 
         $access = $entity->access('view', NULL, TRUE);

src/Plugin/GraphQL/DataProducer/Entity/EntityTranslation.php

@@ -79,7 +79,9 @@ public function __construct(array $configuration, $pluginId, $pluginDefinition,
    */
   public function resolve(EntityInterface $entity, $language) {
     if ($entity instanceof TranslatableInterface && $entity->isTranslatable()) {
-      return $entity->getTranslation($language);
+      $entity = $entity->getTranslation($language);
+      $entity->addCacheContexts(["static:language:{$language}"]);
+      return $entity;
     }
 
     return NULL;

src/Plugin/GraphQL/DataProducer/Entity/EntityTranslations.php

@@ -81,7 +81,10 @@ public function resolve(EntityInterface $entity) {
       $languages = $entity->getTranslationLanguages();
 
       return array_map(function (LanguageInterface $language) use ($entity) {
-        return $entity->getTranslation($language->getId());
+        $langcode = $language->getId();
+        $entity = $entity->getTranslation($langcode);
+        $entity->addCacheContexts(["static:language:{$langcode}"]);
+        return $entity;
       }, $languages);
     }
 

src/Plugin/GraphQL/DataProducer/Field/EntityReference.php

@@ -2,7 +2,6 @@
 
 namespace Drupal\graphql\Plugin\GraphQL\DataProducer\Field;
 
-use Drupal\Core\Cache\RefinableCacheableDependencyInterface;
 use Drupal\Core\Entity\EntityInterface;
 use Drupal\Core\Entity\EntityRepositoryInterface;
 use Drupal\Core\Entity\EntityTypeManager;
@@ -160,7 +159,9 @@ public function resolve(EntityInterface $entity, $field, $language = NULL, $bund
         if (isset($language)) {
           $entities = array_map(function (EntityInterface $entity) use ($language) {
             if ($language != $entity->language()->getId() && $entity instanceof TranslatableInterface) {
-              return $entity->getTranslation($language);
+              $entity = $entity->getTranslation($language);
+              $entity->addCacheContexts(["static:language:{$language}"]);
+              return $entity;
             }
 
             return $entity;

tests/src/Traits/DataProducerExecutionTrait.php

@@ -30,7 +30,6 @@ protected function executeDataProducer($id, $contexts = []) {
     $context->addCacheContexts(Argument::any())->willReturn($context->reveal());
     $context->addCacheTags(Argument::any())->willReturn($context->reveal());
     $context->mergeCacheMaxAge(Argument::any())->willReturn($context->reveal());
-
     $context->getContextValue(Argument::any(), Argument::any())->willReturn(NULL);
     $context->setContextValue(Argument::any(), Argument::any())->willReturn(FALSE);
     $context->hasContextValue(Argument::any())->willReturn(FALSE);