Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\views\Kernel;
Chris@0: 
Chris@0: use Drupal\Core\Cache\Cache;
Chris@0: use Drupal\Core\Entity\EntityInterface;
Chris@0: use Drupal\Core\Language\LanguageInterface;
Chris@0: use Drupal\entity_test\Entity\EntityTest;
Chris@0: use Drupal\views\Tests\AssertViewsCacheTagsTrait;
Chris@0: use Drupal\views\Views;
Chris@0: use Drupal\views\Entity\View;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests the general integration between views and the render cache.
Chris@0:  *
Chris@0:  * @group views
Chris@0:  */
Chris@0: class RenderCacheIntegrationTest extends ViewsKernelTestBase {
Chris@0: 
Chris@0:   use AssertViewsCacheTagsTrait;
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static $testViews = ['test_view', 'test_display', 'entity_test_fields', 'entity_test_row'];
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static $modules = ['entity_test', 'user', 'node'];
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   protected function setUp($import_test_views = TRUE) {
Chris@0:     parent::setUp();
Chris@0: 
Chris@0:     $this->installEntitySchema('entity_test');
Chris@0:     $this->installEntitySchema('user');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests a field-based view's cache tags when using the "none" cache plugin.
Chris@0:    */
Chris@0:   public function testFieldBasedViewCacheTagsWithCachePluginNone() {
Chris@0:     $view = Views::getview('entity_test_fields');
Chris@0:     $view->getDisplay()->overrideOption('cache', [
Chris@0:       'type' => 'none',
Chris@0:     ]);
Chris@0:     $view->save();
Chris@0: 
Chris@0:     $this->assertCacheTagsForFieldBasedView(FALSE);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests a field-based view's cache tags when using the "tag" cache plugin.
Chris@0:    */
Chris@0:   public function testFieldBasedViewCacheTagsWithCachePluginTag() {
Chris@0:     $view = Views::getview('entity_test_fields');
Chris@0:     $view->getDisplay()->overrideOption('cache', [
Chris@0:       'type' => 'tag',
Chris@0:     ]);
Chris@0:     $view->save();
Chris@0: 
Chris@0:     $this->assertCacheTagsForFieldBasedView(TRUE);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests a field-based view's cache tags when using the "time" cache plugin.
Chris@0:    */
Chris@0:   public function testFieldBasedViewCacheTagsWithCachePluginTime() {
Chris@0:     $view = Views::getview('entity_test_fields');
Chris@0:     $view->getDisplay()->overrideOption('cache', [
Chris@0:       'type' => 'time',
Chris@0:       'options' => [
Chris@0:         'results_lifespan' => 3600,
Chris@0:         'output_lifespan' => 3600,
Chris@0:       ],
Chris@0:     ]);
Chris@0:     $view->save();
Chris@0: 
Chris@0:     $this->assertCacheTagsForFieldBasedView(TRUE);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests cache tags on output & result cache items for a field-based view.
Chris@0:    *
Chris@0:    * @param bool $do_assert_views_caches
Chris@0:    *   Whether to check Views' result & output caches.
Chris@0:    */
Chris@0:   protected function assertCacheTagsForFieldBasedView($do_assert_views_caches) {
Chris@0:     $this->pass('Checking cache tags for field-based view.');
Chris@0:     $view = Views::getview('entity_test_fields');
Chris@0: 
Chris@0:     // Empty result (no entities yet).
Chris@0:     $this->pass('Test without entities');
Chris@0:     $base_tags = ['config:views.view.entity_test_fields', 'entity_test_list'];
Chris@0:     $this->assertViewsCacheTags($view, $base_tags, $do_assert_views_caches, $base_tags);
Chris@0:     $this->assertViewsCacheTagsFromStaticRenderArray($view, $base_tags, $do_assert_views_caches);
Chris@0: 
Chris@0:     // Non-empty result (1 entity).
Chris@0:     /** @var \Drupal\Core\Entity\EntityInterface[] $entities */
Chris@0:     $entities[] = $entity = EntityTest::create();
Chris@0:     $entity->save();
Chris@0: 
Chris@0:     $this->pass('Test with entities');
Chris@0:     $tags_with_entity = Cache::mergeTags($base_tags, $entities[0]->getCacheTags());
Chris@0:     $this->assertViewsCacheTags($view, $tags_with_entity, $do_assert_views_caches, $tags_with_entity);
Chris@0:     $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags_with_entity, $do_assert_views_caches);
Chris@0: 
Chris@0:     // Paged result (more entities than the items-per-page limit).
Chris@0:     for ($i = 0; $i < 5; $i++) {
Chris@0:       $entities[] = $entity = EntityTest::create();
Chris@0:       $entity->save();
Chris@0:     }
Chris@0: 
Chris@0:     // Page 1.
Chris@0:     $this->pass('Test pager');
Chris@0:     $this->pass('Page 1');
Chris@0:     \Drupal::request()->query->set('page', 0);
Chris@0:     $tags_page_1 = Cache::mergeTags($base_tags, $entities[1]->getCacheTags());
Chris@0:     $tags_page_1 = Cache::mergeTags($tags_page_1, $entities[2]->getCacheTags());
Chris@0:     $tags_page_1 = Cache::mergeTags($tags_page_1, $entities[3]->getCacheTags());
Chris@0:     $tags_page_1 = Cache::mergeTags($tags_page_1, $entities[4]->getCacheTags());
Chris@0:     $tags_page_1 = Cache::mergeTags($tags_page_1, $entities[5]->getCacheTags());
Chris@0:     $this->assertViewsCacheTags($view, $tags_page_1, $do_assert_views_caches, $tags_page_1);
Chris@0:     $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags_page_1, $do_assert_views_caches);
Chris@0:     $view->destroy();
Chris@0:     // Page 2.
Chris@0:     $this->pass('Page 2');
Chris@0:     $view->setCurrentPage(1);
Chris@0:     \Drupal::request()->query->set('page', 1);
Chris@0:     $tags_page_2 = Cache::mergeTags($base_tags, $entities[0]->getCacheTags());
Chris@0:     $this->assertViewsCacheTags($view, $tags_page_2, $do_assert_views_caches, $tags_page_2);
Chris@0:     $view->destroy();
Chris@0: 
Chris@0:     // Ensure that invalidation works on both pages.
Chris@0:     $this->pass('Page invalidations');
Chris@0:     $this->pass('Page 2');
Chris@0:     $view->setCurrentPage(1);
Chris@0:     \Drupal::request()->query->set('page', 1);
Chris@0:     $entities[0]->name->value = $random_name = $this->randomMachineName();
Chris@0:     $entities[0]->save();
Chris@0:     $build = $this->assertViewsCacheTags($view, $tags_page_2, $do_assert_views_caches, $tags_page_2);
Chris@0:     // @todo Static render arrays don't support different pages yet, see
Chris@0:     //   https://www.drupal.org/node/2500701.
Chris@0:     // $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags_page_2, $do_assert_views_caches);
Chris@0:     $this->assertTrue(strpos($build['#markup'], $random_name) !== FALSE);
Chris@0:     $view->destroy();
Chris@0: 
Chris@0:     $this->pass('Page 1');
Chris@0:     $view->setCurrentPage(0);
Chris@0:     \Drupal::request()->query->set('page', 0);
Chris@0:     $entities[1]->name->value = $random_name = $this->randomMachineName();
Chris@0:     $entities[1]->save();
Chris@0:     $build = $this->assertViewsCacheTags($view, $tags_page_1, $do_assert_views_caches, $tags_page_1);
Chris@0:     $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags_page_1, $do_assert_views_caches);
Chris@0:     $this->assertTrue(strpos($build['#markup'], $random_name) !== FALSE);
Chris@0:     $view->destroy();
Chris@0: 
Chris@0:     // Setup arguments to ensure that render caching also varies by them.
Chris@0:     $this->pass('Test arguments');
Chris@0: 
Chris@0:     // Custom assert for a single result row.
Chris@0:     $single_entity_assertions = function (array $build, EntityInterface $entity) {
Chris@0:       $this->setRawContent($build['#markup']);
Chris@0: 
Chris@0:       $result = $this->cssSelect('div.views-row');
Chris@0:       $count = count($result);
Chris@0:       $this->assertEqual($count, 1);
Chris@0: 
Chris@0:       $this->assertEqual((string) $result[0]->div->span, (string) $entity->id());
Chris@0:     };
Chris@0: 
Chris@0:     // Execute the view once with a static renderable and one with a full
Chris@0:     // prepared render array.
Chris@0:     $tags_argument = Cache::mergeTags($base_tags, $entities[0]->getCacheTags());
Chris@0:     $view->setArguments([$entities[0]->id()]);
Chris@0:     $build = $this->assertViewsCacheTags($view, $tags_argument, $do_assert_views_caches, $tags_argument);
Chris@0:     $single_entity_assertions($build, $entities[0]);
Chris@0: 
Chris@0:     $view->setArguments([$entities[0]->id()]);
Chris@0:     $build = $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags_argument, $do_assert_views_caches);
Chris@0:     $single_entity_assertions($build, $entities[0]);
Chris@0: 
Chris@0:     // Set a different argument and ensure that the result is different.
Chris@0:     $tags2_argument = Cache::mergeTags($base_tags, $entities[1]->getCacheTags());
Chris@0:     $view->setArguments([$entities[1]->id()]);
Chris@0:     $build = $this->assertViewsCacheTagsFromStaticRenderArray($view, $tags2_argument, $do_assert_views_caches);
Chris@0:     $single_entity_assertions($build, $entities[1]);
Chris@0: 
Chris@0:     $view->destroy();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests a entity-based view's cache tags when using the "none" cache plugin.
Chris@0:    */
Chris@0:   public function testEntityBasedViewCacheTagsWithCachePluginNone() {
Chris@0:     $view = Views::getview('entity_test_row');
Chris@0:     $view->getDisplay()->overrideOption('cache', [
Chris@0:       'type' => 'none',
Chris@0:     ]);
Chris@0:     $view->save();
Chris@0: 
Chris@0:     $this->assertCacheTagsForEntityBasedView(FALSE);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests a entity-based view's cache tags when using the "tag" cache plugin.
Chris@0:    */
Chris@0:   public function testEntityBasedViewCacheTagsWithCachePluginTag() {
Chris@0:     $view = Views::getview('entity_test_row');
Chris@0:     $view->getDisplay()->overrideOption('cache', [
Chris@0:       'type' => 'tag',
Chris@0:     ]);
Chris@0:     $view->save();
Chris@0: 
Chris@0:     $this->assertCacheTagsForEntityBasedView(TRUE);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests a entity-based view's cache tags when using the "time" cache plugin.
Chris@0:    */
Chris@0:   public function testEntityBasedViewCacheTagsWithCachePluginTime() {
Chris@0:     $view = Views::getview('entity_test_row');
Chris@0:     $view->getDisplay()->overrideOption('cache', [
Chris@0:       'type' => 'time',
Chris@0:       'options' => [
Chris@0:         'results_lifespan' => 3600,
Chris@0:         'output_lifespan' => 3600,
Chris@0:       ],
Chris@0:     ]);
Chris@0:     $view->save();
Chris@0: 
Chris@0:     $this->assertCacheTagsForEntityBasedView(TRUE);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests cache tags on output & result cache items for an entity-based view.
Chris@0:    */
Chris@0:   protected function assertCacheTagsForEntityBasedView($do_assert_views_caches) {
Chris@0:     $this->pass('Checking cache tags for entity-based view.');
Chris@0:     $view = Views::getview('entity_test_row');
Chris@0: 
Chris@0:     // Empty result (no entities yet).
Chris@0:     $base_tags = $base_render_tags = ['config:views.view.entity_test_row', 'entity_test_list'];
Chris@0:     $this->assertViewsCacheTags($view, $base_tags, $do_assert_views_caches, $base_tags);
Chris@0:     $this->assertViewsCacheTagsFromStaticRenderArray($view, $base_tags, $do_assert_views_caches);
Chris@0: 
Chris@0:     // Non-empty result (1 entity).
Chris@0:     $entities[] = $entity = EntityTest::create();
Chris@0:     $entity->save();
Chris@0: 
Chris@0:     $result_tags_with_entity = Cache::mergeTags($base_tags, $entities[0]->getCacheTags());
Chris@0:     $render_tags_with_entity = Cache::mergeTags($base_render_tags, $entities[0]->getCacheTags());
Chris@0:     $render_tags_with_entity = Cache::mergeTags($render_tags_with_entity, ['entity_test_view']);
Chris@0:     $this->assertViewsCacheTags($view, $result_tags_with_entity, $do_assert_views_caches, $render_tags_with_entity);
Chris@0:     $this->assertViewsCacheTagsFromStaticRenderArray($view, $render_tags_with_entity, $do_assert_views_caches);
Chris@0: 
Chris@0:     // Paged result (more entities than the items-per-page limit).
Chris@0:     for ($i = 0; $i < 5; $i++) {
Chris@0:       $entities[] = $entity = EntityTest::create();
Chris@0:       $entity->save();
Chris@0:     }
Chris@0: 
Chris@0:     $new_entities_cache_tags = Cache::mergeTags($entities[1]->getCacheTags(), $entities[2]->getCacheTags());
Chris@0:     $new_entities_cache_tags = Cache::mergeTags($new_entities_cache_tags, $entities[3]->getCacheTags());
Chris@0:     $new_entities_cache_tags = Cache::mergeTags($new_entities_cache_tags, $entities[4]->getCacheTags());
Chris@0:     $new_entities_cache_tags = Cache::mergeTags($new_entities_cache_tags, $entities[5]->getCacheTags());
Chris@0:     $result_tags_page_1 = Cache::mergeTags($base_tags, $new_entities_cache_tags);
Chris@0:     $render_tags_page_1 = Cache::mergeTags($base_render_tags, $new_entities_cache_tags);
Chris@0:     $render_tags_page_1 = Cache::mergeTags($render_tags_page_1, ['entity_test_view']);
Chris@0:     $this->assertViewsCacheTags($view, $result_tags_page_1, $do_assert_views_caches, $render_tags_page_1);
Chris@0:     $this->assertViewsCacheTagsFromStaticRenderArray($view, $render_tags_page_1, $do_assert_views_caches);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Ensure that the view renderable contains the cache contexts.
Chris@0:    */
Chris@0:   public function testBuildRenderableWithCacheContexts() {
Chris@0:     $view = View::load('test_view');
Chris@0:     $display =& $view->getDisplay('default');
Chris@0:     $display['cache_metadata']['contexts'] = ['views_test_cache_context'];
Chris@0:     $executable = $view->getExecutable();
Chris@0: 
Chris@0:     $build = $executable->buildRenderable();
Chris@0:     $this->assertEqual(['views_test_cache_context'], $build['#cache']['contexts']);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Ensures that saving a view calculates the cache contexts.
Chris@0:    */
Chris@0:   public function testViewAddCacheMetadata() {
Chris@0:     $view = View::load('test_display');
Chris@0:     $view->save();
Chris@0: 
Chris@0:     $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']);
Chris@0:   }
Chris@0: 
Chris@0: }