Fixing schema cache metadata. (#394)

fubhy · web-flow · commit 59eafd6e61a0 · 2017-10-17T12:46:48.000+02:00
diff --git a/modules/graphql_content/src/Plugin/Deriver/DisplayedFieldDeriver.php b/modules/graphql_content/src/Plugin/Deriver/DisplayedFieldDeriver.php
@@ -3,6 +3,7 @@
 namespace Drupal\graphql_content\Plugin\Deriver;
 
 use Drupal\Component\Plugin\Derivative\DeriverBase;
+use Drupal\Core\Cache\CacheableMetadata;
 use Drupal\Core\Entity\ContentEntityTypeInterface;
 use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
 use Drupal\Core\Entity\EntityFieldManagerInterface;
@@ -145,17 +146,22 @@ public function getDerivativeDefinitions($basePluginDefinition) {
                 continue;
               }
 
+              $metadata = CacheableMetadata::createFromObject($display);
+              if (isset($storageDefinition)) {
+                $metadata->addCacheableDependency($storageDefinition);
+              }
+
               $this->derivatives[$typeId . '-' . $bundle . '-' . $field] = [
                 'name' => StringHelper::propCase($field),
                 'types' => [StringHelper::camelCase([$typeId, $bundle])],
                 'entity_type' => $typeId,
                 'bundle' => $bundle,
                 'field' => $field,
                 'virtual' => !isset($storageDefinition),
-                'multi' => isset($storageDefinition) ? $storageDefinition->getCardinality() != 1 : FALSE,
-                'cache_tags' => $display->getCacheTags(),
-                'cache_contexts' => $display->getCacheContexts(),
-                'cache_max_age' => $display->getCacheMaxAge(),
+                'multi' => isset($storageDefinition) ? $storageDefinition->getCardinality() !== 1 : FALSE,
+                'schema_cache_tags' => $metadata->getCacheTags(),
+                'schema_cache_contexts' => $metadata->getCacheContexts(),
+                'schema_cache_max_age' => $metadata->getCacheMaxAge(),
               ] + $basePluginDefinition;
             }
           }
diff --git a/modules/graphql_content_mutation/src/Plugin/GraphQL/Mutations/CreateEntity.php b/modules/graphql_content_mutation/src/Plugin/GraphQL/Mutations/CreateEntity.php
@@ -19,7 +19,7 @@
  *   type = "EntityCrudOutput",
  *   secure = true,
  *   nullable = false,
- *   cache_tags = {"entity_types", "entity_bundles"},
+ *   schema_cache_tags = {"entity_types", "entity_bundles"},
  *   deriver = "Drupal\graphql_content_mutation\Plugin\Deriver\CreateEntityDeriver"
  * )
  */
diff --git a/modules/graphql_content_mutation/src/Plugin/GraphQL/Mutations/DeleteEntity.php b/modules/graphql_content_mutation/src/Plugin/GraphQL/Mutations/DeleteEntity.php
@@ -23,7 +23,7 @@
  *     "id" = "String"
  *   },
  *   nullable = false,
- *   cache_tags = {"entity_types"},
+ *   schema_cache_tags = {"entity_types"},
  *   deriver = "Drupal\graphql_content_mutation\Plugin\Deriver\DeleteEntityDeriver"
  * )
  */
diff --git a/modules/graphql_content_mutation/src/Plugin/GraphQL/Mutations/UpdateEntity.php b/modules/graphql_content_mutation/src/Plugin/GraphQL/Mutations/UpdateEntity.php
@@ -21,7 +21,7 @@
  *   type = "EntityCrudOutput",
  *   secure = true,
  *   nullable = false,
- *   cache_tags = {"entity_types", "entity_bundles"},
+ *   schema_cache_tags = {"entity_types", "entity_bundles"},
  *   deriver = "Drupal\graphql_content_mutation\Plugin\Deriver\UpdateEntityDeriver"
  * )
  */
diff --git a/modules/graphql_core/src/Plugin/Deriver/Fields/EntityFieldDeriver.php b/modules/graphql_core/src/Plugin/Deriver/Fields/EntityFieldDeriver.php
@@ -30,6 +30,9 @@ protected function getDerivativesFromPropertyDefinitions($entityTypeId, FieldSto
       'name' => EntityField::getId($fieldName),
       'multi' => $definition->isMultiple(),
       'field' => $fieldName,
+      'schema_cache_tags' => array_merge($definition->getCacheTags(), ['entity_field_info']),
+      'schema_cache_contexts' => $definition->getCacheContexts(),
+      'schema_cache_max_age' => $definition->getCacheMaxAge(),
     ];
 
     $properties = $definition->getPropertyDefinitions();
