View source
<?php
namespace Drupal\Tests\Core\Render;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Render\BubbleableMetadata;
use Drupal\Tests\UnitTestCase;
use Symfony\Component\DependencyInjection\ContainerBuilder;
class BubbleableMetadataTest extends UnitTestCase {
public function testMerge(BubbleableMetadata $a, CacheableMetadata $b, BubbleableMetadata $expected) {
if (!$b instanceof BubbleableMetadata) {
$renderer = $this
->getMockBuilder('Drupal\\Core\\Render\\Renderer')
->disableOriginalConstructor()
->setMethods([
'mergeAttachments',
])
->getMock();
$renderer
->expects($this
->never())
->method('mergeAttachments');
}
else {
$renderer = $this
->getMockBuilder('Drupal\\Core\\Render\\Renderer')
->disableOriginalConstructor()
->setMethods(NULL)
->getMock();
}
$cache_contexts_manager = $this
->getMockBuilder('Drupal\\Core\\Cache\\Context\\CacheContextsManager')
->disableOriginalConstructor()
->getMock();
$cache_contexts_manager
->method('assertValidTokens')
->willReturn(TRUE);
$container = new ContainerBuilder();
$container
->set('cache_contexts_manager', $cache_contexts_manager);
$container
->set('renderer', $renderer);
\Drupal::setContainer($container);
$this
->assertEquals($expected, $a
->merge($b));
}
public function providerTestMerge() {
return [
[
new BubbleableMetadata(),
new BubbleableMetadata(),
new BubbleableMetadata(),
],
[
(new BubbleableMetadata())
->setCacheContexts([
'foo',
]),
(new BubbleableMetadata())
->setCacheContexts([
'bar',
]),
(new BubbleableMetadata())
->setCacheContexts([
'bar',
'foo',
]),
],
[
(new BubbleableMetadata())
->setCacheTags([
'foo',
]),
(new BubbleableMetadata())
->setCacheTags([
'bar',
]),
(new BubbleableMetadata())
->setCacheTags([
'bar',
'foo',
]),
],
[
(new BubbleableMetadata())
->setCacheMaxAge(60),
(new BubbleableMetadata())
->setCacheMaxAge(Cache::PERMANENT),
(new BubbleableMetadata())
->setCacheMaxAge(60),
],
[
(new BubbleableMetadata())
->setAttachments([
'library' => [
'core/foo',
],
]),
(new BubbleableMetadata())
->setAttachments([
'library' => [
'core/bar',
],
]),
(new BubbleableMetadata())
->setAttachments([
'library' => [
'core/foo',
'core/bar',
],
]),
],
[
(new BubbleableMetadata())
->setAttachments([
'placeholders' => [
'<my-placeholder>' => [
'callback',
[
'A',
],
],
],
]),
(new BubbleableMetadata())
->setAttachments([
'placeholders' => [
'<my-placeholder>' => [
'callback',
[
'A',
],
],
],
]),
(new BubbleableMetadata())
->setAttachments([
'placeholders' => [
'<my-placeholder>' => [
'callback',
[
'A',
],
],
],
]),
],
[
new BubbleableMetadata(),
new CacheableMetadata(),
new BubbleableMetadata(),
],
[
(new BubbleableMetadata())
->setCacheContexts([
'foo',
]),
(new CacheableMetadata())
->setCacheContexts([
'bar',
]),
(new BubbleableMetadata())
->setCacheContexts([
'bar',
'foo',
]),
],
[
(new BubbleableMetadata())
->setCacheTags([
'foo',
]),
(new CacheableMetadata())
->setCacheTags([
'bar',
]),
(new BubbleableMetadata())
->setCacheTags([
'bar',
'foo',
]),
],
[
(new BubbleableMetadata())
->setCacheMaxAge(60),
(new CacheableMetadata())
->setCacheMaxAge(Cache::PERMANENT),
(new BubbleableMetadata())
->setCacheMaxAge(60),
],
];
}
public function testAddAttachments(BubbleableMetadata $initial, $attachments, BubbleableMetadata $expected) {
$test = $initial;
$test
->addAttachments($attachments);
$this
->assertEquals($expected, $test);
}
public function providerTestAddAttachments() {
return [
[
new BubbleableMetadata(),
[],
new BubbleableMetadata(),
],
[
new BubbleableMetadata(),
[
'library' => [
'core/foo',
],
],
(new BubbleableMetadata())
->setAttachments([
'library' => [
'core/foo',
],
]),
],
[
(new BubbleableMetadata())
->setAttachments([
'library' => [
'core/foo',
],
]),
[
'library' => [
'core/bar',
],
],
(new BubbleableMetadata())
->setAttachments([
'library' => [
'core/foo',
'core/bar',
],
]),
],
];
}
public function testApplyTo(BubbleableMetadata $metadata, array $render_array, array $expected) {
$this
->assertNull($metadata
->applyTo($render_array));
$this
->assertEquals($expected, $render_array);
}
public function providerTestApplyTo() {
$data = [];
$empty_metadata = new BubbleableMetadata();
$nonempty_metadata = new BubbleableMetadata();
$nonempty_metadata
->setCacheContexts([
'qux',
])
->setCacheTags([
'foo:bar',
])
->setAttachments([
'settings' => [
'foo' => 'bar',
],
]);
$empty_render_array = [];
$nonempty_render_array = [
'#cache' => [
'contexts' => [
'qux',
],
'tags' => [
'llamas:are:awesome:but:kittens:too',
],
'max-age' => Cache::PERMANENT,
],
'#attached' => [
'library' => [
'core/jquery',
],
],
];
$expected_when_empty_metadata = [
'#cache' => [
'contexts' => [],
'tags' => [],
'max-age' => Cache::PERMANENT,
],
'#attached' => [],
];
$data[] = [
$empty_metadata,
$empty_render_array,
$expected_when_empty_metadata,
];
$data[] = [
$empty_metadata,
$nonempty_render_array,
$expected_when_empty_metadata,
];
$expected_when_nonempty_metadata = [
'#cache' => [
'contexts' => [
'qux',
],
'tags' => [
'foo:bar',
],
'max-age' => Cache::PERMANENT,
],
'#attached' => [
'settings' => [
'foo' => 'bar',
],
],
];
$data[] = [
$nonempty_metadata,
$empty_render_array,
$expected_when_nonempty_metadata,
];
$data[] = [
$nonempty_metadata,
$nonempty_render_array,
$expected_when_nonempty_metadata,
];
return $data;
}
public function testCreateFromRenderArray(array $render_array, BubbleableMetadata $expected) {
$this
->assertEquals($expected, BubbleableMetadata::createFromRenderArray($render_array));
}
public function providerTestCreateFromRenderArray() {
$data = [];
$empty_metadata = new BubbleableMetadata();
$nonempty_metadata = new BubbleableMetadata();
$nonempty_metadata
->setCacheContexts([
'qux',
])
->setCacheTags([
'foo:bar',
])
->setAttachments([
'settings' => [
'foo' => 'bar',
],
]);
$empty_render_array = [];
$nonempty_render_array = [
'#cache' => [
'contexts' => [
'qux',
],
'tags' => [
'foo:bar',
],
'max-age' => Cache::PERMANENT,
],
'#attached' => [
'settings' => [
'foo' => 'bar',
],
],
];
$data[] = [
$empty_render_array,
$empty_metadata,
];
$data[] = [
$nonempty_render_array,
$nonempty_metadata,
];
return $data;
}
public function testMergeAttachmentsLibraryMerging() {
$a['#attached'] = [
'library' => [
'core/drupal',
'core/drupalSettings',
],
'drupalSettings' => [
'foo' => [
'd',
],
],
];
$b['#attached'] = [
'library' => [
'core/jquery',
],
'drupalSettings' => [
'bar' => [
'a',
'b',
'c',
],
],
];
$expected['#attached'] = [
'library' => [
'core/drupal',
'core/drupalSettings',
'core/jquery',
],
'drupalSettings' => [
'foo' => [
'd',
],
'bar' => [
'a',
'b',
'c',
],
],
];
$this
->assertSame($expected['#attached'], BubbleableMetadata::mergeAttachments($a['#attached'], $b['#attached']), 'Attachments merged correctly.');
$expected['#attached'] = [
'library' => [
'core/jquery',
'core/drupal',
'core/drupalSettings',
],
'drupalSettings' => [
'bar' => [
'a',
'b',
'c',
],
'foo' => [
'd',
],
],
];
$this
->assertSame($expected['#attached'], BubbleableMetadata::mergeAttachments($b['#attached'], $a['#attached']), 'Attachments merged correctly; opposite merging yields opposite order.');
$b['#attached']['library'][] = 'core/drupalSettings';
$expected['#attached'] = [
'library' => [
'core/drupal',
'core/drupalSettings',
'core/jquery',
'core/drupalSettings',
],
'drupalSettings' => [
'foo' => [
'd',
],
'bar' => [
'a',
'b',
'c',
],
],
];
$this
->assertSame($expected['#attached'], BubbleableMetadata::mergeAttachments($a['#attached'], $b['#attached']), 'Attachments merged correctly; duplicates are retained.');
$b['#attached']['drupalSettings']['foo'] = [
'a',
'b',
'c',
];
$expected['#attached'] = [
'library' => [
'core/drupal',
'core/drupalSettings',
'core/jquery',
'core/drupalSettings',
],
'drupalSettings' => [
'foo' => [
'a',
'b',
'c',
],
'bar' => [
'a',
'b',
'c',
],
],
];
$this
->assertSame($expected['#attached'], BubbleableMetadata::mergeAttachments($a['#attached'], $b['#attached']));
$expected['#attached'] = [
'library' => [
'core/jquery',
'core/drupalSettings',
'core/drupal',
'core/drupalSettings',
],
'drupalSettings' => [
'bar' => [
'a',
'b',
'c',
],
'foo' => [
'd',
'b',
'c',
],
],
];
$this
->assertSame($expected['#attached'], BubbleableMetadata::mergeAttachments($b['#attached'], $a['#attached']));
$build = [];
$build['a']['#attached']['drupalSettings']['commonTest'] = 'firstValue';
$build['b']['#attached']['drupalSettings']['commonTest'] = 'secondValue';
$build['a']['#attached']['drupalSettings']['commonTestJsArrayLiteral'] = [
'firstValue',
];
$build['b']['#attached']['drupalSettings']['commonTestJsArrayLiteral'] = [
'secondValue',
];
$build['a']['#attached']['drupalSettings']['commonTestJsObjectLiteral'] = [
'key' => 'firstValue',
];
$build['b']['#attached']['drupalSettings']['commonTestJsObjectLiteral'] = [
'key' => 'secondValue',
];
$settings_one = [
'moduleName' => [
'ui' => [
'button A',
'button B',
],
'magical flag' => 3.14159265359,
],
];
$build['a']['#attached']['drupalSettings']['commonTestRealWorldIdentical'] = $settings_one;
$build['b']['#attached']['drupalSettings']['commonTestRealWorldIdentical'] = $settings_one;
$settings_two_a = [
'moduleName' => [
'ui' => [
'button A',
'button B',
'button C',
],
'magical flag' => 3.14159265359,
'thingiesOnPage' => [
'id1' => [],
],
],
];
$build['a']['#attached']['drupalSettings']['commonTestRealWorldAlmostIdentical'] = $settings_two_a;
$settings_two_b = [
'moduleName' => [
'ui' => [
'button D',
'button E',
],
'magical flag' => 3.14,
'thingiesOnPage' => [
'id2' => [],
],
],
];
$build['b']['#attached']['drupalSettings']['commonTestRealWorldAlmostIdentical'] = $settings_two_b;
$merged = BubbleableMetadata::mergeAttachments($build['a']['#attached'], $build['b']['#attached']);
$this
->assertSame('secondValue', $merged['drupalSettings']['commonTest']);
$this
->assertSame('secondValue', $merged['drupalSettings']['commonTestJsArrayLiteral'][0]);
$this
->assertSame('secondValue', $merged['drupalSettings']['commonTestJsObjectLiteral']['key']);
$settings_two['moduleName']['thingiesOnPage']['id1'] = [];
$this
->assertSame($settings_one, $merged['drupalSettings']['commonTestRealWorldIdentical']);
$expected_settings_two = $settings_two_a;
$expected_settings_two['moduleName']['ui'][0] = 'button D';
$expected_settings_two['moduleName']['ui'][1] = 'button E';
$expected_settings_two['moduleName']['ui'][2] = 'button C';
$expected_settings_two['moduleName']['magical flag'] = 3.14;
$expected_settings_two['moduleName']['thingiesOnPage']['id2'] = [];
$this
->assertSame($expected_settings_two, $merged['drupalSettings']['commonTestRealWorldAlmostIdentical']);
}
public function testMergeAttachmentsFeedMerging($a, $b, $expected) {
$this
->assertSame($expected, BubbleableMetadata::mergeAttachments($a, $b));
}
public function providerTestMergeAttachmentsFeedMerging() {
$feed_a = [
'aggregator/rss',
'Feed title',
];
$feed_b = [
'taxonomy/term/1/feed',
'RSS - foo',
];
$a = [
'feed' => [
$feed_a,
],
];
$b = [
'feed' => [
$feed_b,
],
];
$expected_a = [
'feed' => [
$feed_a,
$feed_b,
],
];
$expected_b = [
'feed' => [
$feed_b,
$feed_a,
],
];
return [
[
$a,
$b,
$expected_a,
],
[
$b,
$a,
$expected_b,
],
];
}
public function testMergeAttachmentsHtmlHeadMerging($a, $b, $expected) {
$this
->assertSame($expected, BubbleableMetadata::mergeAttachments($a, $b));
}
public function providerTestMergeAttachmentsHtmlHeadMerging() {
$meta = [
'#tag' => 'meta',
'#attributes' => [
'charset' => 'utf-8',
],
'#weight' => -1000,
];
$html_tag = [
'#type' => 'html_tag',
'#tag' => 'meta',
'#attributes' => [
'name' => 'Generator',
'content' => 'Kitten 1.0 (https://www.drupal.org/project/kitten)',
],
];
$a = [
'html_head' => [
$meta,
'system_meta_content_type',
],
];
$b = [
'html_head' => [
$html_tag,
'system_meta_generator',
],
];
$expected_a = [
'html_head' => [
$meta,
'system_meta_content_type',
$html_tag,
'system_meta_generator',
],
];
$expected_b = [
'html_head' => [
$html_tag,
'system_meta_generator',
$meta,
'system_meta_content_type',
],
];
return [
[
$a,
$b,
$expected_a,
],
[
$b,
$a,
$expected_b,
],
];
}
public function testMergeAttachmentsHtmlHeadLinkMerging($a, $b, $expected) {
$this
->assertSame($expected, BubbleableMetadata::mergeAttachments($a, $b));
}
public function providerTestMergeAttachmentsHtmlHeadLinkMerging() {
$rel = [
'rel' => 'rel',
'href' => 'http://rel.example.com',
];
$shortlink = [
'rel' => 'shortlink',
'href' => 'http://shortlink.example.com',
];
$a = [
'html_head_link' => [
$rel,
TRUE,
],
];
$b = [
'html_head_link' => [
$shortlink,
FALSE,
],
];
$expected_a = [
'html_head_link' => [
$rel,
TRUE,
$shortlink,
FALSE,
],
];
$expected_b = [
'html_head_link' => [
$shortlink,
FALSE,
$rel,
TRUE,
],
];
return [
[
$a,
$b,
$expected_a,
],
[
$b,
$a,
$expected_b,
],
];
}
public function testMergeAttachmentsHttpHeaderMerging($a, $b, $expected) {
$this
->assertSame($expected, BubbleableMetadata::mergeAttachments($a, $b));
}
public function providerTestMergeAttachmentsHttpHeaderMerging() {
$content_type = [
'Content-Type',
'application/rss+xml; charset=utf-8',
];
$expires = [
'Expires',
'Sun, 19 Nov 1978 05:00:00 GMT',
];
$a = [
'http_header' => [
$content_type,
],
];
$b = [
'http_header' => [
$expires,
],
];
$expected_a = [
'http_header' => [
$content_type,
$expires,
],
];
$expected_b = [
'http_header' => [
$expires,
$content_type,
],
];
return [
[
$a,
$b,
$expected_a,
],
[
$b,
$a,
$expected_b,
],
];
}
public function testAddCacheableDependency(BubbleableMetadata $a, $b, BubbleableMetadata $expected) {
$cache_contexts_manager = $this
->getMockBuilder('Drupal\\Core\\Cache\\Context\\CacheContextsManager')
->disableOriginalConstructor()
->getMock();
$cache_contexts_manager
->method('assertValidTokens')
->willReturn(TRUE);
$container = new ContainerBuilder();
$container
->set('cache_contexts_manager', $cache_contexts_manager);
\Drupal::setContainer($container);
$this
->assertEquals($expected, $a
->addCacheableDependency($b));
}
public function providerTestAddCacheableDependency() {
return [
'merge-cacheable-metadata' => [
(new BubbleableMetadata())
->setCacheContexts([
'foo',
])
->setCacheTags([
'foo',
])
->setCacheMaxAge(20),
(new CacheableMetadata())
->setCacheContexts([
'bar',
])
->setCacheTags([
'bar',
])
->setCacheMaxAge(60),
(new BubbleableMetadata())
->setCacheContexts([
'foo',
'bar',
])
->setCacheTags([
'foo',
'bar',
])
->setCacheMaxAge(20),
],
'merge-bubbleable-metadata' => [
(new BubbleableMetadata())
->setCacheContexts([
'foo',
])
->setCacheTags([
'foo',
])
->setCacheMaxAge(20)
->setAttachments([
'foo' => [],
]),
(new BubbleableMetadata())
->setCacheContexts([
'bar',
])
->setCacheTags([
'bar',
])
->setCacheMaxAge(60)
->setAttachments([
'bar' => [],
]),
(new BubbleableMetadata())
->setCacheContexts([
'foo',
'bar',
])
->setCacheTags([
'foo',
'bar',
])
->setCacheMaxAge(20)
->setAttachments([
'foo' => [],
'bar' => [],
]),
],
'merge-attachments-metadata' => [
(new BubbleableMetadata())
->setAttachments([
'foo' => [],
]),
(new BubbleableMetadata())
->setAttachments([
'baro' => [],
]),
(new BubbleableMetadata())
->setAttachments([
'foo' => [],
'bar' => [],
]),
],
];
}
}