Revert "Issue #2445743 by dawehner, Wim Leers: Allow views base tables and...

Revert "Issue #2445743 by dawehner, Wim Leers: Allow views base tables and entity types to define additional cache contexts"

This reverts commit a87aff86.

core/lib/Drupal/Core/Entity/EntityListBuilder.php

@@ -218,9 +218,6 @@ public function render() {
       '#title' => $this->getTitle(),
       '#rows' => array(),
       '#empty' => $this->t('There is no @label yet.', array('@label' => $this->entityType->getLabel())),
-      '#cache' => [
-        'contexts' => $this->entityType->getListCacheContexts(),
-      ],
     );
     foreach ($this->load() as $entity) {
       if ($row = $this->buildRow($entity)) {

core/lib/Drupal/Core/Entity/EntityType.php

@@ -202,19 +202,12 @@ class EntityType implements EntityTypeInterface {
    */
   protected $field_ui_base_route;
 
-  /**
-   * The list cache contexts for this entity type.
-   *
-   * @var string[]
-   */
-  protected $list_cache_contexts = [];
-
   /**
    * The list cache tags for this entity type.
    *
-   * @var string[]
+   * @var array
    */
-  protected $list_cache_tags = [];
+  protected $list_cache_tags = array();
 
   /**
    * Constructs a new EntityType.
@@ -700,13 +693,6 @@ public function getGroupLabel() {
     return !empty($this->group_label) ? (string) $this->group_label : $this->t('Other', array(), array('context' => 'Entity type group'));
   }
 
-  /**
-   * {@inheritdoc}
-   */
-  public function getListCacheContexts() {
-    return $this->list_cache_contexts;
-  }
-
   /**
    * {@inheritdoc}
    */

core/lib/Drupal/Core/Entity/EntityTypeInterface.php

@@ -655,17 +655,6 @@ public function getUriCallback();
    */
   public function setUriCallback($callback);
 
-  /**
-   * The list cache contexts associated with this entity type.
-   *
-   * Enables code listing entities of this type to ensure that rendered listings
-   * are varied as necessary, typically to ensure users of role A see other
-   * entities listed as users of role B.
-   *
-   * @return string[]
-   */
-  public function getListCacheContexts();
-
   /**
    * The list cache tags associated with this entity type.
    *

core/modules/node/src/Entity/Node.php

@@ -45,7 +45,6 @@
  *   revision_table = "node_revision",
  *   revision_data_table = "node_field_revision",
  *   translatable = TRUE,
- *   list_cache_contexts = { "node_view_grants" },
  *   entity_keys = {
  *     "id" = "nid",
  *     "revision" = "vid",

core/modules/node/src/Tests/NodeCacheTagsTest.php

@@ -58,11 +58,4 @@ protected function getAdditionalCacheTagsForEntity(EntityInterface $node) {
     return array('user:' . $node->getOwnerId(), 'user_view');
   }
 
-  /**
-   * {@inheritdoc}
-   */
-  protected function getAdditionalCacheContextsForEntityListing() {
-    return ['node_view_grants'];
-  }
-
 }

core/modules/node/src/Tests/NodeListBuilderTest.php

-<?php
-
-/**
- * @file
- * Contains \Drupal\node\Tests\NodeListBuilderTest.
- */
-
-namespace Drupal\node\Tests;
-
-use Drupal\simpletest\KernelTestBase;
-
-/**
- * Tests the admin listing fallback when views is not enabled.
- *
- * @group node
- */
-class NodeListBuilderTest extends KernelTestBase {
-
-  /**
-   * {@inheritdoc}
-   */
-  public static $modules = ['node', 'user'];
-
-  protected function setUp() {
-    parent::setUp();
-
-    $this->installEntitySchema('node');
-  }
-
-  /**
-   * Tests that the correct cache contexts are set.
-   */
-  public function testCacheContexts() {
-    /** @var \Drupal\Core\Entity\EntityListBuilderInterface $list_builder */
-    $list_builder = $this->container->get('entity.manager')->getListBuilder('node');
-
-    $build = $list_builder->render();
-    $this->container->get('renderer')->render($build);
-
-    $this->assertEqual(['node_view_grants'], $build['#cache']['contexts']);
-  }
-
-}

core/modules/node/src/Tests/Views/FrontPageTest.php

@@ -241,7 +241,7 @@ protected function assertFrontPageViewCacheTags($do_assert_views_caches) {
     $view = Views::getView('frontpage');
     $view->setDisplay('page_1');
 
-    $cache_contexts = ['node_view_grants', 'language'];
+    $cache_contexts = [];
 
     // Test before there are any nodes.
     $empty_node_listing_cache_tags = [

core/modules/system/src/Tests/Entity/EntityCacheTagsTestBase.php

@@ -156,16 +156,6 @@ protected function getAdditionalCacheTagsForEntity(EntityInterface $entity) {
     return array();
   }
 
-  /**
-   * Returns the additional cache tags for the tested entity's listing by type.
-   *
-   * @return string[]
-   *   An array of the additional cache contexts.
-   */
-  protected function getAdditionalCacheContextsForEntityListing() {
-    return [];
-  }
-
   /**
    * Returns the additional cache tags for the tested entity's listing by type.
    *
@@ -392,19 +382,13 @@ public function testReferencedEntity() {
     $this->verifyPageCache($empty_entity_listing_url, 'MISS');
     // Verify a cache hit, but also the presence of the correct cache tags.
     $this->verifyPageCache($empty_entity_listing_url, 'HIT', $empty_entity_listing_cache_tags);
-    // Verify the entity type's list cache contexts are present.
-    $contexts_in_header = $this->drupalGetHeader('X-Drupal-Cache-Contexts');
-    $this->assertEqual($this->getAdditionalCacheContextsForEntityListing(), empty($contexts_in_header) ? [] : explode(' ', $contexts_in_header));
 
 
     $this->pass("Test listing containing referenced entity.", 'Debug');
     // Prime the page cache for the listing containing the referenced entity.
-    $this->verifyPageCache($nonempty_entity_listing_url, 'MISS', $nonempty_entity_listing_cache_tags);
+    $this->verifyPageCache($nonempty_entity_listing_url, 'MISS');
     // Verify a cache hit, but also the presence of the correct cache tags.
     $this->verifyPageCache($nonempty_entity_listing_url, 'HIT', $nonempty_entity_listing_cache_tags);
-    // Verify the entity type's list cache contexts are present.
-    $contexts_in_header = $this->drupalGetHeader('X-Drupal-Cache-Contexts');
-    $this->assertEqual($this->getAdditionalCacheContextsForEntityListing(), empty($contexts_in_header) ? [] : explode(' ', $contexts_in_header));
 
 
     // Verify that after modifying the referenced entity, there is a cache miss

core/modules/system/src/Tests/Entity/EntityListBuilderTest.php

@@ -56,17 +56,4 @@ public function testPager() {
     $this->assertRaw('Test entity 51', 'Test entity 51 is shown.');
   }
 
-  /**
-   * Tests that the correct cache contexts are set.
-   */
-  public function testCacheContexts() {
-    /** @var \Drupal\Core\Entity\EntityListBuilderInterface $list_builder */
-    $list_builder = $this->container->get('entity.manager')->getListBuilder('entity_test');
-
-    $build = $list_builder->render();
-    $this->container->get('renderer')->render($build);
-
-    $this->assertEqual(['entity_test_view_grants'], $build['#cache']['contexts']);
-  }
-
 }

core/modules/system/tests/modules/entity_test/src/Controller/EntityTestController.php

@@ -162,7 +162,6 @@ public function listEntitiesAlphabetically($entity_type_id) {
       '#items' => $labels,
       '#title' => $entity_type_id . ' entities',
       '#cache' => [
-        'contexts' => $entity_type_definition->getListCacheContexts(),
         'tags' => $cache_tags,
       ],
     ];
@@ -183,13 +182,11 @@ public function listEntitiesAlphabetically($entity_type_id) {
    *   A renderable array.
    */
   public function listEntitiesEmpty($entity_type_id) {
-    $entity_type_definition = $this->entityManager()->getDefinition($entity_type_id);
     return [
       '#theme' => 'item_list',
       '#items' => [],
       '#cache' => [
-        'contexts' => $entity_type_definition->getListCacheContexts(),
-        'tags' => $entity_type_definition->getListCacheTags(),
+        'tags' => $this->entityManager()->getDefinition($entity_type_id)->getListCacheTags(),
       ],
     ];
   }

core/modules/system/tests/modules/entity_test/src/Entity/EntityTest.php

@@ -33,7 +33,6 @@
  *   },
  *   base_table = "entity_test",
  *   persistent_cache = FALSE,
- *   list_cache_contexts = { "entity_test_view_grants" },
  *   entity_keys = {
  *     "id" = "id",
  *     "uuid" = "uuid",

core/modules/views/config/schema/views.data_types.schema.yml

@@ -250,6 +250,16 @@ views_display:
     rendering_language:
       type: string
       label: 'Entity language'
+    cache_metadata:
+      type: mapping
+      label: 'Cache metadata'
+      mapping:
+        cacheable:
+          type: boolean
+          label: 'Cacheable'
+        contexts:
+          type: sequence
+          label: 'Cache contexts'
     exposed_block:
       type: boolean
       label: 'Put the exposed form in a block'

core/modules/views/config/schema/views.schema.yml

@@ -114,18 +114,6 @@ views.view.*:
             label: 'Position'
           display_options:
             type: views.display.[%parent.display_plugin]
-          cache_metadata:
-            type: mapping
-            label: 'Cache metadata'
-            mapping:
-              cacheable:
-                type: boolean
-                label: 'Cacheable'
-              contexts:
-                type: sequence
-                label: 'Cache contexts'
-                sequence:
-                  type: string
 
 views_block:
   type: block_settings

core/modules/views/src/Entity/View.php

@@ -310,14 +310,13 @@ protected function addCacheMetadata() {
 
     $current_display = $executable->current_display;
     $displays = $this->get('display');
-    foreach (array_keys($displays) as $display_id) {
-      $display =& $this->getDisplay($display_id);
+    foreach ($displays as $display_id => $display) {
       $executable->setDisplay($display_id);
 
       list($display['cache_metadata']['cacheable'], $display['cache_metadata']['contexts']) = $executable->getDisplay()->calculateCacheMetadata();
       // Always include at least the language context as there will be most
       // probable translatable strings in the view output.
-      $display['cache_metadata']['contexts'][] = 'language';
+      $display['cache_metadata']['contexts'][] = 'cache.context.language';
       $display['cache_metadata']['contexts'] = array_unique($display['cache_metadata']['contexts']);
     }
     // Restore the previous active display.

core/modules/views/src/EntityViewsData.php

@@ -137,7 +137,6 @@ public function getViewsData() {
     $data[$views_base_table]['table']['base'] = [
       'field' => $base_field,
       'title' => $this->entityType->getLabel(),
-      'cache_contexts' => $this->entityType->getListCacheContexts(),
     ];
 
     if ($label_key = $this->entityType->getKey('label')) {

core/modules/views/src/Plugin/views/display/DisplayPluginBase.php

@@ -117,17 +117,6 @@ abstract class DisplayPluginBase extends PluginBase implements DisplayPluginInte
    */
   protected static $unpackOptions = array();
 
-  /**
-   * The display information coming directly from the view entity.
-   *
-   * @see \Drupal\views\Entity\View::getDisplay()
-   *
-   * @todo \Drupal\views\Entity\View::duplicateDisplayAsType directly access it.
-   *
-   * @var array
-   */
-  public $display;
-
   /**
    * Constructs a new DisplayPluginBase object.
    *
@@ -2313,9 +2302,6 @@ public function buildRenderable(array $args = []) {
       '#arguments' => $args,
       '#embed' => FALSE,
       '#view' => $this->view,
-      '#cache' => [
-        'contexts' => isset($this->display['cache_metadata']['contexts']) ?  $this->display['cache_metadata']['contexts'] : [],
-      ],
     ];
   }
 

core/modules/views/src/Plugin/views/query/QueryPluginBase.php

@@ -8,7 +8,6 @@
 namespace Drupal\views\Plugin\views\query;
 
 use Drupal\Core\Form\FormStateInterface;
-use Drupal\views\Plugin\CacheablePluginInterface;
 use Drupal\views\Plugin\views\PluginBase;
 use Drupal\views\Plugin\views\display\DisplayPluginBase;
 use Drupal\views\ViewExecutable;
@@ -36,7 +35,7 @@
 /**
  * Base plugin class for Views queries.
  */
-abstract class QueryPluginBase extends PluginBase implements CacheablePluginInterface {
+abstract class QueryPluginBase extends PluginBase {
 
   /**
    * A pager plugin that should be provided by the display.
@@ -313,27 +312,6 @@ public function getEntityTableInfo() {
     return $entity_tables;
   }
 
-  /**
-   * {@inheritdoc}
-   */
-  public function isCacheable() {
-    // This plugin can't really determine that.
-    return TRUE;
-  }
-
-  /**
-   * {@inheritdoc}
-   */
-  public function getCacheContexts() {
-    $contexts = [];
-    if (($views_data = Views::viewsData()->get($this->view->storage->get('base_table'))) && !empty($views_data['table']['entity type'])) {
-      $entity_type_id = $views_data['table']['entity type'];
-      $entity_type = \Drupal::entityManager()->getDefinition($entity_type_id);
-      $contexts = $entity_type->getListCacheContexts();
-    }
-    return $contexts;
-  }
-
   /**
    * {@inheritdoc}
    */

core/modules/views/src/Tests/GlossaryTest.php

@@ -86,7 +86,7 @@ public function testGlossaryView() {
 
     // Verify cache tags.
     $this->enablePageCaching();
-    $this->assertPageCacheContextsAndTags(Url::fromRoute('view.glossary.page_1'), ['cache.context.url', 'node_view_grants', 'language'], [
+    $this->assertPageCacheContextsAndTags(Url::fromRoute('view.glossary.page_1'), [], [
       'config:views.view.glossary',
       'node:' . $nodes_by_char['a'][0]->id(), 'node:' . $nodes_by_char['a'][1]->id(), 'node:' . $nodes_by_char['a'][2]->id(),
       'node_list',

core/modules/views/src/Tests/RenderCacheIntegrationTest.php

@@ -10,10 +10,9 @@
 use Drupal\Core\Cache\Cache;
 use Drupal\entity_test\Entity\EntityTest;
 use Drupal\views\Views;
-use Drupal\views\Entity\View;
 
 /**
- * Tests the general integration between views and the render cache.
+ * Tests the general integration between Views and the render cache.
  *
  * @group views
  */
@@ -24,12 +23,12 @@ class RenderCacheIntegrationTest extends ViewUnitTestBase {
   /**
    * {@inheritdoc}
    */
-  public static $testViews = ['test_view', 'test_display', 'entity_test_fields', 'entity_test_row'];
+  public static $testViews = ['entity_test_fields', 'entity_test_row'];
 
   /**
    * {@inheritdoc}
    */
-  public static $modules = ['entity_test', 'user', 'node'];
+  public static $modules = ['entity_test', 'user'];
 
   /**
    * {@inheritdoc}
@@ -201,27 +200,4 @@ protected function assertCacheTagsForEntityBasedView($do_assert_views_caches) {
     $this->assertViewsCacheTags($view, $result_tags_page_1, $do_assert_views_caches, $render_tags_page_1);
   }
 
-  /**
-   * Ensure that the view renderable contains the cache contexts.
-   */
-  public function testBuildRenderableWithCacheContexts() {
-    $view = View::load('test_view');
-    $display =& $view->getDisplay('default');
-    $display['cache_metadata']['contexts'] = ['beatles'];
-    $executable = $view->getExecutable();
-
-    $build = $executable->buildRenderable();
-    $this->assertEqual(['beatles'], $build['#cache']['contexts']);
-  }
-
-  /**
-   * Ensures that saving a view calculates the cache contexts.
-   */
-  public function testViewAddCacheMetadata() {
-    $view = View::load('test_display');
-    $view->save();
-
-    $this->assertEqual(['node_view_grants', 'language'], $view->getDisplay('default')['cache_metadata']['contexts']);
-  }
-
 }

core/modules/views/tests/src/Unit/EntityViewsDataTest.php

@@ -89,7 +89,6 @@ protected function setUp() {
       'label' => 'Entity test',
       'entity_keys' => ['id' => 'id', 'langcode' => 'langcode'],
       'provider' => 'entity_test',
-      'list_cache_contexts' => ['entity_test_list_cache_context'],
     ]);
 
     $this->translationManager = $this->getStringTranslationStub();
@@ -165,7 +164,6 @@ public function testBaseTables() {
     $this->assertEquals('entity_test', $data['entity_test']['table']['provider']);
 
     $this->assertEquals('id', $data['entity_test']['table']['base']['field']);
-    $this->assertEquals(['entity_test_list_cache_context'], $data['entity_test']['table']['base']['cache_contexts']);
     $this->assertEquals('Entity test', $data['entity_test']['table']['base']['title']);
 
     $this->assertFalse(isset($data['entity_test']['table']['defaults']));
@@ -175,6 +173,7 @@ public function testBaseTables() {
     $this->assertFalse(isset($data['revision_data_table']));
   }
 
+
   /**
    * Tests data_table support.
    */