Simplify and reduce cache metadata of responses (#686)

fubhy · web-flow · commit 46e0bc62f70b · 2018-09-28T15:57:33.000+02:00
diff --git a/modules/graphql_core/src/Plugin/Deriver/Fields/EntityFieldDeriver.php b/modules/graphql_core/src/Plugin/Deriver/Fields/EntityFieldDeriver.php
@@ -34,9 +34,6 @@ protected function getDerivativeDefinitionsFromFieldDefinition($entityTypeId, Fi
       'schema_cache_tags' => $tags,
       'schema_cache_contexts' => $contexts,
       'schema_cache_max_age' => $maxAge,
-      'response_cache_tags' => $tags,
-      'response_cache_contexts' => $contexts,
-      'response_cache_max_age' => $maxAge,
     ] + $basePluginDefinition;
 
     if (count($propertyDefinitions) === 1) {
diff --git a/modules/graphql_core/src/Plugin/Deriver/Fields/EntityFieldItemDeriver.php b/modules/graphql_core/src/Plugin/Deriver/Fields/EntityFieldItemDeriver.php
@@ -28,9 +28,6 @@ protected function getDerivativeDefinitionsFromFieldDefinition($entityTypeId, Fi
       'schema_cache_tags' => $tags,
       'schema_cache_contexts' => $contexts,
       'schema_cache_max_age' => $maxAge,
-      'response_cache_tags' => $tags,
-      'response_cache_contexts' => $contexts,
-      'response_cache_max_age' => $maxAge,
     ] + $basePluginDefinition;
 
     $derivatives = [];
diff --git a/modules/graphql_core/src/Plugin/Deriver/Fields/EntityReferenceQueryDeriver.php b/modules/graphql_core/src/Plugin/Deriver/Fields/EntityReferenceQueryDeriver.php
@@ -101,9 +101,6 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           'schema_cache_tags' => $tags,
           'schema_cache_contexts' => $contexts,
           'schema_cache_max_age' => $maxAge,
-          'response_cache_tags' => $tags,
-          'response_cache_contexts' => $contexts,
-          'response_cache_max_age' => $maxAge,
         ] + $basePluginDefinition;
 
         /** @var \Drupal\Core\Entity\TypedData\EntityDataDefinitionInterface $definition */
diff --git a/modules/graphql_core/src/Plugin/Deriver/Fields/EntityReferenceReverseDeriver.php b/modules/graphql_core/src/Plugin/Deriver/Fields/EntityReferenceReverseDeriver.php
@@ -98,9 +98,6 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           'schema_cache_tags' => $tags,
           'schema_cache_contexts' => $contexts,
           'schema_cache_max_age' => $maxAge,
-          'response_cache_tags' => $tags,
-          'response_cache_contexts' => $contexts,
-          'response_cache_max_age' => $maxAge,
         ] + $basePluginDefinition;
 
         /** @var \Drupal\Core\Entity\TypedData\EntityDataDefinitionInterface $definition */
