Skip to content

Commit 18aec2d

Browse files
fabpotfabpot
committed
bug #27773 [Serializer] Class discriminator and serialization groups (sroze)
This PR was merged into the 4.1 branch. Discussion ---------- [Serializer] Class discriminator and serialization groups | Q | A | ------------- | --- | Branch? | 4.1 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #27641 | License | MIT | Doc PR | ø It turns out the discriminator mapping does not work well with the serialization groups. This is fixing it (+ a little bit of cleaning in the tests). Commits ------- c91b7af Ensure the class discriminator mechanism works with serialization groups as well
2 parents d4561e4 + c91b7af commit 18aec2d

File tree

5 files changed

+79
-34
lines changed

5 files changed

+79
-34
lines changed

‎src/Symfony/Component/Serializer/Normalizer/ObjectNormalizer.php

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
1717
use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
1818
use Symfony\Component\Serializer\Exception\RuntimeException;
19+
use Symfony\Component\Serializer\Mapping\AttributeMetadata;
1920
use Symfony\Component\Serializer\Mapping\ClassDiscriminatorResolverInterface;
2021
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
2122
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
@@ -131,4 +132,24 @@ protected function setAttributeValue($object, $attribute, $value, $format = null
131132
// Properties not found are ignored
132133
}
133134
}
135+
136+
/**
137+
* {@inheritdoc}
138+
*/
139+
protected function getAllowedAttributes($classOrObject, array $context, $attributesAsString = false)
140+
{
141+
if (false === $allowedAttributes = parent::getAllowedAttributes($classOrObject, $context, $attributesAsString)) {
142+
return false;
143+
}
144+
145+
if (null !== $this->classDiscriminatorResolver && null !== $discriminatorMapping = $this->classDiscriminatorResolver->getMappingForMappedObject($classOrObject)) {
146+
$allowedAttributes[] = $attributesAsString ? $discriminatorMapping->getTypeProperty() : new AttributeMetadata($discriminatorMapping->getTypeProperty());
147+
148+
foreach ($discriminatorMapping->getTypesMapping() as $class) {
149+
$allowedAttributes = array_merge($allowedAttributes, parent::getAllowedAttributes($class, $context, $attributesAsString));
150+
}
151+
}
152+
153+
return $allowedAttributes;
154+
}
134155
}

‎src/Symfony/Component/Serializer/Tests/Fixtures/DummyMessageInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515

1616
/**
1717
* @DiscriminatorMap(typeProperty="type", mapping={
18-
* "first"="Symfony\Component\Serializer\Tests\Fixtures\AbstractDummyFirstChild",
19-
* "second"="Symfony\Component\Serializer\Tests\Fixtures\AbstractDummySecondChild"
18+
* "one"="Symfony\Component\Serializer\Tests\Fixtures\DummyMessageNumberOne",
19+
* "two"="Symfony\Component\Serializer\Tests\Fixtures\DummyMessageNumberTwo"
2020
* })
2121
*
2222
* @author Samuel Roze <samuel.roze@gmail.com>

‎src/Symfony/Component/Serializer/Tests/Fixtures/DummyMessageNumberOne.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,17 @@
1111

1212
namespace Symfony\Component\Serializer\Tests\Fixtures;
1313

14+
use Symfony\Component\Serializer\Annotation\Groups;
15+
1416
/**
1517
* @author Samuel Roze <samuel.roze@gmail.com>
1618
*/
1719
class DummyMessageNumberOne implements DummyMessageInterface
1820
{
1921
public $one;
22+
23+
/**
24+
* @Groups({"two"})
25+
*/
26+
public $two;
2027
}

‎src/Symfony/Component/Serializer/Tests/Fixtures/DummyMessageNumberTwo.php

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Serializer\Tests\Fixtures;
13+
14+
/**
15+
* @author Samuel Roze <samuel.roze@gmail.com>
16+
*/
17+
class DummyMessageNumberTwo implements DummyMessageInterface
18+
{
19+
}

‎src/Symfony/Component/Serializer/Tests/SerializerTest.php

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,14 @@
1111

1212
namespace Symfony\Component\Serializer\Tests;
1313

14+
use Doctrine\Common\Annotations\AnnotationReader;
1415
use PHPUnit\Framework\TestCase;
1516
use Symfony\Component\Serializer\Mapping\ClassDiscriminatorFromClassMetadata;
1617
use Symfony\Component\Serializer\Mapping\ClassDiscriminatorMapping;
1718
use Symfony\Component\Serializer\Mapping\ClassMetadata;
19+
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
1820
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
21+
use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
1922
use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
2023
use Symfony\Component\Serializer\Normalizer\DenormalizerAwareInterface;
2124
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
@@ -398,63 +401,58 @@ public function testDeserializeAndSerializeInterfacedObjectsWithTheClassMetadata
398401
$example = new DummyMessageNumberOne();
399402
$example->one = 1;
400403

