www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views/tests/src/Kernel/RenderCacheIntegrationTest.php

   1 <?php
   2
   3 namespace Drupal\Tests\views\Kernel;
   4
   5 use Drupal\Core\Cache\Cache;
   6 use Drupal\Core\Entity\EntityInterface;
   7 use Drupal\Core\Language\LanguageInterface;
   8 use Drupal\entity_test\Entity\EntityTest;
   9 use Drupal\views\Tests\AssertViewsCacheTagsTrait;
  10 use Drupal\views\Views;
  11 use Drupal\views\Entity\View;
  12
  13 /**
  14  * Tests the general integration between views and the render cache.
  15  *
  16  * @group views
  17  */
  18 class RenderCacheIntegrationTest extends ViewsKernelTestBase {
  19
  20   use AssertViewsCacheTagsTrait;
  21
  22   /**
  23    * {@inheritdoc}
  24    */
  25   public static $testViews = ['test_view', 'test_display', 'entity_test_fields', 'entity_test_row'];
  26
  27   /**
  28    * {@inheritdoc}
  29    */
  30   public static $modules = ['entity_test', 'user', 'node'];
  31
  32   /**
  33    * {@inheritdoc}
  34    */
  35   protected function setUp($import_test_views = TRUE) {
  36     parent::setUp();
  37
  38     $this->installEntitySchema('entity_test');
  39     $this->installEntitySchema('user');
  40   }
  41
  42   /**
  43    * Tests a field-based view's cache tags when using the "none" cache plugin.
  44    */
  45   public function testFieldBasedViewCacheTagsWithCachePluginNone() {
  46     $view = Views::getview('entity_test_fields');
  47     $view->getDisplay()->overrideOption('cache', [
  48       'type' => 'none',
  49     ]);
  50     $view->save();
  51
  52     $this->assertCacheTagsForFieldBasedView(FALSE);
  53   }
  54
  55   /**
  56    * Tests a field-based view's cache tags when using the "tag" cache plugin.
  57    */
  58   public function testFieldBasedViewCacheTagsWithCachePluginTag() {
  59     $view = Views::getview('entity_test_fields');
  60     $view->getDisplay()->overrideOption('cache', [
  61       'type' => 'tag',
  62     ]);
  63     $view->save();
  64
  65     $this->assertCacheTagsForFieldBasedView(TRUE);
  66   }
  67
  68   /**
  69    * Tests a field-based view's cache tags when using the "time" cache plugin.
  70    */
  71   public function testFieldBasedViewCacheTagsWithCachePluginTime() {
  72     $view = Views::getview('entity_test_fields');
  73     $view->getDisplay()->overrideOption('cache', [
  74       'type' => 'time',
  75       'options' => [
  76         'results_lifespan' => 3600,
  77         'output_lifespan' => 3600,
  78       ],
  79     ]);
  80     $view->save();
  81
  82     $this->assertCacheTagsForFieldBasedView(TRUE);
  83   }
  84
  85   /**
  86    * Tests cache tags on output & result cache items for a field-based view.
  87    *
  88    * @param bool $do_assert_views_caches
  89    *   Whether to check Views' result & output caches.
  90    */
  91   protected function assertCacheTagsForFieldBasedView($do_assert_views_caches) {
  92     $this->pass('Checking cache tags for field-based view.');
  93     $view = Views::getview('entity_test_fields');
  94
  95     // Empty result (no entities yet).
  96     $this->pass('Test without entities');
  97     $base_tags = ['config:views.view.entity_test_fields', 'entity_test_list'];
  98     $this->assertViewsCacheTags($view, $base_tags, $do_assert_views_caches, $base_tags);
  99     $this->assertViewsCacheTagsFromStaticRenderArray($view, $base_tags, $do_assert_views_caches);
 100
 101     // Non-empty result (1 entity).
 102     /** @var \Drupal\Core\Entity\EntityInterface[] $entities */
 103     $entities[] = $entity = EntityTest::create();
 104     $entity->save();
 105
 106     $this->pass('Test with entities');
 107     $tags_with_entity = Cache::mergeTags($base_tags, $entities[0]->getCacheTags());
 108     $this->assertViewsCacheTags($view, $tags_with_entity, $do_assert_views_caches, $tags_with_entity);
 109     $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags_with_entity, $do_assert_views_caches);
 110
 111     // Paged result (more entities than the items-per-page limit).
 112     for ($i = 0; $i < 5; $i++) {
 113       $entities[] = $entity = EntityTest::create();
 114       $entity->save();
 115     }
 116
 117     // Page 1.
 118     $this->pass('Test pager');
 119     $this->pass('Page 1');
 120     \Drupal::request()->query->set('page', 0);
 121     $tags_page_1 = Cache::mergeTags($base_tags, $entities[1]->getCacheTags());
 122     $tags_page_1 = Cache::mergeTags($tags_page_1, $entities[2]->getCacheTags());
 123     $tags_page_1 = Cache::mergeTags($tags_page_1, $entities[3]->getCacheTags());
 124     $tags_page_1 = Cache::mergeTags($tags_page_1, $entities[4]->getCacheTags());
 125     $tags_page_1 = Cache::mergeTags($tags_page_1, $entities[5]->getCacheTags());
 126     $this->assertViewsCacheTags($view, $tags_page_1, $do_assert_views_caches, $tags_page_1);
 127     $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags_page_1, $do_assert_views_caches);
 128     $view->destroy();
 129     // Page 2.
 130     $this->pass('Page 2');
 131     $view->setCurrentPage(1);
 132     \Drupal::request()->query->set('page', 1);
 133     $tags_page_2 = Cache::mergeTags($base_tags, $entities[0]->getCacheTags());
 134     $this->assertViewsCacheTags($view, $tags_page_2, $do_assert_views_caches, $tags_page_2);
 135     $view->destroy();
 136
 137     // Ensure that invalidation works on both pages.
 138     $this->pass('Page invalidations');
 139     $this->pass('Page 2');
 140     $view->setCurrentPage(1);
 141     \Drupal::request()->query->set('page', 1);
 142     $entities[0]->name->value = $random_name = $this->randomMachineName();
 143     $entities[0]->save();
 144     $build = $this->assertViewsCacheTags($view, $tags_page_2, $do_assert_views_caches, $tags_page_2);
 145     // @todo Static render arrays don't support different pages yet, see
 146     //   https://www.drupal.org/node/2500701.
 147     // $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags_page_2, $do_assert_views_caches);
 148     $this->assertTrue(strpos($build['#markup'], $random_name) !== FALSE);
 149     $view->destroy();
 150
 151     $this->pass('Page 1');
 152     $view->setCurrentPage(0);
 153     \Drupal::request()->query->set('page', 0);
 154     $entities[1]->name->value = $random_name = $this->randomMachineName();
 155     $entities[1]->save();
 156     $build = $this->assertViewsCacheTags($view, $tags_page_1, $do_assert_views_caches, $tags_page_1);
 157     $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags_page_1, $do_assert_views_caches);
 158     $this->assertTrue(strpos($build['#markup'], $random_name) !== FALSE);
 159     $view->destroy();
 160
 161     // Setup arguments to ensure that render caching also varies by them.
 162     $this->pass('Test arguments');
 163
 164     // Custom assert for a single result row.
 165     $single_entity_assertions = function (array $build, EntityInterface $entity) {
 166       $this->setRawContent($build['#markup']);
 167
 168       $result = $this->cssSelect('div.views-row');
 169       $count = count($result);
 170       $this->assertEqual($count, 1);
 171
 172       $this->assertEqual((string) $result[0]->div->span, (string) $entity->id());
 173     };
 174
 175     // Execute the view once with a static renderable and one with a full
 176     // prepared render array.
 177     $tags_argument = Cache::mergeTags($base_tags, $entities[0]->getCacheTags());
 178     $view->setArguments([$entities[0]->id()]);
 179     $build = $this->assertViewsCacheTags($view, $tags_argument, $do_assert_views_caches, $tags_argument);
 180     $single_entity_assertions($build, $entities[0]);
 181
 182     $view->setArguments([$entities[0]->id()]);
 183     $build = $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags_argument, $do_assert_views_caches);
 184     $single_entity_assertions($build, $entities[0]);
 185
 186     // Set a different argument and ensure that the result is different.
 187     $tags2_argument = Cache::mergeTags($base_tags, $entities[1]->getCacheTags());
 188     $view->setArguments([$entities[1]->id()]);
 189     $build = $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags2_argument, $do_assert_views_caches);
 190     $single_entity_assertions($build, $entities[1]);
 191
 192     $view->destroy();
 193   }
 194
 195   /**
 196    * Tests a entity-based view's cache tags when using the "none" cache plugin.
 197    */
 198   public function testEntityBasedViewCacheTagsWithCachePluginNone() {
 199     $view = Views::getview('entity_test_row');
 200     $view->getDisplay()->overrideOption('cache', [
 201       'type' => 'none',
 202     ]);
 203     $view->save();
 204
 205     $this->assertCacheTagsForEntityBasedView(FALSE);
 206   }
 207
 208   /**
 209    * Tests a entity-based view's cache tags when using the "tag" cache plugin.
 210    */
 211   public function testEntityBasedViewCacheTagsWithCachePluginTag() {
 212     $view = Views::getview('entity_test_row');
 213     $view->getDisplay()->overrideOption('cache', [
 214       'type' => 'tag',
 215     ]);
 216     $view->save();
 217
 218     $this->assertCacheTagsForEntityBasedView(TRUE);
 219   }
 220
 221   /**
 222    * Tests a entity-based view's cache tags when using the "time" cache plugin.
 223    */
 224   public function testEntityBasedViewCacheTagsWithCachePluginTime() {
 225     $view = Views::getview('entity_test_row');
 226     $view->getDisplay()->overrideOption('cache', [
 227       'type' => 'time',
 228       'options' => [
 229         'results_lifespan' => 3600,
 230         'output_lifespan' => 3600,
 231       ],
 232     ]);
 233     $view->save();
 234
 235     $this->assertCacheTagsForEntityBasedView(TRUE);
 236   }
 237
 238   /**
 239    * Tests cache tags on output & result cache items for an entity-based view.
 240    */
 241   protected function assertCacheTagsForEntityBasedView($do_assert_views_caches) {
 242     $this->pass('Checking cache tags for entity-based view.');
 243     $view = Views::getview('entity_test_row');
 244
 245     // Empty result (no entities yet).
 246     $base_tags = $base_render_tags = ['config:views.view.entity_test_row', 'entity_test_list'];
 247     $this->assertViewsCacheTags($view, $base_tags, $do_assert_views_caches, $base_tags);
 248     $this->assertViewsCacheTagsFromStaticRenderArray($view, $base_tags, $do_assert_views_caches);
 249
 250     // Non-empty result (1 entity).
 251     $entities[] = $entity = EntityTest::create();
 252     $entity->save();
 253
 254     $result_tags_with_entity = Cache::mergeTags($base_tags, $entities[0]->getCacheTags());
 255     $render_tags_with_entity = Cache::mergeTags($base_render_tags, $entities[0]->getCacheTags());
 256     $render_tags_with_entity = Cache::mergeTags($render_tags_with_entity, ['entity_test_view']);
 257     $this->assertViewsCacheTags($view, $result_tags_with_entity, $do_assert_views_caches, $render_tags_with_entity);
 258     $this->assertViewsCacheTagsFromStaticRenderArray($view, $render_tags_with_entity, $do_assert_views_caches);
 259
 260     // Paged result (more entities than the items-per-page limit).
 261     for ($i = 0; $i < 5; $i++) {
 262       $entities[] = $entity = EntityTest::create();
 263       $entity->save();
 264     }
 265
 266     $new_entities_cache_tags = Cache::mergeTags($entities[1]->getCacheTags(), $entities[2]->getCacheTags());
 267     $new_entities_cache_tags = Cache::mergeTags($new_entities_cache_tags, $entities[3]->getCacheTags());
 268     $new_entities_cache_tags = Cache::mergeTags($new_entities_cache_tags, $entities[4]->getCacheTags());
 269     $new_entities_cache_tags = Cache::mergeTags($new_entities_cache_tags, $entities[5]->getCacheTags());
 270     $result_tags_page_1 = Cache::mergeTags($base_tags, $new_entities_cache_tags);
 271     $render_tags_page_1 = Cache::mergeTags($base_render_tags, $new_entities_cache_tags);
 272     $render_tags_page_1 = Cache::mergeTags($render_tags_page_1, ['entity_test_view']);
 273     $this->assertViewsCacheTags($view, $result_tags_page_1, $do_assert_views_caches, $render_tags_page_1);
 274     $this->assertViewsCacheTagsFromStaticRenderArray($view, $render_tags_page_1, $do_assert_views_caches);
 275   }
 276
 277   /**
 278    * Ensure that the view renderable contains the cache contexts.
 279    */
 280   public function testBuildRenderableWithCacheContexts() {
 281     $view = View::load('test_view');
 282     $display =& $view->getDisplay('default');
 283     $display['cache_metadata']['contexts'] = ['views_test_cache_context'];
 284     $executable = $view->getExecutable();
 285
 286     $build = $executable->buildRenderable();
 287     $this->assertEqual(['views_test_cache_context'], $build['#cache']['contexts']);
 288   }
 289
 290   /**
 291    * Ensures that saving a view calculates the cache contexts.
 292    */
 293   public function testViewAddCacheMetadata() {
 294     $view = View::load('test_display');
 295     $view->save();
 296
 297     $this->assertEqual(['languages:' . LanguageInterface::TYPE_CONTENT, 'languages:' . LanguageInterface::TYPE_INTERFACE, 'url.query_args', 'user.node_grants:view', 'user.permissions'], $view->getDisplay('default')['cache_metadata']['contexts']);
 298   }
 299
 300 }