View source
<?php
namespace Drupal\views\Tests;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\entity_test\Entity\EntityTest;
use Drupal\views\Views;
use Drupal\views\Entity\View;
class RenderCacheIntegrationTest extends ViewKernelTestBase {
use AssertViewsCacheTagsTrait;
public static $testViews = [
'test_view',
'test_display',
'entity_test_fields',
'entity_test_row',
];
public static $modules = [
'entity_test',
'user',
'node',
];
protected function setUp() {
parent::setUp();
$this
->installEntitySchema('entity_test');
$this
->installEntitySchema('user');
}
public function testFieldBasedViewCacheTagsWithCachePluginNone() {
$view = Views::getview('entity_test_fields');
$view
->getDisplay()
->overrideOption('cache', [
'type' => 'none',
]);
$view
->save();
$this
->assertCacheTagsForFieldBasedView(FALSE);
}
public function testFieldBasedViewCacheTagsWithCachePluginTag() {
$view = Views::getview('entity_test_fields');
$view
->getDisplay()
->overrideOption('cache', [
'type' => 'tag',
]);
$view
->save();
$this
->assertCacheTagsForFieldBasedView(TRUE);
}
public function testFieldBasedViewCacheTagsWithCachePluginTime() {
$view = Views::getview('entity_test_fields');
$view
->getDisplay()
->overrideOption('cache', [
'type' => 'time',
'options' => [
'results_lifespan' => 3600,
'output_lifespan' => 3600,
],
]);
$view
->save();
$this
->assertCacheTagsForFieldBasedView(TRUE);
}
protected function assertCacheTagsForFieldBasedView($do_assert_views_caches) {
$this
->pass('Checking cache tags for field-based view.');
$view = Views::getview('entity_test_fields');
$this
->pass('Test without entities');
$base_tags = [
'config:views.view.entity_test_fields',
'entity_test_list',
];
$this
->assertViewsCacheTags($view, $base_tags, $do_assert_views_caches, $base_tags);
$this
->assertViewsCacheTagsFromStaticRenderArray($view, $base_tags, $do_assert_views_caches);
$entities[] = $entity = EntityTest::create();
$entity
->save();
$this
->pass('Test with entities');
$tags_with_entity = Cache::mergeTags($base_tags, $entities[0]
->getCacheTags());
$this
->assertViewsCacheTags($view, $tags_with_entity, $do_assert_views_caches, $tags_with_entity);
$this
->assertViewsCacheTagsFromStaticRenderArray($view, $tags_with_entity, $do_assert_views_caches);
for ($i = 0; $i < 5; $i++) {
$entities[] = $entity = EntityTest::create();
$entity
->save();
}
$this
->pass('Test pager');
$this
->pass('Page 1');
\Drupal::request()->query
->set('page', 0);
$tags_page_1 = Cache::mergeTags($base_tags, $entities[1]
->getCacheTags());
$tags_page_1 = Cache::mergeTags($tags_page_1, $entities[2]
->getCacheTags());
$tags_page_1 = Cache::mergeTags($tags_page_1, $entities[3]
->getCacheTags());
$tags_page_1 = Cache::mergeTags($tags_page_1, $entities[4]
->getCacheTags());
$tags_page_1 = Cache::mergeTags($tags_page_1, $entities[5]
->getCacheTags());
$this
->assertViewsCacheTags($view, $tags_page_1, $do_assert_views_caches, $tags_page_1);
$this
->assertViewsCacheTagsFromStaticRenderArray($view, $tags_page_1, $do_assert_views_caches);
$view
->destroy();
$this
->pass('Page 2');
$view
->setCurrentPage(1);
\Drupal::request()->query
->set('page', 1);
$tags_page_2 = Cache::mergeTags($base_tags, $entities[0]
->getCacheTags());
$this
->assertViewsCacheTags($view, $tags_page_2, $do_assert_views_caches, $tags_page_2);
$view
->destroy();
$this
->pass('Page invalidations');
$this
->pass('Page 2');
$view
->setCurrentPage(1);
\Drupal::request()->query
->set('page', 1);
$entities[0]->name->value = $random_name = $this
->randomMachineName();
$entities[0]
->save();
$build = $this
->assertViewsCacheTags($view, $tags_page_2, $do_assert_views_caches, $tags_page_2);
$this
->assertTrue(strpos($build['#markup'], $random_name) !== FALSE);
$view
->destroy();
$this
->pass('Page 1');
$view
->setCurrentPage(0);
\Drupal::request()->query
->set('page', 0);
$entities[1]->name->value = $random_name = $this
->randomMachineName();
$entities[1]
->save();
$build = $this
->assertViewsCacheTags($view, $tags_page_1, $do_assert_views_caches, $tags_page_1);
$this
->assertViewsCacheTagsFromStaticRenderArray($view, $tags_page_1, $do_assert_views_caches);
$this
->assertTrue(strpos($build['#markup'], $random_name) !== FALSE);
$view
->destroy();
$this
->pass('Test arguments');
$single_entity_assertions = function (array $build, EntityInterface $entity) {
$this
->setRawContent($build['#markup']);
$result = $this
->cssSelect('div.views-row');
$count = count($result);
$this
->assertEqual($count, 1);
$this
->assertEqual((string) $result[0]->div->span, (string) $entity
->id());
};
$tags_argument = Cache::mergeTags($base_tags, $entities[0]
->getCacheTags());
$view
->setArguments([
$entities[0]
->id(),
]);
$build = $this
->assertViewsCacheTags($view, $tags_argument, $do_assert_views_caches, $tags_argument);
$single_entity_assertions($build, $entities[0]);
$view
->setArguments([
$entities[0]
->id(),
]);
$build = $this
->assertViewsCacheTagsFromStaticRenderArray($view, $tags_argument, $do_assert_views_caches);
$single_entity_assertions($build, $entities[0]);
$tags2_argument = Cache::mergeTags($base_tags, $entities[1]
->getCacheTags());
$view
->setArguments([
$entities[1]
->id(),
]);
$build = $this
->assertViewsCacheTagsFromStaticRenderArray($view, $tags2_argument, $do_assert_views_caches);
$single_entity_assertions($build, $entities[1]);
$view
->destroy();
}
public function testEntityBasedViewCacheTagsWithCachePluginNone() {
$view = Views::getview('entity_test_row');
$view
->getDisplay()
->overrideOption('cache', [
'type' => 'none',
]);
$view
->save();
$this
->assertCacheTagsForEntityBasedView(FALSE);
}
public function testEntityBasedViewCacheTagsWithCachePluginTag() {
$view = Views::getview('entity_test_row');
$view
->getDisplay()
->overrideOption('cache', [
'type' => 'tag',
]);
$view
->save();
$this
->assertCacheTagsForEntityBasedView(TRUE);
}
public function testEntityBasedViewCacheTagsWithCachePluginTime() {
$view = Views::getview('entity_test_row');
$view
->getDisplay()
->overrideOption('cache', [
'type' => 'time',
'options' => [
'results_lifespan' => 3600,
'output_lifespan' => 3600,
],
]);
$view
->save();
$this
->assertCacheTagsForEntityBasedView(TRUE);
}
protected function assertCacheTagsForEntityBasedView($do_assert_views_caches) {
$this
->pass('Checking cache tags for entity-based view.');
$view = Views::getview('entity_test_row');
$base_tags = $base_render_tags = [
'config:views.view.entity_test_row',
'entity_test_list',
];
$this
->assertViewsCacheTags($view, $base_tags, $do_assert_views_caches, $base_tags);
$this
->assertViewsCacheTagsFromStaticRenderArray($view, $base_tags, $do_assert_views_caches);
$entities[] = $entity = EntityTest::create();
$entity
->save();
$result_tags_with_entity = Cache::mergeTags($base_tags, $entities[0]
->getCacheTags());
$render_tags_with_entity = Cache::mergeTags($base_render_tags, $entities[0]
->getCacheTags());
$render_tags_with_entity = Cache::mergeTags($render_tags_with_entity, [
'entity_test_view',
]);
$this
->assertViewsCacheTags($view, $result_tags_with_entity, $do_assert_views_caches, $render_tags_with_entity);
$this
->assertViewsCacheTagsFromStaticRenderArray($view, $render_tags_with_entity, $do_assert_views_caches);
for ($i = 0; $i < 5; $i++) {
$entities[] = $entity = EntityTest::create();
$entity
->save();
}
$new_entities_cache_tags = Cache::mergeTags($entities[1]
->getCacheTags(), $entities[2]
->getCacheTags());
$new_entities_cache_tags = Cache::mergeTags($new_entities_cache_tags, $entities[3]
->getCacheTags());
$new_entities_cache_tags = Cache::mergeTags($new_entities_cache_tags, $entities[4]
->getCacheTags());
$new_entities_cache_tags = Cache::mergeTags($new_entities_cache_tags, $entities[5]
->getCacheTags());
$result_tags_page_1 = Cache::mergeTags($base_tags, $new_entities_cache_tags);
$render_tags_page_1 = Cache::mergeTags($base_render_tags, $new_entities_cache_tags);
$render_tags_page_1 = Cache::mergeTags($render_tags_page_1, [
'entity_test_view',
]);
$this
->assertViewsCacheTags($view, $result_tags_page_1, $do_assert_views_caches, $render_tags_page_1);
$this
->assertViewsCacheTagsFromStaticRenderArray($view, $render_tags_page_1, $do_assert_views_caches);
}
public function testBuildRenderableWithCacheContexts() {
$view = View::load('test_view');
$display =& $view
->getDisplay('default');
$display['cache_metadata']['contexts'] = [
'views_test_cache_context',
];
$executable = $view
->getExecutable();
$build = $executable
->buildRenderable();
$this
->assertEqual([
'views_test_cache_context',
], $build['#cache']['contexts']);
}
public function testViewAddCacheMetadata() {
$view = View::load('test_display');
$view
->save();
$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']);
}
}