function CommentDefaultFormatterCacheTagsTest::testCacheTags
Same name in other branches
- 9 core/modules/comment/tests/src/Kernel/CommentDefaultFormatterCacheTagsTest.php \Drupal\Tests\comment\Kernel\CommentDefaultFormatterCacheTagsTest::testCacheTags()
- 8.9.x core/modules/comment/tests/src/Kernel/CommentDefaultFormatterCacheTagsTest.php \Drupal\Tests\comment\Kernel\CommentDefaultFormatterCacheTagsTest::testCacheTags()
- 10 core/modules/comment/tests/src/Kernel/CommentDefaultFormatterCacheTagsTest.php \Drupal\Tests\comment\Kernel\CommentDefaultFormatterCacheTagsTest::testCacheTags()
Tests the bubbling of cache tags.
File
-
core/
modules/ comment/ tests/ src/ Kernel/ CommentDefaultFormatterCacheTagsTest.php, line 72
Class
- CommentDefaultFormatterCacheTagsTest
- Tests comment cache tag bubbling up when using the Comment list formatter.
Namespace
Drupal\Tests\comment\KernelCode
public function testCacheTags() : void {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = $this->container
->get('renderer');
// Create the entity that will be commented upon.
$commented_entity = EntityTest::create([
'name' => $this->randomMachineName(),
]);
$commented_entity->save();
// Verify cache tags on the rendered entity before it has comments.
$build = \Drupal::entityTypeManager()->getViewBuilder('entity_test')
->view($commented_entity);
$renderer->renderRoot($build);
$expected_cache_tags = [
'entity_test_view',
'CACHE_MISS_IF_UNCACHEABLE_HTTP_METHOD:form',
'entity_test:' . $commented_entity->id(),
'config:core.entity_form_display.comment.comment.default',
'config:field.field.comment.comment.comment_body',
'config:field.field.entity_test.entity_test.comment',
'config:field.storage.comment.comment_body',
'config:user.settings',
];
$this->assertEqualsCanonicalizing($expected_cache_tags, $build['#cache']['tags']);
// Create a comment on that entity. Comment loading requires that the uid
// also exists in the {users} table.
$user = $this->createUser();
$user->save();
$comment = Comment::create([
'subject' => 'Llama',
'comment_body' => [
'value' => 'Llamas are cool!',
'format' => 'plain_text',
],
'entity_id' => $commented_entity->id(),
'entity_type' => 'entity_test',
'field_name' => 'comment',
'comment_type' => 'comment',
'status' => CommentInterface::PUBLISHED,
'uid' => $user->id(),
]);
$comment->save();
// Load commented entity so comment_count gets computed.
// @todo Remove the $reset = TRUE parameter after
// https://www.drupal.org/node/597236 lands. It's a temporary work-around.
$storage = $this->container
->get('entity_type.manager')
->getStorage('entity_test');
$storage->resetCache([
$commented_entity->id(),
]);
$commented_entity = $storage->load($commented_entity->id());
// Verify cache tags on the rendered entity when it has comments.
$build = \Drupal::entityTypeManager()->getViewBuilder('entity_test')
->view($commented_entity);
$renderer->renderRoot($build);
$expected_cache_tags = [
'entity_test_view',
'entity_test:' . $commented_entity->id(),
'comment_view',
'comment:' . $comment->id(),
'config:filter.format.plain_text',
'user_view',
'CACHE_MISS_IF_UNCACHEABLE_HTTP_METHOD:form',
'user:' . $user->id(),
'config:core.entity_form_display.comment.comment.default',
'config:field.field.comment.comment.comment_body',
'config:field.field.entity_test.entity_test.comment',
'config:field.storage.comment.comment_body',
'config:user.settings',
];
$this->assertEqualsCanonicalizing($expected_cache_tags, $build['#cache']['tags']);
// Build a render array with the entity in a sub-element so that lazy
// builder elements bubble up outside of the entity and we can check that
// it got the correct cache max age.
$build = [
'#type' => 'container',
];
$build['entity'] = \Drupal::entityTypeManager()->getViewBuilder('entity_test')
->view($commented_entity);
$renderer->renderRoot($build);
// The entity itself was cached but the top-level element is max-age 0 due
// to the bubbled up max age due to the lazy-built comment form.
$this->assertSame(Cache::PERMANENT, $build['entity']['#cache']['max-age']);
$this->assertSame(0, $build['#cache']['max-age'], 'Top level render array has max-age 0');
// The children (fields) of the entity render array are only built in case
// of a cache miss.
$this->assertFalse(isset($build['entity']['comment']), 'Cache hit');
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.