Retrieve cache metadata from display. (#15)

* Retrieve cache metadata from display instead of view entity.

* Suppress any url cache contexts emitted by views since they never apply here.

Author: pmelab

src/Plugin/Deriver/Fields/ViewDeriver.php

@@ -49,7 +49,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           'display' => $displayId,
           'paged' => $this->isPaged($display),
           'arguments_info' => $info,
-        ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
+        ] + $this->getCacheMetadataDefinition($view, $display) + $basePluginDefinition;
       }
     }
 

src/Plugin/Deriver/Fields/ViewResultCountDeriver.php

@@ -37,7 +37,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           'parents' => [$display->getGraphQLResultName()],
           'view' => $viewId,
           'display' => $displayId,
-        ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
+        ] + $this->getCacheMetadataDefinition($view, $display) + $basePluginDefinition;
       }
     }
 

src/Plugin/Deriver/Fields/ViewResultListDeriver.php

@@ -37,7 +37,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           'view' => $viewId,
           'display' => $displayId,
           'uses_fields' => $style->usesFields(),
-        ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
+        ] + $this->getCacheMetadataDefinition($view, $display) + $basePluginDefinition;
       }
     }
 

src/Plugin/Deriver/Fields/ViewRowFieldDeriver.php

@@ -42,7 +42,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
             'view' => $viewId,
             'display' => $displayId,
             'field' => $alias,
-          ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
+          ] + $this->getCacheMetadataDefinition($view, $display) + $basePluginDefinition;
         }
       }
     }

src/Plugin/Deriver/InputTypes/ViewContextualFilterInputDeriver.php

@@ -30,7 +30,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
         $argumentsInfo = $this->getArgumentsInfo($display->getOption('arguments') ?: []);
         if (!empty($argumentsInfo)) {
           $id = implode('_', [
-            $viewId, $displayId, 'view', 'contextual', 'filter', 'input'
+            $viewId, $displayId, 'view', 'contextual', 'filter', 'input',
           ]);
 
           $this->derivatives[$id] = [
@@ -41,7 +41,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
             ]),
             'view' => $viewId,
             'display' => $displayId,
-          ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
+          ] + $this->getCacheMetadataDefinition($view, $display) + $basePluginDefinition;
         }
       }
     }

src/Plugin/Deriver/InputTypes/ViewFilterInputDeriver.php

@@ -60,7 +60,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           'fields' => $fields,
           'view' => $viewId,
           'display' => $displayId,
-        ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
+        ] + $this->getCacheMetadataDefinition($view, $display) + $basePluginDefinition;
       }
 
     }

src/Plugin/Deriver/Types/ViewResultTypeDeriver.php

@@ -33,7 +33,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           'name' => $display->getGraphQLResultName(),
           'view' => $viewId,
           'display' => $displayId,
-        ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
+        ] + $this->getCacheMetadataDefinition($view, $display) + $basePluginDefinition;
       }
     }
 

src/Plugin/Deriver/Types/ViewRowTypeDeriver.php

@@ -39,7 +39,7 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           'name' => $display->getGraphQLRowName(),
           'view' => $viewId,
           'display' => $displayId,
-        ] + $this->getCacheMetadataDefinition($view) + $basePluginDefinition;
+        ] + $this->getCacheMetadataDefinition($view, $display) + $basePluginDefinition;
       }
     }
 

src/Plugin/Deriver/ViewDeriverBase.php

@@ -248,15 +248,19 @@ protected function getViewStyle(ViewEntityInterface $view, $displayId) {
    * @return array
    *   The cache metadata definitions for the plugin definition.
    */
-  protected function getCacheMetadataDefinition(ViewEntityInterface $view) {
+  protected function getCacheMetadataDefinition(ViewEntityInterface $view, DisplayPluginInterface $display) {
+    $metadata = $display->getCacheMetadata()
+      ->addCacheTags($view->getCacheTags())
+      ->addCacheContexts($view->getCacheContexts())
+      ->mergeCacheMaxAge($view->getCacheMaxAge());
+
     return [
-      'schema_cache_tags' => $view->getCacheTags(),
-      'schema_cache_max_age' => $view->getCacheMaxAge(),
-      'response_cache_contexts' => array_merge($view->getCacheContexts(), [
-        // TODO: check if they are really always there.
-        'languages:language_interface',
-        'languages:language_content',
-      ]),
+      'schema_cache_tags' => $metadata->getCacheTags(),
+      'schema_cache_max_age' => $metadata->getCacheMaxAge(),
+      'response_cache_contexts' => array_filter($metadata->getCacheContexts(), function ($context) {
+        // Don't emit the url cache contexts.
+        return $context !== 'url' && strpos($context, 'url.') !== 0;
+      }),
     ];
   }