diff --git a/modules/graphql_core/src/Plugin/Deriver/Fields/EntityFieldItemDeriver.php b/modules/graphql_core/src/Plugin/Deriver/Fields/EntityFieldItemDeriver.php
@@ -16,10 +16,9 @@ protected function getDerivativesFromPropertyDefinitions($entityTypeId, FieldSto
     $fieldName = $definition->getName();
     $dataType = EntityFieldType::getId($entityTypeId, $fieldName);
 
-    $definitions = $definition->getPropertyDefinitions();
-
-    foreach ($definitions as $property => $definition) {
-      if ($definition->getDataType() == 'map') {
+    $propertyDefinitions = $definition->getPropertyDefinitions();
+    foreach ($propertyDefinitions as $property => $propertyDefinition) {
+      if ($propertyDefinition->getDataType() == 'map') {
         // TODO Is it possible to get the keys of a map (eg. the options array for link field) here?
         continue;
       }
@@ -28,8 +27,11 @@ protected function getDerivativesFromPropertyDefinitions($entityTypeId, FieldSto
         'name' => StringHelper::propCase($property),
         'property' => $property,
         'multi' => FALSE,
-        'type' => $this->typeMapper->typedDataToGraphQLFieldType($definition),
+        'type' => $this->typeMapper->typedDataToGraphQLFieldType($propertyDefinition),
         'types' => [$dataType],
+        'schema_cache_tags' => array_merge($definition->getCacheTags(), ['entity_field_info']),
+        'schema_cache_contexts' => $definition->getCacheContexts(),
+        'schema_cache_max_age' => $definition->getCacheMaxAge(),
       ] + $basePluginDefinition;
     }
   }
diff --git a/modules/graphql_core/src/Plugin/GraphQL/Interfaces/Entity/EntityType.php b/modules/graphql_core/src/Plugin/GraphQL/Interfaces/Entity/EntityType.php
@@ -10,7 +10,7 @@
  * @GraphQLInterface(
  *   id = "entity_type",
  *   weight = -1,
- *   cache_tags = {"entity_types"},
+ *   schema_cache_tags = {"entity_types"},
  *   interfaces = {"Entity"},
  *   deriver = "Drupal\graphql_core\Plugin\Deriver\Interfaces\EntityTypeDeriver"
  * )
diff --git a/modules/graphql_core/src/Plugin/GraphQL/Types/Entity/EntityBundle.php b/modules/graphql_core/src/Plugin/GraphQL/Types/Entity/EntityBundle.php
@@ -12,7 +12,7 @@
  * @GraphQLType(
  *   id = "entity_bundle",
  *   weight = -1,
- *   cache_tags = {"entity_types", "entity_bundles"},
+ *   schema_cache_tags = {"entity_types", "entity_bundles"},
  *   deriver = "Drupal\graphql_core\Plugin\Deriver\Types\EntityBundleDeriver"
  * )
  */
diff --git a/modules/graphql_entity_reference/src/Plugin/GraphQL/Fields/EntityReferenceField.php b/modules/graphql_entity_reference/src/Plugin/GraphQL/Fields/EntityReferenceField.php
@@ -14,7 +14,7 @@
  *   id = "entity_reference",
  *   secure = true,
  *   field_formatter = "graphql_entity_reference",
- *   cache_tags = {"entity_field_info"},
+ *   schema_cache_tags = {"entity_field_info"},
  *   deriver = "Drupal\graphql_entity_reference\Plugin\Deriver\EntityReferenceFields"
  * )
  */
diff --git a/modules/graphql_file/src/Plugin/GraphQL/Fields/FileField.php b/modules/graphql_file/src/Plugin/GraphQL/Fields/FileField.php
@@ -14,7 +14,7 @@
  *   secure = true,
  *   field_formatter = "graphql_file",
  *   type = "File",
- *   cache_tags = {"entity_field_info"},
+ *   schema_cache_tags = {"entity_field_info"},
  *   deriver = "Drupal\graphql_content\Plugin\Deriver\FieldFormatterDeriver"
  * )
  */
diff --git a/modules/graphql_image/src/Plugin/GraphQL/Fields/ImageField.php b/modules/graphql_image/src/Plugin/GraphQL/Fields/ImageField.php
@@ -15,7 +15,7 @@
  *   secure = true,
  *   field_formatter = "graphql_image",
  *   type = "Image",
- *   cache_tags = {"entity_field_info"},
+ *   schema_cache_tags = {"entity_field_info"},
  *   deriver = "Drupal\graphql_content\Plugin\Deriver\FieldFormatterDeriver"
  * )
  */
diff --git a/modules/graphql_link/src/Plugin/GraphQL/Fields/LinkField.php b/modules/graphql_link/src/Plugin/GraphQL/Fields/LinkField.php
@@ -14,6 +14,7 @@
  *   secure = true,
  *   field_formatter = "graphql_link",
  *   type = "LinkItem",
+ *   schema_cache_tags = {"entity_field_info"},
  *   deriver = "Drupal\graphql_content\Plugin\Deriver\FieldFormatterDeriver"
  * )
  */
