Skip to content

[FrameworkBundle][Serializer] Allow setting $objectClassResolver via configuration #60092

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 1 commit 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
1 change: 1 addition & 0 deletions src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ CHANGELOG
* Allow configuring the logging channel per type of exceptions
* Enable service argument resolution on classes that use the `#[Route]` attribute,
the `#[AsController]` attribute is no longer required
* Add `framework.serializer.object_class_resolver` option

7.2
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1172,6 +1172,13 @@ private function addSerializerSection(ArrayNodeDefinition $rootNode, callable $e
->defaultValue([])
->prototype('variable')->end()
;
$objectClassResolver = fn () => (new NodeBuilder())
->variableNode('object_class_resolver')
->validate()
->ifTrue(fn ($v) => !\is_string($v) && !\is_callable($v))
->thenInvalid('The "object_class_resolver" parameter must be a string or a callable.')
->end()
;

$rootNode
->children()
Expand All @@ -1182,6 +1189,7 @@ private function addSerializerSection(ArrayNodeDefinition $rootNode, callable $e
->children()
->booleanNode('enable_attributes')->{class_exists(FullStack::class) ? 'defaultFalse' : 'defaultTrue'}()->end()
->scalarNode('name_converter')->end()
->append($objectClassResolver())
->scalarNode('circular_reference_handler')->end()
->scalarNode('max_depth_handler')->end()
->arrayNode('mapping')
Expand All @@ -1199,6 +1207,7 @@ private function addSerializerSection(ArrayNodeDefinition $rootNode, callable $e
->arrayPrototype()
->children()
->scalarNode('name_converter')->end()
->append($objectClassResolver())
->append($defaultContextNode())
->booleanNode('include_built_in_normalizers')
->info('Whether to include the built-in normalizers')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2070,6 +2070,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
$container->setParameter('serializer.default_context', $defaultContext);
}

if ($config['object_class_resolver'] ?? false) {
$container->setParameter('.serializer.object_class_resolver', $config['object_class_resolver']);
}

if ($config['circular_reference_handler'] ?? false) {
$container->setParameter('.serializer.circular_reference_handler', $config['circular_reference_handler']);
}
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/Serializer/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ CHANGELOG
* Register `NormalizerInterface` and `DenormalizerInterface` aliases for named serializers
* Add `NumberNormalizer` to normalize `BcMath\Number` and `GMP` as `string`
* Add `defaultType` to `DiscriminatorMap`
* Support setting `$objectClassResolver` via `SerializerPass`

7.2
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\Serializer\Debug\TraceableEncoder;
use Symfony\Component\Serializer\Debug\TraceableNormalizer;
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
Expand Down Expand Up @@ -74,6 +75,10 @@ public function process(ContainerBuilder $container): void

$this->bindDefaultContext($container, array_merge($normalizers, $encoders), $defaultContext, $circularReferenceHandler, $maxDepthHandler);

if ($container->hasParameter('.serializer.object_class_resolver')) {
$this->setObjectClassResolver($container, $normalizers, $container->getParameter('.serializer.object_class_resolver'));
}

$this->configureSerializer($container, 'serializer', $normalizers, $encoders, 'default');

if ($namedSerializers) {
Expand Down Expand Up @@ -130,6 +135,23 @@ private function bindDefaultContext(ContainerBuilder $container, array $services
}
}

private function setObjectClassResolver(ContainerBuilder $container, array $services, string|callable $objectClassResolver): void
{
foreach ($services as $id) {
$definition = $container->getDefinition((string) $id);

if (!is_a($definition->getClass(), AbstractObjectNormalizer::class, true)) {
continue;
}

if (!\is_callable($objectClassResolver)) {
$objectClassResolver = new Reference($objectClassResolver);
}

$definition->setArgument('$objectClassResolver', $objectClassResolver);
}
}

private function configureSerializer(ContainerBuilder $container, string $id, array $normalizers, array $encoders, string $serializerName): void
{
if ($container->getParameter('kernel.debug') && $container->hasDefinition('serializer.data_collector')) {
Expand Down Expand Up @@ -175,6 +197,10 @@ private function configureNamedSerializers(ContainerBuilder $container, ?string

$this->bindDefaultContext($container, array_merge($normalizers, $encoders), $config['default_context'], $circularReferenceHandler, $maxDepthHandler);

if ($config['object_class_resolver'] ?? false) {
$this->setObjectClassResolver($container, $normalizers, $config['object_class_resolver']);
}

$container->registerChild($serializerId, 'serializer')->setArgument('$defaultContext', $config['default_context']);
$container->registerAliasForArgument($serializerId, SerializerInterface::class, $serializerName.'.serializer');
$container->registerAliasForArgument($serializerId, NormalizerInterface::class, $serializerName.'.normalizer');
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1052,7 +1052,7 @@ private function updateData(array $data, string $attribute, mixed $attributeValu
*/
private function isMaxDepthReached(array $attributesMetadata, string $class, string $attribute, array &$context): bool
{
if (!($enableMaxDepth = $context[self::ENABLE_MAX_DEPTH] ?? $this->defaultContext[self::ENABLE_MAX_DEPTH] ?? false)
if (!($context[self::ENABLE_MAX_DEPTH] ?? $this->defaultContext[self::ENABLE_MAX_DEPTH] ?? false)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not used.

|| !isset($attributesMetadata[$attribute]) || null === $maxDepth = $attributesMetadata[$attribute]?->getMaxDepth()
) {
return false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use Symfony\Component\Serializer\Debug\TraceableNormalizer;
use Symfony\Component\Serializer\Debug\TraceableSerializer;
use Symfony\Component\Serializer\DependencyInjection\SerializerPass;
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
Expand Down Expand Up @@ -115,8 +116,7 @@ public function testBindObjectNormalizerDefaultContext(array $parameters, array
$container->setParameter('kernel.debug', false);
$container->register('serializer')->setArguments([null, null, []]);
$container->getParameterBag()->add($parameters);
$definition = $container->register('serializer.normalizer.object')
->setClass(ObjectNormalizer::class)
$definition = $container->register('serializer.normalizer.object', ObjectNormalizer::class)
->addTag('serializer.normalizer')
->addTag('serializer.encoder')
;
Expand All @@ -128,6 +128,40 @@ public function testBindObjectNormalizerDefaultContext(array $parameters, array
$this->assertEquals($bindings['array $defaultContext'], new BoundArgument($context, false));
}

/**
* @dataProvider provideSetObjectClassResolverData
*/
public function testSetObjectClassResolver(array $parameters, array $expectedArguments)
{
$container = new ContainerBuilder();
$container->setParameter('kernel.debug', false);
$container->register('serializer')->setArguments([null, null]);
$container->getParameterBag()->add($parameters);
$definition = $container->register('n1', AbstractObjectNormalizer::class)->addTag('serializer.normalizer')->addTag('serializer.encoder');

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

$this->assertEquals($expectedArguments, $definition->getArguments());
}

public static function provideSetObjectClassResolverData(): iterable
{
yield [[], []];
yield [
['.serializer.object_class_resolver' => 'strlen'],
['$objectClassResolver' => 'strlen'],
];
yield [
['.serializer.object_class_resolver' => [self::class, 'provideSetObjectClassResolverData']],
['$objectClassResolver' => [self::class, 'provideSetObjectClassResolverData']],
];
yield [
['.serializer.object_class_resolver' => 'my.service'],
['$objectClassResolver' => new Reference('my.service')],
];
}

public function testNormalizersAndEncodersAreDecoratedAndOrderedWhenCollectingData()
{
$container = new ContainerBuilder();
Expand Down Expand Up @@ -622,8 +656,7 @@ public function testBindNamedSerializerObjectNormalizerDefaultContext(array $def

$container->register('serializer')->setArguments([null, null, []]);
$container->getParameterBag()->add($parameters);
$container->register('serializer.normalizer.object')
->setClass(ObjectNormalizer::class)
$container->register('serializer.normalizer.object', ObjectNormalizer::class)
->addTag('serializer.normalizer', ['serializer' => '*'])
->addTag('serializer.encoder', ['serializer' => '*'])
;
Expand All @@ -636,6 +669,30 @@ public function testBindNamedSerializerObjectNormalizerDefaultContext(array $def
$this->assertEquals($bindings['array $defaultContext'], new BoundArgument($context, false));
}

/**
* @dataProvider provideSetObjectClassResolverData
*/
public function testSetObjectClassResolverToNamedSerializers(array $parameters, array $expectedArguments)
{
$container = new ContainerBuilder();
$container->setParameter('kernel.debug', false);
$container->setParameter('.serializer.named_serializers', [
'api' => ['object_class_resolver' => $parameters['.serializer.object_class_resolver'] ?? null],
]);

$container->register('serializer')->setArguments([null, null]);
$container->register('n1', AbstractObjectNormalizer::class)
->addTag('serializer.normalizer', ['serializer' => '*'])
->addTag('serializer.encoder', ['serializer' => '*'])
;

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

$definition = $container->getDefinition('n1.api');
$this->assertEquals($expectedArguments, $definition->getArguments());
}

public function testNamedSerializersAreRegistered()
{
$container = new ContainerBuilder();
Expand Down
Loading