8000 [FrameworkBundle] Fix setting default context for certain normalizers by HypeMC · Pull Request #57273 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

[FrameworkBundle] Fix setting default context for certain normalizers #57273

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

Merged
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -1859,18 +1859,20 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
}

$arguments = $container->getDefinition('serializer.normalizer.object')->getArguments();
$context = [];
$context = $arguments[6] ?? $defaultContext;

if (isset($config['circular_reference_handler']) && $config['circular_reference_handler']) {
$context += ($arguments[6] ?? $defaultContext) + ['circular_reference_handler' => new Reference($config['circular_reference_handler'])];
$context += ['circular_reference_handler' => new Reference($config['circular_reference_handler'])];
$container->getDefinition('serializer.normalizer.object')->setArgument(5, null);
}

if ($config['max_depth_handler'] ?? false) {
$context += ($arguments[6] ?? $defaultContext) + ['max_depth_handler' => new Reference($config['max_depth_handler'])];
$context += ['max_depth_handler' => new Reference($config['max_depth_handler'])];
}

$container->getDefinition('serializer.normalizer.object')->setArgument(6, $context);

$container->getDefinition('serializer.normalizer.property')->setArgument(5, $defaultContext);
}

private function registerPropertyInfoConfiguration(ContainerBuilder $container, PhpFileLoader $loader)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,6 @@
service('property_info')->ignoreOnInvalid(),
service('serializer.mapping.class_discriminator_resolver')->ignoreOnInvalid(),
null,
[],
])

->alias(PropertyNormalizer::class, 'serializer.normalizer.property')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ protected static function getKernelClass(): string

protected static function createKernel(array $options = []): KernelInterface
{
$class = self::getKernelClass();
$class = static::getKernelClass();

if (!isset($options['test_case'])) {
throw new \InvalidArgumentException('The option "test_case" must be set.');
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@

namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;

use Symfony\Bundle\FrameworkBundle\Tests\Functional\app\AppKernel;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;

/**
* @author Kévin Dunglas <dunglas@gmail.com>
*/
Expand All @@ -33,39 +37,55 @@ public function testDeserializeArrayOfObject()
$this->assertEquals($expected, $result);
}

/**
* @dataProvider provideNormalizersAndEncodersWithDefaultContextOption
*/
public function testNormalizersAndEncodersUseDefaultContextConfigOption(string $normalizerId)
public function testNormalizersAndEncodersUseDefaultContextConfigOption()
{
static::bootKernel(['test_case' => 'Serializer']);
/** @var SerializerKernel $kernel */
$kernel = static::bootKernel(['test_case' => 'Serializer', 'root_config' => 'default_context.yaml']);

foreach ($kernel->normalizersAndEncoders as $normalizerOrEncoderId) {
$normalizerOrEncoder = static::getContainer()->get($normalizerOrEncoderId);

$normalizer = static::getContainer()->get($normalizerId);
$reflectionObject = new \ReflectionObject($normalizerOrEncoder);
$property = $reflectionObject->getProperty('defaultContext');
$property->setAccessible(true);

$reflectionObject = new \ReflectionObject($normalizer);
$property = $reflectionObject->getProperty('defaultContext');
$property->setAccessible(true);
$defaultContext = $property->getValue($normalizerOrEncoder);

$defaultContext = $property->getValue($normalizer);
self::assertArrayHasKey('fake_context_option', $defaultContext);
self::assertEquals('foo', $defaultContext['fake_context_option']);
}
}

self::assertArrayHasKey('fake_context_option', $defaultContext);
self::assertEquals('foo', $defaultContext['fake_context_option']);
protected static function getKernelClass(): string
{
return SerializerKernel::class;
}
}