401-
$jsonData = '{"message-type":"one","one":1}';
402-
403-
$discriminatorResolver = new ClassDiscriminatorFromClassMetadata($this->metadataFactoryMockForDummyInterface());
404-
$serializer = new Serializer(array(new ObjectNormalizer(null, null, null, null, $discriminatorResolver)), array('json' => new JsonEncoder()));
404+
$jsonData = '{"type":"one","one":1,"two":null}';
405405

406+
$serializer = $this->serializerWithClassDiscriminator();
406407
$deserialized = $serializer->deserialize($jsonData, DummyMessageInterface::class, 'json');
407408
$this->assertEquals($example, $deserialized);
408409

409410
$serialized = $serializer->serialize($deserialized, 'json');
410411
$this->assertEquals($jsonData, $serialized);
411412
}
412413

414+
public function testDeserializeAndSerializeInterfacedObjectsWithTheClassMetadataDiscriminatorResolverAndGroups()
415+
{
416+
$example = new DummyMessageNumberOne();
417+
$example->two = 2;
418+
419+
$serializer = $this->serializerWithClassDiscriminator();
420+
$deserialized = $serializer->deserialize('{"type":"one","one":1,"two":2}', DummyMessageInterface::class, 'json', array(
421+
'groups' => array('two'),
422+
));
423+
424+
$this->assertEquals($example, $deserialized);
425+
426+
$serialized = $serializer->serialize($deserialized, 'json', array(
427+
'groups' => array('two'),
428+
));
429+
430+
$this->assertEquals('{"two":2,"type":"one"}', $serialized);
431+
}
432+
413433
/**
414434
* @expectedException \Symfony\Component\Serializer\Exception\RuntimeException
415435
* @expectedExceptionMessage The type "second" has no mapped class for the abstract object "Symfony\Component\Serializer\Tests\Fixtures\DummyMessageInterface"
416436
*/
417437
public function testExceptionWhenTypeIsNotKnownInDiscriminator()
418438
{
419-
$discriminatorResolver = new ClassDiscriminatorFromClassMetadata($this->metadataFactoryMockForDummyInterface());
420-
$serializer = new Serializer(array(new ObjectNormalizer(null, null, null, null, $discriminatorResolver)), array('json' => new JsonEncoder()));
421-
$serializer->deserialize('{"message-type":"second","one":1}', DummyMessageInterface::class, 'json');
439+
$this->serializerWithClassDiscriminator()->deserialize('{"type":"second","one":1}', DummyMessageInterface::class, 'json');
422440
}
423441

424442
/**
425443
* @expectedException \Symfony\Component\Serializer\Exception\RuntimeException
426-
* @expectedExceptionMessage Type property "message-type" not found for the abstract object "Symfony\Component\Serializer\Tests\Fixtures\DummyMessageInterface"
444+
* @expectedExceptionMessage Type property "type" not found for the abstract object "Symfony\Component\Serializer\Tests\Fixtures\DummyMessageInterface"
427445
*/
428446
public function testExceptionWhenTypeIsNotInTheBodyToDeserialiaze()
429447
{
430-
$discriminatorResolver = new ClassDiscriminatorFromClassMetadata($this->metadataFactoryMockForDummyInterface());
431-
$serializer = new Serializer(array(new ObjectNormalizer(null, null, null, null, $discriminatorResolver)), array('json' => new JsonEncoder()));
432-
$serializer->deserialize('{"one":1}', DummyMessageInterface::class, 'json');
448+
$this->serializerWithClassDiscriminator()->deserialize('{"one":1}', DummyMessageInterface::class, 'json');
433449
}
434450

435-
private function metadataFactoryMockForDummyInterface()
451+
private function serializerWithClassDiscriminator()
436452
{
437-
$factoryMock = $this->getMockBuilder(ClassMetadataFactoryInterface::class)->getMock();
438-
$factoryMock->method('hasMetadataFor')->will($this->returnValueMap(array(
439-
array(
440-
DummyMessageInterface::class,
441-
true,
442-
),
443-
)));
444-
445-
$factoryMock->method('getMetadataFor')->will($this->returnValueMap(array(
446-
array(
447-
DummyMessageInterface::class,
448-
new ClassMetadata(
449-
DummyMessageInterface::class,
450-
new ClassDiscriminatorMapping('message-type', array(
451-
'one' => DummyMessageNumberOne::class,
452-
))
453-
),
454-
),
455-
)));
453+
$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
456454

457-
return $factoryMock;
455+
return new Serializer(array(new ObjectNormalizer($classMetadataFactory, null, null, null, new ClassDiscriminatorFromClassMetadata($classMetadataFactory))), array('json' => new JsonEncoder()));
458456
}
459457
}
460458

0 commit comments

Comments
 (0)