Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Serializer] Add ChainNormalizer and ChainDenormalizer #52900

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.

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

Open
wants to merge 10 commits into
base: 7.4
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions UPGRADE-7.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@ Security
--------

* Deprecate argument `$secret` of `RememberMeToken` and `RememberMeAuthenticator`

Serializer
----------

* Deprecated argument `$normalizers` of `Serializer::__construct()`, use arguments `$normalizer` and `$denormalizer` instead
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use Symfony\Component\Serializer\Encoder\YamlEncoder;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
use Symfony\Component\Serializer\Mapping\Loader\AttributeLoader;
use Symfony\Component\Serializer\Normalizer\ChainNormalizer;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Serializer;
use Twig\Environment;
Expand Down Expand Up @@ -50,7 +51,14 @@ public static function serializerDataProvider(): \Generator
private function getTwig(string $template): Environment
{
$meta = new ClassMetadataFactory(new AttributeLoader());
$runtime = new SerializerRuntime(new Serializer([new ObjectNormalizer($meta)], [new JsonEncoder(), new YamlEncoder()]));

// if Symfony 7.2
if (class_exists(ChainNormalizer::class)) {
$serializer = new Serializer([], [new JsonEncoder(), new YamlEncoder()], new ObjectNormalizer($meta), new ObjectNormalizer($meta));
} else {
$serializer = new Serializer([new ObjectNormalizer($meta)], [new JsonEncoder(), new YamlEncoder()]);
}
$runtime = new SerializerRuntime($serializer);

$mockRuntimeLoader = $this->createMock(RuntimeLoaderInterface::class);
$mockRuntimeLoader
Expand Down
35 changes: 29 additions & 6 deletions src/Symfony/Bridge/Twig/Tests/Mime/TemplatedEmailTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
use Symfony\Component\Serializer\Normalizer\ChainDenormalizer;
use Symfony\Component\Serializer\Normalizer\ChainNormalizer;
use Symfony\Component\Serializer\Normalizer\MimeMessageNormalizer;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Normalizer\PropertyNormalizer;
Expand Down Expand Up @@ -105,12 +107,33 @@ public function testSymfonySerialize()

$extractor = new PhpDocExtractor();
$propertyNormalizer = new PropertyNormalizer(null, null, $extractor);
$serializer = new Serializer([
new ArrayDenormalizer(),
new MimeMessageNormalizer($propertyNormalizer),
new ObjectNormalizer(null, null, null, $extractor),
$propertyNormalizer,
], [new JsonEncoder()]);
// if Symfony 7.2
if (class_exists(ChainNormalizer::class)) {
$normalizers = [
new MimeMessageNormalizer($propertyNormalizer),
new ObjectNormalizer(null, null, null, $extractor),
$propertyNormalizer,
];
$denormalizers = [
new ArrayDenormalizer(),
new MimeMessageNormalizer($propertyNormalizer),
new ObjectNormalizer(null, null, null, $extractor),
$propertyNormalizer,
];
$serializer = new Serializer(
[],
[new JsonEncoder()],
new ChainNormalizer($normalizers),
new ChainDenormalizer($denormalizers),
);
} else {
$serializer = new Serializer([
new ArrayDenormalizer(),
new MimeMessageNormalizer($propertyNormalizer),
new ObjectNormalizer(null, null, null, $extractor),
$propertyNormalizer,
], [new JsonEncoder()]);
}

$serialized = $serializer->serialize($e, 'json', [ObjectNormalizer::IGNORED_ATTRIBUTES => ['cachedBody']]);
$this->assertStringMatchesFormat($expectedJson, json_encode(json_decode($serialized), \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
use Symfony\Component\Serializer\NameConverter\MetadataAwareNameConverter;
use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
use Symfony\Component\Serializer\Normalizer\BackedEnumNormalizer;
use Symfony\Component\Serializer\Normalizer\ChainDenormalizer;
use Symfony\Component\Serializer\Normalizer\ChainNormalizer;
use Symfony\Component\Serializer\Normalizer\ConstraintViolationListNormalizer;
use Symfony\Component\Serializer\Normalizer\DataUriNormalizer;
use Symfony\Component\Serializer\Normalizer\DateIntervalNormalizer;
Expand All @@ -58,12 +60,16 @@
;

$container->services()
->set('serializer.normalizer', ChainNormalizer::class)
->args([[]])
->set('serializer.denormalizer', ChainDenormalizer::class)
->args([[]])
->set('serializer', Serializer::class)
->args([[], []])
->args([[], [], service('serializer.normalizer'), service('serializer.denormalizer')])

->alias(SerializerInterface::class, 'serializer')
->alias(NormalizerInterface::class, 'serializer')
->alias(DenormalizerInterface::class, 'serializer')
->alias(NormalizerInterface::class, 'serializer.normalizer')
->alias(DenormalizerInterface::class, 'serializer.denormalizer')
->alias(EncoderInterface::class, 'serializer')
->alias(DecoderInterface::class, 'serializer')

Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
"symfony/scheduler": "^6.4.4|^7.0.4",
"symfony/security-bundle": "^6.4|^7.0",
"symfony/semaphore": "^6.4|^7.0",
"symfony/serializer": "^6.4|^7.0",
"symfony/serializer": "^7.2",
"symfony/stopwatch": "^6.4|^7.0",
"symfony/string": "^6.4|^7.0",
"symfony/translation": "^6.4|^7.0",
Expand Down Expand Up @@ -93,7 +93,7 @@
"symfony/property-info": "<6.4",
"symfony/property-access": "<6.4",
"symfony/scheduler": "<6.4.4|>=7.0.0,<7.0.4",
"symfony/serializer": "<6.4",
"symfony/serializer": "<7.2",
"symfony/security-csrf": "<6.4",
"symfony/security-core": "<6.4",
"symfony/stopwatch": "<6.4",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use PHPUnit\Framework\TestCase;
use Symfony\Component\ErrorHandler\ErrorRenderer\SerializerErrorRenderer;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Normalizer\ChainNormalizer;
use Symfony\Component\Serializer\Normalizer\ProblemNormalizer;
use Symfony\Component\Serializer\Serializer;

Expand All @@ -28,9 +29,15 @@ public function testDefaultContent()

public function testSerializerContent()
{
// if Symfony 7.2
if (class_exists(ChainNormalizer::class)) {
$serializer = new Serializer([], [new JsonEncoder()], new ProblemNormalizer());
} else {
$serializer = new Serializer([new ProblemNormalizer()], [new JsonEncoder()]);
}
$exception = new \RuntimeException('Foo');
$errorRenderer = new SerializerErrorRenderer(
new Serializer([new ProblemNormalizer()], [new JsonEncoder()]),
$serializer,
fn () => 'json'
);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
use Symfony\Component\Serializer\Exception\PartialDenormalizationException;
use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
use Symfony\Component\Serializer\Normalizer\ChainDenormalizer;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Serializer;
Expand Down Expand Up @@ -204,7 +205,10 @@ public function testQueryNullPayloadAndNotDefaultOrNullableArgument()
}
}

public function testWithoutValidatorAndCouldNotDenormalize()
/**
* @group legacy
*/
public function testWithoutValidatorAndCouldNotDenormalizeWithLegacySerializer()
{
$content = '{"price": 50, "title": ["not a string"]}';
$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
Expand All @@ -228,10 +232,34 @@ public function testWithoutValidatorAndCouldNotDenormalize()
}
}

public function testWithoutValidatorAndCouldNotDenormalize()
{
$content = '{"price": 50, "title": ["not a string"]}';
$serializer = new Serializer([], ['json' => new JsonEncoder()], new ObjectNormalizer(), new ObjectNormalizer());

$resolver = new RequestPayloadValueResolver($serializer);

$argument = new ArgumentMetadata('invalid', RequestPayload::class, false, false, null, false, [
MapRequestPayload::class => new MapRequestPayload(),
]);
$request = Request::create('/', 'POST', server: ['CONTENT_TYPE' => 'application/json'], content: $content);

$kernel = $this->createMock(HttpKernelInterface::class);
$arguments = $resolver->resolve($request, $argument);
$event = new ControllerArgumentsEvent($kernel, function () {}, $arguments, $request, HttpKernelInterface::MAIN_REQUEST);

try {
$resolver->onKernelControllerArguments($event);
$this->fail(sprintf('Expected "%s" to be thrown.', HttpException::class));
} catch (HttpException $e) {
$this->assertInstanceOf(PartialDenormalizationException::class, $e->getPrevious());
}
}

public function testValidationNotPassed()
{
$content = '{"price": 50, "title": ["not a string"]}';
$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
$serializer = new Serializer([], ['json' => new JsonEncoder()], new ObjectNormalizer(), new ObjectNormalizer());

$validator = $this->createMock(ValidatorInterface::class);
$validator->expects($this->never())
Expand Down Expand Up @@ -262,7 +290,7 @@ public function testValidationNotPassed()
public function testValidationNotPerformedWhenPartialDenormalizationReturnsViolation()
{
$content = '{"password": "abc"}';
$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
$serializer = new Serializer([], ['json' => new JsonEncoder()], new ObjectNormalizer(), new ObjectNormalizer());

$validator = $this->createMock(ValidatorInterface::class);
$validator->expects($this->never())
Expand Down Expand Up @@ -316,7 +344,7 @@ public function testRequestContentValidationPassed()
{
$content = '{"price": 50}';
$payload = new RequestPayload(50);
$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
$serializer = new Serializer([], ['json' => new JsonEncoder()], new ObjectNormalizer(), new ObjectNormalizer());

$validator = $this->createMock(ValidatorInterface::class);
$validator->expects($this->once())
Expand Down Expand Up @@ -372,7 +400,7 @@ public function testQueryStringValidationPassed()
$payload = new RequestPayload(50);
$query = ['price' => '50'];

$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
$serializer = new Serializer([], ['json' => new JsonEncoder()], new ObjectNormalizer(), new ObjectNormalizer());

$validator = $this->createMock(ValidatorInterface::class);
$validator->expects($this->once())
Expand Down Expand Up @@ -400,7 +428,7 @@ public function testRequestInputValidationPassed()
$input = ['price' => '50'];
$payload = new RequestPayload(50);

$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
$serializer = new Serializer([], ['json' => new JsonEncoder()], new ObjectNormalizer(), new ObjectNormalizer());

$validator = $this->createMock(ValidatorInterface::class);
$validator->expects($this->once())
Expand Down Expand Up @@ -434,7 +462,7 @@ public function testRequestArrayDenormalization()
new RequestPayload(23),
];

$serializer = new Serializer([new ArrayDenormalizer(), new ObjectNormalizer()], ['json' => new JsonEncoder()]);
$serializer = new Serializer([], ['json' => new JsonEncoder()], null, new ChainDenormalizer([new ArrayDenormalizer(), new ObjectNormalizer()]));

$validator = $this->createMock(ValidatorInterface::class);
$validator->expects($this->once())
Expand Down Expand Up @@ -513,7 +541,7 @@ public function testItThrowsOnVariadicArgument()
public function testAcceptFormatPassed(mixed $acceptFormat, string $contentType, string $content)
{
$encoders = ['json' => new JsonEncoder(), 'xml' => new XmlEncoder()];
$serializer = new Serializer([new ObjectNormalizer()], $encoders);
$serializer = new Serializer([], $encoders, new ObjectNormalizer(), new ObjectNormalizer());
$validator = (new ValidatorBuilder())->getValidator();
$resolver = new RequestPayloadValueResolver($serializer, $validator);

Expand Down Expand Up @@ -576,7 +604,7 @@ public static function provideMatchedFormatContext(): iterable
*/
public function testAcceptFormatNotPassed(mixed $acceptFormat, string $contentType, string $content, string $expectedExceptionMessage)
{
$serializer = new Serializer([new ObjectNormalizer()]);
$serializer = new Serializer([], [], new ObjectNormalizer(), new ObjectNormalizer());
$validator = (new ValidatorBuilder())->getValidator();
$resolver = new RequestPayloadValueResolver($serializer, $validator);

Expand Down Expand Up @@ -647,7 +675,7 @@ public function testValidationGroupsPassed(string $method, ValueResolver $attrib
$payload = new RequestPayload(50);
$payload->title = 'A long title, so the validation passes';

$serializer = new Serializer([new ObjectNormalizer()]);
$serializer = new Serializer([], [], new ObjectNormalizer(), new ObjectNormalizer());
$validator = (new ValidatorBuilder())->enableAttributeMapping()->getValidator();
$resolver = new RequestPayloadValueResolver($serializer, $validator);

Expand All @@ -673,7 +701,7 @@ public function testValidationGroupsNotPassed(string $method, ValueResolver $att
{
$input = ['price' => '50', 'title' => 'Too short'];

$serializer = new Serializer([new ObjectNormalizer()]);
$serializer = new Serializer([], [], new ObjectNormalizer(), new ObjectNormalizer());
$validator = (new ValidatorBuilder())->enableAttributeMapping()->getValidator();
$resolver = new RequestPayloadValueResolver($serializer, $validator);

Expand Down Expand Up @@ -732,7 +760,7 @@ public static function provideValidationGroupsOnManyTypes(): iterable

public function testQueryValidationErrorCustomStatusCode()
{
$serializer = new Serializer([new ObjectNormalizer()], []);
$serializer = new Serializer([], [], new ObjectNormalizer(), new ObjectNormalizer());

$validator = $this->createMock(ValidatorInterface::class);

Expand Down Expand Up @@ -765,7 +793,7 @@ public function testQueryValidationErrorCustomStatusCode()
public function testRequestPayloadValidationErrorCustomStatusCode()
{
$content = '{"price": 50, "title": ["not a string"]}';
$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
$serializer = new Serializer([], ['json' => new JsonEncoder()], new ObjectNormalizer(), new ObjectNormalizer());

$validator = $this->createMock(ValidatorInterface::class);
$validator->expects($this->never())
Expand Down Expand Up @@ -798,7 +826,7 @@ public function testRequestPayloadValidationErrorCustomStatusCode()
*/
public function testBoolArgumentInQueryString(mixed $expectedValue, ?string $parameterValue)
{
$serializer = new Serializer([new ObjectNormalizer()]);
$serializer = new Serializer([], [], new ObjectNormalizer(), new ObjectNormalizer());
$validator = $this->createMock(ValidatorInterface::class);
$resolver = new RequestPayloadValueResolver($serializer, $validator);

Expand All @@ -821,7 +849,7 @@ public function testBoolArgumentInQueryString(mixed $expectedValue, ?string $par
*/
public function testBoolArgumentInBody(mixed $expectedValue, ?string $parameterValue)
{
$serializer = new Serializer([new ObjectNormalizer()]);
$serializer = new Serializer([], [], new ObjectNormalizer(), new ObjectNormalizer());
$validator = $this->createMock(ValidatorInterface::class);
$resolver = new RequestPayloadValueResolver($serializer, $validator);

Expand Down Expand Up @@ -857,7 +885,7 @@ public static function provideBoolArgument()
*/
public function testBoolArgumentInJsonBody()
{
$serializer = new Serializer([new ObjectNormalizer()]);
$serializer = new Serializer([], [], new ObjectNormalizer(), new ObjectNormalizer());
$validator = $this->createMock(ValidatorInterface::class);
$resolver = new RequestPayloadValueResolver($serializer, $validator);

Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/HttpKernel/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"symfony/process": "^6.4|^7.0",
"symfony/property-access": "^7.1",
"symfony/routing": "^6.4|^7.0",
"symfony/serializer": "^7.1",
"symfony/serializer": "^7.2",
"symfony/stopwatch": "^6.4|^7.0",
"symfony/translation": "^6.4|^7.0",
"symfony/translation-contracts": "^2.5|^3",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
use Symfony\Component\Messenger\Transport\Serialization\Serializer;
use Symfony\Component\Serializer as SerializerComponent;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Normalizer\ChainNormalizer;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;

class AmazonSqsReceiverTest extends TestCase
Expand Down Expand Up @@ -67,10 +68,13 @@ private function createSqsEnvelope()

private function createSerializer(): Serializer
{
$serializer = new Serializer(
new SerializerComponent\Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()])
);
// if Symfony 7.2
if (class_exists(ChainNormalizer::class)) {
$symfonySerializer = new SerializerComponent\Serializer([], ['json' => new JsonEncoder()], new ObjectNormalizer(), new ObjectNormalizer());
} else {
$symfonySerializer = new SerializerComponent\Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
}

return $serializer;
return new Serializer($symfonySerializer);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,16 @@
use Symfony\Component\Serializer as SerializerComponent;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
use Symfony\Component\Serializer\Normalizer\ChainNormalizer;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;

$serializer = new Serializer(
new SerializerComponent\Serializer([new ObjectNormalizer(), new ArrayDenormalizer()], ['json' => new JsonEncoder()])
);
// if Symfony 7.2
if (class_exists(ChainNormalizer::class)) {
$symfonySerializer = new SerializerComponent\Serializer([], ['json' => new JsonEncoder()], new ObjectNormalizer(), new SerializerComponent\Normalizer\ChainDenormalizer([new ObjectNormalizer(), new ArrayDenormalizer()]));
} else {
$symfonySerializer = new SerializerComponent\Serializer([new ObjectNormalizer(), new ArrayDenormalizer()], ['json' => new JsonEncoder()]);
}
$serializer = new Serializer($symfonySerializer);

$connection = Connection::fromDsn(getenv('DSN'));
$receiver = new AmqpReceiver($connection, $serializer);
Expand Down
Loading
Loading