Skip to content

Properties need to be allowed by Symfony's serializer at the same time #4031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kayue wants to merge 4 commits into from
Closed

Properties need to be allowed by Symfony's serializer at the same time #4031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
85c2ba1
Attributes need to be allowed by Symfony's serializer at the same time
kayue Feb 6, 2021
da820fa
Handle class not supported by Symfony Serializer
kayue Feb 6, 2021
dc80470
Add unit test cover serialization group
kayue Feb 15, 2021
0c16333
Fix CS
kayue Feb 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/Serializer/AbstractItemNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,14 @@ protected function getAllowedAttributes($classOrObject, array $context, $attribu
}
}

// Gets allowed attributes using serialization groups
$groupAllowedAttributes = parent::getAllowedAttributes($classOrObject, $context, $attributesAsString);

if (\is_array($groupAllowedAttributes)) {
// Attributes need to be allowed by both API Resource and serialization groups at the same time
return array_intersect($allowedAttributes, $groupAllowedAttributes);
}

return $allowedAttributes;
}

Expand Down
76 changes: 76 additions & 0 deletions tests/Serializer/AbstractItemNormalizerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
use Symfony\Component\PropertyInfo\Type;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Serializer\Mapping\AttributeMetadata;
use Symfony\Component\Serializer\Mapping\ClassMetadata;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
use Symfony\Component\Serializer\NameConverter\AdvancedNameConverterInterface;
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
Expand Down Expand Up @@ -266,6 +269,79 @@ public function testNormalizeWithSecuredProperty()
]));
}

public function testNormalizeWithSerializationGroup()
{
$dummy = new Dummy();
$dummy->setName('myName'); // Available only in group "Default" (Symfony's default group name)
$dummy->setDescription('myDescription'); // Available only in group "dummy:write"

$propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
$propertyNameCollectionFactoryProphecy->create(Dummy::class, Argument::type('array'))->willReturn(new PropertyNameCollection(['name', 'description']));

$propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
$propertyMetadataFactoryProphecy->create(Dummy::class, 'name', Argument::type('array'))->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_STRING), '', true));
$propertyMetadataFactoryProphecy->create(Dummy::class, 'description', Argument::type('array'))->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_STRING), '', true));

$iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
$iriConverterProphecy->getIriFromItem($dummy)->willReturn('/secured_dummies/1');

$propertyAccessorProphecy = $this->prophesize(PropertyAccessorInterface::class);
$propertyAccessorProphecy->getValue($dummy, 'name')->willReturn($dummy->getName());
$propertyAccessorProphecy->getValue($dummy, 'description')->willReturn($dummy->getDescription());

// Class metadata
$titleAttributeMetadata = new AttributeMetadata('name');
$titleAttributeMetadata->addGroup('Default');
$descriptionAttributeMetadata = new AttributeMetadata('description');
$descriptionAttributeMetadata->addGroup('dummy:write');
$classMetadata = new ClassMetadata(Dummy::class);
$classMetadata->addAttributeMetadata($titleAttributeMetadata);
$classMetadata->addAttributeMetadata($descriptionAttributeMetadata);

$classMetadataFactoryProphecy = $this->prophesize(ClassMetadataFactoryInterface::class);
$classMetadataFactoryProphecy->getMetadataFor($dummy)->willReturn($classMetadata);
$classMetadataFactoryProphecy->getMetadataFor(Dummy::class)->willReturn($classMetadata);

$resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
$resourceClassResolverProphecy->getResourceClass($dummy, null)->willReturn(Dummy::class);

$resourceAccessChecker = $this->prophesize(ResourceAccessCheckerInterface::class);

$serializerProphecy = $this->prophesize(SerializerInterface::class);
$serializerProphecy->willImplement(NormalizerInterface::class);
$serializerProphecy->normalize('myName', null, Argument::type('array'))->willReturn('myName');
$serializerProphecy->normalize('myDescription', null, Argument::type('array'))->willReturn('myDescription');

$normalizer = $this->getMockForAbstractClass(AbstractItemNormalizer::class, [
$propertyNameCollectionFactoryProphecy->reveal(),
$propertyMetadataFactoryProphecy->reveal(),
$iriConverterProphecy->reveal(),
$resourceClassResolverProphecy->reveal(),
$propertyAccessorProphecy->reveal(),
null,
$classMetadataFactoryProphecy->reveal(),
null,
false,
[],
[],
null,
$resourceAccessChecker->reveal(),
]);
$normalizer->setSerializer($serializerProphecy->reveal());

if (!interface_exists(AdvancedNameConverterInterface::class) && method_exists($normalizer, 'setIgnoredAttributes')) {
$normalizer->setIgnoredAttributes(['alias']);
}

$expected = [
'name' => 'myName',
];
$this->assertEquals($expected, $normalizer->normalize($dummy, null, [
'resources' => [],
'groups' => ['Default'],
]));
}

public function testNormalizeReadableLinks()
{
$relatedDummy = new RelatedDummy();
Expand Down