8000 [Serializer] Fix support for DiscriminatorMap in PropertyNormalizer by mtarld · Pull Request #52681 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Serializer] Fix support for DiscriminatorMap in PropertyNormalizer #52681

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

Merged
merged 1 commit into from
Nov 24, 2023
Merged

[Serializer] Fix support for DiscriminatorMap in PropertyNormalizer #52681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 16 additions & 2 deletions src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,15 @@ public function normalize($object, string $format = null, array $context = [])

$attributeContext = $this->getAttributeNormalizationContext($object, $attribute, $context);

$discriminatorProperty = null;
if (null !== $this->classDiscriminatorResolver && null !== $mapping = $this->classDiscriminatorResolver->getMappingForMappedObject($object)) {
$discriminatorProperty = $mapping->getTypeProperty();
}

try {
$attributeValue = $this->getAttributeValue($object, $attribute, $format, $attributeContext);
$attributeValue = $attribute === $discriminatorProperty
? $this->classDiscriminatorResolver->getTypeForMappedObject($object)
: $this->getAttributeValue($object, $attribute, $format, $attributeContext);
} catch (UninitializedPropertyException $e) {
if ($context[self::SKIP_UNINITIALIZED_VALUES] ?? $this->defaultContext[self::SKIP_UNINITIALIZED_VALUES] ?? true) {
continue;
Expand Down Expand Up @@ -386,8 +393,15 @@ public function denormalize($data, string $type, string $format = null, array $c
}

if ($attributeContext[self::DEEP_OBJECT_TO_POPULATE] ?? $this->defaultContext[self::DEEP_OBJECT_TO_POPULATE] ?? false) {
$discriminatorProperty = null;
if (null !== $this->classDiscriminatorResolver && null !== $mapping = $this->classDiscriminatorResolver->getMappingForMappedObject($object)) {
$discriminatorProperty = $mapping->getTypeProperty();
}

try {
$attributeContext[self::OBJECT_TO_POPULATE] = $this->getAttributeValue($object, $attribute, $format, $attributeContext);
$attributeContext[self::OBJECT_TO_POPULATE] = $attribute === $discriminatorProperty
? $this->classDiscriminatorResolver->getTypeForMappedObject($object)
: $this->getAttributeValue($object, $attribute, $format, $attributeContext);
} catch (NoSuchPropertyException $e) {
}
}
Expand Down
4 changes: 4 additions & 0 deletions src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ public function hasCacheableSupportsMethod(): bool
*/
private function supports(string $class): bool
{
if (null !== $this->classDiscriminatorResolver && $this->classDiscriminatorResolver->getMappingForClass($ 8000 class)) {
return true;
}

$class = new \ReflectionClass($class);
$methods = $class->getMethods(\ReflectionMethod::IS_PUBLIC);
foreach ($methods as $method) {
Expand Down
16 changes: 6 additions & 10 deletions src/Symfony/Component/Serializer/Normalizer/ObjectNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ class ObjectNormalizer extends AbstractObjectNormalizer
{
protected $propertyAccessor;

private $discriminatorCache = [];

private $objectClassResolver;

public function __construct(ClassMetadataFactoryInterface $classMetadataFactory = null, NameConverterInterface $nameConverter = null, PropertyAccessorInterface $propertyAccessor = null, PropertyTypeExtractorInterface $propertyTypeExtractor = null, ClassDiscriminatorResolverInterface $classDiscriminatorResolver = null, callable $objectClassResolver = null, array $defaultContext = [])
Expand Down Expand Up @@ -128,16 +126,14 @@ protected function extractAttributes(object $object, string $format = null, arra
*/
protected function getAttributeValue(object $object, string $attribute, string $ 8000 format = null, array $context = [])
{
$cacheKey = \get_class($object);
if (!\array_key_exists($cacheKey, $this->discriminatorCache)) {
$this->discriminatorCache[$cacheKey] = null;
if (null !== $this->classDiscriminatorResolver) {
$mapping = $this->classDiscriminatorResolver->getMappingForMappedObject($object);
$this->discriminatorCache[$cacheKey] = null === $mapping ? null : $mapping->getTypeProperty();
}
$discriminatorProperty = null;
if (null !== $this->classDiscriminatorResolver && null !== $mapping = $this->classDiscriminatorResolver->getMappingForMappedObject($object)) {
$discriminatorProperty = $mapping->getTypeProperty();
}

return $attribute === $this->discriminatorCache[$cacheKey] ? $this->classDiscriminatorResolver->getTypeForMappedObject($object) : $this->propertyAccessor->getValue($object, $attribute);
return $attribute === $discriminatorProperty
? $this->classDiscriminatorResolver->getTypeForMappedObject($object)
: $this->propertyAccessor->getValue($object, $attribute);
}

/**
Expand Down
4 changes: 4 additions & 0 deletions src/Symfony/Component/Serializer/Normalizer/PropertyNormalizer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ public function hasCacheableSupportsMethod(): bool
*/
private function supports(string $class): bool
{
if (null !== $this->classDiscriminatorResolver && $this->classDiscriminatorResolver->getMappingForClass($class)) {
return true;
}

$class = new \ReflectionClass($class);

// We look for at least one non-static property
Expand Down
63 changes: 63 additions & 0 deletions src/Symfony/Component/Serializer/Tests/Normalizer/GetSetMethodNormalizerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
use Symfony\Component\Serializer\Annotation\DiscriminatorMap;
use Symfony\Component\Serializer\Exception\LogicException;
use Symfony\Component\Serializer\Mapping\ClassDiscriminatorFromClassMetadata;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
Expand Down Expand Up @@ -498,6 +500,27 @@ protected function getNormalizerForSkipUninitializedValues(): NormalizerInterfac
{
return new GetSetMethodNormalizer(new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader())));
}

public function testNormalizeWithDiscriminator()
{
$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
$discriminator = new ClassDiscriminatorFromClassMetadata($classMetadataFactory);
$normalizer = new GetSetMethodNormalizer($classMetadataFactory, null, null, $discriminator);

$this->assertSame(['type' => 'one', 'url' => 'URL_ONE'], $normalizer->normalize(new GetSetMethodDiscriminatedDummyOne()));
}

public function testDenormalizeWithDiscriminator()
{
$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
$discriminator = new ClassDiscriminatorFromClassMetadata($classMetadataFactory);
$normalizer = new GetSetMethodNormalizer($classMetadataFactory, null, null, $discriminator);

$denormalized = new GetSetMethodDiscriminatedDummyTwo();
$denormalized->setUrl('url');

$this->assertEquals($denormalized, $normalizer->denormalize(['type' => 'two', 'url' => 'url'], GetSetMethodDummyInterface::class));
}
}

class GetSetDummy
Expand Down Expand Up @@ -762,3 +785,43 @@ public function __call($key, $value)
throw new \RuntimeException('__call should not be called. Called with: '.$key);
}
}

/**
* @DiscriminatorMap(typeProperty="type", mapping={
* "one" = GetSetMethodDiscriminatedDummyOne::class,
* "two" = GetSetMethodDiscriminatedDummyTwo::class,
* })
*/
interface GetSetMethodDummyInterface
{
}

class GetSetMethodDiscriminatedDummyOne implements GetSetMethodDummyInterface
{
private string $url = 'URL_ONE';

public function getUrl(): string
{
return $this->url;
}

public function setUrl(string $url): void
{
$this->url = $url;
}
}

class GetSetMethodDiscriminatedDummyTwo implements GetSetMethodDummyInterface
{
private string $url = 'URL_TWO';

public function getUrl(): string
{
return $this->url;
}

public function setUrl(string $url): void
{
$this->url = $url;
}
}
43 changes: 43 additions & 0 deletions src/Symfony/Component/Serializer/Tests/Normalizer/PropertyNormalizerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
use Symfony\Component\Serializer\Annotation\DiscriminatorMap;
use Symfony\Component\Serializer\Exception\LogicException;
use Symfony\Component\Serializer\Mapping\ClassDiscriminatorFromClassMetadata;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
Expand Down Expand Up @@ -457,6 +459,27 @@ protected function getNormalizerForSkipUninitializedValues(): NormalizerInterfac
{
return new PropertyNormalizer(new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader())));
}

public function testNormalizeWithDiscriminator()
{
$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
$discriminator = new ClassDiscriminatorFromClassMetadata($classMetadataFactory);
$normalizer = new PropertyNormalizer($classMetadataFactory, null, null, $discriminator);

$this->assertSame(['type' => 'one', 'url' => 'URL_ONE'], $normalizer->normalize(new PropertyDiscriminatedDummyOne()));
}

public function testDenormalizeWithDiscriminator()
{
$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
$discriminator = new ClassDiscriminatorFromClassMetadata($classMetadataFactory);
$normalizer = new PropertyNormalizer($classMetadataFactory, null, null, $discriminator);

$denormalized = new PropertyDiscriminatedDummyTwo();
$denormalized->url = 'url';

$this->assertEquals($denormalized, $normalizer->denormalize(['type' => 'two', 'url' => 'url'], PropertyDummyInterface::class));
}
}

class PropertyDummy
Expand Down Expand Up @@ -560,3 +583,23 @@ public function getIntMatrix(): array
return $this->intMatrix;
}
}

/**
* @DiscriminatorMap(typeProperty="type", mapping={
* "one" = PropertyDiscriminatedDummyOne::class,
* "two" = PropertyDiscriminatedDummyTwo::class,
* })
*/
interface PropertyDummyInterface
{
}

class PropertyDiscriminatedDummyOne implements PropertyDummyInterface
{
public string $url = 'URL_ONE';
}

class PropertyDiscriminatedDummyTwo implements PropertyDummyInterface
{
public string $url = 'URL_TWO';
}
0