diff --git a/modules/graphql_core/src/Plugin/GraphQL/Fields/Blocks/BlocksByRegion.php b/modules/graphql_core/src/Plugin/GraphQL/Fields/Blocks/BlocksByRegion.php
@@ -143,8 +143,6 @@ protected function resolveValues($value, array $args, ResolveContext $context, R
       return function ($value, array $args, ResolveContext $context, ResolveInfo $info) use ($resolve) {
         /** @var \Drupal\graphql\GraphQL\Cache\CacheableValue $response */
         $response = $resolve();
-        $metadata = new CacheableMetadata();
-        $metadata->addCacheTags(['config:block_list']);
         $blocks = array_map(function (Block $block) {
           $plugin = $block->getPlugin();
           if ($plugin instanceof BlockContentBlock) {
@@ -156,7 +154,7 @@ protected function resolveValues($value, array $args, ResolveContext $context, R
         }, $response->getValue());
 
         foreach ($blocks as $block) {
-          yield new CacheableValue($block, [$metadata, $response]);
+          yield new CacheableValue($block, [$response]);
         }
       };
     }
diff --git a/modules/graphql_core/tests/src/Kernel/Blocks/BlockTest.php b/modules/graphql_core/tests/src/Kernel/Blocks/BlockTest.php
@@ -66,14 +66,10 @@ protected function setUp() {
   public function testStaticBlocks() {
     $query = $this->getQueryFromFile('Blocks/blocks.gql');
     $metadata = $this->defaultCacheMetaData();
-
-    // TODO: Check cache metadata.
     $metadata->addCacheTags([
-      'config:block_list',
       'block_content:1',
+      // TODO: Check metatags. Is the config metatag required?
       'config:block.block.stark_powered',
-      'config:field.storage.block_content.body',
-      'entity_field_info',
     ]);
 
     $this->assertResults($query, [], [
diff --git a/modules/graphql_core/tests/src/Kernel/Breadcrumbs/BreadcrumbsTest.php b/modules/graphql_core/tests/src/Kernel/Breadcrumbs/BreadcrumbsTest.php
@@ -49,10 +49,7 @@ protected function setUp() {
    */
   public function testBreadcrumbs() {
     $query = $this->getQueryFromFile('breadcrumbs.gql');
-
-    // TODO: Check cache metadata.
     $metadata = $this->defaultCacheMetaData();
-    $metadata->setCacheTags(array_diff($metadata->getCacheTags(), ['entity_bundles']));
 
     $this->assertResults($query, ['path' => '/breadcrumbs-test'], [
       'route' => [
diff --git a/modules/graphql_core/tests/src/Kernel/Context/ContextTest.php b/modules/graphql_core/tests/src/Kernel/Context/ContextTest.php
@@ -20,10 +20,7 @@ class ContextTest extends GraphQLCoreTestBase {
    */
   public function testSimpleContext() {
     $query = $this->getQueryFromFile('context.gql');
-
-    // TODO: Check cache metadata.
     $metadata = $this->defaultCacheMetaData();
-    $metadata->setCacheTags(array_diff($metadata->getCacheTags(), ['entity_bundles']));
 
     $this->assertResults($query, [], [
       'a' => ['name' => 'graphql_context_test.a'],
diff --git a/modules/graphql_core/tests/src/Kernel/Entity/EntityFieldValueTest.php b/modules/graphql_core/tests/src/Kernel/Entity/EntityFieldValueTest.php
@@ -66,12 +66,6 @@ public function testBoolean() {
 
     $metadata = $this->defaultCacheMetaData();
 
-
-    $metadata->addCacheTags([
-      'config:field.storage.node.field_boolean',
-      'entity_field_info',
-    ]);
-
     $this->assertResults($query, [], [
       'node' => [
         'fieldBoolean' => TRUE,
@@ -110,10 +104,6 @@ public function testText() {
 GQL;
 
     $metadata = $this->defaultCacheMetaData();
-    $metadata->addCacheTags([
-      'config:field.storage.node.field_text',
-      'entity_field_info',
-    ]);
 
     $this->assertResults($query, [], [
       'node' => [
@@ -161,10 +151,6 @@ public function testFilteredText() {
 GQL;
 
     $metadata = $this->defaultCacheMetaData();
-    $metadata->addCacheTags([
-      'config:field.storage.node.body',
-      'entity_field_info',
-    ]);
 
     $this->assertResults($query, [], [
       'node' => [
@@ -253,21 +239,6 @@ public function testRawValues($actualFieldValues, $expectedFieldValues) {
 
     $metadata = $this->defaultCacheMetaData();
     $metadata->addCacheTags([
-      'config:field.storage.node.body',
-      'config:field.storage.node.field_text',
-      'config:field.storage.node.field_boolean',
-      'config:field.storage.node.field_datetime',
-      'config:field.storage.node.field_decimal',
-      'config:field.storage.node.field_email',
-      'config:field.storage.node.field_float',
-      'config:field.storage.node.field_file',
-      'config:field.storage.node.field_image',
-      'config:field.storage.node.field_integer',
-      'config:field.storage.node.field_link',
-      'config:field.storage.node.field_string',
-      'config:field.storage.node.field_timestamp',
-      'config:field.storage.node.field_reference',
-      'entity_field_info',
       'node:1',
       'user:0',
       'file:1',
diff --git a/modules/graphql_core/tests/src/Kernel/GraphQLContentTestBase.php b/modules/graphql_core/tests/src/Kernel/GraphQLContentTestBase.php
@@ -30,15 +30,6 @@ class GraphQLContentTestBase extends GraphQLCoreTestBase {
     'text',
   ];
 
-  /**
-   * {@inheritdoc}
-   */
-  protected function defaultCacheTags() {
-    return array_merge([
-      'config:field.storage.node.body',
-    ], parent::defaultCacheTags());
-  }
-
   /**
    * {@inheritdoc}
    *
diff --git a/modules/graphql_core/tests/src/Kernel/GraphQLCoreTestBase.php b/modules/graphql_core/tests/src/Kernel/GraphQLCoreTestBase.php
@@ -17,17 +17,6 @@ class GraphQLCoreTestBase extends GraphQLTestBase {
     'user',
   ];
 
-  /**
-   * {@inheritdoc}
-   */
-  protected function defaultCacheTags() {
-    return array_merge([
-      'entity_bundles',
-      'entity_types',
-      'entity_field_info',
-    ], parent::defaultCacheTags());
-  }
-
   /**
    * {@inheritdoc}
    */
diff --git a/modules/graphql_core/tests/src/Kernel/Images/ImageFieldTest.php b/modules/graphql_core/tests/src/Kernel/Images/ImageFieldTest.php
@@ -54,14 +54,12 @@ public function testImageField() {
 
     $style->transformDimensions($dimensions, $a->image[0]->entity->getFileUri());
 
-    // TODO: Check cache metadata.
     $metadata = $this->defaultCacheMetaData();
     $metadata->addCacheTags([
-      'config:field.storage.node.image',
-      'config:image.style.thumbnail',
-      'entity_field_info',
       'file:1',
       'node:1',
+      // TODO: Check metatags. Is the config metatag required?
+      'config:image.style.thumbnail',
     ]);
 
     $this->assertResults($this->getQueryFromFile('image.gql'), [
diff --git a/modules/graphql_core/tests/src/Kernel/Languages/LanguageTest.php b/modules/graphql_core/tests/src/Kernel/Languages/LanguageTest.php
@@ -50,8 +50,8 @@ protected function setUp() {
    * Test listing of available languages.
    */
   public function testLanguageId() {
-    // TODO: Check cache metadata.
     $metadata = $this->defaultCacheMetaData();
+    // TODO: Should this also contain the language config cache metadata?
 
     $this->assertResults($this->getQueryFromFile('languages.gql'), [], [
       'languages' => [
@@ -99,13 +99,12 @@ public function testLanguageId() {
    * Test language switch links.
    */
   public function testLanguageSwitchLinks() {
-    // TODO: Check cache metadata.
     $metadata = $this->defaultCacheMetaData();
     $metadata->addCacheTags([
       'config:language.entity.en',
       'config:language.entity.es',
       'config:language.entity.fr',
-      'config:language.entity.pt-br',
+      'config:language.entity.pt-br'
     ]);
 
     $this->assertResults($this->getQueryFromFile('language_switch_links.gql'), [], [
@@ -155,12 +154,4 @@ public function testLanguageSwitchLinks() {
       ],
     ], $metadata);
   }
-
-  /**
-   * {@inheritdoc}
-   */
-  protected function defaultCacheTags() {
-    $tags = parent::defaultCacheTags();
-    return array_diff($tags, ['entity_bundles']);
-  }
 }
diff --git a/modules/graphql_core/tests/src/Kernel/Menu/MenuTest.php b/modules/graphql_core/tests/src/Kernel/Menu/MenuTest.php
@@ -72,11 +72,8 @@ public function testTestSetup() {
    * Test menu tree data retrieval.
    */
   public function testMenuTree() {
-    // TODO: Check cache metadata.
     $metadata = $this->defaultCacheMetaData();
-    $metadata->addCacheTags([
-      'config:system.menu.test',
-    ]);
+    $metadata->addCacheTags(['config:system.menu.test']);
 
     $this->assertResults(
       $this->getQueryFromFile('menu.gql'),
diff --git a/modules/graphql_core/tests/src/Kernel/Routing/ExternalRequestTest.php b/modules/graphql_core/tests/src/Kernel/Routing/ExternalRequestTest.php
@@ -38,11 +38,8 @@ public function testExternalRequests() {
     ));
 
     $this->container->set('http_client', $client->reveal());
-
-    // TODO: Check cache metadata.
     // Add cache information from external response?
     $metadata = $this->defaultCacheMetaData();
-    $metadata->setCacheTags(array_diff($metadata->getCacheTags(), ['entity_bundles']));
 
     $this->assertResults($this->getQueryFromFile('external_requests.gql'), [], [
       'route' => [
diff --git a/modules/graphql_core/tests/src/Kernel/Routing/InternalRequestTest.php b/modules/graphql_core/tests/src/Kernel/Routing/InternalRequestTest.php
@@ -28,9 +28,7 @@ protected function setUp() {
    * Test internal requests.
    */
   public function testInternalRequests() {
-    // TODO: Check cache metadata.
     $metadata = $this->defaultCacheMetaData();
-    $metadata->setCacheTags(array_diff($metadata->getCacheTags(), ['entity_bundles']));
 
     $this->assertResults($this->getQueryFromFile('internal_requests.gql'), [], [
       'ok' => [
diff --git a/modules/graphql_core/tests/src/Kernel/Routing/RouteEntityTest.php b/modules/graphql_core/tests/src/Kernel/Routing/RouteEntityTest.php
@@ -26,10 +26,8 @@ public function testRouteEntity() {
     $query = $this->getQueryFromFile('route_entity.gql');
     $vars = ['path' => '/node/' . $node->id()];
 
-    // TODO: Check cache metadata.
     $metadata = $this->defaultCacheMetaData();
     $metadata->addCacheTags([
-      'entity_field_info',
       'node:1',
     ]);
 
diff --git a/modules/graphql_core/tests/src/Kernel/Routing/RouteTest.php b/modules/graphql_core/tests/src/Kernel/Routing/RouteTest.php
@@ -47,9 +47,7 @@ protected function setUp() {
    * Test if the schema is created properly.
    */
   public function testRoute() {
-    // TODO: Check cache metadata.
     $metadata = $this->defaultCacheMetaData();
-    $metadata->setCacheTags(array_diff($metadata->getCacheTags(), ['entity_bundles']));
     $metadata->addCacheTags([
       '4xx-response',
     ]);
diff --git a/src/Plugin/GraphQL/Schemas/SchemaPluginBase.php b/src/Plugin/GraphQL/Schemas/SchemaPluginBase.php
@@ -160,6 +160,8 @@ public static function create(ContainerInterface $container, array $configuratio
    *   The current user.
    * @param \Psr\Log\LoggerInterface $logger
    *   The logger service.
+   * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
+   *   The language manager service.
    * @param array $parameters
    *   The service parameters.
    */
@@ -259,7 +261,8 @@ public function getServer() {
       $context = new ResolveContext($globals, [
         'language' => $this->languageManager->getCurrentLanguage()->getId(),
       ]);
-      $context->addCacheTags(['graphql_response']);
+
+      $context->addCacheTags(['graphql']);
 
       // Always add the language_url cache context.
       $context->addCacheContexts([
@@ -268,9 +271,6 @@ public function getServer() {
         'languages:language_content',
         'user.permissions',
       ]);
-      if ($this instanceof CacheableDependencyInterface) {
-        $context->addCacheableDependency($this);
-      }
 
       return $context;
     });
diff --git a/tests/src/Kernel/Framework/SchemaCacheTest.php b/tests/src/Kernel/Framework/SchemaCacheTest.php
@@ -14,7 +14,7 @@ class SchemaCacheTest extends GraphQLTestBase {
   /**
    * Test basic schema caching.
    */
-  public function testCacheableSchema() {
+  public function testCaching() {
     // Create a first field.
     $this->mockField('foo', [
       'id' => 'foo',
@@ -41,48 +41,15 @@ public function testCacheableSchema() {
     );
   }
 
-  /**
-   * Test an uncacheable schema.
-   */
-  public function testUncacheableSchema() {
-    // Create a first field.
-    $this->mockField('foo', [
-      'id' => 'foo',
-      'name' => 'foo',
-      'type' => 'String',
-      'schema_cache_max_age' => 0,
-    ], 'foo');
-
-    // Run introspect to populate the schema cache.
-    $this->introspect();
-
-    // Add another field.
-    $this->mockField('bar', [
-      'id' => 'bar',
-      'name' => 'bar',
-      'type' => 'String',
-    ], 'bar');
-
-    // Run introspect again, the new field should appear immediately.
-    $schema = $this->introspect();
-    $this->assertArrayHasKey(
-      'bar',
-      $schema['types']['Query']['fields'],
-      'Schema has not been cached.'
-    );
-
-  }
-
   /**
    * Test tag based schema invalidation.
    */
-  public function testTags() {
+  public function testCachingWithInvalidation() {
     // Create a first field.
     $this->mockField('foo', [
       'id' => 'foo',
       'name' => 'foo',
       'type' => 'String',
-      'schema_cache_tags' => ['foo'],
     ], 'foo');
 
     // Run introspect to populate the schema cache.
@@ -103,8 +70,7 @@ public function testTags() {
       'Schema has not been cached.'
     );
 
-    // Clear the fields schema cache tag.
-    $this->container->get('cache_tags.invalidator')->invalidateTags(['foo']);
+    $this->container->get('cache_tags.invalidator')->invalidateTags(['graphql']);
 
     // Now the new field should appear.
     $schema = $this->introspect();
diff --git a/tests/src/Kernel/GraphQLTestBase.php b/tests/src/Kernel/GraphQLTestBase.php
