Skip to content

[Serializer] Handle default context in Serializer #58889

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
chalasr merged 1 commit into from
Jan 28, 2025
Merged

[Serializer] Handle default context in Serializer #58889

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
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@

$container->services()
->set('serializer', Serializer::class)
->args([[], []])
->args([[], [], []])

->alias(SerializerInterface::class, 'serializer')
->alias(NormalizerInterface::class, 'serializer')
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/Serializer/DependencyInjection/SerializerPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ public function process(ContainerBuilder $container)
}

$container->getParameterBag()->remove('serializer.default_context');
$container->getDefinition('serializer')->setArgument('$defaultContext', $defaultContext);
}

if ($container->getParameter('kernel.debug') && $container->hasDefinition('serializer.data_collector')) {
Expand Down
8 changes: 5 additions & 3 deletions src/Symfony/Component/Serializer/Serializer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,12 @@ class Serializer implements SerializerInterface, ContextAwareNormalizerInterface
/**
* @param array<NormalizerInterface|DenormalizerInterface> $normalizers
* @param array<EncoderInterface|DecoderInterface> $encoders
* @param array<string, mixed> $defaultContext
*/
public function __construct(
private array $normalizers = [],
array $encoders = [],
private array $defaultContext = [],
) {
foreach ($normalizers as $normalizer) {
if ($normalizer instanceof SerializerAwareInterface) {
Expand Down Expand Up @@ -163,12 +165,12 @@ public function normalize(mixed $data, ?string $format = null, array $context =
return $data;
}

if (\is_array($data) && !$data && ($context[self::EMPTY_ARRAY_AS_OBJECT] ?? false)) {
if (\is_array($data) && !$data && ($context[self::EMPTY_ARRAY_AS_OBJECT] ?? $this->defaultContext[self::EMPTY_ARRAY_AS_OBJECT] ?? false)) {
return new \ArrayObject();
}

if (is_iterable($data)) {
if ($data instanceof \Countable && ($context[AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS] ?? false) && !\count($data)) {
if ($data instanceof \Countable && ($context[AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS] ?? $this->defaultContext[AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS] ?? false) && !\count($data)) {
return new \ArrayObject();
}

Expand Down Expand Up @@ -220,7 +222,7 @@ public function denormalize(mixed $data, string $type, ?string $format = null, a
throw new NotNormalizableValueException(sprintf('Could not denormalize object of type "%s", no supporting normalizer found.', $type));
}

if (isset($context[DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS])) {
if (isset($context[DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS]) || isset($this->defaultContext[DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS])) {
unset($context[DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS]);
$context['not_normalizable_value_exceptions'] = [];
$errors = &$context['not_normalizable_value_exceptions'];
Expand Down
7 changes: 5 additions & 2 deletions src/Symfony/Component/Serializer/Tests/DependencyInjection/SerializerPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,20 @@ public function testServicesAreOrderedAccordingToPriority()

public function testBindSerializerDefaultContext()
{
$context = ['enable_max_depth' => true];

$container = new ContainerBuilder();
$container->setParameter('kernel.debug', false);
$container->register('serializer')->setArguments([null, null]);
$container->register('serializer')->setArguments([null, null, []]);
$container->setParameter('serializer.default_context', ['enable_max_depth' => true]);
$definition = $container->register('n1')->addTag('serializer.normalizer')->addTag('serializer.encoder');

$serializerPass = new SerializerPass();
$serializerPass->process($container);

$bindings = $definition->getBindings();
$this->assertEquals($bindings['array $defaultContext'], new BoundArgument(['enable_max_depth' => true], false));
$this->assertEquals($bindings['array $defaultContext'], new BoundArgument($context, false));
$this->assertEquals($context, $container->getDefinition('serializer')->getArgument('$defaultContext'));
}

public function testNormalizersAndEncodersAreDecoredAndOrderedWhenCollectingData()
Expand Down
26 changes: 26 additions & 0 deletions src/Symfony/Component/Serializer/Tests/SerializerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1652,6 +1652,32 @@ public function testPartialDenormalizationWithInvalidVariadicParameter()
DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS => true,
]);
}

public function testEmptyArrayAsObjectDefaultContext()
{
$serializer = new Serializer(
defaultContext: [Serializer::EMPTY_ARRAY_AS_OBJECT => true],
);
$this->assertEquals(new \ArrayObject(), $serializer->normalize([]));
}

public function testPreserveEmptyObjectsAsDefaultContext()
{
$serializer = new Serializer(
defaultContext: [AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true],
);
$this->assertEquals(new \ArrayObject(), $serializer->normalize(new \ArrayIterator()));
}

public function testCollectDenormalizationErrorsDefaultContext()
{
$data = ['variadic' => ['a random string']];
$serializer = new Serializer([new UidNormalizer(), new ObjectNormalizer()], [], [DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS => true]);

$this->expectException(PartialDenormalizationException::class);

$serializer->denormalize($data, DummyWithVariadicParameter::class);
}
}

class Model
Expand Down