View source
<?php
namespace Drupal\Tests\jsonapi\Unit\Normalizer\Value;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\jsonapi\ResourceType\ResourceType;
use Drupal\jsonapi\LinkManager\LinkManager;
use Drupal\jsonapi\Normalizer\Value\RelationshipItemNormalizerValue;
use Drupal\jsonapi\Normalizer\Value\RelationshipNormalizerValue;
use Drupal\jsonapi\Normalizer\Value\FieldItemNormalizerValue;
use Drupal\Tests\UnitTestCase;
use Prophecy\Argument;
class RelationshipNormalizerValueTest extends UnitTestCase {
protected $cacheContextsManager;
protected function setUp() {
parent::setUp();
$this->cacheContextsManager = $this
->getMockBuilder('Drupal\\Core\\Cache\\Context\\CacheContextsManager')
->disableOriginalConstructor()
->getMock();
$this->cacheContextsManager
->method('assertValidTokens')
->willReturn(TRUE);
$container = new ContainerBuilder();
$container
->set('cache_contexts_manager', $this->cacheContextsManager);
\Drupal::setContainer($container);
}
public function testRasterizeValue($values, $cardinality, $expected, CacheableMetadata $expected_cacheability) {
$link_manager = $this
->prophesize(LinkManager::class);
$link_manager
->getEntityLink(Argument::any(), Argument::any(), Argument::type('array'), Argument::type('string'))
->willReturn('dummy_entity_link');
$resource_type = new ResourceType($this
->randomMachineName(), $this
->randomMachineName(), NULL);
$resource_type
->setRelatableResourceTypes([
'ipsum' => [
$resource_type,
],
]);
$object = new RelationshipNormalizerValue(AccessResult::allowed()
->cachePerUser()
->addCacheTags([
'relationship:foo',
]), $values, $cardinality, [
'link_manager' => $link_manager
->reveal(),
'host_entity_id' => 'lorem',
'resource_type' => $resource_type,
'field_name' => 'ipsum',
]);
$this
->assertEquals($expected, $object
->rasterizeValue());
$this
->assertSame($expected_cacheability
->getCacheContexts(), $object
->getCacheContexts());
$this
->assertSame($expected_cacheability
->getCacheTags(), $object
->getCacheTags());
$this
->assertSame($expected_cacheability
->getCacheMaxAge(), $object
->getCacheMaxAge());
}
public function rasterizeValueProvider() {
$uid_raw = 1;
$uid1 = $this
->prophesize(RelationshipItemNormalizerValue::class);
$uid1
->rasterizeValue()
->willReturn([
'type' => 'user',
'id' => $uid_raw++,
]);
$uid1
->getInclude()
->willReturn(NULL);
$uid1
->getCacheContexts()
->willReturn([
'ccfoo',
]);
$uid1
->getCacheTags()
->willReturn([
'ctfoo',
]);
$uid1
->getCacheMaxAge()
->willReturn(15);
$uid2 = $this
->prophesize(RelationshipItemNormalizerValue::class);
$uid2
->rasterizeValue()
->willReturn([
'type' => 'user',
'id' => $uid_raw,
]);
$uid2
->getInclude()
->willReturn(NULL);
$uid2
->getCacheContexts()
->willReturn([
'ccbar',
]);
$uid2
->getCacheTags()
->willReturn([
'ctbar',
]);
$uid2
->getCacheMaxAge()
->willReturn(10);
$img_id = $this
->randomMachineName();
$img1 = $this
->prophesize(RelationshipItemNormalizerValue::class);
$img1
->rasterizeValue()
->willReturn([
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
],
]);
$img1
->getInclude()
->willReturn(NULL);
$img1
->getCacheContexts()
->willReturn([
'ccimg1',
]);
$img1
->getCacheTags()
->willReturn([
'ctimg1',
]);
$img1
->getCacheMaxAge()
->willReturn(100);
$img2 = $this
->prophesize(RelationshipItemNormalizerValue::class);
$img2
->rasterizeValue()
->willReturn([
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Adorable llama',
'title' => 'My spirit animal 😍',
],
]);
$img2
->getInclude()
->willReturn(NULL);
$img2
->getCacheContexts()
->willReturn([
'ccimg2',
]);
$img2
->getCacheTags()
->willReturn([
'ctimg2',
]);
$img2
->getCacheMaxAge()
->willReturn(50);
$links = [
'self' => 'dummy_entity_link',
'related' => 'dummy_entity_link',
];
return [
'single cardinality' => [
[
$uid1
->reveal(),
],
1,
[
'data' => [
'type' => 'user',
'id' => 1,
],
'links' => $links,
],
(new CacheableMetadata())
->setCacheContexts([
'ccfoo',
'user',
])
->setCacheTags([
'ctfoo',
'relationship:foo',
])
->setCacheMaxAge(15),
],
'multiple cardinality' => [
[
$uid1
->reveal(),
$uid2
->reveal(),
],
2,
[
'data' => [
[
'type' => 'user',
'id' => 1,
],
[
'type' => 'user',
'id' => 2,
],
],
'links' => $links,
],
(new CacheableMetadata())
->setCacheContexts([
'ccbar',
'ccfoo',
'user',
])
->setCacheTags([
'ctbar',
'ctfoo',
'relationship:foo',
])
->setCacheMaxAge(10),
],
'multiple cardinality, all same values' => [
[
$uid1
->reveal(),
$uid1
->reveal(),
],
2,
[
'data' => [
[
'type' => 'user',
'id' => 1,
'meta' => [
'arity' => 0,
],
],
[
'type' => 'user',
'id' => 1,
'meta' => [
'arity' => 1,
],
],
],
'links' => $links,
],
(new CacheableMetadata())
->setCacheContexts([
'ccfoo',
'user',
])
->setCacheTags([
'ctfoo',
'relationship:foo',
])
->setCacheMaxAge(15),
],
'multiple cardinality, some same values' => [
[
$uid1
->reveal(),
$uid2
->reveal(),
$uid1
->reveal(),
],
2,
[
'data' => [
[
'type' => 'user',
'id' => 1,
'meta' => [
'arity' => 0,
],
],
[
'type' => 'user',
'id' => 2,
],
[
'type' => 'user',
'id' => 1,
'meta' => [
'arity' => 1,
],
],
],
'links' => $links,
],
(new CacheableMetadata())
->setCacheContexts([
'ccbar',
'ccfoo',
'user',
])
->setCacheTags([
'ctbar',
'ctfoo',
'relationship:foo',
])
->setCacheMaxAge(10),
],
'single cardinality, with meta' => [
[
$img1
->reveal(),
],
1,
[
'data' => [
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
],
],
'links' => $links,
],
(new CacheableMetadata())
->setCacheContexts([
'ccimg1',
'user',
])
->setCacheTags([
'ctimg1',
'relationship:foo',
])
->setCacheMaxAge(100),
],
'multiple cardinality, all same values, with meta' => [
[
$img1
->reveal(),
$img1
->reveal(),
],
2,
[
'data' => [
[
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'arity' => 0,
],
],
[
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'arity' => 1,
],
],
],
'links' => $links,
],
(new CacheableMetadata())
->setCacheContexts([
'ccimg1',
'user',
])
->setCacheTags([
'ctimg1',
'relationship:foo',
])
->setCacheMaxAge(100),
],
'multiple cardinality, some same values with same values but different meta' => [
[
$img1
->reveal(),
$img1
->reveal(),
$img2
->reveal(),
],
2,
[
'data' => [
[
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'arity' => 0,
],
],
[
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'arity' => 1,
],
],
[
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Adorable llama',
'title' => 'My spirit animal 😍',
'arity' => 2,
],
],
],
'links' => $links,
],
(new CacheableMetadata())
->setCacheContexts([
'ccimg1',
'ccimg2',
'user',
])
->setCacheTags([
'ctimg1',
'ctimg2',
'relationship:foo',
])
->setCacheMaxAge(50),
],
'all the edge cases!' => [
[
$img1
->reveal(),
$img1
->reveal(),
$img2
->reveal(),
$uid1
->reveal(),
$uid2
->reveal(),
$uid1
->reveal(),
],
10,
[
'data' => [
[
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'arity' => 0,
],
],
[
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Cute llama',
'title' => 'My spirit animal',
'arity' => 1,
],
],
[
'type' => 'file--file',
'id' => $img_id,
'meta' => [
'alt' => 'Adorable llama',
'title' => 'My spirit animal 😍',
'arity' => 2,
],
],
[
'type' => 'user',
'id' => 1,
'meta' => [
'arity' => 0,
],
],
[
'type' => 'user',
'id' => 2,
],
[
'type' => 'user',
'id' => 1,
'meta' => [
'arity' => 1,
],
],
],
'links' => $links,
],
(new CacheableMetadata())
->setCacheContexts([
'ccbar',
'ccfoo',
'ccimg1',
'ccimg2',
'user',
])
->setCacheTags([
'ctbar',
'ctfoo',
'ctimg1',
'ctimg2',
'relationship:foo',
])
->setCacheMaxAge(10),
],
];
}
public function testRasterizeValueFails() {
$uid1 = $this
->prophesize(FieldItemNormalizerValue::class);
$uid1
->rasterizeValue()
->willReturn(1);
$link_manager = $this
->prophesize(LinkManager::class);
$link_manager
->getEntityLink(Argument::any(), Argument::any(), Argument::type('array'), Argument::type('string'))
->willReturn('dummy_entity_link');
$this
->setExpectedException(\RuntimeException::class, 'Unexpected normalizer item value for this Drupal\\jsonapi\\Normalizer\\Value\\RelationshipNormalizerValue.');
new RelationshipNormalizerValue(AccessResult::allowed(), [
$uid1
->reveal(),
], 1, [
'link_manager' => $link_manager
->reveal(),
'host_entity_id' => 'lorem',
'resource_type' => new ResourceType($this
->randomMachineName(), $this
->randomMachineName(), NULL),
'field_name' => 'ipsum',
]);
}
}