diff --git a/modules/graphql_views/src/Plugin/Deriver/ViewContextualFilterInputDeriver.php b/modules/graphql_views/src/Plugin/Deriver/ViewContextualFilterInputDeriver.php
@@ -43,7 +43,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           ]),
           'view' => $viewId,
           'display' => $displayId,
-        ] + $basePluginDefinition;
+        ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
       }
     }
 
diff --git a/modules/graphql_views/src/Plugin/Deriver/ViewDeriver.php b/modules/graphql_views/src/Plugin/Deriver/ViewDeriver.php
@@ -49,10 +49,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
         'display' => $displayId,
         'paged' => $this->isPaged($display),
         'arguments_info' => $info,
-        'cache_tags' => $view->getCacheTags(),
-        'cache_contexts' => $view->getCacheContexts(),
-        'cache_max_age' => $view->getCacheMaxAge(),
-      ] + $basePluginDefinition;
+      ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
     }
 
     return parent::getDerivativeDefinitions($basePluginDefinition);
diff --git a/modules/graphql_views/src/Plugin/Deriver/ViewDeriverBase.php b/modules/graphql_views/src/Plugin/Deriver/ViewDeriverBase.php
@@ -239,6 +239,23 @@ protected function getViewStyle(ViewEntityInterface $view, $displayId) {
     return $viewExecutable->getStyle();
   }
 
+  /**
+   * Returns cache metadata plugin definitions.
+   *
+   * @param \Drupal\views\ViewEntityInterface $view
+   *   The view object.
+   *
+   * @return array
+   *   The cache metadata definitions for the plugin definition.
+   */
+  protected function getCacheMetadataDefinition(ViewEntityInterface $view) {
+    return [
+      'schema_cache_tags' => $view->getCacheTags(),
+      'schema_cache_contexts' => $view->getCacheContexts(),
+      'schema_cache_max_age' => $view->getCacheMaxAge(),
+    ];
+  }
+
   /**
    * Returns information about view arguments (contextual filters).
    *
diff --git a/modules/graphql_views/src/Plugin/Deriver/ViewFilterInputDeriver.php b/modules/graphql_views/src/Plugin/Deriver/ViewFilterInputDeriver.php
@@ -60,7 +60,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
         'fields' => $fields,
         'view' => $viewId,
         'display' => $displayId,
-      ] + $basePluginDefinition;
+      ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
     }
 
     return parent::getDerivativeDefinitions($basePluginDefinition);
diff --git a/modules/graphql_views/src/Plugin/Deriver/ViewResultCountDeriver.php b/modules/graphql_views/src/Plugin/Deriver/ViewResultCountDeriver.php
@@ -36,10 +36,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
         'types' => [$display->getGraphQLResultName()],
         'view' => $viewId,
         'display' => $displayId,
-        'cache_tags' => $view->getCacheTags(),
-        'cache_contexts' => $view->getCacheContexts(),
-        'cache_max_age' => $view->getCacheMaxAge(),
-      ] + $basePluginDefinition;
+      ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
     }
 
     return parent::getDerivativeDefinitions($basePluginDefinition);
diff --git a/modules/graphql_views/src/Plugin/Deriver/ViewResultListDeriver.php b/modules/graphql_views/src/Plugin/Deriver/ViewResultListDeriver.php
@@ -36,10 +36,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
         'view' => $viewId,
         'display' => $displayId,
         'uses_fields' => $style->usesFields(),
-        'cache_tags' => $view->getCacheTags(),
-        'cache_contexts' => $view->getCacheContexts(),
-        'cache_max_age' => $view->getCacheMaxAge(),
-      ] + $basePluginDefinition;
+      ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
     }
 
     return parent::getDerivativeDefinitions($basePluginDefinition);
diff --git a/modules/graphql_views/src/Plugin/Deriver/ViewResultTypeDeriver.php b/modules/graphql_views/src/Plugin/Deriver/ViewResultTypeDeriver.php
@@ -32,7 +32,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
         'name' => $display->getGraphQLResultName(),
         'view' => $viewId,
         'display' => $displayId,
-      ] + $basePluginDefinition;
+      ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
     }
 
     return parent::getDerivativeDefinitions($basePluginDefinition);
diff --git a/modules/graphql_views/src/Plugin/Deriver/ViewRowFieldDeriver.php b/modules/graphql_views/src/Plugin/Deriver/ViewRowFieldDeriver.php
@@ -41,7 +41,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           'view' => $viewId,
           'display' => $displayId,
           'field' => $alias,
-        ] + $basePluginDefinition;
+        ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
       }
     }
 
diff --git a/modules/graphql_views/src/Plugin/Deriver/ViewRowTypeDeriver.php b/modules/graphql_views/src/Plugin/Deriver/ViewRowTypeDeriver.php
@@ -38,7 +38,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
         'name' => $display->getGraphQLRowName(),
         'view' => $viewId,
         'display' => $displayId,
-      ] + $basePluginDefinition;
+      ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
     }
 
     return parent::getDerivativeDefinitions($basePluginDefinition);