class SerializerKernel extends AppKernel implements CompilerPassInterface
{
public $normalizersAndEncoders = [
'serializer.normalizer.property.alias', // Special case as this normalizer isn't tagged
];

public static function provideNormalizersAndEncodersWithDefaultContextOption(): array
public function process(ContainerBuilder $container)
{
return [
['serializer.normalizer.constraint_violation_list.alias'],
['serializer.normalizer.dateinterval.alias'],
['serializer.normalizer.datetime.alias'],
['serializer.normalizer.json_serializable.alias'],
['serializer.normalizer.problem.alias'],
['serializer.normalizer.uid.alias'],
['serializer.normalizer.object.alias'],
['serializer.encoder.xml.alias'],
['serializer.encoder.yaml.alias'],
['serializer.encoder.csv.alias'],
];
$services = array_merge(
$container->findTaggedServiceIds('serializer.normalizer'),
$container->findTaggedServiceIds('serializer.encoder')
);
foreach ($services as $serviceId => $attributes) {
$class = $container->getDefinition($serviceId)->getClass();
if (null === $reflectionConstructor = (new \ReflectionClass($class))->getConstructor()) {
continue;
}
foreach ($reflectionConstructor->getParameters() as $reflectionParam) {
if ('array $defaultContext' === $reflectionParam->getType()->getName().' $'.$reflectionParam->getName()) {
$this->normalizersAndEncoders[] = $serviceId.'.alias';
break;
}
}
}
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ public function __construct($varDir, $testCase, $rootConfig, $environment, $debu
parent::__construct($environment, $debug);
}

protected function getContainerClass(): string
{
return parent::getContainerClass().substr(md5($this->rootConfig), -16);
}

public function registerBundles(): iterable
{
if (!file_exists($filename = $this->getProjectDir().'/'.$this->testCase.'/bundles.php')) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,58 +8,13 @@ framework:
max_depth_handler: Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Serializer\MaxDepthHandler
default_context:
enable_max_depth: true
fake_context_option: foo
property_info: { enabled: true }

services:
serializer.alias:
alias: serializer
public: true

serializer.normalizer.constraint_violation_list.alias:
alias: serializer.normalizer.constraint_violation_list
public: true

serializer.normalizer.dateinterval.alias:
alias: serializer.normalizer.dateinterval
public: true

serializer.normalizer.datetime.alias:
alias: serializer.normalizer.datetime
public: true

serializer.normalizer.json_serializable.alias:
alias: serializer.normalizer.json_serializable
public: true

serializer.normalizer.problem.alias:
alias: serializer.normalizer.problem
public: true

serializer.normalizer.uid.alias:
alias: serializer.normalizer.uid
public: true

serializer.normalizer.property.alias:
alias: serializer.normalizer.property
public: true

serializer.normalizer.object.alias:
alias: serializer.normalizer.object
public: true

serializer.encoder.xml.alias:
alias: serializer.encoder.xml
public: true

serializer.encoder.yaml.alias:
alias: serializer.encoder.yaml
public: true

serializer.encoder.csv.alias:
alias: serializer.encoder.csv
public: true

Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Serializer\CircularReferenceHandler: ~

Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Serializer\MaxDepthHandler: ~
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
imports:
- { resource: ../config/default.yml }

framework:
serializer:
enabled: true
circular_reference_handler: ~ # This must be null
max_depth_handler: ~ # This must be null
default_context:
fake_context_option: foo

services:
serializer.normalizer.constraint_violation_list.alias:
alias: serializer.normalizer.constraint_violation_list
public: true

serializer.normalizer.dateinterval.alias:
alias: serializer.normalizer.dateinterval
public: true

serializer.normalizer.datetime.alias:
alias: serializer.normalizer.datetime
public: true

serializer.normalizer.json_serializable.alias:
alias: serializer.normalizer.json_serializable
public: true

serializer.normalizer.object.alias:
alias: serializer.normalizer.object
public: true

serializer.normalizer.problem.alias:
alias: serializer.normalizer.problem
public: true

serializer.normalizer.property.alias:
alias: serializer.normalizer.property
public: true

serializer.normalizer.uid.alias:
alias: serializer.normalizer.uid
public: true

serializer.encoder.csv.alias:
alias: serializer.encoder.csv
public: true

serializer.encoder.json.alias:
alias: serializer.encoder.json
public: true

serializer.encoder.xml.alias:
alias: serializer.encoder.xml
public: true

serializer.encoder.yaml.alias:
alias: serializer.encoder.yaml
public: true
Loading
0