123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233 |
- <?php
- namespace Drupal\KernelTests\Core\Entity;
- use Drupal\Core\Entity\EntityViewBuilder;
- use Drupal\Core\Language\LanguageInterface;
- use Drupal\field\Tests\EntityReference\EntityReferenceTestTrait;
- use Drupal\Core\Cache\Cache;
- use Drupal\user\Entity\Role;
- use Drupal\user\RoleInterface;
- /**
- * Tests the entity view builder.
- *
- * @group Entity
- */
- class EntityViewBuilderTest extends EntityKernelTestBase {
- use EntityReferenceTestTrait;
- /**
- * {@inheritdoc}
- */
- protected function setUp() {
- parent::setUp();
- $this->installConfig(['user', 'entity_test']);
- // Give anonymous users permission to view test entities.
- Role::load(RoleInterface::ANONYMOUS_ID)
- ->grantPermission('view test entity')
- ->save();
- }
- /**
- * Tests entity render cache handling.
- */
- public function testEntityViewBuilderCache() {
- /** @var \Drupal\Core\Render\RendererInterface $renderer */
- $renderer = $this->container->get('renderer');
- $cache_contexts_manager = \Drupal::service("cache_contexts_manager");
- $cache = \Drupal::cache();
- // Force a request via GET so we can get drupal_render() cache working.
- $request = \Drupal::request();
- $request_method = $request->server->get('REQUEST_METHOD');
- $request->setMethod('GET');
- $entity_test = $this->createTestEntity('entity_test');
- // Test that new entities (before they are saved for the first time) do not
- // generate a cache entry.
- $build = $this->container->get('entity.manager')->getViewBuilder('entity_test')->view($entity_test, 'full');
- $this->assertTrue(isset($build['#cache']) && array_keys($build['#cache']) == ['tags', 'contexts', 'max-age'], 'The render array element of new (unsaved) entities is not cached, but does have cache tags set.');
- // Get a fully built entity view render array.
- $entity_test->save();
- $build = $this->container->get('entity.manager')->getViewBuilder('entity_test')->view($entity_test, 'full');
- $cid_parts = array_merge($build['#cache']['keys'], $cache_contexts_manager->convertTokensToKeys(['languages:' . LanguageInterface::TYPE_INTERFACE, 'theme', 'user.permissions'])->getKeys());
- $cid = implode(':', $cid_parts);
- $bin = $build['#cache']['bin'];
- // Mock the build array to not require the theme registry.
- unset($build['#theme']);
- $build['#markup'] = 'entity_render_test';
- // Test that a cache entry is created.
- $renderer->renderRoot($build);
- $this->assertTrue($this->container->get('cache.' . $bin)->get($cid), 'The entity render element has been cached.');
- // Re-save the entity and check that the cache entry has been deleted.
- $cache->set('kittens', 'Kitten data', Cache::PERMANENT, $build['#cache']['tags']);
- $entity_test->save();
- $this->assertFalse($this->container->get('cache.' . $bin)->get($cid), 'The entity render cache has been cleared when the entity was saved.');
- $this->assertFalse($cache->get('kittens'), 'The entity saving has invalidated cache tags.');
- // Rebuild the render array (creating a new cache entry in the process) and
- // delete the entity to check the cache entry is deleted.
- unset($build['#printed']);
- $renderer->renderRoot($build);
- $this->assertTrue($this->container->get('cache.' . $bin)->get($cid), 'The entity render element has been cached.');
- $entity_test->delete();
- $this->assertFalse($this->container->get('cache.' . $bin)->get($cid), 'The entity render cache has been cleared when the entity was deleted.');
- // Restore the previous request method.
- $request->setMethod($request_method);
- }
- /**
- * Tests entity render cache with references.
- */
- public function testEntityViewBuilderCacheWithReferences() {
- /** @var \Drupal\Core\Render\RendererInterface $renderer */
- $renderer = $this->container->get('renderer');
- $cache_contexts_manager = \Drupal::service("cache_contexts_manager");
- // Force a request via GET so we can get drupal_render() cache working.
- $request = \Drupal::request();
- $request_method = $request->server->get('REQUEST_METHOD');
- $request->setMethod('GET');
- // Create an entity reference field and an entity that will be referenced.
- $this->createEntityReferenceField('entity_test', 'entity_test', 'reference_field', 'Reference', 'entity_test');
- entity_get_display('entity_test', 'entity_test', 'full')->setComponent('reference_field', [
- 'type' => 'entity_reference_entity_view',
- 'settings' => ['link' => FALSE],
- ])->save();
- $entity_test_reference = $this->createTestEntity('entity_test');
- $entity_test_reference->save();
- // Get a fully built entity view render array for the referenced entity.
- $build = $this->container->get('entity.manager')->getViewBuilder('entity_test')->view($entity_test_reference, 'full');
- $cid_parts = array_merge($build['#cache']['keys'], $cache_contexts_manager->convertTokensToKeys(['languages:' . LanguageInterface::TYPE_INTERFACE, 'theme', 'user.permissions'])->getKeys());
- $cid_reference = implode(':', $cid_parts);
- $bin_reference = $build['#cache']['bin'];
- // Mock the build array to not require the theme registry.
- unset($build['#theme']);
- $build['#markup'] = 'entity_render_test';
- $renderer->renderRoot($build);
- // Test that a cache entry was created for the referenced entity.
- $this->assertTrue($this->container->get('cache.' . $bin_reference)->get($cid_reference), 'The entity render element for the referenced entity has been cached.');
- // Create another entity that references the first one.
- $entity_test = $this->createTestEntity('entity_test');
- $entity_test->reference_field->entity = $entity_test_reference;
- $entity_test->save();
- // Get a fully built entity view render array.
- $build = $this->container->get('entity.manager')->getViewBuilder('entity_test')->view($entity_test, 'full');
- $cid_parts = array_merge($build['#cache']['keys'], $cache_contexts_manager->convertTokensToKeys(['languages:' . LanguageInterface::TYPE_INTERFACE, 'theme', 'user.permissions'])->getKeys());
- $cid = implode(':', $cid_parts);
- $bin = $build['#cache']['bin'];
- // Mock the build array to not require the theme registry.
- unset($build['#theme']);
- $build['#markup'] = 'entity_render_test';
- $renderer->renderRoot($build);
- // Test that a cache entry is created.
- $this->assertTrue($this->container->get('cache.' . $bin)->get($cid), 'The entity render element has been cached.');
- // Save the entity and verify that both cache entries have been deleted.
- $entity_test_reference->save();
- $this->assertFalse($this->container->get('cache.' . $bin)->get($cid), 'The entity render cache has been cleared when the entity was deleted.');
- $this->assertFalse($this->container->get('cache.' . $bin_reference)->get($cid_reference), 'The entity render cache for the referenced entity has been cleared when the entity was deleted.');
- // Restore the previous request method.
- $request->setMethod($request_method);
- }
- /**
- * Tests entity render cache toggling.
- */
- public function testEntityViewBuilderCacheToggling() {
- $entity_test = $this->createTestEntity('entity_test');
- $entity_test->save();
- // Test a view mode in default conditions: render caching is enabled for
- // the entity type and the view mode.
- $build = $this->container->get('entity.manager')->getViewBuilder('entity_test')->view($entity_test, 'full');
- $this->assertTrue(isset($build['#cache']) && array_keys($build['#cache']) == ['tags', 'contexts', 'max-age', 'keys', 'bin'], 'A view mode with render cache enabled has the correct output (cache tags, keys, contexts, max-age and bin).');
- // Test that a view mode can opt out of render caching.
- $build = $this->container->get('entity.manager')->getViewBuilder('entity_test')->view($entity_test, 'test');
- $this->assertTrue(isset($build['#cache']) && array_keys($build['#cache']) == ['tags', 'contexts', 'max-age'], 'A view mode with render cache disabled has the correct output (only cache tags, contexts and max-age).');
- // Test that an entity type can opt out of render caching completely.
- $this->installEntitySchema('entity_test_label');
- $entity_test_no_cache = $this->createTestEntity('entity_test_label');
- $entity_test_no_cache->save();
- $build = $this->container->get('entity.manager')->getViewBuilder('entity_test_label')->view($entity_test_no_cache, 'full');
- $this->assertTrue(isset($build['#cache']) && array_keys($build['#cache']) == ['tags', 'contexts', 'max-age'], 'An entity type can opt out of render caching regardless of view mode configuration, but always has cache tags, contexts and max-age set.');
- }
- /**
- * Tests weighting of display components.
- */
- public function testEntityViewBuilderWeight() {
- /** @var \Drupal\Core\Render\RendererInterface $renderer */
- $renderer = $this->container->get('renderer');
- // Set a weight for the label component.
- entity_get_display('entity_test', 'entity_test', 'full')
- ->setComponent('label', ['weight' => 20])
- ->save();
- // Create and build a test entity.
- $entity_test = $this->createTestEntity('entity_test');
- $view = $this->container->get('entity.manager')->getViewBuilder('entity_test')->view($entity_test, 'full');
- $renderer->renderRoot($view);
- // Check that the weight is respected.
- $this->assertEqual($view['label']['#weight'], 20, 'The weight of a display component is respected.');
- }
- /**
- * Creates an entity for testing.
- *
- * @param string $entity_type
- * The entity type.
- *
- * @return \Drupal\Core\Entity\EntityInterface
- * The created entity.
- */
- protected function createTestEntity($entity_type) {
- $data = [
- 'bundle' => $entity_type,
- 'name' => $this->randomMachineName(),
- ];
- return $this->container->get('entity.manager')->getStorage($entity_type)->create($data);
- }
- /**
- * Tests that viewing an entity without template does not specify #theme.
- */
- public function testNoTemplate() {
- // Ensure that an entity type without explicit view builder uses the
- // default.
- $entity_type_manager = \Drupal::entityTypeManager();
- $entity_type = $entity_type_manager->getDefinition('entity_test_base_field_display');
- $this->assertTrue($entity_type->hasViewBuilderClass());
- $this->assertEquals(EntityViewBuilder::class, $entity_type->getViewBuilderClass());
- // Ensure that an entity without matching template does not have a #theme
- // key.
- $entity = $this->createTestEntity('entity_test');
- $build = $entity_type_manager->getViewBuilder('entity_test')->view($entity);
- $this->assertEquals($entity, $build['#entity_test']);
- $this->assertFalse(array_key_exists('#theme', $build));
- }
- }
|